]> git.cameronkatri.com Git - cgit.git/blobdiff - cgit.h
git: update to v2.29.2
[cgit.git] / cgit.h
diff --git a/cgit.h b/cgit.h
index ab0efeb45b5385038fbd237767e11ac96bc94a18..69b5c13232e74845907a2212ade32f36f861bba8 100644 (file)
--- a/cgit.h
+++ b/cgit.h
@@ -3,39 +3,32 @@
 
 
 #include <git-compat-util.h>
+#include <stdbool.h>
+
 #include <cache.h>
 #include <grep.h>
 #include <object.h>
+#include <object-store.h>
 #include <tree.h>
 #include <commit.h>
 #include <tag.h>
 #include <diff.h>
 #include <diffcore.h>
+#include <strvec.h>
 #include <refs.h>
 #include <revision.h>
 #include <log-tree.h>
 #include <archive.h>
+#include <string-list.h>
+#include <xdiff-interface.h>
 #include <xdiff/xdiff.h>
 #include <utf8.h>
+#include <notes.h>
+#include <graph.h>
 
-
-/*
- * The valid cgit repo-commands
- */
-#define CMD_LOG      1
-#define CMD_COMMIT   2
-#define CMD_DIFF     3
-#define CMD_TREE     4
-#define CMD_BLOB     5
-#define CMD_SNAPSHOT 6
-#define CMD_TAG      7
-#define CMD_REFS     8
-
-/*
- * Dateformats used on misc. pages
- */
-#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
-#define FMT_SHORTDATE "%Y-%m-%d"
+/* Add isgraph(x) to Git's sane ctype support (see git-compat-util.h) */
+#undef isgraph
+#define isgraph(x) (isprint((x)) && !isspace((x)))
 
 
 /*
  */
 #define PAGE_ENCODING "UTF-8"
 
+#define BIT(x) (1U << (x))
+
 typedef void (*configfn)(const char *name, const char *value);
 typedef void (*filepair_fn)(struct diff_filepair *pair);
 typedef void (*linediff_fn)(char *line, int len);
 
