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 *module_link;
  69         char *readme;
  70         char *section;
  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 typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
  83               const char *value);
  84
  85 struct cgit_repolist {
  86         int length;
  87         int count;
  88         struct cgit_repo *repos;
  89 };
  90
  91 struct commitinfo {
  92         struct commit *commit;
  93         char *author;
  94         char *author_email;
  95         unsigned long author_date;
  96         char *committer;
  97         char *committer_email;
  98         unsigned long committer_date;
  99         char *subject;
 100         char *msg;
 101         char *msg_encoding;
 102 };
 103
 104 struct taginfo {
 105         char *tagger;
 106         char *tagger_email;
 107         unsigned long tagger_date;
 108         char *msg;
 109 };
 110
 111 struct refinfo {
 112         const char *refname;
 113         struct object *object;
 114         union {
 115                 struct taginfo *tag;
 116                 struct commitinfo *commit;
 117         };
 118 };
 119
 120 struct reflist {
 121         struct refinfo **refs;
 122         int alloc;
 123         int count;
 124 };
 125
 126 struct 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         char *mimetype;
 140         char *url;
 141         char *period;
 142         int   ofs;
 143         int nohead;
 144         char *sort;
 145         int showmsg;
 146 };
 147
 148 struct cgit_config {
 149         char *agefile;
 150         char *cache_root;
 151         char *clone_prefix;
 152         char *css;
 153         char *favicon;
 154         char *footer;
 155         char *head_include;
 156         char *header;
 157         char *index_header;
 158         char *index_info;
 159         char *logo;
 160         char *logo_link;
 161         char *module_link;
 162         char *robots;
 163         char *root_title;
 164         char *root_desc;
 165         char *root_readme;
 166         char *script_name;
 167         char *section;
 168         char *virtual_root;
 169         int cache_size;
 170         int cache_dynamic_ttl;
 171         int cache_max_create_time;
 172         int cache_repo_ttl;
 173         int cache_root_ttl;
 174         int cache_scanrc_ttl;
 175         int cache_static_ttl;
 176         int embedded;
 177         int enable_filter_overrides;
 178         int enable_index_links;
 179         int enable_log_filecount;
 180         int enable_log_linecount;
 181         int enable_tree_linenumbers;
 182         int local_time;
 183         int max_repo_count;
 184         int max_commit_count;
 185         int max_lock_attempts;
 186         int max_msg_len;
 187         int max_repodesc_len;
 188         int max_stats;
 189         int nocache;
 190         int noplainemail;
 191         int noheader;
 192         int renamelimit;
 193         int snapshots;
 194         int summary_branches;
 195         int summary_log;
 196         int summary_tags;
 197         struct string_list mimetypes;
 198         struct cgit_filter *about_filter;
 199         struct cgit_filter *commit_filter;
 200         struct cgit_filter *source_filter;
 201 };
 202
 203 struct cgit_page {
 204         time_t modified;
 205         time_t expires;
 206         size_t size;
 207         char *mimetype;
 208         char *charset;
 209         char *filename;
 210         char *etag;
 211         char *title;
 212         int status;
 213         char *statusmsg;
 214 };
 215
 216 struct cgit_environment {
 217         char *cgit_config;
 218         char *http_host;
 219         char *https;
 220         char *no_http;
 221         char *path_info;
 222         char *query_string;
 223         char *request_method;
 224         char *script_name;
 225         char *server_name;
 226         char *server_port;
 227 };
 228
 229 struct cgit_context {
 230         struct cgit_environment env;
 231         struct cgit_query qry;
 232         struct cgit_config cfg;
 233         struct cgit_repo *repo;
 234         struct cgit_page page;
 235 };
 236
 237 struct cgit_snapshot_format {
 238         const char *suffix;
 239         const char *mimetype;
 240         write_archive_fn_t write_func;
 241         int bit;
 242 };
 243
 244 extern const char *cgit_version;
 245
 246 extern struct cgit_repolist cgit_repolist;
 247 extern struct cgit_context ctx;
 248 extern const struct cgit_snapshot_format cgit_snapshot_formats[];
 249
 250 extern struct cgit_repo *cgit_add_repo(const char *url);
 251 extern struct cgit_repo *cgit_get_repoinfo(const char *url);
 252 extern void cgit_repo_config_cb(const char *name, const char *value);
 253
 254 extern int chk_zero(int result, char *msg);
 255 extern int chk_positive(int result, char *msg);
 256 extern int chk_non_negative(int result, char *msg);
 257
 258 extern char *trim_end(const char *str, char c);
 259 extern char *strlpart(char *txt, int maxlen);
 260 extern char *strrpart(char *txt, int maxlen);
 261
 262 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
 263 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
 264                         int flags, void *cb_data);
 265
 266 extern void *cgit_free_commitinfo(struct commitinfo *info);
 267
 268 extern int cgit_diff_files(const unsigned char *old_sha1,
 269                            const unsigned char *new_sha1,
 270                            unsigned long *old_size, unsigned long *new_size,
 271                            int *binary, linediff_fn fn);
 272
 273 extern void cgit_diff_tree(const unsigned char *old_sha1,
 274                            const unsigned char *new_sha1,
 275                            filepair_fn fn, const char *prefix);
 276
 277 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
 278
 279 extern char *fmt(const char *format,...);
 280
 281 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
 282 extern struct taginfo *cgit_parse_tag(struct tag *tag);
 283 extern void cgit_parse_url(const char *url);
 284
 285 extern const char *cgit_repobasename(const char *reponame);
 286
 287 extern int cgit_parse_snapshots_mask(const char *str);
 288
 289 extern int cgit_open_filter(struct cgit_filter *filter);
 290 extern int cgit_close_filter(struct cgit_filter *filter);
 291
 292 extern int readfile(const char *path, char **buf, size_t *size);
 293
 294 #endif /* CGIT_H */