cgit.h (view raw)
1#ifndef CGIT_H
2#define CGIT_H
3
4
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 <argv-array.h>
15#include <refs.h>
16#include <revision.h>
17#include <log-tree.h>
18#include <archive.h>
19#include <string-list.h>
20#include <xdiff-interface.h>
21#include <xdiff/xdiff.h>
22#include <utf8.h>
23#include <notes.h>
24#include <graph.h>
25
26
27/*
28 * Dateformats used on misc. pages
29 */
30#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S (%Z)"
31#define FMT_SHORTDATE "%Y-%m-%d"
32#define FMT_ATOMDATE "%Y-%m-%dT%H:%M:%SZ"
33
34
35/*
36 * Limits used for relative dates
37 */
38#define TM_MIN 60
39#define TM_HOUR (TM_MIN * 60)
40#define TM_DAY (TM_HOUR * 24)
41#define TM_WEEK (TM_DAY * 7)
42#define TM_YEAR (TM_DAY * 365)
43#define TM_MONTH (TM_YEAR / 12.0)
44
45
46/*
47 * Default encoding
48 */
49#define PAGE_ENCODING "UTF-8"
50
51typedef void (*configfn)(const char *name, const char *value);
52typedef void (*filepair_fn)(struct diff_filepair *pair);
53typedef void (*linediff_fn)(char *line, int len);
54
55typedef enum {
56 DIFF_UNIFIED, DIFF_SSDIFF, DIFF_STATONLY
57} diff_type;
58
59typedef enum {
60 ABOUT, COMMIT, SOURCE, EMAIL, AUTH, OWNER
61} filter_type;
62
63struct cgit_filter {
64 int (*open)(struct cgit_filter *, va_list ap);
65 int (*close)(struct cgit_filter *);
66 void (*fprintf)(struct cgit_filter *, FILE *, const char *prefix);
67 void (*cleanup)(struct cgit_filter *);
68 int argument_count;
69};
70
71struct cgit_exec_filter {
72 struct cgit_filter base;
73 char *cmd;
74 char **argv;
75 int old_stdout;
76 int pipe_fh[2];
77 int pid;
78};
79
80struct cgit_repo {
81 char *url;
82 char *name;
83 char *path;
84 char *desc;
85 char *owner;
86 char *defbranch;
87 char *module_link;
88 struct string_list readme;
89 char *section;
90 char *clone_url;
91 char *logo;
92 char *logo_link;
93 int snapshots;
94 int enable_commit_graph;
95 int enable_log_filecount;
96 int enable_log_linecount;
97 int enable_remote_branches;
98 int enable_subject_links;
99 int max_stats;
100 int branch_sort;
101 int commit_sort;
102 time_t mtime;
103 struct cgit_filter *about_filter;
104 struct cgit_filter *commit_filter;
105 struct cgit_filter *source_filter;
106 struct cgit_filter *email_filter;
107 struct cgit_filter *owner_filter;
108 struct string_list submodules;
109};
110
111typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
112 const char *value);
113
114struct cgit_repolist {
115 int length;
116 int count;
117 struct cgit_repo *repos;
118};
119
120struct commitinfo {
121 struct commit *commit;
122 char *author;
123 char *author_email;
124 unsigned long author_date;
125 char *committer;
126 char *committer_email;
127 unsigned long committer_date;
128 char *subject;
129 char *msg;
130 char *msg_encoding;
131};
132
133struct taginfo {
134 char *tagger;
135 char *tagger_email;
136 unsigned long tagger_date;
137 char *msg;
138};
139
140struct refinfo {
141 const char *refname;
142 struct object *object;
143 union {
144 struct taginfo *tag;
145 struct commitinfo *commit;
146 };
147};
148
149struct reflist {
150 struct refinfo **refs;
151 int alloc;
152 int count;
153};
154
155struct cgit_query {
156 int has_symref;
157 int has_sha1;
158 int has_difftype;
159 char *raw;
160 char *repo;
161 char *page;
162 char *search;
163 char *grep;
164 char *head;
165 char *sha1;
166 char *sha2;
167 char *path;
168 char *name;
169 char *mimetype;
170 char *url;
171 char *period;
172 int ofs;
173 int nohead;
174 char *sort;
175 int showmsg;
176 diff_type difftype;
177 int show_all;
178 int context;
179 int ignorews;
180 char *vpath;
181};
182
183struct cgit_config {
184 char *agefile;
185 char *cache_root;
186 char *clone_prefix;
187 char *clone_url;
188 char *css;
189 char *favicon;
190 char *footer;
191 char *head_include;
192 char *header;
193 char *index_header;
194 char *index_info;
195 char *logo;
196 char *logo_link;
197 char *mimetype_file;
198 char *module_link;
199 char *project_list;
200 struct string_list readme;
201 char *robots;
202 char *root_title;
203 char *root_desc;
204 char *root_readme;
205 char *script_name;
206 char *section;
207 char *repository_sort;
208 char *virtual_root; /* Always ends with '/'. */
209 char *strict_export;
210 int cache_size;
211 int cache_dynamic_ttl;
212 int cache_max_create_time;
213 int cache_repo_ttl;
214 int cache_root_ttl;
215 int cache_scanrc_ttl;
216 int cache_static_ttl;
217 int cache_about_ttl;
218 int cache_snapshot_ttl;
219 int case_sensitive_sort;
220 int embedded;
221 int enable_filter_overrides;
222 int enable_http_clone;
223 int enable_index_links;
224 int enable_index_owner;
225 int enable_commit_graph;
226 int enable_log_filecount;
227 int enable_log_linecount;
228 int enable_remote_branches;
229 int enable_subject_links;
230 int enable_tree_linenumbers;
231 int enable_git_config;
232 int local_time;
233 int max_atom_items;
234 int max_repo_count;
235 int max_commit_count;
236 int max_lock_attempts;
237 int max_msg_len;
238 int max_repodesc_len;
239 int max_blob_size;
240 int max_stats;
241 int nocache;
242 int noplainemail;
243 int noheader;
244 int renamelimit;
245 int remove_suffix;
246 int scan_hidden_path;
247 int section_from_path;
248 int snapshots;
249 int section_sort;
250 int summary_branches;
251 int summary_log;
252 int summary_tags;
253 diff_type difftype;
254 int branch_sort;
255 int commit_sort;
256 struct string_list mimetypes;
257 struct cgit_filter *about_filter;
258 struct cgit_filter *commit_filter;
259 struct cgit_filter *source_filter;
260 struct cgit_filter *email_filter;
261 struct cgit_filter *owner_filter;
262 struct cgit_filter *auth_filter;
263};
264
265struct cgit_page {
266 time_t modified;
267 time_t expires;
268 size_t size;
269 const char *mimetype;
270 const char *charset;
271 const char *filename;
272 const char *etag;
273 const char *title;
274 int status;
275 const char *statusmsg;
276};
277
278struct cgit_environment {
279 const char *cgit_config;
280 const char *http_host;
281 const char *https;
282 const char *no_http;
283 const char *path_info;
284 const char *query_string;
285 const char *request_method;
286 const char *script_name;
287 const char *server_name;
288 const char *server_port;
289 const char *http_cookie;
290 const char *http_referer;
291 unsigned int content_length;
292 int authenticated;
293};
294
295struct cgit_context {
296 struct cgit_environment env;
297 struct cgit_query qry;
298 struct cgit_config cfg;
299 struct cgit_repo *repo;
300 struct cgit_page page;
301};
302
303typedef int (*write_archive_fn_t)(const char *, const char *);
304
305struct cgit_snapshot_format {
306 const char *suffix;
307 const char *mimetype;
308 write_archive_fn_t write_func;
309 int bit;
310};
311
312extern const char *cgit_version;
313
314extern struct cgit_repolist cgit_repolist;
315extern struct cgit_context ctx;
316extern const struct cgit_snapshot_format cgit_snapshot_formats[];
317
318extern char *cgit_default_repo_desc;
319extern struct cgit_repo *cgit_add_repo(const char *url);
320extern struct cgit_repo *cgit_get_repoinfo(const char *url);
321extern void cgit_repo_config_cb(const char *name, const char *value);
322
323extern int chk_zero(int result, char *msg);
324extern int chk_positive(int result, char *msg);
325extern int chk_non_negative(int result, char *msg);
326
327extern char *trim_end(const char *str, char c);
328extern char *ensure_end(const char *str, char c);
329extern char *strlpart(char *txt, int maxlen);
330extern char *strrpart(char *txt, int maxlen);
331
332extern void strbuf_ensure_end(struct strbuf *sb, char c);
333
334extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
335extern void cgit_free_reflist_inner(struct reflist *list);
336extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
337 int flags, void *cb_data);
338
339extern void *cgit_free_commitinfo(struct commitinfo *info);
340
341extern int cgit_diff_files(const unsigned char *old_sha1,
342 const unsigned char *new_sha1,
343 unsigned long *old_size, unsigned long *new_size,
344 int *binary, int context, int ignorews,
345 linediff_fn fn);
346
347extern void cgit_diff_tree(const unsigned char *old_sha1,
348 const unsigned char *new_sha1,
349 filepair_fn fn, const char *prefix, int ignorews);
350
351extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,
352 const char *prefix);
353
354__attribute__((format (printf,1,2)))
355extern char *fmt(const char *format,...);
356
357__attribute__((format (printf,1,2)))
358extern char *fmtalloc(const char *format,...);
359
360extern struct commitinfo *cgit_parse_commit(struct commit *commit);
361extern struct taginfo *cgit_parse_tag(struct tag *tag);
362extern void cgit_parse_url(const char *url);
363
364extern const char *cgit_repobasename(const char *reponame);
365
366extern int cgit_parse_snapshots_mask(const char *str);
367
368extern int cgit_open_filter(struct cgit_filter *filter, ...);
369extern int cgit_close_filter(struct cgit_filter *filter);
370extern void cgit_fprintf_filter(struct cgit_filter *filter, FILE *f, const char *prefix);
371extern void cgit_exec_filter_init(struct cgit_exec_filter *filter, char *cmd, char **argv);
372extern struct cgit_filter *cgit_new_filter(const char *cmd, filter_type filtertype);
373extern void cgit_cleanup_filters(void);
374extern void cgit_init_filters(void);
375
376extern void cgit_prepare_repo_env(struct cgit_repo * repo);
377
378extern int readfile(const char *path, char **buf, size_t *size);
379
380extern char *expand_macros(const char *txt);
381
382#endif /* CGIT_H */