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=fc877d430fd75bfd57343427853ba3a3044f23ea;hp=f3d8c12c4babf134f7981fecee4d9d7f4d210fe2;hb=199731fb710c6a165793f055f85de60539039dfe;hpb=e73e3bad5248d5d16e6b32024ca341d1208e7bcb diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm index f3d8c12..fc877d4 100644 --- a/lib/Catalyst/Utils.pm +++ b/lib/Catalyst/Utils.pm @@ -1,14 +1,18 @@ package Catalyst::Utils; use strict; -use Catalyst::Exception; use File::Spec; use HTTP::Request; use Path::Class; use URI; -use Class::Inspector; use Carp qw/croak/; use Cwd; +use Class::Load 'is_class_loaded'; +use String::RewritePrefix; +use Class::Load (); +use namespace::clean; +use Devel::InnerPackage; +use Moose::Util; =head1 NAME @@ -20,7 +24,7 @@ See L. =head1 DESCRIPTION -Catalyst Utilities. +Catalyst Utilities. =head1 METHODS @@ -121,7 +125,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 @@ -134,9 +138,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', "$@"/ ); } @@ -149,8 +159,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; @@ -169,9 +202,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 @@ -192,7 +224,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; } } @@ -262,8 +294,11 @@ sub ensure_class_loaded { croak "ensure_class_loaded should be given a classname, not a filename ($class)" if $class =~ m/\.pm$/; + # $opts->{ignore_loaded} can be set to true, and this causes the class to be required, even + # 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::Inspector->loaded( $class ); # if a symbol entry exists we don't load again + && 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; @@ -276,8 +311,9 @@ sub ensure_class_loaded { } die $error if $error; - die "require $class was successful but the package is not defined" - unless Class::Inspector->loaded($class); + + warn "require $class was successful but the package is not defined." + unless is_class_loaded($class); return 1; } @@ -292,7 +328,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'; @@ -306,7 +342,7 @@ sub merge_hashes { $merged{ $key } = $righthash->{ $key }; } } - + return \%merged; } @@ -341,44 +377,350 @@ All you need to get this work, is: 1) Install Term::Size::Any, or -2) Export $COLUMNS from your shell. +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 +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 { - return $_term_width if $_term_width; + my $force_reset = shift; + + undef $_term_width if $force_reset; - my $width = eval ' - use Term::Size::Any; - my ($columns, $rows) = Term::Size::Any::chars; - return $columns; - '; + return $_term_width if $_term_width; - if ($@) { + 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"; + } + }; + + unless ($width) { + warn 'Trouble trying to detect your terminal size, looking at $ENV{COLUMNS}'."\n"; $width = $ENV{COLUMNS} if exists($ENV{COLUMNS}) && $ENV{COLUMNS} =~ m/^\d+$/; } - $width = 80 unless ($width && $width >= 80); + 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; +} + +=head2 inject_component + +Used to add components at runtime: + + into The Catalyst package to inject into (e.g. My::App) + component The component package to inject + traits (Optional) ArrayRef of Ls that the componet should consume. + as An optional moniker to use as the package name for the derived component + +For example: + + Catalyst::Utils::inject_component( into => My::App, component => Other::App::Controller::Apple ) + + The above will create 'My::App::Controller::Other::App::Controller::Apple' + + Catalyst::Utils::inject_component( into => My::App, component => Other::App::Controller::Apple, as => Apple ) + + The above will create 'My::App::Controller::Apple' + + Catalyst::Utils::inject_component( into => $myapp, component => 'MyRootV', as => 'Controller::Root' ); + +Will inject Controller, Model, and View components into your Catalyst application +at setup (run)time. It does this by creating a new package on-the-fly, having that +package extend the given component, and then having Catalyst setup the new component +(via $app->setup_component). + +B This is basically a core version of L. If you were using that +you can now use this safely instead. Going forward changes required to make this work will be +synchronized with the core method. + +B The 'traits' option is unique to the L version of this feature. + +B These injected components really need to be a L and a L +based class. + +=cut + +sub inject_component { + my %given = @_; + my ($into, $component, $as) = @given{qw/into component as/}; + + croak "No Catalyst (package) given" unless $into; + croak "No component (package) given" unless $component; + + Class::Load::load_class($component); + + $as ||= $component; + unless ( $as =~ m/^(?:Controller|Model|View)::/ || $given{skip_mvc_renaming} ) { + my $category; + for (qw/ Controller Model View /) { + if ( $component->isa( "Catalyst::$_" ) ) { + $category = $_; + last; + } + } + croak "Don't know what kind of component \"$component\" is" unless $category; + $as = "${category}::$as"; + } + my $component_package = join '::', $into, $as; + + unless ( Class::Load::is_class_loaded $component_package ) { + eval "package $component_package; use base qw/$component/; 1;" or + croak "Unable to build component package for \"$component_package\": $@"; + Moose::Util::apply_all_roles($component_package, @{$given{traits}}) if $given{traits}; + (my $file = "$component_package.pm") =~ s{::}{/}g; + $INC{$file} ||= 1; + } + + my $_setup_component = sub { + my $into = shift; + my $component_package = shift; + $into->components->{$component_package} = $into->delayed_setup_component( $component_package ); + }; + + $_setup_component->( $into, $component_package ); +} + +=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