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
34/*
35 * Dateformats used on misc. pages
36 */
37#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
38#define FMT_SHORTDATE "%Y-%m-%d"
39
40
41/*
42 * Limits used for relative dates
43 */
44#define TM_MIN 60
45#define TM_HOUR (TM_MIN * 60)
46#define TM_DAY (TM_HOUR * 24)
47#define TM_WEEK (TM_DAY * 7)
48#define TM_YEAR (TM_DAY * 365)
49#define TM_MONTH (TM_YEAR / 12.0)
50
51
52/*
53 * Default encoding
54 */
55#define PAGE_ENCODING "UTF-8"
56
57typedef void (*configfn)(const char *name, const char *value);
58typedef void (*filepair_fn)(struct diff_filepair *pair);
59typedef void (*linediff_fn)(char *line, int len);
60
61struct cacheitem {
62 char *name;
63 struct stat st;
64 int ttl;
65 int fd;
66};
67
68struct repoinfo {
69 char *url;
70 char *name;
71 char *path;
72 char *desc;
73 char *owner;
74 char *defbranch;
75 char *group;
76 char *module_link;
77 char *readme;
78 int snapshots;
79 int enable_log_filecount;
80 int enable_log_linecount;
81};
82
83struct repolist {
84 int length;
85 int count;
86 struct repoinfo *repos;
87};
88
89struct commitinfo {
90 struct commit *commit;
91 char *author;
92 char *author_email;
93 unsigned long author_date;
94 char *committer;
95 char *committer_email;
96 unsigned long committer_date;
97 char *subject;
98 char *msg;
99 char *msg_encoding;
100};
101
102struct taginfo {
103 char *tagger;
104 char *tagger_email;
105 int tagger_date;
106 char *msg;
107};
108
109struct refinfo {
110 const char *refname;
111 struct object *object;
112 union {
113 struct taginfo *tag;
114 struct commitinfo *commit;
115 };
116};
117
118struct reflist {
119 struct refinfo **refs;
120 int alloc;
121 int count;
122};
123
124extern const char *cgit_version;
125
126extern struct repolist cgit_repolist;
127extern struct repoinfo *cgit_repo;
128extern int cgit_cmd;
129
130extern char *cgit_root_title;
131extern char *cgit_css;
132extern char *cgit_logo;
133extern char *cgit_index_header;
134extern char *cgit_index_info;
135extern char *cgit_logo_link;
136extern char *cgit_module_link;
137extern char *cgit_agefile;
138extern char *cgit_virtual_root;
139extern char *cgit_script_name;
140extern char *cgit_cache_root;
141extern char *cgit_repo_group;
142
143extern int cgit_nocache;
144extern int cgit_snapshots;
145extern int cgit_enable_index_links;
146extern int cgit_enable_log_filecount;
147extern int cgit_enable_log_linecount;
148extern int cgit_max_lock_attempts;
149extern int cgit_cache_root_ttl;
150extern int cgit_cache_repo_ttl;
151extern int cgit_cache_dynamic_ttl;
152extern int cgit_cache_static_ttl;
153extern int cgit_cache_max_create_time;
154extern int cgit_summary_log;
155extern int cgit_summary_tags;
156extern int cgit_summary_branches;
157
158extern int cgit_max_msg_len;
159extern int cgit_max_repodesc_len;
160extern int cgit_max_commit_count;
161
162extern int cgit_query_has_symref;
163extern int cgit_query_has_sha1;
164
165extern char *cgit_querystring;
166extern char *cgit_query_repo;
167extern char *cgit_query_page;
168extern char *cgit_query_search;
169extern char *cgit_query_grep;
170extern char *cgit_query_head;
171extern char *cgit_query_sha1;
172extern char *cgit_query_sha2;
173extern char *cgit_query_path;
174extern char *cgit_query_name;
175extern int cgit_query_ofs;
176
177extern int htmlfd;
178
179extern int cgit_get_cmd_index(const char *cmd);
180extern struct repoinfo *cgit_get_repoinfo(const char *url);
181extern void cgit_global_config_cb(const char *name, const char *value);
182extern void cgit_repo_config_cb(const char *name, const char *value);
183extern void cgit_querystring_cb(const char *name, const char *value);
184
185extern int chk_zero(int result, char *msg);
186extern int chk_positive(int result, char *msg);
187extern int chk_non_negative(int result, char *msg);
188
189extern int hextoint(char c);
190extern char *trim_end(const char *str, char c);
191extern char *strlpart(char *txt, int maxlen);
192extern char *strrpart(char *txt, int maxlen);
193
194extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
195extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
196 int flags, void *cb_data);
197
198extern void *cgit_free_commitinfo(struct commitinfo *info);
199
200extern int cgit_diff_files(const unsigned char *old_sha1,
201 const unsigned char *new_sha1,
202 linediff_fn fn);
203
204extern void cgit_diff_tree(const unsigned char *old_sha1,
205 const unsigned char *new_sha1,
206 filepair_fn fn, const char *prefix);
207
208extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
209
210extern char *fmt(const char *format,...);
211
212extern void html(const char *txt);
213extern void htmlf(const char *format,...);
214extern void html_txt(char *txt);
215extern void html_ntxt(int len, char *txt);
216extern void html_attr(char *txt);
217extern void html_hidden(char *name, char *value);
218extern void html_option(char *value, char *text, char *selected_value);
219extern void html_link_open(char *url, char *title, char *class);
220extern void html_link_close(void);
221extern void html_filemode(unsigned short mode);
222extern int html_include(const char *filename);
223
224extern int cgit_read_config(const char *filename, configfn fn);
225extern int cgit_parse_query(char *txt, configfn fn);
226extern struct commitinfo *cgit_parse_commit(struct commit *commit);
227extern struct taginfo *cgit_parse_tag(struct tag *tag);
228extern void cgit_parse_url(const char *url);
229
230extern char *cache_safe_filename(const char *unsafe);
231extern int cache_lock(struct cacheitem *item);
232extern int cache_unlock(struct cacheitem *item);
233extern int cache_cancel_lock(struct cacheitem *item);
234extern int cache_exist(struct cacheitem *item);
235extern int cache_expired(struct cacheitem *item);
236
237extern char *cgit_repourl(const char *reponame);
238extern char *cgit_fileurl(const char *reponame, const char *pagename,
239 const char *filename, const char *query);
240extern char *cgit_pageurl(const char *reponame, const char *pagename,
241 const char *query);
242
243extern const char *cgit_repobasename(const char *reponame);
244
245extern void cgit_tree_link(char *name, char *title, char *class, char *head,
246 char *rev, char *path);
247extern void cgit_log_link(char *name, char *title, char *class, char *head,
248 char *rev, char *path, int ofs, char *grep,
249 char *pattern);
250extern void cgit_commit_link(char *name, char *title, char *class, char *head,
251 char *rev);
252extern void cgit_refs_link(char *name, char *title, char *class, char *head,
253 char *rev, char *path);
254extern void cgit_snapshot_link(char *name, char *title, char *class,
255 char *head, char *rev, char *archivename);
256extern void cgit_diff_link(char *name, char *title, char *class, char *head,
257 char *new_rev, char *old_rev, char *path);
258
259extern void cgit_object_link(struct object *obj);
260
261extern void cgit_print_error(char *msg);
262extern void cgit_print_date(time_t secs, char *format);
263extern void cgit_print_age(time_t t, time_t max_relative, char *format);
264extern void cgit_print_docstart(char *title, struct cacheitem *item);
265extern void cgit_print_docend();
266extern void cgit_print_pageheader(char *title, int show_search);
267extern void cgit_print_snapshot_start(const char *mimetype,
268 const char *filename,
269 struct cacheitem *item);
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_snapshot(struct cacheitem *item, const char *head,
284 const char *hex, const char *prefix,
285 const char *filename, int snapshot);
286extern void cgit_print_snapshot_links(const char *repo, const char *head,
287 const char *hex, int snapshots);
288extern int cgit_parse_snapshots_mask(const char *str);
289
290#endif /* CGIT_H */