2 * Copyright (c) 2016, 2019, 2020-2022 Tracey Emery <tracey@traceyemery.net>
3 * Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org>
4 * Copyright (c) 2013 David Gwynne <dlg@openbsd.org>
5 * Copyright (c) 2013 Florian Obser <florian@openbsd.org>
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include <netinet/in.h>
22 #include <sys/queue.h>
28 #define dprintf(x...) do { log_debug(x); } while(0)
34 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
37 /* GOTWEBD DEFAULTS */
38 #define GOTWEBD_CONF "/etc/gotwebd.conf"
40 #define GOTWEBD_USER "www"
42 #define GOTWEBD_MAXDESCRSZ 1024
43 #define GOTWEBD_MAXCLONEURLSZ 1024
44 #define GOTWEBD_CACHESIZE 1024
45 #define GOTWEBD_MAXCLIENTS 1024
46 #define GOTWEBD_MAXTEXT 511
47 #define GOTWEBD_MAXNAME 64
48 #define GOTWEBD_MAXPORT 6
49 #define GOTWEBD_NUMPROC 3
50 #define GOTWEBD_SOCK_FILENO 3
52 #define PROC_MAX_INSTANCES 32
55 #define MAX_QUERYSTRING 2048
56 #define MAX_DOCUMENT_URI 255
57 #define MAX_SERVER_NAME 255
59 #define GOTWEB_GIT_DIR ".git"
61 #define D_HTTPD_CHROOT "/var/www"
62 #define D_UNIX_SOCKET "/run/gotweb.sock"
63 #define D_FCGI_PORT "9000"
64 #define D_GOTPATH "/got/public"
65 #define D_SITENAME "Gotweb"
66 #define D_SITEOWNER "Got Owner"
67 #define D_SITELINK "Repos"
68 #define D_GOTLOGO "got.png"
69 #define D_GOTURL "https://gameoftrees.org"
70 #define D_GOTWEBCSS "gotweb.css"
72 #define D_SHOWROWNER 1
73 #define D_SHOWSOWNER 1
77 #define D_RESPECTEXPORTOK 0
79 #define D_MAXREPODISP 25
80 #define D_MAXSLCOMMDISP 10
81 #define D_MAXCOMMITDISP 25
85 #define TIMEOUT_DEFAULT 120
87 #define FCGI_CONTENT_SIZE 65535
88 #define FCGI_PADDING_SIZE 255
89 #define FCGI_RECORD_SIZE \
90 (sizeof(struct fcgi_record_header) + FCGI_CONTENT_SIZE + FCGI_PADDING_SIZE)
92 #define FCGI_ALIGNMENT 8
93 #define FCGI_ALIGN(n) \
94 (((n) + (FCGI_ALIGNMENT - 1)) & ~(FCGI_ALIGNMENT - 1))
99 #define FCGI_BEGIN_REQUEST 1
100 #define FCGI_ABORT_REQUEST 2
101 #define FCGI_END_REQUEST 3
102 #define FCGI_PARAMS 4
104 #define FCGI_STDOUT 6
105 #define FCGI_STDERR 7
107 #define FCGI_GET_VALUES 9
108 #define FCGI_GET_VALUES_RESULT 10
109 #define FCGI_UNKNOWN_TYPE 11
110 #define FCGI_MAXTYPE (FCGI_UNKNOWN_TYPE)
112 #define FCGI_REQUEST_COMPLETE 0
113 #define FCGI_CANT_MPX_CONN 1
114 #define FCGI_OVERLOADED 2
115 #define FCGI_UNKNOWN_ROLE 3
117 #define GOTWEB_PACK_NUM_TEMPFILES (32 * 2)
119 /* Forward declaration */
120 struct got_blob_object;
121 struct got_tree_entry;
122 struct got_reflist_head;
134 void (*handler)(int, short, void *);
140 #define IMSG_DATA_SIZE(imsg) ((imsg)->hdr.len - IMSG_HEADER_SIZE)
143 SLIST_ENTRY(env_val) entry;
146 SLIST_HEAD(env_head, env_val);
148 struct fcgi_record_header {
152 uint16_t content_len;
155 }__attribute__((__packed__));
161 char datebuf[11]; /* YYYY-MM-DD + NUL */
174 TAILQ_ENTRY(repo_tag) entry;
184 TAILQ_ENTRY(repo_commit) entry;
187 char *commit_id; /* id_str1 */
188 char *parent_id; /* id_str2 */
193 time_t committer_time;
196 struct got_repository;
198 TAILQ_HEAD(repo_commits_head, repo_commit) repo_commits;
199 TAILQ_HEAD(repo_tags_head, repo_tag) repo_tags;
200 struct got_reflist_head refs;
201 struct got_repository *repo;
202 struct repo_dir *repo_dir;
203 struct querystring *qs;
207 unsigned int repos_total;
208 unsigned int next_disp;
209 unsigned int prev_disp;
210 unsigned int tag_count;
211 const struct got_error *error;
212 struct got_blob_object *blob;
215 struct dirent **repos;
219 enum socket_priv_fds {
247 int priv_fd[PRIV_FDS__MAX];
249 uint8_t buf[FCGI_RECORD_SIZE];
253 uint8_t outbuf[GOTWEBD_CACHESIZE];
255 char querystring[MAX_QUERYSTRING];
256 char document_uri[MAX_DOCUMENT_URI];
257 char server_name[MAX_SERVER_NAME];
260 uint8_t request_started;
263 struct fcgi_begin_request_body {
267 }__attribute__((__packed__));
269 struct fcgi_end_request_body {
271 uint8_t protocol_status;
273 }__attribute__((__packed__));
276 TAILQ_ENTRY(address) entry;
277 struct sockaddr_storage ss;
283 char ifname[IFNAMSIZ];
285 TAILQ_HEAD(addresslist, address);
288 TAILQ_ENTRY(server) entry;
289 struct addresslist al;
291 char name[GOTWEBD_MAXTEXT];
293 char repos_path[PATH_MAX];
294 char site_name[GOTWEBD_MAXNAME];
295 char site_owner[GOTWEBD_MAXNAME];
296 char site_link[GOTWEBD_MAXTEXT];
297 char logo[GOTWEBD_MAXTEXT];
298 char logo_url[GOTWEBD_MAXTEXT];
299 char custom_css[PATH_MAX];
302 size_t max_repos_display;
303 size_t max_commits_display;
308 int show_repo_description;
309 int show_repo_cloneurl;
310 int respect_exportok;
313 char unix_socket_name[PATH_MAX];
317 TAILQ_HEAD(serverlist, server);
327 char name[GOTWEBD_MAXTEXT];
328 char srv_name[GOTWEBD_MAXTEXT];
332 char unix_socket_name[PATH_MAX];
333 in_port_t fcgi_socket_port;
337 TAILQ_ENTRY(socket) entry;
338 struct socket_conf conf;
341 int pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
342 int priv_fd[PRIV_FDS__MAX];
350 TAILQ_HEAD(socketlist, socket);
354 struct serverlist servers;
355 struct socketlist sockets;
357 const char *gotwebd_conffile;
362 struct imsgev *iev_parent;
363 struct imsgev *iev_server;
368 uint16_t prefork_gotwebd;
373 char httpd_chroot[PATH_MAX];
376 char unix_socket_name[PATH_MAX];
380 * URL parameter for gotweb_render_url. NULL values and int set to -1
381 * are implicitly ignored, and string are properly escaped.
409 struct querystring_keys {
419 enum querystring_elements {
447 extern struct gotwebd *gotwebd_env;
449 typedef int (*got_render_blame_line_cb)(struct template *, const char *,
450 struct blame_line *, int, int);
453 void imsg_event_add(struct imsgev *);
454 int imsg_compose_event(struct imsgev *, uint16_t, uint32_t,
455 pid_t, int, const void *, uint16_t);
456 int main_compose_sockets(struct gotwebd *, uint32_t, int,
457 const void *, uint16_t);
458 int sockets_compose_main(struct gotwebd *, uint32_t,
459 const void *, uint16_t);
462 void sockets(struct gotwebd *, int);
463 void sockets_parse_sockets(struct gotwebd *);
464 void sockets_socket_accept(int, short, void *);
465 int sockets_privinit(struct gotwebd *, struct socket *);
468 void gotweb_get_navs(struct request *, struct gotweb_url *, int *,
469 struct gotweb_url *, int *);
470 int gotweb_render_age(struct template *, time_t);
471 const struct got_error *gotweb_init_transport(struct transport **);
472 const char *gotweb_action_name(int);
473 int gotweb_render_url(struct request *, struct gotweb_url *);
474 int gotweb_render_absolute_url(struct request *, struct gotweb_url *);
475 void gotweb_free_repo_commit(struct repo_commit *);
476 void gotweb_free_repo_tag(struct repo_tag *);
477 void gotweb_process_request(struct request *);
478 void gotweb_free_transport(struct transport *);
481 int gotweb_render_page(struct template *, int (*)(struct template *));
482 int gotweb_render_error(struct template *);
483 int gotweb_render_repo_table_hdr(struct template *);
484 int gotweb_render_repo_fragment(struct template *, struct repo_dir *);
485 int gotweb_render_briefs(struct template *);
486 int gotweb_render_navs(struct template *);
487 int gotweb_render_commits(struct template *);
488 int gotweb_render_blob(struct template *);
489 int gotweb_render_tree(struct template *);
490 int gotweb_render_tags(struct template *);
491 int gotweb_render_tag(struct template *);
492 int gotweb_render_diff(struct template *);
493 int gotweb_render_branches(struct template *, struct got_reflist_head *);
494 int gotweb_render_summary(struct template *);
495 int gotweb_render_blame(struct template *);
496 int gotweb_render_rss(struct template *);
499 int parse_config(const char *, struct gotwebd *);
500 int cmdline_symset(char *);
503 void fcgi_request(int, short, void *);
504 void fcgi_timeout(int, short, void *);
505 void fcgi_cleanup_request(struct request *);
506 void fcgi_create_end_record(struct request *);
507 void dump_fcgi_record(const char *, struct fcgi_record_header *);
508 int fcgi_write(void *, const void *, size_t);
510 /* got_operations.c */
511 const struct got_error *got_gotweb_closefile(FILE *);
512 const struct got_error *got_get_repo_owner(char **, struct request *);
513 const struct got_error *got_get_repo_age(time_t *, struct request *,
515 const struct got_error *got_get_repo_commits(struct request *, size_t);
516 const struct got_error *got_get_repo_tags(struct request *, size_t);
517 const struct got_error *got_get_repo_heads(struct request *);
518 const struct got_error *got_open_diff_for_output(FILE **, struct request *);
519 int got_output_repo_tree(struct request *,
520 int (*)(struct template *, struct got_tree_entry *));
521 const struct got_error *got_open_blob_for_output(struct got_blob_object **,
522 int *, int *, struct request *);
523 int got_output_blob_by_lines(struct template *, struct got_blob_object *,
524 int (*)(struct template *, const char *, size_t));
525 const struct got_error *got_output_file_blame(struct request *,
526 got_render_blame_line_cb);
529 int config_setserver(struct gotwebd *, struct server *);
530 int config_getserver(struct gotwebd *, struct imsg *);
531 int config_setsock(struct gotwebd *, struct socket *);
532 int config_getsock(struct gotwebd *, struct imsg *);
533 int config_setfd(struct gotwebd *, struct socket *);
534 int config_getfd(struct gotwebd *, struct imsg *);
535 int config_getcfg(struct gotwebd *, struct imsg *);
536 int config_init(struct gotwebd *);
539 void log_init(int, int);
540 void log_procinit(const char *);
541 void log_setverbose(int);
542 int log_getverbose(void);
543 void log_warn(const char *, ...)
544 __attribute__((__format__ (printf, 1, 2)));
545 void log_warnx(const char *, ...)
546 __attribute__((__format__ (printf, 1, 2)));
547 void log_info(const char *, ...)
548 __attribute__((__format__ (printf, 1, 2)));
549 void log_debug(const char *, ...)
550 __attribute__((__format__ (printf, 1, 2)));
551 void logit(int, const char *, ...)
552 __attribute__((__format__ (printf, 2, 3)));
553 void vlog(int, const char *, va_list)
554 __attribute__((__format__ (printf, 2, 0)));
555 __dead void fatal(const char *, ...)
556 __attribute__((__format__ (printf, 1, 2)));
557 __dead void fatalx(const char *, ...)
558 __attribute__((__format__ (printf, 1, 2)));