X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FBase.pm;h=c79ceecacb4dfd1e816b1c6b1f82cb69efab4cc5;hb=50418558d521022a3c23d5edf431b2a41daae0f8;hp=982c379abc917f9273995d7ec22591b6d92f8b40;hpb=5f9aa88cc68949f06000a556a206ed01e0e30b2c;p=kivitendo-erp.git diff --git a/SL/Controller/Base.pm b/SL/Controller/Base.pm index 982c379ab..c79ceecac 100644 --- a/SL/Controller/Base.pm +++ b/SL/Controller/Base.pm @@ -37,18 +37,30 @@ 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 => $::dbcharset || Common::DEFAULT_CHARSET()); + + } else { + $::form->{title} = $locals{title} if $locals{title}; + $::form->header; + } } my %params = ( %locals, @@ -72,23 +84,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 'dispatch'; - return $self->_dispatch(@_) if $action eq 'action_dispatch'; + $::form->error("Invalid action '${action}' for controller " . ref($self)) if !$self->can($sub); - $::form->error("Invalid action ${action} for controller " . ref($self)) if !$self->can($action); - $self->$action(@_); + $self->_run_hooks('before', $action); + $self->$sub(@_); + $self->_run_hooks('after', $action); } sub _controller_name { @@ -98,10 +158,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 { @@ -200,6 +264,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 @@ -217,7 +299,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 @@ -226,14 +308,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 neither the HTTP response header nor the standard HTML header is +generated. -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. +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: @@ -264,6 +355,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 @@ -291,12 +400,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