all repos — cgit @ 2e4a941626c240bc7858aa7564882c01f657f4e8

a hyperfast web frontend for git written in c

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 <string-list.h>
 19#include <xdiff-interface.h>
 20#include <xdiff/xdiff.h>
 21#include <utf8.h>
 22
 23
 24/*
 25 * Dateformats used on misc. pages
 26 */
 27#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S (%Z)"
 28#define FMT_SHORTDATE "%Y-%m-%d"
 29#define FMT_ATOMDATE "%Y-%m-%dT%H:%M:%SZ"
 30
 31
 32/*
 33 * Limits used for relative dates
 34 */
 35#define TM_MIN    60
 36#define TM_HOUR  (TM_MIN * 60)
 37#define TM_DAY   (TM_HOUR * 24)
 38#define TM_WEEK  (TM_DAY * 7)
 39#define TM_YEAR  (TM_DAY * 365)
 40#define TM_MONTH (TM_YEAR / 12.0)
 41
 42
 43/*
 44 * Default encoding
 45 */
 46#define PAGE_ENCODING "UTF-8"
 47
 48typedef void (*configfn)(const char *name, const char *value);
 49typedef void (*filepair_fn)(struct diff_filepair *pair);
 50typedef void (*linediff_fn)(char *line, int len);
 51
 52struct cgit_filter {
 53	char *cmd;
 54	char **argv;
 55	int old_stdout;
 56	int pipe_fh[2];
 57	int pid;
 58	int exitstatus;
 59};
 60
 61struct cgit_repo {
 62	char *url;
 63	char *name;
 64	char *path;
 65	char *desc;
 66	char *owner;
 67	char *defbranch;
 68	char *module_link;
 69	char *readme;
 70	char *section;
 71	char *clone_url;
 72	int snapshots;
 73	int enable_log_filecount;
 74	int enable_log_linecount;
 75	int enable_remote_branches;
 76	int enable_subject_links;
 77	int max_stats;
 78	time_t mtime;
 79	struct cgit_filter *about_filter;
 80	struct cgit_filter *commit_filter;
 81	struct cgit_filter *source_filter;
 82};
 83
 84typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
 85	      const char *value);
 86
 87struct cgit_repolist {
 88	int length;
 89	int count;
 90	struct cgit_repo *repos;
 91};
 92
 93struct commitinfo {
 94	struct commit *commit;
 95	char *author;
 96	char *author_email;
 97	unsigned long author_date;
 98	char *committer;
 99	char *committer_email;
100	unsigned long committer_date;
101	char *subject;
102	char *msg;
103	char *msg_encoding;
104};
105
106struct taginfo {
107	char *tagger;
108	char *tagger_email;
109	unsigned long tagger_date;
110	char *msg;
111};
112
113struct refinfo {
114	const char *refname;
115	struct object *object;
116	union {
117		struct taginfo *tag;
118		struct commitinfo *commit;
119	};
120};
121
122struct reflist {
123	struct refinfo **refs;
124	int alloc;
125	int count;
126};
127
128struct cgit_query {
129	int has_symref;
130	int has_sha1;
131	char *raw;
132	char *repo;
133	char *page;
134	char *search;
135	char *grep;
136	char *head;
137	char *sha1;
138	char *sha2;
139	char *path;
140	char *name;
141	char *mimetype;
142	char *url;
143	char *period;
144	int   ofs;
145	int nohead;
146	char *sort;
147	int showmsg;
148	int ssdiff;
149	int show_all;
150	int context;
151	int ignorews;
152	char *vpath;
153};
154
155struct cgit_config {
156	char *agefile;
157	char *cache_root;
158	char *clone_prefix;
159	char *css;
160	char *favicon;
161	char *footer;
162	char *head_include;
163	char *header;
164	char *index_header;
165	char *index_info;
166	char *logo;
167	char *logo_link;
168	char *module_link;
169	char *project_list;
170	char *robots;
171	char *root_title;
172	char *root_desc;
173	char *root_readme;
174	char *script_name;
175	char *section;
176	char *virtual_root;
177	int cache_size;
178	int cache_dynamic_ttl;
179	int cache_max_create_time;
180	int cache_repo_ttl;
181	int cache_root_ttl;
182	int cache_scanrc_ttl;
183	int cache_static_ttl;
184	int embedded;
185	int enable_filter_overrides;
186	int enable_index_links;
187	int enable_log_filecount;
188	int enable_log_linecount;
189	int enable_remote_branches;
190	int enable_subject_links;
191	int enable_tree_linenumbers;
192	int local_time;
193	int max_atom_items;
194	int max_repo_count;
195	int max_commit_count;
196	int max_lock_attempts;
197	int max_msg_len;
198	int max_repodesc_len;
199	int max_blob_size;
200	int max_stats;
201	int nocache;
202	int noplainemail;
203	int noheader;
204	int renamelimit;
205	int remove_suffix;
206	int snapshots;
207	int summary_branches;
208	int summary_log;
209	int summary_tags;
210	int ssdiff;
211	struct string_list mimetypes;
212	struct cgit_filter *about_filter;
213	struct cgit_filter *commit_filter;
214	struct cgit_filter *source_filter;
215};
216
217struct cgit_page {
218	time_t modified;
219	time_t expires;
220	size_t size;
221	char *mimetype;
222	char *charset;
223	char *filename;
224	char *etag;
225	char *title;
226	int status;
227	char *statusmsg;
228};
229
230struct cgit_environment {
231	char *cgit_config;
232	char *http_host;
233	char *https;
234	char *no_http;
235	char *path_info;
236	char *query_string;
237	char *request_method;
238	char *script_name;
239	char *server_name;
240	char *server_port;
241};
242
243struct cgit_context {
244	struct cgit_environment env;
245	struct cgit_query qry;
246	struct cgit_config cfg;
247	struct cgit_repo *repo;
248	struct cgit_page page;
249};
250
251struct cgit_snapshot_format {
252	const char *suffix;
253	const char *mimetype;
254	write_archive_fn_t write_func;
255	int bit;
256};
257
258extern const char *cgit_version;
259
260extern struct cgit_repolist cgit_repolist;
261extern struct cgit_context ctx;
262extern const struct cgit_snapshot_format cgit_snapshot_formats[];
263
264extern struct cgit_repo *cgit_add_repo(const char *url);
265extern struct cgit_repo *cgit_get_repoinfo(const char *url);
266extern void cgit_repo_config_cb(const char *name, const char *value);
267
268extern int chk_zero(int result, char *msg);
269extern int chk_positive(int result, char *msg);
270extern int chk_non_negative(int result, char *msg);
271
272extern char *trim_end(const char *str, char c);
273extern char *strlpart(char *txt, int maxlen);
274extern char *strrpart(char *txt, int maxlen);
275
276extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
277extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
278			int flags, void *cb_data);
279
280extern void *cgit_free_commitinfo(struct commitinfo *info);
281
282extern int cgit_diff_files(const unsigned char *old_sha1,
283			   const unsigned char *new_sha1,
284			   unsigned long *old_size, unsigned long *new_size,
285			   int *binary, int context, int ignorews,
286			   linediff_fn fn);
287
288extern void cgit_diff_tree(const unsigned char *old_sha1,
289			   const unsigned char *new_sha1,
290			   filepair_fn fn, const char *prefix, int ignorews);
291
292extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
293
294extern char *fmt(const char *format,...);
295
296extern struct commitinfo *cgit_parse_commit(struct commit *commit);
297extern struct taginfo *cgit_parse_tag(struct tag *tag);
298extern void cgit_parse_url(const char *url);
299
300extern const char *cgit_repobasename(const char *reponame);
301
302extern int cgit_parse_snapshots_mask(const char *str);
303
304extern int cgit_open_filter(struct cgit_filter *filter);
305extern int cgit_close_filter(struct cgit_filter *filter);
306
307extern int readfile(const char *path, char **buf, size_t *size);
308
309extern char *expand_macros(const char *txt);
310
311#endif /* CGIT_H */