Commit | Line | Data |
fc7ec1d9 |
1 | package Catalyst; |
2 | |
3 | use strict; |
ac733264 |
4 | use base 'Catalyst::Base'; |
fc7ec1d9 |
5 | use UNIVERSAL::require; |
6 | use Catalyst::Log; |
42a57832 |
7 | use Catalyst::Helper; |
0f7ecc53 |
8 | use Text::ASCIITable; |
fc7ec1d9 |
9 | |
424b2705 |
10 | __PACKAGE__->mk_classdata($_) for qw/dispatcher engine log/; |
fc7ec1d9 |
11 | |
d7953572 |
12 | our $VERSION = '5.01'; |
fc7ec1d9 |
13 | our @ISA; |
14 | |
15 | =head1 NAME |
16 | |
17 | Catalyst - The Elegant MVC Web Application Framework |
18 | |
19 | =head1 SYNOPSIS |
20 | |
21 | # use the helper to start a new application |
91864987 |
22 | catalyst.pl MyApp |
fc7ec1d9 |
23 | cd MyApp |
24 | |
25 | # add models, views, controllers |
d01df17d |
26 | script/create.pl model Something |
27 | script/create.pl view Stuff |
28 | script/create.pl controller Yada |
fc7ec1d9 |
29 | |
30 | # built in testserver |
d01df17d |
31 | script/server.pl |
fc7ec1d9 |
32 | |
33 | # command line interface |
d01df17d |
34 | script/test.pl /yada |
fc7ec1d9 |
35 | |
36 | |
fc7ec1d9 |
37 | use Catalyst; |
38 | |
39 | use Catalyst qw/My::Module My::OtherModule/; |
40 | |
41 | use Catalyst '-Debug'; |
42 | |
43 | use Catalyst qw/-Debug -Engine=CGI/; |
44 | |
5a8ed4fe |
45 | sub default : Private { $_[1]->res->output('Hello') } ); |
46 | |
e3dc9d78 |
47 | sub index : Path('/index.html') { |
5a8ed4fe |
48 | my ( $self, $c ) = @_; |
49 | $c->res->output('Hello'); |
064834ea |
50 | $c->forward('foo'); |
5a8ed4fe |
51 | } |
52 | |
064834ea |
53 | sub product : Regex('^product[_]*(\d*).html$') { |
5a8ed4fe |
54 | my ( $self, $c ) = @_; |
55 | $c->stash->{template} = 'product.tt'; |
56 | $c->stash->{product} = $c->req->snippets->[0]; |
57 | } |
fc7ec1d9 |
58 | |
3803e98f |
59 | See also L<Catalyst::Manual::Intro> |
60 | |
fc7ec1d9 |
61 | =head1 DESCRIPTION |
62 | |
63 | Catalyst is based upon L<Maypole>, which you should consider for smaller |
64 | projects. |
65 | |
66 | The key concept of Catalyst is DRY (Don't Repeat Yourself). |
67 | |
68 | See L<Catalyst::Manual> for more documentation. |
69 | |
23f9d934 |
70 | Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement. |
1985c30b |
71 | Omit the C<Catalyst::Plugin::> prefix from the plugin name, |
23f9d934 |
72 | so C<Catalyst::Plugin::My::Module> becomes C<My::Module>. |
fc7ec1d9 |
73 | |
74 | use Catalyst 'My::Module'; |
75 | |
23f9d934 |
76 | Special flags like -Debug and -Engine can also be specifed as arguments when |
77 | Catalyst is loaded: |
fc7ec1d9 |
78 | |
79 | use Catalyst qw/-Debug My::Module/; |
80 | |
23f9d934 |
81 | The position of plugins and flags in the chain is important, because they are |
82 | loaded in exactly the order that they appear. |
fc7ec1d9 |
83 | |
23f9d934 |
84 | The following flags are supported: |
85 | |
86 | =over 4 |
87 | |
88 | =item -Debug |
89 | |
90 | enables debug output, i.e.: |
fc7ec1d9 |
91 | |
92 | use Catalyst '-Debug'; |
93 | |
23f9d934 |
94 | this is equivalent to: |
fc7ec1d9 |
95 | |
96 | use Catalyst; |
97 | sub debug { 1 } |
98 | |
23f9d934 |
99 | =item -Engine |
fc7ec1d9 |
100 | |
101 | Force Catalyst to use a specific engine. |
23f9d934 |
102 | Omit the C<Catalyst::Engine::> prefix of the engine name, i.e.: |
fc7ec1d9 |
103 | |
104 | use Catalyst '-Engine=CGI'; |
105 | |
23f9d934 |
106 | =back |
fc7ec1d9 |
107 | |
23f9d934 |
108 | =head1 METHODS |
109 | |
110 | =over 4 |
111 | |
112 | =item debug |
fc7ec1d9 |
113 | |
114 | Overload to enable debug messages. |
115 | |
116 | =cut |
117 | |
118 | sub debug { 0 } |
119 | |
23f9d934 |
120 | =item config |
fc7ec1d9 |
121 | |
122 | Returns a hashref containing your applications settings. |
123 | |
124 | =cut |
125 | |
fc7ec1d9 |
126 | sub import { |
127 | my ( $self, @options ) = @_; |
128 | my $caller = caller(0); |
129 | |
99fe1710 |
130 | # Prepare inheritance |
22402712 |
131 | unless ( $caller->isa($self) ) { |
fc7ec1d9 |
132 | no strict 'refs'; |
22402712 |
133 | push @{"$caller\::ISA"}, $self; |
1c99e125 |
134 | } |
135 | |
d96e14c2 |
136 | if ( $caller->engine ) { |
42a57832 |
137 | return; # Catalyst is already initialized |
d96e14c2 |
138 | } |
139 | |
32620e3e |
140 | unless ( $caller->log ) { |
141 | $caller->log( Catalyst::Log->new ); |
fc7ec1d9 |
142 | } |
fc7ec1d9 |
143 | |
99fe1710 |
144 | # Debug? |
1985c30b |
145 | if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) { |
146 | no strict 'refs'; |
147 | *{"$caller\::debug"} = sub { 1 }; |
148 | $caller->log->debug('Debug messages enabled'); |
149 | } |
150 | |
424b2705 |
151 | my $engine = 'Catalyst::Engine::CGI'; |
152 | my $dispatcher = 'Catalyst::Dispatcher'; |
6dc87a0f |
153 | |
99fe1710 |
154 | # Detect mod_perl |
6dc87a0f |
155 | if ( $ENV{MOD_PERL} ) { |
156 | |
157 | require mod_perl; |
158 | |
ceb7ed54 |
159 | if ( $ENV{MOD_PERL_API_VERSION} == 2 ) { |
300aea89 |
160 | $engine = 'Catalyst::Engine::Apache::MP20'; |
161 | } |
162 | elsif ( $mod_perl::VERSION >= 1.99 ) { |
111728e3 |
163 | $engine = 'Catalyst::Engine::Apache::MP19'; |
6dc87a0f |
164 | } |
165 | else { |
111728e3 |
166 | $engine = 'Catalyst::Engine::Apache::MP13'; |
6dc87a0f |
167 | } |
168 | } |
1985c30b |
169 | |
300aea89 |
170 | $caller->log->info( "You are running an old helper script! " |
171 | . "Please update your scripts by regenerating the " |
172 | . "application and copying over the new scripts." ) |
173 | if ( $ENV{CATALYST_SCRIPT_GEN} |
174 | && ( |
175 | $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Helper::CATALYST_SCRIPT_GEN ) |
176 | ); |
177 | |
99fe1710 |
178 | # Process options |
937fcdd8 |
179 | my @plugins; |
fc7ec1d9 |
180 | foreach (@options) { |
99fe1710 |
181 | |
fc7ec1d9 |
182 | if (/^\-Debug$/) { |
1985c30b |
183 | next if $caller->debug; |
fc7ec1d9 |
184 | no strict 'refs'; |
1c99e125 |
185 | *{"$caller\::debug"} = sub { 1 }; |
fc7ec1d9 |
186 | $caller->log->debug('Debug messages enabled'); |
187 | } |
99fe1710 |
188 | |
424b2705 |
189 | elsif (/^-Dispatcher=(.*)$/) { |
190 | $dispatcher = "Catalyst::Dispatcher::$1"; |
191 | } |
99fe1710 |
192 | |
fc7ec1d9 |
193 | elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" } |
194 | elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) } |
99fe1710 |
195 | |
fc7ec1d9 |
196 | else { |
197 | my $plugin = "Catalyst::Plugin::$_"; |
198 | |
c4695f3a |
199 | $plugin->require; |
91dc9907 |
200 | |
f88238ea |
201 | if ($@) { die qq/Couldn't load plugin "$plugin", "$@"/ } |
fc7ec1d9 |
202 | else { |
f5f84847 |
203 | push @plugins, $plugin; |
502619e5 |
204 | no strict 'refs'; |
205 | push @{"$caller\::ISA"}, $plugin; |
fc7ec1d9 |
206 | } |
207 | } |
99fe1710 |
208 | |
fc7ec1d9 |
209 | } |
99fe1710 |
210 | |
211 | # Plugin table |
d2d570d4 |
212 | my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } ); |
0f7ecc53 |
213 | $t->setCols('Class'); |
0822f9a4 |
214 | $t->setColWidth( 'Class', 75, 1 ); |
cd677e12 |
215 | $t->addRow($_) for @plugins; |
0f7ecc53 |
216 | $caller->log->debug( 'Loaded plugins', $t->draw ) |
937fcdd8 |
217 | if ( @plugins && $caller->debug ); |
fc7ec1d9 |
218 | |
219 | # Engine |
220 | $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}" |
221 | if $ENV{CATALYST_ENGINE}; |
d96e14c2 |
222 | |
fc7ec1d9 |
223 | $engine->require; |
224 | die qq/Couldn't load engine "$engine", "$@"/ if $@; |
502619e5 |
225 | { |
226 | no strict 'refs'; |
970cc51d |
227 | push @{"$caller\::ISA"}, $engine; |
502619e5 |
228 | } |
70cb38f0 |
229 | $caller->engine($engine); |
fc7ec1d9 |
230 | $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug; |
424b2705 |
231 | |
232 | # Dispatcher |
233 | $dispatcher = "Catalyst::Dispatcher::$ENV{CATALYST_DISPATCHER}" |
234 | if $ENV{CATALYST_DISPATCHER}; |
235 | |
236 | $dispatcher->require; |
237 | die qq/Couldn't load dispatcher "$dispatcher", "$@"/ if $@; |
238 | { |
239 | no strict 'refs'; |
240 | push @{"$caller\::ISA"}, $dispatcher; |
241 | } |
242 | $caller->dispatcher($dispatcher); |
243 | $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/) if $caller->debug; |
244 | |
fc7ec1d9 |
245 | } |
246 | |
70cb38f0 |
247 | =item $c->engine |
248 | |
249 | Contains the engine class. |
250 | |
145074c2 |
251 | =item $c->log |
252 | |
253 | Contains the logging object. Unless it is already set Catalyst sets this up with a |
254 | C<Catalyst::Log> object. To use your own log class: |
255 | |
256 | $c->log( MyLogger->new ); |
257 | $c->log->info("now logging with my own logger!"); |
258 | |
259 | Your log class should implement the methods described in the C<Catalyst::Log> |
260 | man page. |
261 | |
262 | |
23f9d934 |
263 | =back |
264 | |
d1a31ac6 |
265 | =head1 LIMITATIONS |
266 | |
267 | FCGI and mod_perl2 support are considered experimental and may contain bugs. |
268 | |
269 | You may encounter problems accessing the built in test server on public ip |
270 | addresses on the internet, thats because of a bug in HTTP::Daemon. |
271 | |
3cb1db8c |
272 | =head1 SUPPORT |
273 | |
274 | IRC: |
275 | |
276 | Join #catalyst on irc.perl.org. |
277 | |
278 | Mailing-Lists: |
279 | |
280 | http://lists.rawmode.org/mailman/listinfo/catalyst |
281 | http://lists.rawmode.org/mailman/listinfo/catalyst-dev |
1985c30b |
282 | |
432d507d |
283 | Web: |
284 | |
285 | http://catalyst.perl.org |
286 | |
fc7ec1d9 |
287 | =head1 SEE ALSO |
288 | |
61b1e958 |
289 | =over 4 |
290 | |
291 | =item L<Catalyst::Manual> - The Catalyst Manual |
292 | |
293 | =item L<Catalyst::Engine> - Core Engine |
294 | |
295 | =item L<Catalyst::Log> - The Log Class. |
296 | |
297 | =item L<Catalyst::Request> - The Request Object |
298 | |
299 | =item L<Catalyst::Response> - The Response Object |
300 | |
301 | =item L<Catalyst::Test> - The test suite. |
302 | |
303 | =back |
fc7ec1d9 |
304 | |
305 | =head1 AUTHOR |
306 | |
307 | Sebastian Riedel, C<sri@oook.de> |
308 | |
309 | =head1 THANK YOU |
310 | |
ce2b098c |
311 | Andy Grundman, Andrew Ford, Andrew Ruthven, Christian Hansen, |
312 | Christopher Hicks, Dan Sully, Danijel Milicevic, David Naughton, |
313 | Gary Ashton Jones, Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, |
314 | Tatsuhiko Miyagawa and all the others who've helped. |
fc7ec1d9 |
315 | |
316 | =head1 LICENSE |
317 | |
318 | This library is free software . You can redistribute it and/or modify it under |
319 | the same terms as perl itself. |
320 | |
321 | =cut |
322 | |
323 | 1; |