blob: becf776a3b6d8d45d66338b5a3eb1f9b0c3ab943 [file] [log] [blame]
Lars Hjemli0d169ad2006-12-09 15:18:17 +01001#ifndef CGIT_H
2#define CGIT_H
3
Lars Hjemli61c3ca92007-05-08 22:40:59 +02004
5#include <git-compat-util.h>
6#include <cache.h>
7#include <grep.h>
8#include <object.h>
9#include <tree.h>
10#include <commit.h>
11#include <tag.h>
12#include <diff.h>
13#include <diffcore.h>
14#include <refs.h>
15#include <revision.h>
16#include <log-tree.h>
17#include <archive.h>
Lars Hjemlic4d46c72009-02-13 20:43:30 +010018#include <string-list.h>
Lars Hjemlic495cf02009-01-31 10:40:40 +010019#include <xdiff-interface.h>
Lars Hjemli61c3ca92007-05-08 22:40:59 +020020#include <xdiff/xdiff.h>
Lars Hjemlia2ebbd62007-11-05 22:27:43 +010021#include <utf8.h>
Jeff Smith059b3932010-07-29 09:32:30 -050022#include <notes.h>
Johan Herland9a8d39c2010-11-15 18:39:50 +010023#include <graph.h>
Lars Hjemli61c3ca92007-05-08 22:40:59 +020024
Lars Hjemli25105d72006-12-10 22:31:36 +010025
Lars Hjemli43d40f22007-05-18 00:50:46 +020026/*
Lars Hjemli5db39172007-05-22 23:08:46 +020027 * Dateformats used on misc. pages
28 */
Stefan Naewe0f0ab142008-08-01 14:54:38 +020029#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S (%Z)"
Lars Hjemli5db39172007-05-22 23:08:46 +020030#define FMT_SHORTDATE "%Y-%m-%d"
Lars Hjemlib2a3d312008-05-21 08:17:54 +020031#define FMT_ATOMDATE "%Y-%m-%dT%H:%M:%SZ"
Lars Hjemli5db39172007-05-22 23:08:46 +020032
33
34/*
35 * Limits used for relative dates
36 */
37#define TM_MIN 60
38#define TM_HOUR (TM_MIN * 60)
39#define TM_DAY (TM_HOUR * 24)
40#define TM_WEEK (TM_DAY * 7)
41#define TM_YEAR (TM_DAY * 365)
42#define TM_MONTH (TM_YEAR / 12.0)
43
44
Jonathan Bastien-Filiatrault3845e172007-10-26 18:09:06 -040045/*
46 * Default encoding
47 */
48#define PAGE_ENCODING "UTF-8"
49
Lars Hjemli25105d72006-12-10 22:31:36 +010050typedef void (*configfn)(const char *name, const char *value);
Lars Hjemli1b49de32007-05-13 11:24:23 +020051typedef void (*filepair_fn)(struct diff_filepair *pair);
Lars Hjemlic4ef6672007-05-13 14:21:19 +020052typedef void (*linediff_fn)(char *line, int len);
Lars Hjemli25105d72006-12-10 22:31:36 +010053
Ferry Huberts9240a822011-03-23 11:57:41 +010054typedef enum {
55 ABOUT, COMMIT, SOURCE
56} filter_type;
57
Lars Hjemlie976df22009-08-09 13:22:00 +020058struct cgit_filter {
59 char *cmd;
60 char **argv;
61 int old_stdout;
62 int pipe_fh[2];
63 int pid;
64 int exitstatus;
65};
66
Lars Hjemlid1f3bbe2008-02-16 13:56:09 +010067struct cgit_repo {
Lars Hjemlice1c7332007-02-03 15:02:55 +010068 char *url;
69 char *name;
70 char *path;
71 char *desc;
72 char *owner;
Lars Hjemlib28b1052007-05-16 00:14:51 +020073 char *defbranch;
Lars Hjemlided93932007-05-11 12:12:48 +020074 char *module_link;
Lars Hjemlibbcdc292007-05-23 22:46:54 +020075 char *readme;
Lars Hjemlie7af0022009-08-23 22:58:39 +020076 char *section;
Lars Hjemliafcdd082007-12-03 01:49:38 +010077 char *clone_url;
Bernhard Reutner-Fischer808c6852010-12-23 12:47:54 +010078 char *logo;
79 char *logo_link;
Lars Hjemliac70cb42007-02-08 14:47:56 +010080 int snapshots;
Johan Herland9a8d39c2010-11-15 18:39:50 +010081 int enable_commit_graph;
Lars Hjemlie1893442007-05-18 13:55:52 +020082 int enable_log_filecount;
83 int enable_log_linecount;
Lars Hjemli41934a32009-11-07 19:10:58 +010084 int enable_remote_branches;
Lars Hjemli581a0c22010-02-27 13:12:55 +010085 int enable_subject_links;
Lars Hjemlifb2f3f62008-12-07 13:17:21 +010086 int max_stats;
Lars Hjemli88131702008-11-29 16:46:37 +010087 time_t mtime;
Lars Hjemli537c05f2009-08-09 13:27:21 +020088 struct cgit_filter *about_filter;
Lars Hjemlie976df22009-08-09 13:22:00 +020089 struct cgit_filter *commit_filter;
90 struct cgit_filter *source_filter;
Lars Hjemli6857bec2011-06-15 10:04:13 +020091 struct string_list submodules;
Lars Hjemlice1c7332007-02-03 15:02:55 +010092};
93
Lars Hjemli74061ed2009-08-24 00:04:58 +020094typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
95 const char *value);
96
Lars Hjemlid1f3bbe2008-02-16 13:56:09 +010097struct cgit_repolist {
Lars Hjemlice1c7332007-02-03 15:02:55 +010098 int length;
99 int count;
Lars Hjemlid1f3bbe2008-02-16 13:56:09 +0100100 struct cgit_repo *repos;
Lars Hjemlice1c7332007-02-03 15:02:55 +0100101};
102
Lars Hjemli2101e262006-12-15 18:17:36 +0100103struct commitinfo {
104 struct commit *commit;
105 char *author;
Lars Hjemli77078ba2006-12-16 14:25:41 +0100106 char *author_email;
107 unsigned long author_date;
Lars Hjemli2101e262006-12-15 18:17:36 +0100108 char *committer;
Lars Hjemli77078ba2006-12-16 14:25:41 +0100109 char *committer_email;
110 unsigned long committer_date;
Lars Hjemli2101e262006-12-15 18:17:36 +0100111 char *subject;
112 char *msg;
Jonathan Bastien-Filiatrault3845e172007-10-26 18:09:06 -0400113 char *msg_encoding;
Lars Hjemli2101e262006-12-15 18:17:36 +0100114};
115
Lars Hjemlia69061f2007-01-17 01:09:51 +0100116struct taginfo {
117 char *tagger;
118 char *tagger_email;
Lars Hjemlia8305a92008-09-14 09:45:37 +0200119 unsigned long tagger_date;
Lars Hjemlia69061f2007-01-17 01:09:51 +0100120 char *msg;
121};
122
Lars Hjemlie397ff72007-10-25 09:30:06 +0200123struct refinfo {
124 const char *refname;
125 struct object *object;
126 union {
127 struct taginfo *tag;
128 struct commitinfo *commit;
129 };
130};
131
132struct reflist {
133 struct refinfo **refs;
134 int alloc;
135 int count;
136};
137
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100138struct cgit_query {
139 int has_symref;
140 int has_sha1;
Tim Chenf2ced532012-01-03 16:02:14 +0000141 int has_ssdiff;
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100142 char *raw;
143 char *repo;
144 char *page;
145 char *search;
146 char *grep;
147 char *head;
148 char *sha1;
149 char *sha2;
150 char *path;
151 char *name;
Michael Krelin42effc92008-06-24 23:42:32 +0200152 char *mimetype;
Lars Hjemlie154edd2008-08-09 21:11:41 +0200153 char *url;
Lars Hjemlif86a23f2008-12-06 17:38:19 +0100154 char *period;
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100155 int ofs;
Lars Hjemli5632ba32008-10-11 19:05:50 +0200156 int nohead;
Benjamin Closed71c0c72008-11-25 06:25:35 -0800157 char *sort;
Lars Hjemli0274b572008-11-29 18:39:41 +0100158 int showmsg;
Ragnar Ouchterlonyc358aa32009-09-14 20:19:02 +0200159 int ssdiff;
Aaron Griffin65ced7c2010-02-03 18:31:17 -0600160 int show_all;
Johan Herland6180e612010-06-10 20:15:27 +0200161 int context;
Johan Herland2cc8b992010-06-24 17:52:57 +0200162 int ignorews;
Johan Herland0ff143d2010-06-10 01:09:26 +0200163 char *vpath;
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100164};
165
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100166struct cgit_config {
167 char *agefile;
168 char *cache_root;
169 char *clone_prefix;
Lars Hjemlia1429db2011-06-06 20:49:13 +0000170 char *clone_url;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100171 char *css;
Lars Hjemli502865a2008-07-19 20:40:30 +0200172 char *favicon;
Lars Hjemlide5e9282008-06-26 13:53:30 +0200173 char *footer;
Mark Lodatob5a3a202009-03-15 00:11:54 -0400174 char *head_include;
Lars Hjemlib1159552009-01-29 21:27:39 +0100175 char *header;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100176 char *index_header;
177 char *index_info;
178 char *logo;
179 char *logo_link;
Ferry Hubertsd01c6002011-07-19 10:51:58 +0200180 char *mimetype_file;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100181 char *module_link;
Jason A. Donenfeld35165022010-07-29 17:52:29 +0200182 char *project_list;
Lars Hjemli515edb02010-08-21 15:08:01 +0200183 char *readme;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100184 char *robots;
185 char *root_title;
Lars Hjemli4c991602008-04-29 00:55:34 +0200186 char *root_desc;
Lars Hjemlic6431a72008-04-29 01:06:30 +0200187 char *root_readme;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100188 char *script_name;
Lars Hjemlie7af0022009-08-23 22:58:39 +0200189 char *section;
Jason A. Donenfeldfdfb6a62012-10-16 23:32:40 +0200190 char *repository_sort;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100191 char *virtual_root;
Felix Hanleye0c6f232010-11-08 19:41:13 +0100192 char *strict_export;
Lars Hjemli939d32f2008-04-28 11:32:42 +0200193 int cache_size;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100194 int cache_dynamic_ttl;
195 int cache_max_create_time;
196 int cache_repo_ttl;
197 int cache_root_ttl;
Lars Hjemlid7468272009-08-20 17:41:54 +0200198 int cache_scanrc_ttl;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100199 int cache_static_ttl;
Jason A. Donenfeld184c5652012-07-12 19:13:39 +0200200 int case_sensitive_sort;
Lars Hjemli7a8b3b42009-07-25 12:25:06 +0200201 int embedded;
Lars Hjemli2273c2c2009-08-24 08:53:21 +0200202 int enable_filter_overrides;
Dan McGee42231322011-01-12 12:06:07 -0600203 int enable_http_clone;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100204 int enable_index_links;
Johan Herland9a8d39c2010-11-15 18:39:50 +0100205 int enable_commit_graph;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100206 int enable_log_filecount;
207 int enable_log_linecount;
Lars Hjemli41934a32009-11-07 19:10:58 +0100208 int enable_remote_branches;
Lars Hjemli581a0c22010-02-27 13:12:55 +0100209 int enable_subject_links;
Lars Hjemlib0f946b2009-08-21 14:26:52 +0200210 int enable_tree_linenumbers;
Jason A. Donenfeld521e10c2012-10-09 06:56:14 -0400211 int enable_git_config;
Stefan Naewe0f0ab142008-08-01 14:54:38 +0200212 int local_time;
Aaron Griffin80476b02010-02-04 18:08:16 -0600213 int max_atom_items;
Lars Hjemlic6078b82008-05-03 10:54:39 +0200214 int max_repo_count;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100215 int max_commit_count;
216 int max_lock_attempts;
217 int max_msg_len;
218 int max_repodesc_len;
Georg Lukasef07ccc2009-11-28 03:44:33 +0100219 int max_blob_size;
Lars Hjemlifb2f3f62008-12-07 13:17:21 +0100220 int max_stats;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100221 int nocache;
Martin Szulecki2f56e392009-08-07 14:05:17 +0200222 int noplainemail;
Lars Hjemli7a8b3b42009-07-25 12:25:06 +0200223 int noheader;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100224 int renamelimit;
Jason A. Donenfeld2e4a9412010-07-29 19:47:50 +0200225 int remove_suffix;
Johan Herlanddf522792010-11-15 20:41:00 +0100226 int scan_hidden_path;
Lars Hjemli797110e2010-08-21 15:44:09 +0200227 int section_from_path;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100228 int snapshots;
Tobias Bieniek7a4e7c82012-10-09 20:53:29 +0200229 int section_sort;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100230 int summary_branches;
231 int summary_log;
232 int summary_tags;
Ragnar Ouchterlonyc358aa32009-09-14 20:19:02 +0200233 int ssdiff;
Lars Hjemlic4d46c72009-02-13 20:43:30 +0100234 struct string_list mimetypes;
Lars Hjemli537c05f2009-08-09 13:27:21 +0200235 struct cgit_filter *about_filter;
Lars Hjemlif35db1c2009-07-31 17:42:57 +0200236 struct cgit_filter *commit_filter;
Lars Hjemli46b7abe2009-07-31 16:55:27 +0200237 struct cgit_filter *source_filter;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100238};
239
Lars Hjemlif3c1a182008-03-24 00:51:19 +0100240struct cgit_page {
241 time_t modified;
242 time_t expires;
Lars Hjemlie5da4bc2008-08-06 10:53:50 +0200243 size_t size;
Lars Hjemlif3c1a182008-03-24 00:51:19 +0100244 char *mimetype;
245 char *charset;
246 char *filename;
Lars Hjemli488a2142009-02-19 22:38:36 +0100247 char *etag;
Lars Hjemlif3c1a182008-03-24 00:51:19 +0100248 char *title;
Lars Hjemlie429fb02009-06-07 20:43:08 +0200249 int status;
250 char *statusmsg;
Lars Hjemlif3c1a182008-03-24 00:51:19 +0100251};
252
Lars Hjemli60a26272009-08-10 08:21:09 +0200253struct cgit_environment {
254 char *cgit_config;
255 char *http_host;
256 char *https;
Lars Hjemli8b2252b2009-08-10 09:20:17 +0200257 char *no_http;
Lars Hjemli60a26272009-08-10 08:21:09 +0200258 char *path_info;
259 char *query_string;
260 char *request_method;
261 char *script_name;
262 char *server_name;
263 char *server_port;
264};
265
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100266struct cgit_context {
Lars Hjemli60a26272009-08-10 08:21:09 +0200267 struct cgit_environment env;
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100268 struct cgit_query qry;
Lars Hjemlib228d4f2008-02-16 13:07:13 +0100269 struct cgit_config cfg;
Lars Hjemlid1f3bbe2008-02-16 13:56:09 +0100270 struct cgit_repo *repo;
Lars Hjemlif3c1a182008-03-24 00:51:19 +0100271 struct cgit_page page;
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100272};
273
Lars Hjemlif34478c2008-03-24 16:00:27 +0100274struct cgit_snapshot_format {
275 const char *suffix;
276 const char *mimetype;
277 write_archive_fn_t write_func;
278 int bit;
279};
280
Lars Hjemlif6925032007-06-18 09:42:10 +0200281extern const char *cgit_version;
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100282
Lars Hjemlid1f3bbe2008-02-16 13:56:09 +0100283extern struct cgit_repolist cgit_repolist;
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100284extern struct cgit_context ctx;
Lars Hjemlif34478c2008-03-24 16:00:27 +0100285extern const struct cgit_snapshot_format cgit_snapshot_formats[];
Lars Hjemlice1c7332007-02-03 15:02:55 +0100286
Jason A. Donenfeld521e10c2012-10-09 06:56:14 -0400287extern char *cgit_default_repo_desc;
Lars Hjemli163037e2008-03-24 17:26:08 +0100288extern struct cgit_repo *cgit_add_repo(const char *url);
Lars Hjemlid1f3bbe2008-02-16 13:56:09 +0100289extern struct cgit_repo *cgit_get_repoinfo(const char *url);
Lars Hjemli44923f82006-12-11 17:25:41 +0100290extern void cgit_repo_config_cb(const char *name, const char *value);
Lars Hjemli44923f82006-12-11 17:25:41 +0100291
Lars Hjemliab2ab952007-02-08 13:53:13 +0100292extern int chk_zero(int result, char *msg);
293extern int chk_positive(int result, char *msg);
Michael Krelin127f43d2007-07-20 20:56:43 +0200294extern int chk_non_negative(int result, char *msg);
Lars Hjemliab2ab952007-02-08 13:53:13 +0100295
Lars Hjemli382805e2007-06-26 18:04:31 +0200296extern char *trim_end(const char *str, char c);
Lars Hjemli0c8e1842007-10-30 10:47:38 +0100297extern char *strlpart(char *txt, int maxlen);
298extern char *strrpart(char *txt, int maxlen);
Lars Hjemli52e605c2007-01-04 16:53:03 +0100299
Lars Hjemlie397ff72007-10-25 09:30:06 +0200300extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
301extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
302 int flags, void *cb_data);
303
Lars Hjemliaaa24bd2006-12-16 14:58:20 +0100304extern void *cgit_free_commitinfo(struct commitinfo *info);
Lars Hjemlic4ef6672007-05-13 14:21:19 +0200305
306extern int cgit_diff_files(const unsigned char *old_sha1,
307 const unsigned char *new_sha1,
Lars Hjemlic495cf02009-01-31 10:40:40 +0100308 unsigned long *old_size, unsigned long *new_size,
Johan Herland2cc8b992010-06-24 17:52:57 +0200309 int *binary, int context, int ignorews,
310 linediff_fn fn);
Lars Hjemlic4ef6672007-05-13 14:21:19 +0200311
Lars Hjemli1b49de32007-05-13 11:24:23 +0200312extern void cgit_diff_tree(const unsigned char *old_sha1,
313 const unsigned char *new_sha1,
Johan Herland2cc8b992010-06-24 17:52:57 +0200314 filepair_fn fn, const char *prefix, int ignorews);
Lars Hjemlic4ef6672007-05-13 14:21:19 +0200315
Johan Herland1415f3f2010-09-30 20:15:14 +0200316extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,
317 const char *prefix);
Lars Hjemliaaa24bd2006-12-16 14:58:20 +0100318
Mark Lodatoa4c58d92010-09-04 11:09:57 -0400319__attribute__((format (printf,1,2)))
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100320extern char *fmt(const char *format,...);
321
Lars Hjemli2101e262006-12-15 18:17:36 +0100322extern struct commitinfo *cgit_parse_commit(struct commit *commit);
Lars Hjemlia69061f2007-01-17 01:09:51 +0100323extern struct taginfo *cgit_parse_tag(struct tag *tag);
Lars Hjemli30ccdca2007-05-18 03:00:54 +0200324extern void cgit_parse_url(const char *url);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100325
Michael Krelin1cb8bed2007-07-21 15:24:07 +0200326extern const char *cgit_repobasename(const char *reponame);
327
Michael Krelindc3c9b52007-07-21 18:00:53 +0200328extern int cgit_parse_snapshots_mask(const char *str);
Lars Hjemli74620f12006-12-11 16:48:03 +0100329
Lars Hjemli3ec6b302011-06-06 19:29:58 +0000330extern int cgit_open_filter(struct cgit_filter *filter);
Lars Hjemlid6f60722009-07-31 17:38:38 +0200331extern int cgit_close_filter(struct cgit_filter *filter);
332
Lars Hjemli3ec6b302011-06-06 19:29:58 +0000333extern void cgit_prepare_repo_env(struct cgit_repo * repo);
334
Lars Hjemlie16f1782009-08-18 17:17:41 +0200335extern int readfile(const char *path, char **buf, size_t *size);
Lars Hjemli28d781f2008-04-13 12:42:27 +0200336
Lars Hjemliba56a372010-03-22 00:09:43 +0100337extern char *expand_macros(const char *txt);
338
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100339#endif /* CGIT_H */