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