-# Copyright (C) 2015-2021 all contributors <meta@public-inbox.org>
+# Copyright (C) all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
#
# Contains common daemon code for the httpd, imapd, and nntpd servers
# and/or lossy connections.
package PublicInbox::Daemon;
use strict;
-use warnings;
-use Getopt::Long qw/:config gnu_getopt no_ignore_case auto_abbrev/;
+use v5.10.1;
+use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
use IO::Handle; # ->autoflush
use IO::Socket;
+use File::Spec;
use POSIX qw(WNOHANG :signal_h);
use Socket qw(IPPROTO_TCP SOL_SOCKET);
STDOUT->autoflush(1);
STDERR->autoflush(1);
use PublicInbox::DS qw(now);
-require PublicInbox::Listener;
+use PublicInbox::Listener;
use PublicInbox::EOFpipe;
use PublicInbox::Sigfd;
+use PublicInbox::Git;
use PublicInbox::GitAsyncCat;
+use PublicInbox::Eml;
our $SO_ACCEPTFILTER = 0x1000;
my @CMD;
my ($set_user, $oldset);
my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
my $worker_processes = 1;
my @listeners;
-my %pids;
+my (%pids, %logs);
my %tls_opt; # scheme://sockname => args for IO::Socket::SSL->start_SSL
my $reexec_pid;
my ($uid, $gid);
my ($default_cert, $default_key);
-my %KNOWN_TLS = ( 443 => 'https', 563 => 'nntps', 993 => 'imaps' );
-my %KNOWN_STARTTLS = ( 119 => 'nntp', 143 => 'imap' );
+my %KNOWN_TLS = (443 => 'https', 563 => 'nntps', 993 => 'imaps', 995 =>'pop3s');
+my %KNOWN_STARTTLS = (110 => 'pop3', 119 => 'nntp', 143 => 'imap');
-sub accept_tls_opt ($) {
- my ($opt_str) = @_;
- # opt_str: opt1=val1,opt2=val2 (opt may repeat for multi-value)
- require PublicInbox::TLS;
+sub listener_opt ($) {
+ my ($str) = @_; # opt1=val1,opt2=val2 (opt may repeat for multi-value)
my $o = {};
# allow ',' as delimiter since '&' is shell-unfriendly
- foreach (split(/[,&]/, $opt_str)) {
+ for (split(/[,&]/, $str)) {
my ($k, $v) = split(/=/, $_, 2);
- push @{$o->{$k} ||= []}, $v;
+ push @{$o->{$k}}, $v;
}
# key may be a part of cert. At least
# p5-io-socket-ssl/example/ssl_server.pl has this fallback:
- $o->{cert} //= [ $default_cert ];
+ $o->{cert} //= [ $default_cert ] if defined($default_cert);
$o->{key} //= defined($default_key) ? [ $default_key ] : $o->{cert};
+ $o;
+}
+
+sub accept_tls_opt ($) {
+ my ($opt) = @_;
+ my $o = ref($opt) eq 'HASH' ? $opt : listener_opt($opt);
+ return if !defined($o->{cert});
+ require PublicInbox::TLS;
my %ctx_opt = (SSL_server => 1);
# parse out hostname:/path/to/ mappings:
- foreach my $k (qw(cert key)) {
+ for my $k (qw(cert key)) {
+ $o->{$k} // next;
my $x = $ctx_opt{'SSL_'.$k.'_file'} = {};
foreach my $path (@{$o->{$k}}) {
my $host = '';
{ SSL_server => 1, SSL_startHandshake => 0, SSL_reuse_ctx => $ctx };
}
-sub daemon_prepare ($) {
- my ($default_listen) = @_;
+sub check_absolute ($$) {
+ my ($var, $val) = @_;
+ die <<EOM if index($val // '/', '/') != 0;
+$var must be an absolute path when using --daemonize: $val
+EOM
+}
+
+sub do_chown ($) {
+ $uid // return;
+ my ($path) = @_;
+ chown($uid, $gid, $path) or warn "chown $path: $!\n";
+}
+
+sub open_log_path ($$) { # my ($fh, $path) = @_; # $_[0] is modified
+ open $_[0], '>>', $_[1] or die "open(>> $_[1]): $!";
+ $_[0]->autoflush(1);
+ do_chown($_[1]);
+}
+
+sub load_mod ($;$) {
+ my ($scheme, $opt) = @_;
+ my $modc = "PublicInbox::\U$scheme";
+ my $mod = $modc.'D';
+ eval "require $mod"; # IMAPD|HTTPD|NNTPD|POP3D
+ die $@ if $@;
+ my %xn;
+ my $tlsd = $xn{tlsd} = $mod->new;
+ my %env = map {
+ substr($_, length('env.')) => $opt->{$_}->[-1];
+ } grep(/\Aenv\./, keys %$opt);
+ $xn{refresh} = sub {
+ my ($sig) = @_;
+ local @ENV{keys %env} = values %env;
+ $tlsd->refresh_groups($sig);
+ };
+ $xn{post_accept} = $tlsd->can('post_accept_cb') ?
+ $tlsd->post_accept_cb : sub { $modc->new($_[0], $tlsd) };
+ my @paths = qw(out err);
+ if ($modc eq 'PublicInbox::HTTP') {
+ @paths = qw(err);
+ $xn{af_default} = 'httpready';
+ if (my $p = $opt->{psgi}) {
+ die "multiple psgi= options specified\n" if @$p > 1;
+ check_absolute('psgi=', $p->[0]) if $daemonize;
+ $tlsd->{psgi} = $p->[0];
+ }
+ }
+ for my $f (@paths) {
+ my $p = $opt->{$f} or next;
+ die "multiple $f= options specified\n" if @$p > 1;
+ check_absolute("$f=", $p->[0]) if $daemonize;
+ $p = File::Spec->canonpath($p->[0]);
+ open_log_path(my $fh, $p);
+ $tlsd->{$f} = $logs{$p} = $fh;
+ }
+ \%xn;
+}
+
+sub daemon_prepare ($$) {
+ my ($default_listen, $xnetd) = @_;
my $listener_names = {}; # sockname => IO::Handle
$oldset = PublicInbox::DS::block_signals();
@CMD = ($0, @ARGV);
my ($prog) = ($CMD[0] =~ m!([^/]+)\z!g);
+ my $dh = defined($default_listen) ? " (default: $default_listen)" : '';
my $help = <<EOF;
usage: $prog [-l ADDRESS] [--cert=FILE] [--key=FILE]
options:
- -l ADDRESS address to listen on (default: $default_listen)
+ -l ADDRESS address to listen on$dh
--cert=FILE default SSL/TLS certificate
--key=FILE default SSL/TLS certificate
-W WORKERS number of worker processes to spawn (default: 1)
GetOptions(%opt) or die $help;
if ($show_help) { print $help; exit 0 };
+ $_ = File::Spec->canonpath($_ // next) for ($stdout, $stderr);
if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
die "--pid-file cannot end with '.oldbin'\n";
}
# ignore daemonize when inheriting
$daemonize = undef if scalar @listeners;
- push @cfg_listen, $default_listen unless (@listeners || @cfg_listen);
+ unless (@listeners || @cfg_listen) {
+ $default_listen // die "no listeners specified\n";
+ push @cfg_listen, $default_listen
+ }
foreach my $l (@cfg_listen) {
my $orig = $l;
my $s = $KNOWN_TLS{$1} // $KNOWN_STARTTLS{$1};
$scheme = $s if defined $s;
}
+ my $opt; # non-TLS options
if ($l =~ s!/?\?(.+)\z!!) {
- $tls_opt{"$scheme://$l"} = accept_tls_opt($1);
+ $opt = listener_opt($1);
+ $tls_opt{"$scheme://$l"} = accept_tls_opt($opt);
} elsif (defined($default_cert)) {
$tls_opt{"$scheme://$l"} = accept_tls_opt('');
- } elsif ($scheme =~ /\A(?:https|imaps|imaps)\z/) {
+ } elsif ($scheme =~ /\A(?:https|imaps|nntps|pop3s)\z/) {
die "$orig specified w/o cert=\n";
}
- # TODO: use scheme to load either NNTP.pm or HTTP.pm
+ $scheme =~ /\A(http|imap|nntp|pop3)/ and
+ $xnetd->{$l} = load_mod($1, $opt);
next if $listener_names->{$l}; # already inherited
my (%o, $sock_pkg);
for my $sockname (@inherited_names) {
$sockname =~ /:([0-9]+)\z/ or next;
if (my $scheme = $KNOWN_TLS{$1}) {
+ $xnetd->{$sockname} = load_mod(substr($scheme, 0, -1));
$tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
} elsif (($scheme = $KNOWN_STARTTLS{$1})) {
- next if $tls_opt{"$scheme://$sockname"};
+ $xnetd->{$sockname} = load_mod($scheme);
+ $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
$tls_opt{''} ||= accept_tls_opt('');
}
}
-
+ my @d;
+ while (my ($k, $v) = each %tls_opt) { push(@d, $k) if !defined($v) }
+ delete @tls_opt{@d};
die "No listeners bound\n" unless @listeners;
}
-sub check_absolute ($$) {
- my ($var, $val) = @_;
- if (defined $val && index($val, '/') != 0) {
- die
-"--$var must be an absolute path when using --daemonize: $val\n";
- }
-}
-
sub daemonize () {
if ($daemonize) {
require Cwd;
next unless -e $arg;
$ARGV[$i] = Cwd::abs_path($arg);
}
- check_absolute('stdout', $stdout);
- check_absolute('stderr', $stderr);
- check_absolute('pid-file', $pid_file);
+ check_absolute('--stdout', $stdout);
+ check_absolute('--stderr', $stderr);
+ check_absolute('--pid-file', $pid_file);
chdir '/' or die "chdir failed: $!";
}
my ($dmap, undef) = @_;
my $n = 0;
my $now = now();
-
- foreach my $s (values %$dmap) {
+ for my $s (values %$dmap) {
$s->can('busy') or next;
- if ($s->busy($now)) {
+ if ($s->busy) {
++$n;
- } else {
- # close as much as possible, early as possible
+ } else { # close as much as possible, early as possible
$s->close;
}
}
}
sub reopen_logs {
- if ($stdout) {
- open STDOUT, '>>', $stdout or
- warn "failed to redirect stdout to $stdout: $!\n";
- STDOUT->autoflush(1);
- do_chown($stdout);
- }
- if ($stderr) {
- open STDERR, '>>', $stderr or
- warn "failed to redirect stderr to $stderr: $!\n";
- STDERR->autoflush(1);
- do_chown($stderr);
- }
+ $logs{$stdout} //= \*STDOUT if defined $stdout;
+ $logs{$stderr} //= \*STDERR if defined $stderr;
+ while (my ($p, $fh) = each %logs) { open_log_path($fh, $p) }
}
sub sockname ($) {
}
}
-sub daemon_loop ($$$$) {
- my ($refresh, $post_accept, $tlsd, $af_default) = @_;
+sub daemon_loop ($) {
+ my ($xnetd) = @_;
+ my $refresh = sub {
+ my ($sig) = @_;
+ for my $xn (values %$xnetd) {
+ eval { $xn->{refresh}->($sig) };
+ warn "refresh $@\n" if $@;
+ }
+ };
my %post_accept;
while (my ($k, $v) = each %tls_opt) {
- if ($k =~ s!\A(?:https|imaps|nntps)://!!) {
- $post_accept{$k} = tls_start_cb($v, $post_accept);
- } elsif ($tlsd) { # STARTTLS, $k eq '' is OK
- $tlsd->{accept_tls} = $v;
+ my $l = $k;
+ $l =~ s!\A([^:]+)://!!;
+ my $scheme = $1 // '';
+ my $xn = $xnetd->{$l} // $xnetd->{''};
+ if ($scheme =~ m!\A(?:https|imaps|nntps|pop3s)!) {
+ $post_accept{$l} = tls_start_cb($v, $xn->{post_accept});
+ } elsif ($xn->{tlsd}) { # STARTTLS, $k eq '' is OK
+ $xn->{tlsd}->{accept_tls} = $v;
}
}
my $sig = {
$uid = $gid = undef;
reopen_logs();
@listeners = map {;
- my $tls_cb = $post_accept{sockname($_)};
+ my $l = sockname($_);
+ my $tls_cb = $post_accept{$l};
+ my $xn = $xnetd->{$l} // $xnetd->{''};
# NNTPS, HTTPS, HTTP, IMAPS and POP3S are client-first traffic
# IMAP, NNTP and POP3 are server-first
- defer_accept($_, $tls_cb ? 'dataready' : $af_default);
+ defer_accept($_, $tls_cb ? 'dataready' : $xn->{af_default});
# this calls epoll_create:
- PublicInbox::Listener->new($_, $tls_cb || $post_accept)
+ PublicInbox::Listener->new($_, $tls_cb || $xn->{post_accept})
} @listeners;
PublicInbox::DS::event_loop($sig, $oldset);
}
-sub run ($$$;$) {
- my ($default, $refresh, $post_accept, $tlsd) = @_;
- daemon_prepare($default);
- my $af_default = $default =~ /:8080\z/ ? 'httpready' : undef;
+sub run {
+ my ($default_listen) = @_;
+ my $xnetd = {};
+ if ($default_listen) {
+ $default_listen =~ /\A(http|imap|nntp|pop3)/ or
+ die "BUG: $default_listen";
+ $xnetd->{''} = load_mod($1);
+ }
+ daemon_prepare($default_listen, $xnetd);
my $for_destroy = daemonize();
# localize GCF2C for tests:
local $PublicInbox::GitAsyncCat::GCF2C;
+ local $PublicInbox::Git::async_warn = 1;
+ local $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
- daemon_loop($refresh, $post_accept, $tlsd, $af_default);
+ daemon_loop($xnetd);
PublicInbox::DS->Reset;
# ->DESTROY runs when $for_destroy goes out-of-scope
}
-sub do_chown ($) {
- my ($path) = @_;
- if (defined $uid and !chown($uid, $gid, $path)) {
- warn "could not chown $path: $!\n";
- }
-}
-
sub write_pid ($) {
my ($path) = @_;
Net::Server::Daemonize::create_pid_file($path);