]> gitweb.ps.run Git - ps-cgit/blob - cgit.h
Add support for a custom header
[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         int max_stats;
65         time_t mtime;
66 };
67
68 struct cgit_repolist {
69         int length;
70         int count;
71         struct cgit_repo *repos;
72 };
73
74 struct commitinfo {
75         struct commit *commit;
76         char *author;
77         char *author_email;
78         unsigned long author_date;
79         char *committer;
80         char *committer_email;
81         unsigned long committer_date;
82         char *subject;
83         char *msg;
84         char *msg_encoding;
85 };
86
87 struct taginfo {
88         char *tagger;
89         char *tagger_email;
90         unsigned long tagger_date;
91         char *msg;
92 };
93
94 struct refinfo {
95         const char *refname;
96         struct object *object;
97         union {
98                 struct taginfo *tag;
99                 struct commitinfo *commit;
100         };
101 };
102
103 struct reflist {
104         struct refinfo **refs;
105         int alloc;
106         int count;
107 };
108
109 struct cgit_query {
110         int has_symref;
111         int has_sha1;
112         char *raw;
113         char *repo;
114         char *page;
115         char *search;
116         char *grep;
117         char *head;
118         char *sha1;
119         char *sha2;
120         char *path;
121         char *name;
122         char *mimetype;
123         char *url;
124         char *period;
125         int   ofs;
126         int nohead;
127         char *sort;
128         int showmsg;
129 };
130
131 struct cgit_config {
132         char *agefile;
133         char *cache_root;
134         char *clone_prefix;
135         char *css;
136         char *favicon;
137         char *footer;
138         char *header;
139         char *index_header;
140         char *index_info;
141         char *logo;
142         char *logo_link;
143         char *module_link;
144         char *repo_group;
145         char *robots;
146         char *root_title;
147         char *root_desc;
148         char *root_readme;
149         char *script_name;
150         char *virtual_root;
151         int cache_size;
152         int cache_dynamic_ttl;
153         int cache_max_create_time;
154         int cache_repo_ttl;
155         int cache_root_ttl;
156         int cache_static_ttl;
157         int enable_index_links;
158         int enable_log_filecount;
159         int enable_log_linecount;
160         int local_time;
161         int max_repo_count;
162         int max_commit_count;
163         int max_lock_attempts;
164         int max_msg_len;
165         int max_repodesc_len;
166         int max_stats;
167         int nocache;
168         int renamelimit;
169         int snapshots;
170         int summary_branches;
171         int summary_log;
172         int summary_tags;
173 };
174
175 struct cgit_page {
176         time_t modified;
177         time_t expires;
178         size_t size;
179         char *mimetype;
180         char *charset;
181         char *filename;
182         char *title;
183 };
184
185 struct cgit_context {
186         struct cgit_query qry;
187         struct cgit_config cfg;
188         struct cgit_repo *repo;
189         struct cgit_page page;
190 };
191
192 struct cgit_snapshot_format {
193         const char *suffix;
194         const char *mimetype;
195         write_archive_fn_t write_func;
196         int bit;
197 };
198
199 extern const char *cgit_version;
200
201 extern struct cgit_repolist cgit_repolist;
202 extern struct cgit_context ctx;
203 extern const struct cgit_snapshot_format cgit_snapshot_formats[];
204
205 extern struct cgit_repo *cgit_add_repo(const char *url);
206 extern struct cgit_repo *cgit_get_repoinfo(const char *url);
207 extern void cgit_repo_config_cb(const char *name, const char *value);
208
209 extern int chk_zero(int result, char *msg);
210 extern int chk_positive(int result, char *msg);
211 extern int chk_non_negative(int result, char *msg);
212
213 extern char *trim_end(const char *str, char c);
214 extern char *strlpart(char *txt, int maxlen);
215 extern char *strrpart(char *txt, int maxlen);
216
217 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
218 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
219                         int flags, void *cb_data);
220
221 extern void *cgit_free_commitinfo(struct commitinfo *info);
222
223 extern int cgit_diff_files(const unsigned char *old_sha1,
224                            const unsigned char *new_sha1,
225                            linediff_fn fn);
226
227 extern void cgit_diff_tree(const unsigned char *old_sha1,
228                            const unsigned char *new_sha1,
229                            filepair_fn fn, const char *prefix);
230
231 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
232
233 extern char *fmt(const char *format,...);
234
235 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
236 extern struct taginfo *cgit_parse_tag(struct tag *tag);
237 extern void cgit_parse_url(const char *url);
238
239 extern const char *cgit_repobasename(const char *reponame);
240
241 extern int cgit_parse_snapshots_mask(const char *str);
242
243
244 #endif /* CGIT_H */