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