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