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
101extern const char *cgit_version;
102
103extern struct repolist cgit_repolist;
104extern struct repoinfo *cgit_repo;
105extern int cgit_cmd;
106
107extern char *cgit_root_title;
108extern char *cgit_css;
109extern char *cgit_logo;
110extern char *cgit_index_header;
111extern char *cgit_logo_link;
112extern char *cgit_module_link;
113extern char *cgit_agefile;
114extern char *cgit_virtual_root;
115extern char *cgit_script_name;
116extern char *cgit_cache_root;
117extern char *cgit_repo_group;
118
119extern int cgit_nocache;
120extern int cgit_snapshots;
121extern int cgit_enable_index_links;
122extern int cgit_enable_log_filecount;
123extern int cgit_enable_log_linecount;
124extern int cgit_max_lock_attempts;
125extern int cgit_cache_root_ttl;
126extern int cgit_cache_repo_ttl;
127extern int cgit_cache_dynamic_ttl;
128extern int cgit_cache_static_ttl;
129extern int cgit_cache_max_create_time;
130extern int cgit_summary_log;
131
132extern int cgit_max_msg_len;
133extern int cgit_max_repodesc_len;
134extern int cgit_max_commit_count;
135
136extern int cgit_query_has_symref;
137extern int cgit_query_has_sha1;
138
139extern char *cgit_querystring;
140extern char *cgit_query_repo;
141extern char *cgit_query_page;
142extern char *cgit_query_search;
143extern char *cgit_query_head;
144extern char *cgit_query_sha1;
145extern char *cgit_query_sha2;
146extern char *cgit_query_path;
147extern char *cgit_query_name;
148extern int cgit_query_ofs;
149
150extern int htmlfd;
151
152extern int cgit_get_cmd_index(const char *cmd);
153extern struct repoinfo *cgit_get_repoinfo(const char *url);
154extern void cgit_global_config_cb(const char *name, const char *value);
155extern void cgit_repo_config_cb(const char *name, const char *value);
156extern void cgit_querystring_cb(const char *name, const char *value);
157
158extern int chk_zero(int result, char *msg);
159extern int chk_positive(int result, char *msg);
160extern int chk_non_negative(int result, char *msg);
161
162extern int hextoint(char c);
163extern char *trim_end(const char *str, char c);
164
165extern void *cgit_free_commitinfo(struct commitinfo *info);
166
167extern int cgit_diff_files(const unsigned char *old_sha1,
168 const unsigned char *new_sha1,
169 linediff_fn fn);
170
171extern void cgit_diff_tree(const unsigned char *old_sha1,
172 const unsigned char *new_sha1,
173 filepair_fn fn, const char *prefix);
174
175extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
176
177extern char *fmt(const char *format,...);
178
179extern void html(const char *txt);
180extern void htmlf(const char *format,...);
181extern void html_txt(char *txt);
182extern void html_ntxt(int len, char *txt);
183extern void html_attr(char *txt);
184extern void html_hidden(char *name, char *value);
185extern void html_link_open(char *url, char *title, char *class);
186extern void html_link_close(void);
187extern void html_filemode(unsigned short mode);
188extern int html_include(const char *filename);
189
190extern int cgit_read_config(const char *filename, configfn fn);
191extern int cgit_parse_query(char *txt, configfn fn);
192extern struct commitinfo *cgit_parse_commit(struct commit *commit);
193extern struct taginfo *cgit_parse_tag(struct tag *tag);
194extern void cgit_parse_url(const char *url);
195
196extern char *cache_safe_filename(const char *unsafe);
197extern int cache_lock(struct cacheitem *item);
198extern int cache_unlock(struct cacheitem *item);
199extern int cache_cancel_lock(struct cacheitem *item);
200extern int cache_exist(struct cacheitem *item);
201extern int cache_expired(struct cacheitem *item);
202
203extern char *cgit_repourl(const char *reponame);
204extern char *cgit_fileurl(const char *reponame, const char *pagename,
205 const char *filename, const char *query);
206extern char *cgit_pageurl(const char *reponame, const char *pagename,
207 const char *query);
208
209extern const char *cgit_repobasename(const char *reponame);
210
211extern void cgit_tree_link(char *name, char *title, char *class, char *head,
212 char *rev, char *path);
213extern void cgit_log_link(char *name, char *title, char *class, char *head,
214 char *rev, char *path, int ofs);
215extern void cgit_commit_link(char *name, char *title, char *class, char *head,
216 char *rev);
217extern void cgit_snapshot_link(char *name, char *title, char *class,
218 char *head, char *rev, char *archivename);
219extern void cgit_diff_link(char *name, char *title, char *class, char *head,
220 char *new_rev, char *old_rev, char *path);
221
222extern void cgit_object_link(struct object *obj);
223
224extern void cgit_print_error(char *msg);
225extern void cgit_print_date(time_t secs, char *format);
226extern void cgit_print_age(time_t t, time_t max_relative, char *format);
227extern void cgit_print_docstart(char *title, struct cacheitem *item);
228extern void cgit_print_docend();
229extern void cgit_print_pageheader(char *title, int show_search);
230extern void cgit_print_snapshot_start(const char *mimetype,
231 const char *filename,
232 struct cacheitem *item);
233
234extern void cgit_print_repolist(struct cacheitem *item);
235extern void cgit_print_summary();
236extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep, char *path, int pager);
237extern void cgit_print_blob(struct cacheitem *item, const char *hex, char *path);
238extern void cgit_print_tree(const char *rev, char *path);
239extern void cgit_print_commit(char *hex);
240extern void cgit_print_tag(char *revname);
241extern void cgit_print_diff(const char *new_hex, const char *old_hex);
242extern void cgit_print_snapshot(struct cacheitem *item, const char *head,
243 const char *hex, const char *prefix,
244 const char *filename, int snapshot);
245extern void cgit_print_snapshot_links(const char *repo, const char *head,
246 const char *hex, int snapshots);
247extern int cgit_parse_snapshots_mask(const char *str);
248
249#endif /* CGIT_H */