X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FBase.pm;h=fff11ca3a99b494a516f1c2ad35ce1091dae64e2;hb=89c9ff022d3f13e27ba6bda085df15707fcfb0eb;hp=2db21151ab170ee1d973a3fde948255925489520;hpb=703d517a2e7737e442984bc7bb5dae067c3c04ba;p=kivitendo-erp.git diff --git a/SL/Controller/Base.pm b/SL/Controller/Base.pm index 2db21151a..fff11ca3a 100644 --- a/SL/Controller/Base.pm +++ b/SL/Controller/Base.pm @@ -1,5 +1,7 @@ package SL::Controller::Base; +use strict; + use parent qw(Rose::Object); use Carp; @@ -35,32 +37,37 @@ sub render { my $template = shift; my ($options, %locals) = (@_ && ref($_[0])) ? @_ : ({ }, @_); + $options->{type} = lc($options->{type} || 'html'); + $options->{no_layout} = 1 if $options->{type} eq 'js'; + my $source; if ($options->{inline}) { $source = \$template; } else { - $source = "templates/webpages/${template}.html"; + $source = "templates/webpages/${template}." . $options->{type}; croak "Template file ${source} not found" unless -f $source; } - if (!$options->{partial} && !$options->{inline}) { - $::form->{title} = $locals{title} if $locals{title}; - $::form->header; + if (!$options->{partial} && !$options->{inline} && !$::form->{header}) { + if ($options->{no_layout}) { + $::form->{header} = 1; + my $content_type = $options->{type} eq 'js' ? 'text/javascript' : 'text/html'; + + print $::form->create_http_response(content_type => $content_type, + charset => $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET()); + + } else { + $::form->{title} = $locals{title} if $locals{title}; + $::form->header; + } } my %params = ( %locals, AUTH => $::auth, FORM => $::form, LOCALE => $::locale, - LXCONFIG => { dbcharset => $::dbcharset, - webdav => $::webdav, - lizenzen => $::lizenzen, - latex_templates => $::latex, - opendocument_templates => $::opendocument_templates, - vertreter => $::vertreter, - show_best_before => $::show_best_before, - }, + LXCONFIG => \%::lx_office_conf, LXDEBUG => $::lxdebug, MYCONFIG => \%::myconfig, SELF => $self, @@ -70,23 +77,71 @@ sub render { my $parser = $self->_template_obj; $parser->process($source, \%params, \$output) || croak $parser->error; - print $output unless $options->{inline}; + print $output unless $options->{inline} || $options->{no_output}; return $output; } +# +# Before/after run hooks +# + +sub run_before { + _add_hook('before', @_); +} + +sub run_after { + _add_hook('after', @_); +} + +my %hooks; + +sub _add_hook { + my ($when, $class, $sub, %params) = @_; + + foreach my $key (qw(only except)) { + $params{$key} = { map { ( $_ => 1 ) } @{ $params{$key} } } if $params{$key}; + } + + my $idx = "${when}/${class}"; + $hooks{$idx} ||= [ ]; + push @{ $hooks{$idx} }, { %params, code => $sub }; +} + +sub _run_hooks { + my ($self, $when, $action) = @_; + + my $idx = "${when}/" . ref($self); + + foreach my $hook (@{ $hooks{$idx} || [] }) { + next if ($hook->{only } && !$hook->{only }->{$action}) + || ($hook->{except} && $hook->{except}->{$action}); + + if (ref($hook->{code}) eq 'CODE') { + $hook->{code}->($self); + } else { + my $sub = $hook->{code}; + $self->$sub; + } + } +} + # # private functions -- for use in Base only # sub _run_action { my $self = shift; - my $action = "action_" . shift; + my $action = shift; + my $sub = "action_${action}"; - return $self->_dispatch(@_) if $action eq 'action_dispatch'; + return $self->_dispatch(@_) if $action eq 'dispatch'; - $::form->error("Invalid action ${action} for controller " . ref($self)) if !$self->can($action); - $self->$action(@_); + $::form->error("Invalid action '${action}' for controller " . ref($self)) if !$self->can($sub); + + $self->_run_hooks('before', $action); + $self->$sub(@_); + $self->_run_hooks('after', $action); } sub _controller_name { @@ -96,10 +151,14 @@ sub _controller_name { sub _dispatch { my $self = shift; - my @actions = grep { m/^action_/ } keys %{ ref($self) . "::" }; - my $action = first { $::form->{$_} } @actions; + no strict 'refs'; + my @actions = map { s/^action_//; $_ } grep { m/^action_/ } keys %{ ref($self) . "::" }; + my $action = first { $::form->{"action_${_}"} } @actions; + my $sub = "action_${action}"; - $self->$action(@_); + $self->_run_hooks('before', $action); + $self->$sub(@_); + $self->_run_hooks('after', $action); } sub _template_obj { @@ -113,7 +172,7 @@ sub _template_obj { PLUGIN_BASE => 'SL::Template::Plugin', INCLUDE_PATH => '.:templates/webpages', COMPILE_EXT => '.tcc', - COMPILE_DIR => $::userspath . '/templates-cache', + COMPILE_DIR => $::lx_office_conf{paths}->{userspath} . '/templates-cache', }) || croak; return $self->{__basepriv_template_obj}; @@ -198,6 +257,24 @@ Usage from a template usually looks like this: The dispatching is handled by the function L. +=head2 HOOKS + +Hooks are functions that are called before or after the controller's +action is called. The controller package defines the hooks, and those +hooks themselves are run as instance methods. + +Hooks are run in the order they're added. + +The return value of the hooks is discarded. + +Hooks can be defined to run for all actions, for only specific actions +or for all actions except a list of actions. Each entry is the action +name, not the sub's name. Therefore in order to run a hook before one +of the subs C or C is called the following +code can be used: + + __PACKAGE__->run_before('things_to_do_before_edit_and_save', only => [ 'edit', 'save' ]); + =head1 FUNCTIONS =head2 PUBLIC HELPER FUNCTIONS @@ -215,7 +292,7 @@ C<$options>, if present, must be a hash reference. All remaining parameters are slurped into C<%locals>. What is rendered and how C<$template> is interpreted is determined by -C<< $options->{inline} >> and C<< $options->{partial} >>. +the options I, I, I and I. If C<< $options->{inline} >> is trueish then C<$template> is a string containing the template code to interprete. Additionally the output @@ -224,14 +301,23 @@ caller. If C<< $options->{inline} >> is falsish then C<$template> is interpreted as the name of a template file. It is prefixed with -"templates/webpages/" and postfixed with ".html". An exception will be -thrown if that file does not exist. +"templates/webpages/" and postfixed with a file extension based on +C<< $options->{type} >>. C<< $options->{type} >> can be either C +or C and defaults to C. An exception will be thrown if that +file does not exist. -If C<< $options->{partial} >> or C<< $options->{inline} }} is trueish -then C<< $::form->header >> will not be called. Otherwise -C<< $::form->{header} >> will be set to C<$locals{header}> (only if -$locals{header} is trueish) and C<< $::form->header >> will be called -before the template itself is processed. +If C<< $options->{partial} >> or C<< $options->{inline} >> is trueish +then neither the HTTP response header nor the standard HTML header is +generated. + +Otherwise at least the HTTP response header will be generated based on +the template type (C<< $options->{type} >>). + +If the template type is C then the standard HTML header will be +output via C<< $::form->header >> with C<< $::form->{title} >> set to +C<$locals{title}> (the latter only if C<$locals{title}> is +trueish). Setting C<< $options->{no_layout} >> to trueish will prevent +this. The template itself has access to the following variables: @@ -243,9 +329,10 @@ The template itself has access to the following variables: =item * C -- C<$::locale> -=item * C -- all parameters from C with -the same name they appear in the file (e.g. C, C -etc) +=item * C -- all parameters from C +with the same name they appear in the file (first level is the +section, second the actual variable, e.g. C, +C etc) =item * C -- C<$::lxdebug> @@ -262,6 +349,24 @@ output to the browser. The function will always return the output. +Example: Render a HTML template with a certain title and a few locals + + $self->render('todo/list', + title => 'List TODO items', + TODO_ITEMS => SL::DB::Manager::Todo->get_all_sorted); + +Example: Render a string and return its content for further processing +by the calling function. No header is generated due to C. + + my $content = $self->render('[% USE JavaScript %][% JavaScript.replace_with("#someid", "js/something") %]', + { type => 'js', inline => 1 }); + +Example: Render a JavaScript template and send it to the +browser. Typical use for actions called via AJAX: + + $self->render('todo/single_item', { type => 'js' }, + item => $employee->most_important_todo_item); + =item C =item C @@ -289,12 +394,45 @@ Usage from a template might look like this: create new message -=item redirect_to %url_params +=item C Redirects the browser to a new URL by outputting a HTTP redirect header. The URL is generated by calling L with C<%url_params>. +=item C + +=item C + +Adds a hook to run before or after certain actions are run for the +current package. The code to run is C<$sub> which is either the name +of an instance method or a code reference. If it's the latter then the +first parameter will be C<$self>. + +C<%params> can contain two possible values that restrict the code to +be run only for certain actions: + +=over 2 + +=item C<< only => \@list >> + +Only run the code for actions given in C<@list>. The entries are the +action names, not the names of the sub (so it's C instead of +C). + +=item C<< except => \@list >> + +Run the code for all actions but for those given in C<@list>. The +entries are the action names, not the names of the sub (so it's +C instead of C). + +=back + +If neither restriction is used then the code will be run for any +action. + +The hook's return values are discarded. + =back =head2 PRIVATE FUNCTIONS