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