]> gitweb.ps.run Git - ps-cgit/blob - cgit.h
struct cgit_cmd: Differentiate between various usages of ctx.qry.path
[ps-cgit] / cgit.h
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
48 typedef void (*configfn)(const char *name, const char *value);
49 typedef void (*filepair_fn)(struct diff_filepair *pair);
50 typedef void (*linediff_fn)(char *line, int len);
51
52 struct 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
61 struct cgit_repo {
62         char *url;
63         char *name;
64         char *path;
65         char *desc;
66         char *owner;
67         char *defbranch;
68         char *module_link;
69         char *readme;
70         char *section;
71         char *clone_url;
72         int snapshots;
73         int enable_log_filecount;
74         int enable_log_linecount;
75         int enable_remote_branches;
76         int max_stats;
77         time_t mtime;
78         struct cgit_filter *about_filter;
79         struct cgit_filter *commit_filter;
80         struct cgit_filter *source_filter;
81 };
82
83 typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
84               const char *value);
85
86 struct cgit_repolist {
87         int length;
88         int count;
89         struct cgit_repo *repos;
90 };
91
92 struct commitinfo {
93         struct commit *commit;
94         char *author;
95         char *author_email;
96         unsigned long author_date;
97         char *committer;
98         char *committer_email;
99         unsigned long committer_date;
100         char *subject;
101         char *msg;
102         char *msg_encoding;
103 };
104
105 struct taginfo {
106         char *tagger;
107         char *tagger_email;
108         unsigned long tagger_date;
109         char *msg;
110 };
111
112 struct refinfo {
113         const char *refname;
114         struct object *object;
115         union {
116                 struct taginfo *tag;
117                 struct commitinfo *commit;
118         };
119 };
120
121 struct reflist {
122         struct refinfo **refs;
123         int alloc;
124         int count;
125 };
126
127 struct cgit_query {
128         int has_symref;
129         int has_sha1;
130         char *raw;
131         char *repo;
132         char *page;
133         char *search;
134         char *grep;
135         char *head;
136         char *sha1;
137         char *sha2;
138         char *path;
139         char *name;
140         char *mimetype;
141         char *url;
142         char *period;
143         int   ofs;
144         int nohead;
145         char *sort;
146         int showmsg;
147         int ssdiff;
148         char *vpath;
149 };
150
151 struct cgit_config {
152         char *agefile;
153         char *cache_root;
154         char *clone_prefix;
155         char *css;
156         char *favicon;
157         char *footer;
158         char *head_include;
159         char *header;
160         char *index_header;
161         char *index_info;
162         char *logo;
163         char *logo_link;
164         char *module_link;
165         char *robots;
166         char *root_title;
167         char *root_desc;
168         char *root_readme;
169         char *script_name;
170         char *section;
171         char *virtual_root;
172         int cache_size;
173         int cache_dynamic_ttl;
174         int cache_max_create_time;
175         int cache_repo_ttl;
176         int cache_root_ttl;
177         int cache_scanrc_ttl;
178         int cache_static_ttl;
179         int embedded;
180         int enable_filter_overrides;
181         int enable_index_links;
182         int enable_log_filecount;
183         int enable_log_linecount;
184         int enable_remote_branches;
185         int enable_tree_linenumbers;
186         int local_time;
187         int max_repo_count;
188         int max_commit_count;
189         int max_lock_attempts;
190         int max_msg_len;
191         int max_repodesc_len;
192         int max_blob_size;
193         int max_stats;
194         int nocache;
195         int noplainemail;
196         int noheader;
197         int renamelimit;
198         int snapshots;
199         int summary_branches;
200         int summary_log;
201         int summary_tags;
202         int ssdiff;
203         struct string_list mimetypes;
204         struct cgit_filter *about_filter;
205         struct cgit_filter *commit_filter;
206         struct cgit_filter *source_filter;
207 };
208
209 struct cgit_page {
210         time_t modified;
211         time_t expires;
212         size_t size;
213         char *mimetype;
214         char *charset;
215         char *filename;
216         char *etag;
217         char *title;
218         int status;
219         char *statusmsg;
220 };
221
222 struct cgit_environment {
223         char *cgit_config;
224         char *http_host;
225         char *https;
226         char *no_http;
227         char *path_info;
228         char *query_string;
229         char *request_method;
230         char *script_name;
231         char *server_name;
232         char *server_port;
233 };
234
235 struct cgit_context {
236         struct cgit_environment env;
237         struct cgit_query qry;
238         struct cgit_config cfg;
239         struct cgit_repo *repo;
240         struct cgit_page page;
241 };
242
243 struct cgit_snapshot_format {
244         const char *suffix;
245         const char *mimetype;
246         write_archive_fn_t write_func;
247         int bit;
248 };
249
250 extern const char *cgit_version;
251
252 extern struct cgit_repolist cgit_repolist;
253 extern struct cgit_context ctx;
254 extern const struct cgit_snapshot_format cgit_snapshot_formats[];
255
256 extern struct cgit_repo *cgit_add_repo(const char *url);
257 extern struct cgit_repo *cgit_get_repoinfo(const char *url);
258 extern void cgit_repo_config_cb(const char *name, const char *value);
259
260 extern int chk_zero(int result, char *msg);
261 extern int chk_positive(int result, char *msg);
262 extern int chk_non_negative(int result, char *msg);
263
264 extern char *trim_end(const char *str, char c);
265 extern char *strlpart(char *txt, int maxlen);
266 extern char *strrpart(char *txt, int maxlen);
267
268 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
269 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
270                         int flags, void *cb_data);
271
272 extern void *cgit_free_commitinfo(struct commitinfo *info);
273
274 extern int cgit_diff_files(const unsigned char *old_sha1,
275                            const unsigned char *new_sha1,
276                            unsigned long *old_size, unsigned long *new_size,
277                            int *binary, linediff_fn fn);
278
279 extern void cgit_diff_tree(const unsigned char *old_sha1,
280                            const unsigned char *new_sha1,
281                            filepair_fn fn, const char *prefix);
282
283 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
284
285 extern char *fmt(const char *format,...);
286
287 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
288 extern struct taginfo *cgit_parse_tag(struct tag *tag);
289 extern void cgit_parse_url(const char *url);
290
291 extern const char *cgit_repobasename(const char *reponame);
292
293 extern int cgit_parse_snapshots_mask(const char *str);
294
295 extern int cgit_open_filter(struct cgit_filter *filter);
296 extern int cgit_close_filter(struct cgit_filter *filter);
297
298 extern int readfile(const char *path, char **buf, size_t *size);
299
300 #endif /* CGIT_H */