1 package Catalyst::Utils;
4 use Catalyst::Exception;
12 use String::RewritePrefix;
18 Catalyst::Utils - The Catalyst Utils
30 =head2 appprefix($class)
32 MyApp::Foo becomes myapp_foo
43 =head2 class2appclass($class);
45 MyApp::Controller::Foo::Bar becomes MyApp
46 My::App::Controller::Foo::Bar becomes My::App
51 my $class = shift || '';
53 if ( $class =~ /^(.+?)::([MVC]|Model|View|Controller)::.+$/ ) {
59 =head2 class2classprefix($class);
61 MyApp::Controller::Foo::Bar becomes MyApp::Controller
62 My::App::Controller::Foo::Bar becomes My::App::Controller
66 sub class2classprefix {
67 my $class = shift || '';
69 if ( $class =~ /^(.+?::([MVC]|Model|View|Controller))::.+$/ ) {
75 =head2 class2classsuffix($class);
77 MyApp::Controller::Foo::Bar becomes Controller::Foo::Bar
81 sub class2classsuffix {
82 my $class = shift || '';
83 my $prefix = class2appclass($class) || '';
84 $class =~ s/$prefix\:://;
88 =head2 class2env($class);
90 Returns the environment name for class.
93 My::App becomes MY_APP
98 my $class = shift || '';
103 =head2 class2prefix( $class, $case );
105 Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
107 My::App::Controller::Foo::Bar becomes foo/bar
112 my $class = shift || '';
113 my $case = shift || 0;
115 if ( $class =~ /^.+?::([MVC]|Model|View|Controller)::(.+)$/ ) {
116 $prefix = $case ? $2 : lc $2;
117 $prefix =~ s{::}{/}g;
122 =head2 class2tempdir( $class [, $create ] );
124 Returns a tempdir for a class. If create is true it will try to create the path.
126 My::App becomes /tmp/my/app
127 My::App::C::Foo::Bar becomes /tmp/my/app/c/foo/bar
132 my $class = shift || '';
133 my $create = shift || 0;
134 my @parts = split '::', lc $class;
136 my $tmpdir = dir( File::Spec->tmpdir, @parts )->cleanup;
138 if ( $create && !-e $tmpdir ) {
140 eval { $tmpdir->mkpath };
143 Catalyst::Exception->throw(
144 message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ );
148 return $tmpdir->stringify;
153 Returns home directory for given class.
160 # make an $INC{ $key } style string from the class name
161 (my $file = "$class.pm") =~ s{::}{/}g;
163 if ( my $inc_entry = $INC{$file} ) {
165 # look for an uninstalled Catalyst app
167 # find the @INC entry in which $file was found
168 (my $path = $inc_entry) =~ s/$file$//;
169 $path ||= cwd() if !defined $path || !length $path;
170 my $home = dir($path)->absolute->cleanup;
172 # pop off /lib and /blib if they're there
173 $home = $home->parent while $home =~ /b?lib$/;
175 # only return the dir if it has a Makefile.PL or Build.PL
176 if (-f $home->file("Makefile.PL") or -f $home->file("Build.PL")) {
178 # clean up relative path:
179 # MyApp/script/.. -> MyApp
182 my @dir_list = $home->dir_list();
183 while (($dir = pop(@dir_list)) && $dir eq '..') {
184 $home = dir($home)->parent->parent;
187 return $home->stringify;
192 # look for an installed Catalyst app
194 # trim the .pm off the thing ( Foo/Bar.pm -> Foo/Bar/ )
195 ( my $path = $inc_entry) =~ s/\.pm$//;
196 my $home = dir($path)->absolute->cleanup;
198 # return if if it's a valid directory
199 return $home->stringify if -d $home;
207 =head2 prefix($class, $name);
209 Returns a prefixed action.
211 MyApp::Controller::Foo::Bar, yada becomes foo/bar/yada
216 my ( $class, $name ) = @_;
217 my $prefix = &class2prefix($class);
218 $name = "$prefix/$name" if $prefix;
224 Returns an L<HTTP::Request> object for a uri.
230 unless ( ref $request ) {
231 if ( $request =~ m/^http/i ) {
232 $request = URI->new($request);
235 $request = URI->new( 'http://localhost' . $request );
238 unless ( ref $request eq 'HTTP::Request' ) {
239 $request = HTTP::Request->new( 'GET', $request );
244 =head2 ensure_class_loaded($class_name, \%opts)
246 Loads the class unless it already has been loaded.
248 If $opts{ignore_loaded} is true always tries the require whether the package
249 already exists or not. Only pass this if you're either (a) sure you know the
250 file exists on disk or (b) have code to catch the file not found exception
251 that will result if it doesn't.
255 sub ensure_class_loaded {
259 croak "Malformed class Name $class"
260 if $class =~ m/(?:\b\:\b|\:{3,})/;
262 croak "Malformed class Name $class"
263 if $class =~ m/[^\w:]/;
265 croak "ensure_class_loaded should be given a classname, not a filename ($class)"
266 if $class =~ m/\.pm$/;
268 # $opts->{ignore_loaded} can be set to true, and this causes the class to be required, even
269 # if it already has symbol table entries. This is to support things like Schema::Loader, which
270 # part-generate classes in memory, but then also load some of their contents from disk.
271 return if !$opts->{ ignore_loaded }
272 && Class::MOP::is_class_loaded($class); # if a symbol entry exists we don't load again
274 # this hack is so we don't overwrite $@ if the load did not generate an error
278 my $file = $class . '.pm';
280 eval { CORE::require($file) };
284 die $error if $error;
286 warn "require $class was successful but the package is not defined."
287 unless Class::MOP::is_class_loaded($class);
292 =head2 merge_hashes($hashref, $hashref)
294 Base code to recursively merge two hashes together with right-hand precedence.
299 my ( $lefthash, $righthash ) = @_;
301 return $lefthash unless defined $righthash;
303 my %merged = %$lefthash;
304 for my $key ( keys %$righthash ) {
305 my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH';
306 my $left_ref = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH';
307 if( $right_ref and $left_ref ) {
308 $merged{ $key } = merge_hashes(
309 $lefthash->{ $key }, $righthash->{ $key }
313 $merged{ $key } = $righthash->{ $key };
320 =head2 env_value($class, $key)
322 Checks for and returns an environment value. For instance, if $key is
323 'home', then this method will check for and return the first value it finds,
324 looking at $ENV{MYAPP_HOME} and $ENV{CATALYST_HOME}.
329 my ( $class, $key ) = @_;
332 my @prefixes = ( class2env($class), 'CATALYST' );
334 for my $prefix (@prefixes) {
335 if ( defined( my $value = $ENV{"${prefix}_${key}"} ) ) {
345 Try to guess terminal width to use with formatting of debug output
347 All you need to get this work, is:
349 1) Install Term::Size::Any, or
351 2) Export $COLUMNS from your shell.
353 (Warning to bash users: 'echo $COLUMNS' may be showing you the bash
354 variable, not $ENV{COLUMNS}. 'export COLUMNS=$COLUMNS' and you should see
355 that 'env' now lists COLUMNS.)
357 As last resort, default value of 80 chars will be used.
364 return $_term_width if $_term_width;
368 my ($columns, $rows) = Term::Size::Any::chars;
373 $width = $ENV{COLUMNS}
374 if exists($ENV{COLUMNS})
375 && $ENV{COLUMNS} =~ m/^\d+$/;
378 $width = 80 unless ($width && $width >= 80);
379 return $_term_width = $width;
383 =head2 resolve_namespace
385 Method which adds the namespace for plugins and actions.
387 __PACKAGE__->setup(qw(MyPlugin));
389 # will load Catalyst::Plugin::MyPlugin
394 sub resolve_namespace {
395 my $appnamespace = shift;
396 my $namespace = shift;
398 return String::RewritePrefix->rewrite({
399 q[] => qq[${namespace}::],
401 (defined $appnamespace
402 ? (q[~] => qq[${appnamespace}::])
411 Catalyst Contributors, see Catalyst.pm
415 This library is free software. You can redistribute it and/or modify it under
416 the same terms as Perl itself.