1 package Web::Simple::Application;
3 use Scalar::Util 'weaken';
11 +{ $self->default_config }
14 my ($self, $value) = @_;
15 my %default = $self->default_config;
16 my @not = grep !exists $value->{$_}, keys %default;
17 @{$value}{@not} = @default{@not};
21 sub default_config { () }
23 has '_dispatcher' => (is => 'lazy');
25 sub _build__dispatcher {
27 require Web::Dispatch;
28 require Web::Simple::DispatchNode;
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
40 my $node_args = { app_object => $self };
41 weaken($node_args->{app_object});
43 app => sub { $self->dispatch_request(@_), $final },
44 node_class => 'Web::Simple::DispatchNode',
45 node_args => $node_args
49 sub _build_final_dispatcher {
50 [ 404, [ 'Content-type', 'text/plain' ], [ 'Not found' ] ]
54 # ->to_psgi_app is true for require() but also works for plackup
55 return $_[0]->to_psgi_app if caller(1);
56 my $self = ref($_[0]) ? $_[0] : $_[0]->new;
62 require Plack::Handler::CGI;
63 Plack::Handler::CGI->new->run($self->to_psgi_app);
68 require Plack::Handler::FCGI;
69 Plack::Handler::FCGI->new->run($self->to_psgi_app);
73 my $self = ref($_[0]) ? $_[0] : $_[0]->new;
74 my $app = $self->_dispatcher->to_app;
76 # Close over $self to keep $self alive even though
77 # we weakened the copies the dispatcher has; the
78 # if 0 causes the ops to be optimised away to
79 # minimise the performance impact and avoid void
80 # context warnings while still doing the closing
81 # over part. As Mithaldu said: "Gnarly." ...
83 return sub { $self if 0; goto &$app; };
89 $ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}
90 || -S STDIN # STDIN is a socket, almost certainly FastCGI
92 return $self->_run_fcgi;
93 } elsif ($ENV{GATEWAY_INTERFACE}) {
94 return $self->_run_cgi;
96 unless (@ARGV && $ARGV[0] =~ m{^[A-Z/]}) {
97 return $self->_run_cli(@ARGV);
102 unshift(@args, 'GET') if $args[0] =~ m{^/};
104 $self->_run_cli_test_request(@args);
107 sub _test_request_spec_to_http_request {
108 my ($self, $method, $path, @rest) = @_;
110 # if it's a reference, assume a request object
111 return $method if ref($method);
113 my $request = HTTP::Request->new($method => $path);
117 while (my ($header, $value) = splice(@rest, 0, 2)) {
118 unless ($header =~ s/:$//) {
119 push @params, $header, $value;
122 if ($header eq 'Content') {
123 $request->content($value);
125 $request->headers->push_header($header, $value);
129 if (($method eq 'POST' or $method eq 'PUT') and @params) {
132 my $url = URI->new('http:');
133 $url->query_form(@params);
136 $request->header('Content-Type' => 'application/x-www-form-urlencoded');
137 $request->header('Content-Length' => length($content));
138 $request->content($content);
144 sub run_test_request {
145 my ($self, @req) = @_;
147 require HTTP::Request;
150 my $request = $self->_test_request_spec_to_http_request(@req);
152 Plack::Test::test_psgi(
153 $self->to_psgi_app, sub { shift->($request) }
157 sub _run_cli_test_request {
158 my ($self, @req) = @_;
159 my $response = $self->run_test_request(@req);
161 binmode(STDOUT); binmode(STDERR); # for win32
163 print STDERR $response->status_line."\n";
164 print STDERR $response->headers_as_string("\n")."\n";
165 my $content = $response->content;
166 $content .= "\n" if length($content) and $content !~ /\n\z/;
167 print STDOUT $content if $content;
172 die $self->_cli_usage;
176 "To run this script in CGI test mode, pass a URL path beginning with /:\n".
186 Web::Simple::Application - A base class for your Web-Simple application
190 This is a base class for your L<Web::Simple> application. You probably don't
191 need to construct this class yourself, since L<Web::Simple> does the 'heavy
192 lifting' for you in that regards.
196 This class exposes the following public methods.
198 =head2 default_config
200 Merges with the C<config> initializer to provide configuration information for
201 your application. For example:
206 posts_dir => $FindBin::Bin.'/posts',
210 Now, the C<config> attribute of C<$self> will be set to a HashRef
211 containing keys 'title' and 'posts_dir'.
213 The keys from default_config are merged into any config supplied, so
214 if you construct your application like:
216 MyWebSimpleApp::Web->new(
217 config => { title => 'Spoon', environment => 'dev' }
220 then C<config> will contain:
224 posts_dir => '/path/to/myapp/posts',
230 The run_if_script method is designed to be used at the end of the script
231 or .pm file where your application class is defined - for example:
233 ## my_web_simple_app.pl
235 use Web::Simple 'HelloWorld';
240 sub dispatch_request {
242 [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ]
245 [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ]
250 HelloWorld->run_if_script;
252 This returns a true value, so your file is now valid as a module - so
254 require 'my_web_simple_app.pl';
256 my $hw = HelloWorld->new;
258 will work fine (and you can rename it to lib/HelloWorld.pm later to make it
259 a real use-able module).
261 However, it detects if it's being run as a script (via testing $0) and if
262 so attempts to do the right thing.
264 If run under a CGI environment, your application will execute as a CGI.
266 If run under a FastCGI environment, your application will execute as a
267 FastCGI process (this works both for dynamic shared-hosting-style FastCGI
268 and for apache FastCgiServer style setups).
270 If run from the commandline with a URL path, it runs a GET request against
273 $ perl -Ilib examples/hello-world/hello-world.cgi /
275 Content-Type: text/plain
279 You can also provide a method name -
281 $ perl -Ilib examples/hello-world/hello-world.cgi POST /
282 405 Method Not Allowed
283 Content-Type: text/plain
287 For a POST or PUT request, pairs on the command line will be treated
288 as form variables. For any request, pairs on the command line ending in :
289 are treated as headers, and 'Content:' will set the request body -
291 $ ./myapp POST / Accept: text/html form_field_name form_field_value
293 $ ./myapp POST / Content-Type: text/json Content: '{ "json": "here" }'
295 The body of the response is sent to STDOUT and the headers to STDERR, so
297 $ ./myapp GET / >index.html
299 will generally do the right thing.
301 Additionally, you can treat the file as though it were a standard PSGI
302 application file (*.psgi). For example you can start up up with C<plackup>
304 plackup my_web_simple_app.pl
308 starman my_web_simple_app.pl
312 This method is called by L</run_if_script> to create the L<PSGI> app coderef
313 for use via L<Plack> and L<plackup>. If you want to globally add middleware,
314 you can override this method:
316 use Web::Simple 'HelloWorld';
323 around 'to_psgi_app', sub {
324 my ($orig, $self) = (shift, shift);
325 my $app = $self->$orig(@_);
327 enable ...; ## whatever middleware you want
333 This method can also be used to mount a Web::Simple application within
334 a separate C<*.psgi> file -
342 mount '/' => WSApp->to_psgi_app;
343 mount '/another' => AnotherWSApp->to_psgi_app;
346 This method can be called as a class method, in which case it implicitly
347 calls ->new, or as an object method ... in which case it doesn't.
351 Used for running your application under stand-alone CGI and FCGI modes.
353 I should document this more extensively but run_if_script will call it when
354 you need it, so don't worry about it too much.
356 =head2 run_test_request
358 my $res = $app->run_test_request(GET => '/' => %headers);
360 my $res = $app->run_test_request(POST => '/' => %headers_or_form);
362 my $res = $app->run_test_request($http_request);
364 Accepts either an L<HTTP::Request> object or ($method, $path) and runs that
365 request against the application, returning an L<HTTP::Response> object.
367 If the HTTP method is POST or PUT, then a series of pairs can be passed after
368 this to create a form style message body. If you need to test an upload, then
369 create an L<HTTP::Request> object by hand or use the C<POST> subroutine
370 provided by L<HTTP::Request::Common>.
372 If pairs are passed where the key ends in :, it is instead treated as a
375 my $res = $app->run_test_request(
377 'Accept:' => 'text/html',
378 some_form_key => 'value'
381 will do what you expect. You can also pass a special key of Content: to
382 set the request body:
384 my $res = $app->run_test_request(
386 'Content-Type:' => 'text/json',
387 'Content:' => '{ "json": "here" }',
392 See L<Web::Simple> for authors.
394 =head1 COPYRIGHT AND LICENSE
396 See L<Web::Simple> for the copyright and license.