all repos — cgit @ 670f99097939a08510c2c909cd38f8083800861a

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