all repos — cgit @ 1415f3f3e017d0123e850707c55cb7e5e5887406

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