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