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