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