1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
|
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2023 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
#
#
# LICENSE:
#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
#
#
# CONTRIBUTION SUBMISSION POLICY:
#
# (The following paragraph is not intended to limit the rights granted
# to you to modify and distribute this software under the terms of
# the GNU General Public License and is only of importance to you if
# you choose to contribute your changes and enhancements to the
# community by submitting them to Best Practical Solutions, LLC.)
#
# By intentionally submitting any modifications, corrections or
# derivatives to this work, or any other work intended for use with
# Request Tracker, to Best Practical Solutions, LLC, you confirm that
# you are the copyright holder for those contributions and you grant
# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
# royalty-free, perpetual, license to use, copy, create derivative
# works based on those contributions, and sublicense and distribute
# those contributions and any derivatives thereof.
#
# END BPS TAGGED BLOCK }}}
use warnings;
use strict;
package RT::PlackRunner;
use base 'Plack::Runner';
sub new {
my $class = shift;
return $class->SUPER::new( default_middleware => 0, @_ );
}
sub parse_options {
my $self = shift;
my @args = @_;
# handle "rt-server 8888" for back-compat, but complain about it
if (@args && $args[0] =~ m/^\d+$/) {
warn "Deprecated: please run $0 --port $ARGV[0] instead\n";
unshift @args, '--port';
}
$self->SUPER::parse_options(@args);
$self->{app} ||= $self->app;
$self->{server} ||= $self->loader->guess;
my %args = @{$self->{options}};
$self->{webpath} ||= $args{webpath} if $args{webpath};
if ($self->{server} eq "FCGI") {
# We deal with the possible failure modes of this in ->run
} elsif ($args{port}) {
$self->{explicit_port} = 1;
my $old_app = $self->{app};
$self->{app} = sub {
my $env = shift;
$env->{'rt.explicit_port'} = $args{port};
$old_app->($env, @_);
};
} else {
$self->set_options(port => (RT->Config->Get('WebPort') || '8080'));
}
}
# Don't assume port 5000 with no port or socket supplied; this allows
# the WebPort default to kick in (above), and also to provide useful
# error messages when starting FCGI without any options.
sub mangle_host_port_socket {
my $self = shift;
my ($host, $port, $socket, @listen) = @_;
return $self->SUPER::mangle_host_port_socket(@_)
if @listen or $port or $socket;
return host => $host, port => $port, socket => $socket,
@listen ? (listen => \@listen) : ();
}
sub app {
require RT::Interface::Web::Handler;
my $app = RT::Interface::Web::Handler->PSGIApp;
if ($ENV{RT_TESTING}) {
my $screen_logger = $RT::Logger->remove('screen');
require Log::Dispatch::Perl;
$RT::Logger->add(
Log::Dispatch::Perl->new(
name => 'rttest',
min_level => $screen_logger->min_level,
action => {
error => 'warn',
critical => 'warn'
}
)
);
require Plack::Middleware::Test::StashWarnings;
$app = Plack::Middleware::Test::StashWarnings->wrap($app);
}
return $app;
}
sub run {
my $self = shift;
my %args = @{$self->{options}};
# Plack::Handler::FCGI has its own catch for this, but doesn't
# notice that listen is an empty list, and we can also provide a
# better error message.
if ($self->{server} eq "FCGI" and not -S STDIN and not @{$args{listen} || []}) {
print STDERR "STDIN is not a socket, and no --listen, --socket, or --port provided\n";
exit 1;
}
if ( $self->{webpath} ){
require Plack::App::URLMap;
my $urlmap = Plack::App::URLMap->new;
$urlmap->map($self->{webpath} => $self->{app});
$self->{app} = $urlmap->to_app;
}
eval { $self->SUPER::run(@_) };
my $err = $@;
exit 0 unless $err;
if ( $err =~ /listen/ ) {
print STDERR <<EOF;
WARNING: RT couldn't start up a web server on port $args{port}.
This is often the case if the port is already in use or you're running @{[$0]}
as someone other than your system's "root" user. You may also specify a
temporary port with: $0 --port <port>
EOF
if ($self->{explicit_port}) {
print STDERR
"Please check your system configuration or choose another port\n\n";
}
exit 1;
} else {
die
"Something went wrong while trying to run RT's standalone web server:\n\t"
. $err;
}
}
1;
|