1#ifndef CGIT_H
  2#define CGIT_H
  3
  4
  5#include <git-compat-util.h>
  6#include <stdbool.h>
  7
  8#include <cache.h>
  9#include <grep.h>
 10#include <object.h>
 11#include <tree.h>
 12#include <commit.h>
 13#include <tag.h>
 14#include <diff.h>
 15#include <diffcore.h>
 16#include <argv-array.h>
 17#include <refs.h>
 18#include <revision.h>
 19#include <log-tree.h>
 20#include <archive.h>
 21#include <string-list.h>
 22#include <xdiff-interface.h>
 23#include <xdiff/xdiff.h>
 24#include <utf8.h>
 25#include <notes.h>
 26#include <graph.h>
 27
 28/* Add isgraph(x) to Git's sane ctype support (see git-compat-util.h) */
 29#undef isgraph
 30#define isgraph(x) (isprint((x)) && !isspace((x)))
 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
 53typedef enum {
 54	DIFF_UNIFIED, DIFF_SSDIFF, DIFF_STATONLY
 55} diff_type;
 56
 57typedef enum {
 58	ABOUT, COMMIT, SOURCE, EMAIL, AUTH, OWNER
 59} filter_type;
 60
 61struct cgit_filter {
 62	int (*open)(struct cgit_filter *, va_list ap);
 63	int (*close)(struct cgit_filter *);
 64	void (*fprintf)(struct cgit_filter *, FILE *, const char *prefix);
 65	void (*cleanup)(struct cgit_filter *);
 66	int argument_count;
 67};
 68
 69struct cgit_exec_filter {
 70	struct cgit_filter base;
 71	char *cmd;
 72	char **argv;
 73	int old_stdout;
 74	int pipe_fh[2];
 75	int pid;
 76};
 77
 78struct cgit_repo {
 79	char *url;
 80	char *name;
 81	char *path;
 82	char *desc;
 83	char *owner;
 84	char *homepage;
 85	char *defbranch;
 86	char *module_link;
 87	struct string_list readme;
 88	char *section;
 89	char *clone_url;
 90	char *logo;
 91	char *logo_link;
 92	int snapshots;
 93	int enable_commit_graph;
 94	int enable_log_filecount;
 95	int enable_log_linecount;
 96	int enable_remote_branches;
 97	int enable_subject_links;
 98	int enable_html_serving;
 99	int max_stats;
100	int branch_sort;
101	int commit_sort;
102	time_t mtime;
103	struct cgit_filter *about_filter;
104	struct cgit_filter *commit_filter;
105	struct cgit_filter *source_filter;
106	struct cgit_filter *email_filter;
107	struct cgit_filter *owner_filter;
108	struct string_list submodules;
109	int hide;
110	int ignore;
111};
112
113typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
114	      const char *value);
115
116struct cgit_repolist {
117	int length;
118	int count;
119	struct cgit_repo *repos;
120};
121
122struct commitinfo {
123	struct commit *commit;
124	char *author;
125	char *author_email;
126	unsigned long author_date;
127	int author_tz;
128	char *committer;
129	char *committer_email;
130	unsigned long committer_date;
131	int committer_tz;
132	char *subject;
133	char *msg;
134	char *msg_encoding;
135};
136
137struct taginfo {
138	char *tagger;
139	char *tagger_email;
140	unsigned long tagger_date;
141	int tagger_tz;
142	char *msg;
143};
144
145struct refinfo {
146	const char *refname;
147	struct object *object;
148	union {
149		struct taginfo *tag;
150		struct commitinfo *commit;
151	};
152};
153
154struct reflist {
155	struct refinfo **refs;
156	int alloc;
157	int count;
158};
159
160struct cgit_query {
161	int has_symref;
162	int has_sha1;
163	int has_difftype;
164	char *raw;
165	char *repo;
166	char *page;
167	char *search;
168	char *grep;
169	char *head;
170	char *sha1;
171	char *sha2;
172	char *path;
173	char *name;
174	char *url;
175	char *period;
176	int   ofs;
177	int nohead;
178	char *sort;
179	int showmsg;
180	diff_type difftype;
181	int show_all;
182	int context;
183	int ignorews;
184	int follow;
185	char *vpath;
186};
187
188struct cgit_config {
189	char *agefile;
190	char *cache_root;
191	char *clone_prefix;
192	char *clone_url;
193	char *css;
194	char *favicon;
195	char *footer;
196	char *head_include;
197	char *header;
198	char *index_header;
199	char *index_info;
200	char *logo;
201	char *logo_link;
202	char *mimetype_file;
203	char *module_link;
204	char *project_list;
205	struct string_list readme;
206	char *robots;
207	char *root_title;
208	char *root_desc;
209	char *root_readme;
210	char *script_name;
211	char *section;
212	char *repository_sort;
213	char *virtual_root;	/* Always ends with '/'. */
214	char *strict_export;
215	int cache_size;
216	int cache_dynamic_ttl;
217	int cache_max_create_time;
218	int cache_repo_ttl;
219	int cache_root_ttl;
220	int cache_scanrc_ttl;
221	int cache_static_ttl;
222	int cache_about_ttl;
223	int cache_snapshot_ttl;
224	int case_sensitive_sort;
225	int embedded;
226	int enable_filter_overrides;
227	int enable_follow_links;
228	int enable_http_clone;
229	int enable_index_links;
230	int enable_index_owner;
231	int enable_commit_graph;
232	int enable_log_filecount;
233	int enable_log_linecount;
234	int enable_remote_branches;
235	int enable_subject_links;
236	int enable_html_serving;
237	int enable_tree_linenumbers;
238	int enable_git_config;
239	int local_time;
240	int max_atom_items;
241	int max_repo_count;
242	int max_commit_count;
243	int max_lock_attempts;
244	int max_msg_len;
245	int max_repodesc_len;
246	int max_blob_size;
247	int max_stats;
248	int nocache;
249	int noplainemail;
250	int noheader;
251	int renamelimit;
252	int remove_suffix;
253	int scan_hidden_path;
254	int section_from_path;
255	int snapshots;
256	int section_sort;
257	int summary_branches;
258	int summary_log;
259	int summary_tags;
260	diff_type difftype;
261	int branch_sort;
262	int commit_sort;
263	struct string_list mimetypes;
264	struct cgit_filter *about_filter;
265	struct cgit_filter *commit_filter;
266	struct cgit_filter *source_filter;
267	struct cgit_filter *email_filter;
268	struct cgit_filter *owner_filter;
269	struct cgit_filter *auth_filter;
270};
271
272struct cgit_page {
273	time_t modified;
274	time_t expires;
275	size_t size;
276	const char *mimetype;
277	const char *charset;
278	const char *filename;
279	const char *etag;
280	const char *title;
281	int status;
282	const char *statusmsg;
283};
284
285struct cgit_environment {
286	const char *cgit_config;
287	const char *http_host;
288	const char *https;
289	const char *no_http;
290	const char *path_info;
291	const char *query_string;
292	const char *request_method;
293	const char *script_name;
294	const char *server_name;
295	const char *server_port;
296	const char *http_cookie;
297	const char *http_referer;
298	unsigned int content_length;
299	int authenticated;
300};
301
302struct cgit_context {
303	struct cgit_environment env;
304	struct cgit_query qry;
305	struct cgit_config cfg;
306	struct cgit_repo *repo;
307	struct cgit_page page;
308};
309
310typedef int (*write_archive_fn_t)(const char *, const char *);
311
312struct cgit_snapshot_format {
313	const char *suffix;
314	const char *mimetype;
315	write_archive_fn_t write_func;
316	int bit;
317};
318
319extern const char *cgit_version;
320
321extern struct cgit_repolist cgit_repolist;
322extern struct cgit_context ctx;
323extern const struct cgit_snapshot_format cgit_snapshot_formats[];
324
325extern char *cgit_default_repo_desc;
326extern struct cgit_repo *cgit_add_repo(const char *url);
327extern struct cgit_repo *cgit_get_repoinfo(const char *url);
328extern void cgit_repo_config_cb(const char *name, const char *value);
329
330extern int chk_zero(int result, char *msg);
331extern int chk_positive(int result, char *msg);
332extern int chk_non_negative(int result, char *msg);
333
334extern char *trim_end(const char *str, char c);
335extern char *ensure_end(const char *str, char c);
336
337extern void strbuf_ensure_end(struct strbuf *sb, char c);
338
339extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
340extern void cgit_free_reflist_inner(struct reflist *list);
341extern int cgit_refs_cb(const char *refname, const struct object_id *oid,
342			int flags, void *cb_data);
343
344extern void cgit_free_commitinfo(struct commitinfo *info);
345extern void cgit_free_taginfo(struct taginfo *info);
346
347void cgit_diff_tree_cb(struct diff_queue_struct *q,
348		       struct diff_options *options, void *data);
349
350extern int cgit_diff_files(const struct object_id *old_oid,
351			   const struct object_id *new_oid,
352			   unsigned long *old_size, unsigned long *new_size,
353			   int *binary, int context, int ignorews,
354			   linediff_fn fn);
355
356extern void cgit_diff_tree(const struct object_id *old_oid,
357			   const struct object_id *new_oid,
358			   filepair_fn fn, const char *prefix, int ignorews);
359
360extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,
361			     const char *prefix);
362
363__attribute__((format (printf,1,2)))
364extern char *fmt(const char *format,...);
365
366__attribute__((format (printf,1,2)))
367extern char *fmtalloc(const char *format,...);
368
369extern struct commitinfo *cgit_parse_commit(struct commit *commit);
370extern struct taginfo *cgit_parse_tag(struct tag *tag);
371extern void cgit_parse_url(const char *url);
372
373extern const char *cgit_repobasename(const char *reponame);
374
375extern int cgit_parse_snapshots_mask(const char *str);
376
377extern int cgit_open_filter(struct cgit_filter *filter, ...);
378extern int cgit_close_filter(struct cgit_filter *filter);
379extern void cgit_fprintf_filter(struct cgit_filter *filter, FILE *f, const char *prefix);
380extern void cgit_exec_filter_init(struct cgit_exec_filter *filter, char *cmd, char **argv);
381extern struct cgit_filter *cgit_new_filter(const char *cmd, filter_type filtertype);
382extern void cgit_cleanup_filters(void);
383extern void cgit_init_filters(void);
384
385extern void cgit_prepare_repo_env(struct cgit_repo * repo);
386
387extern int readfile(const char *path, char **buf, size_t *size);
388
389extern char *expand_macros(const char *txt);
390
391extern char *get_mimetype_for_filename(const char *filename);
392
393#endif /* CGIT_H */