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