cgit.c

   1 /* cgit.c: cgi for the git scm
   2  *
   3  * Copyright (C) 2006 Lars Hjemli
   4  *
   5  * Licensed under GNU General Public License v2
   6  *   (see COPYING for full license text)
   7  */
   8
   9 #include "cgit.h"
  10 #include "cache.h"
  11 #include "cmd.h"
  12 #include "configfile.h"
  13 #include "html.h"
  14 #include "ui-shared.h"
  15 #include "scan-tree.h"
  16
  17 const char *cgit_version = CGIT_VERSION;
  18
  19 void config_cb(const char *name, const char *value)
  20 {
  21         if (!strcmp(name, "root-title"))
  22                 ctx.cfg.root_title = xstrdup(value);
  23         else if (!strcmp(name, "root-desc"))
  24                 ctx.cfg.root_desc = xstrdup(value);
  25         else if (!strcmp(name, "root-readme"))
  26                 ctx.cfg.root_readme = xstrdup(value);
  27         else if (!strcmp(name, "css"))
  28                 ctx.cfg.css = xstrdup(value);
  29         else if (!strcmp(name, "favicon"))
  30                 ctx.cfg.favicon = xstrdup(value);
  31         else if (!strcmp(name, "footer"))
  32                 ctx.cfg.footer = xstrdup(value);
  33         else if (!strcmp(name, "logo"))
  34                 ctx.cfg.logo = xstrdup(value);
  35         else if (!strcmp(name, "index-header"))
  36                 ctx.cfg.index_header = xstrdup(value);
  37         else if (!strcmp(name, "index-info"))
  38                 ctx.cfg.index_info = xstrdup(value);
  39         else if (!strcmp(name, "logo-link"))
  40                 ctx.cfg.logo_link = xstrdup(value);
  41         else if (!strcmp(name, "module-link"))
  42                 ctx.cfg.module_link = xstrdup(value);
  43         else if (!strcmp(name, "virtual-root")) {
  44                 ctx.cfg.virtual_root = trim_end(value, '/');
  45                 if (!ctx.cfg.virtual_root && (!strcmp(value, "/")))
  46                         ctx.cfg.virtual_root = "";
  47         } else if (!strcmp(name, "nocache"))
  48                 ctx.cfg.nocache = atoi(value);
  49         else if (!strcmp(name, "snapshots"))
  50                 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
  51         else if (!strcmp(name, "enable-index-links"))
  52                 ctx.cfg.enable_index_links = atoi(value);
  53         else if (!strcmp(name, "enable-log-filecount"))
  54                 ctx.cfg.enable_log_filecount = atoi(value);
  55         else if (!strcmp(name, "enable-log-linecount"))
  56                 ctx.cfg.enable_log_linecount = atoi(value);
  57         else if (!strcmp(name, "cache-size"))
  58                 ctx.cfg.cache_size = atoi(value);
  59         else if (!strcmp(name, "cache-root"))
  60                 ctx.cfg.cache_root = xstrdup(value);
  61         else if (!strcmp(name, "cache-root-ttl"))
  62                 ctx.cfg.cache_root_ttl = atoi(value);
  63         else if (!strcmp(name, "cache-repo-ttl"))
  64                 ctx.cfg.cache_repo_ttl = atoi(value);
  65         else if (!strcmp(name, "cache-static-ttl"))
  66                 ctx.cfg.cache_static_ttl = atoi(value);
  67         else if (!strcmp(name, "cache-dynamic-ttl"))
  68                 ctx.cfg.cache_dynamic_ttl = atoi(value);
  69         else if (!strcmp(name, "max-message-length"))
  70                 ctx.cfg.max_msg_len = atoi(value);
  71         else if (!strcmp(name, "max-repodesc-length"))
  72                 ctx.cfg.max_repodesc_len = atoi(value);
  73         else if (!strcmp(name, "max-repo-count"))
  74                 ctx.cfg.max_repo_count = atoi(value);
  75         else if (!strcmp(name, "max-commit-count"))
  76                 ctx.cfg.max_commit_count = atoi(value);
  77         else if (!strcmp(name, "summary-log"))
  78                 ctx.cfg.summary_log = atoi(value);
  79         else if (!strcmp(name, "summary-branches"))
  80                 ctx.cfg.summary_branches = atoi(value);
  81         else if (!strcmp(name, "summary-tags"))
  82                 ctx.cfg.summary_tags = atoi(value);
  83         else if (!strcmp(name, "agefile"))
  84                 ctx.cfg.agefile = xstrdup(value);
  85         else if (!strcmp(name, "renamelimit"))
  86                 ctx.cfg.renamelimit = atoi(value);
  87         else if (!strcmp(name, "robots"))
  88                 ctx.cfg.robots = xstrdup(value);
  89         else if (!strcmp(name, "clone-prefix"))
  90                 ctx.cfg.clone_prefix = xstrdup(value);
  91         else if (!strcmp(name, "local-time"))
  92                 ctx.cfg.local_time = atoi(value);
  93         else if (!strcmp(name, "repo.group"))
  94                 ctx.cfg.repo_group = xstrdup(value);
  95         else if (!strcmp(name, "repo.url"))
  96                 ctx.repo = cgit_add_repo(value);
  97         else if (!strcmp(name, "repo.name"))
  98                 ctx.repo->name = xstrdup(value);
  99         else if (ctx.repo && !strcmp(name, "repo.path"))
 100                 ctx.repo->path = trim_end(value, '/');
 101         else if (ctx.repo && !strcmp(name, "repo.clone-url"))
 102                 ctx.repo->clone_url = xstrdup(value);
 103         else if (ctx.repo && !strcmp(name, "repo.desc"))
 104                 ctx.repo->desc = xstrdup(value);
 105         else if (ctx.repo && !strcmp(name, "repo.owner"))
 106                 ctx.repo->owner = xstrdup(value);
 107         else if (ctx.repo && !strcmp(name, "repo.defbranch"))
 108                 ctx.repo->defbranch = xstrdup(value);
 109         else if (ctx.repo && !strcmp(name, "repo.snapshots"))
 110                 ctx.repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); /* XXX: &? */
 111         else if (ctx.repo && !strcmp(name, "repo.enable-log-filecount"))
 112                 ctx.repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
 113         else if (ctx.repo && !strcmp(name, "repo.enable-log-linecount"))
 114                 ctx.repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
 115         else if (ctx.repo && !strcmp(name, "repo.module-link"))
 116                 ctx.repo->module_link= xstrdup(value);
 117         else if (ctx.repo && !strcmp(name, "repo.readme") && value != NULL) {
 118                 if (*value == '/')
 119                         ctx.repo->readme = xstrdup(value);
 120                 else
 121                         ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value));
 122         } else if (!strcmp(name, "include"))
 123                 parse_configfile(value, config_cb);
 124 }
 125
 126 static void querystring_cb(const char *name, const char *value)
 127 {
 128         if (!strcmp(name,"r")) {
 129                 ctx.qry.repo = xstrdup(value);
 130                 ctx.repo = cgit_get_repoinfo(value);
 131         } else if (!strcmp(name, "p")) {
 132                 ctx.qry.page = xstrdup(value);
 133         } else if (!strcmp(name, "url")) {
 134                 ctx.qry.url = xstrdup(value);
 135                 cgit_parse_url(value);
 136         } else if (!strcmp(name, "qt")) {
 137                 ctx.qry.grep = xstrdup(value);
 138         } else if (!strcmp(name, "q")) {
 139                 ctx.qry.search = xstrdup(value);
 140         } else if (!strcmp(name, "h")) {
 141                 ctx.qry.head = xstrdup(value);
 142                 ctx.qry.has_symref = 1;
 143         } else if (!strcmp(name, "id")) {
 144                 ctx.qry.sha1 = xstrdup(value);
 145                 ctx.qry.has_sha1 = 1;
 146         } else if (!strcmp(name, "id2")) {
 147                 ctx.qry.sha2 = xstrdup(value);
 148                 ctx.qry.has_sha1 = 1;
 149         } else if (!strcmp(name, "ofs")) {
 150                 ctx.qry.ofs = atoi(value);
 151         } else if (!strcmp(name, "path")) {
 152                 ctx.qry.path = trim_end(value, '/');
 153         } else if (!strcmp(name, "name")) {
 154                 ctx.qry.name = xstrdup(value);
 155         } else if (!strcmp(name, "mimetype")) {
 156                 ctx.qry.mimetype = xstrdup(value);
 157         } else if (!strcmp(name, "s")){
 158                 ctx.qry.sort = xstrdup(value);
 159         }
 160 }
 161
 162 static void prepare_context(struct cgit_context *ctx)
 163 {
 164         memset(ctx, 0, sizeof(ctx));
 165         ctx->cfg.agefile = "info/web/last-modified";
 166         ctx->cfg.nocache = 0;
 167         ctx->cfg.cache_size = 0;
 168         ctx->cfg.cache_dynamic_ttl = 5;
 169         ctx->cfg.cache_max_create_time = 5;
 170         ctx->cfg.cache_repo_ttl = 5;
 171         ctx->cfg.cache_root = CGIT_CACHE_ROOT;
 172         ctx->cfg.cache_root_ttl = 5;
 173         ctx->cfg.cache_static_ttl = -1;
 174         ctx->cfg.css = "/cgit.css";
 175         ctx->cfg.logo = "/git-logo.png";
 176         ctx->cfg.local_time = 0;
 177         ctx->cfg.max_repo_count = 50;
 178         ctx->cfg.max_commit_count = 50;
 179         ctx->cfg.max_lock_attempts = 5;
 180         ctx->cfg.max_msg_len = 80;
 181         ctx->cfg.max_repodesc_len = 80;
 182         ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
 183         ctx->cfg.renamelimit = -1;
 184         ctx->cfg.robots = "index, nofollow";
 185         ctx->cfg.root_title = "Git repository browser";
 186         ctx->cfg.root_desc = "a fast webinterface for the git dscm";
 187         ctx->cfg.script_name = CGIT_SCRIPT_NAME;
 188         ctx->cfg.summary_branches = 10;
 189         ctx->cfg.summary_log = 10;
 190         ctx->cfg.summary_tags = 10;
 191         ctx->page.mimetype = "text/html";
 192         ctx->page.charset = PAGE_ENCODING;
 193         ctx->page.filename = NULL;
 194         ctx->page.size = 0;
 195         ctx->page.modified = time(NULL);
 196         ctx->page.expires = ctx->page.modified;
 197 }
 198
 199 struct refmatch {
 200         char *req_ref;
 201         char *first_ref;
 202         int match;
 203 };
 204
 205 int find_current_ref(const char *refname, const unsigned char *sha1,
 206                      int flags, void *cb_data)
 207 {
 208         struct refmatch *info;
 209
 210         info = (struct refmatch *)cb_data;
 211         if (!strcmp(refname, info->req_ref))
 212                 info->match = 1;
 213         if (!info->first_ref)
 214                 info->first_ref = xstrdup(refname);
 215         return info->match;
 216 }
 217
 218 char *find_default_branch(struct cgit_repo *repo)
 219 {
 220         struct refmatch info;
 221         char *ref;
 222
 223         info.req_ref = repo->defbranch;
 224         info.first_ref = NULL;
 225         info.match = 0;
 226         for_each_branch_ref(find_current_ref, &info);
 227         if (info.match)
 228                 ref = info.req_ref;
 229         else
 230                 ref = info.first_ref;
 231         if (ref)
 232                 ref = xstrdup(ref);
 233         return ref;
 234 }
 235
 236 static int prepare_repo_cmd(struct cgit_context *ctx)
 237 {
 238         char *tmp;
 239         unsigned char sha1[20];
 240         int nongit = 0;
 241
 242         setenv("GIT_DIR", ctx->repo->path, 1);
 243         setup_git_directory_gently(&nongit);
 244         if (nongit) {
 245                 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
 246                                       "config error");
 247                 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
 248                 ctx->repo = NULL;
 249                 cgit_print_http_headers(ctx);
 250                 cgit_print_docstart(ctx);
 251                 cgit_print_pageheader(ctx);
 252                 cgit_print_error(tmp);
 253                 cgit_print_docend();
 254                 return 1;
 255         }
 256         ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
 257
 258         if (!ctx->qry.head) {
 259                 ctx->qry.nohead = 1;
 260                 ctx->qry.head = find_default_branch(ctx->repo);
 261                 ctx->repo->defbranch = ctx->qry.head;
 262         }
 263
 264         if (!ctx->qry.head) {
 265                 cgit_print_http_headers(ctx);
 266                 cgit_print_docstart(ctx);
 267                 cgit_print_pageheader(ctx);
 268                 cgit_print_error("Repository seems to be empty");
 269                 cgit_print_docend();
 270                 return 1;
 271         }
 272
 273         if (get_sha1(ctx->qry.head, sha1)) {
 274                 tmp = xstrdup(ctx->qry.head);
 275                 ctx->qry.head = ctx->repo->defbranch;
 276                 cgit_print_http_headers(ctx);
 277                 cgit_print_docstart(ctx);
 278                 cgit_print_pageheader(ctx);
 279                 cgit_print_error(fmt("Invalid branch: %s", tmp));
 280                 cgit_print_docend();
 281                 return 1;
 282         }
 283         return 0;
 284 }
 285
 286 static void process_request(void *cbdata)
 287 {
 288         struct cgit_context *ctx = cbdata;
 289         struct cgit_cmd *cmd;
 290
 291         cmd = cgit_get_cmd(ctx);
 292         if (!cmd) {
 293                 ctx->page.title = "cgit error";
 294                 ctx->repo = NULL;
 295                 cgit_print_http_headers(ctx);
 296                 cgit_print_docstart(ctx);
 297                 cgit_print_pageheader(ctx);
 298                 cgit_print_error("Invalid request");
 299                 cgit_print_docend();
 300                 return;
 301         }
 302
 303         if (cmd->want_repo && !ctx->repo) {
 304                 cgit_print_http_headers(ctx);
 305                 cgit_print_docstart(ctx);
 306                 cgit_print_pageheader(ctx);
 307                 cgit_print_error(fmt("No repository selected"));
 308                 cgit_print_docend();
 309                 return;
 310         }
 311
 312         if (ctx->repo && prepare_repo_cmd(ctx))
 313                 return;
 314
 315         if (cmd->want_layout) {
 316                 cgit_print_http_headers(ctx);
 317                 cgit_print_docstart(ctx);
 318                 cgit_print_pageheader(ctx);
 319         }
 320
 321         cmd->fn(ctx);
 322
 323         if (cmd->want_layout)
 324                 cgit_print_docend();
 325 }
 326
 327 int cmp_repos(const void *a, const void *b)
 328 {
 329         const struct cgit_repo *ra = a, *rb = b;
 330         return strcmp(ra->url, rb->url);
 331 }
 332
 333 void print_repo(struct cgit_repo *repo)
 334 {
 335         printf("repo.url=%s\n", repo->url);
 336         printf("repo.name=%s\n", repo->name);
 337         printf("repo.path=%s\n", repo->path);
 338         if (repo->owner)
 339                 printf("repo.owner=%s\n", repo->owner);
 340         if (repo->desc)
 341                 printf("repo.desc=%s\n", repo->desc);
 342         if (repo->readme)
 343                 printf("repo.readme=%s\n", repo->readme);
 344         printf("\n");
 345 }
 346
 347 void print_repolist(struct cgit_repolist *list)
 348 {
 349         int i;
 350
 351         for(i = 0; i < list->count; i++)
 352                 print_repo(&list->repos[i]);
 353 }
 354
 355
 356 static void cgit_parse_args(int argc, const char **argv)
 357 {
 358         int i;
 359         int scan = 0;
 360
 361         for (i = 1; i < argc; i++) {
 362                 if (!strncmp(argv[i], "--cache=", 8)) {
 363                         ctx.cfg.cache_root = xstrdup(argv[i]+8);
 364                 }
 365                 if (!strcmp(argv[i], "--nocache")) {
 366                         ctx.cfg.nocache = 1;
 367                 }
 368                 if (!strncmp(argv[i], "--query=", 8)) {
 369                         ctx.qry.raw = xstrdup(argv[i]+8);
 370                 }
 371                 if (!strncmp(argv[i], "--repo=", 7)) {
 372                         ctx.qry.repo = xstrdup(argv[i]+7);
 373                 }
 374                 if (!strncmp(argv[i], "--page=", 7)) {
 375                         ctx.qry.page = xstrdup(argv[i]+7);
 376                 }
 377                 if (!strncmp(argv[i], "--head=", 7)) {
 378                         ctx.qry.head = xstrdup(argv[i]+7);
 379                         ctx.qry.has_symref = 1;
 380                 }
 381                 if (!strncmp(argv[i], "--sha1=", 7)) {
 382                         ctx.qry.sha1 = xstrdup(argv[i]+7);
 383                         ctx.qry.has_sha1 = 1;
 384                 }
 385                 if (!strncmp(argv[i], "--ofs=", 6)) {
 386                         ctx.qry.ofs = atoi(argv[i]+6);
 387                 }
 388                 if (!strncmp(argv[i], "--scan-tree=", 12)) {
 389                         scan++;
 390                         scan_tree(argv[i] + 12);
 391                 }
 392         }
 393         if (scan) {
 394                 qsort(cgit_repolist.repos, cgit_repolist.count,
 395                         sizeof(struct cgit_repo), cmp_repos);
 396                 print_repolist(&cgit_repolist);
 397                 exit(0);
 398         }
 399 }
 400
 401 static int calc_ttl()
 402 {
 403         if (!ctx.repo)
 404                 return ctx.cfg.cache_root_ttl;
 405
 406         if (!ctx.qry.page)
 407                 return ctx.cfg.cache_repo_ttl;
 408
 409         if (ctx.qry.has_symref)
 410                 return ctx.cfg.cache_dynamic_ttl;
 411
 412         if (ctx.qry.has_sha1)
 413                 return ctx.cfg.cache_static_ttl;
 414
 415         return ctx.cfg.cache_repo_ttl;
 416 }
 417
 418 int main(int argc, const char **argv)
 419 {
 420         const char *cgit_config_env = getenv("CGIT_CONFIG");
 421         const char *path;
 422         char *qry;
 423         int err, ttl;
 424
 425         prepare_context(&ctx);
 426         cgit_repolist.length = 0;
 427         cgit_repolist.count = 0;
 428         cgit_repolist.repos = NULL;
 429
 430         if (getenv("SCRIPT_NAME"))
 431                 ctx.cfg.script_name = xstrdup(getenv("SCRIPT_NAME"));
 432         if (getenv("QUERY_STRING"))
 433                 ctx.qry.raw = xstrdup(getenv("QUERY_STRING"));
 434         cgit_parse_args(argc, argv);
 435         parse_configfile(cgit_config_env ? cgit_config_env : CGIT_CONFIG,
 436                          config_cb);
 437         ctx.repo = NULL;
 438         http_parse_querystring(ctx.qry.raw, querystring_cb);
 439
 440         /* If virtual-root isn't specified in cgitrc and no url
 441          * parameter is specified on the querystring, lets pretend
 442          * that virtualroot equals SCRIPT_NAME and use PATH_INFO as
 443          * url. This allows cgit to work with virtual urls without
 444          * the need for rewriterules in the webserver (as long as
 445          * PATH_INFO is included in the cache lookup key).
 446          */
 447         if (!ctx.cfg.virtual_root && !ctx.qry.url) {
 448                 ctx.cfg.virtual_root = ctx.cfg.script_name;
 449                 path = getenv("PATH_INFO");
 450                 if (path) {
 451                         if (path[0] == '/')
 452                                 path++;
 453                         ctx.qry.url = xstrdup(path);
 454                         if (ctx.qry.raw) {
 455                                 qry = ctx.qry.raw;
 456                                 ctx.qry.raw = xstrdup(fmt("%s?%s", path, qry));
 457                                 free(qry);
 458                         } else
 459                                 ctx.qry.raw = ctx.qry.url;
 460                         cgit_parse_url(ctx.qry.url);
 461                 }
 462         }
 463
 464         ttl = calc_ttl();
 465         ctx.page.expires += ttl*60;
 466         if (ctx.cfg.nocache)
 467                 ctx.cfg.cache_size = 0;
 468         err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
 469                             ctx.qry.raw, ttl, process_request, &ctx);
 470         if (err)
 471                 cgit_print_error(fmt("Error processing page: %s (%d)",
 472                                      strerror(err), err));
 473         return err;
 474 }