]> git.cameronkatri.com Git - cgit.git/blob - cgit.c
Add support for including a footer on all pages
[cgit.git] / cgit.c
1 /* cgit.c: cgi for the git scm
2 *
3 * Copyright (C) 2006 Lars Hjemli
4 *
5 * Licensed under GNU General Public License v2
6 * (see COPYING for full license text)
7 */
8
9 #include "cgit.h"
10 #include "cache.h"
11 #include "cmd.h"
12 #include "configfile.h"
13 #include "html.h"
14 #include "ui-shared.h"
15
16 const char *cgit_version = CGIT_VERSION;
17
18 void config_cb(const char *name, const char *value)
19 {
20 if (!strcmp(name, "root-title"))
21 ctx.cfg.root_title = xstrdup(value);
22 else if (!strcmp(name, "root-desc"))
23 ctx.cfg.root_desc = xstrdup(value);
24 else if (!strcmp(name, "root-readme"))
25 ctx.cfg.root_readme = xstrdup(value);
26 else if (!strcmp(name, "css"))
27 ctx.cfg.css = xstrdup(value);
28 else if (!strcmp(name, "footer"))
29 ctx.cfg.footer = xstrdup(value);
30 else if (!strcmp(name, "logo"))
31 ctx.cfg.logo = xstrdup(value);
32 else if (!strcmp(name, "index-header"))
33 ctx.cfg.index_header = xstrdup(value);
34 else if (!strcmp(name, "index-info"))
35 ctx.cfg.index_info = xstrdup(value);
36 else if (!strcmp(name, "logo-link"))
37 ctx.cfg.logo_link = xstrdup(value);
38 else if (!strcmp(name, "module-link"))
39 ctx.cfg.module_link = xstrdup(value);
40 else if (!strcmp(name, "virtual-root")) {
41 ctx.cfg.virtual_root = trim_end(value, '/');
42 if (!ctx.cfg.virtual_root && (!strcmp(value, "/")))
43 ctx.cfg.virtual_root = "";
44 } else if (!strcmp(name, "nocache"))
45 ctx.cfg.nocache = atoi(value);
46 else if (!strcmp(name, "snapshots"))
47 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
48 else if (!strcmp(name, "enable-index-links"))
49 ctx.cfg.enable_index_links = atoi(value);
50 else if (!strcmp(name, "enable-log-filecount"))
51 ctx.cfg.enable_log_filecount = atoi(value);
52 else if (!strcmp(name, "enable-log-linecount"))
53 ctx.cfg.enable_log_linecount = atoi(value);
54 else if (!strcmp(name, "cache-size"))
55 ctx.cfg.cache_size = atoi(value);
56 else if (!strcmp(name, "cache-root"))
57 ctx.cfg.cache_root = xstrdup(value);
58 else if (!strcmp(name, "cache-root-ttl"))
59 ctx.cfg.cache_root_ttl = atoi(value);
60 else if (!strcmp(name, "cache-repo-ttl"))
61 ctx.cfg.cache_repo_ttl = atoi(value);
62 else if (!strcmp(name, "cache-static-ttl"))
63 ctx.cfg.cache_static_ttl = atoi(value);
64 else if (!strcmp(name, "cache-dynamic-ttl"))
65 ctx.cfg.cache_dynamic_ttl = atoi(value);
66 else if (!strcmp(name, "max-message-length"))
67 ctx.cfg.max_msg_len = atoi(value);
68 else if (!strcmp(name, "max-repodesc-length"))
69 ctx.cfg.max_repodesc_len = atoi(value);
70 else if (!strcmp(name, "max-repo-count"))
71 ctx.cfg.max_repo_count = atoi(value);
72 else if (!strcmp(name, "max-commit-count"))
73 ctx.cfg.max_commit_count = atoi(value);
74 else if (!strcmp(name, "summary-log"))
75 ctx.cfg.summary_log = atoi(value);
76 else if (!strcmp(name, "summary-branches"))
77 ctx.cfg.summary_branches = atoi(value);
78 else if (!strcmp(name, "summary-tags"))
79 ctx.cfg.summary_tags = atoi(value);
80 else if (!strcmp(name, "agefile"))
81 ctx.cfg.agefile = xstrdup(value);
82 else if (!strcmp(name, "renamelimit"))
83 ctx.cfg.renamelimit = atoi(value);
84 else if (!strcmp(name, "robots"))
85 ctx.cfg.robots = xstrdup(value);
86 else if (!strcmp(name, "clone-prefix"))
87 ctx.cfg.clone_prefix = xstrdup(value);
88 else if (!strcmp(name, "repo.group"))
89 ctx.cfg.repo_group = xstrdup(value);
90 else if (!strcmp(name, "repo.url"))
91 ctx.repo = cgit_add_repo(value);
92 else if (!strcmp(name, "repo.name"))
93 ctx.repo->name = xstrdup(value);
94 else if (ctx.repo && !strcmp(name, "repo.path"))
95 ctx.repo->path = trim_end(value, '/');
96 else if (ctx.repo && !strcmp(name, "repo.clone-url"))
97 ctx.repo->clone_url = xstrdup(value);
98 else if (ctx.repo && !strcmp(name, "repo.desc"))
99 ctx.repo->desc = xstrdup(value);
100 else if (ctx.repo && !strcmp(name, "repo.owner"))
101 ctx.repo->owner = xstrdup(value);
102 else if (ctx.repo && !strcmp(name, "repo.defbranch"))
103 ctx.repo->defbranch = xstrdup(value);
104 else if (ctx.repo && !strcmp(name, "repo.snapshots"))
105 ctx.repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); /* XXX: &? */
106 else if (ctx.repo && !strcmp(name, "repo.enable-log-filecount"))
107 ctx.repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
108 else if (ctx.repo && !strcmp(name, "repo.enable-log-linecount"))
109 ctx.repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
110 else if (ctx.repo && !strcmp(name, "repo.module-link"))
111 ctx.repo->module_link= xstrdup(value);
112 else if (ctx.repo && !strcmp(name, "repo.readme") && value != NULL) {
113 if (*value == '/')
114 ctx.repo->readme = xstrdup(value);
115 else
116 ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value));
117 } else if (!strcmp(name, "include"))
118 parse_configfile(value, config_cb);
119 }
120
121 static void querystring_cb(const char *name, const char *value)
122 {
123 if (!strcmp(name,"r")) {
124 ctx.qry.repo = xstrdup(value);
125 ctx.repo = cgit_get_repoinfo(value);
126 } else if (!strcmp(name, "p")) {
127 ctx.qry.page = xstrdup(value);
128 } else if (!strcmp(name, "url")) {
129 cgit_parse_url(value);
130 } else if (!strcmp(name, "qt")) {
131 ctx.qry.grep = xstrdup(value);
132 } else if (!strcmp(name, "q")) {
133 ctx.qry.search = xstrdup(value);
134 } else if (!strcmp(name, "h")) {
135 ctx.qry.head = xstrdup(value);
136 ctx.qry.has_symref = 1;
137 } else if (!strcmp(name, "id")) {
138 ctx.qry.sha1 = xstrdup(value);
139 ctx.qry.has_sha1 = 1;
140 } else if (!strcmp(name, "id2")) {
141 ctx.qry.sha2 = xstrdup(value);
142 ctx.qry.has_sha1 = 1;
143 } else if (!strcmp(name, "ofs")) {
144 ctx.qry.ofs = atoi(value);
145 } else if (!strcmp(name, "path")) {
146 ctx.qry.path = trim_end(value, '/');
147 } else if (!strcmp(name, "name")) {
148 ctx.qry.name = xstrdup(value);
149 } else if (!strcmp(name, "mimetype")) {
150 ctx.qry.mimetype = xstrdup(value);
151 }
152 }
153
154 static void prepare_context(struct cgit_context *ctx)
155 {
156 memset(ctx, 0, sizeof(ctx));
157 ctx->cfg.agefile = "info/web/last-modified";
158 ctx->cfg.nocache = 0;
159 ctx->cfg.cache_size = 0;
160 ctx->cfg.cache_dynamic_ttl = 5;
161 ctx->cfg.cache_max_create_time = 5;
162 ctx->cfg.cache_repo_ttl = 5;
163 ctx->cfg.cache_root = CGIT_CACHE_ROOT;
164 ctx->cfg.cache_root_ttl = 5;
165 ctx->cfg.cache_static_ttl = -1;
166 ctx->cfg.css = "/cgit.css";
167 ctx->cfg.logo = "/git-logo.png";
168 ctx->cfg.max_repo_count = 50;
169 ctx->cfg.max_commit_count = 50;
170 ctx->cfg.max_lock_attempts = 5;
171 ctx->cfg.max_msg_len = 60;
172 ctx->cfg.max_repodesc_len = 60;
173 ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
174 ctx->cfg.renamelimit = -1;
175 ctx->cfg.robots = "index, nofollow";
176 ctx->cfg.root_title = "Git repository browser";
177 ctx->cfg.root_desc = "a fast webinterface for the git dscm";
178 ctx->cfg.script_name = CGIT_SCRIPT_NAME;
179 ctx->page.mimetype = "text/html";
180 ctx->page.charset = PAGE_ENCODING;
181 ctx->page.filename = NULL;
182 ctx->page.modified = time(NULL);
183 ctx->page.expires = ctx->page.modified;
184 }
185
186 struct refmatch {
187 char *req_ref;
188 char *first_ref;
189 int match;
190 };
191
192 int find_current_ref(const char *refname, const unsigned char *sha1,
193 int flags, void *cb_data)
194 {
195 struct refmatch *info;
196
197 info = (struct refmatch *)cb_data;
198 if (!strcmp(refname, info->req_ref))
199 info->match = 1;
200 if (!info->first_ref)
201 info->first_ref = xstrdup(refname);
202 return info->match;
203 }
204
205 char *find_default_branch(struct cgit_repo *repo)
206 {
207 struct refmatch info;
208
209 info.req_ref = repo->defbranch;
210 info.first_ref = NULL;
211 info.match = 0;
212 for_each_branch_ref(find_current_ref, &info);
213 if (info.match)
214 return info.req_ref;
215 else
216 return info.first_ref;
217 }
218
219 static int prepare_repo_cmd(struct cgit_context *ctx)
220 {
221 char *tmp;
222 unsigned char sha1[20];
223 int nongit = 0;
224
225 setenv("GIT_DIR", ctx->repo->path, 1);
226 setup_git_directory_gently(&nongit);
227 if (nongit) {
228 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
229 "config error");
230 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
231 ctx->repo = NULL;
232 cgit_print_http_headers(ctx);
233 cgit_print_docstart(ctx);
234 cgit_print_pageheader(ctx);
235 cgit_print_error(tmp);
236 cgit_print_docend();
237 return 1;
238 }
239 ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
240
241 if (!ctx->qry.head) {
242 ctx->qry.head = xstrdup(find_default_branch(ctx->repo));
243 ctx->repo->defbranch = ctx->qry.head;
244 }
245
246 if (!ctx->qry.head) {
247 cgit_print_http_headers(ctx);
248 cgit_print_docstart(ctx);
249 cgit_print_pageheader(ctx);
250 cgit_print_error("Repository seems to be empty");
251 cgit_print_docend();
252 return 1;
253 }
254
255 if (get_sha1(ctx->qry.head, sha1)) {
256 tmp = xstrdup(ctx->qry.head);
257 ctx->qry.head = ctx->repo->defbranch;
258 cgit_print_http_headers(ctx);
259 cgit_print_docstart(ctx);
260 cgit_print_pageheader(ctx);
261 cgit_print_error(fmt("Invalid branch: %s", tmp));
262 cgit_print_docend();
263 return 1;
264 }
265 return 0;
266 }
267
268 static void process_request(void *cbdata)
269 {
270 struct cgit_context *ctx = cbdata;
271 struct cgit_cmd *cmd;
272
273 cmd = cgit_get_cmd(ctx);
274 if (!cmd) {
275 ctx->page.title = "cgit error";
276 ctx->repo = NULL;
277 cgit_print_http_headers(ctx);
278 cgit_print_docstart(ctx);
279 cgit_print_pageheader(ctx);
280 cgit_print_error("Invalid request");
281 cgit_print_docend();
282 return;
283 }
284
285 if (cmd->want_repo && !ctx->repo) {
286 cgit_print_http_headers(ctx);
287 cgit_print_docstart(ctx);
288 cgit_print_pageheader(ctx);
289 cgit_print_error(fmt("No repository selected"));
290 cgit_print_docend();
291 return;
292 }
293
294 if (ctx->repo && prepare_repo_cmd(ctx))
295 return;
296
297 if (cmd->want_layout) {
298 cgit_print_http_headers(ctx);
299 cgit_print_docstart(ctx);
300 cgit_print_pageheader(ctx);
301 }
302
303 cmd->fn(ctx);
304
305 if (cmd->want_layout)
306 cgit_print_docend();
307 }
308
309 static void cgit_parse_args(int argc, const char **argv)
310 {
311 int i;
312
313 for (i = 1; i < argc; i++) {
314 if (!strncmp(argv[i], "--cache=", 8)) {
315 ctx.cfg.cache_root = xstrdup(argv[i]+8);
316 }
317 if (!strcmp(argv[i], "--nocache")) {
318 ctx.cfg.nocache = 1;
319 }
320 if (!strncmp(argv[i], "--query=", 8)) {
321 ctx.qry.raw = xstrdup(argv[i]+8);
322 }
323 if (!strncmp(argv[i], "--repo=", 7)) {
324 ctx.qry.repo = xstrdup(argv[i]+7);
325 }
326 if (!strncmp(argv[i], "--page=", 7)) {
327 ctx.qry.page = xstrdup(argv[i]+7);
328 }
329 if (!strncmp(argv[i], "--head=", 7)) {
330 ctx.qry.head = xstrdup(argv[i]+7);
331 ctx.qry.has_symref = 1;
332 }
333 if (!strncmp(argv[i], "--sha1=", 7)) {
334 ctx.qry.sha1 = xstrdup(argv[i]+7);
335 ctx.qry.has_sha1 = 1;
336 }
337 if (!strncmp(argv[i], "--ofs=", 6)) {
338 ctx.qry.ofs = atoi(argv[i]+6);
339 }
340 }
341 }
342
343 static int calc_ttl()
344 {
345 if (!ctx.repo)
346 return ctx.cfg.cache_root_ttl;
347
348 if (!ctx.qry.page)
349 return ctx.cfg.cache_repo_ttl;
350
351 if (ctx.qry.has_symref)
352 return ctx.cfg.cache_dynamic_ttl;
353
354 if (ctx.qry.has_sha1)
355 return ctx.cfg.cache_static_ttl;
356
357 return ctx.cfg.cache_repo_ttl;
358 }
359
360 int main(int argc, const char **argv)
361 {
362 const char *cgit_config_env = getenv("CGIT_CONFIG");
363 int err, ttl;
364
365 prepare_context(&ctx);
366 cgit_repolist.length = 0;
367 cgit_repolist.count = 0;
368 cgit_repolist.repos = NULL;
369
370 parse_configfile(cgit_config_env ? cgit_config_env : CGIT_CONFIG,
371 config_cb);
372 ctx.repo = NULL;
373 if (getenv("SCRIPT_NAME"))
374 ctx.cfg.script_name = xstrdup(getenv("SCRIPT_NAME"));
375 if (getenv("QUERY_STRING"))
376 ctx.qry.raw = xstrdup(getenv("QUERY_STRING"));
377 cgit_parse_args(argc, argv);
378 http_parse_querystring(ctx.qry.raw, querystring_cb);
379
380 ttl = calc_ttl();
381 ctx.page.expires += ttl*60;
382 if (ctx.cfg.nocache)
383 ctx.cfg.cache_size = 0;
384 err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
385 ctx.qry.raw, ttl, process_request, &ctx);
386 if (err)
387 cgit_print_error(fmt("Error processing page: %s (%d)",
388 strerror(err), err));
389 return err;
390 }