cgit.c (view raw)
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
20const char *cgit_version = CGIT_VERSION;
21
22static 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, name);
27 item->util = xstrdup(value);
28}
29
30static void process_cached_repolist(const char *path);
31
32static 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, "extra-head-content"))
50 repo->extra_head_content = xstrdup(value);
51 else if (!strcmp(name, "snapshots"))
52 repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value);
53 else if (!strcmp(name, "enable-commit-graph"))
54 repo->enable_commit_graph = atoi(value);
55 else if (!strcmp(name, "enable-log-filecount"))
56 repo->enable_log_filecount = atoi(value);
57 else if (!strcmp(name, "enable-log-linecount"))
58 repo->enable_log_linecount = atoi(value);
59 else if (!strcmp(name, "enable-remote-branches"))
60 repo->enable_remote_branches = atoi(value);
61 else if (!strcmp(name, "enable-subject-links"))
62 repo->enable_subject_links = atoi(value);
63 else if (!strcmp(name, "enable-html-serving"))
64 repo->enable_html_serving = atoi(value);
65 else if (!strcmp(name, "branch-sort")) {
66 if (!strcmp(value, "age"))
67 repo->branch_sort = 1;
68 if (!strcmp(value, "name"))
69 repo->branch_sort = 0;
70 } else if (!strcmp(name, "commit-sort")) {
71 if (!strcmp(value, "date"))
72 repo->commit_sort = 1;
73 if (!strcmp(value, "topo"))
74 repo->commit_sort = 2;
75 } else if (!strcmp(name, "max-stats"))
76 repo->max_stats = cgit_find_stats_period(value, NULL);
77 else if (!strcmp(name, "module-link"))
78 repo->module_link= xstrdup(value);
79 else if (skip_prefix(name, "module-link.", &path)) {
80 item = string_list_append(&repo->submodules, xstrdup(path));
81 item->util = xstrdup(value);
82 } else if (!strcmp(name, "section"))
83 repo->section = xstrdup(value);
84 else if (!strcmp(name, "snapshot-prefix"))
85 repo->snapshot_prefix = xstrdup(value);
86 else if (!strcmp(name, "readme") && value != NULL) {
87 if (repo->readme.items == ctx.cfg.readme.items)
88 memset(&repo->readme, 0, sizeof(repo->readme));
89 string_list_append(&repo->readme, xstrdup(value));
90 } else if (!strcmp(name, "logo") && value != NULL)
91 repo->logo = xstrdup(value);
92 else if (!strcmp(name, "logo-link") && value != NULL)
93 repo->logo_link = xstrdup(value);
94 else if (!strcmp(name, "hide"))
95 repo->hide = atoi(value);
96 else if (!strcmp(name, "ignore"))
97 repo->ignore = atoi(value);
98 else if (ctx.cfg.enable_filter_overrides) {
99 if (!strcmp(name, "about-filter"))
100 repo->about_filter = cgit_new_filter(value, ABOUT);
101 else if (!strcmp(name, "commit-filter"))
102 repo->commit_filter = cgit_new_filter(value, COMMIT);
103 else if (!strcmp(name, "source-filter"))
104 repo->source_filter = cgit_new_filter(value, SOURCE);
105 else if (!strcmp(name, "email-filter"))
106 repo->email_filter = cgit_new_filter(value, EMAIL);
107 else if (!strcmp(name, "owner-filter"))
108 repo->owner_filter = cgit_new_filter(value, OWNER);
109 }
110}
111
112static void config_cb(const char *name, const char *value)
113{
114 const char *arg;
115
116 if (!strcmp(name, "section"))
117 ctx.cfg.section = xstrdup(value);
118 else if (!strcmp(name, "repo.url"))
119 ctx.repo = cgit_add_repo(value);
120 else if (ctx.repo && !strcmp(name, "repo.path"))
121 ctx.repo->path = trim_end(value, '/');
122 else if (ctx.repo && skip_prefix(name, "repo.", &arg))
123 repo_config(ctx.repo, arg, value);
124 else if (!strcmp(name, "readme"))
125 string_list_append(&ctx.cfg.readme, xstrdup(value));
126 else if (!strcmp(name, "root-title"))
127 ctx.cfg.root_title = xstrdup(value);
128 else if (!strcmp(name, "root-desc"))
129 ctx.cfg.root_desc = xstrdup(value);
130 else if (!strcmp(name, "root-readme"))
131 ctx.cfg.root_readme = xstrdup(value);
132 else if (!strcmp(name, "css"))
133 ctx.cfg.css = xstrdup(value);
134 else if (!strcmp(name, "favicon"))
135 ctx.cfg.favicon = xstrdup(value);
136 else if (!strcmp(name, "footer"))
137 ctx.cfg.footer = xstrdup(value);
138 else if (!strcmp(name, "head-include"))
139 ctx.cfg.head_include = xstrdup(value);
140 else if (!strcmp(name, "header"))
141 ctx.cfg.header = xstrdup(value);
142 else if (!strcmp(name, "logo"))
143 ctx.cfg.logo = 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, "noplainemail"))
153 ctx.cfg.noplainemail = atoi(value);
154 else if (!strcmp(name, "noheader"))
155 ctx.cfg.noheader = atoi(value);
156 else if (!strcmp(name, "snapshots"))
157 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
158 else if (!strcmp(name, "enable-filter-overrides"))
159 ctx.cfg.enable_filter_overrides = atoi(value);
160 else if (!strcmp(name, "enable-follow-links"))
161 ctx.cfg.enable_follow_links = atoi(value);
162 else if (!strcmp(name, "enable-http-clone"))
163 ctx.cfg.enable_http_clone = atoi(value);
164 else if (!strcmp(name, "enable-index-links"))
165 ctx.cfg.enable_index_links = atoi(value);
166 else if (!strcmp(name, "enable-index-owner"))
167 ctx.cfg.enable_index_owner = atoi(value);
168 else if (!strcmp(name, "enable-blame"))
169 ctx.cfg.enable_blame = 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.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
292static 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
350static void prepare_context(void)
351{
352 memset(&ctx, 0, sizeof(ctx));
353 ctx.cfg.agefile = "info/web/last-modified";
354 ctx.cfg.cache_size = 0;
355 ctx.cfg.cache_max_create_time = 5;
356 ctx.cfg.cache_root = CGIT_CACHE_ROOT;
357 ctx.cfg.cache_about_ttl = 15;
358 ctx.cfg.cache_snapshot_ttl = 5;
359 ctx.cfg.cache_repo_ttl = 5;
360 ctx.cfg.cache_root_ttl = 5;
361 ctx.cfg.cache_scanrc_ttl = 15;
362 ctx.cfg.cache_dynamic_ttl = 5;
363 ctx.cfg.cache_static_ttl = -1;
364 ctx.cfg.case_sensitive_sort = 1;
365 ctx.cfg.branch_sort = 0;
366 ctx.cfg.commit_sort = 0;
367 ctx.cfg.css = "/cgit.css";
368 ctx.cfg.logo = "/cgit.png";
369 ctx.cfg.favicon = "/favicon.ico";
370 ctx.cfg.local_time = 0;
371 ctx.cfg.enable_http_clone = 1;
372 ctx.cfg.enable_index_owner = 1;
373 ctx.cfg.enable_tree_linenumbers = 1;
374 ctx.cfg.enable_git_config = 0;
375 ctx.cfg.max_repo_count = 50;
376 ctx.cfg.max_commit_count = 50;
377 ctx.cfg.max_lock_attempts = 5;
378 ctx.cfg.max_msg_len = 80;
379 ctx.cfg.max_repodesc_len = 80;
380 ctx.cfg.max_blob_size = 0;
381 ctx.cfg.max_stats = 0;
382 ctx.cfg.project_list = NULL;
383 ctx.cfg.renamelimit = -1;
384 ctx.cfg.remove_suffix = 0;
385 ctx.cfg.robots = "index, nofollow";
386 ctx.cfg.root_title = "Git repository browser";
387 ctx.cfg.root_desc = "a fast webinterface for the git dscm";
388 ctx.cfg.scan_hidden_path = 0;
389 ctx.cfg.script_name = CGIT_SCRIPT_NAME;
390 ctx.cfg.section = "";
391 ctx.cfg.repository_sort = "name";
392 ctx.cfg.section_sort = 1;
393 ctx.cfg.summary_branches = 10;
394 ctx.cfg.summary_log = 10;
395 ctx.cfg.summary_tags = 10;
396 ctx.cfg.max_atom_items = 10;
397 ctx.cfg.difftype = DIFF_UNIFIED;
398 ctx.env.cgit_config = getenv("CGIT_CONFIG");
399 ctx.env.http_host = getenv("HTTP_HOST");
400 ctx.env.https = getenv("HTTPS");
401 ctx.env.no_http = getenv("NO_HTTP");
402 ctx.env.path_info = getenv("PATH_INFO");
403 ctx.env.query_string = getenv("QUERY_STRING");
404 ctx.env.request_method = getenv("REQUEST_METHOD");
405 ctx.env.script_name = getenv("SCRIPT_NAME");
406 ctx.env.server_name = getenv("SERVER_NAME");
407 ctx.env.server_port = getenv("SERVER_PORT");
408 ctx.env.http_cookie = getenv("HTTP_COOKIE");
409 ctx.env.http_referer = getenv("HTTP_REFERER");
410 ctx.env.content_length = getenv("CONTENT_LENGTH") ? strtoul(getenv("CONTENT_LENGTH"), NULL, 10) : 0;
411 ctx.env.authenticated = 0;
412 ctx.page.mimetype = "text/html";
413 ctx.page.charset = PAGE_ENCODING;
414 ctx.page.filename = NULL;
415 ctx.page.size = 0;
416 ctx.page.modified = time(NULL);
417 ctx.page.expires = ctx.page.modified;
418 ctx.page.etag = NULL;
419 string_list_init(&ctx.cfg.mimetypes, 1);
420 if (ctx.env.script_name)
421 ctx.cfg.script_name = xstrdup(ctx.env.script_name);
422 if (ctx.env.query_string)
423 ctx.qry.raw = xstrdup(ctx.env.query_string);
424 if (!ctx.env.cgit_config)
425 ctx.env.cgit_config = CGIT_CONFIG;
426}
427
428struct refmatch {
429 char *req_ref;
430 char *first_ref;
431 int match;
432};
433
434static int find_current_ref(const char *refname, const struct object_id *oid,
435 int flags, void *cb_data)
436{
437 struct refmatch *info;
438
439 info = (struct refmatch *)cb_data;
440 if (!strcmp(refname, info->req_ref))
441 info->match = 1;
442 if (!info->first_ref)
443 info->first_ref = xstrdup(refname);
444 return info->match;
445}
446
447static void free_refmatch_inner(struct refmatch *info)
448{
449 if (info->first_ref)
450 free(info->first_ref);
451}
452
453static char *find_default_branch(struct cgit_repo *repo)
454{
455 struct refmatch info;
456 char *ref;
457
458 info.req_ref = repo->defbranch;
459 info.first_ref = NULL;
460 info.match = 0;
461 for_each_branch_ref(find_current_ref, &info);
462 if (info.match)
463 ref = info.req_ref;
464 else
465 ref = info.first_ref;
466 if (ref)
467 ref = xstrdup(ref);
468 free_refmatch_inner(&info);
469
470 return ref;
471}
472
473static char *guess_defbranch(void)
474{
475 const char *ref, *refname;
476 struct object_id oid;
477
478 ref = resolve_ref_unsafe("HEAD", 0, &oid, NULL);
479 if (!ref || !skip_prefix(ref, "refs/heads/", &refname))
480 return "master";
481 return xstrdup(refname);
482}
483
484/* The caller must free filename and ref after calling this. */
485static inline void parse_readme(const char *readme, char **filename, char **ref, struct cgit_repo *repo)
486{
487 const char *colon;
488
489 *filename = NULL;
490 *ref = NULL;
491
492 if (!readme || !readme[0])
493 return;
494
495 /* Check if the readme is tracked in the git repo. */
496 colon = strchr(readme, ':');
497 if (colon && strlen(colon) > 1) {
498 /* If it starts with a colon, we want to use
499 * the default branch */
500 if (colon == readme && repo->defbranch)
501 *ref = xstrdup(repo->defbranch);
502 else
503 *ref = xstrndup(readme, colon - readme);
504 readme = colon + 1;
505 }
506
507 /* Prepend repo path to relative readme path unless tracked. */
508 if (!(*ref) && readme[0] != '/')
509 *filename = fmtalloc("%s/%s", repo->path, readme);
510 else
511 *filename = xstrdup(readme);
512}
513static void choose_readme(struct cgit_repo *repo)
514{
515 int found;
516 char *filename, *ref;
517 struct string_list_item *entry;
518
519 if (!repo->readme.nr)
520 return;
521
522 found = 0;
523 for_each_string_list_item(entry, &repo->readme) {
524 parse_readme(entry->string, &filename, &ref, repo);
525 if (!filename) {
526 free(filename);
527 free(ref);
528 continue;
529 }
530 if (ref) {
531 if (cgit_ref_path_exists(filename, ref, 1)) {
532 found = 1;
533 break;
534 }
535 }
536 else if (!access(filename, R_OK)) {
537 found = 1;
538 break;
539 }
540 free(filename);
541 free(ref);
542 }
543 repo->readme.strdup_strings = 1;
544 string_list_clear(&repo->readme, 0);
545 repo->readme.strdup_strings = 0;
546 if (found)
547 string_list_append(&repo->readme, filename)->util = ref;
548}
549
550static void print_no_repo_clone_urls(const char *url)
551{
552 html("<tr><td><a rel='vcs-git' href='");
553 html_url_path(url);
554 html("' title='");
555 html_attr(ctx.repo->name);
556 html(" Git repository'>");
557 html_txt(url);
558 html("</a></td></tr>\n");
559}
560
561static void prepare_repo_env(int *nongit)
562{
563 /* The path to the git repository. */
564 setenv("GIT_DIR", ctx.repo->path, 1);
565
566 /* Do not look in /etc/ for gitconfig and gitattributes. */
567 setenv("GIT_CONFIG_NOSYSTEM", "1", 1);
568 setenv("GIT_ATTR_NOSYSTEM", "1", 1);
569 unsetenv("HOME");
570 unsetenv("XDG_CONFIG_HOME");
571
572 /* Setup the git directory and initialize the notes system. Both of these
573 * load local configuration from the git repository, so we do them both while
574 * the HOME variables are unset. */
575 setup_git_directory_gently(nongit);
576 init_display_notes(NULL);
577}
578static int prepare_repo_cmd(int nongit)
579{
580 struct object_id oid;
581 int rc;
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> </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
636static 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 cgit_currentfullurl(),
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. */
659static inline void authenticate_post(void)
660{
661 char buffer[MAX_AUTHENTICATION_POST_BYTES];
662 ssize_t 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 ((len = 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
676static 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
698static void process_request(void)
699{
700 struct cgit_cmd *cmd;
701 int nongit = 0;
702
703 /* If we're not yet authenticated, no matter what page we're on,
704 * display the authentication body from the auth_filter. This should
705 * never be cached. */
706 if (!ctx.env.authenticated) {
707 ctx.page.title = "Authentication Required";
708 cgit_print_http_headers();
709 cgit_print_docstart();
710 cgit_print_pageheader();
711 open_auth_filter("body");
712 cgit_close_filter(ctx.cfg.auth_filter);
713 cgit_print_docend();
714 return;
715 }
716
717 if (ctx.repo)
718 prepare_repo_env(&nongit);
719
720 cmd = cgit_get_cmd();
721 if (!cmd) {
722 ctx.page.title = "cgit error";
723 cgit_print_error_page(404, "Not found", "Invalid request");
724 return;
725 }
726
727 if (!ctx.cfg.enable_http_clone && cmd->is_clone) {
728 ctx.page.title = "cgit error";
729 cgit_print_error_page(404, "Not found", "Invalid request");
730 return;
731 }
732
733 if (cmd->want_repo && !ctx.repo) {
734 cgit_print_error_page(400, "Bad request",
735 "No repository selected");
736 return;
737 }
738
739 /* If cmd->want_vpath is set, assume ctx.qry.path contains a "virtual"
740 * in-project path limit to be made available at ctx.qry.vpath.
741 * Otherwise, no path limit is in effect (ctx.qry.vpath = NULL).
742 */
743 ctx.qry.vpath = cmd->want_vpath ? ctx.qry.path : NULL;
744
745 if (ctx.repo && prepare_repo_cmd(nongit))
746 return;
747
748 cmd->fn();
749}
750
751static int cmp_repos(const void *a, const void *b)
752{
753 const struct cgit_repo *ra = a, *rb = b;
754 return strcmp(ra->url, rb->url);
755}
756
757static char *build_snapshot_setting(int bitmap)
758{
759 const struct cgit_snapshot_format *f;
760 struct strbuf result = STRBUF_INIT;
761
762 for (f = cgit_snapshot_formats; f->suffix; f++) {
763 if (cgit_snapshot_format_bit(f) & bitmap) {
764 if (result.len)
765 strbuf_addch(&result, ' ');
766 strbuf_addstr(&result, f->suffix);
767 }
768 }
769 return strbuf_detach(&result, NULL);
770}
771
772static char *get_first_line(char *txt)
773{
774 char *t = xstrdup(txt);
775 char *p = strchr(t, '\n');
776 if (p)
777 *p = '\0';
778 return t;
779}
780
781static void print_repo(FILE *f, struct cgit_repo *repo)
782{
783 struct string_list_item *item;
784 fprintf(f, "repo.url=%s\n", repo->url);
785 fprintf(f, "repo.name=%s\n", repo->name);
786 fprintf(f, "repo.path=%s\n", repo->path);
787 if (repo->owner)
788 fprintf(f, "repo.owner=%s\n", repo->owner);
789 if (repo->desc) {
790 char *tmp = get_first_line(repo->desc);
791 fprintf(f, "repo.desc=%s\n", tmp);
792 free(tmp);
793 }
794 for_each_string_list_item(item, &repo->readme) {
795 if (item->util)
796 fprintf(f, "repo.readme=%s:%s\n", (char *)item->util, item->string);
797 else
798 fprintf(f, "repo.readme=%s\n", item->string);
799 }
800 if (repo->defbranch)
801 fprintf(f, "repo.defbranch=%s\n", repo->defbranch);
802 if (repo->extra_head_content)
803 fprintf(f, "repo.extra-head-content=%s\n", repo->extra_head_content);
804 if (repo->module_link)
805 fprintf(f, "repo.module-link=%s\n", repo->module_link);
806 if (repo->section)
807 fprintf(f, "repo.section=%s\n", repo->section);
808 if (repo->homepage)
809 fprintf(f, "repo.homepage=%s\n", repo->homepage);
810 if (repo->clone_url)
811 fprintf(f, "repo.clone-url=%s\n", repo->clone_url);
812 fprintf(f, "repo.enable-commit-graph=%d\n",
813 repo->enable_commit_graph);
814 fprintf(f, "repo.enable-log-filecount=%d\n",
815 repo->enable_log_filecount);
816 fprintf(f, "repo.enable-log-linecount=%d\n",
817 repo->enable_log_linecount);
818 if (repo->about_filter && repo->about_filter != ctx.cfg.about_filter)
819 cgit_fprintf_filter(repo->about_filter, f, "repo.about-filter=");
820 if (repo->commit_filter && repo->commit_filter != ctx.cfg.commit_filter)
821 cgit_fprintf_filter(repo->commit_filter, f, "repo.commit-filter=");
822 if (repo->source_filter && repo->source_filter != ctx.cfg.source_filter)
823 cgit_fprintf_filter(repo->source_filter, f, "repo.source-filter=");
824 if (repo->email_filter && repo->email_filter != ctx.cfg.email_filter)
825 cgit_fprintf_filter(repo->email_filter, f, "repo.email-filter=");
826 if (repo->owner_filter && repo->owner_filter != ctx.cfg.owner_filter)
827 cgit_fprintf_filter(repo->owner_filter, f, "repo.owner-filter=");
828 if (repo->snapshots != ctx.cfg.snapshots) {
829 char *tmp = build_snapshot_setting(repo->snapshots);
830 fprintf(f, "repo.snapshots=%s\n", tmp ? tmp : "");
831 free(tmp);
832 }
833 if (repo->snapshot_prefix)
834 fprintf(f, "repo.snapshot-prefix=%s\n", repo->snapshot_prefix);
835 if (repo->max_stats != ctx.cfg.max_stats)
836 fprintf(f, "repo.max-stats=%s\n",
837 cgit_find_stats_periodname(repo->max_stats));
838 if (repo->logo)
839 fprintf(f, "repo.logo=%s\n", repo->logo);
840 if (repo->logo_link)
841 fprintf(f, "repo.logo-link=%s\n", repo->logo_link);
842 fprintf(f, "repo.enable-remote-branches=%d\n", repo->enable_remote_branches);
843 fprintf(f, "repo.enable-subject-links=%d\n", repo->enable_subject_links);
844 fprintf(f, "repo.enable-html-serving=%d\n", repo->enable_html_serving);
845 if (repo->branch_sort == 1)
846 fprintf(f, "repo.branch-sort=age\n");
847 if (repo->commit_sort) {
848 if (repo->commit_sort == 1)
849 fprintf(f, "repo.commit-sort=date\n");
850 else if (repo->commit_sort == 2)
851 fprintf(f, "repo.commit-sort=topo\n");
852 }
853 fprintf(f, "repo.hide=%d\n", repo->hide);
854 fprintf(f, "repo.ignore=%d\n", repo->ignore);
855 fprintf(f, "\n");
856}
857
858static void print_repolist(FILE *f, struct cgit_repolist *list, int start)
859{
860 int i;
861
862 for (i = start; i < list->count; i++)
863 print_repo(f, &list->repos[i]);
864}
865
866/* Scan 'path' for git repositories, save the resulting repolist in 'cached_rc'
867 * and return 0 on success.
868 */
869static int generate_cached_repolist(const char *path, const char *cached_rc)
870{
871 struct strbuf locked_rc = STRBUF_INIT;
872 int result = 0;
873 int idx;
874 FILE *f;
875
876 strbuf_addf(&locked_rc, "%s.lock", cached_rc);
877 f = fopen(locked_rc.buf, "wx");
878 if (!f) {
879 /* Inform about the error unless the lockfile already existed,
880 * since that only means we've got concurrent requests.
881 */
882 result = errno;
883 if (result != EEXIST)
884 fprintf(stderr, "[cgit] Error opening %s: %s (%d)\n",
885 locked_rc.buf, strerror(result), result);
886 goto out;
887 }
888 idx = cgit_repolist.count;
889 if (ctx.cfg.project_list)
890 scan_projects(path, ctx.cfg.project_list, repo_config);
891 else
892 scan_tree(path, repo_config);
893 print_repolist(f, &cgit_repolist, idx);
894 if (rename(locked_rc.buf, cached_rc))
895 fprintf(stderr, "[cgit] Error renaming %s to %s: %s (%d)\n",
896 locked_rc.buf, cached_rc, strerror(errno), errno);
897 fclose(f);
898out:
899 strbuf_release(&locked_rc);
900 return result;
901}
902
903static void process_cached_repolist(const char *path)
904{
905 struct stat st;
906 struct strbuf cached_rc = STRBUF_INIT;
907 time_t age;
908 unsigned long hash;
909
910 hash = hash_str(path);
911 if (ctx.cfg.project_list)
912 hash += hash_str(ctx.cfg.project_list);
913 strbuf_addf(&cached_rc, "%s/rc-%8lx", ctx.cfg.cache_root, hash);
914
915 if (stat(cached_rc.buf, &st)) {
916 /* Nothing is cached, we need to scan without forking. And
917 * if we fail to generate a cached repolist, we need to
918 * invoke scan_tree manually.
919 */
920 if (generate_cached_repolist(path, cached_rc.buf)) {
921 if (ctx.cfg.project_list)
922 scan_projects(path, ctx.cfg.project_list,
923 repo_config);
924 else
925 scan_tree(path, repo_config);
926 }
927 goto out;
928 }
929
930 parse_configfile(cached_rc.buf, config_cb);
931
932 /* If the cached configfile hasn't expired, lets exit now */
933 age = time(NULL) - st.st_mtime;
934 if (age <= (ctx.cfg.cache_scanrc_ttl * 60))
935 goto out;
936
937 /* The cached repolist has been parsed, but it was old. So lets
938 * rescan the specified path and generate a new cached repolist
939 * in a child-process to avoid latency for the current request.
940 */
941 if (fork())
942 goto out;
943
944 exit(generate_cached_repolist(path, cached_rc.buf));
945out:
946 strbuf_release(&cached_rc);
947}
948
949static void cgit_parse_args(int argc, const char **argv)
950{
951 int i;
952 const char *arg;
953 int scan = 0;
954
955 for (i = 1; i < argc; i++) {
956 if (!strcmp(argv[i], "--version")) {
957 printf("CGit %s | https://git.zx2c4.com/cgit/\n\nCompiled in features:\n", CGIT_VERSION);
958#ifdef NO_LUA
959 printf("[-] ");
960#else
961 printf("[+] ");
962#endif
963 printf("Lua scripting\n");
964#ifndef HAVE_LINUX_SENDFILE
965 printf("[-] ");
966#else
967 printf("[+] ");
968#endif
969 printf("Linux sendfile() usage\n");
970
971 exit(0);
972 }
973 if (skip_prefix(argv[i], "--cache=", &arg)) {
974 ctx.cfg.cache_root = xstrdup(arg);
975 } else if (!strcmp(argv[i], "--nohttp")) {
976 ctx.env.no_http = "1";
977 } else if (skip_prefix(argv[i], "--query=", &arg)) {
978 ctx.qry.raw = xstrdup(arg);
979 } else if (skip_prefix(argv[i], "--repo=", &arg)) {
980 ctx.qry.repo = xstrdup(arg);
981 } else if (skip_prefix(argv[i], "--page=", &arg)) {
982 ctx.qry.page = xstrdup(arg);
983 } else if (skip_prefix(argv[i], "--head=", &arg)) {
984 ctx.qry.head = xstrdup(arg);
985 ctx.qry.has_symref = 1;
986 } else if (skip_prefix(argv[i], "--sha1=", &arg)) {
987 ctx.qry.sha1 = xstrdup(arg);
988 ctx.qry.has_sha1 = 1;
989 } else if (skip_prefix(argv[i], "--ofs=", &arg)) {
990 ctx.qry.ofs = atoi(arg);
991 } else if (skip_prefix(argv[i], "--scan-tree=", &arg) ||
992 skip_prefix(argv[i], "--scan-path=", &arg)) {
993 /*
994 * HACK: The global snapshot bit mask defines the set
995 * of allowed snapshot formats, but the config file
996 * hasn't been parsed yet so the mask is currently 0.
997 * By setting all bits high before scanning we make
998 * sure that any in-repo cgitrc snapshot setting is
999 * respected by scan_tree().
1000 *
1001 * NOTE: We assume that there aren't more than 8
1002 * different snapshot formats supported by cgit...
1003 */
1004 ctx.cfg.snapshots = 0xFF;
1005 scan++;
1006 scan_tree(arg, repo_config);
1007 }
1008 }
1009 if (scan) {
1010 qsort(cgit_repolist.repos, cgit_repolist.count,
1011 sizeof(struct cgit_repo), cmp_repos);
1012 print_repolist(stdout, &cgit_repolist, 0);
1013 exit(0);
1014 }
1015}
1016
1017static int calc_ttl(void)
1018{
1019 if (!ctx.repo)
1020 return ctx.cfg.cache_root_ttl;
1021
1022 if (!ctx.qry.page)
1023 return ctx.cfg.cache_repo_ttl;
1024
1025 if (!strcmp(ctx.qry.page, "about"))
1026 return ctx.cfg.cache_about_ttl;
1027
1028 if (!strcmp(ctx.qry.page, "snapshot"))
1029 return ctx.cfg.cache_snapshot_ttl;
1030
1031 if (ctx.qry.has_sha1)
1032 return ctx.cfg.cache_static_ttl;
1033
1034 if (ctx.qry.has_symref)
1035 return ctx.cfg.cache_dynamic_ttl;
1036
1037 return ctx.cfg.cache_repo_ttl;
1038}
1039
1040int cmd_main(int argc, const char **argv)
1041{
1042 const char *path;
1043 int err, ttl;
1044
1045 cgit_init_filters();
1046 atexit(cgit_cleanup_filters);
1047
1048 prepare_context();
1049 cgit_repolist.length = 0;
1050 cgit_repolist.count = 0;
1051 cgit_repolist.repos = NULL;
1052
1053 cgit_parse_args(argc, argv);
1054 parse_configfile(expand_macros(ctx.env.cgit_config), config_cb);
1055 ctx.repo = NULL;
1056 http_parse_querystring(ctx.qry.raw, querystring_cb);
1057
1058 /* If virtual-root isn't specified in cgitrc, lets pretend
1059 * that virtual-root equals SCRIPT_NAME, minus any possibly
1060 * trailing slashes.
1061 */
1062 if (!ctx.cfg.virtual_root && ctx.cfg.script_name)
1063 ctx.cfg.virtual_root = ensure_end(ctx.cfg.script_name, '/');
1064
1065 /* If no url parameter is specified on the querystring, lets
1066 * use PATH_INFO as url. This allows cgit to work with virtual
1067 * urls without the need for rewriterules in the webserver (as
1068 * long as PATH_INFO is included in the cache lookup key).
1069 */
1070 path = ctx.env.path_info;
1071 if (!ctx.qry.url && path) {
1072 if (path[0] == '/')
1073 path++;
1074 ctx.qry.url = xstrdup(path);
1075 if (ctx.qry.raw) {
1076 char *newqry = fmtalloc("%s?%s", path, ctx.qry.raw);
1077 free(ctx.qry.raw);
1078 ctx.qry.raw = newqry;
1079 } else
1080 ctx.qry.raw = xstrdup(ctx.qry.url);
1081 cgit_parse_url(ctx.qry.url);
1082 }
1083
1084 /* Before we go any further, we set ctx.env.authenticated by checking to see
1085 * if the supplied cookie is valid. All cookies are valid if there is no
1086 * auth_filter. If there is an auth_filter, the filter decides. */
1087 authenticate_cookie();
1088
1089 ttl = calc_ttl();
1090 if (ttl < 0)
1091 ctx.page.expires += 10 * 365 * 24 * 60 * 60; /* 10 years */
1092 else
1093 ctx.page.expires += ttl * 60;
1094 if (!ctx.env.authenticated || (ctx.env.request_method && !strcmp(ctx.env.request_method, "HEAD")))
1095 ctx.cfg.cache_size = 0;
1096 err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
1097 ctx.qry.raw, ttl, process_request);
1098 cgit_cleanup_filters();
1099 if (err)
1100 cgit_print_error("Error processing page: %s (%d)",
1101 strerror(err), err);
1102 return err;
1103}