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
20
21/*
22 * The valid cgit repo-commands
23 */
24#define CMD_LOG 1
25#define CMD_COMMIT 2
26#define CMD_DIFF 3
27#define CMD_TREE 4
28#define CMD_BLOB 5
29#define CMD_SNAPSHOT 6
30#define CMD_TAG 7
31#define CMD_REFS 8
32
33/*
34 * Dateformats used on misc. pages
35 */
36#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
37#define FMT_SHORTDATE "%Y-%m-%d"
38
39
40/*
41 * Limits used for relative dates
42 */
43#define TM_MIN 60
44#define TM_HOUR (TM_MIN * 60)
45#define TM_DAY (TM_HOUR * 24)
46#define TM_WEEK (TM_DAY * 7)
47#define TM_YEAR (TM_DAY * 365)
48#define TM_MONTH (TM_YEAR / 12.0)
49
50
51/*
52 * Default encoding
53 */
54#define PAGE_ENCODING "UTF-8"
55
56typedef void (*configfn)(const char *name, const char *value);
57typedef void (*filepair_fn)(struct diff_filepair *pair);
58typedef void (*linediff_fn)(char *line, int len);
59
60struct cacheitem {
61 char *name;
62 struct stat st;
63 int ttl;
64 int fd;
65};
66
67struct repoinfo {
68 char *url;
69 char *name;
70 char *path;
71 char *desc;
72 char *owner;
73 char *defbranch;
74 char *group;
75 char *module_link;
76 char *readme;
77 int snapshots;
78 int enable_log_filecount;
79 int enable_log_linecount;
80};
81
82struct repolist {
83 int length;
84 int count;
85 struct repoinfo *repos;
86};
87
88struct commitinfo {
89 struct commit *commit;
90 char *author;
91 char *author_email;
92 unsigned long author_date;
93 char *committer;
94 char *committer_email;
95 unsigned long committer_date;
96 char *subject;
97 char *msg;
98 char *msg_encoding;
99};
100
101struct taginfo {
102 char *tagger;
103 char *tagger_email;
104 int tagger_date;
105 char *msg;
106};
107
108struct refinfo {
109 const char *refname;
110 struct object *object;
111 union {
112 struct taginfo *tag;
113 struct commitinfo *commit;
114 };
115};
116
117struct reflist {
118 struct refinfo **refs;
119 int alloc;
120 int count;
121};
122
123extern const char *cgit_version;
124
125extern struct repolist cgit_repolist;
126extern struct repoinfo *cgit_repo;
127extern int cgit_cmd;
128
129extern char *cgit_root_title;
130extern char *cgit_css;
131extern char *cgit_logo;
132extern char *cgit_index_header;
133extern char *cgit_index_info;
134extern char *cgit_logo_link;
135extern char *cgit_module_link;
136extern char *cgit_agefile;
137extern char *cgit_virtual_root;
138extern char *cgit_script_name;
139extern char *cgit_cache_root;
140extern char *cgit_repo_group;
141
142extern int cgit_nocache;
143extern int cgit_snapshots;
144extern int cgit_enable_index_links;
145extern int cgit_enable_log_filecount;
146extern int cgit_enable_log_linecount;
147extern int cgit_max_lock_attempts;
148extern int cgit_cache_root_ttl;
149extern int cgit_cache_repo_ttl;
150extern int cgit_cache_dynamic_ttl;
151extern int cgit_cache_static_ttl;
152extern int cgit_cache_max_create_time;
153extern int cgit_summary_log;
154extern int cgit_summary_tags;
155extern int cgit_summary_branches;
156
157extern int cgit_max_msg_len;
158extern int cgit_max_repodesc_len;
159extern int cgit_max_commit_count;
160
161extern int cgit_query_has_symref;
162extern int cgit_query_has_sha1;
163
164extern char *cgit_querystring;
165extern char *cgit_query_repo;
166extern char *cgit_query_page;
167extern char *cgit_query_search;
168extern char *cgit_query_grep;
169extern char *cgit_query_head;
170extern char *cgit_query_sha1;
171extern char *cgit_query_sha2;
172extern char *cgit_query_path;
173extern char *cgit_query_name;
174extern int cgit_query_ofs;
175
176extern int htmlfd;
177
178extern int cgit_get_cmd_index(const char *cmd);
179extern struct repoinfo *cgit_get_repoinfo(const char *url);
180extern void cgit_global_config_cb(const char *name, const char *value);
181extern void cgit_repo_config_cb(const char *name, const char *value);
182extern void cgit_querystring_cb(const char *name, const char *value);
183
184extern int chk_zero(int result, char *msg);
185extern int chk_positive(int result, char *msg);
186extern int chk_non_negative(int result, char *msg);
187
188extern int hextoint(char c);
189extern char *trim_end(const char *str, char c);
190extern char *strlpart(char *txt, int maxlen);
191extern char *strrpart(char *txt, int maxlen);
192
193extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
194extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
195 int flags, void *cb_data);
196
197extern void *cgit_free_commitinfo(struct commitinfo *info);
198
199extern int cgit_diff_files(const unsigned char *old_sha1,
200 const unsigned char *new_sha1,
201 linediff_fn fn);
202
203extern void cgit_diff_tree(const unsigned char *old_sha1,
204 const unsigned char *new_sha1,
205 filepair_fn fn, const char *prefix);
206
207extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
208
209extern char *fmt(const char *format,...);
210
211extern void html(const char *txt);
212extern void htmlf(const char *format,...);
213extern void html_txt(char *txt);
214extern void html_ntxt(int len, char *txt);
215extern void html_attr(char *txt);
216extern void html_hidden(char *name, char *value);
217extern void html_option(char *value, char *text, char *selected_value);
218extern void html_link_open(char *url, char *title, char *class);
219extern void html_link_close(void);
220extern void html_filemode(unsigned short mode);
221extern int html_include(const char *filename);
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_branches(int maxcount);
270extern void cgit_print_tags(int maxcount);
271
272extern void cgit_print_repolist(struct cacheitem *item);
273extern void cgit_print_summary();
274extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep,
275 char *pattern, char *path, int pager);
276extern void cgit_print_blob(struct cacheitem *item, const char *hex, char *path);
277extern void cgit_print_tree(const char *rev, char *path);
278extern void cgit_print_commit(char *hex);
279extern void cgit_print_refs();
280extern void cgit_print_tag(char *revname);
281extern void cgit_print_diff(const char *new_hex, const char *old_hex, const char *prefix);
282extern void cgit_print_snapshot(struct cacheitem *item, const char *head,
283 const char *hex, const char *prefix,
284 const char *filename, int snapshot);
285extern void cgit_print_snapshot_links(const char *repo, const char *head,
286 const char *hex, int snapshots);
287extern int cgit_parse_snapshots_mask(const char *str);
288
289#endif /* CGIT_H */