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