1 package Web::Simple::Application;
9 +{ $self->default_config }
12 my ($self, $value) = @_;
13 my %default = $self->default_config;
14 my @not = grep !exists $value->{$_}, keys %default;
15 @{$value}{@not} = @default{@not};
19 sub default_config { () }
21 has '_dispatcher' => (is => 'lazy');
23 sub _build__dispatcher {
25 require Web::Dispatch;
26 require Web::Simple::DispatchNode;
27 my $final = $self->_build_final_dispatcher;
29 app => sub { $self->dispatch_request(@_), $final },
30 node_class => 'Web::Simple::DispatchNode',
31 node_args => { app_object => $self }
35 sub _build_final_dispatcher {
36 [ 404, [ 'Content-type', 'text/plain' ], [ 'Not found' ] ]
40 # ->to_psgi_app is true for require() but also works for plackup
41 return $_[0]->to_psgi_app if caller(1);
42 my $self = ref($_[0]) ? $_[0] : $_[0]->new;
48 require Plack::Server::CGI;
49 Plack::Server::CGI->run($self->to_psgi_app);
54 require Plack::Server::FCGI;
55 Plack::Server::FCGI->run($self->to_psgi_app);
59 my $self = ref($_[0]) ? $_[0] : $_[0]->new;
60 $self->_dispatcher->to_app;
65 if ($ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}) {
66 return $self->_run_fcgi;
67 } elsif ($ENV{GATEWAY_INTERFACE}) {
68 return $self->_run_cgi;
70 unless (@ARGV && $ARGV[0] =~ m{^[A-Z/]}) {
71 return $self->_run_cli(@ARGV);
76 unshift(@args, 'GET') if $args[0] =~ m{^/};
78 $self->_run_test_request(@args);
81 sub _run_test_request {
82 my ($self, $method, $path, @rest) = @_;
84 require HTTP::Request;
87 my $request = HTTP::Request->new($method => $path);
88 if ($method eq 'POST' or $method eq 'PUT' and @rest) {
91 my $url = URI->new('http:');
92 $url->query_form(@rest);
95 $request->header('Content-Type' => 'application/x-www-form-urlencoded');
96 $request->header('Content-Length' => length($content));
97 $request->content($content);
100 Plack::Test::test_psgi(
101 $self->to_psgi_app, sub { $response = shift->($request) }
103 print STDERR $response->status_line."\n";
104 print STDERR $response->headers_as_string("\n")."\n";
105 print STDOUT $response->content."\n";
110 die $self->_cli_usage;
114 "To run this script in CGI test mode, pass a URL path beginning with /:\n".
124 Web::Simple::Application - A base class for your Web-Simple application
128 This is a base class for your L<Web::Simple> application. You probably don't
129 need to construct this class yourself, since L<Web::Simple> does the 'heavy
130 lifting' for you in that regards.
134 This class exposes the following public methods.
136 =head2 default_config
138 Merges with the C<config> initializer to provide configuration information for
139 your application. For example:
144 posts_dir => $FindBin::Bin.'/posts',
148 Now, the C<config> attribute of C<$self> will be set to a HashRef
149 containing keys 'title' and 'posts_dir'.
151 The keys from default_config are merged into any config supplied, so
152 if you construct your application like:
154 MyWebSimpleApp::Web->new(
155 config => { title => 'Spoon', environment => 'dev' }
158 then C<config> will contain:
162 posts_dir => '/path/to/myapp/posts',
168 The run_if_script method is designed to be used at the end of the script
169 or .pm file where your application class is defined - for example:
171 ## my_web_simple_app.pl
173 use Web::Simple 'HelloWorld';
178 sub dispatch_request {
180 [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ]
183 [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ]
188 HelloWorld->run_if_script;
190 This returns a true value, so your file is now valid as a module - so
192 require 'my_web_simple_app.pl';
194 my $hw = HelloWorld->new;
196 will work fine (and you can rename it to lib/HelloWorld.pm later to make it
197 a real use-able module).
199 However, it detects if it's being run as a script (via testing $0) and if
200 so attempts to do the right thing.
202 If run under a CGI environment, your application will execute as a CGI.
204 If run under a FastCGI environment, your application will execute as a
205 FastCGI process (this works both for dynamic shared-hosting-style FastCGI
206 and for apache FastCgiServer style setups).
208 If run from the commandline with a URL path, it runs a GET request against
211 $ perl -Ilib examples/hello-world/hello-world.cgi /
213 Content-Type: text/plain
217 Additionally, you can treat the file as though it were a standard PSGI
218 application file (*.psgi). For example you can start up up with C<plackup>
220 plackup my_web_simple_app.pl
224 starman my_web_simple_app.pl
228 This method is called by L</run_if_script> to create the L<PSGI> app coderef
229 for use via L<Plack> and L<plackup>. If you want to globally add middleware,
230 you can override this method:
232 use Web::Simple 'HelloWorld';
239 around 'to_psgi_app', sub {
240 my ($orig, $self) = (shift, shift);
241 my $app = $self->$orig(@_);
243 enable ...; ## whatever middleware you want
249 This method can also be used to mount a Web::Simple application within
250 a separate C<*.psgi> file -
258 mount '/' => WSApp->to_psgi_app;
259 mount '/another' => AnotherWSApp->to_psgi_app;
262 This method can be called as a class method, in which case it implicitly
263 calls ->new, or as an object method ... in which case it doesn't.
267 Used for running your application under stand-alone CGI and FCGI modes. Also
270 my $app = MyWebSimpleApp::Web->new;
271 my $c = HTTP::Request::AsCGI->new(@args)->setup;
276 See L<Web::Simple> for authors.
278 =head1 COPYRIGHT AND LICENSE
280 See L<Web::Simple> for the copyright and license.