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