1 package Web::Simple::Application;
3 use Scalar::Util 'weaken';
12 +{ $self->default_config }
15 my ($self, $value) = @_;
16 my %default = $self->default_config;
17 my @not = grep !exists $value->{$_}, keys %default;
18 @{$value}{@not} = @default{@not};
22 sub default_config { () }
24 has '_dispatcher' => (is => 'lazy');
26 sub _build__dispatcher {
28 require Web::Dispatch;
29 my $final = $self->_build_final_dispatcher;
31 # We need to weaken both the copy of $self that the
32 # app parameter will close over and the copy that'll
33 # be passed through as a node argument.
35 # To ensure that this doesn't then result in us being
36 # DESTROYed unexpectedly early, our to_psgi_app method
37 # closes back over $self
41 dispatch_app => sub { $self->dispatch_request(@_), $final },
42 dispatch_object => $self
44 weaken($dispatch_args{dispatch_object});
45 Web::Dispatch->new(%dispatch_args);
48 sub _build_final_dispatcher {
49 [ 404, [ 'Content-type', 'text/plain' ], [ 'Not found' ] ]
54 # ->to_psgi_app is true for require() but also works for plackup
55 return $self->to_psgi_app if caller(1);
56 $self = ref($self) ? $self : $self->_build_for_run_if_script;
60 sub _build_for_run_if_script {
64 die "Failed to create new '$self' object during run_if_script"
65 . " (should your .pm file end with just '1;'?) : $_\n";
71 require Plack::Handler::CGI;
72 Plack::Handler::CGI->new->run($self->to_psgi_app);
77 require Plack::Handler::FCGI;
78 Plack::Handler::FCGI->new->run($self->to_psgi_app);
82 my $self = ref($_[0]) ? $_[0] : $_[0]->new;
83 my $app = $self->_dispatcher->to_app;
85 # Close over $self to keep $self alive even though
86 # we weakened the copies the dispatcher has; the
87 # if 0 causes the ops to be optimised away to
88 # minimise the performance impact and avoid void
89 # context warnings while still doing the closing
90 # over part. As Mithaldu said: "Gnarly." ...
92 return sub { $self if 0; goto &$app; };
98 $ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}
99 || ( -S STDIN && !$ENV{GATEWAY_INTERFACE} )
100 # If STDIN is a socket, almost certainly FastCGI, except for mod_cgid
102 return $self->_run_fcgi;
103 } elsif ($ENV{GATEWAY_INTERFACE}) {
104 return $self->_run_cgi;
106 unless (@ARGV && $ARGV[0] =~ m{(^[A-Z/])|\@}) {
107 return $self->_run_cli(@ARGV);
112 unshift(@args, 'GET') if $args[0] !~ /^[A-Z]/;
114 $self->_run_cli_test_request(@args);
117 sub _test_request_spec_to_http_request {
118 my ($self, $method, $path, @rest) = @_;
120 # if it's a reference, assume a request object
121 return $method if ref($method);
123 if ($path =~ s/^(.*?)\@//) {
125 require MIME::Base64;
126 unshift @rest, 'Authorization:', 'Basic '.MIME::Base64::encode($basic);
129 my $request = HTTP::Request->new($method => $path);
133 while (my ($header, $value) = splice(@rest, 0, 2)) {
134 unless ($header =~ s/:$//) {
135 push @params, $header, $value;
138 if ($header eq 'Content') {
139 $request->content($value);
141 $request->headers->push_header($header, $value);
145 if (($method eq 'POST' or $method eq 'PUT') and @params) {
148 my $url = URI->new('http:');
149 $url->query_form(@params);
152 $request->header('Content-Type' => 'application/x-www-form-urlencoded');
153 $request->header('Content-Length' => length($content));
154 $request->content($content);
160 sub run_test_request {
161 my ($self, @req) = @_;
163 require HTTP::Request;
167 my $request = $self->_test_request_spec_to_http_request(@req);
169 Plack::Test::test_psgi(
170 $self->to_psgi_app, sub { shift->($request) }
174 sub _run_cli_test_request {
175 my ($self, @req) = @_;
176 my $response = $self->run_test_request(@req);
178 binmode(STDOUT); binmode(STDERR); # for win32
180 print STDERR $response->status_line."\n";
181 print STDERR $response->headers_as_string("\n")."\n";
182 my $content = $response->content;
183 $content .= "\n" if length($content) and $content !~ /\n\z/;
184 print STDOUT $content if $content;
189 die $self->_cli_usage;
193 "To run this script in CGI test mode, pass a URL path beginning with /:\n".
203 Web::Simple::Application - A base class for your Web-Simple application
207 This is a base class for your L<Web::Simple> application. You probably don't
208 need to construct this class yourself, since L<Web::Simple> does the 'heavy
209 lifting' for you in that regards.
213 This class exposes the following public methods.
215 =head2 default_config
217 Merges with the C<config> initializer to provide configuration information for
218 your application. For example:
223 posts_dir => $FindBin::Bin.'/posts',
227 Now, the C<config> attribute of C<$self> will be set to a HashRef
228 containing keys 'title' and 'posts_dir'.
230 The keys from default_config are merged into any config supplied, so
231 if you construct your application like:
233 MyWebSimpleApp::Web->new(
234 config => { title => 'Spoon', environment => 'dev' }
237 then C<config> will contain:
241 posts_dir => '/path/to/myapp/posts',
247 The run_if_script method is designed to be used at the end of the script
248 or .pm file where your application class is defined - for example:
250 ## my_web_simple_app.pl
252 use Web::Simple 'HelloWorld';
257 sub dispatch_request {
259 [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ]
262 [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ]
267 HelloWorld->run_if_script;
269 This returns a true value, so your file is now valid as a module - so
271 require 'my_web_simple_app.pl';
273 my $hw = HelloWorld->new;
275 will work fine (and you can rename it to lib/HelloWorld.pm later to make it
276 a real use-able module).
278 However, it detects if it's being run as a script (via testing $0) and if
279 so attempts to do the right thing.
281 If run under a CGI environment, your application will execute as a CGI.
283 If run under a FastCGI environment, your application will execute as a
284 FastCGI process (this works both for dynamic shared-hosting-style FastCGI
285 and for apache FastCgiServer style setups).
287 If run from the commandline with a URL path, it runs a GET request against
290 $ perl -Ilib examples/hello-world/hello-world.cgi /
292 Content-Type: text/plain
296 You can also provide a method name -
298 $ perl -Ilib examples/hello-world/hello-world.cgi POST /
299 405 Method Not Allowed
300 Content-Type: text/plain
304 For a POST or PUT request, pairs on the command line will be treated
305 as form variables. For any request, pairs on the command line ending in :
306 are treated as headers, and 'Content:' will set the request body -
308 $ ./myapp POST / Accept: text/html form_field_name form_field_value
310 $ ./myapp POST / Content-Type: text/json Content: '{ "json": "here" }'
312 The body of the response is sent to STDOUT and the headers to STDERR, so
314 $ ./myapp GET / >index.html
316 will generally do the right thing.
318 To send basic authentication credentials, use user:pass@ syntax -
320 $ ./myapp GET bob:secret@/protected/path
322 Additionally, you can treat the file as though it were a standard PSGI
323 application file (*.psgi). For example you can start up up with C<plackup>
325 plackup my_web_simple_app.pl
329 starman my_web_simple_app.pl
333 This method is called by L</run_if_script> to create the L<PSGI> app coderef
334 for use via L<Plack> and L<plackup>. If you want to globally add middleware,
335 you can override this method:
337 use Web::Simple 'HelloWorld';
344 around 'to_psgi_app', sub {
345 my ($orig, $self) = (shift, shift);
346 my $app = $self->$orig(@_);
348 enable ...; ## whatever middleware you want
354 This method can also be used to mount a Web::Simple application within
355 a separate C<*.psgi> file -
363 mount '/' => WSApp->to_psgi_app;
364 mount '/another' => AnotherWSApp->to_psgi_app;
367 This method can be called as a class method, in which case it implicitly
368 calls ->new, or as an object method ... in which case it doesn't.
372 Used for running your application under stand-alone CGI and FCGI modes.
374 I should document this more extensively but run_if_script will call it when
375 you need it, so don't worry about it too much.
377 =head2 run_test_request
379 my $res = $app->run_test_request(GET => '/' => %headers);
381 my $res = $app->run_test_request(POST => '/' => %headers_or_form);
383 my $res = $app->run_test_request($http_request);
385 Accepts either an L<HTTP::Request> object or ($method, $path) and runs that
386 request against the application, returning an L<HTTP::Response> object.
388 If the HTTP method is POST or PUT, then a series of pairs can be passed after
389 this to create a form style message body. If you need to test an upload, then
390 create an L<HTTP::Request> object by hand or use the C<POST> subroutine
391 provided by L<HTTP::Request::Common>.
393 If you prefix the URL with 'user:pass@' this will be converted into
394 an Authorization header for HTTP basic auth:
396 my $res = $app->run_test_request(
397 GET => 'bob:secret@/protected/resource'
400 If pairs are passed where the key ends in :, it is instead treated as a
403 my $res = $app->run_test_request(
405 'Accept:' => 'text/html',
406 some_form_key => 'value'
409 will do what you expect. You can also pass a special key of Content: to
410 set the request body:
412 my $res = $app->run_test_request(
414 'Content-Type:' => 'text/json',
415 'Content:' => '{ "json": "here" }',
420 See L<Web::Simple> for authors.
422 =head1 COPYRIGHT AND LICENSE
424 See L<Web::Simple> for the copyright and license.