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)
12 #include "configfile.h"
14 #include "ui-shared.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"))
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);
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)
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")) {
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, "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 } else if (!strcmp(name, "follow")) {
337 ctx.qry.follow = atoi(value);
341 static void prepare_context(void)
343 memset(&ctx, 0, sizeof(ctx));
344 ctx.cfg.agefile = "info/web/last-modified";
346 ctx.cfg.cache_size = 0;
347 ctx.cfg.cache_max_create_time = 5;
348 ctx.cfg.cache_root = CGIT_CACHE_ROOT;
349 ctx.cfg.cache_about_ttl = 15;
350 ctx.cfg.cache_snapshot_ttl = 5;
351 ctx.cfg.cache_repo_ttl = 5;
352 ctx.cfg.cache_root_ttl = 5;
353 ctx.cfg.cache_scanrc_ttl = 15;
354 ctx.cfg.cache_dynamic_ttl = 5;
355 ctx.cfg.cache_static_ttl = -1;
356 ctx.cfg.case_sensitive_sort = 1;
357 ctx.cfg.branch_sort = 0;
358 ctx.cfg.commit_sort = 0;
359 ctx.cfg.css = "/cgit.css";
360 ctx.cfg.logo = "/cgit.png";
361 ctx.cfg.favicon = "/favicon.ico";
362 ctx.cfg.local_time = 0;
363 ctx.cfg.enable_http_clone = 1;
364 ctx.cfg.enable_index_owner = 1;
365 ctx.cfg.enable_tree_linenumbers = 1;
366 ctx.cfg.enable_git_config = 0;
367 ctx.cfg.max_repo_count = 50;
368 ctx.cfg.max_commit_count = 50;
369 ctx.cfg.max_lock_attempts = 5;
370 ctx.cfg.max_msg_len = 80;
371 ctx.cfg.max_repodesc_len = 80;
372 ctx.cfg.max_blob_size = 0;
373 ctx.cfg.max_stats = 0;
374 ctx.cfg.project_list = NULL;
375 ctx.cfg.renamelimit = -1;
376 ctx.cfg.remove_suffix = 0;
377 ctx.cfg.robots = "index, nofollow";
378 ctx.cfg.root_title = "Git repository browser";
379 ctx.cfg.root_desc = "a fast webinterface for the git dscm";
380 ctx.cfg.scan_hidden_path = 0;
381 ctx.cfg.script_name = CGIT_SCRIPT_NAME;
382 ctx.cfg.section = "";
383 ctx.cfg.repository_sort = "name";
384 ctx.cfg.section_sort = 1;
385 ctx.cfg.summary_branches = 10;
386 ctx.cfg.summary_log = 10;
387 ctx.cfg.summary_tags = 10;
388 ctx.cfg.max_atom_items = 10;
389 ctx.cfg.difftype = DIFF_UNIFIED;
390 ctx.env.cgit_config = getenv("CGIT_CONFIG");
391 ctx.env.http_host = getenv("HTTP_HOST");
392 ctx.env.https = getenv("HTTPS");
393 ctx.env.no_http = getenv("NO_HTTP");
394 ctx.env.path_info = getenv("PATH_INFO");
395 ctx.env.query_string = getenv("QUERY_STRING");
396 ctx.env.request_method = getenv("REQUEST_METHOD");
397 ctx.env.script_name = getenv("SCRIPT_NAME");
398 ctx.env.server_name = getenv("SERVER_NAME");
399 ctx.env.server_port = getenv("SERVER_PORT");
400 ctx.env.http_cookie = getenv("HTTP_COOKIE");
401 ctx.env.http_referer = getenv("HTTP_REFERER");
402 ctx.env.content_length = getenv("CONTENT_LENGTH") ? strtoul(getenv("CONTENT_LENGTH"), NULL, 10) : 0;
403 ctx.env.authenticated = 0;
404 ctx.page.mimetype = "text/html";
405 ctx.page.charset = PAGE_ENCODING;
406 ctx.page.filename = NULL;
408 ctx.page.modified = time(NULL);
409 ctx.page.expires = ctx.page.modified;
410 ctx.page.etag = NULL;
411 memset(&ctx.cfg.mimetypes, 0, sizeof(struct string_list));
412 if (ctx.env.script_name)
413 ctx.cfg.script_name = xstrdup(ctx.env.script_name);
414 if (ctx.env.query_string)
415 ctx.qry.raw = xstrdup(ctx.env.query_string);
416 if (!ctx.env.cgit_config)
417 ctx.env.cgit_config = CGIT_CONFIG;
426 static int find_current_ref(const char *refname, const struct object_id *oid,
427 int flags, void *cb_data)
429 struct refmatch *info;
431 info = (struct refmatch *)cb_data;
432 if (!strcmp(refname, info->req_ref))
434 if (!info->first_ref)
435 info->first_ref = xstrdup(refname);
439 static void free_refmatch_inner(struct refmatch *info)
442 free(info->first_ref);
445 static char *find_default_branch(struct cgit_repo *repo)
447 struct refmatch info;
450 info.req_ref = repo->defbranch;
451 info.first_ref = NULL;
453 for_each_branch_ref(find_current_ref, &info);
457 ref = info.first_ref;
460 free_refmatch_inner(&info);
465 static char *guess_defbranch(void)
468 unsigned char sha1[20];
470 ref = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
471 if (!ref || !starts_with(ref, "refs/heads/"))
473 return xstrdup(ref + 11);
475 /* The caller must free filename and ref after calling this. */
476 static inline void parse_readme(const char *readme, char **filename, char **ref, struct cgit_repo *repo)
483 if (!readme || !readme[0])
486 /* Check if the readme is tracked in the git repo. */
487 colon = strchr(readme, ':');
488 if (colon && strlen(colon) > 1) {
489 /* If it starts with a colon, we want to use
490 * the default branch */
491 if (colon == readme && repo->defbranch)
492 *ref = xstrdup(repo->defbranch);
494 *ref = xstrndup(readme, colon - readme);
498 /* Prepend repo path to relative readme path unless tracked. */
499 if (!(*ref) && readme[0] != '/')
500 *filename = fmtalloc("%s/%s", repo->path, readme);
502 *filename = xstrdup(readme);
504 static void choose_readme(struct cgit_repo *repo)
507 char *filename, *ref;
508 struct string_list_item *entry;
510 if (!repo->readme.nr)
514 for_each_string_list_item(entry, &repo->readme) {
515 parse_readme(entry->string, &filename, &ref, repo);
522 if (cgit_ref_path_exists(filename, ref, 1)) {
527 else if (!access(filename, R_OK)) {
534 repo->readme.strdup_strings = 1;
535 string_list_clear(&repo->readme, 0);
536 repo->readme.strdup_strings = 0;
538 string_list_append(&repo->readme, filename)->util = ref;
541 static void print_no_repo_clone_urls(const char *url)
543 html("<tr><td><a rel='vcs-git' href='");
546 html_attr(ctx.repo->name);
547 html(" Git repository'>");
549 html("</a></td></tr>\n");
552 static int prepare_repo_cmd(void)
554 unsigned char sha1[20];
558 /* The path to the git repository. */
559 setenv("GIT_DIR", ctx.repo->path, 1);
561 /* Do not look in /etc/ for gitconfig and gitattributes. */
562 setenv("GIT_CONFIG_NOSYSTEM", "1", 1);
563 setenv("GIT_ATTR_NOSYSTEM", "1", 1);
565 unsetenv("XDG_CONFIG_HOME");
567 /* Setup the git directory and initialize the notes system. Both of these
568 * load local configuration from the git repository, so we do them both while
569 * the HOME variables are unset. */
570 setup_git_directory_gently(&nongit);
571 init_display_notes(NULL);
574 const char *name = ctx.repo->name;
576 ctx.page.title = fmtalloc("%s - %s", ctx.cfg.root_title,
579 cgit_print_http_headers();
580 cgit_print_docstart();
581 cgit_print_pageheader();
582 cgit_print_error("Failed to open %s: %s", name,
583 rc ? strerror(rc) : "Not a valid git repository");
587 ctx.page.title = fmtalloc("%s - %s", ctx.repo->name, ctx.repo->desc);
589 if (!ctx.repo->defbranch)
590 ctx.repo->defbranch = guess_defbranch();
594 ctx.qry.head = find_default_branch(ctx.repo);
598 cgit_print_http_headers();
599 cgit_print_docstart();
600 cgit_print_pageheader();
601 cgit_print_error("Repository seems to be empty");
602 if (!strcmp(ctx.qry.page, "summary")) {
603 html("<table class='list'><tr class='nohover'><td> </td></tr><tr class='nohover'><th class='left'>Clone</th></tr>\n");
604 cgit_prepare_repo_env(ctx.repo);
605 cgit_add_clone_urls(print_no_repo_clone_urls);
612 if (get_sha1(ctx.qry.head, sha1)) {
613 char *tmp = xstrdup(ctx.qry.head);
614 ctx.qry.head = ctx.repo->defbranch;
615 cgit_print_error_page(404, "Not found",
616 "Invalid branch: %s", tmp);
620 string_list_sort(&ctx.repo->submodules);
621 cgit_prepare_repo_env(ctx.repo);
622 choose_readme(ctx.repo);
626 static inline void open_auth_filter(const char *function)
628 cgit_open_filter(ctx.cfg.auth_filter, function,
629 ctx.env.http_cookie ? ctx.env.http_cookie : "",
630 ctx.env.request_method ? ctx.env.request_method : "",
631 ctx.env.query_string ? ctx.env.query_string : "",
632 ctx.env.http_referer ? ctx.env.http_referer : "",
633 ctx.env.path_info ? ctx.env.path_info : "",
634 ctx.env.http_host ? ctx.env.http_host : "",
635 ctx.env.https ? ctx.env.https : "",
636 ctx.qry.repo ? ctx.qry.repo : "",
637 ctx.qry.page ? ctx.qry.page : "",
638 ctx.qry.url ? ctx.qry.url : "",
642 /* We intentionally keep this rather small, instead of looping and
643 * feeding it to the filter a couple bytes at a time. This way, the
644 * filter itself does not need to handle any denial of service or
645 * buffer bloat issues. If this winds up being too small, people
646 * will complain on the mailing list, and we'll increase it as needed. */
647 #define MAX_AUTHENTICATION_POST_BYTES 4096
648 /* The filter is expected to spit out "Status: " and all headers. */
649 static inline void authenticate_post(void)
651 char buffer[MAX_AUTHENTICATION_POST_BYTES];
654 open_auth_filter("authenticate-post");
655 len = ctx.env.content_length;
656 if (len > MAX_AUTHENTICATION_POST_BYTES)
657 len = MAX_AUTHENTICATION_POST_BYTES;
658 if (read(STDIN_FILENO, buffer, len) < 0)
659 die_errno("Could not read POST from stdin");
660 if (write(STDOUT_FILENO, buffer, len) < 0)
661 die_errno("Could not write POST to stdout");
662 cgit_close_filter(ctx.cfg.auth_filter);
666 static inline void authenticate_cookie(void)
668 /* If we don't have an auth_filter, consider all cookies valid, and thus return early. */
669 if (!ctx.cfg.auth_filter) {
670 ctx.env.authenticated = 1;
674 /* If we're having something POST'd to /login, we're authenticating POST,
675 * instead of the cookie, so call authenticate_post and bail out early.
676 * This pattern here should match /?p=login with POST. */
677 if (ctx.env.request_method && ctx.qry.page && !ctx.repo && \
678 !strcmp(ctx.env.request_method, "POST") && !strcmp(ctx.qry.page, "login")) {
683 /* If we've made it this far, we're authenticating the cookie for real, so do that. */
684 open_auth_filter("authenticate-cookie");
685 ctx.env.authenticated = cgit_close_filter(ctx.cfg.auth_filter);
688 static void process_request(void)
690 struct cgit_cmd *cmd;
692 /* If we're not yet authenticated, no matter what page we're on,
693 * display the authentication body from the auth_filter. This should
694 * never be cached. */
695 if (!ctx.env.authenticated) {
696 ctx.page.title = "Authentication Required";
697 cgit_print_http_headers();
698 cgit_print_docstart();
699 cgit_print_pageheader();
700 open_auth_filter("body");
701 cgit_close_filter(ctx.cfg.auth_filter);
706 cmd = cgit_get_cmd();
708 ctx.page.title = "cgit error";
709 cgit_print_error_page(404, "Not found", "Invalid request");
713 if (!ctx.cfg.enable_http_clone && cmd->is_clone) {
714 ctx.page.title = "cgit error";
715 cgit_print_error_page(404, "Not found", "Invalid request");
719 /* If cmd->want_vpath is set, assume ctx.qry.path contains a "virtual"
720 * in-project path limit to be made available at ctx.qry.vpath.
721 * Otherwise, no path limit is in effect (ctx.qry.vpath = NULL).
723 ctx.qry.vpath = cmd->want_vpath ? ctx.qry.path : NULL;
725 if (cmd->want_repo && !ctx.repo) {
726 cgit_print_error_page(400, "Bad request",
727 "No repository selected");
731 if (ctx.repo && prepare_repo_cmd())
737 static int cmp_repos(const void *a, const void *b)
739 const struct cgit_repo *ra = a, *rb = b;
740 return strcmp(ra->url, rb->url);
743 static char *build_snapshot_setting(int bitmap)
745 const struct cgit_snapshot_format *f;
746 struct strbuf result = STRBUF_INIT;
748 for (f = cgit_snapshot_formats; f->suffix; f++) {
749 if (f->bit & bitmap) {
751 strbuf_addch(&result, ' ');
752 strbuf_addstr(&result, f->suffix);
755 return strbuf_detach(&result, NULL);
758 static char *get_first_line(char *txt)
760 char *t = xstrdup(txt);
761 char *p = strchr(t, '\n');
767 static void print_repo(FILE *f, struct cgit_repo *repo)
769 struct string_list_item *item;
770 fprintf(f, "repo.url=%s\n", repo->url);
771 fprintf(f, "repo.name=%s\n", repo->name);
772 fprintf(f, "repo.path=%s\n", repo->path);
774 fprintf(f, "repo.owner=%s\n", repo->owner);
776 char *tmp = get_first_line(repo->desc);
777 fprintf(f, "repo.desc=%s\n", tmp);
780 for_each_string_list_item(item, &repo->readme) {
782 fprintf(f, "repo.readme=%s:%s\n", (char *)item->util, item->string);
784 fprintf(f, "repo.readme=%s\n", item->string);
787 fprintf(f, "repo.defbranch=%s\n", repo->defbranch);
788 if (repo->module_link)
789 fprintf(f, "repo.module-link=%s\n", repo->module_link);
791 fprintf(f, "repo.section=%s\n", repo->section);
793 fprintf(f, "repo.clone-url=%s\n", repo->clone_url);
794 fprintf(f, "repo.enable-commit-graph=%d\n",
795 repo->enable_commit_graph);
796 fprintf(f, "repo.enable-log-filecount=%d\n",
797 repo->enable_log_filecount);
798 fprintf(f, "repo.enable-log-linecount=%d\n",
799 repo->enable_log_linecount);
800 if (repo->about_filter && repo->about_filter != ctx.cfg.about_filter)
801 cgit_fprintf_filter(repo->about_filter, f, "repo.about-filter=");
802 if (repo->commit_filter && repo->commit_filter != ctx.cfg.commit_filter)
803 cgit_fprintf_filter(repo->commit_filter, f, "repo.commit-filter=");
804 if (repo->source_filter && repo->source_filter != ctx.cfg.source_filter)
805 cgit_fprintf_filter(repo->source_filter, f, "repo.source-filter=");
806 if (repo->email_filter && repo->email_filter != ctx.cfg.email_filter)
807 cgit_fprintf_filter(repo->email_filter, f, "repo.email-filter=");
808 if (repo->owner_filter && repo->owner_filter != ctx.cfg.owner_filter)
809 cgit_fprintf_filter(repo->owner_filter, f, "repo.owner-filter=");
810 if (repo->snapshots != ctx.cfg.snapshots) {
811 char *tmp = build_snapshot_setting(repo->snapshots);
812 fprintf(f, "repo.snapshots=%s\n", tmp ? tmp : "");
815 if (repo->max_stats != ctx.cfg.max_stats)
816 fprintf(f, "repo.max-stats=%s\n",
817 cgit_find_stats_periodname(repo->max_stats));
819 fprintf(f, "repo.logo=%s\n", repo->logo);
821 fprintf(f, "repo.logo-link=%s\n", repo->logo_link);
822 fprintf(f, "repo.enable-remote-branches=%d\n", repo->enable_remote_branches);
823 fprintf(f, "repo.enable-subject-links=%d\n", repo->enable_subject_links);
824 if (repo->branch_sort == 1)
825 fprintf(f, "repo.branch-sort=age\n");
826 if (repo->commit_sort) {
827 if (repo->commit_sort == 1)
828 fprintf(f, "repo.commit-sort=date\n");
829 else if (repo->commit_sort == 2)
830 fprintf(f, "repo.commit-sort=topo\n");
832 fprintf(f, "repo.hide=%d\n", repo->hide);
833 fprintf(f, "repo.ignore=%d\n", repo->ignore);
837 static void print_repolist(FILE *f, struct cgit_repolist *list, int start)
841 for (i = start; i < list->count; i++)
842 print_repo(f, &list->repos[i]);
845 /* Scan 'path' for git repositories, save the resulting repolist in 'cached_rc'
846 * and return 0 on success.
848 static int generate_cached_repolist(const char *path, const char *cached_rc)
850 struct strbuf locked_rc = STRBUF_INIT;
855 strbuf_addf(&locked_rc, "%s.lock", cached_rc);
856 f = fopen(locked_rc.buf, "wx");
858 /* Inform about the error unless the lockfile already existed,
859 * since that only means we've got concurrent requests.
862 if (result != EEXIST)
863 fprintf(stderr, "[cgit] Error opening %s: %s (%d)\n",
864 locked_rc.buf, strerror(result), result);
867 idx = cgit_repolist.count;
868 if (ctx.cfg.project_list)
869 scan_projects(path, ctx.cfg.project_list, repo_config);
871 scan_tree(path, repo_config);
872 print_repolist(f, &cgit_repolist, idx);
873 if (rename(locked_rc.buf, cached_rc))
874 fprintf(stderr, "[cgit] Error renaming %s to %s: %s (%d)\n",
875 locked_rc.buf, cached_rc, strerror(errno), errno);
878 strbuf_release(&locked_rc);
882 static void process_cached_repolist(const char *path)
885 struct strbuf cached_rc = STRBUF_INIT;
889 hash = hash_str(path);
890 if (ctx.cfg.project_list)
891 hash += hash_str(ctx.cfg.project_list);
892 strbuf_addf(&cached_rc, "%s/rc-%8lx", ctx.cfg.cache_root, hash);
894 if (stat(cached_rc.buf, &st)) {
895 /* Nothing is cached, we need to scan without forking. And
896 * if we fail to generate a cached repolist, we need to
897 * invoke scan_tree manually.
899 if (generate_cached_repolist(path, cached_rc.buf)) {
900 if (ctx.cfg.project_list)
901 scan_projects(path, ctx.cfg.project_list,
904 scan_tree(path, repo_config);
909 parse_configfile(cached_rc.buf, config_cb);
911 /* If the cached configfile hasn't expired, lets exit now */
912 age = time(NULL) - st.st_mtime;
913 if (age <= (ctx.cfg.cache_scanrc_ttl * 60))
916 /* The cached repolist has been parsed, but it was old. So lets
917 * rescan the specified path and generate a new cached repolist
918 * in a child-process to avoid latency for the current request.
923 exit(generate_cached_repolist(path, cached_rc.buf));
925 strbuf_release(&cached_rc);
928 static void cgit_parse_args(int argc, const char **argv)
933 for (i = 1; i < argc; i++) {
934 if (!strcmp(argv[i], "--version")) {
935 printf("CGit %s | http://git.zx2c4.com/cgit/\n\nCompiled in features:\n", CGIT_VERSION);
941 printf("Lua scripting\n");
942 #ifndef HAVE_LINUX_SENDFILE
947 printf("Linux sendfile() usage\n");
951 if (starts_with(argv[i], "--cache=")) {
952 ctx.cfg.cache_root = xstrdup(argv[i] + 8);
953 } else if (!strcmp(argv[i], "--nocache")) {
955 } else if (!strcmp(argv[i], "--nohttp")) {
956 ctx.env.no_http = "1";
957 } else if (starts_with(argv[i], "--query=")) {
958 ctx.qry.raw = xstrdup(argv[i] + 8);
959 } else if (starts_with(argv[i], "--repo=")) {
960 ctx.qry.repo = xstrdup(argv[i] + 7);
961 } else if (starts_with(argv[i], "--page=")) {
962 ctx.qry.page = xstrdup(argv[i] + 7);
963 } else if (starts_with(argv[i], "--head=")) {
964 ctx.qry.head = xstrdup(argv[i] + 7);
965 ctx.qry.has_symref = 1;
966 } else if (starts_with(argv[i], "--sha1=")) {
967 ctx.qry.sha1 = xstrdup(argv[i] + 7);
968 ctx.qry.has_sha1 = 1;
969 } else if (starts_with(argv[i], "--ofs=")) {
970 ctx.qry.ofs = atoi(argv[i] + 6);
971 } else if (starts_with(argv[i], "--scan-tree=") ||
972 starts_with(argv[i], "--scan-path=")) {
974 * HACK: The global snapshot bit mask defines the set
975 * of allowed snapshot formats, but the config file
976 * hasn't been parsed yet so the mask is currently 0.
977 * By setting all bits high before scanning we make
978 * sure that any in-repo cgitrc snapshot setting is
979 * respected by scan_tree().
981 * NOTE: We assume that there aren't more than 8
982 * different snapshot formats supported by cgit...
984 ctx.cfg.snapshots = 0xFF;
986 scan_tree(argv[i] + 12, repo_config);
990 qsort(cgit_repolist.repos, cgit_repolist.count,
991 sizeof(struct cgit_repo), cmp_repos);
992 print_repolist(stdout, &cgit_repolist, 0);
997 static int calc_ttl(void)
1000 return ctx.cfg.cache_root_ttl;
1003 return ctx.cfg.cache_repo_ttl;
1005 if (!strcmp(ctx.qry.page, "about"))
1006 return ctx.cfg.cache_about_ttl;
1008 if (!strcmp(ctx.qry.page, "snapshot"))
1009 return ctx.cfg.cache_snapshot_ttl;
1011 if (ctx.qry.has_sha1)
1012 return ctx.cfg.cache_static_ttl;
1014 if (ctx.qry.has_symref)
1015 return ctx.cfg.cache_dynamic_ttl;
1017 return ctx.cfg.cache_repo_ttl;
1020 int main(int argc, const char **argv)
1025 cgit_init_filters();
1026 atexit(cgit_cleanup_filters);
1029 cgit_repolist.length = 0;
1030 cgit_repolist.count = 0;
1031 cgit_repolist.repos = NULL;
1033 cgit_parse_args(argc, argv);
1034 parse_configfile(expand_macros(ctx.env.cgit_config), config_cb);
1036 http_parse_querystring(ctx.qry.raw, querystring_cb);
1038 /* If virtual-root isn't specified in cgitrc, lets pretend
1039 * that virtual-root equals SCRIPT_NAME, minus any possibly
1042 if (!ctx.cfg.virtual_root && ctx.cfg.script_name)
1043 ctx.cfg.virtual_root = ensure_end(ctx.cfg.script_name, '/');
1045 /* If no url parameter is specified on the querystring, lets
1046 * use PATH_INFO as url. This allows cgit to work with virtual
1047 * urls without the need for rewriterules in the webserver (as
1048 * long as PATH_INFO is included in the cache lookup key).
1050 path = ctx.env.path_info;
1051 if (!ctx.qry.url && path) {
1054 ctx.qry.url = xstrdup(path);
1056 char *newqry = fmtalloc("%s?%s", path, ctx.qry.raw);
1058 ctx.qry.raw = newqry;
1060 ctx.qry.raw = xstrdup(ctx.qry.url);
1061 cgit_parse_url(ctx.qry.url);
1064 /* Before we go any further, we set ctx.env.authenticated by checking to see
1065 * if the supplied cookie is valid. All cookies are valid if there is no
1066 * auth_filter. If there is an auth_filter, the filter decides. */
1067 authenticate_cookie();
1071 ctx.page.expires += 10 * 365 * 24 * 60 * 60; /* 10 years */
1073 ctx.page.expires += ttl * 60;
1074 if (!ctx.env.authenticated || (ctx.env.request_method && !strcmp(ctx.env.request_method, "HEAD")))
1075 ctx.cfg.nocache = 1;
1076 if (ctx.cfg.nocache)
1077 ctx.cfg.cache_size = 0;
1078 err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
1079 ctx.qry.raw, ttl, process_request);
1080 cgit_cleanup_filters();
1082 cgit_print_error("Error processing page: %s (%d)",
1083 strerror(err), err);