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