1 package Catalyst::Utils;
4 use Catalyst::Exception;
14 Catalyst::Utils - The Catalyst Utils
24 =head2 appprefix($class)
26 MyApp::Foo becomes myapp_foo
37 =head2 class2appclass($class);
39 MyApp::Controller::Foo::Bar becomes MyApp
40 My::App::Controller::Foo::Bar becomes My::App
45 my $class = shift || '';
47 if ( $class =~ /^(.+?)::([MVC]|Model|View|Controller)::.+$/ ) {
53 =head2 class2classprefix($class);
55 MyApp::Controller::Foo::Bar becomes MyApp::Controller
56 My::App::Controller::Foo::Bar becomes My::App::Controller
60 sub class2classprefix {
61 my $class = shift || '';
63 if ( $class =~ /^(.+?::([MVC]|Model|View|Controller))::.+$/ ) {
69 =head2 class2classsuffix($class);
71 MyApp::Controller::Foo::Bar becomes Controller::Foo::Bar
75 sub class2classsuffix {
76 my $class = shift || '';
77 my $prefix = class2appclass($class) || '';
78 $class =~ s/$prefix\:://;
82 =head2 class2env($class);
84 Returns the environment name for class.
87 My::App becomes MY_APP
92 my $class = shift || '';
97 =head2 class2prefix( $class, $case );
99 Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
101 My::App::Controller::Foo::Bar becomes foo/bar
106 my $class = shift || '';
107 my $case = shift || 0;
109 if ( $class =~ /^.+?::([MVC]|Model|View|Controller)::(.+)$/ ) {
110 $prefix = $case ? $2 : lc $2;
111 $prefix =~ s{::}{/}g;
116 =head2 class2tempdir( $class [, $create ] );
118 Returns a tempdir for a class. If create is true it will try to create the path.
120 My::App becomes /tmp/my/app
121 My::App::C::Foo::Bar becomes /tmp/my/app/c/foo/bar
126 my $class = shift || '';
127 my $create = shift || 0;
128 my @parts = split '::', lc $class;
130 my $tmpdir = dir( File::Spec->tmpdir, @parts )->cleanup;
132 if ( $create && !-e $tmpdir ) {
134 eval { $tmpdir->mkpath };
137 Catalyst::Exception->throw(
138 message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ );
142 return $tmpdir->stringify;
147 Returns home directory for given class.
154 # make an $INC{ $key } style string from the class name
155 (my $file = "$class.pm") =~ s{::}{/}g;
157 if ( my $inc_entry = $INC{$file} ) {
159 # look for an uninstalled Catalyst app
161 # find the @INC entry in which $file was found
162 (my $path = $inc_entry) =~ s/$file$//;
163 my $home = dir($path)->absolute->cleanup;
165 # pop off /lib and /blib if they're there
166 $home = $home->parent while $home =~ /b?lib$/;
168 # only return the dir if it has a Makefile.PL or Build.PL
169 if (-f $home->file("Makefile.PL") or -f $home->file("Build.PL")) {
171 # clean up relative path:
172 # MyApp/script/.. -> MyApp
174 my ($lastdir) = $home->dir_list( -1, 1 );
175 if ( $lastdir eq '..' ) {
176 $home = dir($home)->parent->parent;
179 return $home->stringify;
184 # look for an installed Catalyst app
186 # trim the .pm off the thing ( Foo/Bar.pm -> Foo/Bar/ )
187 ( my $path = $inc_entry) =~ s/\.pm$//;
188 my $home = dir($path)->absolute->cleanup;
190 # return if if it's a valid directory
191 return $home->stringify if -d $home;
199 =head2 prefix($class, $name);
201 Returns a prefixed action.
203 MyApp::Controller::Foo::Bar, yada becomes foo/bar/yada
208 my ( $class, $name ) = @_;
209 my $prefix = &class2prefix($class);
210 $name = "$prefix/$name" if $prefix;
216 Returns an L<HTTP::Request> object for a uri.
222 unless ( ref $request ) {
223 if ( $request =~ m/^http/i ) {
224 $request = URI->new($request);
227 $request = URI->new( 'http://localhost' . $request );
230 unless ( ref $request eq 'HTTP::Request' ) {
231 $request = HTTP::Request->new( 'GET', $request );
236 =head2 ensure_class_loaded($class_name)
238 Loads the class unless it already has been loaded.
242 sub ensure_class_loaded {
246 croak "Malformed class Name $class"
247 if $class =~ m/(?:\b\:\b|\:{3,})/;
249 return if !$opts->{ ignore_loaded }
250 && Class::Inspector->loaded( $class ); # if a symbol entry exists we don't load again
252 # this hack is so we don't overwrite $@ if the load did not generate an error
256 eval "require $class";
260 die $error if $error;
261 die "require $class was successful but the package is not defined"
262 unless Class::Inspector->loaded($class);
267 =head2 merge_hashes($hashref, $hashref)
269 Base code to recursively merge two hashes together with right-hand precedence.
274 my ( $lefthash, $righthash ) = @_;
276 return $lefthash unless defined $righthash;
278 my %merged = %$lefthash;
279 for my $key ( keys %$righthash ) {
280 my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH';
281 my $left_ref = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH';
282 if( $right_ref and $left_ref ) {
283 $merged{ $key } = merge_hashes(
284 $lefthash->{ $key }, $righthash->{ $key }
288 $merged{ $key } = $righthash->{ $key };
295 =head2 env_value($class, $key)
297 Checks for and returns an environment value. For instance, if $key is
298 'home', then this method will check for and return the first value it finds,
299 looking at $ENV{MYAPP_HOME} and $ENV{CATALYST_HOME}.
304 my ( $class, $key ) = @_;
307 my @prefixes = ( class2env($class), 'CATALYST' );
309 for my $prefix (@prefixes) {
310 if ( defined( my $value = $ENV{"${prefix}_${key}"} ) ) {
320 Sebastian Riedel, C<sri@cpan.org>
321 Yuval Kogman, C<nothingmuch@woobling.org>
325 This program is free software, you can redistribute it and/or modify it under
326 the same terms as Perl itself.