Commit | Line | Data |
f05af9ba |
1 | package Catalyst::Utils; |
2 | |
3 | use strict; |
a2f2cde9 |
4 | use Catalyst::Exception; |
37a3ac5c |
5 | use File::Spec; |
d837e1a7 |
6 | use HTTP::Request; |
812a28c9 |
7 | use Path::Class; |
d837e1a7 |
8 | use URI; |
d9183506 |
9 | use Class::Inspector; |
f05af9ba |
10 | |
11 | =head1 NAME |
12 | |
13 | Catalyst::Utils - The Catalyst Utils |
14 | |
15 | =head1 SYNOPSIS |
16 | |
17 | See L<Catalyst>. |
18 | |
19 | =head1 DESCRIPTION |
20 | |
21 | =head1 METHODS |
22 | |
b5ecfcf0 |
23 | =head2 appprefix($class) |
41ca9ba7 |
24 | |
05850e06 |
25 | MyApp::Foo becomes myapp_foo |
41ca9ba7 |
26 | |
27 | =cut |
28 | |
29 | sub appprefix { |
30 | my $class = shift; |
31 | $class =~ s/\:\:/_/g; |
32 | $class = lc($class); |
33 | return $class; |
34 | } |
35 | |
b5ecfcf0 |
36 | =head2 class2appclass($class); |
84cf74e7 |
37 | |
2d90477f |
38 | MyApp::C::Foo::Bar becomes MyApp |
39 | My::App::C::Foo::Bar becomes My::App |
40 | |
84cf74e7 |
41 | =cut |
42 | |
43 | sub class2appclass { |
44 | my $class = shift || ''; |
45 | my $appname = ''; |
46 | if ( $class =~ /^(.*)::([MVC]|Model|View|Controller)?::.*$/ ) { |
47 | $appname = $1; |
48 | } |
49 | return $appname; |
50 | } |
51 | |
b5ecfcf0 |
52 | =head2 class2classprefix($class); |
2930d610 |
53 | |
2d90477f |
54 | MyApp::C::Foo::Bar becomes MyApp::C |
55 | My::App::C::Foo::Bar becomes My::App::C |
56 | |
2930d610 |
57 | =cut |
58 | |
59 | sub class2classprefix { |
60 | my $class = shift || ''; |
61 | my $prefix; |
62 | if ( $class =~ /^(.*::[MVC]|Model|View|Controller)?::.*$/ ) { |
63 | $prefix = $1; |
64 | } |
65 | return $prefix; |
66 | } |
67 | |
b5ecfcf0 |
68 | =head2 class2classsuffix($class); |
84cf74e7 |
69 | |
2d90477f |
70 | MyApp::C::Foo::Bar becomes C::Foo::Bar |
71 | |
84cf74e7 |
72 | =cut |
73 | |
74 | sub class2classsuffix { |
75 | my $class = shift || ''; |
76 | my $prefix = class2appclass($class) || ''; |
77 | $class =~ s/$prefix\:\://; |
78 | return $class; |
79 | } |
80 | |
b5ecfcf0 |
81 | =head2 class2env($class); |
3ad654e0 |
82 | |
26e73131 |
83 | Returns the environment name for class. |
3ad654e0 |
84 | |
85 | MyApp becomes MYAPP |
86 | My::App becomes MY_APP |
87 | |
88 | =cut |
89 | |
90 | sub class2env { |
91 | my $class = shift || ''; |
5d9a6d47 |
92 | $class =~ s/\:\:/_/g; |
3ad654e0 |
93 | return uc($class); |
94 | } |
95 | |
b5ecfcf0 |
96 | =head2 class2prefix( $class, $case ); |
f05af9ba |
97 | |
e2cc89a9 |
98 | Returns the uri prefix for a class. If case is false the prefix is converted to lowercase. |
f05af9ba |
99 | |
e2cc89a9 |
100 | My::App::C::Foo::Bar becomes foo/bar |
2d90477f |
101 | |
f05af9ba |
102 | =cut |
103 | |
104 | sub class2prefix { |
105 | my $class = shift || ''; |
e494bd6b |
106 | my $case = shift || 0; |
f05af9ba |
107 | my $prefix; |
108 | if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) { |
e494bd6b |
109 | $prefix = $case ? $2 : lc $2; |
f05af9ba |
110 | $prefix =~ s/\:\:/\//g; |
111 | } |
112 | return $prefix; |
113 | } |
114 | |
b5ecfcf0 |
115 | =head2 class2tempdir( $class [, $create ] ); |
37a3ac5c |
116 | |
e2cc89a9 |
117 | Returns a tempdir for a class. If create is true it will try to create the path. |
37a3ac5c |
118 | |
119 | My::App becomes /tmp/my/app |
120 | My::App::C::Foo::Bar becomes /tmp/my/app/c/foo/bar |
121 | |
122 | =cut |
123 | |
124 | sub class2tempdir { |
125 | my $class = shift || ''; |
126 | my $create = shift || 0; |
4be535b1 |
127 | my @parts = split '::', lc $class; |
37a3ac5c |
128 | |
129 | my $tmpdir = dir( File::Spec->tmpdir, @parts )->cleanup; |
130 | |
4be535b1 |
131 | if ( $create && !-e $tmpdir ) { |
37a3ac5c |
132 | |
133 | eval { $tmpdir->mkpath }; |
134 | |
4be535b1 |
135 | if ($@) { |
37a3ac5c |
136 | Catalyst::Exception->throw( |
4be535b1 |
137 | message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ ); |
37a3ac5c |
138 | } |
139 | } |
140 | |
141 | return $tmpdir->stringify; |
142 | } |
143 | |
b5ecfcf0 |
144 | =head2 home($class) |
812a28c9 |
145 | |
146 | Returns home directory for given class. |
147 | |
148 | =cut |
149 | |
150 | sub home { |
51f412bd |
151 | my $class = shift; |
152 | |
153 | # make an $INC{ $key } style string from the class name |
154 | (my $file = "$class.pm") =~ s{::}{/}g; |
155 | |
156 | if ( my $inc_entry = $INC{$file} ) { |
51452916 |
157 | { |
51f412bd |
158 | # look for an uninstalled Catalyst app |
159 | |
160 | # find the @INC entry in which $file was found |
161 | (my $path = $inc_entry) =~ s/$file$//; |
162 | my $home = dir($path)->absolute->cleanup; |
163 | |
164 | # pop off /lib and /blib if they're there |
165 | $home = $home->parent while $home =~ /b?lib$/; |
166 | |
167 | # only return the dir if it has a Makefile.PL or Build.PL |
168 | return $home->stringify |
169 | if $home->file("Makefile.PL") or -f $home->file("Build.PL"); |
51452916 |
170 | } |
4be535b1 |
171 | |
51f412bd |
172 | { |
173 | # look for an installed Catalyst app |
174 | |
175 | # trim the .pm off the thing ( Foo/Bar.pm -> Foo/Bar/ ) |
176 | ( my $path = $inc_entry) =~ s/\.pm$//; |
177 | my $home = dir($path)->absolute->cleanup; |
178 | |
179 | # return if if it's a valid directory |
180 | return $home->stringify if -d $home; |
62459712 |
181 | } |
812a28c9 |
182 | } |
51f412bd |
183 | |
184 | # we found nothing |
185 | return 0; |
812a28c9 |
186 | } |
187 | |
b5ecfcf0 |
188 | =head2 prefix($class, $name); |
812a28c9 |
189 | |
190 | Returns a prefixed action. |
191 | |
e2cc89a9 |
192 | MyApp::C::Foo::Bar, yada becomes foo/bar/yada |
812a28c9 |
193 | |
194 | =cut |
195 | |
196 | sub prefix { |
197 | my ( $class, $name ) = @_; |
198 | my $prefix = &class2prefix($class); |
199 | $name = "$prefix/$name" if $prefix; |
200 | return $name; |
201 | } |
202 | |
b5ecfcf0 |
203 | =head2 request($uri) |
4d60aa90 |
204 | |
e2cc89a9 |
205 | Returns an L<HTTP::Request> object for a uri. |
4d60aa90 |
206 | |
207 | =cut |
208 | |
209 | sub request { |
210 | my $request = shift; |
211 | unless ( ref $request ) { |
a88c7ec8 |
212 | if ( $request =~ m/^http/i ) { |
4d60aa90 |
213 | $request = URI->new($request)->canonical; |
214 | } |
215 | else { |
216 | $request = URI->new( 'http://localhost' . $request )->canonical; |
217 | } |
218 | } |
219 | unless ( ref $request eq 'HTTP::Request' ) { |
220 | $request = HTTP::Request->new( 'GET', $request ); |
221 | } |
4d60aa90 |
222 | return $request; |
223 | } |
224 | |
d9183506 |
225 | =head2 ensure_class_loaded($class_name) |
226 | |
227 | Loads the class unless it already has been loaded. |
228 | |
229 | =cut |
230 | |
231 | sub ensure_class_loaded { |
232 | my $class = shift; |
233 | |
234 | return if Class::Inspector->loaded( $class ); # if a symbol entry exists we don't load again |
235 | |
236 | # this hack is so we don't overwrite $@ if the load did not generate an error |
237 | my $error; |
238 | { |
239 | local $@; |
240 | eval "require $class"; |
241 | $error = $@; |
242 | } |
6bfff75e |
243 | |
d9183506 |
244 | die $error if $error; |
6bfff75e |
245 | die "require $class was successful but the package is not defined" |
246 | unless Class::Inspector->loaded($class); |
247 | |
248 | return 1; |
d9183506 |
249 | } |
250 | |
358e1592 |
251 | =head2 merge_hashes($hashref, $hashref) |
252 | |
253 | Base code to recursively merge two hashes together with right-hand precedence. |
254 | |
255 | =cut |
256 | |
257 | sub merge_hashes { |
258 | my ( $lefthash, $righthash ) = @_; |
259 | |
260 | return $lefthash unless defined $righthash; |
261 | |
262 | my %merged = %$lefthash; |
263 | for my $key ( keys %$righthash ) {\r |
264 | my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH';\r |
265 | my $left_ref = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH';\r |
266 | if( $right_ref and $left_ref ) {\r |
267 | $merged{ $key } = merge_hashes( |
268 | $lefthash->{ $key }, $righthash->{ $key } |
269 | );\r |
270 | } |
271 | else { |
272 | $merged{ $key } = $righthash->{ $key }; |
273 | }\r |
274 | } |
275 | |
276 | return \%merged; |
277 | } |
278 | |
d9183506 |
279 | |
f05af9ba |
280 | =head1 AUTHOR |
281 | |
282 | Sebastian Riedel, C<sri@cpan.org> |
d9183506 |
283 | Yuval Kogman, C<nothingmuch@woobling.org> |
f05af9ba |
284 | |
285 | =head1 COPYRIGHT |
286 | |
287 | This program is free software, you can redistribute it and/or modify it under |
288 | the same terms as Perl itself. |
289 | |
290 | =cut |
291 | |
292 | 1; |