X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FWeb%2FSimple.pm;h=7adf003a00ed8606d38d41e9aa187a66e141a60d;hb=e139ce1642139a961b78ea726bc7afccc28966c8;hp=bca9d85b1241d75c94cb3e703bfb9daaa4f4ef84;hpb=48904f8077fe19d8a48e278a32a3c398eba53d7f;p=catagits%2FWeb-Simple.git diff --git a/lib/Web/Simple.pm b/lib/Web/Simple.pm index bca9d85..7adf003 100644 --- a/lib/Web/Simple.pm +++ b/lib/Web/Simple.pm @@ -1,12 +1,11 @@ package Web::Simple; use strictures 1; -use 5.008; use warnings::illegalproto (); use Moo (); use Web::Dispatch::Wrapper (); -our $VERSION = '0.009'; +our $VERSION = '0.031'; sub import { my ($class, $app_package) = @_; @@ -30,6 +29,8 @@ sub _export_into { $INC{"${name}.pm"} = 'Set by "use Web::Simple;" invocation'; } +1; + =head1 NAME Web::Simple - A quick and easy way to build simple web applications @@ -39,18 +40,15 @@ Web::Simple - A quick and easy way to build simple web applications #!/usr/bin/env perl - use Web::Simple 'HelloWorld'; - - { - package HelloWorld; + package HelloWorld; + use Web::Simple; - sub dispatch_request { - sub (GET) { - [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ] - }, - sub () { - [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ] - } + sub dispatch_request { + GET => sub { + [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ] + }, + '' => sub { + [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ] } } @@ -60,9 +58,17 @@ If you save this file into your cgi-bin as C and then visit: http://my.server.name/cgi-bin/hello-world.cgi/ -you'll get the "Hello world!" string output to your browser. For more complex -examples and non-CGI deployment, see below. To get help with L, -please connect to the irc.perl.org IRC network and join #web-simple. +you'll get the "Hello world!" string output to your browser. At the same time +this file will also act as a class module, so you can save it as HelloWorld.pm +and use it as-is in test scripts or other deployment mechanisms. + +Note that you should retain the ->run_if_script even if your app is a +module, since this additionally makes it valid as a .psgi file, which can +be extremely useful during development. + +For more complex examples and non-CGI deployment, see +L. To get help with L, please connect to +the irc.perl.org IRC network and join #web-simple. =head1 DESCRIPTION @@ -82,14 +88,14 @@ C based one: This sets up your package (in this case "NameOfApplication" is your package) so that it inherits from L and imports L, -as well as installs a C constant for convenience, as well as some +as well as installs a C constant for convenience, as well as some other subroutines. Importing L will automatically make your code use the C and C pragma, so you can skip the usual: use strict; - use warnings FATAL => 'aa'; + use warnings FATAL => 'all'; provided you 'use Web::Simple' at the top of the file. Note that we turn on *fatal* warnings so if you have any warnings at any point from the file @@ -125,6 +131,16 @@ so that perl will not attempt to load the application again even if is encountered in other code. +One important thing to remember when using + + NameOfApplication->run_if_script; + +At the end of your app is that this call will create an instance of your app +for you automatically, regardless of context. An easier way to think of this +would be if the method were more verbosely named + + NameOfApplication->run_request_if_script_else_turn_coderef_for_psgi; + =head1 DISPATCH STRATEGY L despite being straightforward to use, has a powerful system @@ -136,41 +152,45 @@ and nested subdispatchers. =head2 Examples sub dispatch_request { - # matches: GET /user/1.htm?show_details=1 - # GET /user/1.htm - sub (GET + /user/* + ?show_details~ + .htm|.html|.xhtml) { - my ($self, $user_id, $show_details) = @_; - ... - }, - # matches: POST /user?username=frew - # POST /user?username=mst&first_name=matt&last_name=trout - sub (POST + /user + ?username=&*) { - my ($self, $username, $misc_params) = @_; - ... - }, - # matches: DELETE /user/1/friend/2 - sub (DELETE + /user/*/friend/*) { - my ($self, $user_id, $friend_id) = @_; - ... - }, - # matches: PUT /user/1?first_name=Matt&last_name=Trout - sub (PUT + /user/* + ?first_name~&last_name~) { - my ($self, $user_id, $first_name, $last_name) = @_; - ... - }, - sub (/user/*/...) { - my $user_id = $_[1]; - # matches: PUT /user/1/role/1 - sub (PUT + /role/*) { - my $role_id = $_[1]; + ( + # matches: GET /user/1.htm?show_details=1 + # GET /user/1.htm + 'GET + /user/* + ?show_details~ + .htm|.html|.xhtml' => sub { + my ($self, $user_id, $show_details) = @_; + ... + }, + # matches: POST /user?username=frew + # POST /user?username=mst&first_name=matt&last_name=trout + 'POST + /user + ?username=&*' => sub { + my ($self, $username, $misc_params) = @_; ... }, - # matches: DELETE /user/1/role/1 - sub (DELETE + /role/*) { - my $role_id = $_[1]; + # matches: DELETE /user/1/friend/2 + 'DELETE + /user/*/friend/*' => sub { + my ($self, $user_id, $friend_id) = @_; ... }, - }, + # matches: PUT /user/1?first_name=Matt&last_name=Trout + 'PUT + /user/* + ?first_name~&last_name~' => sub { + my ($self, $user_id, $first_name, $last_name) = @_; + ... + }, + '/user/*/...' => sub { + my $user_id = $_[1]; + ( + # matches: PUT /user/1/role/1 + 'PUT + /role/*' => sub { + my $role_id = $_[1]; + ... + }, + # matches: DELETE /user/1/role/1 + 'DELETE + /role/*' => sub { + my $role_id = $_[1]; + ... + }, + ); + }, + ); } =head2 The dispatch cycle @@ -184,21 +204,36 @@ here and return a PSGI response arrayref if you want: [ 404, [ 'Content-type' => 'text/plain' ], [ 'Amnesia == fail' ] ] } -However, generally, instead of that, you return a set of dispatch subs: +However, generally, instead of that, you return a set of route/target +pairs: sub dispatch_request { my $self = shift; - sub (/) { redispatch_to '/index.html' }, - sub (/user/*) { $self->show_user($_[1]) }, - ... + ( + '/' => sub { redispatch_to '/index.html' }, + '/user/*' => sub { $self->show_user($_[1]) }, + 'POST + %*' => 'handle_post', + ... + ); } -If you return a subroutine with a prototype, the prototype is treated -as a match specification - and if the test is passed, the body of the -sub is called as a method any matched arguments (see below for more details). +Well, a sub is a valid PSGI response too (for ultimate streaming and async +cleverness). If you want to return a PSGI sub you have to wrap it into an +array ref. -You can also return a plain subroutine which will be called with just $env -- remember that in this case if you need $self you -must- close over it. + sub dispatch_request { + [ sub { + my $respond = shift; + # This is pure PSGI here, so read perldoc PSGI + } ] + } + +If you return a string followed by a subroutine or method name, the string is +treated as a match specification - and if the test is passed, the subroutine +is called as a method and passed any matched arguments (see below for more details). + +You can also return a plain subroutine which will be called with just C<$env> +- remember that in this case if you need C<$self> you B close over it. If you return a normal object, L will simply return it upwards on the assumption that a response_filter (or some arbitrary L) @@ -206,10 +241,27 @@ somewhere will convert it to something useful. This allows: sub dispatch_request { my $self = shift; - sub (.html) { response_filter { $self->render_zoom($_[0]) } }, - sub (/user/*) { $self->users->get($_[1]) }, + ( + '.html' => sub { response_filter { $self->render_zoom($_[0]) } }, + '/user/*' => sub { $self->users->get($_[1]) }, + ); } +An alternative to using string + suborutine to declare a route is to use +the sub prototype - + + sub dispatch_request { + my $self = shift; + ( + sub (.html) { response_filter { $self->render_zoom($_[0]) } }, + sub (/user/) { $self->users->get($_[1]) }, + $self->can('handle_post'), # if declared as 'sub handle_post (...) {' + ) + } + +This can be useful sugar, especially if you want to keep method-based +dispatchers' route specifications on the methods. + to render a user object to HTML, if there is an incoming URL such as: http://myweb.org/user/111.html @@ -222,51 +274,59 @@ This user object 'bubbles up' through all the wrapping middleware until it hits the C we defined, after which the return is converted to a true html response. -However, two types of object are treated specially - a Plack::App object -will have its C<->to_app> method called and be used as a dispatcher: +However, two types of objects are treated specially - a C object +will have its C method called and be used as a dispatcher: sub dispatch_request { my $self = shift; - sub (/static/...) { Plack::App::File->new(...) }, - ... + ( + '/static/...' => sub { Plack::App::File->new(...) }, + ... + ); } -A Plack::Middleware object will be used as a filter for the rest of the +A L object will be used as a filter for the rest of the dispatch being returned into: ## responds to /admin/track_usage AND /admin/delete_accounts sub dispatch_request { my $self = shift; - sub (/admin/**) { - Plack::Middleware::Session->new(%opts); - }, - sub (/admin/track_usage) { - ## something that needs a session - }, - sub (/admin/delete_accounts) { - ## something else that needs a session - }, + ( + '/admin/**' => sub { + Plack::Middleware::Session->new(%opts); + }, + '/admin/track_usage' => sub { + ## something that needs a session + }, + '/admin/delete_accounts' => sub { + ## something else that needs a session + }, + ); } -Note that this is for the dispatch being -returned- to, so if you want to +Note that this is for the dispatch being B to, so if you want to provide it inline you need to do: ## ALSO responds to /admin/track_usage AND /admin/delete_accounts sub dispatch_request { my $self = shift; - sub (/admin/...) { - sub { - Plack::Middleware::Session->new(%opts); - }, - sub (/track_usage) { - ## something that needs a session - }, - sub (/delete_accounts) { - ## something else that needs a session - }, - } + ( + '/admin/...' => sub { + ( + sub { + Plack::Middleware::Session->new(%opts); + }, + '/track_usage' => sub { + ## something that needs a session + }, + '/delete_accounts' => sub { + ## something else that needs a session + }, + ); + } + ); } And that's it - but remember that all this happens recursively - it's @@ -277,51 +337,61 @@ dispatchers and then hit all added filters or L. =head3 Method matches - sub (GET) { + 'GET' => sub { A match specification beginning with a capital letter matches HTTP requests with that request method. =head3 Path matches - sub (/login) { + '/login' => sub { A match specification beginning with a / is a path match. In the simplest case it matches a specific path. To match a path with a wildcard part, you can do: - sub (/user/*) { + '/user/*' => sub { $self->handle_user($_[1]) This will match /user/ where does not include a literal / character. The matched part becomes part of the match arguments. You can also match more than one part: - sub (/user/*/*) { + '/user/*/*' => sub { my ($self, $user_1, $user_2) = @_; - sub (/domain/*/user/*) { + '/domain/*/user/*' => sub { my ($self, $domain, $user) = @_; -and so on. To match an arbitrary number of parts, use - +and so on. To match an arbitrary number of parts, use C<**>: - sub (/page/**) { + '/page/**' => sub { + my ($self, $match) = @_; -This will result in an element per /-separated part so matched. Note that -you can do +This will result in a single element for the entire match. Note that you can do - sub (/page/**/edit) { + '/page/**/edit' => sub { to match an arbitrary number of parts up to but not including some final part. +Note: Since Web::Simple handles a concept of file extensions, C<*> and C<**> +matchers will not by default match things after a final dot, and this +can be modified by using C<*.*> and C<**.*> in the final position, e.g.: + + /one/* matches /one/two.three and captures "two" + /one/*.* matches /one/two.three and captures "two.three" + /** matches /one/two.three and captures "one/two" + /**.* matches /one/two.three and captures "one/two.three" + Finally, - sub (/foo/...) { + '/foo/...' => sub { -Will match /foo/ on the beginning of the path -and- strip it. This is designed -to be used to construct nested dispatch structures, but can also prove useful -for having e.g. an optional language specification at the start of a path. +Will match C on the beginning of the path B strip it. This is +designed to be used to construct nested dispatch structures, but can also prove +useful for having e.g. an optional language specification at the start of a +path. Note that the '...' is a "maybe something here, maybe not" so the above specification will match like this: @@ -330,29 +400,103 @@ specification will match like this: /foo/ # match and strip path to '/' /foo/bar/baz # match and strip path to '/bar/baz' -Note: Since Web::Simple handles a concept of file extensions, * and ** -matchers will not by default match things after a final dot, and this -can be modified by using *.* and **.* in the final position, i.e.: +Almost the same, - /one/* matches /one/two.three and captures "two" - /one/*.* matches /one/two.three and captures "two.three" - /** matches /one/two.three and captures "one/two" - /**.* matches /one/two.three and captures "one/two.three" + '/foo...' => sub { + +Will match on C, but also include C. Otherwise it +operates the same way as C. + + /foo # match and strip path to '' + /foo/ # match and strip path to '/' + /foo/bar/baz # match and strip path to '/bar/baz' + +Please note the difference between C and C. In +the first case, this is expecting to find something after C (and fails to +match if nothing is found), while in the second case we can match both C +and C. The following are roughly the same: + + '/foo' => sub { 'I match /foo' }, + '/foo/...' => sub { + ( + '/bar' => sub { 'I match /foo/bar' }, + '/*' => sub { 'I match /foo/{id}' }, + ); + } + +Versus + + '/foo...' => sub { + ( + '~' => sub { 'I match /foo' }, + '/bar' => sub { 'I match /foo/bar' }, + '/*' => sub { 'I match /foo/{id}' }, + ); + } + +You may prefer the latter example should you wish to take advantage of +subdispatchers to scope common activities. For example: + + '/user...' => sub { + my $user_rs = $schema->resultset('User'); + ( + '~' => sub { $user_rs }, + '/*' => sub { $user_rs->find($_[1]) }, + ); + } + +You should note the special case path match C which is only meaningful +when it is contained in this type of path match. It matches to an empty path. + +=head4 Naming your patch matches + +Any C<*>, C<**>, C<*.*>, or C<**.*> match can be followed with C<:name> to make it into a named +match, so: + + '/*:one/*:two/*:three/*:four' => sub { + "I match /1/2/3/4 capturing { one => 1, two => 2, three => 3, four => 4 }" + } + + '/**.*:allofit' => sub { + "I match anything capturing { allofit => \$whole_path }" + } + +In the specific case of a simple single-* match, the * may be omitted, to +allow you to write: + + '/:one/:two/:three/:four' => sub { + "I match /1/2/3/4 capturing { one => 1, two => 2, three => 3, four => 4 }" + } + +=head4 C and C are different specs + +As you may have noticed with the difference between C<'/foo/...'> and +C<'/foo...'>, trailing slashes in path specs are significant. This is +intentional and necessary to retain the ability to use relative links on +websites. Let's demonstrate on this link: + + bar + +If the user loads the url C and clicks on this link, they will be +sent to C. However when they are on the url C and click this +link, then they will be sent to C. + +This makes it necessary to be explicit about the trailing slash. =head3 Extension matches - sub (.html) { + '.html' => sub { will match .html from the path (assuming the subroutine itself returns -something, of course). This is normally used for rendering - e.g. +something, of course). This is normally used for rendering - e.g.: - sub (.html) { + '.html' => sub { response_filter { $self->render_html($_[1]) } } Additionally, - sub (.*) { + '.*' => sub { will match any extension and supplies the extension as a match argument. @@ -360,15 +504,14 @@ will match any extension and supplies the extension as a match argument. Query and body parameters can be match via - sub (?) { # match URI query - sub (%) { # match body params + '?' => sub { # match URI query + '%' => sub { # match body params The body spec will match if the request content is either application/x-www-form-urlencoded or multipart/form-data - the latter -of which is required for uploads, which are now handled experimentally -- see below. +of which is required for uploads - see below. -The param spec is elements of one of the following forms - +The param spec is elements of one of the following forms: param~ # optional parameter param= # required parameter @@ -381,24 +524,26 @@ The param spec is elements of one of the following forms - * # include all other parameters in hashref @* # include all other parameters as multiple in hashref -separated by the & character. The arguments added to the request are -one per non-:/* parameter (scalar for normal, arrayref for multiple), -plus if any :/* specs exist a hashref containing those values. +separated by the C<&> character. The arguments added to the request are +one per non-C<:>/C<*> parameter (scalar for normal, arrayref for multiple), +plus if any C<:>/C<*> specs exist a hashref containing those values. If a +parameter has no value, i.e. appears as '?foo&', a value of 1 will be +captured. Please note that if you specify a multiple type parameter match, you are ensured of getting an arrayref for the value, EVEN if the current incoming request has only one value. However if a parameter is specified as single and multiple values are found, the last one will be used. -For example to match a page parameter with an optional order_by parameter one +For example to match a C parameter with an optional C parameter one would write: - sub (?page=&order_by~) { + '?page=&order_by~' => sub { my ($self, $page, $order_by) = @_; return unless $page =~ /^\d+$/; - $page ||= 'id'; + $order_by ||= 'id'; response_filter { - $_[1]->search_rs({}, $p); + $_[1]->search_rs({}, { page => $page, order_by => $order_by }); } } @@ -406,36 +551,32 @@ to implement paging and ordering against a L object. Another Example: To get all parameters as a hashref of arrayrefs, write: - sub(?@*) { + '?@*' => sub { my ($self, $params) = @_; ... To get two parameters as a hashref, write: - sub(?:user~&:domain~) { + '?:user~&:domain~' => sub { my ($self, $params) = @_; # params contains only 'user' and 'domain' keys You can also mix these, so: - sub (?foo=&@bar~&:coffee=&@*) { - my ($self, $foo, $bar, $params); + '?foo=&@bar~&:coffee=&@*' => sub { + my ($self, $foo, $bar, $params) = @_; where $bar is an arrayref (possibly an empty one), and $params contains -arrayref values for all parameters -not- mentioned and a scalar value for +arrayref values for all parameters B mentioned and a scalar value for the 'coffee' parameter. Note, in the case where you combine arrayref, single parameter and named hashref style, the arrayref and single parameters will appear in C<@_> in the -order you defined them in the protoype, but all hashrefs will merge into a +order you defined them in the prototype, but all hashrefs will merge into a single C<$params>, as in the example above. -=head3 Upload matches (EXPERIMENTAL) +=head3 Upload matches -Note: This feature is experimental. This means that it may not remain -100% in its current form. If we change it, notes on updating your code -will be added to the L section below. - - sub (*foo=) { # param specifier can be anything valid for query or body + '*foo=' => sub { # param specifier can be anything valid for query or body The upload match system functions exactly like a query/body match, except that the values returned (if any) are C objects. @@ -463,71 +604,110 @@ filename to make copying it somewhere else easier to handle. Matches may be combined with the + character - e.g. - sub (GET + /user/*) { + 'GET + /user/*' => sub { -to create an AND match. They may also be combined withe the | character - e.g. +to create an AND match. They may also be combined with the | character - e.g. - sub (GET|POST) { + 'GET|POST' => sub { to create an OR match. Matches can be nested with () - e.g. - sub ((GET|POST) + /user/*) { + '(GET|POST + /user/*)' => sub { and negated with ! - e.g. - sub (!/user/foo + /user/*) { + '!/user/foo + /user/*' => sub { ! binds to the immediate rightmost match specification, so if you want to negate a combination you will need to use - sub ( !(POST|PUT|DELETE) ) { + '!(POST|PUT|DELETE)' => sub { and | binds tighter than +, so - sub ((GET|POST) + /user/*) { + '(GET|POST) + /user/*' => sub { and - sub (GET|POST + /user/*) { + 'GET|POST + /user/*' => sub { are equivalent, but - sub ((GET + /admin/...) | (POST + /admin/...)) { + '(GET + /admin/...) | (POST + /admin/...)' => sub { and - sub (GET + /admin/... | POST + /admin/...) { + 'GET + /admin/... | POST + /admin/...' => sub { are not - the latter is equivalent to - sub (GET + (/admin/...|POST) + /admin/...) { + 'GET + (/admin/...|POST) + /admin/...' => sub { which will never match! =head3 Whitespace -Note that for legibility you are permitted to use whitespace - +Note that for legibility you are permitted to use whitespace: - sub (GET + /user/*) { + 'GET + /user/*' => sub { but it will be ignored. This is because the perl parser strips whitespace from subroutine prototypes, so this is equivalent to - sub (GET+/user/*) { + 'GET+/user/*' => sub { + +=head3 Accessing parameters via C<%_> + +If your dispatch specification causes your dispatch subroutine to receive +a hash reference as its first argument, the contained named parameters +will be accessible via C<%_>. + +This can be used to access your path matches, if they are named: + + 'GET + /foo/:path_part' => sub { + [ 200, + ['Content-type' => 'text/plain'], + ["We are in $_{path_part}"], + ]; + } + +Or, if your first argument would be a hash reference containing named +query parameters: + + 'GET + /foo + ?:some_param=' => sub { + [ 200, + ['Content-type' => 'text/plain'], + ["We received $_{some_param} as parameter"], + ]; + } + +Of course this also works when all you are doing is slurping the whole set +of parameters by their name: + + 'GET + /foo + ?*' => sub { + [ 200, + ['Content-type' => 'text/plain'], + [exists($_{foo}) ? "Received a foo: $_{foo}" : "No foo!"], + ], + } + +Note that only the first hash reference will be available via C<%_>. If +you receive additional hash references, you will need to access them as +usual. =head3 Accessing the PSGI env hash In some cases you may wish to get the raw PSGI env hash - to do this, -you can either use a plain sub - +you can either use a plain sub: sub { my ($env) = @_; ... } -or use the PSGI_ENV constant exported to retrieve it: +or use the C constant exported to retrieve it from C<@_>: - sub (GET + /foo + ?some_param=) { + 'GET + /foo + ?some_param=' => sub { my $param = $_[1]; my $env = $_[PSGI_ENV]; } @@ -567,12 +747,12 @@ It creates and returns a special dispatcher that always matches, and instead of continuing dispatch re-delegates it to the start of the dispatch process, but with the path of the request altered to the supplied URL. -Thus if you receive a POST to '/some/url' and return a redispatch to -'/other/url', the dispatch behaviour will be exactly as if the same POST -request had been made to '/other/url' instead. +Thus if you receive a POST to C and return a redispatch to +C, the dispatch behaviour will be exactly as if the same POST +request had been made to C instead. Note, this is not the same as returning an HTTP 3xx redirect as a response; -rather it is a much more efficient internal process. +rather it is a much more efficient internal process. =head1 CHANGES BETWEEN RELEASES @@ -586,19 +766,21 @@ dispatch {} has gone away - instead, you write: sub dispatch_request { my $self = shift; - sub (GET /foo/) { ... }, - ... + ( + 'GET /foo/' => sub { ... }, + ... + ); } -Note that this method is still -returning- the dispatch code - just like -dispatch did. +Note that this method is still B the dispatch code - just like +C did. -Also note that you need the 'my $self = shift' since the magic $self +Also note that you need the C<< my $self = shift >> since the magic $self variable went away. =item * the magic $self variable went away. -Just add 'my $self = shift;' while writing your 'sub dispatch_request {' +Just add C<< my $self = shift; >> while writing your C<< sub dispatch_request { >> like a normal perl method. =item * subdispatch deleted - all dispatchers can now subdispatch @@ -690,7 +872,7 @@ John Napiorkowski (jnap) Josh McMichael -Justin Hunter +Justin Hunter (arcanez) Kjetil Kjernsmo @@ -702,9 +884,17 @@ nperez Robin Edwards +Andrew Rodland (hobbs) + +Robert Sedlacek (phaylon) + +Hakim Cassimally (osfameron) + +Karen Etheridge (ether) + =head1 COPYRIGHT -Copyright (c) 2010 the Web::Simple L and L +Copyright (c) 2011 the Web::Simple L and L as listed above. =head1 LICENSE @@ -713,5 +903,3 @@ This library is free software and may be distributed under the same terms as perl itself. =cut - -1;