blob: ab0efeb45b5385038fbd237767e11ac96bc94a18 [file] [log] [blame]
Lars Hjemli0d169ad2006-12-09 15:18:17 +01001#ifndef CGIT_H
2#define CGIT_H
3
Lars Hjemli61c3ca92007-05-08 22:40:59 +02004
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>
Lars Hjemlia2ebbd62007-11-05 22:27:43 +010019#include <utf8.h>
Lars Hjemli61c3ca92007-05-08 22:40:59 +020020
Lars Hjemli25105d72006-12-10 22:31:36 +010021
Lars Hjemli43d40f22007-05-18 00:50:46 +020022/*
23 * The valid cgit repo-commands
24 */
Lars Hjemli30ccdca2007-05-18 03:00:54 +020025#define CMD_LOG 1
26#define CMD_COMMIT 2
27#define CMD_DIFF 3
28#define CMD_TREE 4
Lars Hjemliffc69732007-06-16 20:20:42 +020029#define CMD_BLOB 5
30#define CMD_SNAPSHOT 6
Lars Hjemli4e9107a2007-07-22 23:42:55 +020031#define CMD_TAG 7
Lars Hjemli7937d062007-10-27 10:36:53 +020032#define CMD_REFS 8
Lars Hjemli5db39172007-05-22 23:08:46 +020033
34/*
35 * Dateformats used on misc. pages
36 */
37#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
38#define FMT_SHORTDATE "%Y-%m-%d"
39
40
41/*
42 * Limits used for relative dates
43 */
44#define TM_MIN 60
45#define TM_HOUR (TM_MIN * 60)
46#define TM_DAY (TM_HOUR * 24)
47#define TM_WEEK (TM_DAY * 7)
48#define TM_YEAR (TM_DAY * 365)
49#define TM_MONTH (TM_YEAR / 12.0)
50
51
Jonathan Bastien-Filiatrault3845e172007-10-26 18:09:06 -040052/*
53 * Default encoding
54 */
55#define PAGE_ENCODING "UTF-8"
56
Lars Hjemli25105d72006-12-10 22:31:36 +010057typedef void (*configfn)(const char *name, const char *value);
Lars Hjemli1b49de32007-05-13 11:24:23 +020058typedef void (*filepair_fn)(struct diff_filepair *pair);
Lars Hjemlic4ef6672007-05-13 14:21:19 +020059typedef void (*linediff_fn)(char *line, int len);
Lars Hjemli25105d72006-12-10 22:31:36 +010060
61struct cacheitem {
62 char *name;
63 struct stat st;
64 int ttl;
65 int fd;
66};
67
Lars Hjemlice1c7332007-02-03 15:02:55 +010068struct repoinfo {
69 char *url;
70 char *name;
71 char *path;
72 char *desc;
73 char *owner;
Lars Hjemlib28b1052007-05-16 00:14:51 +020074 char *defbranch;
Lars Hjemli5877c492007-05-18 22:48:22 +020075 char *group;
Lars Hjemlided93932007-05-11 12:12:48 +020076 char *module_link;
Lars Hjemlibbcdc292007-05-23 22:46:54 +020077 char *readme;
Lars Hjemliac70cb42007-02-08 14:47:56 +010078 int snapshots;
Lars Hjemlie1893442007-05-18 13:55:52 +020079 int enable_log_filecount;
80 int enable_log_linecount;
Lars Hjemlice1c7332007-02-03 15:02:55 +010081};
82
83struct repolist {
84 int length;
85 int count;
86 struct repoinfo *repos;
87};
88
Lars Hjemli2101e262006-12-15 18:17:36 +010089struct commitinfo {
90 struct commit *commit;
91 char *author;
Lars Hjemli77078ba2006-12-16 14:25:41 +010092 char *author_email;
93 unsigned long author_date;
Lars Hjemli2101e262006-12-15 18:17:36 +010094 char *committer;
Lars Hjemli77078ba2006-12-16 14:25:41 +010095 char *committer_email;
96 unsigned long committer_date;
Lars Hjemli2101e262006-12-15 18:17:36 +010097 char *subject;
98 char *msg;
Jonathan Bastien-Filiatrault3845e172007-10-26 18:09:06 -040099 char *msg_encoding;
Lars Hjemli2101e262006-12-15 18:17:36 +0100100};
101
Lars Hjemlia69061f2007-01-17 01:09:51 +0100102struct taginfo {
103 char *tagger;
104 char *tagger_email;
105 int tagger_date;
106 char *msg;
107};
108
Lars Hjemlie397ff72007-10-25 09:30:06 +0200109struct refinfo {
110 const char *refname;
111 struct object *object;
112 union {
113 struct taginfo *tag;
114 struct commitinfo *commit;
115 };
116};
117
118struct reflist {
119 struct refinfo **refs;
120 int alloc;
121 int count;
122};
123
Lars Hjemlif6925032007-06-18 09:42:10 +0200124extern const char *cgit_version;
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100125
Lars Hjemlice1c7332007-02-03 15:02:55 +0100126extern struct repolist cgit_repolist;
127extern struct repoinfo *cgit_repo;
Lars Hjemli30ccdca2007-05-18 03:00:54 +0200128extern int cgit_cmd;
Lars Hjemlice1c7332007-02-03 15:02:55 +0100129
Lars Hjemli25105d72006-12-10 22:31:36 +0100130extern char *cgit_root_title;
131extern char *cgit_css;
132extern char *cgit_logo;
Lars Hjemlide69ce02007-05-19 00:00:25 +0200133extern char *cgit_index_header;
Lars Hjemli10ac7ad2007-10-30 10:39:59 +0100134extern char *cgit_index_info;
Lars Hjemli25105d72006-12-10 22:31:36 +0100135extern char *cgit_logo_link;
Lars Hjemlided93932007-05-11 12:12:48 +0200136extern char *cgit_module_link;
Lars Hjemli57f6a8b2007-05-22 23:25:25 +0200137extern char *cgit_agefile;
Lars Hjemli25105d72006-12-10 22:31:36 +0100138extern char *cgit_virtual_root;
Lars Hjemliea2831f2007-05-15 00:48:31 +0200139extern char *cgit_script_name;
Lars Hjemli25105d72006-12-10 22:31:36 +0100140extern char *cgit_cache_root;
Lars Hjemli5877c492007-05-18 22:48:22 +0200141extern char *cgit_repo_group;
Lars Hjemlid267d882007-11-11 21:57:21 +0100142extern char *cgit_robots;
Lars Hjemli25105d72006-12-10 22:31:36 +0100143
Lars Hjemli521dc7a2006-12-16 13:33:32 +0100144extern int cgit_nocache;
Lars Hjemliac70cb42007-02-08 14:47:56 +0100145extern int cgit_snapshots;
Lars Hjemli0d05bca2007-06-19 00:56:40 +0200146extern int cgit_enable_index_links;
Lars Hjemlie1893442007-05-18 13:55:52 +0200147extern int cgit_enable_log_filecount;
148extern int cgit_enable_log_linecount;
Lars Hjemli318d1062006-12-11 12:10:12 +0100149extern int cgit_max_lock_attempts;
Lars Hjemli25105d72006-12-10 22:31:36 +0100150extern int cgit_cache_root_ttl;
151extern int cgit_cache_repo_ttl;
152extern int cgit_cache_dynamic_ttl;
153extern int cgit_cache_static_ttl;
154extern int cgit_cache_max_create_time;
Ondrej Jirman51a960a2007-05-26 03:33:41 +0200155extern int cgit_summary_log;
Lars Hjemlife211c72007-10-25 10:40:16 +0200156extern int cgit_summary_tags;
Lars Hjemli763a6a02007-10-27 10:13:42 +0200157extern int cgit_summary_branches;
Lars Hjemli25105d72006-12-10 22:31:36 +0100158
Lars Hjemli7dd50c92007-01-28 12:17:03 +0100159extern int cgit_max_msg_len;
Lars Hjemlic1ad6cb2007-05-16 10:45:45 +0200160extern int cgit_max_repodesc_len;
Lars Hjemlic6cf3a42007-05-13 17:15:06 +0200161extern int cgit_max_commit_count;
Lars Hjemli7dd50c92007-01-28 12:17:03 +0100162
Lars Hjemli25105d72006-12-10 22:31:36 +0100163extern int cgit_query_has_symref;
164extern int cgit_query_has_sha1;
165
166extern char *cgit_querystring;
167extern char *cgit_query_repo;
168extern char *cgit_query_page;
Lars Hjemlie39d7382006-12-28 02:01:49 +0100169extern char *cgit_query_search;
Lars Hjemli68ca0322007-10-28 15:23:00 +0100170extern char *cgit_query_grep;
Lars Hjemli25105d72006-12-10 22:31:36 +0100171extern char *cgit_query_head;
172extern char *cgit_query_sha1;
Lars Hjemli36aba002006-12-20 22:48:27 +0100173extern char *cgit_query_sha2;
Lars Hjemli5cd2bf72007-01-12 00:46:17 +0100174extern char *cgit_query_path;
Lars Hjemliab2ab952007-02-08 13:53:13 +0100175extern char *cgit_query_name;
Lars Hjemli420712a2006-12-14 00:40:34 +0100176extern int cgit_query_ofs;
Lars Hjemli25105d72006-12-10 22:31:36 +0100177
178extern int htmlfd;
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100179
Lars Hjemli43d40f22007-05-18 00:50:46 +0200180extern int cgit_get_cmd_index(const char *cmd);
Lars Hjemli305414d2007-05-18 00:47:47 +0200181extern struct repoinfo *cgit_get_repoinfo(const char *url);
Lars Hjemli44923f82006-12-11 17:25:41 +0100182extern void cgit_global_config_cb(const char *name, const char *value);
183extern void cgit_repo_config_cb(const char *name, const char *value);
184extern void cgit_querystring_cb(const char *name, const char *value);
185
Lars Hjemliab2ab952007-02-08 13:53:13 +0100186extern int chk_zero(int result, char *msg);
187extern int chk_positive(int result, char *msg);
Michael Krelin127f43d2007-07-20 20:56:43 +0200188extern int chk_non_negative(int result, char *msg);
Lars Hjemliab2ab952007-02-08 13:53:13 +0100189
Lars Hjemli52e605c2007-01-04 16:53:03 +0100190extern int hextoint(char c);
Lars Hjemli382805e2007-06-26 18:04:31 +0200191extern char *trim_end(const char *str, char c);
Lars Hjemli0c8e1842007-10-30 10:47:38 +0100192extern char *strlpart(char *txt, int maxlen);
193extern char *strrpart(char *txt, int maxlen);
Lars Hjemli52e605c2007-01-04 16:53:03 +0100194
Lars Hjemlie397ff72007-10-25 09:30:06 +0200195extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
196extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
197 int flags, void *cb_data);
198
Lars Hjemliaaa24bd2006-12-16 14:58:20 +0100199extern void *cgit_free_commitinfo(struct commitinfo *info);
Lars Hjemlic4ef6672007-05-13 14:21:19 +0200200
201extern int cgit_diff_files(const unsigned char *old_sha1,
202 const unsigned char *new_sha1,
203 linediff_fn fn);
204
Lars Hjemli1b49de32007-05-13 11:24:23 +0200205extern void cgit_diff_tree(const unsigned char *old_sha1,
206 const unsigned char *new_sha1,
Lars Hjemlif527a572007-10-01 11:42:19 +0200207 filepair_fn fn, const char *prefix);
Lars Hjemlic4ef6672007-05-13 14:21:19 +0200208
Lars Hjemli1b49de32007-05-13 11:24:23 +0200209extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
Lars Hjemliaaa24bd2006-12-16 14:58:20 +0100210
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100211extern char *fmt(const char *format,...);
212
213extern void html(const char *txt);
214extern void htmlf(const char *format,...);
215extern void html_txt(char *txt);
Lars Hjemli9d8d9b62006-12-22 00:58:18 +0100216extern void html_ntxt(int len, char *txt);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100217extern void html_attr(char *txt);
Lars Hjemlie39d7382006-12-28 02:01:49 +0100218extern void html_hidden(char *name, char *value);
Lars Hjemli6ec5f362007-10-28 12:08:45 +0100219extern void html_option(char *value, char *text, char *selected_value);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100220extern void html_link_open(char *url, char *title, char *class);
221extern void html_link_close(void);
Lars Hjemli6cb326c2006-12-17 23:07:28 +0100222extern void html_filemode(unsigned short mode);
Lars Hjemli5e751282007-05-18 23:56:10 +0200223extern int html_include(const char *filename);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100224
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100225extern int cgit_read_config(const char *filename, configfn fn);
Lars Hjemli51ada4f2006-12-11 16:11:40 +0100226extern int cgit_parse_query(char *txt, configfn fn);
Lars Hjemli2101e262006-12-15 18:17:36 +0100227extern struct commitinfo *cgit_parse_commit(struct commit *commit);
Lars Hjemlia69061f2007-01-17 01:09:51 +0100228extern struct taginfo *cgit_parse_tag(struct tag *tag);
Lars Hjemli30ccdca2007-05-18 03:00:54 +0200229extern void cgit_parse_url(const char *url);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100230
Lars Hjemli2c2047f2007-01-12 00:24:35 +0100231extern char *cache_safe_filename(const char *unsafe);
Lars Hjemli25105d72006-12-10 22:31:36 +0100232extern int cache_lock(struct cacheitem *item);
233extern int cache_unlock(struct cacheitem *item);
Lars Hjemlifbaf1172006-12-11 22:53:50 +0100234extern int cache_cancel_lock(struct cacheitem *item);
Lars Hjemlif5069d82006-12-11 09:57:58 +0100235extern int cache_exist(struct cacheitem *item);
Lars Hjemli25105d72006-12-10 22:31:36 +0100236extern int cache_expired(struct cacheitem *item);
237
Lars Hjemli74620f12006-12-11 16:48:03 +0100238extern char *cgit_repourl(const char *reponame);
Michael Krelin0df096f2007-07-21 13:13:40 +0200239extern char *cgit_fileurl(const char *reponame, const char *pagename,
240 const char *filename, const char *query);
Lars Hjemlif9ff7df2007-05-16 00:58:35 +0200241extern char *cgit_pageurl(const char *reponame, const char *pagename,
Lars Hjemli74620f12006-12-11 16:48:03 +0100242 const char *query);
243
Michael Krelin1cb8bed2007-07-21 15:24:07 +0200244extern const char *cgit_repobasename(const char *reponame);
245
Lars Hjemli44947bf2007-06-17 01:23:08 +0200246extern void cgit_tree_link(char *name, char *title, char *class, char *head,
247 char *rev, char *path);
Lars Hjemli48c487d2007-06-17 13:57:51 +0200248extern void cgit_log_link(char *name, char *title, char *class, char *head,
Lars Hjemli51140312007-11-03 10:42:37 +0100249 char *rev, char *path, int ofs, char *grep,
250 char *pattern);
Lars Hjemli42a7eb92007-06-17 14:53:02 +0200251extern void cgit_commit_link(char *name, char *title, char *class, char *head,
252 char *rev);
Lars Hjemliac1f4932007-10-27 10:47:44 +0200253extern void cgit_refs_link(char *name, char *title, char *class, char *head,
254 char *rev, char *path);
Lars Hjemlieb453422007-07-23 00:11:15 +0200255extern void cgit_snapshot_link(char *name, char *title, char *class,
256 char *head, char *rev, char *archivename);
Lars Hjemli4a0be582007-06-17 18:12:03 +0200257extern void cgit_diff_link(char *name, char *title, char *class, char *head,
258 char *new_rev, char *old_rev, char *path);
Lars Hjemli44947bf2007-06-17 01:23:08 +0200259
Lars Hjemli4e9107a2007-07-22 23:42:55 +0200260extern void cgit_object_link(struct object *obj);
261
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100262extern void cgit_print_error(char *msg);
Lars Hjemli5db39172007-05-22 23:08:46 +0200263extern void cgit_print_date(time_t secs, char *format);
264extern void cgit_print_age(time_t t, time_t max_relative, char *format);
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100265extern void cgit_print_docstart(char *title, struct cacheitem *item);
266extern void cgit_print_docend();
Lars Hjemlie39d7382006-12-28 02:01:49 +0100267extern void cgit_print_pageheader(char *title, int show_search);
Lars Hjemlif9ff7df2007-05-16 00:58:35 +0200268extern void cgit_print_snapshot_start(const char *mimetype,
269 const char *filename,
Lars Hjemliab2ab952007-02-08 13:53:13 +0100270 struct cacheitem *item);
Lars Hjemli8efb05f2007-10-27 10:25:40 +0200271extern void cgit_print_branches(int maxcount);
272extern void cgit_print_tags(int maxcount);
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100273
Lars Hjemli74620f12006-12-11 16:48:03 +0100274extern void cgit_print_repolist(struct cacheitem *item);
Lars Hjemlid14c5f62006-12-11 17:04:19 +0100275extern void cgit_print_summary();
Lars Hjemli68ca0322007-10-28 15:23:00 +0100276extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep,
277 char *pattern, char *path, int pager);
Lars Hjemlica8eb8f2007-05-09 00:48:09 +0200278extern void cgit_print_blob(struct cacheitem *item, const char *hex, char *path);
Lars Hjemliffc69732007-06-16 20:20:42 +0200279extern void cgit_print_tree(const char *rev, char *path);
Lars Hjemli4a0be582007-06-17 18:12:03 +0200280extern void cgit_print_commit(char *hex);
Lars Hjemli7937d062007-10-27 10:36:53 +0200281extern void cgit_print_refs();
Lars Hjemli4e9107a2007-07-22 23:42:55 +0200282extern void cgit_print_tag(char *revname);
Lars Hjemli1a6025b2007-10-01 11:46:38 +0200283extern void cgit_print_diff(const char *new_hex, const char *old_hex, const char *prefix);
Lars Hjemlieb453422007-07-23 00:11:15 +0200284extern void cgit_print_snapshot(struct cacheitem *item, const char *head,
285 const char *hex, const char *prefix,
286 const char *filename, int snapshot);
287extern void cgit_print_snapshot_links(const char *repo, const char *head,
288 const char *hex, int snapshots);
Michael Krelindc3c9b52007-07-21 18:00:53 +0200289extern int cgit_parse_snapshots_mask(const char *str);
Lars Hjemli74620f12006-12-11 16:48:03 +0100290
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100291#endif /* CGIT_H */