X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FWeb%2FSimple%2FApplication.pm;h=65919ad4cb97bf7c29581db9ee9b1f6eaba1d9a2;hb=ea54c010c46fee647172945fae6dd4523ff6ffd2;hp=77646187d9be2b20e210d8792c7d568af230cb15;hpb=3583ca04311e905c78ba0cbb467d8c21e63043b1;p=catagits%2FWeb-Simple.git

diff --git a/lib/Web/Simple/Application.pm b/lib/Web/Simple/Application.pm
index 7764618..65919ad 100644
--- a/lib/Web/Simple/Application.pm
+++ b/lib/Web/Simple/Application.pm
@@ -1,178 +1,414 @@
 package Web::Simple::Application;
 
-use strict;
-use warnings FATAL => 'all';
+use Scalar::Util 'weaken';
 
-{
-  package Web::Simple::Dispatcher;
+use Moo;
 
-  sub _is_dispatcher {
-    ref($_[1])
-      and "$_[1]" =~ /\w+=[A-Z]/
-      and $_[1]->isa(__PACKAGE__);
+has 'config' => (
+  is => 'ro',
+  default => sub {
+    my ($self) = @_;
+    +{ $self->default_config }
+  },
+  trigger => sub {
+    my ($self, $value) = @_;
+    my %default = $self->default_config;
+    my @not = grep !exists $value->{$_}, keys %default;
+    @{$value}{@not} = @default{@not};
   }
+);
 
-  sub next {
-    @_ > 1
-      ? $_[0]->{next} = $_[1]
-      : shift->{next}
+sub default_config { () }
+
+has '_dispatcher' => (is => 'lazy');
+
+sub _build__dispatcher {
+  my $self = shift;
+  require Web::Dispatch;
+  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 %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 {
+  [ 404, [ 'Content-type', 'text/plain' ], [ 'Not found' ] ]
+}
+
+sub run_if_script {
+  # ->to_psgi_app is true for require() but also works for plackup
+  return $_[0]->to_psgi_app if caller(1);
+  my $self = ref($_[0]) ? $_[0] : $_[0]->new;
+  $self->run(@_);
+}
+
+sub _run_cgi {
+  my $self = shift;
+  require Plack::Handler::CGI;
+  Plack::Handler::CGI->new->run($self->to_psgi_app);
+}
+
+sub _run_fcgi {
+  my $self = shift;
+  require Plack::Handler::FCGI;
+  Plack::Handler::FCGI->new->run($self->to_psgi_app);
+}
+
+sub to_psgi_app {
+  my $self = ref($_[0]) ? $_[0] : $_[0]->new;
+  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}
+    || ( -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{(^[A-Z/])|\@}) {
+    return $self->_run_cli(@ARGV);
   }
 
-  sub set_next {
-    $_[0]->{next} = $_[1];
-    $_[0]
+  my @args = @ARGV;
+
+  unshift(@args, 'GET') if $args[0] !~ /^[A-Z]/;
+
+  $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);
   }
 
-  sub dispatch {
-    my ($self, $env, @args) = @_;
-    my $next = $self->next;
-    if (my ($env_delta, @match) = $self->_match_against($env)) {
-      if (my ($result) = $self->_execute_with(@args, @match)) {
-        if ($self->_is_dispatcher($result)) {
-          $next = $result->set_next($next);
-          $env = { %$env, %$env_delta };
-        } else {
-          return $result;
-        }
-      }
+  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);
     }
-    return $next->dispatch($env, @args);
   }
 
-  sub _match_against {
-     return ({}, $_[1]) unless $_[0]->{matches};
-     $_[0]->{matches}->($_[1]);
+  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);
   }
 
-  sub _execute_with {
-    $_[0]->{call}->(@_);
-  }
+  return $request;
 }
 
