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