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 <argv-array.h>
  15 #include <refs.h>
  16 #include <revision.h>
  17 #include <log-tree.h>
  18 #include <archive.h>
  19 #include <string-list.h>
  20 #include <xdiff-interface.h>
  21 #include <xdiff/xdiff.h>
  22 #include <utf8.h>
  23 #include <notes.h>
  24 #include <graph.h>
  25
  26
  27 /*
  28  * Dateformats used on misc. pages
  29  */
  30 #define FMT_LONGDATE "%Y-%m-%d %H:%M:%S (%Z)"
  31 #define FMT_SHORTDATE "%Y-%m-%d"
  32 #define FMT_ATOMDATE "%Y-%m-%dT%H:%M:%SZ"
  33
  34
  35 /*
  36  * Limits used for relative dates
  37  */
  38 #define TM_MIN    60
  39 #define TM_HOUR  (TM_MIN * 60)
  40 #define TM_DAY   (TM_HOUR * 24)
  41 #define TM_WEEK  (TM_DAY * 7)
  42 #define TM_YEAR  (TM_DAY * 365)
  43 #define TM_MONTH (TM_YEAR / 12.0)
  44
  45
  46 /*
  47  * Default encoding
  48  */
  49 #define PAGE_ENCODING "UTF-8"
  50
  51 typedef void (*configfn)(const char *name, const char *value);
  52 typedef void (*filepair_fn)(struct diff_filepair *pair);
  53 typedef void (*linediff_fn)(char *line, int len);
  54
  55 typedef enum {
  56         ABOUT, COMMIT, SOURCE, EMAIL, AUTH
  57 } filter_type;
  58
  59 struct cgit_filter {
  60         int (*open)(struct cgit_filter *, va_list ap);
  61         int (*close)(struct cgit_filter *);
  62         void (*fprintf)(struct cgit_filter *, FILE *, const char *prefix);
  63         void (*cleanup)(struct cgit_filter *);
  64         int argument_count;
  65 };
  66
  67 struct cgit_exec_filter {
  68         struct cgit_filter base;
  69         char *cmd;
  70         char **argv;
  71         int old_stdout;
  72         int pipe_fh[2];
  73         int pid;
  74 };
  75
  76 struct cgit_repo {
  77         char *url;
  78         char *name;
  79         char *path;
  80         char *desc;
  81         char *owner;
  82         char *defbranch;
  83         char *module_link;
  84         struct string_list readme;
  85         char *section;
  86         char *clone_url;
  87         char *logo;
  88         char *logo_link;
  89         int snapshots;
  90         int enable_commit_graph;
  91         int enable_log_filecount;
  92         int enable_log_linecount;
  93         int enable_remote_branches;
  94         int enable_subject_links;
  95         int max_stats;
  96         int branch_sort;
  97         int commit_sort;
  98         time_t mtime;
  99         struct cgit_filter *about_filter;
 100         struct cgit_filter *commit_filter;
 101         struct cgit_filter *source_filter;
 102         struct cgit_filter *email_filter;
 103         struct string_list submodules;
 104 };
 105
 106 typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
 107               const char *value);
 108
 109 struct cgit_repolist {
 110         int length;
 111         int count;
 112         struct cgit_repo *repos;
 113 };
 114
 115 struct commitinfo {
 116         struct commit *commit;
 117         char *author;
 118         char *author_email;
 119         unsigned long author_date;
 120         char *committer;
 121         char *committer_email;
 122         unsigned long committer_date;
 123         char *subject;
 124         char *msg;
 125         char *msg_encoding;
 126 };
 127
 128 struct taginfo {
 129         char *tagger;
 130         char *tagger_email;
 131         unsigned long tagger_date;
 132         char *msg;
 133 };
 134
 135 struct refinfo {
 136         const char *refname;
 137         struct object *object;
 138         union {
 139                 struct taginfo *tag;
 140                 struct commitinfo *commit;
 141         };
 142 };
 143
 144 struct reflist {
 145         struct refinfo **refs;
 146         int alloc;
 147         int count;
 148 };
 149
 150 struct cgit_query {
 151         int has_symref;
 152         int has_sha1;
 153         int has_ssdiff;
 154         char *raw;
 155         char *repo;
 156         char *page;
 157         char *search;
 158         char *grep;
 159         char *head;
 160         char *sha1;
 161         char *sha2;
 162         char *path;
 163         char *name;
 164         char *mimetype;
 165         char *url;
 166         char *period;
 167         int   ofs;
 168         int nohead;
 169         char *sort;
 170         int showmsg;
 171         int ssdiff;
 172         int show_all;
 173         int context;
 174         int ignorews;
 175         char *vpath;
 176 };
 177
 178 struct cgit_config {
 179         char *agefile;
 180         char *cache_root;
 181         char *clone_prefix;
 182         char *clone_url;
 183         char *css;
 184         char *favicon;
 185         char *footer;
 186         char *head_include;
 187         char *header;
 188         char *index_header;
 189         char *index_info;
 190         char *logo;
 191         char *logo_link;
 192         char *mimetype_file;
 193         char *module_link;
 194         char *project_list;
 195         struct string_list readme;
 196         char *robots;
 197         char *root_title;
 198         char *root_desc;
 199         char *root_readme;
 200         char *script_name;
 201         char *section;
 202         char *repository_sort;
 203         char *virtual_root;     /* Always ends with '/'. */
 204         char *strict_export;
 205         int cache_size;
 206         int cache_dynamic_ttl;
 207         int cache_max_create_time;
 208         int cache_repo_ttl;
 209         int cache_root_ttl;
 210         int cache_scanrc_ttl;
 211         int cache_static_ttl;
 212         int cache_about_ttl;
 213         int case_sensitive_sort;
 214         int embedded;
 215         int enable_filter_overrides;
 216         int enable_http_clone;
 217         int enable_index_links;
 218         int enable_index_owner;
 219         int enable_commit_graph;
 220         int enable_log_filecount;
 221         int enable_log_linecount;
 222         int enable_remote_branches;
 223         int enable_subject_links;
 224         int enable_tree_linenumbers;
 225         int enable_git_config;
 226         int local_time;
 227         int max_atom_items;
 228         int max_repo_count;
 229         int max_commit_count;
 230         int max_lock_attempts;
 231         int max_msg_len;
 232         int max_repodesc_len;
 233         int max_blob_size;
 234         int max_stats;
 235         int nocache;
 236         int noplainemail;
 237         int noheader;
 238         int renamelimit;
 239         int remove_suffix;
 240         int scan_hidden_path;
 241         int section_from_path;
 242         int snapshots;
 243         int section_sort;
 244         int summary_branches;
 245         int summary_log;
 246         int summary_tags;
 247         int ssdiff;
 248         int branch_sort;
 249         int commit_sort;
 250         struct string_list mimetypes;
 251         struct cgit_filter *about_filter;
 252         struct cgit_filter *commit_filter;
 253         struct cgit_filter *source_filter;
 254         struct cgit_filter *email_filter;
 255         struct cgit_filter *auth_filter;
 256 };
 257
 258 struct cgit_page {
 259         time_t modified;
 260         time_t expires;
 261         size_t size;
 262         const char *mimetype;
 263         const char *charset;
 264         const char *filename;
 265         const char *etag;
 266         const char *title;
 267         int status;
 268         const char *statusmsg;
 269 };
 270
 271 struct cgit_environment {
 272         const char *cgit_config;
 273         const char *http_host;
 274         const char *https;
 275         const char *no_http;
 276         const char *path_info;
 277         const char *query_string;
 278         const char *request_method;
 279         const char *script_name;
 280         const char *server_name;
 281         const char *server_port;
 282         const char *http_cookie;
 283         const char *http_referer;
 284         unsigned int content_length;
 285         int authenticated;
 286 };
 287
 288 struct cgit_context {
 289         struct cgit_environment env;
 290         struct cgit_query qry;
 291         struct cgit_config cfg;
 292         struct cgit_repo *repo;
 293         struct cgit_page page;
 294 };
 295
 296 typedef int (*write_archive_fn_t)(const char *, const char *);
 297
 298 struct cgit_snapshot_format {
 299         const char *suffix;
 300         const char *mimetype;
 301         write_archive_fn_t write_func;
 302         int bit;
 303 };
 304
 305 extern const char *cgit_version;
 306
 307 extern struct cgit_repolist cgit_repolist;
 308 extern struct cgit_context ctx;
 309 extern const struct cgit_snapshot_format cgit_snapshot_formats[];
 310
 311 extern char *cgit_default_repo_desc;
 312 extern struct cgit_repo *cgit_add_repo(const char *url);
 313 extern struct cgit_repo *cgit_get_repoinfo(const char *url);
 314 extern void cgit_repo_config_cb(const char *name, const char *value);
 315
 316 extern int chk_zero(int result, char *msg);
 317 extern int chk_positive(int result, char *msg);
 318 extern int chk_non_negative(int result, char *msg);
 319
 320 extern char *trim_end(const char *str, char c);
 321 extern char *ensure_end(const char *str, char c);
 322 extern char *strlpart(char *txt, int maxlen);
 323 extern char *strrpart(char *txt, int maxlen);
 324
 325 extern void strbuf_ensure_end(struct strbuf *sb, char c);
 326
 327 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
 328 extern void cgit_free_reflist_inner(struct reflist *list);
 329 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
 330                         int flags, void *cb_data);
 331
 332 extern void *cgit_free_commitinfo(struct commitinfo *info);
 333
 334 extern int cgit_diff_files(const unsigned char *old_sha1,
 335                            const unsigned char *new_sha1,
 336                            unsigned long *old_size, unsigned long *new_size,
 337                            int *binary, int context, int ignorews,
 338                            linediff_fn fn);
 339
 340 extern void cgit_diff_tree(const unsigned char *old_sha1,
 341                            const unsigned char *new_sha1,
 342                            filepair_fn fn, const char *prefix, int ignorews);
 343
 344 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,
 345                              const char *prefix);
 346
 347 __attribute__((format (printf,1,2)))
 348 extern char *fmt(const char *format,...);
 349
 350 __attribute__((format (printf,1,2)))
 351 extern char *fmtalloc(const char *format,...);
 352
 353 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
 354 extern struct taginfo *cgit_parse_tag(struct tag *tag);
 355 extern void cgit_parse_url(const char *url);
 356
 357 extern const char *cgit_repobasename(const char *reponame);
 358
 359 extern int cgit_parse_snapshots_mask(const char *str);
 360
 361 extern int cgit_open_filter(struct cgit_filter *filter, ...);
 362 extern int cgit_close_filter(struct cgit_filter *filter);
 363 extern void cgit_fprintf_filter(struct cgit_filter *filter, FILE *f, const char *prefix);
 364 extern void cgit_exec_filter_init(struct cgit_exec_filter *filter, char *cmd, char **argv);
 365 extern struct cgit_filter *cgit_new_filter(const char *cmd, filter_type filtertype);
 366 extern void cgit_cleanup_filters(void);
 367 extern void cgit_init_filters(void);
 368
 369 extern void cgit_prepare_repo_env(struct cgit_repo * repo);
 370
 371 extern int readfile(const char *path, char **buf, size_t *size);
 372
 373 extern char *expand_macros(const char *txt);
 374
 375 #endif /* CGIT_H */