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
, "enable-html-serving"))
59 repo
->enable_html_serving
= atoi(value
);
60 else if (!strcmp(name
, "branch-sort")) {
61 if (!strcmp(value
, "age"))
62 repo
->branch_sort
= 1;
63 if (!strcmp(value
, "name"))
64 repo
->branch_sort
= 0;
65 } else if (!strcmp(name
, "commit-sort")) {
66 if (!strcmp(value
, "date"))
67 repo
->commit_sort
= 1;
68 if (!strcmp(value
, "topo"))
69 repo
->commit_sort
= 2;
70 } else if (!strcmp(name
, "max-stats"))
71 repo
->max_stats
= cgit_find_stats_period(value
, NULL
);
72 else if (!strcmp(name
, "module-link"))
73 repo
->module_link
= xstrdup(value
);
74 else if (starts_with(name
, "module-link.")) {
75 item
= string_list_append(&repo
->submodules
, xstrdup(name
+ 12));
76 item
->util
= xstrdup(value
);
77 } else if (!strcmp(name
, "section"))
78 repo
->section
= xstrdup(value
);
79 else if (!strcmp(name
, "readme") && value
!= NULL
) {
80 if (repo
->readme
.items
== ctx
.cfg
.readme
.items
)
81 memset(&repo
->readme
, 0, sizeof(repo
->readme
));
82 string_list_append(&repo
->readme
, xstrdup(value
));
83 } else if (!strcmp(name
, "logo") && value
!= NULL
)
84 repo
->logo
= xstrdup(value
);
85 else if (!strcmp(name
, "logo-link") && value
!= NULL
)
86 repo
->logo_link
= xstrdup(value
);
87 else if (!strcmp(name
, "hide"))
88 repo
->hide
= atoi(value
);
89 else if (!strcmp(name
, "ignore"))
90 repo
->ignore
= atoi(value
);
91 else if (ctx
.cfg
.enable_filter_overrides
) {
92 if (!strcmp(name
, "about-filter"))
93 repo
->about_filter
= cgit_new_filter(value
, ABOUT
);
94 else if (!strcmp(name
, "commit-filter"))
95 repo
->commit_filter
= cgit_new_filter(value
, COMMIT
);
96 else if (!strcmp(name
, "source-filter"))
97 repo
->source_filter
= cgit_new_filter(value
, SOURCE
);
98 else if (!strcmp(name
, "email-filter"))
99 repo
->email_filter
= cgit_new_filter(value
, EMAIL
);
100 else if (!strcmp(name
, "owner-filter"))
101 repo
->owner_filter
= cgit_new_filter(value
, OWNER
);
105 static void config_cb(const char *name
, const char *value
)
107 if (!strcmp(name
, "section") || !strcmp(name
, "repo.group"))
108 ctx
.cfg
.section
= xstrdup(value
);
109 else if (!strcmp(name
, "repo.url"))
110 ctx
.repo
= cgit_add_repo(value
);
111 else if (ctx
.repo
&& !strcmp(name
, "repo.path"))
112 ctx
.repo
->path
= trim_end(value
, '/');
113 else if (ctx
.repo
&& starts_with(name
, "repo."))
114 repo_config(ctx
.repo
, name
+ 5, value
);
115 else if (!strcmp(name
, "readme"))
116 string_list_append(&ctx
.cfg
.readme
, xstrdup(value
));
117 else if (!strcmp(name
, "root-title"))
118 ctx
.cfg
.root_title
= xstrdup(value
);
119 else if (!strcmp(name
, "root-desc"))
120 ctx
.cfg
.root_desc
= xstrdup(value
);
121 else if (!strcmp(name
, "root-readme"))
122 ctx
.cfg
.root_readme
= xstrdup(value
);
123 else if (!strcmp(name
, "css"))
124 ctx
.cfg
.css
= xstrdup(value
);
125 else if (!strcmp(name
, "favicon"))
126 ctx
.cfg
.favicon
= xstrdup(value
);
127 else if (!strcmp(name
, "footer"))
128 ctx
.cfg
.footer
= xstrdup(value
);
129 else if (!strcmp(name
, "head-include"))
130 ctx
.cfg
.head_include
= xstrdup(value
);
131 else if (!strcmp(name
, "header"))
132 ctx
.cfg
.header
= xstrdup(value
);
133 else if (!strcmp(name
, "logo"))
134 ctx
.cfg
.logo
= xstrdup(value
);
135 else if (!strcmp(name
, "index-header"))
136 ctx
.cfg
.index_header
= xstrdup(value
);
137 else if (!strcmp(name
, "index-info"))
138 ctx
.cfg
.index_info
= xstrdup(value
);
139 else if (!strcmp(name
, "logo-link"))
140 ctx
.cfg
.logo_link
= xstrdup(value
);
141 else if (!strcmp(name
, "module-link"))
142 ctx
.cfg
.module_link
= xstrdup(value
);
143 else if (!strcmp(name
, "strict-export"))
144 ctx
.cfg
.strict_export
= xstrdup(value
);
145 else if (!strcmp(name
, "virtual-root")) {
146 ctx
.cfg
.virtual_root
= ensure_end(value
, '/');
147 } else if (!strcmp(name
, "nocache"))
148 ctx
.cfg
.nocache
= atoi(value
);
149 else if (!strcmp(name
, "noplainemail"))
150 ctx
.cfg
.noplainemail
= atoi(value
);
151 else if (!strcmp(name
, "noheader"))
152 ctx
.cfg
.noheader
= atoi(value
);
153 else if (!strcmp(name
, "snapshots"))
154 ctx
.cfg
.snapshots
= cgit_parse_snapshots_mask(value
);
155 else if (!strcmp(name
, "enable-filter-overrides"))
156 ctx
.cfg
.enable_filter_overrides
= atoi(value
);
157 else if (!strcmp(name
, "enable-follow-links"))
158 ctx
.cfg
.enable_follow_links
= atoi(value
);
159 else if (!strcmp(name
, "enable-http-clone"))
160 ctx
.cfg
.enable_http_clone
= atoi(value
);
161 else if (!strcmp(name
, "enable-index-links"))
162 ctx
.cfg
.enable_index_links
= atoi(value
);
163 else if (!strcmp(name
, "enable-index-owner"))
164 ctx
.cfg
.enable_index_owner
= atoi(value
);
165 else if (!strcmp(name
, "enable-commit-graph"))
166 ctx
.cfg
.enable_commit_graph
= atoi(value
);
167 else if (!strcmp(name
, "enable-log-filecount"))
168 ctx
.cfg
.enable_log_filecount
= atoi(value
);
169 else if (!strcmp(name
, "enable-log-linecount"))
170 ctx
.cfg
.enable_log_linecount
= atoi(value
);
171 else if (!strcmp(name
, "enable-remote-branches"))
172 ctx
.cfg
.enable_remote_branches
= atoi(value
);
173 else if (!strcmp(name
, "enable-subject-links"))
174 ctx
.cfg
.enable_subject_links
= atoi(value
);
175 else if (!strcmp(name
, "enable-html-serving"))
176 ctx
.cfg
.enable_html_serving
= atoi(value
);
177 else if (!strcmp(name
, "enable-tree-linenumbers"))
178 ctx
.cfg
.enable_tree_linenumbers
= atoi(value
);
179 else if (!strcmp(name
, "enable-git-config"))
180 ctx
.cfg
.enable_git_config
= atoi(value
);
181 else if (!strcmp(name
, "max-stats"))
182 ctx
.cfg
.max_stats
= cgit_find_stats_period(value
, NULL
);
183 else if (!strcmp(name
, "cache-size"))
184 ctx
.cfg
.cache_size
= atoi(value
);
185 else if (!strcmp(name
, "cache-root"))
186 ctx
.cfg
.cache_root
= xstrdup(expand_macros(value
));
187 else if (!strcmp(name
, "cache-root-ttl"))
188 ctx
.cfg
.cache_root_ttl
= atoi(value
);
189 else if (!strcmp(name
, "cache-repo-ttl"))
190 ctx
.cfg
.cache_repo_ttl
= atoi(value
);
191 else if (!strcmp(name
, "cache-scanrc-ttl"))
192 ctx
.cfg
.cache_scanrc_ttl
= atoi(value
);
193 else if (!strcmp(name
, "cache-static-ttl"))
194 ctx
.cfg
.cache_static_ttl
= atoi(value
);
195 else if (!strcmp(name
, "cache-dynamic-ttl"))
196 ctx
.cfg
.cache_dynamic_ttl
= atoi(value
);
197 else if (!strcmp(name
, "cache-about-ttl"))
198 ctx
.cfg
.cache_about_ttl
= atoi(value
);
199 else if (!strcmp(name
, "cache-snapshot-ttl"))
200 ctx
.cfg
.cache_snapshot_ttl
= atoi(value
);
201 else if (!strcmp(name
, "case-sensitive-sort"))
202 ctx
.cfg
.case_sensitive_sort
= atoi(value
);
203 else if (!strcmp(name
, "about-filter"))
204 ctx
.cfg
.about_filter
= cgit_new_filter(value
, ABOUT
);
205 else if (!strcmp(name
, "commit-filter"))
206 ctx
.cfg
.commit_filter
= cgit_new_filter(value
, COMMIT
);
207 else if (!strcmp(name
, "email-filter"))
208 ctx
.cfg
.email_filter
= cgit_new_filter(value
, EMAIL
);
209 else if (!strcmp(name
, "owner-filter"))
210 ctx
.cfg
.owner_filter
= cgit_new_filter(value
, OWNER
);
211 else if (!strcmp(name
, "auth-filter"))
212 ctx
.cfg
.auth_filter
= cgit_new_filter(value
, AUTH
);
213 else if (!strcmp(name
, "embedded"))
214 ctx
.cfg
.embedded
= atoi(value
);
215 else if (!strcmp(name
, "max-atom-items"))
216 ctx
.cfg
.max_atom_items
= atoi(value
);
217 else if (!strcmp(name
, "max-message-length"))
218 ctx
.cfg
.max_msg_len
= atoi(value
);
219 else if (!strcmp(name
, "max-repodesc-length"))
220 ctx
.cfg
.max_repodesc_len
= atoi(value
);
221 else if (!strcmp(name
, "max-blob-size"))
222 ctx
.cfg
.max_blob_size
= atoi(value
);
223 else if (!strcmp(name
, "max-repo-count"))
224 ctx
.cfg
.max_repo_count
= atoi(value
);
225 else if (!strcmp(name
, "max-commit-count"))
226 ctx
.cfg
.max_commit_count
= atoi(value
);
227 else if (!strcmp(name
, "project-list"))
228 ctx
.cfg
.project_list
= xstrdup(expand_macros(value
));
229 else if (!strcmp(name
, "scan-path"))
230 if (!ctx
.cfg
.nocache
&& ctx
.cfg
.cache_size
)
231 process_cached_repolist(expand_macros(value
));
232 else if (ctx
.cfg
.project_list
)
233 scan_projects(expand_macros(value
),
234 ctx
.cfg
.project_list
, repo_config
);
236 scan_tree(expand_macros(value
), repo_config
);
237 else if (!strcmp(name
, "scan-hidden-path"))
238 ctx
.cfg
.scan_hidden_path
= atoi(value
);
239 else if (!strcmp(name
, "section-from-path"))
240 ctx
.cfg
.section_from_path
= atoi(value
);
241 else if (!strcmp(name
, "repository-sort"))
242 ctx
.cfg
.repository_sort
= xstrdup(value
);
243 else if (!strcmp(name
, "section-sort"))
244 ctx
.cfg
.section_sort
= atoi(value
);
245 else if (!strcmp(name
, "source-filter"))
246 ctx
.cfg
.source_filter
= cgit_new_filter(value
, SOURCE
);
247 else if (!strcmp(name
, "summary-log"))
248 ctx
.cfg
.summary_log
= atoi(value
);
249 else if (!strcmp(name
, "summary-branches"))
250 ctx
.cfg
.summary_branches
= atoi(value
);
251 else if (!strcmp(name
, "summary-tags"))
252 ctx
.cfg
.summary_tags
= atoi(value
);
253 else if (!strcmp(name
, "side-by-side-diffs"))
254 ctx
.cfg
.difftype
= atoi(value
) ? DIFF_SSDIFF
: DIFF_UNIFIED
;
255 else if (!strcmp(name
, "agefile"))
256 ctx
.cfg
.agefile
= xstrdup(value
);
257 else if (!strcmp(name
, "mimetype-file"))
258 ctx
.cfg
.mimetype_file
= xstrdup(value
);
259 else if (!strcmp(name
, "renamelimit"))
260 ctx
.cfg
.renamelimit
= atoi(value
);
261 else if (!strcmp(name
, "remove-suffix"))
262 ctx
.cfg
.remove_suffix
= atoi(value
);
263 else if (!strcmp(name
, "robots"))
264 ctx
.cfg
.robots
= xstrdup(value
);
265 else if (!strcmp(name
, "clone-prefix"))
266 ctx
.cfg
.clone_prefix
= xstrdup(value
);
267 else if (!strcmp(name
, "clone-url"))
268 ctx
.cfg
.clone_url
= xstrdup(value
);
269 else if (!strcmp(name
, "local-time"))
270 ctx
.cfg
.local_time
= atoi(value
);
271 else if (!strcmp(name
, "commit-sort")) {
272 if (!strcmp(value
, "date"))
273 ctx
.cfg
.commit_sort
= 1;
274 if (!strcmp(value
, "topo"))
275 ctx
.cfg
.commit_sort
= 2;
276 } else if (!strcmp(name
, "branch-sort")) {
277 if (!strcmp(value
, "age"))
278 ctx
.cfg
.branch_sort
= 1;
279 if (!strcmp(value
, "name"))
280 ctx
.cfg
.branch_sort
= 0;
281 } else if (starts_with(name
, "mimetype."))
282 add_mimetype(name
+ 9, value
);
283 else if (!strcmp(name
, "include"))
284 parse_configfile(expand_macros(value
), config_cb
);
287 static void querystring_cb(const char *name
, const char *value
)
292 if (!strcmp(name
,"r")) {
293 ctx
.qry
.repo
= xstrdup(value
);
294 ctx
.repo
= cgit_get_repoinfo(value
);
295 } else if (!strcmp(name
, "p")) {
296 ctx
.qry
.page
= xstrdup(value
);
297 } else if (!strcmp(name
, "url")) {
300 ctx
.qry
.url
= xstrdup(value
);
301 cgit_parse_url(value
);
302 } else if (!strcmp(name
, "qt")) {
303 ctx
.qry
.grep
= xstrdup(value
);
304 } else if (!strcmp(name
, "q")) {
305 ctx
.qry
.search
= xstrdup(value
);
306 } else if (!strcmp(name
, "h")) {
307 ctx
.qry
.head
= xstrdup(value
);
308 ctx
.qry
.has_symref
= 1;
309 } else if (!strcmp(name
, "id")) {
310 ctx
.qry
.sha1
= xstrdup(value
);
311 ctx
.qry
.has_sha1
= 1;
312 } else if (!strcmp(name
, "id2")) {
313 ctx
.qry
.sha2
= xstrdup(value
);
314 ctx
.qry
.has_sha1
= 1;
315 } else if (!strcmp(name
, "ofs")) {
316 ctx
.qry
.ofs
= atoi(value
);
317 } else if (!strcmp(name
, "path")) {
318 ctx
.qry
.path
= trim_end(value
, '/');
319 } else if (!strcmp(name
, "name")) {
320 ctx
.qry
.name
= xstrdup(value
);
321 } else if (!strcmp(name
, "s")) {
322 ctx
.qry
.sort
= xstrdup(value
);
323 } else if (!strcmp(name
, "showmsg")) {
324 ctx
.qry
.showmsg
= atoi(value
);
325 } else if (!strcmp(name
, "period")) {
326 ctx
.qry
.period
= xstrdup(value
);
327 } else if (!strcmp(name
, "dt")) {
328 ctx
.qry
.difftype
= atoi(value
);
329 ctx
.qry
.has_difftype
= 1;
330 } else if (!strcmp(name
, "ss")) {
331 /* No longer generated, but there may be links out there. */
332 ctx
.qry
.difftype
= atoi(value
) ? DIFF_SSDIFF
: DIFF_UNIFIED
;
333 ctx
.qry
.has_difftype
= 1;
334 } else if (!strcmp(name
, "all")) {
335 ctx
.qry
.show_all
= atoi(value
);
336 } else if (!strcmp(name
, "context")) {
337 ctx
.qry
.context
= atoi(value
);
338 } else if (!strcmp(name
, "ignorews")) {
339 ctx
.qry
.ignorews
= atoi(value
);
340 } else if (!strcmp(name
, "follow")) {
341 ctx
.qry
.follow
= atoi(value
);
345 static void prepare_context(void)
347 memset(&ctx
, 0, sizeof(ctx
));
348 ctx
.cfg
.agefile
= "info/web/last-modified";
350 ctx
.cfg
.cache_size
= 0;
351 ctx
.cfg
.cache_max_create_time
= 5;
352 ctx
.cfg
.cache_root
= CGIT_CACHE_ROOT
;
353 ctx
.cfg
.cache_about_ttl
= 15;
354 ctx
.cfg
.cache_snapshot_ttl
= 5;
355 ctx
.cfg
.cache_repo_ttl
= 5;
356 ctx
.cfg
.cache_root_ttl
= 5;
357 ctx
.cfg
.cache_scanrc_ttl
= 15;
358 ctx
.cfg
.cache_dynamic_ttl
= 5;
359 ctx
.cfg
.cache_static_ttl
= -1;
360 ctx
.cfg
.case_sensitive_sort
= 1;
361 ctx
.cfg
.branch_sort
= 0;
362 ctx
.cfg
.commit_sort
= 0;
363 ctx
.cfg
.css
= "/cgit.css";
364 ctx
.cfg
.logo
= "/cgit.png";
365 ctx
.cfg
.favicon
= "/favicon.ico";
366 ctx
.cfg
.local_time
= 0;
367 ctx
.cfg
.enable_http_clone
= 1;
368 ctx
.cfg
.enable_index_owner
= 1;
369 ctx
.cfg
.enable_tree_linenumbers
= 1;
370 ctx
.cfg
.enable_git_config
= 0;
371 ctx
.cfg
.max_repo_count
= 50;
372 ctx
.cfg
.max_commit_count
= 50;
373 ctx
.cfg
.max_lock_attempts
= 5;
374 ctx
.cfg
.max_msg_len
= 80;
375 ctx
.cfg
.max_repodesc_len
= 80;
376 ctx
.cfg
.max_blob_size
= 0;
377 ctx
.cfg
.max_stats
= 0;
378 ctx
.cfg
.project_list
= NULL
;
379 ctx
.cfg
.renamelimit
= -1;
380 ctx
.cfg
.remove_suffix
= 0;
381 ctx
.cfg
.robots
= "index, nofollow";
382 ctx
.cfg
.root_title
= "Git repository browser";
383 ctx
.cfg
.root_desc
= "a fast webinterface for the git dscm";
384 ctx
.cfg
.scan_hidden_path
= 0;
385 ctx
.cfg
.script_name
= CGIT_SCRIPT_NAME
;
386 ctx
.cfg
.section
= "";
387 ctx
.cfg
.repository_sort
= "name";
388 ctx
.cfg
.section_sort
= 1;
389 ctx
.cfg
.summary_branches
= 10;
390 ctx
.cfg
.summary_log
= 10;
391 ctx
.cfg
.summary_tags
= 10;
392 ctx
.cfg
.max_atom_items
= 10;
393 ctx
.cfg
.difftype
= DIFF_UNIFIED
;
394 ctx
.env
.cgit_config
= getenv("CGIT_CONFIG");
395 ctx
.env
.http_host
= getenv("HTTP_HOST");
396 ctx
.env
.https
= getenv("HTTPS");
397 ctx
.env
.no_http
= getenv("NO_HTTP");
398 ctx
.env
.path_info
= getenv("PATH_INFO");
399 ctx
.env
.query_string
= getenv("QUERY_STRING");
400 ctx
.env
.request_method
= getenv("REQUEST_METHOD");
401 ctx
.env
.script_name
= getenv("SCRIPT_NAME");
402 ctx
.env
.server_name
= getenv("SERVER_NAME");
403 ctx
.env
.server_port
= getenv("SERVER_PORT");
404 ctx
.env
.http_cookie
= getenv("HTTP_COOKIE");
405 ctx
.env
.http_referer
= getenv("HTTP_REFERER");
406 ctx
.env
.content_length
= getenv("CONTENT_LENGTH") ? strtoul(getenv("CONTENT_LENGTH"), NULL
, 10) : 0;
407 ctx
.env
.authenticated
= 0;
408 ctx
.page
.mimetype
= "text/html";
409 ctx
.page
.charset
= PAGE_ENCODING
;
410 ctx
.page
.filename
= NULL
;
412 ctx
.page
.modified
= time(NULL
);
413 ctx
.page
.expires
= ctx
.page
.modified
;
414 ctx
.page
.etag
= NULL
;
415 memset(&ctx
.cfg
.mimetypes
, 0, sizeof(struct string_list
));
416 if (ctx
.env
.script_name
)
417 ctx
.cfg
.script_name
= xstrdup(ctx
.env
.script_name
);
418 if (ctx
.env
.query_string
)
419 ctx
.qry
.raw
= xstrdup(ctx
.env
.query_string
);
420 if (!ctx
.env
.cgit_config
)
421 ctx
.env
.cgit_config
= CGIT_CONFIG
;
430 static int find_current_ref(const char *refname
, const struct object_id
*oid
,
431 int flags
, void *cb_data
)
433 struct refmatch
*info
;
435 info
= (struct refmatch
*)cb_data
;
436 if (!strcmp(refname
, info
->req_ref
))
438 if (!info
->first_ref
)
439 info
->first_ref
= xstrdup(refname
);
443 static void free_refmatch_inner(struct refmatch
*info
)
446 free(info
->first_ref
);
449 static char *find_default_branch(struct cgit_repo
*repo
)
451 struct refmatch info
;
454 info
.req_ref
= repo
->defbranch
;
455 info
.first_ref
= NULL
;
457 for_each_branch_ref(find_current_ref
, &info
);
461 ref
= info
.first_ref
;
464 free_refmatch_inner(&info
);
469 static char *guess_defbranch(void)
472 unsigned char sha1
[20];
474 ref
= resolve_ref_unsafe("HEAD", 0, sha1
, NULL
);
475 if (!ref
|| !starts_with(ref
, "refs/heads/"))
477 return xstrdup(ref
+ 11);
479 /* The caller must free filename and ref after calling this. */
480 static inline void parse_readme(const char *readme
, char **filename
, char **ref
, struct cgit_repo
*repo
)
487 if (!readme
|| !readme
[0])
490 /* Check if the readme is tracked in the git repo. */
491 colon
= strchr(readme
, ':');
492 if (colon
&& strlen(colon
) > 1) {
493 /* If it starts with a colon, we want to use
494 * the default branch */
495 if (colon
== readme
&& repo
->defbranch
)
496 *ref
= xstrdup(repo
->defbranch
);
498 *ref
= xstrndup(readme
, colon
- readme
);
502 /* Prepend repo path to relative readme path unless tracked. */
503 if (!(*ref
) && readme
[0] != '/')
504 *filename
= fmtalloc("%s/%s", repo
->path
, readme
);
506 *filename
= xstrdup(readme
);
508 static void choose_readme(struct cgit_repo
*repo
)
511 char *filename
, *ref
;
512 struct string_list_item
*entry
;
514 if (!repo
->readme
.nr
)
518 for_each_string_list_item(entry
, &repo
->readme
) {
519 parse_readme(entry
->string
, &filename
, &ref
, repo
);
526 if (cgit_ref_path_exists(filename
, ref
, 1)) {
531 else if (!access(filename
, R_OK
)) {
538 repo
->readme
.strdup_strings
= 1;
539 string_list_clear(&repo
->readme
, 0);
540 repo
->readme
.strdup_strings
= 0;
542 string_list_append(&repo
->readme
, filename
)->util
= ref
;
545 static void print_no_repo_clone_urls(const char *url
)
547 html("<tr><td><a rel='vcs-git' href='");
550 html_attr(ctx
.repo
->name
);
551 html(" Git repository'>");
553 html("</a></td></tr>\n");
556 static int prepare_repo_cmd(void)
558 unsigned char sha1
[20];
562 /* The path to the git repository. */
563 setenv("GIT_DIR", ctx
.repo
->path
, 1);
565 /* Do not look in /etc/ for gitconfig and gitattributes. */
566 setenv("GIT_CONFIG_NOSYSTEM", "1", 1);
567 setenv("GIT_ATTR_NOSYSTEM", "1", 1);
569 unsetenv("XDG_CONFIG_HOME");
571 /* Setup the git directory and initialize the notes system. Both of these
572 * load local configuration from the git repository, so we do them both while
573 * the HOME variables are unset. */
574 setup_git_directory_gently(&nongit
);
575 init_display_notes(NULL
);
578 const char *name
= ctx
.repo
->name
;
580 ctx
.page
.title
= fmtalloc("%s - %s", ctx
.cfg
.root_title
,
583 cgit_print_http_headers();
584 cgit_print_docstart();
585 cgit_print_pageheader();
586 cgit_print_error("Failed to open %s: %s", name
,
587 rc
? strerror(rc
) : "Not a valid git repository");
591 ctx
.page
.title
= fmtalloc("%s - %s", ctx
.repo
->name
, ctx
.repo
->desc
);
593 if (!ctx
.repo
->defbranch
)
594 ctx
.repo
->defbranch
= guess_defbranch();
598 ctx
.qry
.head
= find_default_branch(ctx
.repo
);
602 cgit_print_http_headers();
603 cgit_print_docstart();
604 cgit_print_pageheader();
605 cgit_print_error("Repository seems to be empty");
606 if (!strcmp(ctx
.qry
.page
, "summary")) {
607 html("<table class='list'><tr class='nohover'><td> </td></tr><tr class='nohover'><th class='left'>Clone</th></tr>\n");
608 cgit_prepare_repo_env(ctx
.repo
);
609 cgit_add_clone_urls(print_no_repo_clone_urls
);
616 if (get_sha1(ctx
.qry
.head
, sha1
)) {
617 char *tmp
= xstrdup(ctx
.qry
.head
);
618 ctx
.qry
.head
= ctx
.repo
->defbranch
;
619 cgit_print_error_page(404, "Not found",
620 "Invalid branch: %s", tmp
);
624 string_list_sort(&ctx
.repo
->submodules
);
625 cgit_prepare_repo_env(ctx
.repo
);
626 choose_readme(ctx
.repo
);
630 static inline void open_auth_filter(const char *function
)
632 cgit_open_filter(ctx
.cfg
.auth_filter
, function
,
633 ctx
.env
.http_cookie
? ctx
.env
.http_cookie
: "",
634 ctx
.env
.request_method
? ctx
.env
.request_method
: "",
635 ctx
.env
.query_string
? ctx
.env
.query_string
: "",
636 ctx
.env
.http_referer
? ctx
.env
.http_referer
: "",
637 ctx
.env
.path_info
? ctx
.env
.path_info
: "",
638 ctx
.env
.http_host
? ctx
.env
.http_host
: "",
639 ctx
.env
.https
? ctx
.env
.https
: "",
640 ctx
.qry
.repo
? ctx
.qry
.repo
: "",
641 ctx
.qry
.page
? ctx
.qry
.page
: "",
642 ctx
.qry
.url
? ctx
.qry
.url
: "",
646 /* We intentionally keep this rather small, instead of looping and
647 * feeding it to the filter a couple bytes at a time. This way, the
648 * filter itself does not need to handle any denial of service or
649 * buffer bloat issues. If this winds up being too small, people
650 * will complain on the mailing list, and we'll increase it as needed. */
651 #define MAX_AUTHENTICATION_POST_BYTES 4096
652 /* The filter is expected to spit out "Status: " and all headers. */
653 static inline void authenticate_post(void)
655 char buffer
[MAX_AUTHENTICATION_POST_BYTES
];
658 open_auth_filter("authenticate-post");
659 len
= ctx
.env
.content_length
;
660 if (len
> MAX_AUTHENTICATION_POST_BYTES
)
661 len
= MAX_AUTHENTICATION_POST_BYTES
;
662 if (read(STDIN_FILENO
, buffer
, len
) < 0)
663 die_errno("Could not read POST from stdin");
664 if (write(STDOUT_FILENO
, buffer
, len
) < 0)
665 die_errno("Could not write POST to stdout");
666 cgit_close_filter(ctx
.cfg
.auth_filter
);
670 static inline void authenticate_cookie(void)
672 /* If we don't have an auth_filter, consider all cookies valid, and thus return early. */
673 if (!ctx
.cfg
.auth_filter
) {
674 ctx
.env
.authenticated
= 1;
678 /* If we're having something POST'd to /login, we're authenticating POST,
679 * instead of the cookie, so call authenticate_post and bail out early.
680 * This pattern here should match /?p=login with POST. */
681 if (ctx
.env
.request_method
&& ctx
.qry
.page
&& !ctx
.repo
&& \
682 !strcmp(ctx
.env
.request_method
, "POST") && !strcmp(ctx
.qry
.page
, "login")) {
687 /* If we've made it this far, we're authenticating the cookie for real, so do that. */
688 open_auth_filter("authenticate-cookie");
689 ctx
.env
.authenticated
= cgit_close_filter(ctx
.cfg
.auth_filter
);
692 static void process_request(void)
694 struct cgit_cmd
*cmd
;
696 /* If we're not yet authenticated, no matter what page we're on,
697 * display the authentication body from the auth_filter. This should
698 * never be cached. */
699 if (!ctx
.env
.authenticated
) {
700 ctx
.page
.title
= "Authentication Required";
701 cgit_print_http_headers();
702 cgit_print_docstart();
703 cgit_print_pageheader();
704 open_auth_filter("body");
705 cgit_close_filter(ctx
.cfg
.auth_filter
);
710 cmd
= cgit_get_cmd();
712 ctx
.page
.title
= "cgit error";
713 cgit_print_error_page(404, "Not found", "Invalid request");
717 if (!ctx
.cfg
.enable_http_clone
&& cmd
->is_clone
) {
718 ctx
.page
.title
= "cgit error";
719 cgit_print_error_page(404, "Not found", "Invalid request");
723 /* If cmd->want_vpath is set, assume ctx.qry.path contains a "virtual"
724 * in-project path limit to be made available at ctx.qry.vpath.
725 * Otherwise, no path limit is in effect (ctx.qry.vpath = NULL).
727 ctx
.qry
.vpath
= cmd
->want_vpath
? ctx
.qry
.path
: NULL
;
729 if (cmd
->want_repo
&& !ctx
.repo
) {
730 cgit_print_error_page(400, "Bad request",
731 "No repository selected");
735 if (ctx
.repo
&& prepare_repo_cmd())
741 static int cmp_repos(const void *a
, const void *b
)
743 const struct cgit_repo
*ra
= a
, *rb
= b
;
744 return strcmp(ra
->url
, rb
->url
);
747 static char *build_snapshot_setting(int bitmap
)
749 const struct cgit_snapshot_format
*f
;
750 struct strbuf result
= STRBUF_INIT
;
752 for (f
= cgit_snapshot_formats
; f
->suffix
; f
++) {
753 if (f
->bit
& bitmap
) {
755 strbuf_addch(&result
, ' ');
756 strbuf_addstr(&result
, f
->suffix
);
759 return strbuf_detach(&result
, NULL
);
762 static char *get_first_line(char *txt
)
764 char *t
= xstrdup(txt
);
765 char *p
= strchr(t
, '\n');
771 static void print_repo(FILE *f
, struct cgit_repo
*repo
)
773 struct string_list_item
*item
;
774 fprintf(f
, "repo.url=%s\n", repo
->url
);
775 fprintf(f
, "repo.name=%s\n", repo
->name
);
776 fprintf(f
, "repo.path=%s\n", repo
->path
);
778 fprintf(f
, "repo.owner=%s\n", repo
->owner
);
780 char *tmp
= get_first_line(repo
->desc
);
781 fprintf(f
, "repo.desc=%s\n", tmp
);
784 for_each_string_list_item(item
, &repo
->readme
) {
786 fprintf(f
, "repo.readme=%s:%s\n", (char *)item
->util
, item
->string
);
788 fprintf(f
, "repo.readme=%s\n", item
->string
);
791 fprintf(f
, "repo.defbranch=%s\n", repo
->defbranch
);
792 if (repo
->module_link
)
793 fprintf(f
, "repo.module-link=%s\n", repo
->module_link
);
795 fprintf(f
, "repo.section=%s\n", repo
->section
);
797 fprintf(f
, "repo.clone-url=%s\n", repo
->clone_url
);
798 fprintf(f
, "repo.enable-commit-graph=%d\n",
799 repo
->enable_commit_graph
);
800 fprintf(f
, "repo.enable-log-filecount=%d\n",
801 repo
->enable_log_filecount
);
802 fprintf(f
, "repo.enable-log-linecount=%d\n",
803 repo
->enable_log_linecount
);
804 if (repo
->about_filter
&& repo
->about_filter
!= ctx
.cfg
.about_filter
)
805 cgit_fprintf_filter(repo
->about_filter
, f
, "repo.about-filter=");
806 if (repo
->commit_filter
&& repo
->commit_filter
!= ctx
.cfg
.commit_filter
)
807 cgit_fprintf_filter(repo
->commit_filter
, f
, "repo.commit-filter=");
808 if (repo
->source_filter
&& repo
->source_filter
!= ctx
.cfg
.source_filter
)
809 cgit_fprintf_filter(repo
->source_filter
, f
, "repo.source-filter=");
810 if (repo
->email_filter
&& repo
->email_filter
!= ctx
.cfg
.email_filter
)
811 cgit_fprintf_filter(repo
->email_filter
, f
, "repo.email-filter=");
812 if (repo
->owner_filter
&& repo
->owner_filter
!= ctx
.cfg
.owner_filter
)
813 cgit_fprintf_filter(repo
->owner_filter
, f
, "repo.owner-filter=");
814 if (repo
->snapshots
!= ctx
.cfg
.snapshots
) {
815 char *tmp
= build_snapshot_setting(repo
->snapshots
);
816 fprintf(f
, "repo.snapshots=%s\n", tmp
? tmp
: "");
819 if (repo
->max_stats
!= ctx
.cfg
.max_stats
)
820 fprintf(f
, "repo.max-stats=%s\n",
821 cgit_find_stats_periodname(repo
->max_stats
));
823 fprintf(f
, "repo.logo=%s\n", repo
->logo
);
825 fprintf(f
, "repo.logo-link=%s\n", repo
->logo_link
);
826 fprintf(f
, "repo.enable-remote-branches=%d\n", repo
->enable_remote_branches
);
827 fprintf(f
, "repo.enable-subject-links=%d\n", repo
->enable_subject_links
);
828 fprintf(f
, "repo.enable-html-serving=%d\n", repo
->enable_html_serving
);
829 if (repo
->branch_sort
== 1)
830 fprintf(f
, "repo.branch-sort=age\n");
831 if (repo
->commit_sort
) {
832 if (repo
->commit_sort
== 1)
833 fprintf(f
, "repo.commit-sort=date\n");
834 else if (repo
->commit_sort
== 2)
835 fprintf(f
, "repo.commit-sort=topo\n");
837 fprintf(f
, "repo.hide=%d\n", repo
->hide
);
838 fprintf(f
, "repo.ignore=%d\n", repo
->ignore
);
842 static void print_repolist(FILE *f
, struct cgit_repolist
*list
, int start
)
846 for (i
= start
; i
< list
->count
; i
++)
847 print_repo(f
, &list
->repos
[i
]);
850 /* Scan 'path' for git repositories, save the resulting repolist in 'cached_rc'
851 * and return 0 on success.
853 static int generate_cached_repolist(const char *path
, const char *cached_rc
)
855 struct strbuf locked_rc
= STRBUF_INIT
;
860 strbuf_addf(&locked_rc
, "%s.lock", cached_rc
);
861 f
= fopen(locked_rc
.buf
, "wx");
863 /* Inform about the error unless the lockfile already existed,
864 * since that only means we've got concurrent requests.
867 if (result
!= EEXIST
)
868 fprintf(stderr
, "[cgit] Error opening %s: %s (%d)\n",
869 locked_rc
.buf
, strerror(result
), result
);
872 idx
= cgit_repolist
.count
;
873 if (ctx
.cfg
.project_list
)
874 scan_projects(path
, ctx
.cfg
.project_list
, repo_config
);
876 scan_tree(path
, repo_config
);
877 print_repolist(f
, &cgit_repolist
, idx
);
878 if (rename(locked_rc
.buf
, cached_rc
))
879 fprintf(stderr
, "[cgit] Error renaming %s to %s: %s (%d)\n",
880 locked_rc
.buf
, cached_rc
, strerror(errno
), errno
);
883 strbuf_release(&locked_rc
);
887 static void process_cached_repolist(const char *path
)
890 struct strbuf cached_rc
= STRBUF_INIT
;
894 hash
= hash_str(path
);
895 if (ctx
.cfg
.project_list
)
896 hash
+= hash_str(ctx
.cfg
.project_list
);
897 strbuf_addf(&cached_rc
, "%s/rc-%8lx", ctx
.cfg
.cache_root
, hash
);
899 if (stat(cached_rc
.buf
, &st
)) {
900 /* Nothing is cached, we need to scan without forking. And
901 * if we fail to generate a cached repolist, we need to
902 * invoke scan_tree manually.
904 if (generate_cached_repolist(path
, cached_rc
.buf
)) {
905 if (ctx
.cfg
.project_list
)
906 scan_projects(path
, ctx
.cfg
.project_list
,
909 scan_tree(path
, repo_config
);
914 parse_configfile(cached_rc
.buf
, config_cb
);
916 /* If the cached configfile hasn't expired, lets exit now */
917 age
= time(NULL
) - st
.st_mtime
;
918 if (age
<= (ctx
.cfg
.cache_scanrc_ttl
* 60))
921 /* The cached repolist has been parsed, but it was old. So lets
922 * rescan the specified path and generate a new cached repolist
923 * in a child-process to avoid latency for the current request.
928 exit(generate_cached_repolist(path
, cached_rc
.buf
));
930 strbuf_release(&cached_rc
);
933 static void cgit_parse_args(int argc
, const char **argv
)
938 for (i
= 1; i
< argc
; i
++) {
939 if (!strcmp(argv
[i
], "--version")) {
940 printf("CGit %s | http://git.zx2c4.com/cgit/\n\nCompiled in features:\n", CGIT_VERSION
);
946 printf("Lua scripting\n");
947 #ifndef HAVE_LINUX_SENDFILE
952 printf("Linux sendfile() usage\n");
956 if (starts_with(argv
[i
], "--cache=")) {
957 ctx
.cfg
.cache_root
= xstrdup(argv
[i
] + 8);
958 } else if (!strcmp(argv
[i
], "--nocache")) {
960 } else if (!strcmp(argv
[i
], "--nohttp")) {
961 ctx
.env
.no_http
= "1";
962 } else if (starts_with(argv
[i
], "--query=")) {
963 ctx
.qry
.raw
= xstrdup(argv
[i
] + 8);
964 } else if (starts_with(argv
[i
], "--repo=")) {
965 ctx
.qry
.repo
= xstrdup(argv
[i
] + 7);
966 } else if (starts_with(argv
[i
], "--page=")) {
967 ctx
.qry
.page
= xstrdup(argv
[i
] + 7);
968 } else if (starts_with(argv
[i
], "--head=")) {
969 ctx
.qry
.head
= xstrdup(argv
[i
] + 7);
970 ctx
.qry
.has_symref
= 1;
971 } else if (starts_with(argv
[i
], "--sha1=")) {
972 ctx
.qry
.sha1
= xstrdup(argv
[i
] + 7);
973 ctx
.qry
.has_sha1
= 1;
974 } else if (starts_with(argv
[i
], "--ofs=")) {
975 ctx
.qry
.ofs
= atoi(argv
[i
] + 6);
976 } else if (starts_with(argv
[i
], "--scan-tree=") ||
977 starts_with(argv
[i
], "--scan-path=")) {
979 * HACK: The global snapshot bit mask defines the set
980 * of allowed snapshot formats, but the config file
981 * hasn't been parsed yet so the mask is currently 0.
982 * By setting all bits high before scanning we make
983 * sure that any in-repo cgitrc snapshot setting is
984 * respected by scan_tree().
986 * NOTE: We assume that there aren't more than 8
987 * different snapshot formats supported by cgit...
989 ctx
.cfg
.snapshots
= 0xFF;
991 scan_tree(argv
[i
] + 12, repo_config
);
995 qsort(cgit_repolist
.repos
, cgit_repolist
.count
,
996 sizeof(struct cgit_repo
), cmp_repos
);
997 print_repolist(stdout
, &cgit_repolist
, 0);
1002 static int calc_ttl(void)
1005 return ctx
.cfg
.cache_root_ttl
;
1008 return ctx
.cfg
.cache_repo_ttl
;
1010 if (!strcmp(ctx
.qry
.page
, "about"))
1011 return ctx
.cfg
.cache_about_ttl
;
1013 if (!strcmp(ctx
.qry
.page
, "snapshot"))
1014 return ctx
.cfg
.cache_snapshot_ttl
;
1016 if (ctx
.qry
.has_sha1
)
1017 return ctx
.cfg
.cache_static_ttl
;
1019 if (ctx
.qry
.has_symref
)
1020 return ctx
.cfg
.cache_dynamic_ttl
;
1022 return ctx
.cfg
.cache_repo_ttl
;
1025 int main(int argc
, const char **argv
)
1030 cgit_init_filters();
1031 atexit(cgit_cleanup_filters
);
1034 cgit_repolist
.length
= 0;
1035 cgit_repolist
.count
= 0;
1036 cgit_repolist
.repos
= NULL
;
1038 cgit_parse_args(argc
, argv
);
1039 parse_configfile(expand_macros(ctx
.env
.cgit_config
), config_cb
);
1041 http_parse_querystring(ctx
.qry
.raw
, querystring_cb
);
1043 /* If virtual-root isn't specified in cgitrc, lets pretend
1044 * that virtual-root equals SCRIPT_NAME, minus any possibly
1047 if (!ctx
.cfg
.virtual_root
&& ctx
.cfg
.script_name
)
1048 ctx
.cfg
.virtual_root
= ensure_end(ctx
.cfg
.script_name
, '/');
1050 /* If no url parameter is specified on the querystring, lets
1051 * use PATH_INFO as url. This allows cgit to work with virtual
1052 * urls without the need for rewriterules in the webserver (as
1053 * long as PATH_INFO is included in the cache lookup key).
1055 path
= ctx
.env
.path_info
;
1056 if (!ctx
.qry
.url
&& path
) {
1059 ctx
.qry
.url
= xstrdup(path
);
1061 char *newqry
= fmtalloc("%s?%s", path
, ctx
.qry
.raw
);
1063 ctx
.qry
.raw
= newqry
;
1065 ctx
.qry
.raw
= xstrdup(ctx
.qry
.url
);
1066 cgit_parse_url(ctx
.qry
.url
);
1069 /* Before we go any further, we set ctx.env.authenticated by checking to see
1070 * if the supplied cookie is valid. All cookies are valid if there is no
1071 * auth_filter. If there is an auth_filter, the filter decides. */
1072 authenticate_cookie();
1076 ctx
.page
.expires
+= 10 * 365 * 24 * 60 * 60; /* 10 years */
1078 ctx
.page
.expires
+= ttl
* 60;
1079 if (!ctx
.env
.authenticated
|| (ctx
.env
.request_method
&& !strcmp(ctx
.env
.request_method
, "HEAD")))
1080 ctx
.cfg
.nocache
= 1;
1081 if (ctx
.cfg
.nocache
)
1082 ctx
.cfg
.cache_size
= 0;
1083 err
= cache_process(ctx
.cfg
.cache_size
, ctx
.cfg
.cache_root
,
1084 ctx
.qry
.raw
, ttl
, process_request
);
1085 cgit_cleanup_filters();
1087 cgit_print_error("Error processing page: %s (%d)",
1088 strerror(err
), err
);