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