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