Archives/cgit
2
0
Fork 0
mirror of https://git.zx2c4.com/cgit/ synced 2024-11-13 19:12:05 +00:00
Code Issues Projects Releases Wiki Activity
8fb2f05696
cgit/cgit.h

143 lines
3.7 KiB
C
Raw Normal View History

Import cgit prototype from git tree This enables basic cgit functionality, using libgit.a and xdiff/lib.a from git + a custom "git.h" + openssl for sha1 routines. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-09 14:18:17 +00:00
#ifndef CGIT_H
#define CGIT_H
#include "git.h"
#include <openssl/sha.h>
Add caching infrastructure This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-10 21:31:36 +00:00
#include <ctype.h>
#include <sched.h>
typedef void (*configfn)(const char *name, const char *value);
struct cacheitem {
char *name;
struct stat st;
int ttl;
int fd;
};
Read repo-info from /etc/cgitrc This makes cgit read all repo-info from the configfile, instead of scanning for possible git-dirs below a common root path. This is primarily done to get better security (separate physical path from logical repo-name). In /etc/cgitrc each repo is registered with the following keys: repo.url repo.name repo.path repo.desc repo.owner Note: *Required keys are repo.url and repo.path, all others are optional *Each occurrence of repo.url starts a new repository registration *Default value for repo.name is taken from repo.url *The value of repo.url cannot contain characters with special meaning for urls (i.e. one of /?%&), while repo.name can contain anything. Example: repo.url=cgit-pub repo.name=cgit/public repo.path=/pub/git/cgit repo.desc=My public cgit repo repo.owner=Lars Hjemli repo.url=cgit-priv repo.name=cgit/private repo.path=/home/larsh/src/cgit/.git repo.desc=My private cgit repo repo.owner=Lars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-02-03 14:02:55 +00:00
struct repoinfo {
char *url;
char *name;
char *path;
char *desc;
char *owner;
};
struct repolist {
int length;
int count;
struct repoinfo *repos;
};
Add a common commit parser Make a better commit parser, replacing the ugly one in ui-log.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-15 17:17:36 +00:00
struct commitinfo {
struct commit *commit;
char *author;
Teach commit parser about author/committer email + timestamp We want all four of these when showing a commit, so save them in the commitinfo struct. Btw: There's probably no good reason to save committer timestamp since it's already available in commit->date. But it doesn't hurt us either, and it makes the parser look more complete, so we just do it. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-16 13:25:41 +00:00
char *author_email;
unsigned long author_date;
Add a common commit parser Make a better commit parser, replacing the ugly one in ui-log.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-15 17:17:36 +00:00
char *committer;
Teach commit parser about author/committer email + timestamp We want all four of these when showing a commit, so save them in the commitinfo struct. Btw: There's probably no good reason to save committer timestamp since it's already available in commit->date. But it doesn't hurt us either, and it makes the parser look more complete, so we just do it. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-16 13:25:41 +00:00
char *committer_email;
unsigned long committer_date;
Add a common commit parser Make a better commit parser, replacing the ugly one in ui-log.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-15 17:17:36 +00:00
char *subject;
char *msg;
};
Add function cgit_parse_tag() Teach cgit how to extract author info from a tag. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-01-17 00:09:51 +00:00
struct taginfo {
char *tagger;
char *tagger_email;
int tagger_date;
char *msg;
};
Move common output-functions into ui-shared.c While at it, replace the cgit_[lib_]error constants with a proper function Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 15:38:30 +00:00
extern const char cgit_version[];
Read repo-info from /etc/cgitrc This makes cgit read all repo-info from the configfile, instead of scanning for possible git-dirs below a common root path. This is primarily done to get better security (separate physical path from logical repo-name). In /etc/cgitrc each repo is registered with the following keys: repo.url repo.name repo.path repo.desc repo.owner Note: *Required keys are repo.url and repo.path, all others are optional *Each occurrence of repo.url starts a new repository registration *Default value for repo.name is taken from repo.url *The value of repo.url cannot contain characters with special meaning for urls (i.e. one of /?%&), while repo.name can contain anything. Example: repo.url=cgit-pub repo.name=cgit/public repo.path=/pub/git/cgit repo.desc=My public cgit repo repo.owner=Lars Hjemli repo.url=cgit-priv repo.name=cgit/private repo.path=/home/larsh/src/cgit/.git repo.desc=My private cgit repo repo.owner=Lars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-02-03 14:02:55 +00:00
extern struct repolist cgit_repolist;
extern struct repoinfo *cgit_repo;
Add caching infrastructure This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-10 21:31:36 +00:00
extern char *cgit_root_title;
extern char *cgit_css;
extern char *cgit_logo;
extern char *cgit_logo_link;
extern char *cgit_virtual_root;
extern char *cgit_cache_root;
Add argument parsing + switch for uncached operation This adds support for the following options to cgit: --root=<path> --cache=<path> --nocache --query=<querystring> --repo=<reponame> --page=<pagename> --head=<branchname> --sha1=<sha1> --ofs=<number> On startup, /etc/cgitrc is parsed, followed by argument parsing and finally querystring parsing. If --nocache is specified (or set in /etc/gitrc), caching is disabled and cgit instead generates pages to stdout. The combined effect of these two changes makes testing/debugging a lot less painfull. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-16 12:33:32 +00:00
extern int cgit_nocache;
Avoid infinite loops in caching layer Add a global variable, cgit_max_lock_attemps, to avoid the possibility of infinite loops when failing to acquire a lockfile. This could happen on broken setups or under crazy server load. Incidentally, this also fixes a lurking bug in cache_lock() where an uninitialized returnvalue was used. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 11:10:12 +00:00
extern int cgit_max_lock_attempts;
Add caching infrastructure This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-10 21:31:36 +00:00
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;
Add parameter to adjust max message length in log listings The parameter "max-message-length" can be specified in cgitrc, default value is 60. This affects the log message shown in repo summary and shortlog. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-01-28 11:17:03 +00:00
extern int cgit_max_msg_len;
Add caching infrastructure This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-10 21:31:36 +00:00
extern char *cgit_repo_name;
extern char *cgit_repo_desc;
extern char *cgit_repo_owner;
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;
Add generic support for search box in page header This adds the ability to show a search box in any pageheader with correct href and hidden form data, but does not enable the box on any pages. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-28 01:01:49 +00:00
extern char *cgit_query_search;
Add caching infrastructure This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-10 21:31:36 +00:00
extern char *cgit_query_head;
extern char *cgit_query_sha1;
Add basic diff view Finally, xdiff is used to show per-file diffs via commit view. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-20 21:48:27 +00:00
extern char *cgit_query_sha2;
WIP: add paths/backlinks to tree/blobview
2007-01-11 23:46:17 +00:00
extern char *cgit_query_path;
Add simple pager to log page Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-13 23:40:34 +00:00
extern int cgit_query_ofs;
Add caching infrastructure This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-10 21:31:36 +00:00
extern int htmlfd;
Import cgit prototype from git tree This enables basic cgit functionality, using libgit.a and xdiff/lib.a from git + a custom "git.h" + openssl for sha1 routines. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-09 14:18:17 +00:00
Move global variables + callback functions into shared.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 16:25:41 +00:00
extern void cgit_global_config_cb(const char *name, const char *value);
extern void cgit_repo_config_cb(const char *name, const char *value);
extern void cgit_querystring_cb(const char *name, const char *value);
Handle %xx encoding in querystring Convert valid %xx expressions in querystring to ascii, ignore invalid expressions (i.e. eat the three characters %xx). Signed-off-by: Lars Hjemli <larsh@hal-2004.(none)>
2007-01-04 15:53:03 +00:00
extern int hextoint(char c);
Add cgit_free_commitinfo() and use where needed Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-16 13:58:20 +00:00
extern void *cgit_free_commitinfo(struct commitinfo *info);
Import cgit prototype from git tree This enables basic cgit functionality, using libgit.a and xdiff/lib.a from git + a custom "git.h" + openssl for sha1 routines. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-09 14:18:17 +00:00
extern char *fmt(const char *format,...);
extern void html(const char *txt);
extern void htmlf(const char *format,...);
extern void html_txt(char *txt);
Only show first 80 characters of commit subject in log and summary Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-21 23:58:18 +00:00
extern void html_ntxt(int len, char *txt);
Import cgit prototype from git tree This enables basic cgit functionality, using libgit.a and xdiff/lib.a from git + a custom "git.h" + openssl for sha1 routines. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-09 14:18:17 +00:00
extern void html_attr(char *txt);
Add generic support for search box in page header This adds the ability to show a search box in any pageheader with correct href and hidden form data, but does not enable the box on any pages. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-28 01:01:49 +00:00
extern void html_hidden(char *name, char *value);
Import cgit prototype from git tree This enables basic cgit functionality, using libgit.a and xdiff/lib.a from git + a custom "git.h" + openssl for sha1 routines. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-09 14:18:17 +00:00
extern void html_link_open(char *url, char *title, char *class);
extern void html_link_close(void);
Show list of modified files in ui-commit.c Compare current commit with 1.parent, and for each affected file display current filemode, old filemode if changed, current filename and source filename if it was a copy/rename. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-17 22:07:28 +00:00
extern void html_filemode(unsigned short mode);
Import cgit prototype from git tree This enables basic cgit functionality, using libgit.a and xdiff/lib.a from git + a custom "git.h" + openssl for sha1 routines. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-09 14:18:17 +00:00
extern int cgit_read_config(const char *filename, configfn fn);
Rename config.c to parsing.c + move cgit_parse_query from cgit.c to parsing.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 15:11:40 +00:00
extern int cgit_parse_query(char *txt, configfn fn);
Add a common commit parser Make a better commit parser, replacing the ugly one in ui-log.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-15 17:17:36 +00:00
extern struct commitinfo *cgit_parse_commit(struct commit *commit);
Add function cgit_parse_tag() Teach cgit how to extract author info from a tag. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-01-17 00:09:51 +00:00
extern struct taginfo *cgit_parse_tag(struct tag *tag);
Import cgit prototype from git tree This enables basic cgit functionality, using libgit.a and xdiff/lib.a from git + a custom "git.h" + openssl for sha1 routines. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-09 14:18:17 +00:00
Remove troublesome chars from cachefile names Add a funtion cache_safe_filename() which replaces possibly bad filename characters with '_'. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-01-11 23:24:35 +00:00
extern char *cache_safe_filename(const char *unsafe);
Add caching infrastructure This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-10 21:31:36 +00:00
extern int cache_lock(struct cacheitem *item);
extern int cache_unlock(struct cacheitem *item);
Don't truncate valid cachefiles An embarrassing thinko in cgit_check_cache() would truncate valid cachefiles in the following situation: 1) process A notices a missing/expired cachefile 2) process B gets scheduled, locks, fills and unlocks the cachefile 3) process A gets scheduled, locks the cachefile, notices that the cachefile now exist/is not expired anymore, and continues to overwrite it with an empty lockfile. Thanks to Linus for noticing (again). Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 21:53:50 +00:00
extern int cache_cancel_lock(struct cacheitem *item);
Fix cache algorithm loophole This closes the door for unneccessary calls to cgit_fill_cache(). Noticed by Linus. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 08:57:58 +00:00
extern int cache_exist(struct cacheitem *item);
Add caching infrastructure This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-10 21:31:36 +00:00
extern int cache_expired(struct cacheitem *item);
Move functions for repolist output into ui-repolist.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 15:48:03 +00:00
extern char *cgit_repourl(const char *reponame);
extern char *cgit_pageurl(const char *reponame, const char *pagename,
const char *query);
Move common output-functions into ui-shared.c While at it, replace the cgit_[lib_]error constants with a proper function Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 15:38:30 +00:00
extern void cgit_print_error(char *msg);
Move cgit_print_date into ui-shared, reuse in ui-summary Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-15 23:33:28 +00:00
extern void cgit_print_date(unsigned long secs);
Move common output-functions into ui-shared.c While at it, replace the cgit_[lib_]error constants with a proper function Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 15:38:30 +00:00
extern void cgit_print_docstart(char *title, struct cacheitem *item);
extern void cgit_print_docend();
Add generic support for search box in page header This adds the ability to show a search box in any pageheader with correct href and hidden form data, but does not enable the box on any pages. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-28 01:01:49 +00:00
extern void cgit_print_pageheader(char *title, int show_search);
Move common output-functions into ui-shared.c While at it, replace the cgit_[lib_]error constants with a proper function Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 15:38:30 +00:00
Move functions for repolist output into ui-repolist.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 15:48:03 +00:00
extern void cgit_print_repolist(struct cacheitem *item);
Move log-functions into ui-log.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 16:04:19 +00:00
extern void cgit_print_summary();
Add basic log filtering This enables case-insensitive grep on logentris using the new search box Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-28 01:45:28 +00:00
extern void cgit_print_log(const char *tip, int ofs, int cnt, char *grep);
Add ui-commit.c + misc ui cleanups Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-15 23:19:56 +00:00
extern void cgit_print_view(const char *hex);
WIP: add paths/backlinks to tree/blobview
2007-01-11 23:46:17 +00:00
extern void cgit_print_tree(const char *hex, char *path);
Add ui-commit.c + misc ui cleanups Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-15 23:19:56 +00:00
extern void cgit_print_commit(const char *hex);
Add basic diff view Finally, xdiff is used to show per-file diffs via commit view. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-20 21:48:27 +00:00
extern void cgit_print_diff(const char *old_hex, const char *new_hex);
Move functions for repolist output into ui-repolist.c Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-11 15:48:03 +00:00
Import cgit prototype from git tree This enables basic cgit functionality, using libgit.a and xdiff/lib.a from git + a custom "git.h" + openssl for sha1 routines. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-09 14:18:17 +00:00
#endif /* CGIT_H */
Reference in New Issue Copy Permalink