X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FWeb%2FSimple%2FApplication.pm;h=febd830208a533a5348b77bf024009e5d23c7876;hb=8c3623e2a1cd54122eee642e9816bd4b3acb52bb;hp=99e64363e9d47458f7db9ea9583990edd0c5654c;hpb=6a4808bf0d52746eec29e8335002600600ea07c4;p=catagits%2FWeb-Simple.git diff --git a/lib/Web/Simple/Application.pm b/lib/Web/Simple/Application.pm index 99e6436..febd830 100644 --- a/lib/Web/Simple/Application.pm +++ b/lib/Web/Simple/Application.pm @@ -1,5 +1,7 @@ package Web::Simple::Application; +use Scalar::Util 'weaken'; + use Moo; has 'config' => ( @@ -25,10 +27,22 @@ sub _build__dispatcher { require Web::Dispatch; require Web::Simple::DispatchNode; my $final = $self->_build_final_dispatcher; + + # 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 $node_args = { app_object => $self }; + weaken($node_args->{app_object}); Web::Dispatch->new( app => sub { $self->dispatch_request(@_), $final }, node_class => 'Web::Simple::DispatchNode', - node_args => { app_object => $self } + node_args => $node_args ); } @@ -45,42 +59,120 @@ sub run_if_script { 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}) { + 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_fcgi; } elsif ($ENV{GATEWAY_INTERFACE}) { return $self->_run_cgi; } - unless (@ARGV && $ARGV[0] =~ m{^/}) { + unless (@ARGV && $ARGV[0] =~ m{^[A-Z/]}) { return $self->_run_cli(@ARGV); } - my $path = shift @ARGV; + my @args = @ARGV; + + unshift(@args, 'GET') if $args[0] =~ m{^/} or $args[0] =~ m{\@}; + + $self->_run_cli_test_request(@args); +} + +sub _test_request_spec_to_http_request { + my ($self, $method, $path, @rest) = @_; + + # 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); + } + + require HTTP::Request; + + my $request = HTTP::Request->new($method => $path); + + 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(@params); + $url->query; + }; + $request->header('Content-Type' => 'application/x-www-form-urlencoded'); + $request->header('Content-Length' => length($content)); + $request->content($content); + } + + return $request; +} + +sub run_test_request { + my ($self, @req) = @_; - require HTTP::Request::Common; require Plack::Test; - local *GET = \&HTTP::Request::Common::GET; - my $request = GET($path); - my $response; - Plack::Test::test_psgi($self->to_psgi_app, sub { $response = shift->($request) }); - print $response->as_string; + my $request = $self->_test_request_spec_to_http_request(@req); + + Plack::Test::test_psgi( + $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"; + my $content = $response->content; + $content .= "\n" if length($content) and $content !~ /\n\z/; + print STDOUT $content if $content; } sub _run_cli { @@ -126,22 +218,25 @@ your application. For example: Now, the C attribute of C<$self> will be set to a HashRef containing keys 'title' and 'posts_dir'. -If you construct your application like: - - MyWebSimpleApp::Web->new(config=>{environment=>'dev'}) +The keys from default_config are merged into any config supplied, so +if you construct your application like: -then C will have a C key with a value of 'dev'. + MyWebSimpleApp::Web->new( + config => { title => 'Spoon', environment => 'dev' } + ) -=head2 run_if_script +then C will contain: -In the case where you wish to run your L based application as a -stand alone CGI application, you can simple do: + { + title => 'Spoon', + posts_dir => '/path/to/myapp/posts', + environment => 'dev' + } - ## my_web_simple_app.pl - use MyWebSimpleApp::Web; - MyWebSimpleApp::Web->run_if_script. +=head2 run_if_script -Or (even more simply) just inline the entire application: +The 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 #!/usr/bin/env perl @@ -162,47 +257,73 @@ Or (even more simply) just inline the entire application: HelloWorld->run_if_script; -Additionally, you can treat the above script as though it were a standard PSGI -application file (*.psgi). For example you can start up up with C +This returns a true value, so your file is now valid as a module - so - plackup my_web_simple_app.pl + require 'my_web_simple_app.pl'; -Which means you can write a L application as a plain old CGI -application and seemlessly migrate to a L based solution when you are -ready for that. + my $hw = HelloWorld->new; -Lastly, L will automatically detect and support a Fast CGI -environment. +will work fine (and you can rename it to lib/HelloWorld.pm later to make it +a real use-able module). -=head2 to_psgi_app +However, it detects if it's being run as a script (via testing $0) and if +so attempts to do the right thing. -Given a L application root namespace, return it in a form suitable -to run in inside a L container, or in L or in a C<*.psgi> -file: +If run under a CGI environment, your application will execute as a CGI. - ## app.psgi - use strictures 1; - use Plack::Builder; - use MyWebSimpleApp::Web; +If run under a FastCGI environment, your application will execute as a +FastCGI process (this works both for dynamic shared-hosting-style FastCGI +and for apache FastCgiServer style setups). - builder { - ## enable middleware - enable 'StackTrace'; - enable 'Debug'; +If run from the commandline with a URL path, it runs a GET request against +that path - - ## return application - MyWebSimpleApp::Web->to_psgi_app; - }; + $ perl -Ilib examples/hello-world/hello-world.cgi / + 200 OK + Content-Type: text/plain + + Hello world! + +You can also provide a method name - + + $ perl -Ilib examples/hello-world/hello-world.cgi POST / + 405 Method Not Allowed + Content-Type: text/plain + + Method not allowed + +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 - + + $ ./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 + +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 -This could be run via C, etc. Please note the L DSL -is optional, if you are enabling L internally in your -L application; your app.psgi could be as simple as: + plackup my_web_simple_app.pl + +or C - use MyWebSimpleApp::Web; - MyWebSimpleApp::Web->to_psgi_app; + starman my_web_simple_app.pl -This means if you want to provide a 'default' set of middleware, one option is -to modify this method: +=head2 to_psgi_app + +This method is called by L to create the L app coderef +for use via L and L. If you want to globally add middleware, +you can override this method: use Web::Simple 'HelloWorld'; use Plack::Builder; @@ -221,34 +342,76 @@ to modify this method: }; } -As always, mix and match the pieces you actually need and remember the -L philosophy of trying to keep it as minimal and simple as possible. +This method can also be used to mount a Web::Simple application within +a separate C<*.psgi> file - + + use strictures 1; + use Plack::Builder; + use WSApp; + use AnotherWSApp; + + builder { + mount '/' => WSApp->to_psgi_app; + mount '/another' => AnotherWSApp->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 -Used for running your application under stand-alone CGI and FCGI modes. Also -useful for testing: +Used for running your application under stand-alone CGI and FCGI modes. + +I should document this more extensively but run_if_script will call it when +you need it, so don't worry about it too much. + +=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 object or ($method, $path) and runs that +request against the application, returning an L 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 object by hand or use the C subroutine +provided by L. + +If you prefix the URL with 'user:pass@' this will be converted into +an Authorization header for HTTP basic auth: - my $app = MyWebSimpleApp::Web->new; - my $c = HTTP::Request::AsCGI->new(@args)->setup; - $app->run; + my $res = $app->run_test_request( + GET => 'bob:secret@/protected/resource' + ); -=head1 AUTHOR +If pairs are passed where the key ends in :, it is instead treated as a +headers, so: -Matt S. Trout + my $res = $app->run_test_request( + POST => '/', + 'Accept:' => 'text/html', + some_form_key => 'value' + ); -=head1 CONTRIBUTORS +will do what you expect. You can also pass a special key of Content: to +set the request body: -None required yet. Maybe this module is perfect (hahahahaha ...). + my $res = $app->run_test_request( + POST => '/', + 'Content-Type:' => 'text/json', + 'Content:' => '{ "json": "here" }', + ); -=head1 COPYRIGHT +=head1 AUTHORS -Copyright (c) 2010 the Web::Simple L and L -as listed above. +See L for authors. -=head1 LICENSE +=head1 COPYRIGHT AND LICENSE -This library is free software and may be distributed under the same terms -as perl itself. +See L for the copyright and license. =cut