all repos — cgit @ 2273c2c821bfc77d492d7e97ae38f162d7fc91aa

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 max_stats;
 76	time_t mtime;
 77	struct cgit_filter *about_filter;
 78	struct cgit_filter *commit_filter;
 79	struct cgit_filter *source_filter;
 80};
 81
 82typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
 83	      const char *value);
 84
 85struct cgit_repolist {
 86	int length;
 87	int count;
 88	struct cgit_repo *repos;
 89};
 90
 91struct commitinfo {
 92	struct commit *commit;
 93	char *author;
 94	char *author_email;
 95	unsigned long author_date;
 96	char *committer;
 97	char *committer_email;
 98	unsigned long committer_date;
 99	char *subject;
100	char *msg;
101	char *msg_encoding;
102};
103
104struct taginfo {
105	char *tagger;
106	char *tagger_email;
107	unsigned long tagger_date;
108	char *msg;
109};
110
111struct refinfo {
112	const char *refname;
113	struct object *object;
114	union {
115		struct taginfo *tag;
116		struct commitinfo *commit;
117	};
118};
119
120struct reflist {
121	struct refinfo **refs;
122	int alloc;
123	int count;
124};
125
126struct cgit_query {
127	int has_symref;
128	int has_sha1;
129	char *raw;
130	char *repo;
131	char *page;
132	char *search;
133	char *grep;
134	char *head;
135	char *sha1;
136	char *sha2;
137	char *path;
138	char *name;
139	char *mimetype;
140	char *url;
141	char *period;
142	int   ofs;
143	int nohead;
144	char *sort;
145	int showmsg;
146};
147
148struct cgit_config {
149	char *agefile;
150	char *cache_root;
151	char *clone_prefix;
152	char *css;
153	char *favicon;
154	char *footer;
155	char *head_include;
156	char *header;
157	char *index_header;
158	char *index_info;
159	char *logo;
160	char *logo_link;
161	char *module_link;
162	char *robots;
163	char *root_title;
164	char *root_desc;
165	char *root_readme;
166	char *script_name;
167	char *section;
168	char *virtual_root;
169	int cache_size;
170	int cache_dynamic_ttl;
171	int cache_max_create_time;
172	int cache_repo_ttl;
173	int cache_root_ttl;
174	int cache_scanrc_ttl;
175	int cache_static_ttl;
176	int embedded;
177	int enable_filter_overrides;
178	int enable_index_links;
179	int enable_log_filecount;
180	int enable_log_linecount;
181	int local_time;
182	int max_repo_count;
183	int max_commit_count;
184	int max_lock_attempts;
185	int max_msg_len;
186	int max_repodesc_len;
187	int max_stats;
188	int nocache;
189	int noplainemail;
190	int noheader;
191	int renamelimit;
192	int snapshots;
193	int summary_branches;
194	int summary_log;
195	int summary_tags;
196	struct string_list mimetypes;
197	struct cgit_filter *about_filter;
198	struct cgit_filter *commit_filter;
199	struct cgit_filter *source_filter;
200};
201
202struct cgit_page {
203	time_t modified;
204	time_t expires;
205	size_t size;
206	char *mimetype;
207	char *charset;
208	char *filename;
209	char *etag;
210	char *title;
211	int status;
212	char *statusmsg;
213};
214
215struct cgit_environment {
216	char *cgit_config;
217	char *http_host;
218	char *https;
219	char *no_http;
220	char *path_info;
221	char *query_string;
222	char *request_method;
223	char *script_name;
224	char *server_name;
225	char *server_port;
226};
227
228struct cgit_context {
229	struct cgit_environment env;
230	struct cgit_query qry;
231	struct cgit_config cfg;
232	struct cgit_repo *repo;
233	struct cgit_page page;
234};
235
236struct cgit_snapshot_format {
237	const char *suffix;
238	const char *mimetype;
239	write_archive_fn_t write_func;
240	int bit;
241};
242
243extern const char *cgit_version;
244
245extern struct cgit_repolist cgit_repolist;
246extern struct cgit_context ctx;
247extern const struct cgit_snapshot_format cgit_snapshot_formats[];
248
249extern struct cgit_repo *cgit_add_repo(const char *url);
250extern struct cgit_repo *cgit_get_repoinfo(const char *url);
251extern void cgit_repo_config_cb(const char *name, const char *value);
252
253extern int chk_zero(int result, char *msg);
254extern int chk_positive(int result, char *msg);
255extern int chk_non_negative(int result, char *msg);
256
257extern char *trim_end(const char *str, char c);
258extern char *strlpart(char *txt, int maxlen);
259extern char *strrpart(char *txt, int maxlen);
260
261extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
262extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
263			int flags, void *cb_data);
264
265extern void *cgit_free_commitinfo(struct commitinfo *info);
266
267extern int cgit_diff_files(const unsigned char *old_sha1,
268			   const unsigned char *new_sha1,
269			   unsigned long *old_size, unsigned long *new_size,
270			   int *binary, linediff_fn fn);
271
272extern void cgit_diff_tree(const unsigned char *old_sha1,
273			   const unsigned char *new_sha1,
274			   filepair_fn fn, const char *prefix);
275
276extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
277
278extern char *fmt(const char *format,...);
279
280extern struct commitinfo *cgit_parse_commit(struct commit *commit);
281extern struct taginfo *cgit_parse_tag(struct tag *tag);
282extern void cgit_parse_url(const char *url);
283
284extern const char *cgit_repobasename(const char *reponame);
285
286extern int cgit_parse_snapshots_mask(const char *str);
287
288extern int cgit_open_filter(struct cgit_filter *filter);
289extern int cgit_close_filter(struct cgit_filter *filter);
290
291extern int readfile(const char *path, char **buf, size_t *size);
292
293#endif /* CGIT_H */