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