]> gitweb.ps.run Git - ps-cgit/blob - cgit.c
Use skip_prefix() to get rid of magic constants
[ps-cgit] / cgit.c
1 /* cgit.c: cgi for the git scm
2  *
3  * Copyright (C) 2006-2014 cgit Development Team <cgit@lists.zx2c4.com>
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 "ui-blob.h"
17 #include "ui-summary.h"
18 #include "scan-tree.h"
19
20 const char *cgit_version = CGIT_VERSION;
21
22 static void add_mimetype(const char *name, const char *value)
23 {
24         struct string_list_item *item;
25
26         item = string_list_insert(&ctx.cfg.mimetypes, xstrdup(name));
27         item->util = xstrdup(value);
28 }
29
30 static void process_cached_repolist(const char *path);
31
32 static void repo_config(struct cgit_repo *repo, const char *name, const char *value)
33 {
34         const char *path;
35         struct string_list_item *item;
36
37         if (!strcmp(name, "name"))
38                 repo->name = xstrdup(value);
39         else if (!strcmp(name, "clone-url"))
40                 repo->clone_url = xstrdup(value);
41         else if (!strcmp(name, "desc"))
42                 repo->desc = xstrdup(value);
43         else if (!strcmp(name, "owner"))
44                 repo->owner = xstrdup(value);
45         else if (!strcmp(name, "homepage"))
46                 repo->homepage = xstrdup(value);
47         else if (!strcmp(name, "defbranch"))
48                 repo->defbranch = xstrdup(value);
49         else if (!strcmp(name, "snapshots"))
50                 repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value);
51         else if (!strcmp(name, "enable-commit-graph"))
52                 repo->enable_commit_graph = atoi(value);
53         else if (!strcmp(name, "enable-log-filecount"))
54                 repo->enable_log_filecount = atoi(value);
55         else if (!strcmp(name, "enable-log-linecount"))
56                 repo->enable_log_linecount = atoi(value);
57         else if (!strcmp(name, "enable-remote-branches"))
58                 repo->enable_remote_branches = atoi(value);
59         else if (!strcmp(name, "enable-subject-links"))
60                 repo->enable_subject_links = atoi(value);
61         else if (!strcmp(name, "enable-html-serving"))
62                 repo->enable_html_serving = atoi(value);
63         else if (!strcmp(name, "branch-sort")) {
64                 if (!strcmp(value, "age"))
65                         repo->branch_sort = 1;
66                 if (!strcmp(value, "name"))
67                         repo->branch_sort = 0;
68         } else if (!strcmp(name, "commit-sort")) {
69                 if (!strcmp(value, "date"))
70                         repo->commit_sort = 1;
71                 if (!strcmp(value, "topo"))
72                         repo->commit_sort = 2;
73         } else if (!strcmp(name, "max-stats"))
74                 repo->max_stats = cgit_find_stats_period(value, NULL);
75         else if (!strcmp(name, "module-link"))
76                 repo->module_link= xstrdup(value);
77         else if (skip_prefix(name, "module-link.", &path)) {
78                 item = string_list_append(&repo->submodules, xstrdup(path));
79                 item->util = xstrdup(value);
80         } else if (!strcmp(name, "section"))
81                 repo->section = xstrdup(value);
82         else if (!strcmp(name, "readme") && value != NULL) {
83                 if (repo->readme.items == ctx.cfg.readme.items)
84                         memset(&repo->readme, 0, sizeof(repo->readme));
85                 string_list_append(&repo->readme, xstrdup(value));
86         } else if (!strcmp(name, "logo") && value != NULL)
87                 repo->logo = xstrdup(value);
88         else if (!strcmp(name, "logo-link") && value != NULL)
89                 repo->logo_link = xstrdup(value);
90         else if (!strcmp(name, "hide"))
91                 repo->hide = atoi(value);
92         else if (!strcmp(name, "ignore"))
93                 repo->ignore = atoi(value);
94         else if (ctx.cfg.enable_filter_overrides) {
95                 if (!strcmp(name, "about-filter"))
96                         repo->about_filter = cgit_new_filter(value, ABOUT);
97                 else if (!strcmp(name, "commit-filter"))
98                         repo->commit_filter = cgit_new_filter(value, COMMIT);
99                 else if (!strcmp(name, "source-filter"))
100                         repo->source_filter = cgit_new_filter(value, SOURCE);
101                 else if (!strcmp(name, "email-filter"))
102                         repo->email_filter = cgit_new_filter(value, EMAIL);
103                 else if (!strcmp(name, "owner-filter"))
104                         repo->owner_filter = cgit_new_filter(value, OWNER);
105         }
106 }
107
108 static void config_cb(const char *name, const char *value)
109 {
110         const char *arg;
111
112         if (!strcmp(name, "section") || !strcmp(name, "repo.group"))
113                 ctx.cfg.section = xstrdup(value);
114         else if (!strcmp(name, "repo.url"))
115                 ctx.repo = cgit_add_repo(value);
116         else if (ctx.repo && !strcmp(name, "repo.path"))
117                 ctx.repo->path = trim_end(value, '/');
118         else if (ctx.repo && skip_prefix(name, "repo.", &arg))
119                 repo_config(ctx.repo, arg, value);
120         else if (!strcmp(name, "readme"))
121                 string_list_append(&ctx.cfg.readme, xstrdup(value));
122         else if (!strcmp(name, "root-title"))
123                 ctx.cfg.root_title = xstrdup(value);
124         else if (!strcmp(name, "root-desc"))
125                 ctx.cfg.root_desc = xstrdup(value);
126         else if (!strcmp(name, "root-readme"))
127                 ctx.cfg.root_readme = xstrdup(value);
128         else if (!strcmp(name, "css"))
129                 ctx.cfg.css = xstrdup(value);
130         else if (!strcmp(name, "favicon"))
131                 ctx.cfg.favicon = xstrdup(value);
132         else if (!strcmp(name, "footer"))
133                 ctx.cfg.footer = xstrdup(value);
134         else if (!strcmp(name, "head-include"))
135                 ctx.cfg.head_include = xstrdup(value);
136         else if (!strcmp(name, "header"))
137                 ctx.cfg.header = xstrdup(value);
138         else if (!strcmp(name, "logo"))
139                 ctx.cfg.logo = xstrdup(value);
140         else if (!strcmp(name, "index-header"))
141                 ctx.cfg.index_header = xstrdup(value);
142         else if (!strcmp(name, "index-info"))
143                 ctx.cfg.index_info = xstrdup(value);
144         else if (!strcmp(name, "logo-link"))
145                 ctx.cfg.logo_link = xstrdup(value);
146         else if (!strcmp(name, "module-link"))
147                 ctx.cfg.module_link = xstrdup(value);
148         else if (!strcmp(name, "strict-export"))
149                 ctx.cfg.strict_export = xstrdup(value);
150         else if (!strcmp(name, "virtual-root")) {
151                 ctx.cfg.virtual_root = ensure_end(value, '/');
152         } else if (!strcmp(name, "nocache"))
153                 ctx.cfg.nocache = atoi(value);
154         else if (!strcmp(name, "noplainemail"))
155                 ctx.cfg.noplainemail = atoi(value);
156         else if (!strcmp(name, "noheader"))
157                 ctx.cfg.noheader = atoi(value);
158         else if (!strcmp(name, "snapshots"))
159                 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
160         else if (!strcmp(name, "enable-filter-overrides"))
161                 ctx.cfg.enable_filter_overrides = atoi(value);
162         else if (!strcmp(name, "enable-follow-links"))
163                 ctx.cfg.enable_follow_links = atoi(value);
164         else if (!strcmp(name, "enable-http-clone"))
165                 ctx.cfg.enable_http_clone = atoi(value);
166         else if (!strcmp(name, "enable-index-links"))
167                 ctx.cfg.enable_index_links = atoi(value);
168         else if (!strcmp(name, "enable-index-owner"))
169                 ctx.cfg.enable_index_owner = atoi(value);
170         else if (!strcmp(name, "enable-commit-graph"))
171                 ctx.cfg.enable_commit_graph = atoi(value);
172         else if (!strcmp(name, "enable-log-filecount"))
173                 ctx.cfg.enable_log_filecount = atoi(value);
174         else if (!strcmp(name, "enable-log-linecount"))
175                 ctx.cfg.enable_log_linecount = atoi(value);
176         else if (!strcmp(name, "enable-remote-branches"))
177                 ctx.cfg.enable_remote_branches = atoi(value);
178         else if (!strcmp(name, "enable-subject-links"))
179                 ctx.cfg.enable_subject_links = atoi(value);
180         else if (!strcmp(name, "enable-html-serving"))
181                 ctx.cfg.enable_html_serving = atoi(value);
182         else if (!strcmp(name, "enable-tree-linenumbers"))
183                 ctx.cfg.enable_tree_linenumbers = atoi(value);
184         else if (!strcmp(name, "enable-git-config"))
185                 ctx.cfg.enable_git_config = atoi(value);
186         else if (!strcmp(name, "max-stats"))
187                 ctx.cfg.max_stats = cgit_find_stats_period(value, NULL);
188         else if (!strcmp(name, "cache-size"))
189                 ctx.cfg.cache_size = atoi(value);
190         else if (!strcmp(name, "cache-root"))
191                 ctx.cfg.cache_root = xstrdup(expand_macros(value));
192         else if (!strcmp(name, "cache-root-ttl"))
193                 ctx.cfg.cache_root_ttl = atoi(value);
194         else if (!strcmp(name, "cache-repo-ttl"))
195                 ctx.cfg.cache_repo_ttl = atoi(value);
196         else if (!strcmp(name, "cache-scanrc-ttl"))
197                 ctx.cfg.cache_scanrc_ttl = atoi(value);
198         else if (!strcmp(name, "cache-static-ttl"))
199                 ctx.cfg.cache_static_ttl = atoi(value);
200         else if (!strcmp(name, "cache-dynamic-ttl"))
201                 ctx.cfg.cache_dynamic_ttl = atoi(value);
202         else if (!strcmp(name, "cache-about-ttl"))
203                 ctx.cfg.cache_about_ttl = atoi(value);
204         else if (!strcmp(name, "cache-snapshot-ttl"))
205                 ctx.cfg.cache_snapshot_ttl = atoi(value);
206         else if (!strcmp(name, "case-sensitive-sort"))
207                 ctx.cfg.case_sensitive_sort = atoi(value);
208         else if (!strcmp(name, "about-filter"))
209                 ctx.cfg.about_filter = cgit_new_filter(value, ABOUT);
210         else if (!strcmp(name, "commit-filter"))
211                 ctx.cfg.commit_filter = cgit_new_filter(value, COMMIT);
212         else if (!strcmp(name, "email-filter"))
213                 ctx.cfg.email_filter = cgit_new_filter(value, EMAIL);
214         else if (!strcmp(name, "owner-filter"))
215                 ctx.cfg.owner_filter = cgit_new_filter(value, OWNER);
216         else if (!strcmp(name, "auth-filter"))
217                 ctx.cfg.auth_filter = cgit_new_filter(value, AUTH);
218         else if (!strcmp(name, "embedded"))
219                 ctx.cfg.embedded = atoi(value);
220         else if (!strcmp(name, "max-atom-items"))
221                 ctx.cfg.max_atom_items = atoi(value);
222         else if (!strcmp(name, "max-message-length"))
223                 ctx.cfg.max_msg_len = atoi(value);
224         else if (!strcmp(name, "max-repodesc-length"))
225                 ctx.cfg.max_repodesc_len = atoi(value);
226         else if (!strcmp(name, "max-blob-size"))
227                 ctx.cfg.max_blob_size = atoi(value);
228         else if (!strcmp(name, "max-repo-count"))
229                 ctx.cfg.max_repo_count = atoi(value);
230         else if (!strcmp(name, "max-commit-count"))
231                 ctx.cfg.max_commit_count = atoi(value);
232         else if (!strcmp(name, "project-list"))
233                 ctx.cfg.project_list = xstrdup(expand_macros(value));
234         else if (!strcmp(name, "scan-path"))
235                 if (!ctx.cfg.nocache && ctx.cfg.cache_size)
236                         process_cached_repolist(expand_macros(value));
237                 else if (ctx.cfg.project_list)
238                         scan_projects(expand_macros(value),
239                                       ctx.cfg.project_list, repo_config);
240                 else
241                         scan_tree(expand_macros(value), repo_config);
242         else if (!strcmp(name, "scan-hidden-path"))
243                 ctx.cfg.scan_hidden_path = atoi(value);
244         else if (!strcmp(name, "section-from-path"))
245                 ctx.cfg.section_from_path = atoi(value);
246         else if (!strcmp(name, "repository-sort"))
247                 ctx.cfg.repository_sort = xstrdup(value);
248         else if (!strcmp(name, "section-sort"))
249                 ctx.cfg.section_sort = atoi(value);
250         else if (!strcmp(name, "source-filter"))
251                 ctx.cfg.source_filter = cgit_new_filter(value, SOURCE);
252         else if (!strcmp(name, "summary-log"))
253                 ctx.cfg.summary_log = atoi(value);
254         else if (!strcmp(name, "summary-branches"))
255                 ctx.cfg.summary_branches = atoi(value);
256         else if (!strcmp(name, "summary-tags"))
257                 ctx.cfg.summary_tags = atoi(value);
258         else if (!strcmp(name, "side-by-side-diffs"))
259                 ctx.cfg.difftype = atoi(value) ? DIFF_SSDIFF : DIFF_UNIFIED;
260         else if (!strcmp(name, "agefile"))
261                 ctx.cfg.agefile = xstrdup(value);
262         else if (!strcmp(name, "mimetype-file"))
263                 ctx.cfg.mimetype_file = xstrdup(value);
264         else if (!strcmp(name, "renamelimit"))
265                 ctx.cfg.renamelimit = atoi(value);
266         else if (!strcmp(name, "remove-suffix"))
267                 ctx.cfg.remove_suffix = atoi(value);
268         else if (!strcmp(name, "robots"))
269                 ctx.cfg.robots = xstrdup(value);
270         else if (!strcmp(name, "clone-prefix"))
271                 ctx.cfg.clone_prefix = xstrdup(value);
272         else if (!strcmp(name, "clone-url"))
273                 ctx.cfg.clone_url = xstrdup(value);
274         else if (!strcmp(name, "local-time"))
275                 ctx.cfg.local_time = atoi(value);
276         else if (!strcmp(name, "commit-sort")) {
277                 if (!strcmp(value, "date"))
278                         ctx.cfg.commit_sort = 1;
279                 if (!strcmp(value, "topo"))
280                         ctx.cfg.commit_sort = 2;
281         } else if (!strcmp(name, "branch-sort")) {
282                 if (!strcmp(value, "age"))
283                         ctx.cfg.branch_sort = 1;
284                 if (!strcmp(value, "name"))
285                         ctx.cfg.branch_sort = 0;
286         } else if (skip_prefix(name, "mimetype.", &arg))
287                 add_mimetype(arg, value);
288         else if (!strcmp(name, "include"))
289                 parse_configfile(expand_macros(value), config_cb);
290 }
291
292 static void querystring_cb(const char *name, const char *value)
293 {
294         if (!value)
295                 value = "";
296
297         if (!strcmp(name,"r")) {
298                 ctx.qry.repo = xstrdup(value);
299                 ctx.repo = cgit_get_repoinfo(value);
300         } else if (!strcmp(name, "p")) {
301                 ctx.qry.page = xstrdup(value);
302         } else if (!strcmp(name, "url")) {
303                 if (*value == '/')
304                         value++;
305                 ctx.qry.url = xstrdup(value);
306                 cgit_parse_url(value);
307         } else if (!strcmp(name, "qt")) {
308                 ctx.qry.grep = xstrdup(value);
309         } else if (!strcmp(name, "q")) {
310                 ctx.qry.search = xstrdup(value);
311         } else if (!strcmp(name, "h")) {
312                 ctx.qry.head = xstrdup(value);
313                 ctx.qry.has_symref = 1;
314         } else if (!strcmp(name, "id")) {
315                 ctx.qry.sha1 = xstrdup(value);
316                 ctx.qry.has_sha1 = 1;
317         } else if (!strcmp(name, "id2")) {
318                 ctx.qry.sha2 = xstrdup(value);
319                 ctx.qry.has_sha1 = 1;
320         } else if (!strcmp(name, "ofs")) {
321                 ctx.qry.ofs = atoi(value);
322         } else if (!strcmp(name, "path")) {
323                 ctx.qry.path = trim_end(value, '/');
324         } else if (!strcmp(name, "name")) {
325                 ctx.qry.name = xstrdup(value);
326         } else if (!strcmp(name, "s")) {
327                 ctx.qry.sort = xstrdup(value);
328         } else if (!strcmp(name, "showmsg")) {
329                 ctx.qry.showmsg = atoi(value);
330         } else if (!strcmp(name, "period")) {
331                 ctx.qry.period = xstrdup(value);
332         } else if (!strcmp(name, "dt")) {
333                 ctx.qry.difftype = atoi(value);
334                 ctx.qry.has_difftype = 1;
335         } else if (!strcmp(name, "ss")) {
336                 /* No longer generated, but there may be links out there. */
337                 ctx.qry.difftype = atoi(value) ? DIFF_SSDIFF : DIFF_UNIFIED;
338                 ctx.qry.has_difftype = 1;
339         } else if (!strcmp(name, "all")) {
340                 ctx.qry.show_all = atoi(value);
341         } else if (!strcmp(name, "context")) {
342                 ctx.qry.context = atoi(value);
343         } else if (!strcmp(name, "ignorews")) {
344                 ctx.qry.ignorews = atoi(value);
345         } else if (!strcmp(name, "follow")) {
346                 ctx.qry.follow = atoi(value);
347         }
348 }
349
350 static void prepare_context(void)
351 {
352         memset(&ctx, 0, sizeof(ctx));
353         ctx.cfg.agefile = "info/web/last-modified";
354         ctx.cfg.nocache = 0;
355         ctx.cfg.cache_size = 0;
356         ctx.cfg.cache_max_create_time = 5;
357         ctx.cfg.cache_root = CGIT_CACHE_ROOT;
358         ctx.cfg.cache_about_ttl = 15;
359         ctx.cfg.cache_snapshot_ttl = 5;
360         ctx.cfg.cache_repo_ttl = 5;
361         ctx.cfg.cache_root_ttl = 5;
362         ctx.cfg.cache_scanrc_ttl = 15;
363         ctx.cfg.cache_dynamic_ttl = 5;
364         ctx.cfg.cache_static_ttl = -1;
365         ctx.cfg.case_sensitive_sort = 1;
366         ctx.cfg.branch_sort = 0;
367         ctx.cfg.commit_sort = 0;
368         ctx.cfg.css = "/cgit.css";
369         ctx.cfg.logo = "/cgit.png";
370         ctx.cfg.favicon = "/favicon.ico";
371         ctx.cfg.local_time = 0;
372         ctx.cfg.enable_http_clone = 1;
373         ctx.cfg.enable_index_owner = 1;
374         ctx.cfg.enable_tree_linenumbers = 1;
375         ctx.cfg.enable_git_config = 0;
376         ctx.cfg.max_repo_count = 50;
377         ctx.cfg.max_commit_count = 50;
378         ctx.cfg.max_lock_attempts = 5;
379         ctx.cfg.max_msg_len = 80;
380         ctx.cfg.max_repodesc_len = 80;
381         ctx.cfg.max_blob_size = 0;
382         ctx.cfg.max_stats = 0;
383         ctx.cfg.project_list = NULL;
384         ctx.cfg.renamelimit = -1;
385         ctx.cfg.remove_suffix = 0;
386         ctx.cfg.robots = "index, nofollow";
387         ctx.cfg.root_title = "Git repository browser";
388         ctx.cfg.root_desc = "a fast webinterface for the git dscm";
389         ctx.cfg.scan_hidden_path = 0;
390         ctx.cfg.script_name = CGIT_SCRIPT_NAME;
391         ctx.cfg.section = "";
392         ctx.cfg.repository_sort = "name";
393         ctx.cfg.section_sort = 1;
394         ctx.cfg.summary_branches = 10;
395         ctx.cfg.summary_log = 10;
396         ctx.cfg.summary_tags = 10;
397         ctx.cfg.max_atom_items = 10;
398         ctx.cfg.difftype = DIFF_UNIFIED;
399         ctx.env.cgit_config = getenv("CGIT_CONFIG");
400         ctx.env.http_host = getenv("HTTP_HOST");
401         ctx.env.https = getenv("HTTPS");
402         ctx.env.no_http = getenv("NO_HTTP");
403         ctx.env.path_info = getenv("PATH_INFO");
404         ctx.env.query_string = getenv("QUERY_STRING");
405         ctx.env.request_method = getenv("REQUEST_METHOD");
406         ctx.env.script_name = getenv("SCRIPT_NAME");
407         ctx.env.server_name = getenv("SERVER_NAME");
408         ctx.env.server_port = getenv("SERVER_PORT");
409         ctx.env.http_cookie = getenv("HTTP_COOKIE");
410         ctx.env.http_referer = getenv("HTTP_REFERER");
411         ctx.env.content_length = getenv("CONTENT_LENGTH") ? strtoul(getenv("CONTENT_LENGTH"), NULL, 10) : 0;
412         ctx.env.authenticated = 0;
413         ctx.page.mimetype = "text/html";
414         ctx.page.charset = PAGE_ENCODING;
415         ctx.page.filename = NULL;
416         ctx.page.size = 0;
417         ctx.page.modified = time(NULL);
418         ctx.page.expires = ctx.page.modified;
419         ctx.page.etag = NULL;
420         memset(&ctx.cfg.mimetypes, 0, sizeof(struct string_list));
421         if (ctx.env.script_name)
422                 ctx.cfg.script_name = xstrdup(ctx.env.script_name);
423         if (ctx.env.query_string)
424                 ctx.qry.raw = xstrdup(ctx.env.query_string);
425         if (!ctx.env.cgit_config)
426                 ctx.env.cgit_config = CGIT_CONFIG;
427 }
428
429 struct refmatch {
430         char *req_ref;
431         char *first_ref;
432         int match;
433 };
434
435 static int find_current_ref(const char *refname, const struct object_id *oid,
436                             int flags, void *cb_data)
437 {
438         struct refmatch *info;
439
440         info = (struct refmatch *)cb_data;
441         if (!strcmp(refname, info->req_ref))
442                 info->match = 1;
443         if (!info->first_ref)
444                 info->first_ref = xstrdup(refname);
445         return info->match;
446 }
447
448 static void free_refmatch_inner(struct refmatch *info)
449 {
450         if (info->first_ref)
451                 free(info->first_ref);
452 }
453
454 static char *find_default_branch(struct cgit_repo *repo)
455 {
456         struct refmatch info;
457         char *ref;
458
459         info.req_ref = repo->defbranch;
460         info.first_ref = NULL;
461         info.match = 0;
462         for_each_branch_ref(find_current_ref, &info);
463         if (info.match)
464                 ref = info.req_ref;
465         else
466                 ref = info.first_ref;
467         if (ref)
468                 ref = xstrdup(ref);
469         free_refmatch_inner(&info);
470
471         return ref;
472 }
473
474 static char *guess_defbranch(void)
475 {
476         const char *ref, *refname;
477         struct object_id oid;
478
479         ref = resolve_ref_unsafe("HEAD", 0, oid.hash, NULL);
480         if (!ref || !skip_prefix(ref, "refs/heads/", &refname))
481                 return "master";
482         return xstrdup(refname);
483 }
484
485 /* The caller must free filename and ref after calling this. */
486 static inline void parse_readme(const char *readme, char **filename, char **ref, struct cgit_repo *repo)
487 {
488         const char *colon;
489
490         *filename = NULL;
491         *ref = NULL;
492
493         if (!readme || !readme[0])
494                 return;
495
496         /* Check if the readme is tracked in the git repo. */
497         colon = strchr(readme, ':');
498         if (colon && strlen(colon) > 1) {
499                 /* If it starts with a colon, we want to use
500                  * the default branch */
501                 if (colon == readme && repo->defbranch)
502                         *ref = xstrdup(repo->defbranch);
503                 else
504                         *ref = xstrndup(readme, colon - readme);
505                 readme = colon + 1;
506         }
507
508         /* Prepend repo path to relative readme path unless tracked. */
509         if (!(*ref) && readme[0] != '/')
510                 *filename = fmtalloc("%s/%s", repo->path, readme);
511         else
512                 *filename = xstrdup(readme);
513 }
514 static void choose_readme(struct cgit_repo *repo)
515 {
516         int found;
517         char *filename, *ref;
518         struct string_list_item *entry;
519
520         if (!repo->readme.nr)
521                 return;
522
523         found = 0;
524         for_each_string_list_item(entry, &repo->readme) {
525                 parse_readme(entry->string, &filename, &ref, repo);
526                 if (!filename) {
527                         free(filename);
528                         free(ref);
529                         continue;
530                 }
531                 if (ref) {
532                         if (cgit_ref_path_exists(filename, ref, 1)) {
533                                 found = 1;
534                                 break;
535                         }
536                 }
537                 else if (!access(filename, R_OK)) {
538                         found = 1;
539                         break;
540                 }
541                 free(filename);
542                 free(ref);
543         }
544         repo->readme.strdup_strings = 1;
545         string_list_clear(&repo->readme, 0);
546         repo->readme.strdup_strings = 0;
547         if (found)
548                 string_list_append(&repo->readme, filename)->util = ref;
549 }
550
551 static void print_no_repo_clone_urls(const char *url)
552 {
553         html("<tr><td><a rel='vcs-git' href='");
554         html_url_path(url);
555         html("' title='");
556         html_attr(ctx.repo->name);
557         html(" Git repository'>");
558         html_txt(url);
559         html("</a></td></tr>\n");
560 }
561
562 static int prepare_repo_cmd(void)
563 {
564         struct object_id oid;
565         int nongit = 0;
566         int rc;
567
568         /* The path to the git repository. */
569         setenv("GIT_DIR", ctx.repo->path, 1);
570
571         /* Do not look in /etc/ for gitconfig and gitattributes. */
572         setenv("GIT_CONFIG_NOSYSTEM", "1", 1);
573         setenv("GIT_ATTR_NOSYSTEM", "1", 1);
574         unsetenv("HOME");
575         unsetenv("XDG_CONFIG_HOME");
576
577         /* Setup the git directory and initialize the notes system. Both of these
578          * load local configuration from the git repository, so we do them both while
579          * the HOME variables are unset. */
580         setup_git_directory_gently(&nongit);
581         init_display_notes(NULL);
582
583         if (nongit) {
584                 const char *name = ctx.repo->name;
585                 rc = errno;
586                 ctx.page.title = fmtalloc("%s - %s", ctx.cfg.root_title,
587                                                 "config error");
588                 ctx.repo = NULL;
589                 cgit_print_http_headers();
590                 cgit_print_docstart();
591                 cgit_print_pageheader();
592                 cgit_print_error("Failed to open %s: %s", name,
593                                  rc ? strerror(rc) : "Not a valid git repository");
594                 cgit_print_docend();
595                 return 1;
596         }
597         ctx.page.title = fmtalloc("%s - %s", ctx.repo->name, ctx.repo->desc);
598
599         if (!ctx.repo->defbranch)
600                 ctx.repo->defbranch = guess_defbranch();
601
602         if (!ctx.qry.head) {
603                 ctx.qry.nohead = 1;
604                 ctx.qry.head = find_default_branch(ctx.repo);
605         }
606
607         if (!ctx.qry.head) {
608                 cgit_print_http_headers();
609                 cgit_print_docstart();
610                 cgit_print_pageheader();
611                 cgit_print_error("Repository seems to be empty");
612                 if (!strcmp(ctx.qry.page, "summary")) {
613                         html("<table class='list'><tr class='nohover'><td>&nbsp;</td></tr><tr class='nohover'><th class='left'>Clone</th></tr>\n");
614                         cgit_prepare_repo_env(ctx.repo);
615                         cgit_add_clone_urls(print_no_repo_clone_urls);
616                         html("</table>\n");
617                 }
618                 cgit_print_docend();
619                 return 1;
620         }
621
622         if (get_oid(ctx.qry.head, &oid)) {
623                 char *old_head = ctx.qry.head;
624                 ctx.qry.head = xstrdup(ctx.repo->defbranch);
625                 cgit_print_error_page(404, "Not found",
626                                 "Invalid branch: %s", old_head);
627                 free(old_head);
628                 return 1;
629         }
630         string_list_sort(&ctx.repo->submodules);
631         cgit_prepare_repo_env(ctx.repo);
632         choose_readme(ctx.repo);
633         return 0;
634 }
635
636 static inline void open_auth_filter(const char *function)
637 {
638         cgit_open_filter(ctx.cfg.auth_filter, function,
639                 ctx.env.http_cookie ? ctx.env.http_cookie : "",
640                 ctx.env.request_method ? ctx.env.request_method : "",
641                 ctx.env.query_string ? ctx.env.query_string : "",
642                 ctx.env.http_referer ? ctx.env.http_referer : "",
643                 ctx.env.path_info ? ctx.env.path_info : "",
644                 ctx.env.http_host ? ctx.env.http_host : "",
645                 ctx.env.https ? ctx.env.https : "",
646                 ctx.qry.repo ? ctx.qry.repo : "",
647                 ctx.qry.page ? ctx.qry.page : "",
648                 ctx.qry.url ? ctx.qry.url : "",
649                 cgit_loginurl());
650 }
651
652 /* We intentionally keep this rather small, instead of looping and
653  * feeding it to the filter a couple bytes at a time. This way, the
654  * filter itself does not need to handle any denial of service or
655  * buffer bloat issues. If this winds up being too small, people
656  * will complain on the mailing list, and we'll increase it as needed. */
657 #define MAX_AUTHENTICATION_POST_BYTES 4096
658 /* The filter is expected to spit out "Status: " and all headers. */
659 static inline void authenticate_post(void)
660 {
661         char buffer[MAX_AUTHENTICATION_POST_BYTES];
662         unsigned int len;
663
664         open_auth_filter("authenticate-post");
665         len = ctx.env.content_length;
666         if (len > MAX_AUTHENTICATION_POST_BYTES)
667                 len = MAX_AUTHENTICATION_POST_BYTES;
668         if (read(STDIN_FILENO, buffer, len) < 0)
669                 die_errno("Could not read POST from stdin");
670         if (write(STDOUT_FILENO, buffer, len) < 0)
671                 die_errno("Could not write POST to stdout");
672         cgit_close_filter(ctx.cfg.auth_filter);
673         exit(0);
674 }
675
676 static inline void authenticate_cookie(void)
677 {
678         /* If we don't have an auth_filter, consider all cookies valid, and thus return early. */
679         if (!ctx.cfg.auth_filter) {
680                 ctx.env.authenticated = 1;
681                 return;
682         }
683
684         /* If we're having something POST'd to /login, we're authenticating POST,
685          * instead of the cookie, so call authenticate_post and bail out early.
686          * This pattern here should match /?p=login with POST. */
687         if (ctx.env.request_method && ctx.qry.page && !ctx.repo && \
688             !strcmp(ctx.env.request_method, "POST") && !strcmp(ctx.qry.page, "login")) {
689                 authenticate_post();
690                 return;
691         }
692
693         /* If we've made it this far, we're authenticating the cookie for real, so do that. */
694         open_auth_filter("authenticate-cookie");
695         ctx.env.authenticated = cgit_close_filter(ctx.cfg.auth_filter);
696 }
697
698 static void process_request(void)
699 {
700         struct cgit_cmd *cmd;
701
702         /* If we're not yet authenticated, no matter what page we're on,
703          * display the authentication body from the auth_filter. This should
704          * never be cached. */
705         if (!ctx.env.authenticated) {
706                 ctx.page.title = "Authentication Required";
707                 cgit_print_http_headers();
708                 cgit_print_docstart();
709                 cgit_print_pageheader();
710                 open_auth_filter("body");
711                 cgit_close_filter(ctx.cfg.auth_filter);
712                 cgit_print_docend();
713                 return;
714         }
715
716         cmd = cgit_get_cmd();
717         if (!cmd) {
718                 ctx.page.title = "cgit error";
719                 cgit_print_error_page(404, "Not found", "Invalid request");
720                 return;
721         }
722
723         if (!ctx.cfg.enable_http_clone && cmd->is_clone) {
724                 ctx.page.title = "cgit error";
725                 cgit_print_error_page(404, "Not found", "Invalid request");
726                 return;
727         }
728
729         /* If cmd->want_vpath is set, assume ctx.qry.path contains a "virtual"
730          * in-project path limit to be made available at ctx.qry.vpath.
731          * Otherwise, no path limit is in effect (ctx.qry.vpath = NULL).
732          */
733         ctx.qry.vpath = cmd->want_vpath ? ctx.qry.path : NULL;
734
735         if (cmd->want_repo && !ctx.repo) {
736                 cgit_print_error_page(400, "Bad request",
737                                 "No repository selected");
738                 return;
739         }
740
741         if (ctx.repo && prepare_repo_cmd())
742                 return;
743
744         cmd->fn();
745 }
746
747 static int cmp_repos(const void *a, const void *b)
748 {
749         const struct cgit_repo *ra = a, *rb = b;
750         return strcmp(ra->url, rb->url);
751 }
752
753 static char *build_snapshot_setting(int bitmap)
754 {
755         const struct cgit_snapshot_format *f;
756         struct strbuf result = STRBUF_INIT;
757
758         for (f = cgit_snapshot_formats; f->suffix; f++) {
759                 if (f->bit & bitmap) {
760                         if (result.len)
761                                 strbuf_addch(&result, ' ');
762                         strbuf_addstr(&result, f->suffix);
763                 }
764         }
765         return strbuf_detach(&result, NULL);
766 }
767
768 static char *get_first_line(char *txt)
769 {
770         char *t = xstrdup(txt);
771         char *p = strchr(t, '\n');
772         if (p)
773                 *p = '\0';
774         return t;
775 }
776
777 static void print_repo(FILE *f, struct cgit_repo *repo)
778 {
779         struct string_list_item *item;
780         fprintf(f, "repo.url=%s\n", repo->url);
781         fprintf(f, "repo.name=%s\n", repo->name);
782         fprintf(f, "repo.path=%s\n", repo->path);
783         if (repo->owner)
784                 fprintf(f, "repo.owner=%s\n", repo->owner);
785         if (repo->desc) {
786                 char *tmp = get_first_line(repo->desc);
787                 fprintf(f, "repo.desc=%s\n", tmp);
788                 free(tmp);
789         }
790         for_each_string_list_item(item, &repo->readme) {
791                 if (item->util)
792                         fprintf(f, "repo.readme=%s:%s\n", (char *)item->util, item->string);
793                 else
794                         fprintf(f, "repo.readme=%s\n", item->string);
795         }
796         if (repo->defbranch)
797                 fprintf(f, "repo.defbranch=%s\n", repo->defbranch);
798         if (repo->module_link)
799                 fprintf(f, "repo.module-link=%s\n", repo->module_link);
800         if (repo->section)
801                 fprintf(f, "repo.section=%s\n", repo->section);
802         if (repo->homepage)
803                 fprintf(f, "repo.homepage=%s\n", repo->homepage);
804         if (repo->clone_url)
805                 fprintf(f, "repo.clone-url=%s\n", repo->clone_url);
806         fprintf(f, "repo.enable-commit-graph=%d\n",
807                 repo->enable_commit_graph);
808         fprintf(f, "repo.enable-log-filecount=%d\n",
809                 repo->enable_log_filecount);
810         fprintf(f, "repo.enable-log-linecount=%d\n",
811                 repo->enable_log_linecount);
812         if (repo->about_filter && repo->about_filter != ctx.cfg.about_filter)
813                 cgit_fprintf_filter(repo->about_filter, f, "repo.about-filter=");
814         if (repo->commit_filter && repo->commit_filter != ctx.cfg.commit_filter)
815                 cgit_fprintf_filter(repo->commit_filter, f, "repo.commit-filter=");
816         if (repo->source_filter && repo->source_filter != ctx.cfg.source_filter)
817                 cgit_fprintf_filter(repo->source_filter, f, "repo.source-filter=");
818         if (repo->email_filter && repo->email_filter != ctx.cfg.email_filter)
819                 cgit_fprintf_filter(repo->email_filter, f, "repo.email-filter=");
820         if (repo->owner_filter && repo->owner_filter != ctx.cfg.owner_filter)
821                 cgit_fprintf_filter(repo->owner_filter, f, "repo.owner-filter=");
822         if (repo->snapshots != ctx.cfg.snapshots) {
823                 char *tmp = build_snapshot_setting(repo->snapshots);
824                 fprintf(f, "repo.snapshots=%s\n", tmp ? tmp : "");
825                 free(tmp);
826         }
827         if (repo->max_stats != ctx.cfg.max_stats)
828                 fprintf(f, "repo.max-stats=%s\n",
829                         cgit_find_stats_periodname(repo->max_stats));
830         if (repo->logo)
831                 fprintf(f, "repo.logo=%s\n", repo->logo);
832         if (repo->logo_link)
833                 fprintf(f, "repo.logo-link=%s\n", repo->logo_link);
834         fprintf(f, "repo.enable-remote-branches=%d\n", repo->enable_remote_branches);
835         fprintf(f, "repo.enable-subject-links=%d\n", repo->enable_subject_links);
836         fprintf(f, "repo.enable-html-serving=%d\n", repo->enable_html_serving);
837         if (repo->branch_sort == 1)
838                 fprintf(f, "repo.branch-sort=age\n");
839         if (repo->commit_sort) {
840                 if (repo->commit_sort == 1)
841                         fprintf(f, "repo.commit-sort=date\n");
842                 else if (repo->commit_sort == 2)
843                         fprintf(f, "repo.commit-sort=topo\n");
844         }
845         fprintf(f, "repo.hide=%d\n", repo->hide);
846         fprintf(f, "repo.ignore=%d\n", repo->ignore);
847         fprintf(f, "\n");
848 }
849
850 static void print_repolist(FILE *f, struct cgit_repolist *list, int start)
851 {
852         int i;
853
854         for (i = start; i < list->count; i++)
855                 print_repo(f, &list->repos[i]);
856 }
857
858 /* Scan 'path' for git repositories, save the resulting repolist in 'cached_rc'
859  * and return 0 on success.
860  */
861 static int generate_cached_repolist(const char *path, const char *cached_rc)
862 {
863         struct strbuf locked_rc = STRBUF_INIT;
864         int result = 0;
865         int idx;
866         FILE *f;
867
868         strbuf_addf(&locked_rc, "%s.lock", cached_rc);
869         f = fopen(locked_rc.buf, "wx");
870         if (!f) {
871                 /* Inform about the error unless the lockfile already existed,
872                  * since that only means we've got concurrent requests.
873                  */
874                 result = errno;
875                 if (result != EEXIST)
876                         fprintf(stderr, "[cgit] Error opening %s: %s (%d)\n",
877                                 locked_rc.buf, strerror(result), result);
878                 goto out;
879         }
880         idx = cgit_repolist.count;
881         if (ctx.cfg.project_list)
882                 scan_projects(path, ctx.cfg.project_list, repo_config);
883         else
884                 scan_tree(path, repo_config);
885         print_repolist(f, &cgit_repolist, idx);
886         if (rename(locked_rc.buf, cached_rc))
887                 fprintf(stderr, "[cgit] Error renaming %s to %s: %s (%d)\n",
888                         locked_rc.buf, cached_rc, strerror(errno), errno);
889         fclose(f);
890 out:
891         strbuf_release(&locked_rc);
892         return result;
893 }
894
895 static void process_cached_repolist(const char *path)
896 {
897         struct stat st;
898         struct strbuf cached_rc = STRBUF_INIT;
899         time_t age;
900         unsigned long hash;
901
902         hash = hash_str(path);
903         if (ctx.cfg.project_list)
904                 hash += hash_str(ctx.cfg.project_list);
905         strbuf_addf(&cached_rc, "%s/rc-%8lx", ctx.cfg.cache_root, hash);
906
907         if (stat(cached_rc.buf, &st)) {
908                 /* Nothing is cached, we need to scan without forking. And
909                  * if we fail to generate a cached repolist, we need to
910                  * invoke scan_tree manually.
911                  */
912                 if (generate_cached_repolist(path, cached_rc.buf)) {
913                         if (ctx.cfg.project_list)
914                                 scan_projects(path, ctx.cfg.project_list,
915                                               repo_config);
916                         else
917                                 scan_tree(path, repo_config);
918                 }
919                 goto out;
920         }
921
922         parse_configfile(cached_rc.buf, config_cb);
923
924         /* If the cached configfile hasn't expired, lets exit now */
925         age = time(NULL) - st.st_mtime;
926         if (age <= (ctx.cfg.cache_scanrc_ttl * 60))
927                 goto out;
928
929         /* The cached repolist has been parsed, but it was old. So lets
930          * rescan the specified path and generate a new cached repolist
931          * in a child-process to avoid latency for the current request.
932          */
933         if (fork())
934                 goto out;
935
936         exit(generate_cached_repolist(path, cached_rc.buf));
937 out:
938         strbuf_release(&cached_rc);
939 }
940
941 static void cgit_parse_args(int argc, const char **argv)
942 {
943         int i;
944         const char *arg;
945         int scan = 0;
946
947         for (i = 1; i < argc; i++) {
948                 if (!strcmp(argv[i], "--version")) {
949                         printf("CGit %s | https://git.zx2c4.com/cgit/\n\nCompiled in features:\n", CGIT_VERSION);
950 #ifdef NO_LUA
951                         printf("[-] ");
952 #else
953                         printf("[+] ");
954 #endif
955                         printf("Lua scripting\n");
956 #ifndef HAVE_LINUX_SENDFILE
957                         printf("[-] ");
958 #else
959                         printf("[+] ");
960 #endif
961                         printf("Linux sendfile() usage\n");
962
963                         exit(0);
964                 }
965                 if (skip_prefix(argv[i], "--cache=", &arg)) {
966                         ctx.cfg.cache_root = xstrdup(arg);
967                 } else if (!strcmp(argv[i], "--nocache")) {
968                         ctx.cfg.nocache = 1;
969                 } else if (!strcmp(argv[i], "--nohttp")) {
970                         ctx.env.no_http = "1";
971                 } else if (skip_prefix(argv[i], "--query=", &arg)) {
972                         ctx.qry.raw = xstrdup(arg);
973                 } else if (skip_prefix(argv[i], "--repo=", &arg)) {
974                         ctx.qry.repo = xstrdup(arg);
975                 } else if (skip_prefix(argv[i], "--page=", &arg)) {
976                         ctx.qry.page = xstrdup(arg);
977                 } else if (skip_prefix(argv[i], "--head=", &arg)) {
978                         ctx.qry.head = xstrdup(arg);
979                         ctx.qry.has_symref = 1;
980                 } else if (skip_prefix(argv[i], "--sha1=", &arg)) {
981                         ctx.qry.sha1 = xstrdup(arg);
982                         ctx.qry.has_sha1 = 1;
983                 } else if (skip_prefix(argv[i], "--ofs=", &arg)) {
984                         ctx.qry.ofs = atoi(arg);
985                 } else if (skip_prefix(argv[i], "--scan-tree=", &arg) ||
986                            skip_prefix(argv[i], "--scan-path=", &arg)) {
987                         /*
988                          * HACK: The global snapshot bit mask defines the set
989                          * of allowed snapshot formats, but the config file
990                          * hasn't been parsed yet so the mask is currently 0.
991                          * By setting all bits high before scanning we make
992                          * sure that any in-repo cgitrc snapshot setting is
993                          * respected by scan_tree().
994                          *
995                          * NOTE: We assume that there aren't more than 8
996                          * different snapshot formats supported by cgit...
997                          */
998                         ctx.cfg.snapshots = 0xFF;
999                         scan++;
1000                         scan_tree(arg, repo_config);
1001                 }
1002         }
1003         if (scan) {
1004                 qsort(cgit_repolist.repos, cgit_repolist.count,
1005                         sizeof(struct cgit_repo), cmp_repos);
1006                 print_repolist(stdout, &cgit_repolist, 0);
1007                 exit(0);
1008         }
1009 }
1010
1011 static int calc_ttl(void)
1012 {
1013         if (!ctx.repo)
1014                 return ctx.cfg.cache_root_ttl;
1015
1016         if (!ctx.qry.page)
1017                 return ctx.cfg.cache_repo_ttl;
1018
1019         if (!strcmp(ctx.qry.page, "about"))
1020                 return ctx.cfg.cache_about_ttl;
1021
1022         if (!strcmp(ctx.qry.page, "snapshot"))
1023                 return ctx.cfg.cache_snapshot_ttl;
1024
1025         if (ctx.qry.has_sha1)
1026                 return ctx.cfg.cache_static_ttl;
1027
1028         if (ctx.qry.has_symref)
1029                 return ctx.cfg.cache_dynamic_ttl;
1030
1031         return ctx.cfg.cache_repo_ttl;
1032 }
1033
1034 int cmd_main(int argc, const char **argv)
1035 {
1036         const char *path;
1037         int err, ttl;
1038
1039         cgit_init_filters();
1040         atexit(cgit_cleanup_filters);
1041
1042         prepare_context();
1043         cgit_repolist.length = 0;
1044         cgit_repolist.count = 0;
1045         cgit_repolist.repos = NULL;
1046
1047         cgit_parse_args(argc, argv);
1048         parse_configfile(expand_macros(ctx.env.cgit_config), config_cb);
1049         ctx.repo = NULL;
1050         http_parse_querystring(ctx.qry.raw, querystring_cb);
1051
1052         /* If virtual-root isn't specified in cgitrc, lets pretend
1053          * that virtual-root equals SCRIPT_NAME, minus any possibly
1054          * trailing slashes.
1055          */
1056         if (!ctx.cfg.virtual_root && ctx.cfg.script_name)
1057                 ctx.cfg.virtual_root = ensure_end(ctx.cfg.script_name, '/');
1058
1059         /* If no url parameter is specified on the querystring, lets
1060          * use PATH_INFO as url. This allows cgit to work with virtual
1061          * urls without the need for rewriterules in the webserver (as
1062          * long as PATH_INFO is included in the cache lookup key).
1063          */
1064         path = ctx.env.path_info;
1065         if (!ctx.qry.url && path) {
1066                 if (path[0] == '/')
1067                         path++;
1068                 ctx.qry.url = xstrdup(path);
1069                 if (ctx.qry.raw) {
1070                         char *newqry = fmtalloc("%s?%s", path, ctx.qry.raw);
1071                         free(ctx.qry.raw);
1072                         ctx.qry.raw = newqry;
1073                 } else
1074                         ctx.qry.raw = xstrdup(ctx.qry.url);
1075                 cgit_parse_url(ctx.qry.url);
1076         }
1077
1078         /* Before we go any further, we set ctx.env.authenticated by checking to see
1079          * if the supplied cookie is valid. All cookies are valid if there is no
1080          * auth_filter. If there is an auth_filter, the filter decides. */
1081         authenticate_cookie();
1082
1083         ttl = calc_ttl();
1084         if (ttl < 0)
1085                 ctx.page.expires += 10 * 365 * 24 * 60 * 60; /* 10 years */
1086         else
1087                 ctx.page.expires += ttl * 60;
1088         if (!ctx.env.authenticated || (ctx.env.request_method && !strcmp(ctx.env.request_method, "HEAD")))
1089                 ctx.cfg.nocache = 1;
1090         if (ctx.cfg.nocache)
1091                 ctx.cfg.cache_size = 0;
1092         err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
1093                             ctx.qry.raw, ttl, process_request);
1094         cgit_cleanup_filters();
1095         if (err)
1096                 cgit_print_error("Error processing page: %s (%d)",
1097                                  strerror(err), err);
1098         return err;
1099 }