plack::app::urlmap(3pm) [debian man page]

Plack::App::URLMap(3pm) 				User Contributed Perl Documentation				   Plack::App::URLMap(3pm)

NAME

       Plack::App::URLMap - Map multiple apps in different paths

SYNOPSIS

	 use Plack::App::URLMap;

	 my $app1 = sub { ... };
	 my $app2 = sub { ... };
	 my $app3 = sub { ... };

	 my $urlmap = Plack::App::URLMap->new;
	 $urlmap->map("/" => $app1);
	 $urlmap->map("/foo" => $app2);
	 $urlmap->map("http://bar.example.com/" => $app3);

	 my $app = $urlmap->to_app;

DESCRIPTION

       Plack::App::URLMap is a PSGI application that can dispatch multiple applications based on URL path and hostnames (a.k.a "virtual hosting")
       and takes care of rewriting "SCRIPT_NAME" and "PATH_INFO" (See "HOW THIS WORKS" for details). This module is inspired by Rack::URLMap.

METHODS

       map
	     $urlmap->map("/foo" => $app);
	     $urlmap->map("http://bar.example.com/" => $another_app);

	   Maps URL path or an absolute URL to a PSGI application. The match order is sorted by host name length and then path length.

	   URL paths need to match from the beginning and should match completely till the path separator (or the end of the path). For example,
	   if you register the path "/foo", it will match with the request "/foo", "/foo/" or "/foo/bar" but it won't match with "/foox".

	   Mapping URL with host names is also possible, and in that case the URL mapping works like a virtual host.

	   Mappings will nest.	If $app is already mapped to "/baz" it will match a request for "/foo/baz" but not "/foo". See "HOW THIS WORKS"
	   for more details.

       mount
	   Alias for "map".

       to_app
	     my $handler = $urlmap->to_app;

	   Returns the PSGI application code reference. Note that the Plack::App::URLMap object is callable (by overloading the code dereference),
	   so returning the object itself as a PSGI application should also work.

DEBUGGING

       You can set the environment variable "PLACK_URLMAP_DEBUG" to see how this application matches with the incoming request host names and
       paths.

HOW THIS WORKS

       This application works by fixing "SCRIPT_NAME" and "PATH_INFO" before dispatching the incoming request to the relocated applications.

       Say you have a Wiki application that takes "/index" and "/page/*" and makes a PSGI application $wiki_app out of it, using one of supported
       web frameworks, you can put the whole application under "/wiki" by:

	 # MyWikiApp looks at PATH_INFO and handles /index and /page/*
	 my $wiki_app = sub { MyWikiApp->run(@_) };

	 use Plack::App::URLMap;
	 my $app = Plack::App::URLMap->new;
	 $app->mount("/wiki" => $wiki_app);

       When a request comes in with "PATH_INFO" set to "/wiki/page/foo", the URLMap application $app strips the "/wiki" part from "PATH_INFO" and
       appends that to "SCRIPT_NAME".

       That way, if the $app is mounted under the root (i.e. "SCRIPT_NAME" is "") with standalone web servers like Starman, "SCRIPT_NAME" is now
       locally set to "/wiki" and "PATH_INFO" is changed to "/page/foo" when $wiki_app gets called.

AUTHOR

       Tatsuhiko Miyagawa

SEE ALSO

       Plack::Builder

perl v5.14.2							    2011-06-22						   Plack::App::URLMap(3pm)

Check Out this Related Man Page

Plack::Runner(3pm)					User Contributed Perl Documentation					Plack::Runner(3pm)

NAME

       Plack::Runner - plackup core

SYNOPSIS

	 # Your bootstrap script
	 use Plack::Runner;
	 my $app = sub { ... };

	 my $runner = Plack::Runner->new;
	 $runner->parse_options(@ARGV);
	 $runner->run($app);

DESCRIPTION

       Plack::Runner is the core of plackup runner script. You can create your own frontend to run your application or framework, munge command
       line options and pass that to "run" method of this class.

       "run" method does exactly the same thing as the plackup script does, but one notable addition is that you can pass a PSGI application code
       reference directly to the method, rather than via ".psgi" file path or with "-e" switch. This would be useful if you want to make an
       installable PSGI application.

       Also, when "-h" or "--help" switch is passed, the usage text is automatically extracted from your own script using Pod::Usage.

NOTES

       Do not directly call this module from your ".psgi", since that makes your PSGI application unnecessarily depend on plackup and won't run
       other backends like Plack::Handler::Apache2 or mod_psgi.

       If you really want to make your ".psgi" runnable as a standalone script, you can do this:

	 my $app = sub { ... };

	 unless (caller) {
	     require Plack::Runner;
	     my $runner = Plack::Runner->new;
	     $runner->parse_options(@ARGV);
	     return $runner->run($app);
	 }

	 return $app;

       WARNING: this section used to recommend "if (__FILE__ eq $0)" but it's known to be broken since Plack 0.9971, since $0 is now always set to
       the .psgi file path even when you run it from plackup.

SEE ALSO

       plackup

perl v5.14.2							    2012-03-21							Plack::Runner(3pm)

Linux and UNIX Man Pages

plack::app::urlmap(3pm) [debian man page]

Check Out this Related Man Page