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