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  * The valid cgit repo-commands
  24  */
  25 #define CMD_LOG      1
  26 #define CMD_COMMIT   2
  27 #define CMD_DIFF     3
  28 #define CMD_TREE     4
  29 #define CMD_BLOB     5
  30 #define CMD_SNAPSHOT 6
  31 #define CMD_TAG      7
  32 #define CMD_REFS     8
  33
  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
  52 /*
  53  * Default encoding
  54  */
  55 #define PAGE_ENCODING "UTF-8"
  56
  57 typedef void (*configfn)(const char *name, const char *value);
  58 typedef void (*filepair_fn)(struct diff_filepair *pair);
  59 typedef void (*linediff_fn)(char *line, int len);
  60
  61 struct cacheitem {
  62         char *name;
  63         struct stat st;
  64         int ttl;
  65         int fd;
  66 };
  67
  68 struct repoinfo {
  69         char *url;
  70         char *name;
  71         char *path;
  72         char *desc;
  73         char *owner;
  74         char *defbranch;
  75         char *group;
  76         char *module_link;
  77         char *readme;
  78         char *clone_url;
  79         int snapshots;
  80         int enable_log_filecount;
  81         int enable_log_linecount;
  82 };
  83
  84 struct repolist {
  85         int length;
  86         int count;
  87         struct repoinfo *repos;
  88 };
  89
  90 struct commitinfo {
  91         struct commit *commit;
  92         char *author;
  93         char *author_email;
  94         unsigned long author_date;
  95         char *committer;
  96         char *committer_email;
  97         unsigned long committer_date;
  98         char *subject;
  99         char *msg;
 100         char *msg_encoding;
 101 };
 102
 103 struct taginfo {
 104         char *tagger;
 105         char *tagger_email;
 106         int tagger_date;
 107         char *msg;
 108 };
 109
 110 struct refinfo {
 111         const char *refname;
 112         struct object *object;
 113         union {
 114                 struct taginfo *tag;
 115                 struct commitinfo *commit;
 116         };
 117 };
 118
 119 struct reflist {
 120         struct refinfo **refs;
 121         int alloc;
 122         int count;
 123 };
 124
 125 extern const char *cgit_version;
 126
 127 extern struct repolist cgit_repolist;
 128 extern struct repoinfo *cgit_repo;
 129 extern int cgit_cmd;
 130
 131 extern char *cgit_root_title;
 132 extern char *cgit_css;
 133 extern char *cgit_logo;
 134 extern char *cgit_index_header;
 135 extern char *cgit_index_info;
 136 extern char *cgit_logo_link;
 137 extern char *cgit_module_link;
 138 extern char *cgit_agefile;
 139 extern char *cgit_virtual_root;
 140 extern char *cgit_script_name;
 141 extern char *cgit_cache_root;
 142 extern char *cgit_repo_group;
 143 extern char *cgit_robots;
 144 extern char *cgit_clone_prefix;
 145
 146 extern int cgit_nocache;
 147 extern int cgit_snapshots;
 148 extern int cgit_enable_index_links;
 149 extern int cgit_enable_log_filecount;
 150 extern int cgit_enable_log_linecount;
 151 extern int cgit_max_lock_attempts;
 152 extern int cgit_cache_root_ttl;
 153 extern int cgit_cache_repo_ttl;
 154 extern int cgit_cache_dynamic_ttl;
 155 extern int cgit_cache_static_ttl;
 156 extern int cgit_cache_max_create_time;
 157 extern int cgit_summary_log;
 158 extern int cgit_summary_tags;
 159 extern int cgit_summary_branches;
 160
 161 extern int cgit_max_msg_len;
 162 extern int cgit_max_repodesc_len;
 163 extern int cgit_max_commit_count;
 164
 165 extern int cgit_query_has_symref;
 166 extern int cgit_query_has_sha1;
 167
 168 extern char *cgit_querystring;
 169 extern char *cgit_query_repo;
 170 extern char *cgit_query_page;
 171 extern char *cgit_query_search;
 172 extern char *cgit_query_grep;
 173 extern char *cgit_query_head;
 174 extern char *cgit_query_sha1;
 175 extern char *cgit_query_sha2;
 176 extern char *cgit_query_path;
 177 extern char *cgit_query_name;
 178 extern int   cgit_query_ofs;
 179
 180 extern int htmlfd;
 181
 182 extern int cgit_get_cmd_index(const char *cmd);
 183 extern struct repoinfo *cgit_get_repoinfo(const char *url);
 184 extern void cgit_global_config_cb(const char *name, const char *value);
 185 extern void cgit_repo_config_cb(const char *name, const char *value);
 186 extern void cgit_querystring_cb(const char *name, const char *value);
 187
 188 extern int chk_zero(int result, char *msg);
 189 extern int chk_positive(int result, char *msg);
 190 extern int chk_non_negative(int result, char *msg);
 191
 192 extern int hextoint(char c);
 193 extern char *trim_end(const char *str, char c);
 194 extern char *strlpart(char *txt, int maxlen);
 195 extern char *strrpart(char *txt, int maxlen);
 196
 197 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
 198 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
 199                         int flags, void *cb_data);
 200
 201 extern void *cgit_free_commitinfo(struct commitinfo *info);
 202
 203 extern int cgit_diff_files(const unsigned char *old_sha1,
 204                            const unsigned char *new_sha1,
 205                            linediff_fn fn);
 206
 207 extern void cgit_diff_tree(const unsigned char *old_sha1,
 208                            const unsigned char *new_sha1,
 209                            filepair_fn fn, const char *prefix);
 210
 211 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
 212
 213 extern char *fmt(const char *format,...);
 214
 215 extern void html(const char *txt);
 216 extern void htmlf(const char *format,...);
 217 extern void html_txt(char *txt);
 218 extern void html_ntxt(int len, char *txt);
 219 extern void html_attr(char *txt);
 220 extern void html_hidden(char *name, char *value);
 221 extern void html_option(char *value, char *text, char *selected_value);
 222 extern void html_link_open(char *url, char *title, char *class);
 223 extern void html_link_close(void);
 224 extern void html_filemode(unsigned short mode);
 225 extern int html_include(const char *filename);
 226
 227 extern int cgit_read_config(const char *filename, configfn fn);
 228 extern int cgit_parse_query(char *txt, configfn fn);
 229 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
 230 extern struct taginfo *cgit_parse_tag(struct tag *tag);
 231 extern void cgit_parse_url(const char *url);
 232
 233 extern char *cache_safe_filename(const char *unsafe);
 234 extern int cache_lock(struct cacheitem *item);
 235 extern int cache_unlock(struct cacheitem *item);
 236 extern int cache_cancel_lock(struct cacheitem *item);
 237 extern int cache_exist(struct cacheitem *item);
 238 extern int cache_expired(struct cacheitem *item);
 239
 240 extern char *cgit_repourl(const char *reponame);
 241 extern char *cgit_fileurl(const char *reponame, const char *pagename,
 242                           const char *filename, const char *query);
 243 extern char *cgit_pageurl(const char *reponame, const char *pagename,
 244                           const char *query);
 245
 246 extern const char *cgit_repobasename(const char *reponame);
 247
 248 extern void cgit_tree_link(char *name, char *title, char *class, char *head,
 249                            char *rev, char *path);
 250 extern void cgit_log_link(char *name, char *title, char *class, char *head,
 251                           char *rev, char *path, int ofs, char *grep,
 252                           char *pattern);
 253 extern void cgit_commit_link(char *name, char *title, char *class, char *head,
 254                              char *rev);
 255 extern void cgit_refs_link(char *name, char *title, char *class, char *head,
 256                            char *rev, char *path);
 257 extern void cgit_snapshot_link(char *name, char *title, char *class,
 258                                char *head, char *rev, char *archivename);
 259 extern void cgit_diff_link(char *name, char *title, char *class, char *head,
 260                            char *new_rev, char *old_rev, char *path);
 261
 262 extern void cgit_object_link(struct object *obj);
 263
 264 extern void cgit_print_error(char *msg);
 265 extern void cgit_print_date(time_t secs, char *format);
 266 extern void cgit_print_age(time_t t, time_t max_relative, char *format);
 267 extern void cgit_print_docstart(char *title, struct cacheitem *item);
 268 extern void cgit_print_docend();
 269 extern void cgit_print_pageheader(char *title, int show_search);
 270 extern void cgit_print_snapshot_start(const char *mimetype,
 271                                       const char *filename,
 272                                       struct cacheitem *item);
 273 extern void cgit_print_branches(int maxcount);
 274 extern void cgit_print_tags(int maxcount);
 275
 276 extern void cgit_print_repolist(struct cacheitem *item);
 277 extern void cgit_print_summary();
 278 extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep,
 279                            char *pattern, char *path, int pager);
 280 extern void cgit_print_blob(struct cacheitem *item, const char *hex, char *path);
 281 extern void cgit_print_tree(const char *rev, char *path);
 282 extern void cgit_print_commit(char *hex);
 283 extern void cgit_print_refs();
 284 extern void cgit_print_tag(char *revname);
 285 extern void cgit_print_diff(const char *new_hex, const char *old_hex, const char *prefix);
 286 extern void cgit_print_snapshot(struct cacheitem *item, const char *head,
 287                                 const char *hex, const char *prefix,
 288                                 const char *filename, int snapshot);
 289 extern void cgit_print_snapshot_links(const char *repo, const char *head,
 290                                       const char *hex, int snapshots);
 291 extern int cgit_parse_snapshots_mask(const char *str);
 292
 293 #endif /* CGIT_H */