]> gitweb.ps.run Git - ps-cgit/blob - cgit.h
Add 'about-filter' and 'repo.about-filter' options
[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_filter {
52         char *cmd;
53         char **argv;
54         int old_stdout;
55         int pipe_fh[2];
56         int pid;
57         int exitstatus;
58 };
59
60 struct cgit_repo {
61         char *url;
62         char *name;
63         char *path;
64         char *desc;
65         char *owner;
66         char *defbranch;
67         char *group;
68         char *module_link;
69         char *readme;
70         char *clone_url;
71         int snapshots;
72         int enable_log_filecount;
73         int enable_log_linecount;
74         int max_stats;
75         time_t mtime;
76         struct cgit_filter *about_filter;
77         struct cgit_filter *commit_filter;
78         struct cgit_filter *source_filter;
79 };
80
81 struct cgit_repolist {
82         int length;
83         int count;
84         struct cgit_repo *repos;
85 };
86
87 struct 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
100 struct taginfo {
101         char *tagger;
102         char *tagger_email;
103         unsigned long tagger_date;
104         char *msg;
105 };
106
107 struct refinfo {
108         const char *refname;
109         struct object *object;
110         union {
111                 struct taginfo *tag;
112                 struct commitinfo *commit;
113         };
114 };
115
116 struct reflist {
117         struct refinfo **refs;
118         int alloc;
119         int count;
120 };
121
122 struct 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
144 struct 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 noheader;
184         int renamelimit;
185         int snapshots;
186         int summary_branches;
187         int summary_log;
188         int summary_tags;
189         struct cgit_filter *about_filter;
190         struct cgit_filter *commit_filter;
191         struct cgit_filter *source_filter;
192 };
193
194 struct cgit_page {
195         time_t modified;
196         time_t expires;
197         size_t size;
198         char *mimetype;
199         char *charset;
200         char *filename;
201         char *etag;
202         char *title;
203         int status;
204         char *statusmsg;
205 };
206
207 struct cgit_context {
208         struct cgit_query qry;
209         struct cgit_config cfg;
210         struct cgit_repo *repo;
211         struct cgit_page page;
212 };
213
214 struct cgit_snapshot_format {
215         const char *suffix;
216         const char *mimetype;
217         write_archive_fn_t write_func;
218         int bit;
219 };
220
221 extern const char *cgit_version;
222
223 extern struct cgit_repolist cgit_repolist;
224 extern struct cgit_context ctx;
225 extern const struct cgit_snapshot_format cgit_snapshot_formats[];
226
227 extern struct cgit_repo *cgit_add_repo(const char *url);
228 extern struct cgit_repo *cgit_get_repoinfo(const char *url);
229 extern void cgit_repo_config_cb(const char *name, const char *value);
230
231 extern int chk_zero(int result, char *msg);
232 extern int chk_positive(int result, char *msg);
233 extern int chk_non_negative(int result, char *msg);
234
235 extern char *trim_end(const char *str, char c);
236 extern char *strlpart(char *txt, int maxlen);
237 extern char *strrpart(char *txt, int maxlen);
238
239 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
240 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
241                         int flags, void *cb_data);
242
243 extern void *cgit_free_commitinfo(struct commitinfo *info);
244
245 extern int cgit_diff_files(const unsigned char *old_sha1,
246                            const unsigned char *new_sha1,
247                            unsigned long *old_size, unsigned long *new_size,
248                            int *binary, linediff_fn fn);
249
250 extern void cgit_diff_tree(const unsigned char *old_sha1,
251                            const unsigned char *new_sha1,
252                            filepair_fn fn, const char *prefix);
253
254 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
255
256 extern char *fmt(const char *format,...);
257
258 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
259 extern struct taginfo *cgit_parse_tag(struct tag *tag);
260 extern void cgit_parse_url(const char *url);
261
262 extern const char *cgit_repobasename(const char *reponame);
263
264 extern int cgit_parse_snapshots_mask(const char *str);
265
266 extern int cgit_open_filter(struct cgit_filter *filter);
267 extern int cgit_close_filter(struct cgit_filter *filter);
268
269
270 #endif /* CGIT_H */