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