X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FUtils.pm;h=1bccecba7ada144b97fa0d5a216598843458b8c2;hp=5d5cfc3686e30a46e31ec402bb9e0eb2efb66976;hb=81436df99bdb4a0afd7367fb946c5481b483919d;hpb=f55d149186ec2daa69216561df88353feaeb2fd9 diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm index 5d5cfc3..1bccecb 100644 --- a/lib/Catalyst/Utils.pm +++ b/lib/Catalyst/Utils.pm @@ -1,13 +1,16 @@ package Catalyst::Utils; use strict; -use Catalyst::Exception; use File::Spec; use HTTP::Request; use Path::Class; use URI; use Carp qw/croak/; use Cwd; +use Class::Load 'is_class_loaded'; +use String::RewritePrefix; +use Class::Load (); +use namespace::clean; =head1 NAME @@ -19,6 +22,8 @@ See L. =head1 DESCRIPTION +Catalyst Utilities. + =head1 METHODS =head2 appprefix($class) @@ -118,7 +123,7 @@ sub class2prefix { Returns a tempdir for a class. If create is true it will try to create the path. My::App becomes /tmp/my/app - My::App::C::Foo::Bar becomes /tmp/my/app/c/foo/bar + My::App::Controller::Foo::Bar becomes /tmp/my/app/c/foo/bar =cut @@ -131,9 +136,15 @@ sub class2tempdir { if ( $create && !-e $tmpdir ) { - eval { $tmpdir->mkpath }; - - if ($@) { + eval { $tmpdir->mkpath; 1 } + or do { + # don't load Catalyst::Exception as a BEGIN in Utils, + # because Utils often gets loaded before MyApp.pm, and if + # Catalyst::Exception is loaded before MyApp.pm, it does + # not honor setting + # $Catalyst::Exception::CATALYST_EXCEPTION_CLASS in + # MyApp.pm + require Catalyst::Exception; Catalyst::Exception->throw( message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ ); } @@ -146,8 +157,31 @@ sub class2tempdir { Returns home directory for given class. +=head2 dist_indicator_file_list + +Returns a list of files which can be tested to check if you're inside +a CPAN distribution which is not yet installed. + +These are: + +=over + +=item Makefile.PL + +=item Build.PL + +=item dist.ini + +=item L + +=back + =cut +sub dist_indicator_file_list { + qw{Makefile.PL Build.PL dist.ini cpanfile}; +} + sub home { my $class = shift; @@ -166,9 +200,8 @@ sub home { # pop off /lib and /blib if they're there $home = $home->parent while $home =~ /b?lib$/; - # only return the dir if it has a Makefile.PL or Build.PL - if (-f $home->file("Makefile.PL") or -f $home->file("Build.PL")) { - + # only return the dir if it has a Makefile.PL or Build.PL or dist.ini + if (grep { -f $home->file($_) } dist_indicator_file_list()) { # clean up relative path: # MyApp/script/.. -> MyApp @@ -189,7 +222,7 @@ sub home { ( my $path = $inc_entry) =~ s/\.pm$//; my $home = dir($path)->absolute->cleanup; - # return if if it's a valid directory + # return if it's a valid directory return $home->stringify if -d $home; } } @@ -263,9 +296,7 @@ sub ensure_class_loaded { # if it already has symbol table entries. This is to support things like Schema::Loader, which # part-generate classes in memory, but then also load some of their contents from disk. return if !$opts->{ ignore_loaded } - && Class::MOP::is_class_loaded($class); # if a symbol entry exists we don't load again - - # FIXME - as soon as Class::MOP 0.67 + 1 is released Class::MOP::load_class($class) can be used instead + && is_class_loaded($class); # if a symbol entry exists we don't load again # this hack is so we don't overwrite $@ if the load did not generate an error my $error; @@ -280,7 +311,7 @@ sub ensure_class_loaded { die $error if $error; warn "require $class was successful but the package is not defined." - unless Class::MOP::is_class_loaded($class); + unless is_class_loaded($class); return 1; } @@ -295,7 +326,7 @@ sub merge_hashes { my ( $lefthash, $righthash ) = @_; return $lefthash unless defined $righthash; - + my %merged = %$lefthash; for my $key ( keys %$righthash ) { my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH'; @@ -309,7 +340,7 @@ sub merge_hashes { $merged{ $key } = $righthash->{ $key }; } } - + return \%merged; } @@ -336,13 +367,280 @@ sub env_value { return; } +=head2 term_width + +Try to guess terminal width to use with formatting of debug output + +All you need to get this work, is: + +1) Install Term::Size::Any, or + +2) Export $COLUMNS from your shell. + +(Warning to bash users: 'echo $COLUMNS' may be showing you the bash +variable, not $ENV{COLUMNS}. 'export COLUMNS=$COLUMNS' and you should see +that 'env' now lists COLUMNS.) + +As last resort, default value of 80 chars will be used. + +Calling C with a true value will cause it to be recalculated; you +can use this to cause it to get recalculated when your terminal is resized like +this + + $SIG{WINCH} = sub { Catalyst::Utils::term_width(1) }; + +=cut + +my $_term_width; + +sub term_width { + my $force_reset = shift; + + undef $_term_width if $force_reset; + + return $_term_width if $_term_width; + + my $width; + eval ' + use Term::Size::Any; + ($width) = Term::Size::Any::chars; + 1; + ' or do { + if($@ =~m[Can't locate Term/Size/Any.pm]) { + warn "Term::Size::Any is not installed, can't autodetect terminal column width\n"; + } else { + warn "There was an error trying to detect your terminal size: $@\n"; + } + warn 'Trouble trying to detect your terminal size, looking at $ENV{COLUMNS}'."\n"; + $width = $ENV{COLUMNS} + if exists($ENV{COLUMNS}) + && $ENV{COLUMNS} =~ m/^\d+$/; + }; + + do { + warn "Cannot determine desired terminal width, using default of 80 columns\n"; + $width = 80 } unless ($width && $width >= 80); + return $_term_width = $width; +} + + +=head2 resolve_namespace + +Method which adds the namespace for plugins and actions. + + __PACKAGE__->setup(qw(MyPlugin)); + + # will load Catalyst::Plugin::MyPlugin + +=cut + + +sub resolve_namespace { + my $appnamespace = shift; + my $namespace = shift; + my @classes = @_; + return String::RewritePrefix->rewrite({ + q[] => qq[${namespace}::], + q[+] => q[], + (defined $appnamespace + ? (q[~] => qq[${appnamespace}::]) + : () + ), + }, @classes); +} + +=head2 build_middleware (@args) + +Internal application that converts a single middleware definition (see +L) into an actual instance of middleware. + +=cut + +sub build_middleware { + my ($class, $namespace, @init_args) = @_; + + if( + $namespace =~s/^\+// || + $namespace =~/^Plack::Middleware/ || + $namespace =~/^$class/ + ) { ## the string is a full namespace + return Class::Load::try_load_class($namespace) ? + $namespace->new(@init_args) : + die "Can't load class $namespace"; + } else { ## the string is a partial namespace + if(Class::Load::try_load_class($class .'::Middleware::'. $namespace)) { ## Load Middleware from Project namespace + my $ns = $class .'::Middleware::'. $namespace; + return $ns->new(@init_args); + } elsif(Class::Load::try_load_class("Plack::Middleware::$namespace")) { ## Act like Plack::Builder + return "Plack::Middleware::$namespace"->new(@init_args); + } else { + die "Can't load middleware via '$namespace'. It's not ".$class."::Middleware::".$namespace." or Plack::Middleware::$namespace"; + } + } + + return; ## be sure we can count on a proper return when valid +} + +=head2 apply_registered_middleware ($psgi) + +Given a $psgi reference, wrap all the L +around it and return the wrapped version. + +This exists to deal with the fact Catalyst registered middleware can be +either an object with a wrap method or a coderef. + +=cut + +sub apply_registered_middleware { + my ($class, $psgi) = @_; + my $new_psgi = $psgi; + foreach my $middleware ($class->registered_middlewares) { + $new_psgi = Scalar::Util::blessed $middleware ? + $middleware->wrap($new_psgi) : + $middleware->($new_psgi); + } + return $new_psgi; +} + + + +=head1 PSGI Helpers + +Utility functions to make it easier to work with PSGI applications under Catalyst + +=head2 env_at_path_prefix + +Localize C<$env> under the current controller path prefix: + + package MyApp::Controller::User; + + use Catalyst::Utils; + + use base 'Catalyst::Controller'; + + sub name :Local { + my ($self, $c) = @_; + my $env = $c->Catalyst::Utils::env_at_path_prefix; + } + +Assuming you have a request like GET /user/name: + +In the example case C<$env> will have PATH_INFO of '/name' instead of +'/user/name' and SCRIPT_NAME will now be '/user'. + +=cut + +sub env_at_path_prefix { + my $ctx = shift; + my $path_prefix = $ctx->controller->path_prefix; + my $env = $ctx->request->env; + my $path_info = $env->{PATH_INFO}; + my $script_name = ($env->{SCRIPT_NAME} || ''); + + $path_info =~ s/(^\/\Q$path_prefix\E)//; + $script_name = "$script_name$1"; + + return +{ + %$env, + PATH_INFO => $path_info, + SCRIPT_NAME => $script_name }; +} + +=head2 env_at_action + +Localize C<$env> under the current action namespace. + + package MyApp::Controller::User; + + use Catalyst::Utils; + + use base 'Catalyst::Controller'; + + sub name :Local { + my ($self, $c) = @_; + my $env = $c->Catalyst::Utils::env_at_action; + } + +Assuming you have a request like GET /user/name: + +In the example case C<$env> will have PATH_INFO of '/' instead of +'/user/name' and SCRIPT_NAME will now be '/user/name'. + +Alternatively, assuming you have a request like GET /user/name/foo: + +In this example case C<$env> will have PATH_INFO of '/foo' instead of +'/user/name/foo' and SCRIPT_NAME will now be '/user/name'. + +This is probably a common case where you want to mount a PSGI application +under an action but let the Args fall through to the PSGI app. + +=cut + +sub env_at_action { + my $ctx = shift; + my $argpath = join '/', @{$ctx->request->arguments}; + my $path = '/' . $ctx->request->path; + + $path =~ s/\/?\Q$argpath\E\/?$//; + + my $env = $ctx->request->env; + my $path_info = $env->{PATH_INFO}; + my $script_name = ($env->{SCRIPT_NAME} || ''); + + $path_info =~ s/(^\Q$path\E)//; + $script_name = "$script_name$1"; + + return +{ + %$env, + PATH_INFO => $path_info, + SCRIPT_NAME => $script_name }; +} + +=head2 env_at_request_uri + +Localize C<$env> under the current request URI: + + package MyApp::Controller::User; + + use Catalyst::Utils; + + use base 'Catalyst::Controller'; + + sub name :Local Args(1) { + my ($self, $c, $id) = @_; + my $env = $c->Catalyst::Utils::env_at_request_uri + } + +Assuming you have a request like GET /user/name/hello: + +In the example case C<$env> will have PATH_INFO of '/' instead of +'/user/name' and SCRIPT_NAME will now be '/user/name/hello'. + +=cut + +sub env_at_request_uri { + my $ctx = shift; + my $path = '/' . $ctx->request->path; + my $env = $ctx->request->env; + my $path_info = $env->{PATH_INFO}; + my $script_name = ($env->{SCRIPT_NAME} || ''); + + $path_info =~ s/(^\Q$path\E)//; + $script_name = "$script_name$1"; + + return +{ + %$env, + PATH_INFO => $path_info, + SCRIPT_NAME => $script_name }; +} + =head1 AUTHORS Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it under +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut