package Web::Simple::Application;
+use Scalar::Util 'weaken';
+
use Moo;
has 'config' => (
sub _build__dispatcher {
my $self = shift;
require Web::Dispatch;
- require Web::Simple::DispatchNode;
my $final = $self->_build_final_dispatcher;
- Web::Dispatch->new(
- app => sub { $self->dispatch_request(@_), $final },
- node_class => 'Web::Simple::DispatchNode',
- node_args => { app_object => $self }
+
+ # We need to weaken both the copy of $self that the
+ # app parameter will close over and the copy that'll
+ # be passed through as a node argument.
+ #
+ # To ensure that this doesn't then result in us being
+ # DESTROYed unexpectedly early, our to_psgi_app method
+ # closes back over $self
+
+ weaken($self);
+ my %dispatch_args = (
+ dispatch_app => sub { $self->dispatch_request(@_), $final },
+ dispatch_object => $self
);
+ weaken($dispatch_args{dispatch_object});
+ Web::Dispatch->new(%dispatch_args);
}
sub _build_final_dispatcher {
sub _run_cgi {
my $self = shift;
- require Plack::Server::CGI;
- Plack::Server::CGI->run($self->to_psgi_app);
+ require Plack::Handler::CGI;
+ Plack::Handler::CGI->new->run($self->to_psgi_app);
}
sub _run_fcgi {
my $self = shift;
- require Plack::Server::FCGI;
- Plack::Server::FCGI->run($self->to_psgi_app);
+ require Plack::Handler::FCGI;
+ Plack::Handler::FCGI->new->run($self->to_psgi_app);
}
sub to_psgi_app {
my $self = ref($_[0]) ? $_[0] : $_[0]->new;
- $self->_dispatcher->to_app;
+ my $app = $self->_dispatcher->to_app;
+
+ # Close over $self to keep $self alive even though
+ # we weakened the copies the dispatcher has; the
+ # if 0 causes the ops to be optimised away to
+ # minimise the performance impact and avoid void
+ # context warnings while still doing the closing
+ # over part. As Mithaldu said: "Gnarly." ...
+
+ return sub { $self if 0; goto &$app; };
}
sub run {
my $self = shift;
- if ($ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}) {
- return $self->_run_fcgi;
- } elsif ($ENV{GATEWAY_INTERFACE}) {
- return $self->_run_cgi;
- }
- unless (@ARGV && $ARGV[0] =~ m{^[A-Z/]}) {
- return $self->_run_cli(@ARGV);
- }
-
- my @args = @ARGV;
-
- unshift(@args, 'GET') if $args[0] =~ m{^/};
+ return $self->_run_fcgi if
+ $ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}
+ || ( -S STDIN && !$ENV{GATEWAY_INTERFACE} );
+ # If STDIN is a socket, almost certainly FastCGI, except for mod_cgid
+ return $self->_run_cgi if $ENV{GATEWAY_INTERFACE};
+ return $self->run_cli(@ARGV);
+}
- $self->_run_test_request(@args);
+sub run_cli_request {
+ my ($self, @args) = @_;
+ return if !@args || $args[0] !~ m{(^[A-Z/])|\@};
+ unshift @args, 'GET' if $args[0] !~ /^[A-Z]/;
+ $self->_run_cli_test_request(@args);
+ return 1;
}
-sub _run_test_request {
+sub _test_request_spec_to_http_request {
my ($self, $method, $path, @rest) = @_;
- require HTTP::Request;
- require Plack::Test;
+ # if it's a reference, assume a request object
+ return $method if ref($method);
+
+ if ($path =~ s/^(.*?)\@//) {
+ my $basic = $1;
+ require MIME::Base64;
+ unshift @rest, 'Authorization:', 'Basic '.MIME::Base64::encode($basic);
+ }
my $request = HTTP::Request->new($method => $path);
- if ($method eq 'POST' or $method eq 'PUT' and @rest) {
+
+ my @params;
+
+ while (my ($header, $value) = splice(@rest, 0, 2)) {
+ unless ($header =~ s/:$//) {
+ push @params, $header, $value;
+ }
+ $header =~ s/_/-/g;
+ if ($header eq 'Content') {
+ $request->content($value);
+ } else {
+ $request->headers->push_header($header, $value);
+ }
+ }
+
+ if (($method eq 'POST' or $method eq 'PUT') and @params) {
my $content = do {
require URI;
my $url = URI->new('http:');
- $url->query_form(@rest);
+ $url->query_form(@params);
$url->query;
};
$request->header('Content-Type' => 'application/x-www-form-urlencoded');
$request->header('Content-Length' => length($content));
$request->content($content);
}
- my $response;
+
+ return $request;
+}
+
+sub run_test_request {
+ my ($self, @req) = @_;
+
+ require HTTP::Request;
+
+ require Plack::Test;
+
+ my $request = $self->_test_request_spec_to_http_request(@req);
+
Plack::Test::test_psgi(
- $self->to_psgi_app, sub { $response = shift->($request) }
+ $self->to_psgi_app, sub { shift->($request) }
);
+}
+
+sub _run_cli_test_request {
+ my ($self, @req) = @_;
+ my $response = $self->run_test_request(@req);
+
+ binmode(STDOUT); binmode(STDERR); # for win32
+
print STDERR $response->status_line."\n";
print STDERR $response->headers_as_string("\n")."\n";
- print STDOUT $response->content."\n";
+ my $content = $response->content;
+ $content .= "\n" if length($content) and $content !~ /\n\z/;
+ print STDOUT $content if $content;
}
-sub _run_cli {
- my $self = shift;
- die $self->_cli_usage;
+sub run_cli {
+ my ($self, @args) = @_;
+ return $self->run_cli_request(@args) || die $self->cli_request_usage;
}
-sub _cli_usage {
- "To run this script in CGI test mode, pass a URL path beginning with /:\n".
+sub cli_request_usage {
+ "This application does not implement its own run_cli method. To run\n".
+ "this script in CGI test mode, pass a URL path beginning with /:\n".
"\n".
" $0 /some/path\n".
" $0 /\n"
=head2 run_if_script
-The run_if_script method is designed to be used at the end of the script
+The C<run_if_script> method is designed to be used at the end of the script
or .pm file where your application class is defined - for example:
## my_web_simple_app.pl
will work fine (and you can rename it to lib/HelloWorld.pm later to make it
a real use-able module).
-However, it detects if it's being run as a script (via testing $0) and if
-so attempts to do the right thing.
+Specifically, this true value is a PSGI app. You can you can pass the return
+value of C<HelloWorld->run_if_script> to code expecting a PSGI app and you can
+treat the file as though it were a standard PSGI application file (*.psgi). For
+example you can start it up with C<plackup>
+
+ plackup my_web_simple_app.pl
+
+or C<starman>
+
+ starman my_web_simple_app.pl
+
+If C<run_if_script> is called from a situation where there is no caller, i.e. as
+C<perl my_web_simple_app.pl> on the shell, or by a web server, it will call the
+C<run> method to run the actual application itself.
+
+=head2 run
If run under a CGI environment, your application will execute as a CGI.
FastCGI process (this works both for dynamic shared-hosting-style FastCGI
and for apache FastCgiServer style setups).
-If run from the commandline with a URL path, it runs a GET request against
-that path -
+If neither of these are the case, it defaults to running the C<run_cli> method
+with C<@ARGV> as arguments.
+
+=head2 run_cli
+
+This method is meant to be overriden to implement your own command line mode for
+the app, be this a debugger, interactive mode or page generator.
+
+Its default implementation calls the C<run_cli_request> method with the
+arguments it was given, or, if that indicates failure by returning 0, calls
+C<cli_request_usage> to print a message explaining the correct CLI usage.
+
+=head2 run_cli_request
+
+Looks at the arguments passed to it, typically C<@ARGV> captured somewhere up the
+callstack, and tries to convert that into a sensible request against the
+application, which it then runs. Any results are printed to C<STDOUT>. Returns
+C<1> if it was able to run the request, and C<undef> if it was not able to
+covert the arguments into a sensible request.
+
+If run with a URL path, it runs a GET request against that path -
$ perl -Ilib examples/hello-world/hello-world.cgi /
200 OK
Hello world!
-Additionally, you can treat the file as though it were a standard PSGI
-application file (*.psgi). For example you can start up up with C<plackup>
+You can also provide a method name -
- plackup my_web_simple_app.pl
+ $ perl -Ilib examples/hello-world/hello-world.cgi POST /
+ 405 Method Not Allowed
+ Content-Type: text/plain
+
+ Method not allowed
-or C<starman>
+For a POST or PUT request, pairs on the command line will be treated
+as form variables. For any request, pairs on the command line ending in :
+are treated as headers, and 'Content:' will set the request body -
- starman my_web_simple_app.pl
+ $ ./myapp POST / Accept: text/html form_field_name form_field_value
+
+ $ ./myapp POST / Content-Type: text/json Content: '{ "json": "here" }'
+
+The body of the response is sent to STDOUT and the headers to STDERR, so
+
+ $ ./myapp GET / >index.html
+
+will generally do the right thing.
+
+To send basic authentication credentials, use user:pass@ syntax -
+
+ $ ./myapp GET bob:secret@/protected/path
+
+=head2 cli_request_usage
+
+Prints a message explaining how to pass CLI parameters. Can be overridden for
+your own purposes.
=head2 to_psgi_app
This method can be called as a class method, in which case it implicitly
calls ->new, or as an object method ... in which case it doesn't.
-=head2 run
+=head2 run_test_request
+
+ my $res = $app->run_test_request(GET => '/' => %headers);
+
+ my $res = $app->run_test_request(POST => '/' => %headers_or_form);
+
+ my $res = $app->run_test_request($http_request);
+
+Accepts either an L<HTTP::Request> object or ($method, $path) and runs that
+request against the application, returning an L<HTTP::Response> object.
+
+If the HTTP method is POST or PUT, then a series of pairs can be passed after
+this to create a form style message body. If you need to test an upload, then
+create an L<HTTP::Request> object by hand or use the C<POST> subroutine
+provided by L<HTTP::Request::Common>.
+
+If you prefix the URL with 'user:pass@' this will be converted into
+an Authorization header for HTTP basic auth:
+
+ my $res = $app->run_test_request(
+ GET => 'bob:secret@/protected/resource'
+ );
+
+If pairs are passed where the key ends in :, it is instead treated as a
+headers, so:
+
+ my $res = $app->run_test_request(
+ POST => '/',
+ 'Accept:' => 'text/html',
+ some_form_key => 'value'
+ );
-Used for running your application under stand-alone CGI and FCGI modes. Also
-useful for testing:
+will do what you expect. You can also pass a special key of Content: to
+set the request body:
- my $app = MyWebSimpleApp::Web->new;
- my $c = HTTP::Request::AsCGI->new(@args)->setup;
- $app->run;
+ my $res = $app->run_test_request(
+ POST => '/',
+ 'Content-Type:' => 'text/json',
+ 'Content:' => '{ "json": "here" }',
+ );
=head1 AUTHORS
projects / catagits/Web-Simple.git / blobdiff