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::Handler::CGI;
49 Plack::Handler::CGI->new->run($self->to_psgi_app);
54 require Plack::Handler::FCGI;
55 Plack::Handler::FCGI->new->run($self->to_psgi_app);
59 my $self = ref($_[0]) ? $_[0] : $_[0]->new;
60 $self->_dispatcher->to_app;
66 $ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}
67 || -S STDIN # STDIN is a socket, almost certainly FastCGI
69 return $self->_run_fcgi;
70 } elsif ($ENV{GATEWAY_INTERFACE}) {
71 return $self->_run_cgi;
73 unless (@ARGV && $ARGV[0] =~ m{^[A-Z/]}) {
74 return $self->_run_cli(@ARGV);
79 unshift(@args, 'GET') if $args[0] =~ m{^/};
81 $self->_run_test_request(@args);
84 sub _run_test_request {
85 my ($self, $method, $path, @rest) = @_;
87 require HTTP::Request;
90 my $request = HTTP::Request->new($method => $path);
91 if ($method eq 'POST' or $method eq 'PUT' and @rest) {
94 my $url = URI->new('http:');
95 $url->query_form(@rest);
98 $request->header('Content-Type' => 'application/x-www-form-urlencoded');
99 $request->header('Content-Length' => length($content));
100 $request->content($content);
103 Plack::Test::test_psgi(
104 $self->to_psgi_app, sub { $response = shift->($request) }
106 print STDERR $response->status_line."\n";
107 print STDERR $response->headers_as_string("\n")."\n";
108 my $content = $response->content;
109 $content .= "\n" if length($content) and $content !~ /\n\z/;
110 print STDOUT $content if $content;
115 die $self->_cli_usage;
119 "To run this script in CGI test mode, pass a URL path beginning with /:\n".
129 Web::Simple::Application - A base class for your Web-Simple application
133 This is a base class for your L<Web::Simple> application. You probably don't
134 need to construct this class yourself, since L<Web::Simple> does the 'heavy
135 lifting' for you in that regards.
139 This class exposes the following public methods.
141 =head2 default_config
143 Merges with the C<config> initializer to provide configuration information for
144 your application. For example:
149 posts_dir => $FindBin::Bin.'/posts',
153 Now, the C<config> attribute of C<$self> will be set to a HashRef
154 containing keys 'title' and 'posts_dir'.
156 The keys from default_config are merged into any config supplied, so
157 if you construct your application like:
159 MyWebSimpleApp::Web->new(
160 config => { title => 'Spoon', environment => 'dev' }
163 then C<config> will contain:
167 posts_dir => '/path/to/myapp/posts',
173 The run_if_script method is designed to be used at the end of the script
174 or .pm file where your application class is defined - for example:
176 ## my_web_simple_app.pl
178 use Web::Simple 'HelloWorld';
183 sub dispatch_request {
185 [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ]
188 [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ]
193 HelloWorld->run_if_script;
195 This returns a true value, so your file is now valid as a module - so
197 require 'my_web_simple_app.pl';
199 my $hw = HelloWorld->new;
201 will work fine (and you can rename it to lib/HelloWorld.pm later to make it
202 a real use-able module).
204 However, it detects if it's being run as a script (via testing $0) and if
205 so attempts to do the right thing.
207 If run under a CGI environment, your application will execute as a CGI.
209 If run under a FastCGI environment, your application will execute as a
210 FastCGI process (this works both for dynamic shared-hosting-style FastCGI
211 and for apache FastCgiServer style setups).
213 If run from the commandline with a URL path, it runs a GET request against
216 $ perl -Ilib examples/hello-world/hello-world.cgi /
218 Content-Type: text/plain
222 Additionally, you can treat the file as though it were a standard PSGI
223 application file (*.psgi). For example you can start up up with C<plackup>
225 plackup my_web_simple_app.pl
229 starman my_web_simple_app.pl
233 This method is called by L</run_if_script> to create the L<PSGI> app coderef
234 for use via L<Plack> and L<plackup>. If you want to globally add middleware,
235 you can override this method:
237 use Web::Simple 'HelloWorld';
244 around 'to_psgi_app', sub {
245 my ($orig, $self) = (shift, shift);
246 my $app = $self->$orig(@_);
248 enable ...; ## whatever middleware you want
254 This method can also be used to mount a Web::Simple application within
255 a separate C<*.psgi> file -
263 mount '/' => WSApp->to_psgi_app;
264 mount '/another' => AnotherWSApp->to_psgi_app;
267 This method can be called as a class method, in which case it implicitly
268 calls ->new, or as an object method ... in which case it doesn't.
272 Used for running your application under stand-alone CGI and FCGI modes.
276 See L<Web::Simple> for authors.
278 =head1 COPYRIGHT AND LICENSE
280 See L<Web::Simple> for the copyright and license.