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