1 package SL::Controller::Base;
5 use parent qw(Rose::Object);
9 use List::Util qw(first);
10 use SL::Request qw(flatten);
11 use SL::MoreCommon qw(uri_encode);
14 # public/helper functions
20 return $_[0] if (scalar(@_) == 1) && !ref($_[0]);
22 my %params = ref($_[0]) eq 'HASH' ? %{ $_[0] } : @_;
23 my $controller = delete($params{controller}) || $self->_controller_name;
24 my $action = $params{action} || 'dispatch';
27 if ($controller =~ m/\.pl$/) {
28 # Old-style controller
29 $script = $controller;
31 $params{action} = "${controller}/${action}";
32 $script = "controller.pl";
35 my $query = join '&', map { uri_encode($_->[0]) . '=' . uri_encode($_->[1]) } @{ flatten(\%params) };
37 return "${script}?${query}";
42 my $url = $self->url_for(@_);
44 if ($self->delay_flash_on_redirect) {
45 require SL::Helper::Flash;
46 SL::Helper::Flash::delay_flash();
49 print $::request->{cgi}->redirect($url);
55 my ($options, %locals) = (@_ && ref($_[0])) ? @_ : ({ }, @_);
57 $options->{type} = lc($options->{type} || 'html');
58 $options->{no_layout} = 1 if $options->{type} eq 'js';
61 if ($options->{inline}) {
64 } elsif($options->{raw}) {
68 $source = "templates/webpages/${template}." . $options->{type};
69 croak "Template file ${source} not found" unless -f $source;
72 if (!$options->{partial} && !$options->{inline} && !$::form->{header}) {
73 if ($options->{no_layout}) {
74 $::form->{header} = 1;
75 my $content_type = $options->{type} eq 'js' ? 'text/javascript' : 'text/html';
77 print $::form->create_http_response(content_type => $content_type,
78 charset => $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET());
81 $::form->{title} = $locals{title} if $locals{title};
86 my %params = ( %locals,
88 FLASH => $::form->{FLASH},
90 INSTANCE_CONF => $::instance_conf,
92 LXCONFIG => \%::lx_office_conf,
93 LXDEBUG => $::lxdebug,
94 MYCONFIG => \%::myconfig,
99 if (!$options->{raw}) {
100 my $parser = $self->_template_obj;
101 $parser->process($source, \%params, \$output) || croak $parser->error;
106 print $output unless $options->{inline} || $options->{no_output};
112 my ($self, $file_name, %params) = @_;
114 my $file = IO::File->new($file_name, 'r') || croak("Cannot open file '${file_name}'");
115 my $content_type = $params{type} || 'application/octet_stream';
116 my $attachment_name = $params{name} || $file_name;
117 $attachment_name =~ s:.*//::g;
119 print $::form->create_http_response(content_type => $content_type,
120 content_disposition => 'attachment; filename="' . $attachment_name . '"',
121 content_length => -s $file);
123 $::locale->with_raw_io(\*STDOUT, sub { print while <$file> });
128 # Before/after run hooks
132 _add_hook('before', @_);
136 _add_hook('after', @_);
142 my ($when, $class, $sub, %params) = @_;
144 foreach my $key (qw(only except)) {
145 $params{$key} = { map { ( $_ => 1 ) } @{ $params{$key} } } if $params{$key};
148 my $idx = "${when}/${class}";
149 $hooks{$idx} ||= [ ];
150 push @{ $hooks{$idx} }, { %params, code => $sub };
154 my ($self, $when, $action) = @_;
156 my $idx = "${when}/" . ref($self);
158 foreach my $hook (@{ $hooks{$idx} || [] }) {
159 next if ($hook->{only } && !$hook->{only }->{$action})
160 || ($hook->{except} && $hook->{except}->{$action});
162 if (ref($hook->{code}) eq 'CODE') {
163 $hook->{code}->($self);
165 my $sub = $hook->{code};
172 # behaviour. override these
175 sub delay_flash_on_redirect {
180 # Ignore the 'action' parameter.
184 sub keep_auth_vars_in_form {
189 # private functions -- for use in Base only
195 my $sub = "action_${action}";
197 return $self->_dispatch(@_) if $action eq 'dispatch';
199 $::form->error("Invalid action '${action}' for controller " . ref($self)) if !$self->can($sub);
201 $self->_run_hooks('before', $action);
203 $self->_run_hooks('after', $action);
206 sub _controller_name {
207 return (split(/::/, ref($_[0])))[-1];
214 my @actions = map { s/^action_//; $_ } grep { m/^action_/ } keys %{ ref($self) . "::" };
215 my $action = first { $::form->{"action_${_}"} } @actions;
216 my $sub = "action_${action}";
218 if ($self->can($sub)) {
219 $self->_run_hooks('before', $action);
221 $self->_run_hooks('after', $action);
223 $::form->error($::locale->text('Oops. No valid action found to dispatch. Please report this case to the Lx-Office team.'));
230 $self->{__basepriv_template_obj} ||=
231 Template->new({ INTERPOLATE => 0,
235 PLUGIN_BASE => 'SL::Template::Plugin',
236 INCLUDE_PATH => '.:templates/webpages',
237 COMPILE_EXT => '.tcc',
238 COMPILE_DIR => $::lx_office_conf{paths}->{userspath} . '/templates-cache',
241 return $self->{__basepriv_template_obj};
250 SL::Controller::Base - base class for all action controllers
256 This is a base class for all action controllers. Action controllers
257 provide subs that are callable by special URLs.
259 For each request made to the web server an instance of the controller
260 will be created. After the request has been served that instance will
261 handed over to garbage collection.
263 This base class is derived from L<Rose::Object>.
267 The URLs have the following properties:
273 The script part of the URL must be C<controller.pl>.
277 There must be a GET or POST parameter named C<action> containing the
278 name of the controller and the sub to call separated by C</>,
279 e.g. C<Message/list>.
283 The controller name is the package's name without the
284 C<SL::Controller::> prefix. At the moment only packages in the
285 C<SL::Controller> namespace are valid; sub-namespaces are not
286 allowed. The package name must start with an upper-case letter.
290 The sub part of the C<action> parameter is the name of the sub to
291 call. However, the sub's name is automatically prefixed with
292 C<action_>. Therefore for the example C<Message/list> the sub
293 C<SL::DB::Message::action_list> would be called. This in turn means
294 that subs whose name does not start with C<action_> cannot be invoked
295 directly via the URL.
299 =head2 INDIRECT DISPATCHING
301 In the case that there are several submit buttons on a page it is
302 often impractical to have a single C<action> parameter match up
303 properly. For such a case a special dispatcher method is available. In
304 that case the C<action> parameter of the URL must be
305 C<Controller/dispatch>.
307 The C<SL::Controller::Base::_dispatch> method will iterate over all
308 subs in the controller package whose names start with C<action_>. The
309 first one for which there's a GET or POST parameter with the same name
310 and that's trueish is called.
312 Usage from a template usually looks like this:
314 <form method="POST" action="controller.pl">
316 <input type="hidden" name="action" value="Message/dispatch">
317 <input type="submit" name="action_mark_as_read" value="Mark messages as read">
318 <input type="submit" name="action_delete" value="Delete messages">
321 The dispatching is handled by the function L</_dispatch>.
325 Hooks are functions that are called before or after the controller's
326 action is called. The controller package defines the hooks, and those
327 hooks themselves are run as instance methods.
329 Hooks are run in the order they're added.
331 The return value of the hooks is discarded.
333 Hooks can be defined to run for all actions, for only specific actions
334 or for all actions except a list of actions. Each entry is the action
335 name, not the sub's name. Therefore in order to run a hook before one
336 of the subs C<action_edit> or C<action_save> is called the following
339 __PACKAGE__->run_before('things_to_do_before_edit_and_save', only => [ 'edit', 'save' ]);
343 =head2 PUBLIC HELPER FUNCTIONS
345 These functions are supposed to be called by sub-classed controllers.
349 =item C<render $template, [ $options, ] %locals>
351 Renders the template C<$template>. Provides other variables than
352 C<Form::parse_html_template> does.
354 C<$options>, if present, must be a hash reference. All remaining
355 parameters are slurped into C<%locals>.
357 What is rendered and how C<$template> is interpreted is determined by
358 the options I<type>, I<inline>, I<partial> and I<no_layout>.
360 If C<< $options->{inline} >> is trueish then C<$template> is a string
361 containing the template code to interprete. Additionally the output
362 will not be sent to the browser. Instead it is only returned to the
365 If C<< $options->{raw} >> is trueish, the function will treat the input as
366 already parsed, and will not filter the input through Template. Unlike
367 C<inline>, the input is taked as a reference.
369 If C<< $options->{inline} >> is falsish then C<$template> is
370 interpreted as the name of a template file. It is prefixed with
371 "templates/webpages/" and postfixed with a file extension based on
372 C<< $options->{type} >>. C<< $options->{type} >> can be either C<html>
373 or C<js> and defaults to C<html>. An exception will be thrown if that
376 If C<< $options->{partial} >> or C<< $options->{inline} >> is trueish
377 then neither the HTTP response header nor the standard HTML header is
380 Otherwise at least the HTTP response header will be generated based on
381 the template type (C<< $options->{type} >>).
383 If the template type is C<html> then the standard HTML header will be
384 output via C<< $::form->header >> with C<< $::form->{title} >> set to
385 C<$locals{title}> (the latter only if C<$locals{title}> is
386 trueish). Setting C<< $options->{no_layout} >> to trueish will prevent
389 The template itself has access to the following variables:
393 =item * C<AUTH> -- C<$::auth>
395 =item * C<FORM> -- C<$::form>
397 =item * C<LOCALE> -- C<$::locale>
399 =item * C<LXCONFIG> -- all parameters from C<config/lx_office.conf>
400 with the same name they appear in the file (first level is the
401 section, second the actual variable, e.g. C<system.dbcharset>,
402 C<features.webdav> etc)
404 =item * C<LXDEBUG> -- C<$::lxdebug>
406 =item * C<MYCONFIG> -- C<%::myconfig>
408 =item * C<SELF> -- the controller instance
410 =item * All items from C<%locals>
414 Unless C<< $options->{inline} >> is trueish the function will send the
415 output to the browser.
417 The function will always return the output.
419 Example: Render a HTML template with a certain title and a few locals
421 $self->render('todo/list',
422 title => 'List TODO items',
423 TODO_ITEMS => SL::DB::Manager::Todo->get_all_sorted);
425 Example: Render a string and return its content for further processing
426 by the calling function. No header is generated due to C<inline>.
428 my $content = $self->render('[% USE JavaScript %][% JavaScript.replace_with("#someid", "js/something") %]',
429 { type => 'js', inline => 1 });
431 Example: Render a JavaScript template and send it to the
432 browser. Typical use for actions called via AJAX:
434 $self->render('todo/single_item', { type => 'js' },
435 item => $employee->most_important_todo_item);
437 =item C<send_file $file_name, [%params]>
439 Sends the file C<$file_name> to the browser including appropriate HTTP
440 headers for a download. C<%params> can include the following:
444 =item * C<type> -- the file's content type; defaults to
445 'application/octet_stream'
447 =item * C<name> -- the name presented to the browser; defaults to
452 =item C<url_for $url>
454 =item C<url_for $params>
456 =item C<url_for %params>
458 Creates an URL for the given parameters suitable for calling an action
459 controller. If there's only one scalar parameter then it is returned
462 Otherwise the parameters are given either as a single hash ref
463 parameter or as a normal hash.
465 The controller to call is given by C<$params{controller}>. It defaults
466 to the current controller as returned by
467 L</_controller_name>.
469 The action to call is given by C<$params{action}>. It defaults to
472 All other key/value pairs in C<%params> are appended as GET parameters
475 Usage from a template might look like this:
477 <a href="[% SELF.url_for(controller => 'Message', action => 'new', recipient_id => 42) %]">create new message</a>
479 =item C<redirect_to %url_params>
481 Redirects the browser to a new URL by outputting a HTTP redirect
482 header. The URL is generated by calling L</url_for> with
485 =item C<run_before $sub, %params>
487 =item C<run_after $sub, %params>
489 Adds a hook to run before or after certain actions are run for the
490 current package. The code to run is C<$sub> which is either the name
491 of an instance method or a code reference. If it's the latter then the
492 first parameter will be C<$self>.
494 C<%params> can contain two possible values that restrict the code to
495 be run only for certain actions:
499 =item C<< only => \@list >>
501 Only run the code for actions given in C<@list>. The entries are the
502 action names, not the names of the sub (so it's C<list> instead of
505 =item C<< except => \@list >>
507 Run the code for all actions but for those given in C<@list>. The
508 entries are the action names, not the names of the sub (so it's
509 C<list> instead of C<action_list>).
513 If neither restriction is used then the code will be run for any
516 The hook's return values are discarded.
518 =item C<delay_flash_on_redirect>
520 May be overridden by a controller. If this method returns true, redirect_to
521 will delay all flash messages for the current request. Defaults to false for
522 compatibility reasons.
524 =item C<get_auth_level $action>
526 May be overridden by a controller. Determines what kind of
527 authentication is required for a particular action. Must return either
528 C<admin> (which means that authentication as an admin is required),
529 C<user> (authentication as a normal user suffices) with a possible
530 future value C<none> (which would require no authentication but is not
533 =item C<keep_auth_vars_in_form>
535 May be overridden by a controller. If falsish (the default) all form
536 variables whose name starts with C<{AUTH}> are removed before the
537 request is routed. Only controllers that handle login requests
538 themselves should return trueish for this function.
542 =head2 PRIVATE FUNCTIONS
544 These functions are supposed to be used from this base class only.
548 =item C<_controller_name>
550 Returns the name of the curernt controller package without the
551 C<SL::Controller::> prefix.
555 Implements the method lookup for indirect dispatching mentioned in the
556 section L</INDIRECT DISPATCHING>.
558 =item C<_run_action $action>
560 Executes a sub based on the value of C<$action>. C<$action> is the sub
561 name part of the C<action> GET or POST parameter as described in
564 If C<$action> equals C<dispatch> then the sub L</_dispatch> in this
565 base class is called for L</INDIRECT DISPATCHING>. Otherwise
566 C<$action> is prefixed with C<action_>, and that sub is called on the
567 current controller instance.
573 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>