all repos — cgit @ a75968df103a938656599e0d2d9fd1ab4de5ea8a

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 <xdiff/xdiff.h>
 19#include <utf8.h>
 20
 21
 22/*
 23 * Dateformats used on misc. pages
 24 */
 25#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
 26#define FMT_SHORTDATE "%Y-%m-%d"
 27
 28
 29/*
 30 * Limits used for relative dates
 31 */
 32#define TM_MIN    60
 33#define TM_HOUR  (TM_MIN * 60)
 34#define TM_DAY   (TM_HOUR * 24)
 35#define TM_WEEK  (TM_DAY * 7)
 36#define TM_YEAR  (TM_DAY * 365)
 37#define TM_MONTH (TM_YEAR / 12.0)
 38
 39
 40/*
 41 * Default encoding
 42 */
 43#define PAGE_ENCODING "UTF-8"
 44
 45typedef void (*configfn)(const char *name, const char *value);
 46typedef void (*filepair_fn)(struct diff_filepair *pair);
 47typedef void (*linediff_fn)(char *line, int len);
 48
 49struct cgit_repo {
 50	char *url;
 51	char *name;
 52	char *path;
 53	char *desc;
 54	char *owner;
 55	char *defbranch;
 56	char *group;
 57	char *module_link;
 58	char *readme;
 59	char *clone_url;
 60	int snapshots;
 61	int enable_log_filecount;
 62	int enable_log_linecount;
 63};
 64
 65struct cgit_repolist {
 66	int length;
 67	int count;
 68	struct cgit_repo *repos;
 69};
 70
 71struct commitinfo {
 72	struct commit *commit;
 73	char *author;
 74	char *author_email;
 75	unsigned long author_date;
 76	char *committer;
 77	char *committer_email;
 78	unsigned long committer_date;
 79	char *subject;
 80	char *msg;
 81	char *msg_encoding;
 82};
 83
 84struct taginfo {
 85	char *tagger;
 86	char *tagger_email;
 87	int tagger_date;
 88	char *msg;
 89};
 90
 91struct refinfo {
 92	const char *refname;
 93	struct object *object;
 94	union {
 95		struct taginfo *tag;
 96		struct commitinfo *commit;
 97	};
 98};
 99
100struct reflist {
101	struct refinfo **refs;
102	int alloc;
103	int count;
104};
105
106struct cgit_query {
107	int has_symref;
108	int has_sha1;
109	char *raw;
110	char *repo;
111	char *page;
112	char *search;
113	char *grep;
114	char *head;
115	char *sha1;
116	char *sha2;
117	char *path;
118	char *name;
119	char *mimetype;
120	int   ofs;
121};
122
123struct cgit_config {
124	char *agefile;
125	char *cache_root;
126	char *clone_prefix;
127	char *css;
128	char *favicon;
129	char *footer;
130	char *index_header;
131	char *index_info;
132	char *logo;
133	char *logo_link;
134	char *module_link;
135	char *repo_group;
136	char *robots;
137	char *root_title;
138	char *root_desc;
139	char *root_readme;
140	char *script_name;
141	char *virtual_root;
142	int cache_size;
143	int cache_dynamic_ttl;
144	int cache_max_create_time;
145	int cache_repo_ttl;
146	int cache_root_ttl;
147	int cache_static_ttl;
148	int enable_index_links;
149	int enable_log_filecount;
150	int enable_log_linecount;
151	int max_repo_count;
152	int max_commit_count;
153	int max_lock_attempts;
154	int max_msg_len;
155	int max_repodesc_len;
156	int nocache;
157	int renamelimit;
158	int snapshots;
159	int summary_branches;
160	int summary_log;
161	int summary_tags;
162};
163
164struct cgit_page {
165	time_t modified;
166	time_t expires;
167	char *mimetype;
168	char *charset;
169	char *filename;
170	char *title;
171};
172
173struct cgit_context {
174	struct cgit_query qry;
175	struct cgit_config cfg;
176	struct cgit_repo *repo;
177	struct cgit_page page;
178};
179
180struct cgit_snapshot_format {
181	const char *suffix;
182	const char *mimetype;
183	write_archive_fn_t write_func;
184	int bit;
185};
186
187extern const char *cgit_version;
188
189extern struct cgit_repolist cgit_repolist;
190extern struct cgit_context ctx;
191extern const struct cgit_snapshot_format cgit_snapshot_formats[];
192
193extern struct cgit_repo *cgit_add_repo(const char *url);
194extern struct cgit_repo *cgit_get_repoinfo(const char *url);
195extern void cgit_repo_config_cb(const char *name, const char *value);
196
197extern int chk_zero(int result, char *msg);
198extern int chk_positive(int result, char *msg);
199extern int chk_non_negative(int result, char *msg);
200
201extern char *trim_end(const char *str, char c);
202extern char *strlpart(char *txt, int maxlen);
203extern char *strrpart(char *txt, int maxlen);
204
205extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
206extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
207			int flags, void *cb_data);
208
209extern void *cgit_free_commitinfo(struct commitinfo *info);
210
211extern int cgit_diff_files(const unsigned char *old_sha1,
212			   const unsigned char *new_sha1,
213			   linediff_fn fn);
214
215extern void cgit_diff_tree(const unsigned char *old_sha1,
216			   const unsigned char *new_sha1,
217			   filepair_fn fn, const char *prefix);
218
219extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
220
221extern char *fmt(const char *format,...);
222
223extern struct commitinfo *cgit_parse_commit(struct commit *commit);
224extern struct taginfo *cgit_parse_tag(struct tag *tag);
225extern void cgit_parse_url(const char *url);
226
227extern const char *cgit_repobasename(const char *reponame);
228
229extern int cgit_parse_snapshots_mask(const char *str);
230
231/* libgit.a either links against or compiles its own implementation of
232 * strcasestr(), and we'd like to reuse it. Simply re-declaring it
233 * seems to do the trick.
234 */
235extern char *strcasestr(const char *haystack, const char *needle);
236
237
238#endif /* CGIT_H */