use URI;
use Carp qw/croak/;
use Cwd;
-use Class::MOP;
+use Class::Load 'is_class_loaded';
use String::RewritePrefix;
-
+use Class::Load ();
use namespace::clean;
+use Devel::InnerPackage;
+use Moose::Util;
=head1 NAME
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
=item dist.ini
+=item L<cpanfile>
+
=back
=cut
sub dist_indicator_file_list {
- qw{Makefile.PL Build.PL dist.ini};
+ qw{Makefile.PL Build.PL dist.ini cpanfile};
}
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;
}
}
# 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
+ && 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;
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;
}
As last resort, default value of 80 chars will be used.
+Calling C<term_width> 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;
- my $width = eval '
- use Term::Size::Any;
- my ($columns, $rows) = Term::Size::Any::chars;
- return $columns;
- ';
+ undef $_term_width if $force_reset;
- if ($@) {
+ 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";
+ }
+ };
+
+ 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;
}
}, @classes);
}
+=head2 build_middleware (@args)
+
+Internal application that converts a single middleware definition (see
+L<Catalyst/psgi_middleware>) 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<Catalyst/registered_middlewares>
+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 L<Moose::Role>s that the component 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<NOTE:> This is basically a core version of L<CatalystX::InjectComponent>. 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<NOTE:> The 'traits' option is unique to the L<Catalyst::Utils> version of this feature.
+
+B<NOTE:> These injected components really need to be a L<Catalyst::Component> and a L<Moose>
+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
projects / catagits/Catalyst-Runtime.git / blobdiff