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