-sub new {
-  my ($class, $data) = @_;
-  my $config = { $class->_default_config, %{($data||{})->{config}||{}} };
-  bless({ config => $config }, $class);
-}
+sub run_test_request {
+  my ($self, @req) = @_;
 
-sub _default_config { () }
+  require HTTP::Request;
 
-sub config {
-  shift->{config};
+  require Plack::Test;
+
+  my $request = $self->_test_request_spec_to_http_request(@req);
+
+  Plack::Test::test_psgi(
+    $self->to_psgi_app, sub { shift->($request) }
+  );
 }
 
-sub _construct_response_filter {
-  my $code = $_[1];
-  $_[0]->_build_dispatcher({
-    call => sub {
-      my ($d, $self, $env) = (shift, shift, shift);
-      $self->_run_with_self($code, $d->next->dispatch($env, $self, @_));
-    },
-  });
+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 _construct_redispatch {
-  my ($self, $new_path) = @_;
-  $self->_build_dispatcher({
-    call => sub {
-      shift;
-      my ($self, $env) = @_;
-      $self->handle_request({ %{$env}, PATH_INFO => $new_path })
-    }
-  })
+sub _run_cli {
+  my $self = shift;
+  die $self->_cli_usage;
 }
 
-sub _dispatch_parser {
-  require Web::Simple::DispatchParser;
-  return Web::Simple::DispatchParser->new;
+sub _cli_usage {
+  "To run this script in CGI test mode, pass a URL path beginning with /:\n".
+  "\n".
+  "  $0 /some/path\n".
+  "  $0 /\n"
 }
 
-sub _setup_dispatchables {
-  my ($class, $dispatch_subs) = @_;
-  my $parser = $class->_dispatch_parser;
-  my @dispatchables;
-  my ($root, $last);
-  foreach my $dispatch_sub (@$dispatch_subs) {
-    my $proto = prototype $dispatch_sub;
-    my $matcher = (
-      defined($proto)
-        ? $parser->parse_dispatch_specification($proto)
-        : undef
+1;
+
+=head1 NAME
+
+Web::Simple::Application - A base class for your Web-Simple application
+
+=head1 DESCRIPTION
+
+This is a base class for your L<Web::Simple> application.  You probably don't
+need to construct this class yourself, since L<Web::Simple> does the 'heavy
+lifting' for you in that regards.
+
+=head1 METHODS
+
+This class exposes the following public methods.
+
+=head2 default_config
+
+Merges with the C<config> initializer to provide configuration information for
+your application.  For example:
+
+  sub default_config {
+    (
+      title => 'Bloggery',
+      posts_dir => $FindBin::Bin.'/posts',
     );
-    my $new = $class->_build_dispatcher({
-      matches => $matcher,
-      call => sub { shift;
-        shift->_run_with_self($dispatch_sub, @_)
-      },
-    });
-    $root ||= $new;
-    $last = $last ? $last->next($new) : $new;
-    push @dispatchables, [ $matcher, $dispatch_sub ];
   }
-  $last->next($class->_build_final_dispatcher);
+
+Now, the C<config> attribute of C<$self>  will be set to a HashRef
+containing keys 'title' and 'posts_dir'.
+
+The keys from default_config are merged into any config supplied, so
+if you construct your application like:
+
+  MyWebSimpleApp::Web->new(
+    config => { title => 'Spoon', environment => 'dev' }
+  )
+
+then C<config> will contain:
+
   {
-    no strict 'refs';
-    *{"${class}::_dispatch_root"} = sub { $root };
+    title => 'Spoon',
+    posts_dir => '/path/to/myapp/posts',
+    environment => 'dev'
   }
-}
 
-sub _build_dispatcher {
-  bless($_[1], 'Web::Simple::Dispatcher');
-}
+=head2 run_if_script
 
-sub _build_final_dispatcher {
-  shift->_build_dispatcher({
-    call => sub {
-      [
-        500, [ 'Content-type', 'text/plain' ],
-        [ 'The management apologises but we have no idea how to handle that' ]
-      ]
+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
+  use Web::Simple 'HelloWorld';
+
+  {
+    package HelloWorld;
+
+    sub dispatch_request {
+      sub (GET) {
+        [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ]
+      },
+      sub () {
+        [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ]
+      }
     }
-  })
-}
+  }
 
-sub handle_request {
-  my ($self, $env) = @_;
-  $self->_dispatch_root->dispatch($env, $self);
-}
+  HelloWorld->run_if_script;
 
-sub _run_with_self {
-  my ($self, $run, @args) = @_;
-  my $class = ref($self);
-  no strict 'refs';
-  local *{"${class}::self"} = \$self;
-  $self->$run(@args);
-}
+This returns a true value, so your file is now valid as a module - so
 
-sub run_if_script {
-  return 1 if caller(1); # 1 so we can be the last thing in the file
-  my $class = shift;
-  my $self = $class->new;
-  $self->run(@_);
-}
+  require 'my_web_simple_app.pl';
 
-sub _run_cgi {
-  my $self = shift;
-  require Web::Simple::HackedPlack;
-  Plack::Server::CGI->run(sub { $self->handle_request(@_) });
-}
+  my $hw = HelloWorld->new;
 
-sub run {
-  my $self = shift;
-  if ($ENV{GATEWAY_INTERFACE}) {
-    $self->_run_cgi;
+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.
+
+If run under a CGI environment, your application will execute as a CGI.
+
+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).
+
+If run from the commandline with a URL path, it runs a GET request against
+that path -
+
+  $ 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<plackup>
+
+  plackup my_web_simple_app.pl
+
+or C<starman>
+
+  starman my_web_simple_app.pl
+
+=head2 to_psgi_app
+
+This method is called by L</run_if_script> to create the L<PSGI> app coderef
+for use via L<Plack> and L<plackup>. If you want to globally add middleware,
+you can override this method:
+
+  use Web::Simple 'HelloWorld';
+ 
+  {
+    package HelloWorld;
+    use Plack::Builder;
+  
+    around 'to_psgi_app', sub {
+      my ($orig, $self) = (shift, shift);
+      my $app = $self->$orig(@_); 
+      builder {
+        enable ...; ## whatever middleware you want
+        $app;
+      };
+    };
   }
-  my $path = shift(@ARGV) or die "No path passed - use $0 / for root";
 
-  require HTTP::Request::AsCGI;
-  require HTTP::Request::Common;
-  local *GET = \&HTTP::Request::Common::GET;
+This method can also be used to mount a Web::Simple application within
+a separate C<*.psgi> file -
 
-  my $request = GET($path);
-  my $c = HTTP::Request::AsCGI->new($request)->setup;
-  $self->_run_cgi;
-  $c->restore;
-  print $c->response->as_string;
-}
+  use strictures 1;
+  use Plack::Builder;
+  use WSApp;
+  use AnotherWSApp;
 
-1;
+  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.
+
+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<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'
+            );
+
+will do what you expect. You can also pass a special key of Content: to
+set the request body:
+
+  my $res = $app->run_test_request(
+              POST => '/',
+              'Content-Type:' => 'text/json',
+              'Content:' => '{ "json": "here" }',
+            );
+
+=head1 AUTHORS
+
+See L<Web::Simple> for authors.
+
+=head1 COPYRIGHT AND LICENSE
+
+See L<Web::Simple> for the copyright and license.
+
+=cut