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