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-interface.h>
  19 #include <xdiff/xdiff.h>
  20 #include <utf8.h>
  21
  22
  23 /*
  24  * Dateformats used on misc. pages
  25  */
  26 #define FMT_LONGDATE "%Y-%m-%d %H:%M:%S (%Z)"
  27 #define FMT_SHORTDATE "%Y-%m-%d"
  28 #define FMT_ATOMDATE "%Y-%m-%dT%H:%M:%SZ"
  29
  30
  31 /*
  32  * Limits used for relative dates
  33  */
  34 #define TM_MIN    60
  35 #define TM_HOUR  (TM_MIN * 60)
  36 #define TM_DAY   (TM_HOUR * 24)
  37 #define TM_WEEK  (TM_DAY * 7)
  38 #define TM_YEAR  (TM_DAY * 365)
  39 #define TM_MONTH (TM_YEAR / 12.0)
  40
  41
  42 /*
  43  * Default encoding
  44  */
  45 #define PAGE_ENCODING "UTF-8"
  46
  47 typedef void (*configfn)(const char *name, const char *value);
  48 typedef void (*filepair_fn)(struct diff_filepair *pair);
  49 typedef void (*linediff_fn)(char *line, int len);
  50
  51 struct cgit_repo {
  52         char *url;
  53         char *name;
  54         char *path;
  55         char *desc;
  56         char *owner;
  57         char *defbranch;
  58         char *group;
  59         char *module_link;
  60         char *readme;
  61         char *clone_url;
  62         int snapshots;
  63         int enable_log_filecount;
  64         int enable_log_linecount;
  65         int max_stats;
  66         time_t mtime;
  67 };
  68
  69 struct cgit_repolist {
  70         int length;
  71         int count;
  72         struct cgit_repo *repos;
  73 };
  74
  75 struct commitinfo {
  76         struct commit *commit;
  77         char *author;
  78         char *author_email;
  79         unsigned long author_date;
  80         char *committer;
  81         char *committer_email;
  82         unsigned long committer_date;
  83         char *subject;
  84         char *msg;
  85         char *msg_encoding;
  86 };
  87
  88 struct taginfo {
  89         char *tagger;
  90         char *tagger_email;
  91         unsigned long tagger_date;
  92         char *msg;
  93 };
  94
  95 struct refinfo {
  96         const char *refname;
  97         struct object *object;
  98         union {
  99                 struct taginfo *tag;
 100                 struct commitinfo *commit;
 101         };
 102 };
 103
 104 struct reflist {
 105         struct refinfo **refs;
 106         int alloc;
 107         int count;
 108 };
 109
 110 struct cgit_query {
 111         int has_symref;
 112         int has_sha1;
 113         char *raw;
 114         char *repo;
 115         char *page;
 116         char *search;
 117         char *grep;
 118         char *head;
 119         char *sha1;
 120         char *sha2;
 121         char *path;
 122         char *name;
 123         char *mimetype;
 124         char *url;
 125         char *period;
 126         int   ofs;
 127         int nohead;
 128         char *sort;
 129         int showmsg;
 130 };
 131
 132 struct cgit_config {
 133         char *agefile;
 134         char *cache_root;
 135         char *clone_prefix;
 136         char *css;
 137         char *favicon;
 138         char *footer;
 139         char *head_include;
 140         char *header;
 141         char *index_header;
 142         char *index_info;
 143         char *logo;
 144         char *logo_link;
 145         char *module_link;
 146         char *repo_group;
 147         char *robots;
 148         char *root_title;
 149         char *root_desc;
 150         char *root_readme;
 151         char *script_name;
 152         char *virtual_root;
 153         int cache_size;
 154         int cache_dynamic_ttl;
 155         int cache_max_create_time;
 156         int cache_repo_ttl;
 157         int cache_root_ttl;
 158         int cache_static_ttl;
 159         int embedded;
 160         int enable_index_links;
 161         int enable_log_filecount;
 162         int enable_log_linecount;
 163         int local_time;
 164         int max_repo_count;
 165         int max_commit_count;
 166         int max_lock_attempts;
 167         int max_msg_len;
 168         int max_repodesc_len;
 169         int max_stats;
 170         int nocache;
 171         int noheader;
 172         int renamelimit;
 173         int snapshots;
 174         int summary_branches;
 175         int summary_log;
 176         int summary_tags;
 177 };
 178
 179 struct cgit_page {
 180         time_t modified;
 181         time_t expires;
 182         size_t size;
 183         char *mimetype;
 184         char *charset;
 185         char *filename;
 186         char *etag;
 187         char *title;
 188         int status;
 189         char *statusmsg;
 190 };
 191
 192 struct cgit_context {
 193         struct cgit_query qry;
 194         struct cgit_config cfg;
 195         struct cgit_repo *repo;
 196         struct cgit_page page;
 197 };
 198
 199 struct cgit_snapshot_format {
 200         const char *suffix;
 201         const char *mimetype;
 202         write_archive_fn_t write_func;
 203         int bit;
 204 };
 205
 206 extern const char *cgit_version;
 207
 208 extern struct cgit_repolist cgit_repolist;
 209 extern struct cgit_context ctx;
 210 extern const struct cgit_snapshot_format cgit_snapshot_formats[];
 211
 212 extern struct cgit_repo *cgit_add_repo(const char *url);
 213 extern struct cgit_repo *cgit_get_repoinfo(const char *url);
 214 extern void cgit_repo_config_cb(const char *name, const char *value);
 215
 216 extern int chk_zero(int result, char *msg);
 217 extern int chk_positive(int result, char *msg);
 218 extern int chk_non_negative(int result, char *msg);
 219
 220 extern char *trim_end(const char *str, char c);
 221 extern char *strlpart(char *txt, int maxlen);
 222 extern char *strrpart(char *txt, int maxlen);
 223
 224 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
 225 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
 226                         int flags, void *cb_data);
 227
 228 extern void *cgit_free_commitinfo(struct commitinfo *info);
 229
 230 extern int cgit_diff_files(const unsigned char *old_sha1,
 231                            const unsigned char *new_sha1,
 232                            unsigned long *old_size, unsigned long *new_size,
 233                            int *binary, linediff_fn fn);
 234
 235 extern void cgit_diff_tree(const unsigned char *old_sha1,
 236                            const unsigned char *new_sha1,
 237                            filepair_fn fn, const char *prefix);
 238
 239 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
 240
 241 extern char *fmt(const char *format,...);
 242
 243 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
 244 extern struct taginfo *cgit_parse_tag(struct tag *tag);
 245 extern void cgit_parse_url(const char *url);
 246
 247 extern const char *cgit_repobasename(const char *reponame);
 248
 249 extern int cgit_parse_snapshots_mask(const char *str);
 250
 251
 252 #endif /* CGIT_H */