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 (ctx
.cfg
.enable_filter_overrides
) {
86 if (!strcmp(name
, "about-filter"))
87 repo
->about_filter
= cgit_new_filter(value
, ABOUT
);
88 else if (!strcmp(name
, "commit-filter"))
89 repo
->commit_filter
= cgit_new_filter(value
, COMMIT
);
90 else if (!strcmp(name
, "source-filter"))
91 repo
->source_filter
= cgit_new_filter(value
, SOURCE
);
92 else if (!strcmp(name
, "email-filter"))
93 repo
->email_filter
= cgit_new_filter(value
, EMAIL
);
94 else if (!strcmp(name
, "owner-filter"))
95 repo
->owner_filter
= cgit_new_filter(value
, OWNER
);
99 static void config_cb(const char *name
, const char *value
)
101 if (!strcmp(name
, "section") || !strcmp(name
, "repo.group"))
102 ctx
.cfg
.section
= xstrdup(value
);
103 else if (!strcmp(name
, "repo.url"))
104 ctx
.repo
= cgit_add_repo(value
);
105 else if (ctx
.repo
&& !strcmp(name
, "repo.path"))
106 ctx
.repo
->path
= trim_end(value
, '/');
107 else if (ctx
.repo
&& starts_with(name
, "repo."))
108 repo_config(ctx
.repo
, name
+ 5, value
);
109 else if (!strcmp(name
, "readme") && value
!= NULL
)
110 string_list_append(&ctx
.cfg
.readme
, xstrdup(value
));
111 else if (!strcmp(name
, "root-title"))
112 ctx
.cfg
.root_title
= xstrdup(value
);
113 else if (!strcmp(name
, "root-desc"))
114 ctx
.cfg
.root_desc
= xstrdup(value
);
115 else if (!strcmp(name
, "root-readme"))
116 ctx
.cfg
.root_readme
= xstrdup(value
);
117 else if (!strcmp(name
, "css"))
118 ctx
.cfg
.css
= xstrdup(value
);
119 else if (!strcmp(name
, "favicon"))
120 ctx
.cfg
.favicon
= xstrdup(value
);
121 else if (!strcmp(name
, "footer"))
122 ctx
.cfg
.footer
= xstrdup(value
);
123 else if (!strcmp(name
, "head-include"))
124 ctx
.cfg
.head_include
= xstrdup(value
);
125 else if (!strcmp(name
, "header"))
126 ctx
.cfg
.header
= xstrdup(value
);
127 else if (!strcmp(name
, "logo"))
128 ctx
.cfg
.logo
= xstrdup(value
);
129 else if (!strcmp(name
, "index-header"))
130 ctx
.cfg
.index_header
= xstrdup(value
);
131 else if (!strcmp(name
, "index-info"))
132 ctx
.cfg
.index_info
= xstrdup(value
);
133 else if (!strcmp(name
, "logo-link"))
134 ctx
.cfg
.logo_link
= xstrdup(value
);
135 else if (!strcmp(name
, "module-link"))
136 ctx
.cfg
.module_link
= xstrdup(value
);
137 else if (!strcmp(name
, "strict-export"))
138 ctx
.cfg
.strict_export
= xstrdup(value
);
139 else if (!strcmp(name
, "virtual-root")) {
140 ctx
.cfg
.virtual_root
= ensure_end(value
, '/');
141 } else if (!strcmp(name
, "nocache"))
142 ctx
.cfg
.nocache
= atoi(value
);
143 else if (!strcmp(name
, "noplainemail"))
144 ctx
.cfg
.noplainemail
= atoi(value
);
145 else if (!strcmp(name
, "noheader"))
146 ctx
.cfg
.noheader
= atoi(value
);
147 else if (!strcmp(name
, "snapshots"))
148 ctx
.cfg
.snapshots
= cgit_parse_snapshots_mask(value
);
149 else if (!strcmp(name
, "enable-filter-overrides"))
150 ctx
.cfg
.enable_filter_overrides
= atoi(value
);
151 else if (!strcmp(name
, "enable-http-clone"))
152 ctx
.cfg
.enable_http_clone
= atoi(value
);
153 else if (!strcmp(name
, "enable-index-links"))
154 ctx
.cfg
.enable_index_links
= atoi(value
);
155 else if (!strcmp(name
, "enable-index-owner"))
156 ctx
.cfg
.enable_index_owner
= atoi(value
);
157 else if (!strcmp(name
, "enable-commit-graph"))
158 ctx
.cfg
.enable_commit_graph
= atoi(value
);
159 else if (!strcmp(name
, "enable-log-filecount"))
160 ctx
.cfg
.enable_log_filecount
= atoi(value
);
161 else if (!strcmp(name
, "enable-log-linecount"))
162 ctx
.cfg
.enable_log_linecount
= atoi(value
);
163 else if (!strcmp(name
, "enable-remote-branches"))
164 ctx
.cfg
.enable_remote_branches
= atoi(value
);
165 else if (!strcmp(name
, "enable-subject-links"))
166 ctx
.cfg
.enable_subject_links
= atoi(value
);
167 else if (!strcmp(name
, "enable-tree-linenumbers"))
168 ctx
.cfg
.enable_tree_linenumbers
= atoi(value
);
169 else if (!strcmp(name
, "enable-git-config"))
170 ctx
.cfg
.enable_git_config
= atoi(value
);
171 else if (!strcmp(name
, "max-stats"))
172 ctx
.cfg
.max_stats
= cgit_find_stats_period(value
, NULL
);
173 else if (!strcmp(name
, "cache-size"))
174 ctx
.cfg
.cache_size
= atoi(value
);
175 else if (!strcmp(name
, "cache-root"))
176 ctx
.cfg
.cache_root
= xstrdup(expand_macros(value
));
177 else if (!strcmp(name
, "cache-root-ttl"))
178 ctx
.cfg
.cache_root_ttl
= atoi(value
);
179 else if (!strcmp(name
, "cache-repo-ttl"))
180 ctx
.cfg
.cache_repo_ttl
= atoi(value
);
181 else if (!strcmp(name
, "cache-scanrc-ttl"))
182 ctx
.cfg
.cache_scanrc_ttl
= atoi(value
);
183 else if (!strcmp(name
, "cache-static-ttl"))
184 ctx
.cfg
.cache_static_ttl
= atoi(value
);
185 else if (!strcmp(name
, "cache-dynamic-ttl"))
186 ctx
.cfg
.cache_dynamic_ttl
= atoi(value
);
187 else if (!strcmp(name
, "cache-about-ttl"))
188 ctx
.cfg
.cache_about_ttl
= atoi(value
);
189 else if (!strcmp(name
, "cache-snapshot-ttl"))
190 ctx
.cfg
.cache_snapshot_ttl
= atoi(value
);
191 else if (!strcmp(name
, "case-sensitive-sort"))
192 ctx
.cfg
.case_sensitive_sort
= atoi(value
);
193 else if (!strcmp(name
, "about-filter"))
194 ctx
.cfg
.about_filter
= cgit_new_filter(value
, ABOUT
);
195 else if (!strcmp(name
, "commit-filter"))
196 ctx
.cfg
.commit_filter
= cgit_new_filter(value
, COMMIT
);
197 else if (!strcmp(name
, "email-filter"))
198 ctx
.cfg
.email_filter
= cgit_new_filter(value
, EMAIL
);
199 else if (!strcmp(name
, "owner-filter"))
200 ctx
.cfg
.owner_filter
= cgit_new_filter(value
, OWNER
);
201 else if (!strcmp(name
, "auth-filter"))
202 ctx
.cfg
.auth_filter
= cgit_new_filter(value
, AUTH
);
203 else if (!strcmp(name
, "embedded"))
204 ctx
.cfg
.embedded
= atoi(value
);
205 else if (!strcmp(name
, "max-atom-items"))
206 ctx
.cfg
.max_atom_items
= atoi(value
);
207 else if (!strcmp(name
, "max-message-length"))
208 ctx
.cfg
.max_msg_len
= atoi(value
);
209 else if (!strcmp(name
, "max-repodesc-length"))
210 ctx
.cfg
.max_repodesc_len
= atoi(value
);
211 else if (!strcmp(name
, "max-blob-size"))
212 ctx
.cfg
.max_blob_size
= atoi(value
);
213 else if (!strcmp(name
, "max-repo-count"))
214 ctx
.cfg
.max_repo_count
= atoi(value
);
215 else if (!strcmp(name
, "max-commit-count"))
216 ctx
.cfg
.max_commit_count
= atoi(value
);
217 else if (!strcmp(name
, "project-list"))
218 ctx
.cfg
.project_list
= xstrdup(expand_macros(value
));
219 else if (!strcmp(name
, "scan-path"))
220 if (!ctx
.cfg
.nocache
&& ctx
.cfg
.cache_size
)
221 process_cached_repolist(expand_macros(value
));
222 else if (ctx
.cfg
.project_list
)
223 scan_projects(expand_macros(value
),
224 ctx
.cfg
.project_list
, repo_config
);
226 scan_tree(expand_macros(value
), repo_config
);
227 else if (!strcmp(name
, "scan-hidden-path"))
228 ctx
.cfg
.scan_hidden_path
= atoi(value
);
229 else if (!strcmp(name
, "section-from-path"))
230 ctx
.cfg
.section_from_path
= atoi(value
);
231 else if (!strcmp(name
, "repository-sort"))
232 ctx
.cfg
.repository_sort
= xstrdup(value
);
233 else if (!strcmp(name
, "section-sort"))
234 ctx
.cfg
.section_sort
= atoi(value
);
235 else if (!strcmp(name
, "source-filter"))
236 ctx
.cfg
.source_filter
= cgit_new_filter(value
, SOURCE
);
237 else if (!strcmp(name
, "summary-log"))
238 ctx
.cfg
.summary_log
= atoi(value
);
239 else if (!strcmp(name
, "summary-branches"))
240 ctx
.cfg
.summary_branches
= atoi(value
);
241 else if (!strcmp(name
, "summary-tags"))
242 ctx
.cfg
.summary_tags
= atoi(value
);
243 else if (!strcmp(name
, "side-by-side-diffs"))
244 ctx
.cfg
.difftype
= atoi(value
) ? DIFF_SSDIFF
: DIFF_UNIFIED
;
245 else if (!strcmp(name
, "agefile"))
246 ctx
.cfg
.agefile
= xstrdup(value
);
247 else if (!strcmp(name
, "mimetype-file"))
248 ctx
.cfg
.mimetype_file
= xstrdup(value
);
249 else if (!strcmp(name
, "renamelimit"))
250 ctx
.cfg
.renamelimit
= atoi(value
);
251 else if (!strcmp(name
, "remove-suffix"))
252 ctx
.cfg
.remove_suffix
= atoi(value
);
253 else if (!strcmp(name
, "robots"))
254 ctx
.cfg
.robots
= xstrdup(value
);
255 else if (!strcmp(name
, "clone-prefix"))
256 ctx
.cfg
.clone_prefix
= xstrdup(value
);
257 else if (!strcmp(name
, "clone-url"))
258 ctx
.cfg
.clone_url
= xstrdup(value
);
259 else if (!strcmp(name
, "local-time"))
260 ctx
.cfg
.local_time
= atoi(value
);
261 else if (!strcmp(name
, "commit-sort")) {
262 if (!strcmp(value
, "date"))
263 ctx
.cfg
.commit_sort
= 1;
264 if (!strcmp(value
, "topo"))
265 ctx
.cfg
.commit_sort
= 2;
266 } else if (!strcmp(name
, "branch-sort")) {
267 if (!strcmp(value
, "age"))
268 ctx
.cfg
.branch_sort
= 1;
269 if (!strcmp(value
, "name"))
270 ctx
.cfg
.branch_sort
= 0;
271 } else if (starts_with(name
, "mimetype."))
272 add_mimetype(name
+ 9, value
);
273 else if (!strcmp(name
, "include"))
274 parse_configfile(expand_macros(value
), config_cb
);
277 static void querystring_cb(const char *name
, const char *value
)
282 if (!strcmp(name
,"r")) {
283 ctx
.qry
.repo
= xstrdup(value
);
284 ctx
.repo
= cgit_get_repoinfo(value
);
285 } else if (!strcmp(name
, "p")) {
286 ctx
.qry
.page
= xstrdup(value
);
287 } else if (!strcmp(name
, "url")) {
290 ctx
.qry
.url
= xstrdup(value
);
291 cgit_parse_url(value
);
292 } else if (!strcmp(name
, "qt")) {
293 ctx
.qry
.grep
= xstrdup(value
);
294 } else if (!strcmp(name
, "q")) {
295 ctx
.qry
.search
= xstrdup(value
);
296 } else if (!strcmp(name
, "h")) {
297 ctx
.qry
.head
= xstrdup(value
);
298 ctx
.qry
.has_symref
= 1;
299 } else if (!strcmp(name
, "id")) {
300 ctx
.qry
.sha1
= xstrdup(value
);
301 ctx
.qry
.has_sha1
= 1;
302 } else if (!strcmp(name
, "id2")) {
303 ctx
.qry
.sha2
= xstrdup(value
);
304 ctx
.qry
.has_sha1
= 1;
305 } else if (!strcmp(name
, "ofs")) {
306 ctx
.qry
.ofs
= atoi(value
);
307 } else if (!strcmp(name
, "path")) {
308 ctx
.qry
.path
= trim_end(value
, '/');
309 } else if (!strcmp(name
, "name")) {
310 ctx
.qry
.name
= xstrdup(value
);
311 } else if (!strcmp(name
, "mimetype")) {
312 ctx
.qry
.mimetype
= xstrdup(value
);
313 } else if (!strcmp(name
, "s")) {
314 ctx
.qry
.sort
= xstrdup(value
);
315 } else if (!strcmp(name
, "showmsg")) {
316 ctx
.qry
.showmsg
= atoi(value
);
317 } else if (!strcmp(name
, "period")) {
318 ctx
.qry
.period
= xstrdup(value
);
319 } else if (!strcmp(name
, "dt")) {
320 ctx
.qry
.difftype
= atoi(value
);
321 ctx
.qry
.has_difftype
= 1;
322 } else if (!strcmp(name
, "ss")) {
323 /* No longer generated, but there may be links out there. */
324 ctx
.qry
.difftype
= atoi(value
) ? DIFF_SSDIFF
: DIFF_UNIFIED
;
325 ctx
.qry
.has_difftype
= 1;
326 } else if (!strcmp(name
, "all")) {
327 ctx
.qry
.show_all
= atoi(value
);
328 } else if (!strcmp(name
, "context")) {
329 ctx
.qry
.context
= atoi(value
);
330 } else if (!strcmp(name
, "ignorews")) {
331 ctx
.qry
.ignorews
= atoi(value
);
335 static void prepare_context(void)
337 memset(&ctx
, 0, sizeof(ctx
));
338 ctx
.cfg
.agefile
= "info/web/last-modified";
340 ctx
.cfg
.cache_size
= 0;
341 ctx
.cfg
.cache_max_create_time
= 5;
342 ctx
.cfg
.cache_root
= CGIT_CACHE_ROOT
;
343 ctx
.cfg
.cache_about_ttl
= 15;
344 ctx
.cfg
.cache_snapshot_ttl
= 5;
345 ctx
.cfg
.cache_repo_ttl
= 5;
346 ctx
.cfg
.cache_root_ttl
= 5;
347 ctx
.cfg
.cache_scanrc_ttl
= 15;
348 ctx
.cfg
.cache_dynamic_ttl
= 5;
349 ctx
.cfg
.cache_static_ttl
= -1;
350 ctx
.cfg
.case_sensitive_sort
= 1;
351 ctx
.cfg
.branch_sort
= 0;
352 ctx
.cfg
.commit_sort
= 0;
353 ctx
.cfg
.css
= "/cgit.css";
354 ctx
.cfg
.logo
= "/cgit.png";
355 ctx
.cfg
.favicon
= "/favicon.ico";
356 ctx
.cfg
.local_time
= 0;
357 ctx
.cfg
.enable_http_clone
= 1;
358 ctx
.cfg
.enable_index_owner
= 1;
359 ctx
.cfg
.enable_tree_linenumbers
= 1;
360 ctx
.cfg
.enable_git_config
= 0;
361 ctx
.cfg
.max_repo_count
= 50;
362 ctx
.cfg
.max_commit_count
= 50;
363 ctx
.cfg
.max_lock_attempts
= 5;
364 ctx
.cfg
.max_msg_len
= 80;
365 ctx
.cfg
.max_repodesc_len
= 80;
366 ctx
.cfg
.max_blob_size
= 0;
367 ctx
.cfg
.max_stats
= 0;
368 ctx
.cfg
.project_list
= NULL
;
369 ctx
.cfg
.renamelimit
= -1;
370 ctx
.cfg
.remove_suffix
= 0;
371 ctx
.cfg
.robots
= "index, nofollow";
372 ctx
.cfg
.root_title
= "Git repository browser";
373 ctx
.cfg
.root_desc
= "a fast webinterface for the git dscm";
374 ctx
.cfg
.scan_hidden_path
= 0;
375 ctx
.cfg
.script_name
= CGIT_SCRIPT_NAME
;
376 ctx
.cfg
.section
= "";
377 ctx
.cfg
.repository_sort
= "name";
378 ctx
.cfg
.section_sort
= 1;
379 ctx
.cfg
.summary_branches
= 10;
380 ctx
.cfg
.summary_log
= 10;
381 ctx
.cfg
.summary_tags
= 10;
382 ctx
.cfg
.max_atom_items
= 10;
383 ctx
.cfg
.difftype
= DIFF_UNIFIED
;
384 ctx
.env
.cgit_config
= getenv("CGIT_CONFIG");
385 ctx
.env
.http_host
= getenv("HTTP_HOST");
386 ctx
.env
.https
= getenv("HTTPS");
387 ctx
.env
.no_http
= getenv("NO_HTTP");
388 ctx
.env
.path_info
= getenv("PATH_INFO");
389 ctx
.env
.query_string
= getenv("QUERY_STRING");
390 ctx
.env
.request_method
= getenv("REQUEST_METHOD");
391 ctx
.env
.script_name
= getenv("SCRIPT_NAME");
392 ctx
.env
.server_name
= getenv("SERVER_NAME");
393 ctx
.env
.server_port
= getenv("SERVER_PORT");
394 ctx
.env
.http_cookie
= getenv("HTTP_COOKIE");
395 ctx
.env
.http_referer
= getenv("HTTP_REFERER");
396 ctx
.env
.content_length
= getenv("CONTENT_LENGTH") ? strtoul(getenv("CONTENT_LENGTH"), NULL
, 10) : 0;
397 ctx
.env
.authenticated
= 0;
398 ctx
.page
.mimetype
= "text/html";
399 ctx
.page
.charset
= PAGE_ENCODING
;
400 ctx
.page
.filename
= NULL
;
402 ctx
.page
.modified
= time(NULL
);
403 ctx
.page
.expires
= ctx
.page
.modified
;
404 ctx
.page
.etag
= NULL
;
405 memset(&ctx
.cfg
.mimetypes
, 0, sizeof(struct string_list
));
406 if (ctx
.env
.script_name
)
407 ctx
.cfg
.script_name
= xstrdup(ctx
.env
.script_name
);
408 if (ctx
.env
.query_string
)
409 ctx
.qry
.raw
= xstrdup(ctx
.env
.query_string
);
410 if (!ctx
.env
.cgit_config
)
411 ctx
.env
.cgit_config
= CGIT_CONFIG
;
420 static int find_current_ref(const char *refname
, const unsigned char *sha1
,
421 int flags
, void *cb_data
)
423 struct refmatch
*info
;
425 info
= (struct refmatch
*)cb_data
;
426 if (!strcmp(refname
, info
->req_ref
))
428 if (!info
->first_ref
)
429 info
->first_ref
= xstrdup(refname
);
433 static void free_refmatch_inner(struct refmatch
*info
)
436 free(info
->first_ref
);
439 static char *find_default_branch(struct cgit_repo
*repo
)
441 struct refmatch info
;
444 info
.req_ref
= repo
->defbranch
;
445 info
.first_ref
= NULL
;
447 for_each_branch_ref(find_current_ref
, &info
);
451 ref
= info
.first_ref
;
454 free_refmatch_inner(&info
);
459 static char *guess_defbranch(void)
462 unsigned char sha1
[20];
464 ref
= resolve_ref_unsafe("HEAD", 0, sha1
, NULL
);
465 if (!ref
|| !starts_with(ref
, "refs/heads/"))
467 return xstrdup(ref
+ 11);
469 /* The caller must free filename and ref after calling this. */
470 static inline void parse_readme(const char *readme
, char **filename
, char **ref
, struct cgit_repo
*repo
)
477 if (!readme
|| !readme
[0])
480 /* Check if the readme is tracked in the git repo. */
481 colon
= strchr(readme
, ':');
482 if (colon
&& strlen(colon
) > 1) {
483 /* If it starts with a colon, we want to use
484 * the default branch */
485 if (colon
== readme
&& repo
->defbranch
)
486 *ref
= xstrdup(repo
->defbranch
);
488 *ref
= xstrndup(readme
, colon
- readme
);
492 /* Prepend repo path to relative readme path unless tracked. */
493 if (!(*ref
) && readme
[0] != '/')
494 *filename
= fmtalloc("%s/%s", repo
->path
, readme
);
496 *filename
= xstrdup(readme
);
498 static void choose_readme(struct cgit_repo
*repo
)
501 char *filename
, *ref
;
502 struct string_list_item
*entry
;
504 if (!repo
->readme
.nr
)
508 for_each_string_list_item(entry
, &repo
->readme
) {
509 parse_readme(entry
->string
, &filename
, &ref
, repo
);
516 if (cgit_ref_path_exists(filename
, ref
, 1)) {
521 else if (!access(filename
, R_OK
)) {
528 repo
->readme
.strdup_strings
= 1;
529 string_list_clear(&repo
->readme
, 0);
530 repo
->readme
.strdup_strings
= 0;
532 string_list_append(&repo
->readme
, filename
)->util
= ref
;
535 static int prepare_repo_cmd(void)
537 unsigned char sha1
[20];
541 /* The path to the git repository. */
542 setenv("GIT_DIR", ctx
.repo
->path
, 1);
544 /* Do not look in /etc/ for gitconfig and gitattributes. */
545 setenv("GIT_CONFIG_NOSYSTEM", "1", 1);
546 setenv("GIT_ATTR_NOSYSTEM", "1", 1);
548 unsetenv("XDG_CONFIG_HOME");
550 /* Setup the git directory and initialize the notes system. Both of these
551 * load local configuration from the git repository, so we do them both while
552 * the HOME variables are unset. */
553 setup_git_directory_gently(&nongit
);
554 init_display_notes(NULL
);
557 const char *name
= ctx
.repo
->name
;
559 ctx
.page
.title
= fmtalloc("%s - %s", ctx
.cfg
.root_title
,
562 cgit_print_http_headers();
563 cgit_print_docstart();
564 cgit_print_pageheader();
565 cgit_print_error("Failed to open %s: %s", name
,
566 rc
? strerror(rc
) : "Not a valid git repository");
570 ctx
.page
.title
= fmtalloc("%s - %s", ctx
.repo
->name
, ctx
.repo
->desc
);
572 if (!ctx
.repo
->defbranch
)
573 ctx
.repo
->defbranch
= guess_defbranch();
577 ctx
.qry
.head
= find_default_branch(ctx
.repo
);
581 cgit_print_http_headers();
582 cgit_print_docstart();
583 cgit_print_pageheader();
584 cgit_print_error("Repository seems to be empty");
589 if (get_sha1(ctx
.qry
.head
, sha1
)) {
590 char *tmp
= xstrdup(ctx
.qry
.head
);
591 ctx
.qry
.head
= ctx
.repo
->defbranch
;
592 ctx
.page
.status
= 404;
593 ctx
.page
.statusmsg
= "Not found";
594 cgit_print_http_headers();
595 cgit_print_docstart();
596 cgit_print_pageheader();
597 cgit_print_error("Invalid branch: %s", tmp
);
602 sort_string_list(&ctx
.repo
->submodules
);
603 cgit_prepare_repo_env(ctx
.repo
);
604 choose_readme(ctx
.repo
);
608 static inline void open_auth_filter(const char *function
)
610 cgit_open_filter(ctx
.cfg
.auth_filter
, function
,
611 ctx
.env
.http_cookie
? ctx
.env
.http_cookie
: "",
612 ctx
.env
.request_method
? ctx
.env
.request_method
: "",
613 ctx
.env
.query_string
? ctx
.env
.query_string
: "",
614 ctx
.env
.http_referer
? ctx
.env
.http_referer
: "",
615 ctx
.env
.path_info
? ctx
.env
.path_info
: "",
616 ctx
.env
.http_host
? ctx
.env
.http_host
: "",
617 ctx
.env
.https
? ctx
.env
.https
: "",
618 ctx
.qry
.repo
? ctx
.qry
.repo
: "",
619 ctx
.qry
.page
? ctx
.qry
.page
: "",
620 ctx
.qry
.url
? ctx
.qry
.url
: "",
624 /* We intentionally keep this rather small, instead of looping and
625 * feeding it to the filter a couple bytes at a time. This way, the
626 * filter itself does not need to handle any denial of service or
627 * buffer bloat issues. If this winds up being too small, people
628 * will complain on the mailing list, and we'll increase it as needed. */
629 #define MAX_AUTHENTICATION_POST_BYTES 4096
630 /* The filter is expected to spit out "Status: " and all headers. */
631 static inline void authenticate_post(void)
633 char buffer
[MAX_AUTHENTICATION_POST_BYTES
];
636 open_auth_filter("authenticate-post");
637 len
= ctx
.env
.content_length
;
638 if (len
> MAX_AUTHENTICATION_POST_BYTES
)
639 len
= MAX_AUTHENTICATION_POST_BYTES
;
640 if (read(STDIN_FILENO
, buffer
, len
) < 0)
641 die_errno("Could not read POST from stdin");
642 if (write(STDOUT_FILENO
, buffer
, len
) < 0)
643 die_errno("Could not write POST to stdout");
644 cgit_close_filter(ctx
.cfg
.auth_filter
);
648 static inline void authenticate_cookie(void)
650 /* If we don't have an auth_filter, consider all cookies valid, and thus return early. */
651 if (!ctx
.cfg
.auth_filter
) {
652 ctx
.env
.authenticated
= 1;
656 /* If we're having something POST'd to /login, we're authenticating POST,
657 * instead of the cookie, so call authenticate_post and bail out early.
658 * This pattern here should match /?p=login with POST. */
659 if (ctx
.env
.request_method
&& ctx
.qry
.page
&& !ctx
.repo
&& \
660 !strcmp(ctx
.env
.request_method
, "POST") && !strcmp(ctx
.qry
.page
, "login")) {
665 /* If we've made it this far, we're authenticating the cookie for real, so do that. */
666 open_auth_filter("authenticate-cookie");
667 ctx
.env
.authenticated
= cgit_close_filter(ctx
.cfg
.auth_filter
);
670 static void process_request(void)
672 struct cgit_cmd
*cmd
;
674 /* If we're not yet authenticated, no matter what page we're on,
675 * display the authentication body from the auth_filter. This should
676 * never be cached. */
677 if (!ctx
.env
.authenticated
) {
678 ctx
.page
.title
= "Authentication Required";
679 cgit_print_http_headers();
680 cgit_print_docstart();
681 cgit_print_pageheader();
682 open_auth_filter("body");
683 cgit_close_filter(ctx
.cfg
.auth_filter
);
688 cmd
= cgit_get_cmd();
690 ctx
.page
.title
= "cgit error";
691 ctx
.page
.status
= 404;
692 ctx
.page
.statusmsg
= "Not found";
693 cgit_print_http_headers();
694 cgit_print_docstart();
695 cgit_print_pageheader();
696 cgit_print_error("Invalid request");
701 if (!ctx
.cfg
.enable_http_clone
&& cmd
->is_clone
) {
702 html_status(404, "Not found", 0);
706 /* If cmd->want_vpath is set, assume ctx.qry.path contains a "virtual"
707 * in-project path limit to be made available at ctx.qry.vpath.
708 * Otherwise, no path limit is in effect (ctx.qry.vpath = NULL).
710 ctx
.qry
.vpath
= cmd
->want_vpath
? ctx
.qry
.path
: NULL
;
712 if (cmd
->want_repo
&& !ctx
.repo
) {
713 cgit_print_http_headers();
714 cgit_print_docstart();
715 cgit_print_pageheader();
716 cgit_print_error("No repository selected");
721 if (ctx
.repo
&& prepare_repo_cmd())
724 if (cmd
->want_layout
) {
725 cgit_print_http_headers();
726 cgit_print_docstart();
727 cgit_print_pageheader();
732 if (cmd
->want_layout
)
736 static int cmp_repos(const void *a
, const void *b
)
738 const struct cgit_repo
*ra
= a
, *rb
= b
;
739 return strcmp(ra
->url
, rb
->url
);
742 static char *build_snapshot_setting(int bitmap
)
744 const struct cgit_snapshot_format
*f
;
745 struct strbuf result
= STRBUF_INIT
;
747 for (f
= cgit_snapshot_formats
; f
->suffix
; f
++) {
748 if (f
->bit
& bitmap
) {
750 strbuf_addch(&result
, ' ');
751 strbuf_addstr(&result
, f
->suffix
);
754 return strbuf_detach(&result
, NULL
);
757 static char *get_first_line(char *txt
)
759 char *t
= xstrdup(txt
);
760 char *p
= strchr(t
, '\n');
766 static void print_repo(FILE *f
, struct cgit_repo
*repo
)
768 struct string_list_item
*item
;
769 fprintf(f
, "repo.url=%s\n", repo
->url
);
770 fprintf(f
, "repo.name=%s\n", repo
->name
);
771 fprintf(f
, "repo.path=%s\n", repo
->path
);
773 fprintf(f
, "repo.owner=%s\n", repo
->owner
);
775 char *tmp
= get_first_line(repo
->desc
);
776 fprintf(f
, "repo.desc=%s\n", tmp
);
779 for_each_string_list_item(item
, &repo
->readme
) {
781 fprintf(f
, "repo.readme=%s:%s\n", (char *)item
->util
, item
->string
);
783 fprintf(f
, "repo.readme=%s\n", item
->string
);
786 fprintf(f
, "repo.defbranch=%s\n", repo
->defbranch
);
787 if (repo
->module_link
)
788 fprintf(f
, "repo.module-link=%s\n", repo
->module_link
);
790 fprintf(f
, "repo.section=%s\n", repo
->section
);
792 fprintf(f
, "repo.clone-url=%s\n", repo
->clone_url
);
793 fprintf(f
, "repo.enable-commit-graph=%d\n",
794 repo
->enable_commit_graph
);
795 fprintf(f
, "repo.enable-log-filecount=%d\n",
796 repo
->enable_log_filecount
);
797 fprintf(f
, "repo.enable-log-linecount=%d\n",
798 repo
->enable_log_linecount
);
799 if (repo
->about_filter
&& repo
->about_filter
!= ctx
.cfg
.about_filter
)
800 cgit_fprintf_filter(repo
->about_filter
, f
, "repo.about-filter=");
801 if (repo
->commit_filter
&& repo
->commit_filter
!= ctx
.cfg
.commit_filter
)
802 cgit_fprintf_filter(repo
->commit_filter
, f
, "repo.commit-filter=");
803 if (repo
->source_filter
&& repo
->source_filter
!= ctx
.cfg
.source_filter
)
804 cgit_fprintf_filter(repo
->source_filter
, f
, "repo.source-filter=");
805 if (repo
->email_filter
&& repo
->email_filter
!= ctx
.cfg
.email_filter
)
806 cgit_fprintf_filter(repo
->email_filter
, f
, "repo.email-filter=");
807 if (repo
->owner_filter
&& repo
->owner_filter
!= ctx
.cfg
.owner_filter
)
808 cgit_fprintf_filter(repo
->owner_filter
, f
, "repo.owner-filter=");
809 if (repo
->snapshots
!= ctx
.cfg
.snapshots
) {
810 char *tmp
= build_snapshot_setting(repo
->snapshots
);
811 fprintf(f
, "repo.snapshots=%s\n", tmp
? tmp
: "");
814 if (repo
->max_stats
!= ctx
.cfg
.max_stats
)
815 fprintf(f
, "repo.max-stats=%s\n",
816 cgit_find_stats_periodname(repo
->max_stats
));
818 fprintf(f
, "repo.logo=%s\n", repo
->logo
);
820 fprintf(f
, "repo.logo-link=%s\n", repo
->logo_link
);
821 fprintf(f
, "repo.enable-remote-branches=%d\n", repo
->enable_remote_branches
);
822 fprintf(f
, "repo.enable-subject-links=%d\n", repo
->enable_subject_links
);
823 if (repo
->branch_sort
== 1)
824 fprintf(f
, "repo.branch-sort=age\n");
825 if (repo
->commit_sort
) {
826 if (repo
->commit_sort
== 1)
827 fprintf(f
, "repo.commit-sort=date\n");
828 else if (repo
->commit_sort
== 2)
829 fprintf(f
, "repo.commit-sort=topo\n");
834 static void print_repolist(FILE *f
, struct cgit_repolist
*list
, int start
)
838 for (i
= start
; i
< list
->count
; i
++)
839 print_repo(f
, &list
->repos
[i
]);
842 /* Scan 'path' for git repositories, save the resulting repolist in 'cached_rc'
843 * and return 0 on success.
845 static int generate_cached_repolist(const char *path
, const char *cached_rc
)
847 struct strbuf locked_rc
= STRBUF_INIT
;
852 strbuf_addf(&locked_rc
, "%s.lock", cached_rc
);
853 f
= fopen(locked_rc
.buf
, "wx");
855 /* Inform about the error unless the lockfile already existed,
856 * since that only means we've got concurrent requests.
859 if (result
!= EEXIST
)
860 fprintf(stderr
, "[cgit] Error opening %s: %s (%d)\n",
861 locked_rc
.buf
, strerror(result
), result
);
864 idx
= cgit_repolist
.count
;
865 if (ctx
.cfg
.project_list
)
866 scan_projects(path
, ctx
.cfg
.project_list
, repo_config
);
868 scan_tree(path
, repo_config
);
869 print_repolist(f
, &cgit_repolist
, idx
);
870 if (rename(locked_rc
.buf
, cached_rc
))
871 fprintf(stderr
, "[cgit] Error renaming %s to %s: %s (%d)\n",
872 locked_rc
.buf
, cached_rc
, strerror(errno
), errno
);
875 strbuf_release(&locked_rc
);
879 static void process_cached_repolist(const char *path
)
882 struct strbuf cached_rc
= STRBUF_INIT
;
886 hash
= hash_str(path
);
887 if (ctx
.cfg
.project_list
)
888 hash
+= hash_str(ctx
.cfg
.project_list
);
889 strbuf_addf(&cached_rc
, "%s/rc-%8lx", ctx
.cfg
.cache_root
, hash
);
891 if (stat(cached_rc
.buf
, &st
)) {
892 /* Nothing is cached, we need to scan without forking. And
893 * if we fail to generate a cached repolist, we need to
894 * invoke scan_tree manually.
896 if (generate_cached_repolist(path
, cached_rc
.buf
)) {
897 if (ctx
.cfg
.project_list
)
898 scan_projects(path
, ctx
.cfg
.project_list
,
901 scan_tree(path
, repo_config
);
906 parse_configfile(cached_rc
.buf
, config_cb
);
908 /* If the cached configfile hasn't expired, lets exit now */
909 age
= time(NULL
) - st
.st_mtime
;
910 if (age
<= (ctx
.cfg
.cache_scanrc_ttl
* 60))
913 /* The cached repolist has been parsed, but it was old. So lets
914 * rescan the specified path and generate a new cached repolist
915 * in a child-process to avoid latency for the current request.
920 exit(generate_cached_repolist(path
, cached_rc
.buf
));
922 strbuf_release(&cached_rc
);
925 static void cgit_parse_args(int argc
, const char **argv
)
930 for (i
= 1; i
< argc
; i
++) {
931 if (!strcmp(argv
[i
], "--version")) {
932 printf("CGit %s | http://git.zx2c4.com/cgit/\n\nCompiled in features:\n", CGIT_VERSION
);
938 printf("Lua scripting\n");
939 #ifndef HAVE_LINUX_SENDFILE
944 printf("Linux sendfile() usage\n");
948 if (starts_with(argv
[i
], "--cache=")) {
949 ctx
.cfg
.cache_root
= xstrdup(argv
[i
] + 8);
950 } else if (!strcmp(argv
[i
], "--nocache")) {
952 } else if (!strcmp(argv
[i
], "--nohttp")) {
953 ctx
.env
.no_http
= "1";
954 } else if (starts_with(argv
[i
], "--query=")) {
955 ctx
.qry
.raw
= xstrdup(argv
[i
] + 8);
956 } else if (starts_with(argv
[i
], "--repo=")) {
957 ctx
.qry
.repo
= xstrdup(argv
[i
] + 7);
958 } else if (starts_with(argv
[i
], "--page=")) {
959 ctx
.qry
.page
= xstrdup(argv
[i
] + 7);
960 } else if (starts_with(argv
[i
], "--head=")) {
961 ctx
.qry
.head
= xstrdup(argv
[i
] + 7);
962 ctx
.qry
.has_symref
= 1;
963 } else if (starts_with(argv
[i
], "--sha1=")) {
964 ctx
.qry
.sha1
= xstrdup(argv
[i
] + 7);
965 ctx
.qry
.has_sha1
= 1;
966 } else if (starts_with(argv
[i
], "--ofs=")) {
967 ctx
.qry
.ofs
= atoi(argv
[i
] + 6);
968 } else if (starts_with(argv
[i
], "--scan-tree=") ||
969 starts_with(argv
[i
], "--scan-path=")) {
971 * HACK: The global snapshot bit mask defines the set
972 * of allowed snapshot formats, but the config file
973 * hasn't been parsed yet so the mask is currently 0.
974 * By setting all bits high before scanning we make
975 * sure that any in-repo cgitrc snapshot setting is
976 * respected by scan_tree().
978 * NOTE: We assume that there aren't more than 8
979 * different snapshot formats supported by cgit...
981 ctx
.cfg
.snapshots
= 0xFF;
983 scan_tree(argv
[i
] + 12, repo_config
);
987 qsort(cgit_repolist
.repos
, cgit_repolist
.count
,
988 sizeof(struct cgit_repo
), cmp_repos
);
989 print_repolist(stdout
, &cgit_repolist
, 0);
994 static int calc_ttl()
997 return ctx
.cfg
.cache_root_ttl
;
1000 return ctx
.cfg
.cache_repo_ttl
;
1002 if (!strcmp(ctx
.qry
.page
, "about"))
1003 return ctx
.cfg
.cache_about_ttl
;
1005 if (!strcmp(ctx
.qry
.page
, "snapshot"))
1006 return ctx
.cfg
.cache_snapshot_ttl
;
1008 if (ctx
.qry
.has_sha1
)
1009 return ctx
.cfg
.cache_static_ttl
;
1011 if (ctx
.qry
.has_symref
)
1012 return ctx
.cfg
.cache_dynamic_ttl
;
1014 return ctx
.cfg
.cache_repo_ttl
;
1017 int main(int argc
, const char **argv
)
1022 cgit_init_filters();
1023 atexit(cgit_cleanup_filters
);
1026 cgit_repolist
.length
= 0;
1027 cgit_repolist
.count
= 0;
1028 cgit_repolist
.repos
= NULL
;
1030 cgit_parse_args(argc
, argv
);
1031 parse_configfile(expand_macros(ctx
.env
.cgit_config
), config_cb
);
1033 http_parse_querystring(ctx
.qry
.raw
, querystring_cb
);
1035 /* If virtual-root isn't specified in cgitrc, lets pretend
1036 * that virtual-root equals SCRIPT_NAME, minus any possibly
1039 if (!ctx
.cfg
.virtual_root
&& ctx
.cfg
.script_name
)
1040 ctx
.cfg
.virtual_root
= ensure_end(ctx
.cfg
.script_name
, '/');
1042 /* If no url parameter is specified on the querystring, lets
1043 * use PATH_INFO as url. This allows cgit to work with virtual
1044 * urls without the need for rewriterules in the webserver (as
1045 * long as PATH_INFO is included in the cache lookup key).
1047 path
= ctx
.env
.path_info
;
1048 if (!ctx
.qry
.url
&& path
) {
1051 ctx
.qry
.url
= xstrdup(path
);
1053 char *newqry
= fmtalloc("%s?%s", path
, ctx
.qry
.raw
);
1055 ctx
.qry
.raw
= newqry
;
1057 ctx
.qry
.raw
= xstrdup(ctx
.qry
.url
);
1058 cgit_parse_url(ctx
.qry
.url
);
1061 /* Before we go any further, we set ctx.env.authenticated by checking to see
1062 * if the supplied cookie is valid. All cookies are valid if there is no
1063 * auth_filter. If there is an auth_filter, the filter decides. */
1064 authenticate_cookie();
1068 ctx
.page
.expires
+= 10 * 365 * 24 * 60 * 60; /* 10 years */
1070 ctx
.page
.expires
+= ttl
* 60;
1071 if (!ctx
.env
.authenticated
|| (ctx
.env
.request_method
&& !strcmp(ctx
.env
.request_method
, "HEAD")))
1072 ctx
.cfg
.nocache
= 1;
1073 if (ctx
.cfg
.nocache
)
1074 ctx
.cfg
.cache_size
= 0;
1075 err
= cache_process(ctx
.cfg
.cache_size
, ctx
.cfg
.cache_root
,
1076 ctx
.qry
.raw
, ttl
, process_request
);
1077 cgit_cleanup_filters();
1079 cgit_print_error("Error processing page: %s (%d)",
1080 strerror(err
), err
);