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