all repos — cgit @ 9c8be943f72b6f1bda5a31ce401899c3dd734e98

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	time_t mtime;
 65};
 66
 67struct cgit_repolist {
 68	int length;
 69	int count;
 70	struct cgit_repo *repos;
 71};
 72
 73struct commitinfo {
 74	struct commit *commit;
 75	char *author;
 76	char *author_email;
 77	unsigned long author_date;
 78	char *committer;
 79	char *committer_email;
 80	unsigned long committer_date;
 81	char *subject;
 82	char *msg;
 83	char *msg_encoding;
 84};
 85
 86struct taginfo {
 87	char *tagger;
 88	char *tagger_email;
 89	unsigned long tagger_date;
 90	char *msg;
 91};
 92
 93struct refinfo {
 94	const char *refname;
 95	struct object *object;
 96	union {
 97		struct taginfo *tag;
 98		struct commitinfo *commit;
 99	};
100};
101
102struct reflist {
103	struct refinfo **refs;
104	int alloc;
105	int count;
106};
107
108struct cgit_query {
109	int has_symref;
110	int has_sha1;
111	char *raw;
112	char *repo;
113	char *page;
114	char *search;
115	char *grep;
116	char *head;
117	char *sha1;
118	char *sha2;
119	char *path;
120	char *name;
121	char *mimetype;
122	char *url;
123	int   ofs;
124	int nohead;
125	char *sort;
126};
127
128struct cgit_config {
129	char *agefile;
130	char *cache_root;
131	char *clone_prefix;
132	char *css;
133	char *favicon;
134	char *footer;
135	char *index_header;
136	char *index_info;
137	char *logo;
138	char *logo_link;
139	char *module_link;
140	char *repo_group;
141	char *robots;
142	char *root_title;
143	char *root_desc;
144	char *root_readme;
145	char *script_name;
146	char *virtual_root;
147	int cache_size;
148	int cache_dynamic_ttl;
149	int cache_max_create_time;
150	int cache_repo_ttl;
151	int cache_root_ttl;
152	int cache_static_ttl;
153	int enable_index_links;
154	int enable_log_filecount;
155	int enable_log_linecount;
156	int local_time;
157	int max_repo_count;
158	int max_commit_count;
159	int max_lock_attempts;
160	int max_msg_len;
161	int max_repodesc_len;
162	int nocache;
163	int renamelimit;
164	int snapshots;
165	int summary_branches;
166	int summary_log;
167	int summary_tags;
168};
169
170struct cgit_page {
171	time_t modified;
172	time_t expires;
173	size_t size;
174	char *mimetype;
175	char *charset;
176	char *filename;
177	char *title;
178};
179
180struct cgit_context {
181	struct cgit_query qry;
182	struct cgit_config cfg;
183	struct cgit_repo *repo;
184	struct cgit_page page;
185};
186
187struct cgit_snapshot_format {
188	const char *suffix;
189	const char *mimetype;
190	write_archive_fn_t write_func;
191	int bit;
192};
193
194extern const char *cgit_version;
195
196extern struct cgit_repolist cgit_repolist;
197extern struct cgit_context ctx;
198extern const struct cgit_snapshot_format cgit_snapshot_formats[];
199
200extern struct cgit_repo *cgit_add_repo(const char *url);
201extern struct cgit_repo *cgit_get_repoinfo(const char *url);
202extern void cgit_repo_config_cb(const char *name, const char *value);
203
204extern int chk_zero(int result, char *msg);
205extern int chk_positive(int result, char *msg);
206extern int chk_non_negative(int result, char *msg);
207
208extern char *trim_end(const char *str, char c);
209extern char *strlpart(char *txt, int maxlen);
210extern char *strrpart(char *txt, int maxlen);
211
212extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
213extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
214			int flags, void *cb_data);
215
216extern void *cgit_free_commitinfo(struct commitinfo *info);
217
218extern int cgit_diff_files(const unsigned char *old_sha1,
219			   const unsigned char *new_sha1,
220			   linediff_fn fn);
221
222extern void cgit_diff_tree(const unsigned char *old_sha1,
223			   const unsigned char *new_sha1,
224			   filepair_fn fn, const char *prefix);
225
226extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
227
228extern char *fmt(const char *format,...);
229
230extern struct commitinfo *cgit_parse_commit(struct commit *commit);
231extern struct taginfo *cgit_parse_tag(struct tag *tag);
232extern void cgit_parse_url(const char *url);
233
234extern const char *cgit_repobasename(const char *reponame);
235
236extern int cgit_parse_snapshots_mask(const char *str);
237
238
239#endif /* CGIT_H */