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