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