X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FScript%2FServer.pm;h=1848e4a7e61ec9e7ced60db8d7c983a9c72e8965;hp=22bafcbd64dca205d3f340a14e4009d2a15d4fd9;hb=35b3434762d426e0cd5e04eb735291f8ca7ea08e;hpb=3a8c155fa0077e949f68f29fbe4b835d5484a2c9 diff --git a/lib/Catalyst/Script/Server.pm b/lib/Catalyst/Script/Server.pm index 22bafcb..1848e4a 100644 --- a/lib/Catalyst/Script/Server.pm +++ b/lib/Catalyst/Script/Server.pm @@ -1,126 +1,198 @@ package Catalyst::Script::Server; - -BEGIN { - $ENV{CATALYST_ENGINE} ||= 'HTTP'; - require Catalyst::Engine::HTTP; -} - use Moose; -use MooseX::Types::Moose qw/ArrayRef Str Bool Int/; +use Catalyst::Utils; +use Class::Load qw(try_load_class load_class); use namespace::autoclean; with 'Catalyst::ScriptRole'; -__PACKAGE__->meta->get_attribute('help')->cmd_aliases('?'); - has debug => ( - traits => [qw(Getopt)], - cmd_aliases => 'd', - isa => Bool, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'd', + isa => 'Bool', + is => 'ro', documentation => q{Force debug mode}, ); has host => ( - traits => [qw(Getopt)], - cmd_aliases => 'h', - isa => Str, - is => 'ro', - default => 'localhost', - documentation => 'Specify an IP on this host for the server to bind to', + traits => [qw(Getopt)], + cmd_aliases => 'h', + isa => 'Str', + is => 'ro', + # N.B. undef (the default) means we bind on all interfaces on the host. + documentation => 'Specify a hostname or IP on this host for the server to bind to', ); has fork => ( - traits => [qw(Getopt)], - cmd_aliases => 'f', - isa => Bool, - is => 'ro', - default => 0, + traits => [qw(Getopt)], + cmd_aliases => 'f', + isa => 'Bool', + is => 'ro', + default => 0, documentation => 'Fork the server to be able to serve multiple requests at once', ); has port => ( - traits => [qw(Getopt)], - cmd_aliases => 'p', - isa => Int, - is => 'ro', - default => 3000, + traits => [qw(Getopt)], + cmd_aliases => 'p', + isa => 'Int', + is => 'ro', + default => sub { + Catalyst::Utils::env_value(shift->application_name, 'port') || 3000 + }, documentation => 'Specify a different listening port (to the default port 3000)', ); +use Moose::Util::TypeConstraints; +class_type 'MooseX::Daemonize::Pid::File'; +subtype 'Catalyst::Script::Server::Types::Pidfile', + as 'MooseX::Daemonize::Pid::File'; + +coerce 'Catalyst::Script::Server::Types::Pidfile', from 'Str', via { + my ($success, $error) = try_load_class("MooseX::Daemonize::Pid::File"); + warn("Could not load MooseX::Daemonize::Pid::File, needed for --pid option: $error\n"), + exit 1 if not $success; + MooseX::Daemonize::Pid::File->new( file => $_ ); +}; +MooseX::Getopt::OptionTypeMap->add_option_type_to_map( + 'Catalyst::Script::Server::Types::Pidfile' => '=s', +); has pidfile => ( - traits => [qw(Getopt)], - cmd_aliases => 'pid', - isa => Str, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'pid', + isa => 'Catalyst::Script::Server::Types::Pidfile', + is => 'ro', documentation => 'Specify a pidfile', + coerce => 1, + predicate => '_has_pidfile', ); +# Override MooseX::Daemonize +sub dont_close_all_files { 1 } +sub BUILD { + my $self = shift; + + if ($self->background) { + # FIXME - This is evil. Should we just add MX::Daemonize to the deps? + my ($success, $error) = try_load_class("MooseX::Daemonize::Core"); + warn("MooseX::Daemonize is needed for the --background option: $error\n"), + exit 1 if not $success; + my ($success, $error) = try_load_class("POSIX"); + warn("$error\n"), exit 1 if not $success; + MooseX::Daemonize::Core->meta->apply($self); + POSIX::close($_) foreach (0..2); + } +} + has keepalive => ( - traits => [qw(Getopt)], - cmd_aliases => 'k', - isa => Bool, - is => 'ro', - default => 0, + traits => [qw(Getopt)], + cmd_aliases => 'k', + isa => 'Bool', + is => 'ro', + default => 0, documentation => 'Support keepalive', ); has background => ( - traits => [qw(Getopt)], - cmd_aliases => 'bg', - isa => Bool, - is => 'ro', - default => 0, + traits => [qw(Getopt)], + cmd_aliases => 'bg', + isa => 'Bool', + is => 'ro', + default => 0, documentation => 'Run in the background', ); has restart => ( - traits => [qw(Getopt)], - cmd_aliases => 'r', - isa => Bool, - is => 'ro', - default => 0, + traits => [qw(Getopt)], + cmd_aliases => 'r', + isa => 'Bool', + is => 'ro', + default => sub { + Catalyst::Utils::env_value(shift->application_name, 'reload') || 0; + }, documentation => 'use Catalyst::Restarter to detect code changes and restart the application', ); has restart_directory => ( - traits => [qw(Getopt)], - cmd_aliases => 'rdir', - isa => ArrayRef[Str], - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => [ 'rdir', 'restartdirectory' ], + isa => 'ArrayRef[Str]', + is => 'ro', documentation => 'Restarter directory to watch', - predicate => '_has_restart_directory', + predicate => '_has_restart_directory', ); has restart_delay => ( - traits => [qw(Getopt)], - cmd_aliases => 'rd', - isa => Int, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'rd', + isa => 'Int', + is => 'ro', documentation => 'Set a restart delay', - predicate => '_has_restart_delay', + predicate => '_has_restart_delay', ); -has restart_regex => ( - traits => [qw(Getopt)], - cmd_aliases => 'rr', - isa => Str, - is => 'ro', - documentation => 'Restart regex', - predicate => '_has_restart_regex', -); +{ + use Moose::Util::TypeConstraints; + + my $tc = subtype 'Catalyst::Script::Server::Types::RegexpRef', as 'RegexpRef'; + coerce $tc, from 'Str', via { qr/$_/ }; + + MooseX::Getopt::OptionTypeMap->add_option_type_to_map($tc => '=s'); + + has restart_regex => ( + traits => [qw(Getopt)], + cmd_aliases => 'rr', + isa => $tc, + coerce => 1, + is => 'ro', + documentation => 'Restart regex', + predicate => '_has_restart_regex', + ); +} has follow_symlinks => ( - traits => [qw(Getopt)], - cmd_aliases => 'sym', - isa => Bool, - is => 'ro', - default => 0, + traits => [qw(Getopt)], + cmd_aliases => 'sym', + isa => 'Bool', + is => 'ro', + default => 0, documentation => 'Follow symbolic links', + predicate => '_has_follow_symlinks', +); + +sub _plack_engine_name { + my $self = shift; + return $self->fork || $self->keepalive ? 'Starman' : 'Standalone'; +} + +sub _restarter_args { + my $self = shift; + + return ( + argv => $self->ARGV, + start_sub => sub { $self->_run_application }, + ($self->_has_follow_symlinks ? (follow_symlinks => $self->follow_symlinks) : ()), + ($self->_has_restart_delay ? (sleep_interval => $self->restart_delay) : ()), + ($self->_has_restart_directory ? (directories => $self->restart_directory) : ()), + ($self->_has_restart_regex ? (filter => $self->restart_regex) : ()), + ), + ( + map { $_ => $self->$_ } qw(application_name host port debug pidfile fork background keepalive) + ); +} + +has restarter_class => ( + is => 'ro', + isa => 'Str', + lazy => 1, + default => sub { + my $self = shift; + Catalyst::Utils::env_value($self->application_name, 'RESTARTER') || 'Catalyst::Restarter'; + } ); sub run { - my ($self) = shift; + my $self = shift; local $ENV{CATALYST_DEBUG} = 1 if $self->debug; @@ -128,6 +200,8 @@ sub run { if ( $self->restart ) { die "Cannot run in the background and also watch for changed files.\n" if $self->background; + die "Cannot write out a pid file and fork for the restarter.\n" + if $self->_has_pidfile; # If we load this here, then in the case of a restarter, it does not # need to be reloaded for each restart. @@ -137,41 +211,61 @@ sub run { # fail. $| = 1 if $ENV{HARNESS_ACTIVE}; - require Catalyst::Restarter; - - my $subclass = Catalyst::Restarter->pick_subclass; + Catalyst::Utils::ensure_class_loaded($self->restarter_class); - my %args; - $args{follow_symlinks} = $self->follow_symlinks - if $self->follow_symlinks; - $args{directories} = $self->restart_directory - if $self->_has_restart_directory; - $args{sleep_interval} = $self->restart_delay - if $self->_has_restart_delay; - $args{filter} = qr/$self->restart_regex/ - if $self->_has_restart_regex; + my $subclass = $self->restarter_class->pick_subclass; my $restarter = $subclass->new( - %args, - start_sub => sub { $self->_run_application }, - argv => $self->ARGV, + $self->_restarter_args() ); $restarter->run_and_watch; } else { + if ($self->background) { + $self->daemon_fork; + + return 1 unless $self->is_daemon; + + load_class($self->application_name); + + $self->daemon_detach; + } + + $self->pidfile->write + if $self->_has_pidfile; + $self->_run_application; } } -sub _application_args { +sub _plack_loader_args { my ($self) = shift; return ( + port => $self->port, + host => $self->host, + keepalive => $self->keepalive ? 100 : 1, + server_ready => sub { + my ($args) = @_; + + my $name = $args->{server_software} || ref($args); # $args is $server + my $host = $args->{host} || 0; + my $proto = $args->{proto} || 'http'; + + print STDERR "$name: Accepting connections at $proto://$host:$args->{port}/\n"; + }, + ); +} + +around _application_args => sub { + my ($orig, $self) = @_; + return ( $self->port, $self->host, { + %{ $self->$orig }, map { $_ => $self->$_ } qw/ fork keepalive @@ -179,13 +273,14 @@ sub _application_args { pidfile keepalive follow_symlinks + port + host /, }, ); -} +}; __PACKAGE__->meta->make_immutable; - 1; =head1 NAME @@ -200,19 +295,19 @@ Catalyst::Script::Server - Catalyst test server -d --debug force debug mode -f --fork handle each request in a new process (defaults to false) - -h --help display this help and exits - --host host (defaults to all) + --help display this help and exits + -h --host host (defaults to all) -p --port port (defaults to 3000) -k --keepalive enable keep-alive connections -r --restart restart when files get modified (defaults to false) - --rd --restartdelay delay between file checks + --rd --restart_delay delay between file checks (ignored if you have Linux::Inotify2 installed) - --rr --restartregex regex match files that trigger + --rr --restart_regex regex match files that trigger a restart when modified (defaults to '\.yml$|\.yaml$|\.conf|\.pm$') - --rdir --restartdirectory the directory to search for - modified files, can be set mulitple times + --rdir --restart_directory the directory to search for + modified files, can be set multiple times (defaults to '[SCRIPT_DIR]/..') --sym --follow_symlinks follow symlinks in search directories (defaults to false. this is a no-op on Win32) @@ -227,6 +322,10 @@ Catalyst::Script::Server - Catalyst test server Run a Catalyst test server for this application. +=head1 SEE ALSO + +L + =head1 AUTHORS Catalyst Contributors, see Catalyst.pm