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