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 "ui-shared.h"
  14
  15 const char *cgit_version = CGIT_VERSION;
  16
  17 void config_cb(const char *name, const char *value)
  18 {
  19         if (!strcmp(name, "root-title"))
  20                 ctx.cfg.root_title = xstrdup(value);
  21         else if (!strcmp(name, "css"))
  22                 ctx.cfg.css = xstrdup(value);
  23         else if (!strcmp(name, "logo"))
  24                 ctx.cfg.logo = xstrdup(value);
  25         else if (!strcmp(name, "index-header"))
  26                 ctx.cfg.index_header = xstrdup(value);
  27         else if (!strcmp(name, "index-info"))
  28                 ctx.cfg.index_info = xstrdup(value);
  29         else if (!strcmp(name, "logo-link"))
  30                 ctx.cfg.logo_link = xstrdup(value);
  31         else if (!strcmp(name, "module-link"))
  32                 ctx.cfg.module_link = xstrdup(value);
  33         else if (!strcmp(name, "virtual-root")) {
  34                 ctx.cfg.virtual_root = trim_end(value, '/');
  35                 if (!ctx.cfg.virtual_root && (!strcmp(value, "/")))
  36                         ctx.cfg.virtual_root = "";
  37         } else if (!strcmp(name, "nocache"))
  38                 ctx.cfg.nocache = atoi(value);
  39         else if (!strcmp(name, "snapshots"))
  40                 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
  41         else if (!strcmp(name, "enable-index-links"))
  42                 ctx.cfg.enable_index_links = atoi(value);
  43         else if (!strcmp(name, "enable-log-filecount"))
  44                 ctx.cfg.enable_log_filecount = atoi(value);
  45         else if (!strcmp(name, "enable-log-linecount"))
  46                 ctx.cfg.enable_log_linecount = atoi(value);
  47         else if (!strcmp(name, "cache-root"))
  48                 ctx.cfg.cache_root = xstrdup(value);
  49         else if (!strcmp(name, "cache-root-ttl"))
  50                 ctx.cfg.cache_root_ttl = atoi(value);
  51         else if (!strcmp(name, "cache-repo-ttl"))
  52                 ctx.cfg.cache_repo_ttl = atoi(value);
  53         else if (!strcmp(name, "cache-static-ttl"))
  54                 ctx.cfg.cache_static_ttl = atoi(value);
  55         else if (!strcmp(name, "cache-dynamic-ttl"))
  56                 ctx.cfg.cache_dynamic_ttl = atoi(value);
  57         else if (!strcmp(name, "max-message-length"))
  58                 ctx.cfg.max_msg_len = atoi(value);
  59         else if (!strcmp(name, "max-repodesc-length"))
  60                 ctx.cfg.max_repodesc_len = atoi(value);
  61         else if (!strcmp(name, "max-commit-count"))
  62                 ctx.cfg.max_commit_count = atoi(value);
  63         else if (!strcmp(name, "summary-log"))
  64                 ctx.cfg.summary_log = atoi(value);
  65         else if (!strcmp(name, "summary-branches"))
  66                 ctx.cfg.summary_branches = atoi(value);
  67         else if (!strcmp(name, "summary-tags"))
  68                 ctx.cfg.summary_tags = atoi(value);
  69         else if (!strcmp(name, "agefile"))
  70                 ctx.cfg.agefile = xstrdup(value);
  71         else if (!strcmp(name, "renamelimit"))
  72                 ctx.cfg.renamelimit = atoi(value);
  73         else if (!strcmp(name, "robots"))
  74                 ctx.cfg.robots = xstrdup(value);
  75         else if (!strcmp(name, "clone-prefix"))
  76                 ctx.cfg.clone_prefix = xstrdup(value);
  77         else if (!strcmp(name, "repo.group"))
  78                 ctx.cfg.repo_group = xstrdup(value);
  79         else if (!strcmp(name, "repo.url"))
  80                 ctx.repo = cgit_add_repo(value);
  81         else if (!strcmp(name, "repo.name"))
  82                 ctx.repo->name = xstrdup(value);
  83         else if (ctx.repo && !strcmp(name, "repo.path"))
  84                 ctx.repo->path = trim_end(value, '/');
  85         else if (ctx.repo && !strcmp(name, "repo.clone-url"))
  86                 ctx.repo->clone_url = xstrdup(value);
  87         else if (ctx.repo && !strcmp(name, "repo.desc"))
  88                 ctx.repo->desc = xstrdup(value);
  89         else if (ctx.repo && !strcmp(name, "repo.owner"))
  90                 ctx.repo->owner = xstrdup(value);
  91         else if (ctx.repo && !strcmp(name, "repo.defbranch"))
  92                 ctx.repo->defbranch = xstrdup(value);
  93         else if (ctx.repo && !strcmp(name, "repo.snapshots"))
  94                 ctx.repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); /* XXX: &? */
  95         else if (ctx.repo && !strcmp(name, "repo.enable-log-filecount"))
  96                 ctx.repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
  97         else if (ctx.repo && !strcmp(name, "repo.enable-log-linecount"))
  98                 ctx.repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
  99         else if (ctx.repo && !strcmp(name, "repo.module-link"))
 100                 ctx.repo->module_link= xstrdup(value);
 101         else if (ctx.repo && !strcmp(name, "repo.readme") && value != NULL) {
 102                 if (*value == '/')
 103                         ctx.repo->readme = xstrdup(value);
 104                 else
 105                         ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value));
 106         } else if (!strcmp(name, "include"))
 107                 parse_configfile(value, config_cb);
 108 }
 109
 110 static void querystring_cb(const char *name, const char *value)
 111 {
 112         if (!strcmp(name,"r")) {
 113                 ctx.qry.repo = xstrdup(value);
 114                 ctx.repo = cgit_get_repoinfo(value);
 115         } else if (!strcmp(name, "p")) {
 116                 ctx.qry.page = xstrdup(value);
 117         } else if (!strcmp(name, "url")) {
 118                 cgit_parse_url(value);
 119         } else if (!strcmp(name, "qt")) {
 120                 ctx.qry.grep = xstrdup(value);
 121         } else if (!strcmp(name, "q")) {
 122                 ctx.qry.search = xstrdup(value);
 123         } else if (!strcmp(name, "h")) {
 124                 ctx.qry.head = xstrdup(value);
 125                 ctx.qry.has_symref = 1;
 126         } else if (!strcmp(name, "id")) {
 127                 ctx.qry.sha1 = xstrdup(value);
 128                 ctx.qry.has_sha1 = 1;
 129         } else if (!strcmp(name, "id2")) {
 130                 ctx.qry.sha2 = xstrdup(value);
 131                 ctx.qry.has_sha1 = 1;
 132         } else if (!strcmp(name, "ofs")) {
 133                 ctx.qry.ofs = atoi(value);
 134         } else if (!strcmp(name, "path")) {
 135                 ctx.qry.path = trim_end(value, '/');
 136         } else if (!strcmp(name, "name")) {
 137                 ctx.qry.name = xstrdup(value);
 138         }
 139 }
 140
 141 static void prepare_context(struct cgit_context *ctx)
 142 {
 143         memset(ctx, 0, sizeof(ctx));
 144         ctx->cfg.agefile = "info/web/last-modified";
 145         ctx->cfg.cache_dynamic_ttl = 5;
 146         ctx->cfg.cache_max_create_time = 5;
 147         ctx->cfg.cache_repo_ttl = 5;
 148         ctx->cfg.cache_root = CGIT_CACHE_ROOT;
 149         ctx->cfg.cache_root_ttl = 5;
 150         ctx->cfg.cache_static_ttl = -1;
 151         ctx->cfg.css = "/cgit.css";
 152         ctx->cfg.logo = "/git-logo.png";
 153         ctx->cfg.max_commit_count = 50;
 154         ctx->cfg.max_lock_attempts = 5;
 155         ctx->cfg.max_msg_len = 60;
 156         ctx->cfg.max_repodesc_len = 60;
 157         ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
 158         ctx->cfg.renamelimit = -1;
 159         ctx->cfg.robots = "index, nofollow";
 160         ctx->cfg.root_title = "Git repository browser";
 161         ctx->cfg.script_name = CGIT_SCRIPT_NAME;
 162         ctx->page.mimetype = "text/html";
 163         ctx->page.charset = PAGE_ENCODING;
 164         ctx->page.filename = NULL;
 165 }
 166
 167 static int cgit_prepare_cache(struct cacheitem *item)
 168 {
 169         if (!ctx.repo && ctx.qry.repo) {
 170                 ctx.page.title = fmt("%s - %s", ctx.cfg.root_title,
 171                                       "Bad request");
 172                 cgit_print_http_headers(&ctx);
 173                 cgit_print_docstart(&ctx);
 174                 cgit_print_pageheader(&ctx);
 175                 cgit_print_error(fmt("Unknown repo: %s", ctx.qry.repo));
 176                 cgit_print_docend();
 177                 return 0;
 178         }
 179
 180         if (!ctx.repo) {
 181                 item->name = xstrdup(fmt("%s/index.html", ctx.cfg.cache_root));
 182                 item->ttl = ctx.cfg.cache_root_ttl;
 183                 return 1;
 184         }
 185
 186         if (!ctx.qry.page) {
 187                 item->name = xstrdup(fmt("%s/%s/index.%s.html", ctx.cfg.cache_root,
 188                                          cache_safe_filename(ctx.repo->url),
 189                                          cache_safe_filename(ctx.qry.raw)));
 190                 item->ttl = ctx.cfg.cache_repo_ttl;
 191         } else {
 192                 item->name = xstrdup(fmt("%s/%s/%s/%s.html", ctx.cfg.cache_root,
 193                                          cache_safe_filename(ctx.repo->url),
 194                                          ctx.qry.page,
 195                                          cache_safe_filename(ctx.qry.raw)));
 196                 if (ctx.qry.has_symref)
 197                         item->ttl = ctx.cfg.cache_dynamic_ttl;
 198                 else if (ctx.qry.has_sha1)
 199                         item->ttl = ctx.cfg.cache_static_ttl;
 200                 else
 201                         item->ttl = ctx.cfg.cache_repo_ttl;
 202         }
 203         return 1;
 204 }
 205
 206 struct refmatch {
 207         char *req_ref;
 208         char *first_ref;
 209         int match;
 210 };
 211
 212 int find_current_ref(const char *refname, const unsigned char *sha1,
 213                      int flags, void *cb_data)
 214 {
 215         struct refmatch *info;
 216
 217         info = (struct refmatch *)cb_data;
 218         if (!strcmp(refname, info->req_ref))
 219                 info->match = 1;
 220         if (!info->first_ref)
 221                 info->first_ref = xstrdup(refname);
 222         return info->match;
 223 }
 224
 225 char *find_default_branch(struct cgit_repo *repo)
 226 {
 227         struct refmatch info;
 228
 229         info.req_ref = repo->defbranch;
 230         info.first_ref = NULL;
 231         info.match = 0;
 232         for_each_branch_ref(find_current_ref, &info);
 233         if (info.match)
 234                 return info.req_ref;
 235         else
 236                 return info.first_ref;
 237 }
 238
 239 static int prepare_repo_cmd(struct cgit_context *ctx)
 240 {
 241         char *tmp;
 242         unsigned char sha1[20];
 243         int nongit = 0;
 244
 245         setenv("GIT_DIR", ctx->repo->path, 1);
 246         setup_git_directory_gently(&nongit);
 247         if (nongit) {
 248                 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
 249                                       "config error");
 250                 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
 251                 ctx->repo = NULL;
 252                 cgit_print_http_headers(ctx);
 253                 cgit_print_docstart(ctx);
 254                 cgit_print_pageheader(ctx);
 255                 cgit_print_error(tmp);
 256                 cgit_print_docend();
 257                 return 1;
 258         }
 259         ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
 260
 261         if (!ctx->qry.head) {
 262                 ctx->qry.head = xstrdup(find_default_branch(ctx->repo));
 263                 ctx->repo->defbranch = ctx->qry.head;
 264         }
 265
 266         if (!ctx->qry.head) {
 267                 cgit_print_http_headers(ctx);
 268                 cgit_print_docstart(ctx);
 269                 cgit_print_pageheader(ctx);
 270                 cgit_print_error("Repository seems to be empty");
 271                 cgit_print_docend();
 272                 return 1;
 273         }
 274
 275         if (get_sha1(ctx->qry.head, sha1)) {
 276                 tmp = xstrdup(ctx->qry.head);
 277                 ctx->qry.head = ctx->repo->defbranch;
 278                 cgit_print_http_headers(ctx);
 279                 cgit_print_docstart(ctx);
 280                 cgit_print_pageheader(ctx);
 281                 cgit_print_error(fmt("Invalid branch: %s", tmp));
 282                 cgit_print_docend();
 283                 return 1;
 284         }
 285         return 0;
 286 }
 287
 288 static void process_request(struct cgit_context *ctx)
 289 {
 290         struct cgit_cmd *cmd;
 291
 292         cmd = cgit_get_cmd(ctx);
 293         if (!cmd) {
 294                 ctx->page.title = "cgit error";
 295                 ctx->repo = NULL;
 296                 cgit_print_http_headers(ctx);
 297                 cgit_print_docstart(ctx);
 298                 cgit_print_pageheader(ctx);
 299                 cgit_print_error("Invalid request");
 300                 cgit_print_docend();
 301                 return;
 302         }
 303
 304         if (cmd->want_repo && prepare_repo_cmd(ctx))
 305                 return;
 306
 307         if (cmd->want_layout) {
 308                 cgit_print_http_headers(ctx);
 309                 cgit_print_docstart(ctx);
 310                 cgit_print_pageheader(ctx);
 311         }
 312
 313         cmd->fn(ctx);
 314
 315         if (cmd->want_layout)
 316                 cgit_print_docend();
 317 }
 318
 319 static long ttl_seconds(long ttl)
 320 {
 321         if (ttl<0)
 322                 return 60 * 60 * 24 * 365;
 323         else
 324                 return ttl * 60;
 325 }
 326
 327 static void cgit_fill_cache(struct cacheitem *item, int use_cache)
 328 {
 329         int stdout2;
 330
 331         if (use_cache) {
 332                 stdout2 = chk_positive(dup(STDOUT_FILENO),
 333                                        "Preserving STDOUT");
 334                 chk_zero(close(STDOUT_FILENO), "Closing STDOUT");
 335                 chk_positive(dup2(item->fd, STDOUT_FILENO), "Dup2(cachefile)");
 336         }
 337
 338         ctx.page.modified = time(NULL);
 339         ctx.page.expires = ctx.page.modified + ttl_seconds(item->ttl);
 340         process_request(&ctx);
 341
 342         if (use_cache) {
 343                 chk_zero(close(STDOUT_FILENO), "Close redirected STDOUT");
 344                 chk_positive(dup2(stdout2, STDOUT_FILENO),
 345                              "Restoring original STDOUT");
 346                 chk_zero(close(stdout2), "Closing temporary STDOUT");
 347         }
 348 }
 349
 350 static void cgit_check_cache(struct cacheitem *item)
 351 {
 352         int i = 0;
 353
 354  top:
 355         if (++i > ctx.cfg.max_lock_attempts) {
 356                 die("cgit_refresh_cache: unable to lock %s: %s",
 357                     item->name, strerror(errno));
 358         }
 359         if (!cache_exist(item)) {
 360                 if (!cache_lock(item)) {
 361                         sleep(1);
 362                         goto top;
 363                 }
 364                 if (!cache_exist(item)) {
 365                         cgit_fill_cache(item, 1);
 366                         cache_unlock(item);
 367                 } else {
 368                         cache_cancel_lock(item);
 369                 }
 370         } else if (cache_expired(item) && cache_lock(item)) {
 371                 if (cache_expired(item)) {
 372                         cgit_fill_cache(item, 1);
 373                         cache_unlock(item);
 374                 } else {
 375                         cache_cancel_lock(item);
 376                 }
 377         }
 378 }
 379
 380 static void cgit_print_cache(struct cacheitem *item)
 381 {
 382         static char buf[4096];
 383         ssize_t i;
 384
 385         int fd = open(item->name, O_RDONLY);
 386         if (fd<0)
 387                 die("Unable to open cached file %s", item->name);
 388
 389         while((i=read(fd, buf, sizeof(buf))) > 0)
 390                 write(STDOUT_FILENO, buf, i);
 391
 392         close(fd);
 393 }
 394
 395 static void cgit_parse_args(int argc, const char **argv)
 396 {
 397         int i;
 398
 399         for (i = 1; i < argc; i++) {
 400                 if (!strncmp(argv[i], "--cache=", 8)) {
 401                         ctx.cfg.cache_root = xstrdup(argv[i]+8);
 402                 }
 403                 if (!strcmp(argv[i], "--nocache")) {
 404                         ctx.cfg.nocache = 1;
 405                 }
 406                 if (!strncmp(argv[i], "--query=", 8)) {
 407                         ctx.qry.raw = xstrdup(argv[i]+8);
 408                 }
 409                 if (!strncmp(argv[i], "--repo=", 7)) {
 410                         ctx.qry.repo = xstrdup(argv[i]+7);
 411                 }
 412                 if (!strncmp(argv[i], "--page=", 7)) {
 413                         ctx.qry.page = xstrdup(argv[i]+7);
 414                 }
 415                 if (!strncmp(argv[i], "--head=", 7)) {
 416                         ctx.qry.head = xstrdup(argv[i]+7);
 417                         ctx.qry.has_symref = 1;
 418                 }
 419                 if (!strncmp(argv[i], "--sha1=", 7)) {
 420                         ctx.qry.sha1 = xstrdup(argv[i]+7);
 421                         ctx.qry.has_sha1 = 1;
 422                 }
 423                 if (!strncmp(argv[i], "--ofs=", 6)) {
 424                         ctx.qry.ofs = atoi(argv[i]+6);
 425                 }
 426         }
 427 }
 428
 429 int main(int argc, const char **argv)
 430 {
 431         struct cacheitem item;
 432         const char *cgit_config_env = getenv("CGIT_CONFIG");
 433
 434         prepare_context(&ctx);
 435         item.st.st_mtime = time(NULL);
 436         cgit_repolist.length = 0;
 437         cgit_repolist.count = 0;
 438         cgit_repolist.repos = NULL;
 439
 440         parse_configfile(cgit_config_env ? cgit_config_env : CGIT_CONFIG,
 441                          config_cb);
 442         if (getenv("SCRIPT_NAME"))
 443                 ctx.cfg.script_name = xstrdup(getenv("SCRIPT_NAME"));
 444         if (getenv("QUERY_STRING"))
 445                 ctx.qry.raw = xstrdup(getenv("QUERY_STRING"));
 446         cgit_parse_args(argc, argv);
 447         cgit_parse_query(ctx.qry.raw, querystring_cb);
 448         if (!cgit_prepare_cache(&item))
 449                 return 0;
 450         if (ctx.cfg.nocache) {
 451                 cgit_fill_cache(&item, 0);
 452         } else {
 453                 cgit_check_cache(&item);
 454                 cgit_print_cache(&item);
 455         }
 456         return 0;
 457 }