]> git.cameronkatri.com Git - cgit.git/blob - cgit.h
Add support for including a footer on all pages
[cgit.git] / cgit.h
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
45 typedef void (*configfn)(const char *name, const char *value);
46 typedef void (*filepair_fn)(struct diff_filepair *pair);
47 typedef void (*linediff_fn)(char *line, int len);
48
49 struct 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
65 struct cgit_repolist {
66 int length;
67 int count;
68 struct cgit_repo *repos;
69 };
70
71 struct 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
84 struct taginfo {
85 char *tagger;
86 char *tagger_email;
87 int tagger_date;
88 char *msg;
89 };
90
91 struct refinfo {
92 const char *refname;
93 struct object *object;
94 union {
95 struct taginfo *tag;
96 struct commitinfo *commit;
97 };
98 };
99
100 struct reflist {
101 struct refinfo **refs;
102 int alloc;
103 int count;
104 };
105
106 struct 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
123 struct cgit_config {
124 char *agefile;
125 char *cache_root;
126 char *clone_prefix;
127 char *css;
128 char *footer;
129 char *index_header;
130 char *index_info;
131 char *logo;
132 char *logo_link;
133 char *module_link;
134 char *repo_group;
135 char *robots;
136 char *root_title;
137 char *root_desc;
138 char *root_readme;
139 char *script_name;
140 char *virtual_root;
141 int cache_size;
142 int cache_dynamic_ttl;
143 int cache_max_create_time;
144 int cache_repo_ttl;
145 int cache_root_ttl;
146 int cache_static_ttl;
147 int enable_index_links;
148 int enable_log_filecount;
149 int enable_log_linecount;
150 int max_repo_count;
151 int max_commit_count;
152 int max_lock_attempts;
153 int max_msg_len;
154 int max_repodesc_len;
155 int nocache;
156 int renamelimit;
157 int snapshots;
158 int summary_branches;
159 int summary_log;
160 int summary_tags;
161 };
162
163 struct cgit_page {
164 time_t modified;
165 time_t expires;
166 char *mimetype;
167 char *charset;
168 char *filename;
169 char *title;
170 };
171
172 struct cgit_context {
173 struct cgit_query qry;
174 struct cgit_config cfg;
175 struct cgit_repo *repo;
176 struct cgit_page page;
177 };
178
179 struct cgit_snapshot_format {
180 const char *suffix;
181 const char *mimetype;
182 write_archive_fn_t write_func;
183 int bit;
184 };
185
186 extern const char *cgit_version;
187
188 extern struct cgit_repolist cgit_repolist;
189 extern struct cgit_context ctx;
190 extern const struct cgit_snapshot_format cgit_snapshot_formats[];
191
192 extern struct cgit_repo *cgit_add_repo(const char *url);
193 extern struct cgit_repo *cgit_get_repoinfo(const char *url);
194 extern void cgit_repo_config_cb(const char *name, const char *value);
195
196 extern int chk_zero(int result, char *msg);
197 extern int chk_positive(int result, char *msg);
198 extern int chk_non_negative(int result, char *msg);
199
200 extern char *trim_end(const char *str, char c);
201 extern char *strlpart(char *txt, int maxlen);
202 extern char *strrpart(char *txt, int maxlen);
203
204 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
205 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
206 int flags, void *cb_data);
207
208 extern void *cgit_free_commitinfo(struct commitinfo *info);
209
210 extern int cgit_diff_files(const unsigned char *old_sha1,
211 const unsigned char *new_sha1,
212 linediff_fn fn);
213
214 extern void cgit_diff_tree(const unsigned char *old_sha1,
215 const unsigned char *new_sha1,
216 filepair_fn fn, const char *prefix);
217
218 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
219
220 extern char *fmt(const char *format,...);
221
222 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
223 extern struct taginfo *cgit_parse_tag(struct tag *tag);
224 extern void cgit_parse_url(const char *url);
225
226 extern const char *cgit_repobasename(const char *reponame);
227
228 extern int cgit_parse_snapshots_mask(const char *str);
229
230 /* libgit.a either links against or compiles its own implementation of
231 * strcasestr(), and we'd like to reuse it. Simply re-declaring it
232 * seems to do the trick.
233 */
234 extern char *strcasestr(const char *haystack, const char *needle);
235
236
237 #endif /* CGIT_H */