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