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