]> git.cameronkatri.com Git - cgit.git/blob - cgit.h
Add setting to enable/disable extra links on index page
[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
20
21 /*
22 * The valid cgit repo-commands
23 */
24 #define CMD_LOG 1
25 #define CMD_COMMIT 2
26 #define CMD_DIFF 3
27 #define CMD_TREE 4
28 #define CMD_BLOB 5
29 #define CMD_SNAPSHOT 6
30
31
32 /*
33 * Dateformats used on misc. pages
34 */
35 #define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
36 #define FMT_SHORTDATE "%Y-%m-%d"
37
38
39 /*
40 * Limits used for relative dates
41 */
42 #define TM_MIN 60
43 #define TM_HOUR (TM_MIN * 60)
44 #define TM_DAY (TM_HOUR * 24)
45 #define TM_WEEK (TM_DAY * 7)
46 #define TM_YEAR (TM_DAY * 365)
47 #define TM_MONTH (TM_YEAR / 12.0)
48
49
50 typedef void (*configfn)(const char *name, const char *value);
51 typedef void (*filepair_fn)(struct diff_filepair *pair);
52 typedef void (*linediff_fn)(char *line, int len);
53
54 struct cacheitem {
55 char *name;
56 struct stat st;
57 int ttl;
58 int fd;
59 };
60
61 struct repoinfo {
62 char *url;
63 char *name;
64 char *path;
65 char *desc;
66 char *owner;
67 char *defbranch;
68 char *group;
69 char *module_link;
70 char *readme;
71 int snapshots;
72 int enable_log_filecount;
73 int enable_log_linecount;
74 };
75
76 struct repolist {
77 int length;
78 int count;
79 struct repoinfo *repos;
80 };
81
82 struct commitinfo {
83 struct commit *commit;
84 char *author;
85 char *author_email;
86 unsigned long author_date;
87 char *committer;
88 char *committer_email;
89 unsigned long committer_date;
90 char *subject;
91 char *msg;
92 };
93
94 struct taginfo {
95 char *tagger;
96 char *tagger_email;
97 int tagger_date;
98 char *msg;
99 };
100
101 extern const char cgit_version[];
102
103 extern struct repolist cgit_repolist;
104 extern struct repoinfo *cgit_repo;
105 extern int cgit_cmd;
106
107 extern char *cgit_root_title;
108 extern char *cgit_css;
109 extern char *cgit_logo;
110 extern char *cgit_index_header;
111 extern char *cgit_logo_link;
112 extern char *cgit_module_link;
113 extern char *cgit_agefile;
114 extern char *cgit_virtual_root;
115 extern char *cgit_script_name;
116 extern char *cgit_cache_root;
117 extern char *cgit_repo_group;
118
119 extern int cgit_nocache;
120 extern int cgit_snapshots;
121 extern int cgit_enable_index_links;
122 extern int cgit_enable_log_filecount;
123 extern int cgit_enable_log_linecount;
124 extern int cgit_max_lock_attempts;
125 extern int cgit_cache_root_ttl;
126 extern int cgit_cache_repo_ttl;
127 extern int cgit_cache_dynamic_ttl;
128 extern int cgit_cache_static_ttl;
129 extern int cgit_cache_max_create_time;
130 extern int cgit_summary_log;
131
132 extern int cgit_max_msg_len;
133 extern int cgit_max_repodesc_len;
134 extern int cgit_max_commit_count;
135
136 extern int cgit_query_has_symref;
137 extern int cgit_query_has_sha1;
138
139 extern char *cgit_querystring;
140 extern char *cgit_query_repo;
141 extern char *cgit_query_page;
142 extern char *cgit_query_search;
143 extern char *cgit_query_head;
144 extern char *cgit_query_sha1;
145 extern char *cgit_query_sha2;
146 extern char *cgit_query_path;
147 extern char *cgit_query_name;
148 extern int cgit_query_ofs;
149
150 extern int htmlfd;
151
152 extern int cgit_get_cmd_index(const char *cmd);
153 extern struct repoinfo *cgit_get_repoinfo(const char *url);
154 extern void cgit_global_config_cb(const char *name, const char *value);
155 extern void cgit_repo_config_cb(const char *name, const char *value);
156 extern void cgit_querystring_cb(const char *name, const char *value);
157
158 extern int chk_zero(int result, char *msg);
159 extern int chk_positive(int result, char *msg);
160
161 extern int hextoint(char c);
162
163 extern void *cgit_free_commitinfo(struct commitinfo *info);
164
165 extern int cgit_diff_files(const unsigned char *old_sha1,
166 const unsigned char *new_sha1,
167 linediff_fn fn);
168
169 extern void cgit_diff_tree(const unsigned char *old_sha1,
170 const unsigned char *new_sha1,
171 filepair_fn fn);
172
173 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
174
175 extern char *fmt(const char *format,...);
176
177 extern void html(const char *txt);
178 extern void htmlf(const char *format,...);
179 extern void html_txt(char *txt);
180 extern void html_ntxt(int len, char *txt);
181 extern void html_attr(char *txt);
182 extern void html_hidden(char *name, char *value);
183 extern void html_link_open(char *url, char *title, char *class);
184 extern void html_link_close(void);
185 extern void html_filemode(unsigned short mode);
186 extern int html_include(const char *filename);
187
188 extern int cgit_read_config(const char *filename, configfn fn);
189 extern int cgit_parse_query(char *txt, configfn fn);
190 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
191 extern struct taginfo *cgit_parse_tag(struct tag *tag);
192 extern void cgit_parse_url(const char *url);
193
194 extern char *cache_safe_filename(const char *unsafe);
195 extern int cache_lock(struct cacheitem *item);
196 extern int cache_unlock(struct cacheitem *item);
197 extern int cache_cancel_lock(struct cacheitem *item);
198 extern int cache_exist(struct cacheitem *item);
199 extern int cache_expired(struct cacheitem *item);
200
201 extern char *cgit_repourl(const char *reponame);
202 extern char *cgit_pageurl(const char *reponame, const char *pagename,
203 const char *query);
204
205 extern void cgit_tree_link(char *name, char *title, char *class, char *head,
206 char *rev, char *path);
207 extern void cgit_log_link(char *name, char *title, char *class, char *head,
208 char *rev, char *path);
209 extern void cgit_commit_link(char *name, char *title, char *class, char *head,
210 char *rev);
211 extern void cgit_diff_link(char *name, char *title, char *class, char *head,
212 char *new_rev, char *old_rev, char *path);
213
214 extern void cgit_print_error(char *msg);
215 extern void cgit_print_date(time_t secs, char *format);
216 extern void cgit_print_age(time_t t, time_t max_relative, char *format);
217 extern void cgit_print_docstart(char *title, struct cacheitem *item);
218 extern void cgit_print_docend();
219 extern void cgit_print_pageheader(char *title, int show_search);
220 extern void cgit_print_snapshot_start(const char *mimetype,
221 const char *filename,
222 struct cacheitem *item);
223
224 extern void cgit_print_repolist(struct cacheitem *item);
225 extern void cgit_print_summary();
226 extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep, char *path, int pager);
227 extern void cgit_print_blob(struct cacheitem *item, const char *hex, char *path);
228 extern void cgit_print_tree(const char *rev, char *path);
229 extern void cgit_print_commit(char *hex);
230 extern void cgit_print_diff(const char *new_hex, const char *old_hex);
231 extern void cgit_print_snapshot(struct cacheitem *item, const char *hex,
232 const char *format, const char *prefix,
233 const char *filename);
234
235 #endif /* CGIT_H */