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 { |
151 | my $name = shift; |
152 | $name =~ s/\:\:/\//g; |
153 | my $home = 0; |
154 | if ( my $path = $INC{"$name.pm"} ) { |
155 | $home = file($path)->absolute->dir; |
156 | $name =~ /(\w+)$/; |
157 | my $append = $1; |
158 | my $subdir = dir($home)->subdir($append); |
159 | for ( split '/', $name ) { $home = dir($home)->parent } |
160 | if ( $home =~ /blib$/ ) { $home = dir($home)->parent } |
51452916 |
161 | elsif (!-f file( $home, 'Makefile.PL' ) |
162 | && !-f file( $home, 'Build.PL' ) ) |
163 | { |
164 | $home = $subdir; |
165 | } |
4be535b1 |
166 | |
62459712 |
167 | # clean up relative path: |
168 | # MyApp/script/.. -> MyApp |
169 | my ($lastdir) = $home->dir_list( -1, 1 ); |
170 | if ( $lastdir eq '..' ) { |
171 | $home = dir($home)->parent->parent; |
172 | } |
812a28c9 |
173 | } |
174 | return $home; |
175 | } |
176 | |
b5ecfcf0 |
177 | =head2 prefix($class, $name); |
812a28c9 |
178 | |
179 | Returns a prefixed action. |
180 | |
e2cc89a9 |
181 | MyApp::C::Foo::Bar, yada becomes foo/bar/yada |
812a28c9 |
182 | |
183 | =cut |
184 | |
185 | sub prefix { |
186 | my ( $class, $name ) = @_; |
187 | my $prefix = &class2prefix($class); |
188 | $name = "$prefix/$name" if $prefix; |
189 | return $name; |
190 | } |
191 | |
b5ecfcf0 |
192 | =head2 request($uri) |
4d60aa90 |
193 | |
e2cc89a9 |
194 | Returns an L<HTTP::Request> object for a uri. |
4d60aa90 |
195 | |
196 | =cut |
197 | |
198 | sub request { |
199 | my $request = shift; |
200 | unless ( ref $request ) { |
a88c7ec8 |
201 | if ( $request =~ m/^http/i ) { |
4d60aa90 |
202 | $request = URI->new($request)->canonical; |
203 | } |
204 | else { |
205 | $request = URI->new( 'http://localhost' . $request )->canonical; |
206 | } |
207 | } |
208 | unless ( ref $request eq 'HTTP::Request' ) { |
209 | $request = HTTP::Request->new( 'GET', $request ); |
210 | } |
4d60aa90 |
211 | return $request; |
212 | } |
213 | |
d9183506 |
214 | =head2 ensure_class_loaded($class_name) |
215 | |
216 | Loads the class unless it already has been loaded. |
217 | |
218 | =cut |
219 | |
220 | sub ensure_class_loaded { |
221 | my $class = shift; |
222 | |
223 | return if Class::Inspector->loaded( $class ); # if a symbol entry exists we don't load again |
224 | |
225 | # this hack is so we don't overwrite $@ if the load did not generate an error |
226 | my $error; |
227 | { |
228 | local $@; |
229 | eval "require $class"; |
230 | $error = $@; |
231 | } |
6bfff75e |
232 | |
d9183506 |
233 | die $error if $error; |
6bfff75e |
234 | die "require $class was successful but the package is not defined" |
235 | unless Class::Inspector->loaded($class); |
236 | |
237 | return 1; |
d9183506 |
238 | } |
239 | |
240 | |
f05af9ba |
241 | =head1 AUTHOR |
242 | |
243 | Sebastian Riedel, C<sri@cpan.org> |
d9183506 |
244 | Yuval Kogman, C<nothingmuch@woobling.org> |
f05af9ba |
245 | |
246 | =head1 COPYRIGHT |
247 | |
248 | This program is free software, you can redistribute it and/or modify it under |
249 | the same terms as Perl itself. |
250 | |
251 | =cut |
252 | |
253 | 1; |