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