blob: 4576efb5903a5a7ba59dd26281370154103b99b4 [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 Hjemli620bb3e2007-12-10 21:47:29 +010033#define CMD_PATCH 9
Lars Hjemli5db39172007-05-22 23:08:46 +020034
35/*
36 * Dateformats used on misc. pages
37 */
38#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
39#define FMT_SHORTDATE "%Y-%m-%d"
40
41
42/*
43 * Limits used for relative dates
44 */
45#define TM_MIN 60
46#define TM_HOUR (TM_MIN * 60)
47#define TM_DAY (TM_HOUR * 24)
48#define TM_WEEK (TM_DAY * 7)
49#define TM_YEAR (TM_DAY * 365)
50#define TM_MONTH (TM_YEAR / 12.0)
51
52
Jonathan Bastien-Filiatrault3845e172007-10-26 18:09:06 -040053/*
54 * Default encoding
55 */
56#define PAGE_ENCODING "UTF-8"
57
Lars Hjemli25105d72006-12-10 22:31:36 +010058typedef void (*configfn)(const char *name, const char *value);
Lars Hjemli1b49de32007-05-13 11:24:23 +020059typedef void (*filepair_fn)(struct diff_filepair *pair);
Lars Hjemlic4ef6672007-05-13 14:21:19 +020060typedef void (*linediff_fn)(char *line, int len);
Lars Hjemli25105d72006-12-10 22:31:36 +010061
62struct cacheitem {
63 char *name;
64 struct stat st;
65 int ttl;
66 int fd;
67};
68
Lars Hjemlice1c7332007-02-03 15:02:55 +010069struct repoinfo {
70 char *url;
71 char *name;
72 char *path;
73 char *desc;
74 char *owner;
Lars Hjemlib28b1052007-05-16 00:14:51 +020075 char *defbranch;
Lars Hjemli5877c492007-05-18 22:48:22 +020076 char *group;
Lars Hjemlided93932007-05-11 12:12:48 +020077 char *module_link;
Lars Hjemlibbcdc292007-05-23 22:46:54 +020078 char *readme;
Lars Hjemliafcdd082007-12-03 01:49:38 +010079 char *clone_url;
Lars Hjemliac70cb42007-02-08 14:47:56 +010080 int snapshots;
Lars Hjemlie1893442007-05-18 13:55:52 +020081 int enable_log_filecount;
82 int enable_log_linecount;
Lars Hjemlice1c7332007-02-03 15:02:55 +010083};
84
85struct repolist {
86 int length;
87 int count;
88 struct repoinfo *repos;
89};
90
Lars Hjemli2101e262006-12-15 18:17:36 +010091struct commitinfo {
92 struct commit *commit;
93 char *author;
Lars Hjemli77078ba2006-12-16 14:25:41 +010094 char *author_email;
95 unsigned long author_date;
Lars Hjemli2101e262006-12-15 18:17:36 +010096 char *committer;
Lars Hjemli77078ba2006-12-16 14:25:41 +010097 char *committer_email;
98 unsigned long committer_date;
Lars Hjemli2101e262006-12-15 18:17:36 +010099 char *subject;
100 char *msg;
Jonathan Bastien-Filiatrault3845e172007-10-26 18:09:06 -0400101 char *msg_encoding;
Lars Hjemli2101e262006-12-15 18:17:36 +0100102};
103
Lars Hjemlia69061f2007-01-17 01:09:51 +0100104struct taginfo {
105 char *tagger;
106 char *tagger_email;
107 int tagger_date;
108 char *msg;
109};
110
Lars Hjemlie397ff72007-10-25 09:30:06 +0200111struct refinfo {
112 const char *refname;
113 struct object *object;
114 union {
115 struct taginfo *tag;
116 struct commitinfo *commit;
117 };
118};
119
120struct reflist {
121 struct refinfo **refs;
122 int alloc;
123 int count;
124};
125
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100126struct cgit_query {
127 int has_symref;
128 int has_sha1;
129 char *raw;
130 char *repo;
131 char *page;
132 char *search;
133 char *grep;
134 char *head;
135 char *sha1;
136 char *sha2;
137 char *path;
138 char *name;
139 int ofs;
140};
141
142struct cgit_context {
143 struct cgit_query qry;
144};
145
Lars Hjemlif6925032007-06-18 09:42:10 +0200146extern const char *cgit_version;
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100147
Lars Hjemlice1c7332007-02-03 15:02:55 +0100148extern struct repolist cgit_repolist;
149extern struct repoinfo *cgit_repo;
Lars Hjemlid14d77f2008-02-16 11:53:40 +0100150extern struct cgit_context ctx;
Lars Hjemli30ccdca2007-05-18 03:00:54 +0200151extern int cgit_cmd;
Lars Hjemlice1c7332007-02-03 15:02:55 +0100152
Lars Hjemli25105d72006-12-10 22:31:36 +0100153extern char *cgit_root_title;
154extern char *cgit_css;
155extern char *cgit_logo;
Lars Hjemlide69ce02007-05-19 00:00:25 +0200156extern char *cgit_index_header;
Lars Hjemli10ac7ad2007-10-30 10:39:59 +0100157extern char *cgit_index_info;
Lars Hjemli25105d72006-12-10 22:31:36 +0100158extern char *cgit_logo_link;
Lars Hjemlided93932007-05-11 12:12:48 +0200159extern char *cgit_module_link;
Lars Hjemli57f6a8b2007-05-22 23:25:25 +0200160extern char *cgit_agefile;
Lars Hjemli25105d72006-12-10 22:31:36 +0100161extern char *cgit_virtual_root;
Lars Hjemliea2831f2007-05-15 00:48:31 +0200162extern char *cgit_script_name;
Lars Hjemli25105d72006-12-10 22:31:36 +0100163extern char *cgit_cache_root;
Lars Hjemli5877c492007-05-18 22:48:22 +0200164extern char *cgit_repo_group;
Lars Hjemlid267d882007-11-11 21:57:21 +0100165extern char *cgit_robots;
Lars Hjemliafcdd082007-12-03 01:49:38 +0100166extern char *cgit_clone_prefix;
Lars Hjemli25105d72006-12-10 22:31:36 +0100167
Lars Hjemli521dc7a2006-12-16 13:33:32 +0100168extern int cgit_nocache;
Lars Hjemliac70cb42007-02-08 14:47:56 +0100169extern int cgit_snapshots;
Lars Hjemli0d05bca2007-06-19 00:56:40 +0200170extern int cgit_enable_index_links;
Lars Hjemlie1893442007-05-18 13:55:52 +0200171extern int cgit_enable_log_filecount;
172extern int cgit_enable_log_linecount;
Lars Hjemli318d1062006-12-11 12:10:12 +0100173extern int cgit_max_lock_attempts;
Lars Hjemli25105d72006-12-10 22:31:36 +0100174extern int cgit_cache_root_ttl;
175extern int cgit_cache_repo_ttl;
176extern int cgit_cache_dynamic_ttl;
177extern int cgit_cache_static_ttl;
178extern int cgit_cache_max_create_time;
Ondrej Jirman51a960a2007-05-26 03:33:41 +0200179extern int cgit_summary_log;
Lars Hjemlife211c72007-10-25 10:40:16 +0200180extern int cgit_summary_tags;
Lars Hjemli763a6a02007-10-27 10:13:42 +0200181extern int cgit_summary_branches;
Lars Hjemli25105d72006-12-10 22:31:36 +0100182
Lars Hjemli7dd50c92007-01-28 12:17:03 +0100183extern int cgit_max_msg_len;
Lars Hjemlic1ad6cb2007-05-16 10:45:45 +0200184extern int cgit_max_repodesc_len;
Lars Hjemlic6cf3a42007-05-13 17:15:06 +0200185extern int cgit_max_commit_count;
Lars Hjemli7dd50c92007-01-28 12:17:03 +0100186
Lars Hjemli25105d72006-12-10 22:31:36 +0100187
188extern int htmlfd;
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100189
Lars Hjemli43d40f22007-05-18 00:50:46 +0200190extern int cgit_get_cmd_index(const char *cmd);
Lars Hjemli305414d2007-05-18 00:47:47 +0200191extern struct repoinfo *cgit_get_repoinfo(const char *url);
Lars Hjemli44923f82006-12-11 17:25:41 +0100192extern void cgit_global_config_cb(const char *name, const char *value);
193extern void cgit_repo_config_cb(const char *name, const char *value);
194extern void cgit_querystring_cb(const char *name, const char *value);
195
Lars Hjemliab2ab952007-02-08 13:53:13 +0100196extern int chk_zero(int result, char *msg);
197extern int chk_positive(int result, char *msg);
Michael Krelin127f43d2007-07-20 20:56:43 +0200198extern int chk_non_negative(int result, char *msg);
Lars Hjemliab2ab952007-02-08 13:53:13 +0100199
Lars Hjemli52e605c2007-01-04 16:53:03 +0100200extern int hextoint(char c);
Lars Hjemli382805e2007-06-26 18:04:31 +0200201extern char *trim_end(const char *str, char c);
Lars Hjemli0c8e1842007-10-30 10:47:38 +0100202extern char *strlpart(char *txt, int maxlen);
203extern char *strrpart(char *txt, int maxlen);
Lars Hjemli52e605c2007-01-04 16:53:03 +0100204
Lars Hjemlie397ff72007-10-25 09:30:06 +0200205extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
206extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
207 int flags, void *cb_data);
208
Lars Hjemliaaa24bd2006-12-16 14:58:20 +0100209extern void *cgit_free_commitinfo(struct commitinfo *info);
Lars Hjemlic4ef6672007-05-13 14:21:19 +0200210
211extern int cgit_diff_files(const unsigned char *old_sha1,
212 const unsigned char *new_sha1,
213 linediff_fn fn);
214
Lars Hjemli1b49de32007-05-13 11:24:23 +0200215extern void cgit_diff_tree(const unsigned char *old_sha1,
216 const unsigned char *new_sha1,
Lars Hjemlif527a572007-10-01 11:42:19 +0200217 filepair_fn fn, const char *prefix);
Lars Hjemlic4ef6672007-05-13 14:21:19 +0200218
Lars Hjemli1b49de32007-05-13 11:24:23 +0200219extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
Lars Hjemliaaa24bd2006-12-16 14:58:20 +0100220
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100221extern char *fmt(const char *format,...);
222
223extern void html(const char *txt);
224extern void htmlf(const char *format,...);
225extern void html_txt(char *txt);
Lars Hjemli9d8d9b62006-12-22 00:58:18 +0100226extern void html_ntxt(int len, char *txt);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100227extern void html_attr(char *txt);
Lars Hjemlie39d7382006-12-28 02:01:49 +0100228extern void html_hidden(char *name, char *value);
Lars Hjemli6ec5f362007-10-28 12:08:45 +0100229extern void html_option(char *value, char *text, char *selected_value);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100230extern void html_link_open(char *url, char *title, char *class);
231extern void html_link_close(void);
Lars Hjemli6cb326c2006-12-17 23:07:28 +0100232extern void html_filemode(unsigned short mode);
Lars Hjemli5e751282007-05-18 23:56:10 +0200233extern int html_include(const char *filename);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100234
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100235extern int cgit_read_config(const char *filename, configfn fn);
Lars Hjemli51ada4f2006-12-11 16:11:40 +0100236extern int cgit_parse_query(char *txt, configfn fn);
Lars Hjemli2101e262006-12-15 18:17:36 +0100237extern struct commitinfo *cgit_parse_commit(struct commit *commit);
Lars Hjemlia69061f2007-01-17 01:09:51 +0100238extern struct taginfo *cgit_parse_tag(struct tag *tag);
Lars Hjemli30ccdca2007-05-18 03:00:54 +0200239extern void cgit_parse_url(const char *url);
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100240
Lars Hjemli2c2047f2007-01-12 00:24:35 +0100241extern char *cache_safe_filename(const char *unsafe);
Lars Hjemli25105d72006-12-10 22:31:36 +0100242extern int cache_lock(struct cacheitem *item);
243extern int cache_unlock(struct cacheitem *item);
Lars Hjemlifbaf1172006-12-11 22:53:50 +0100244extern int cache_cancel_lock(struct cacheitem *item);
Lars Hjemlif5069d82006-12-11 09:57:58 +0100245extern int cache_exist(struct cacheitem *item);
Lars Hjemli25105d72006-12-10 22:31:36 +0100246extern int cache_expired(struct cacheitem *item);
247
Lars Hjemli74620f12006-12-11 16:48:03 +0100248extern char *cgit_repourl(const char *reponame);
Michael Krelin0df096f2007-07-21 13:13:40 +0200249extern char *cgit_fileurl(const char *reponame, const char *pagename,
250 const char *filename, const char *query);
Lars Hjemlif9ff7df2007-05-16 00:58:35 +0200251extern char *cgit_pageurl(const char *reponame, const char *pagename,
Lars Hjemli74620f12006-12-11 16:48:03 +0100252 const char *query);
253
Michael Krelin1cb8bed2007-07-21 15:24:07 +0200254extern const char *cgit_repobasename(const char *reponame);
255
Lars Hjemli44947bf2007-06-17 01:23:08 +0200256extern void cgit_tree_link(char *name, char *title, char *class, char *head,
257 char *rev, char *path);
Lars Hjemli48c487d2007-06-17 13:57:51 +0200258extern void cgit_log_link(char *name, char *title, char *class, char *head,
Lars Hjemli51140312007-11-03 10:42:37 +0100259 char *rev, char *path, int ofs, char *grep,
260 char *pattern);
Lars Hjemli42a7eb92007-06-17 14:53:02 +0200261extern void cgit_commit_link(char *name, char *title, char *class, char *head,
262 char *rev);
Lars Hjemliac1f4932007-10-27 10:47:44 +0200263extern void cgit_refs_link(char *name, char *title, char *class, char *head,
264 char *rev, char *path);
Lars Hjemlieb453422007-07-23 00:11:15 +0200265extern void cgit_snapshot_link(char *name, char *title, char *class,
266 char *head, char *rev, char *archivename);
Lars Hjemli4a0be582007-06-17 18:12:03 +0200267extern void cgit_diff_link(char *name, char *title, char *class, char *head,
268 char *new_rev, char *old_rev, char *path);
Lars Hjemli44947bf2007-06-17 01:23:08 +0200269
Lars Hjemli4e9107a2007-07-22 23:42:55 +0200270extern void cgit_object_link(struct object *obj);
271
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100272extern void cgit_print_error(char *msg);
Lars Hjemli5db39172007-05-22 23:08:46 +0200273extern void cgit_print_date(time_t secs, char *format);
274extern void cgit_print_age(time_t t, time_t max_relative, char *format);
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100275extern void cgit_print_docstart(char *title, struct cacheitem *item);
276extern void cgit_print_docend();
Lars Hjemlie39d7382006-12-28 02:01:49 +0100277extern void cgit_print_pageheader(char *title, int show_search);
Lars Hjemlif9ff7df2007-05-16 00:58:35 +0200278extern void cgit_print_snapshot_start(const char *mimetype,
279 const char *filename,
Lars Hjemliab2ab952007-02-08 13:53:13 +0100280 struct cacheitem *item);
Lars Hjemli8efb05f2007-10-27 10:25:40 +0200281extern void cgit_print_branches(int maxcount);
282extern void cgit_print_tags(int maxcount);
Lars Hjemli5a106eb2006-12-11 16:38:30 +0100283
Lars Hjemli74620f12006-12-11 16:48:03 +0100284extern void cgit_print_repolist(struct cacheitem *item);
Lars Hjemlid14c5f62006-12-11 17:04:19 +0100285extern void cgit_print_summary();
Lars Hjemli68ca0322007-10-28 15:23:00 +0100286extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep,
287 char *pattern, char *path, int pager);
Lars Hjemlica8eb8f2007-05-09 00:48:09 +0200288extern void cgit_print_blob(struct cacheitem *item, const char *hex, char *path);
Lars Hjemliffc69732007-06-16 20:20:42 +0200289extern void cgit_print_tree(const char *rev, char *path);
Lars Hjemli4a0be582007-06-17 18:12:03 +0200290extern void cgit_print_commit(char *hex);
Lars Hjemli7937d062007-10-27 10:36:53 +0200291extern void cgit_print_refs();
Lars Hjemli4e9107a2007-07-22 23:42:55 +0200292extern void cgit_print_tag(char *revname);
Lars Hjemli1a6025b2007-10-01 11:46:38 +0200293extern void cgit_print_diff(const char *new_hex, const char *old_hex, const char *prefix);
Lars Hjemli620bb3e2007-12-10 21:47:29 +0100294extern void cgit_print_patch(char *hex, struct cacheitem *item);
Lars Hjemlieb453422007-07-23 00:11:15 +0200295extern void cgit_print_snapshot(struct cacheitem *item, const char *head,
296 const char *hex, const char *prefix,
297 const char *filename, int snapshot);
298extern void cgit_print_snapshot_links(const char *repo, const char *head,
299 const char *hex, int snapshots);
Michael Krelindc3c9b52007-07-21 18:00:53 +0200300extern int cgit_parse_snapshots_mask(const char *str);
Lars Hjemli74620f12006-12-11 16:48:03 +0100301
Lars Hjemli0d169ad2006-12-09 15:18:17 +0100302#endif /* CGIT_H */