-struct cacheitem {
-       char *name;
-       struct stat st;
-       int ttl;
-       int fd;
+typedef enum {
+       DIFF_UNIFIED, DIFF_SSDIFF, DIFF_STATONLY
+} diff_type;
+
+typedef enum {
+       ABOUT, COMMIT, SOURCE, EMAIL, AUTH, OWNER
+} filter_type;
+
+struct cgit_filter {
+       int (*open)(struct cgit_filter *, va_list ap);
+       int (*close)(struct cgit_filter *);
+       void (*fprintf)(struct cgit_filter *, FILE *, const char *prefix);
+       void (*cleanup)(struct cgit_filter *);
+       int argument_count;
 };
 
-struct repoinfo {
+struct cgit_exec_filter {
+       struct cgit_filter base;
+       char *cmd;
+       char **argv;
+       int old_stdout;
+       int pid;
+};
+
+struct cgit_repo {
        char *url;
        char *name;
        char *path;
        char *desc;
+       char *extra_head_content;
        char *owner;
+       char *homepage;
        char *defbranch;
-       char *group;
        char *module_link;
-       char *readme;
+       struct string_list readme;
+       char *section;
+       char *clone_url;
+       char *logo;
+       char *logo_link;
+       char *snapshot_prefix;
        int snapshots;
+       int enable_blame;
+       int enable_commit_graph;
        int enable_log_filecount;
        int enable_log_linecount;
+       int enable_remote_branches;
+       int enable_subject_links;
+       int enable_html_serving;
+       int max_stats;
+       int branch_sort;
+       int commit_sort;
+       time_t mtime;
+       struct cgit_filter *about_filter;
+       struct cgit_filter *commit_filter;
+       struct cgit_filter *source_filter;
+       struct cgit_filter *email_filter;
+       struct cgit_filter *owner_filter;
+       struct string_list submodules;
+       int hide;
+       int ignore;
 };
 
-struct repolist {
+typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
+             const char *value);
+
+struct cgit_repolist {
        int length;
        int count;
-       struct repoinfo *repos;
+       struct cgit_repo *repos;
 };
 
 struct commitinfo {
@@ -91,9 +129,11 @@ struct commitinfo {
        char *author;
        char *author_email;
        unsigned long author_date;
+       int author_tz;
        char *committer;
        char *committer_email;
        unsigned long committer_date;
+       int committer_tz;
        char *subject;
        char *msg;
        char *msg_encoding;
@@ -102,7 +142,8 @@ struct commitinfo {
 struct taginfo {
        char *tagger;
        char *tagger_email;
-       int tagger_date;
+       unsigned long tagger_date;
+       int tagger_tz;
        char *msg;
 };
 
@@ -121,171 +162,237 @@ struct reflist {
        int count;
 };
 
+struct cgit_query {
+       int has_symref;
+       int has_oid;
+       int has_difftype;
+       char *raw;
+       char *repo;
+       char *page;
+       char *search;
+       char *grep;
+       char *head;
+       char *oid;
+       char *oid2;
+       char *path;
+       char *name;
+       char *url;
+       char *period;
+       int   ofs;
+       int nohead;
+       char *sort;
+       int showmsg;
+       diff_type difftype;
+       int show_all;
+       int context;
+       int ignorews;
+       int follow;
+       char *vpath;
+};
+
+struct cgit_config {
+       char *agefile;
+       char *cache_root;
+       char *clone_prefix;
+       char *clone_url;
+       char *css;
+       char *favicon;
+       char *footer;
+       char *head_include;
+       char *header;
+       char *logo;
+       char *logo_link;
+       char *mimetype_file;
+       char *module_link;
+       char *project_list;
+       struct string_list readme;
+       char *robots;
+       char *root_title;
+       char *root_desc;
+       char *root_readme;
+       char *script_name;
+       char *section;
+       char *repository_sort;
+       char *virtual_root;     /* Always ends with '/'. */
+       char *strict_export;
+       int cache_size;
+       int cache_dynamic_ttl;
+       int cache_max_create_time;
+       int cache_repo_ttl;
+       int cache_root_ttl;
+       int cache_scanrc_ttl;
+       int cache_static_ttl;
+       int cache_about_ttl;
+       int cache_snapshot_ttl;
+       int case_sensitive_sort;
+       int embedded;
+       int enable_filter_overrides;
+       int enable_follow_links;
+       int enable_http_clone;
+       int enable_index_links;
+       int enable_index_owner;
+       int enable_blame;
+       int enable_commit_graph;
+       int enable_log_filecount;
+       int enable_log_linecount;
+       int enable_remote_branches;
+       int enable_subject_links;
+       int enable_html_serving;
+       int enable_tree_linenumbers;
+       int enable_git_config;
+       int local_time;
+       int max_atom_items;
+       int max_repo_count;
+       int max_commit_count;
+       int max_lock_attempts;
+       int max_msg_len;
+       int max_repodesc_len;
+       int max_blob_size;
+       int max_stats;
+       int noplainemail;
+       int noheader;
+       int renamelimit;
+       int remove_suffix;
+       int scan_hidden_path;
+       int section_from_path;
+       int snapshots;
+       int section_sort;
+       int summary_branches;
+       int summary_log;
+       int summary_tags;
+       diff_type difftype;
+       int branch_sort;
+       int commit_sort;
+       struct string_list mimetypes;
+       struct cgit_filter *about_filter;
+       struct cgit_filter *commit_filter;
+       struct cgit_filter *source_filter;
+       struct cgit_filter *email_filter;
+       struct cgit_filter *owner_filter;
+       struct cgit_filter *auth_filter;
+};
+
+struct cgit_page {
+       time_t modified;
+       time_t expires;
+       size_t size;
+       const char *mimetype;
+       const char *charset;
+       const char *filename;
+       const char *etag;
+       const char *title;
+       int status;
+       const char *statusmsg;
+};
+
+struct cgit_environment {
+       const char *cgit_config;
+       const char *http_host;
+       const char *https;
+       const char *no_http;
+       const char *path_info;
+       const char *query_string;
+       const char *request_method;
+       const char *script_name;
+       const char *server_name;
+       const char *server_port;
+       const char *http_cookie;
+       const char *http_referer;
+       unsigned int content_length;
+       int authenticated;
+};
+
+struct cgit_context {
+       struct cgit_environment env;
+       struct cgit_query qry;
+       struct cgit_config cfg;
+       struct cgit_repo *repo;
+       struct cgit_page page;
+};
+
+typedef int (*write_archive_fn_t)(const char *, const char *);
+
+struct cgit_snapshot_format {
+       const char *suffix;
+       const char *mimetype;
+       write_archive_fn_t write_func;
+};
+
 extern const char *cgit_version;
 
-extern struct repolist cgit_repolist;
-extern struct repoinfo *cgit_repo;
-extern int cgit_cmd;
-
-extern char *cgit_root_title;
-extern char *cgit_css;
-extern char *cgit_logo;
-extern char *cgit_index_header;
-extern char *cgit_index_info;
-extern char *cgit_logo_link;
-extern char *cgit_module_link;
-extern char *cgit_agefile;
-extern char *cgit_virtual_root;
-extern char *cgit_script_name;
-extern char *cgit_cache_root;
-extern char *cgit_repo_group;
-extern char *cgit_robots;
-
-extern int cgit_nocache;
-extern int cgit_snapshots;
-extern int cgit_enable_index_links;
-extern int cgit_enable_log_filecount;
-extern int cgit_enable_log_linecount;
-extern int cgit_max_lock_attempts;
-extern int cgit_cache_root_ttl;
-extern int cgit_cache_repo_ttl;
-extern int cgit_cache_dynamic_ttl;
-extern int cgit_cache_static_ttl;
-extern int cgit_cache_max_create_time;
-extern int cgit_summary_log;
-extern int cgit_summary_tags;
-extern int cgit_summary_branches;
-
-extern int cgit_max_msg_len;
-extern int cgit_max_repodesc_len;
-extern int cgit_max_commit_count;
-
-extern int cgit_query_has_symref;
-extern int cgit_query_has_sha1;
-
-extern char *cgit_querystring;
-extern char *cgit_query_repo;
-extern char *cgit_query_page;
-extern char *cgit_query_search;
-extern char *cgit_query_grep;
-extern char *cgit_query_head;
-extern char *cgit_query_sha1;
-extern char *cgit_query_sha2;
-extern char *cgit_query_path;
-extern char *cgit_query_name;
-extern int   cgit_query_ofs;
-
-extern int htmlfd;
-
-extern int cgit_get_cmd_index(const char *cmd);
-extern struct repoinfo *cgit_get_repoinfo(const char *url);
-extern void cgit_global_config_cb(const char *name, const char *value);
+extern struct cgit_repolist cgit_repolist;
+extern struct cgit_context ctx;
+extern const struct cgit_snapshot_format cgit_snapshot_formats[];
+
+extern char *cgit_default_repo_desc;
+extern struct cgit_repo *cgit_add_repo(const char *url);
+extern struct cgit_repo *cgit_get_repoinfo(const char *url);
 extern void cgit_repo_config_cb(const char *name, const char *value);
-extern void cgit_querystring_cb(const char *name, const char *value);
 
 extern int chk_zero(int result, char *msg);
 extern int chk_positive(int result, char *msg);
 extern int chk_non_negative(int result, char *msg);
 
-extern int hextoint(char c);
 extern char *trim_end(const char *str, char c);
-extern char *strlpart(char *txt, int maxlen);
-extern char *strrpart(char *txt, int maxlen);
+extern char *ensure_end(const char *str, char c);
+
+extern void strbuf_ensure_end(struct strbuf *sb, char c);
 
 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
-extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
+extern void cgit_free_reflist_inner(struct reflist *list);
+extern int cgit_refs_cb(const char *refname, const struct object_id *oid,
                        int flags, void *cb_data);
 
-extern void *cgit_free_commitinfo(struct commitinfo *info);
+extern void cgit_free_commitinfo(struct commitinfo *info);
+extern void cgit_free_taginfo(struct taginfo *info);
+
+void cgit_diff_tree_cb(struct diff_queue_struct *q,
+                      struct diff_options *options, void *data);
 
-extern int cgit_diff_files(const unsigned char *old_sha1,
-                          const unsigned char *new_sha1,
+extern int cgit_diff_files(const struct object_id *old_oid,
+                          const struct object_id *new_oid,
+                          unsigned long *old_size, unsigned long *new_size,
+                          int *binary, int context, int ignorews,
                           linediff_fn fn);
 
-extern void cgit_diff_tree(const unsigned char *old_sha1,
-                          const unsigned char *new_sha1,
-                          filepair_fn fn, const char *prefix);
+extern void cgit_diff_tree(const struct object_id *old_oid,
+                          const struct object_id *new_oid,
+                          filepair_fn fn, const char *prefix, int ignorews);
 
-extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
+extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,
+                            const char *prefix);
 
+__attribute__((format (printf,1,2)))
 extern char *fmt(const char *format,...);
 
-extern void html(const char *txt);
-extern void htmlf(const char *format,...);
-extern void html_txt(char *txt);
-extern void html_ntxt(int len, char *txt);
-extern void html_attr(char *txt);
-extern void html_hidden(char *name, char *value);
-extern void html_option(char *value, char *text, char *selected_value);
-extern void html_link_open(char *url, char *title, char *class);
-extern void html_link_close(void);
-extern void html_filemode(unsigned short mode);
-extern int html_include(const char *filename);
-
-extern int cgit_read_config(const char *filename, configfn fn);
-extern int cgit_parse_query(char *txt, configfn fn);
+__attribute__((format (printf,1,2)))
+extern char *fmtalloc(const char *format,...);
+
 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
 extern struct taginfo *cgit_parse_tag(struct tag *tag);
 extern void cgit_parse_url(const char *url);
 
-extern char *cache_safe_filename(const char *unsafe);
-extern int cache_lock(struct cacheitem *item);
-extern int cache_unlock(struct cacheitem *item);
-extern int cache_cancel_lock(struct cacheitem *item);
-extern int cache_exist(struct cacheitem *item);
-extern int cache_expired(struct cacheitem *item);
-
-extern char *cgit_repourl(const char *reponame);
-extern char *cgit_fileurl(const char *reponame, const char *pagename,
-                         const char *filename, const char *query);
-extern char *cgit_pageurl(const char *reponame, const char *pagename,
-                         const char *query);
-
 extern const char *cgit_repobasename(const char *reponame);
 
-extern void cgit_tree_link(char *name, char *title, char *class, char *head,
-                          char *rev, char *path);
-extern void cgit_log_link(char *name, char *title, char *class, char *head,
-                         char *rev, char *path, int ofs, char *grep,
-                         char *pattern);
-extern void cgit_commit_link(char *name, char *title, char *class, char *head,
-                            char *rev);
-extern void cgit_refs_link(char *name, char *title, char *class, char *head,
-                          char *rev, char *path);
-extern void cgit_snapshot_link(char *name, char *title, char *class,
-                              char *head, char *rev, char *archivename);
-extern void cgit_diff_link(char *name, char *title, char *class, char *head,
-                          char *new_rev, char *old_rev, char *path);
-
-extern void cgit_object_link(struct object *obj);
-
-extern void cgit_print_error(char *msg);
-extern void cgit_print_date(time_t secs, char *format);
-extern void cgit_print_age(time_t t, time_t max_relative, char *format);
-extern void cgit_print_docstart(char *title, struct cacheitem *item);
-extern void cgit_print_docend();
-extern void cgit_print_pageheader(char *title, int show_search);
-extern void cgit_print_snapshot_start(const char *mimetype,
-                                     const char *filename,
-                                     struct cacheitem *item);
-extern void cgit_print_branches(int maxcount);
-extern void cgit_print_tags(int maxcount);
-
-extern void cgit_print_repolist(struct cacheitem *item);
-extern void cgit_print_summary();
-extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep,
-                          char *pattern, char *path, int pager);
-extern void cgit_print_blob(struct cacheitem *item, const char *hex, char *path);
-extern void cgit_print_tree(const char *rev, char *path);
-extern void cgit_print_commit(char *hex);
-extern void cgit_print_refs();
-extern void cgit_print_tag(char *revname);
-extern void cgit_print_diff(const char *new_hex, const char *old_hex, const char *prefix);
-extern void cgit_print_snapshot(struct cacheitem *item, const char *head,
-                               const char *hex, const char *prefix,
-                               const char *filename, int snapshot);
-extern void cgit_print_snapshot_links(const char *repo, const char *head,
-                                     const char *hex, int snapshots);
 extern int cgit_parse_snapshots_mask(const char *str);
+extern const struct object_id *cgit_snapshot_get_sig(const char *ref,
+                                                    const struct cgit_snapshot_format *f);
+extern const unsigned cgit_snapshot_format_bit(const struct cgit_snapshot_format *f);
+
+extern int cgit_open_filter(struct cgit_filter *filter, ...);
+extern int cgit_close_filter(struct cgit_filter *filter);
+extern void cgit_fprintf_filter(struct cgit_filter *filter, FILE *f, const char *prefix);
+extern void cgit_exec_filter_init(struct cgit_exec_filter *filter, char *cmd, char **argv);
+extern struct cgit_filter *cgit_new_filter(const char *cmd, filter_type filtertype);
+extern void cgit_cleanup_filters(void);
+extern void cgit_init_filters(void);
+
+extern void cgit_prepare_repo_env(struct cgit_repo * repo);
+
+extern int readfile(const char *path, char **buf, size_t *size);
+
+extern char *expand_macros(const char *txt);
+
+extern char *get_mimetype_for_filename(const char *filename);
 
 #endif /* CGIT_H */