cgit.h (view raw)
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
46typedef void (*configfn)(const char *name, const char *value);
47typedef void (*filepair_fn)(struct diff_filepair *pair);
48typedef void (*linediff_fn)(char *line, int len);
49
50struct 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
66struct cgit_repolist {
67 int length;
68 int count;
69 struct cgit_repo *repos;
70};
71
72struct 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
85struct taginfo {
86 char *tagger;
87 char *tagger_email;
88 unsigned long tagger_date;
89 char *msg;
90};
91
92struct refinfo {
93 const char *refname;
94 struct object *object;
95 union {
96 struct taginfo *tag;
97 struct commitinfo *commit;
98 };
99};
100
101struct reflist {
102 struct refinfo **refs;
103 int alloc;
104 int count;
105};
106
107struct 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 int nohead;
124 int showmsg;
125};
126
127struct cgit_config {
128 char *agefile;
129 char *cache_root;
130 char *clone_prefix;
131 char *css;
132 char *favicon;
133 char *footer;
134 char *index_header;
135 char *index_info;
136 char *logo;
137 char *logo_link;
138 char *module_link;
139 char *repo_group;
140 char *robots;
141 char *root_title;
142 char *root_desc;
143 char *root_readme;
144 char *script_name;
145 char *virtual_root;
146 int cache_size;
147 int cache_dynamic_ttl;
148 int cache_max_create_time;
149 int cache_repo_ttl;
150 int cache_root_ttl;
151 int cache_static_ttl;
152 int enable_index_links;
153 int enable_log_filecount;
154 int enable_log_linecount;
155 int local_time;
156 int max_repo_count;
157 int max_commit_count;
158 int max_lock_attempts;
159 int max_msg_len;
160 int max_repodesc_len;
161 int nocache;
162 int renamelimit;
163 int snapshots;
164 int summary_branches;
165 int summary_log;
166 int summary_tags;
167};
168
169struct cgit_page {
170 time_t modified;
171 time_t expires;
172 size_t size;
173 char *mimetype;
174 char *charset;
175 char *filename;
176 char *title;
177};
178
179struct cgit_context {
180 struct cgit_query qry;
181 struct cgit_config cfg;
182 struct cgit_repo *repo;
183 struct cgit_page page;
184};
185
186struct cgit_snapshot_format {
187 const char *suffix;
188 const char *mimetype;
189 write_archive_fn_t write_func;
190 int bit;
191};
192
193extern const char *cgit_version;
194
195extern struct cgit_repolist cgit_repolist;
196extern struct cgit_context ctx;
197extern const struct cgit_snapshot_format cgit_snapshot_formats[];
198
199extern struct cgit_repo *cgit_add_repo(const char *url);
200extern struct cgit_repo *cgit_get_repoinfo(const char *url);
201extern void cgit_repo_config_cb(const char *name, const char *value);
202
203extern int chk_zero(int result, char *msg);
204extern int chk_positive(int result, char *msg);
205extern int chk_non_negative(int result, char *msg);
206
207extern char *trim_end(const char *str, char c);
208extern char *strlpart(char *txt, int maxlen);
209extern char *strrpart(char *txt, int maxlen);
210
211extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
212extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
213 int flags, void *cb_data);
214
215extern void *cgit_free_commitinfo(struct commitinfo *info);
216
217extern int cgit_diff_files(const unsigned char *old_sha1,
218 const unsigned char *new_sha1,
219 linediff_fn fn);
220
221extern void cgit_diff_tree(const unsigned char *old_sha1,
222 const unsigned char *new_sha1,
223 filepair_fn fn, const char *prefix);
224
225extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
226
227extern char *fmt(const char *format,...);
228
229extern struct commitinfo *cgit_parse_commit(struct commit *commit);
230extern struct taginfo *cgit_parse_tag(struct tag *tag);
231extern void cgit_parse_url(const char *url);
232
233extern const char *cgit_repobasename(const char *reponame);
234
235extern int cgit_parse_snapshots_mask(const char *str);
236
237/* libgit.a either links against or compiles its own implementation of
238 * strcasestr(), and we'd like to reuse it. Simply re-declaring it
239 * seems to do the trick.
240 */
241extern char *strcasestr(const char *haystack, const char *needle);
242
243
244#endif /* CGIT_H */