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