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