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 * The valid cgit repo-commands
24 */
25#define CMD_LOG 1
26#define CMD_COMMIT 2
27#define CMD_DIFF 3
28#define CMD_TREE 4
29#define CMD_BLOB 5
30#define CMD_SNAPSHOT 6
31#define CMD_TAG 7
32#define CMD_REFS 8
33#define CMD_PATCH 9
34
35/*
36 * Dateformats used on misc. pages
37 */
38#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
39#define FMT_SHORTDATE "%Y-%m-%d"
40
41
42/*
43 * Limits used for relative dates
44 */
45#define TM_MIN 60
46#define TM_HOUR (TM_MIN * 60)
47#define TM_DAY (TM_HOUR * 24)
48#define TM_WEEK (TM_DAY * 7)
49#define TM_YEAR (TM_DAY * 365)
50#define TM_MONTH (TM_YEAR / 12.0)
51
52
53/*
54 * Default encoding
55 */
56#define PAGE_ENCODING "UTF-8"
57
58typedef void (*configfn)(const char *name, const char *value);
59typedef void (*filepair_fn)(struct diff_filepair *pair);
60typedef void (*linediff_fn)(char *line, int len);
61
62struct cacheitem {
63 char *name;
64 struct stat st;
65 int ttl;
66 int fd;
67};
68
69struct cgit_repo {
70 char *url;
71 char *name;
72 char *path;
73 char *desc;
74 char *owner;
75 char *defbranch;
76 char *group;
77 char *module_link;
78 char *readme;
79 char *clone_url;
80 int snapshots;
81 int enable_log_filecount;
82 int enable_log_linecount;
83};
84
85struct cgit_repolist {
86 int length;
87 int count;
88 struct cgit_repo *repos;
89};
90
91struct commitinfo {
92 struct commit *commit;
93 char *author;
94 char *author_email;
95 unsigned long author_date;
96 char *committer;
97 char *committer_email;
98 unsigned long committer_date;
99 char *subject;
100 char *msg;
101 char *msg_encoding;
102};
103
104struct taginfo {
105 char *tagger;
106 char *tagger_email;
107 int tagger_date;
108 char *msg;
109};
110
111struct refinfo {
112 const char *refname;
113 struct object *object;
114 union {
115 struct taginfo *tag;
116 struct commitinfo *commit;
117 };
118};
119
120struct reflist {
121 struct refinfo **refs;
122 int alloc;
123 int count;
124};
125
126struct cgit_query {
127 int has_symref;
128 int has_sha1;
129 char *raw;
130 char *repo;
131 char *page;
132 char *search;
133 char *grep;
134 char *head;
135 char *sha1;
136 char *sha2;
137 char *path;
138 char *name;
139 int ofs;
140};
141
142struct cgit_config {
143 char *agefile;
144 char *cache_root;
145 char *clone_prefix;
146 char *css;
147 char *index_header;
148 char *index_info;
149 char *logo;
150 char *logo_link;
151 char *module_link;
152 char *repo_group;
153 char *robots;
154 char *root_title;
155 char *script_name;
156 char *virtual_root;
157 int cache_dynamic_ttl;
158 int cache_max_create_time;
159 int cache_repo_ttl;
160 int cache_root_ttl;
161 int cache_static_ttl;
162 int enable_index_links;
163 int enable_log_filecount;
164 int enable_log_linecount;
165 int max_commit_count;
166 int max_lock_attempts;
167 int max_msg_len;
168 int max_repodesc_len;
169 int nocache;
170 int renamelimit;
171 int snapshots;
172 int summary_branches;
173 int summary_log;
174 int summary_tags;
175};
176
177struct cgit_context {
178 struct cgit_query qry;
179 struct cgit_config cfg;
180 struct cgit_repo *repo;
181};
182
183extern const char *cgit_version;
184
185extern struct cgit_repolist cgit_repolist;
186extern struct cgit_context ctx;
187extern int cgit_cmd;
188
189extern void cgit_prepare_context(struct cgit_context *ctx);
190extern int cgit_get_cmd_index(const char *cmd);
191extern struct cgit_repo *cgit_get_repoinfo(const char *url);
192extern void cgit_global_config_cb(const char *name, const char *value);
193extern void cgit_repo_config_cb(const char *name, const char *value);
194extern void cgit_querystring_cb(const char *name, const char *value);
195
196extern int chk_zero(int result, char *msg);
197extern int chk_positive(int result, char *msg);
198extern int chk_non_negative(int result, char *msg);
199
200extern int hextoint(char c);
201extern char *trim_end(const char *str, char c);
202extern char *strlpart(char *txt, int maxlen);
203extern char *strrpart(char *txt, int maxlen);
204
205extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
206extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
207 int flags, void *cb_data);
208
209extern void *cgit_free_commitinfo(struct commitinfo *info);
210
211extern int cgit_diff_files(const unsigned char *old_sha1,
212 const unsigned char *new_sha1,
213 linediff_fn fn);
214
215extern void cgit_diff_tree(const unsigned char *old_sha1,
216 const unsigned char *new_sha1,
217 filepair_fn fn, const char *prefix);
218
219extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
220
221extern char *fmt(const char *format,...);
222
223extern int cgit_read_config(const char *filename, configfn fn);
224extern int cgit_parse_query(char *txt, configfn fn);
225extern struct commitinfo *cgit_parse_commit(struct commit *commit);
226extern struct taginfo *cgit_parse_tag(struct tag *tag);
227extern void cgit_parse_url(const char *url);
228
229extern char *cache_safe_filename(const char *unsafe);
230extern int cache_lock(struct cacheitem *item);
231extern int cache_unlock(struct cacheitem *item);
232extern int cache_cancel_lock(struct cacheitem *item);
233extern int cache_exist(struct cacheitem *item);
234extern int cache_expired(struct cacheitem *item);
235
236extern char *cgit_repourl(const char *reponame);
237extern char *cgit_fileurl(const char *reponame, const char *pagename,
238 const char *filename, const char *query);
239extern char *cgit_pageurl(const char *reponame, const char *pagename,
240 const char *query);
241
242extern const char *cgit_repobasename(const char *reponame);
243
244extern void cgit_tree_link(char *name, char *title, char *class, char *head,
245 char *rev, char *path);
246extern void cgit_log_link(char *name, char *title, char *class, char *head,
247 char *rev, char *path, int ofs, char *grep,
248 char *pattern);
249extern void cgit_commit_link(char *name, char *title, char *class, char *head,
250 char *rev);
251extern void cgit_refs_link(char *name, char *title, char *class, char *head,
252 char *rev, char *path);
253extern void cgit_snapshot_link(char *name, char *title, char *class,
254 char *head, char *rev, char *archivename);
255extern void cgit_diff_link(char *name, char *title, char *class, char *head,
256 char *new_rev, char *old_rev, char *path);
257
258extern void cgit_object_link(struct object *obj);
259
260extern void cgit_print_error(char *msg);
261extern void cgit_print_date(time_t secs, char *format);
262extern void cgit_print_age(time_t t, time_t max_relative, char *format);
263extern void cgit_print_docstart(char *title, struct cacheitem *item);
264extern void cgit_print_docend();
265extern void cgit_print_pageheader(char *title, int show_search);
266extern void cgit_print_snapshot_start(const char *mimetype,
267 const char *filename,
268 struct cacheitem *item);
269extern void cgit_print_filemode(unsigned short mode);
270extern void cgit_print_branches(int maxcount);
271extern void cgit_print_tags(int maxcount);
272
273extern void cgit_print_repolist(struct cacheitem *item);
274extern void cgit_print_summary();
275extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep,
276 char *pattern, char *path, int pager);
277extern void cgit_print_blob(struct cacheitem *item, const char *hex, char *path);
278extern void cgit_print_tree(const char *rev, char *path);
279extern void cgit_print_commit(char *hex);
280extern void cgit_print_refs();
281extern void cgit_print_tag(char *revname);
282extern void cgit_print_diff(const char *new_hex, const char *old_hex, const char *prefix);
283extern void cgit_print_patch(char *hex, struct cacheitem *item);
284extern void cgit_print_snapshot(struct cacheitem *item, const char *head,
285 const char *hex, const char *prefix,
286 const char *filename, int snapshot);
287extern void cgit_print_snapshot_links(const char *repo, const char *head,
288 const char *hex, int snapshots);
289extern int cgit_parse_snapshots_mask(const char *str);
290
291#endif /* CGIT_H */