all repos — cgit @ 7710178e45dee61e85ea77c4221309ce8c086f95

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