X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FBase.pm;h=a37ac8bef315faf181599e6e603789251b7fd2ae;hb=eff6af2885966e0bbe4b614ef03525012cff92aa;hp=7fe1d36eaf922c881cc817165ad6326ce0c9cd78;hpb=075bd42af8885aee3c18fe055a2c82b8b43f4cea;p=kivitendo-erp.git diff --git a/SL/Controller/Base.pm b/SL/Controller/Base.pm index 7fe1d36ea..a37ac8bef 100644 --- a/SL/Controller/Base.pm +++ b/SL/Controller/Base.pm @@ -9,6 +9,7 @@ use IO::File; use List::Util qw(first); use SL::Request qw(flatten); use SL::MoreCommon qw(uri_encode); +use SL::Presenter; use Rose::Object::MakeMethods::Generic ( @@ -51,6 +52,8 @@ sub redirect_to { SL::Helper::Flash::delay_flash(); } + return $self->render(SL::ClientJS->new->redirect_to($self->url_for(@_))) if $::request->is_ajax; + print $::request->{cgi}->redirect($url); } @@ -59,56 +62,74 @@ 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'; + # Special handling/shortcut for an instance of SL::ClientJS: + return $self->render(\$template->to_json, { type => 'json' }) if ref($template) eq 'SL::ClientJS'; + + # Set defaults for all available options. + my %defaults = ( + type => 'html', + output => 1, + header => 1, + layout => 1, + process => 1, + ); + $options->{$_} //= $defaults{$_} for keys %defaults; + $options->{type} = lc $options->{type}; + + # Check supplied options for validity. + foreach (keys %{ $options }) { + croak "Unsupported option: $_" unless $defaults{$_}; + } + + # Only certain types are supported. + croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json|text)$/; - my $source; - if ($options->{inline}) { - $source = \$template; + # The "template" argument must be a string or a reference to one. + $template = ${ $template } if ((ref($template) || '') eq 'REF') && (ref(${ $template }) eq 'SL::Presenter::EscapedText'); + croak "Unsupported 'template' reference type: " . ref($template) if ref($template) && (ref($template) !~ m/^(?:SCALAR|SL::Presenter::EscapedText)$/); - } elsif($options->{raw}) { - $source = $template; + # If all output is turned off then don't output the header either. + if (!$options->{output}) { + $options->{header} = 0; + $options->{layout} = 0; } else { - $source = "templates/webpages/${template}." . $options->{type}; - croak "Template file ${source} not found" unless -f $source; + # Layout only makes sense if we're outputting HTML. + $options->{layout} = 0 if $options->{type} ne 'html'; } - 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'; + if ($options->{header}) { + # Output the HTTP response and the layout in case of HTML output. - print $::form->create_http_response(content_type => $content_type, - charset => $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET()); + if ($options->{layout}) { + $::form->{title} = $locals{title} if $locals{title}; + $::form->header; } else { - $::form->{title} = $locals{title} if $locals{title}; - $::form->header(no_menu => $options->{no_menu}); + # No layout: just the standard HTTP response. Also notify + # $::form that the header has already been output so that + # $::form->header() won't output it again. + $::form->{header} = 1; + my $content_type = $options->{type} eq 'html' ? 'text/html' + : $options->{type} eq 'js' ? 'text/javascript' + : $options->{type} eq 'text' ? 'text/plain' + : 'application/json'; + + print $::form->create_http_response(content_type => $content_type, + charset => 'UTF-8'); } } - my %params = ( %locals, - AUTH => $::auth, - FLASH => $::form->{FLASH}, - FORM => $::form, - INSTANCE_CONF => $::instance_conf, - LOCALE => $::locale, - LXCONFIG => \%::lx_office_conf, - LXDEBUG => $::lxdebug, - MYCONFIG => \%::myconfig, - SELF => $self, - ); - - my $output; - if (!$options->{raw}) { - my $parser = $self->_template_obj; - $parser->process($source, \%params, \$output) || croak $parser->error; - } else { - $output = $$source; - } + # Let the presenter do the rest of the work. + my $output = $self->presenter->render( + $template, + { type => $options->{type}, process => $options->{process} }, + %locals, + SELF => $self, + ); - print $output unless $options->{inline} || $options->{no_output}; + # Print the output if wanted. + print $output if $options->{output}; return $output; } @@ -129,6 +150,10 @@ sub send_file { $file->close; } +sub presenter { + return SL::Presenter->get; +} + sub controller_name { my $class = ref($_[0]) || $_[0]; $class =~ s/^SL::Controller:://; @@ -229,28 +254,10 @@ sub _dispatch { $self->$sub(@_); $self->_run_hooks('after', $action); } else { - $::form->error($::locale->text('Oops. No valid action found to dispatch. Please report this case to the Lx-Office team.')); + $::form->error($::locale->text('Oops. No valid action found to dispatch. Please report this case to the kivitendo team.')); } } -sub _template_obj { - my ($self) = @_; - - $self->{__basepriv_template_obj} ||= - Template->new({ INTERPOLATE => 0, - EVAL_PERL => 0, - ABSOLUTE => 1, - CACHE_SIZE => 0, - PLUGIN_BASE => 'SL::Template::Plugin', - INCLUDE_PATH => '.:templates/webpages', - COMPILE_EXT => '.tcc', - COMPILE_DIR => $::lx_office_conf{paths}->{userspath} . '/templates-cache', - ERROR => 'templates/webpages/generic/exception.html', - }) || croak; - - return $self->{__basepriv_template_obj}; -} - 1; __END__ @@ -368,65 +375,69 @@ C does. 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 -the options I, I, I and I. +What is rendered and how C<$template> is interpreted is determined +both by C<$template>'s reference type and by the supplied options. The +actual rendering is handled by L. -If C<< $options->{inline} >> is trueish then C<$template> is a string -containing the template code to interprete. Additionally the output -will not be sent to the browser. Instead it is only returned to the -caller. +If C<$template> is a normal scalar (not a reference) then it is meant +to be a template file name relative to the C +directory. The file name to use is determined by the C option. -If C<< $options->{raw} >> is trueish, the function will treat the input as -already parsed, and will not filter the input through Template. Unlike -C, the input is taked as a reference. +If C<$template> is a reference to a scalar then the referenced +scalar's content is used as the content to process. The C option +is not considered in this case. -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 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. +C<$template> can also be an instance of L +or a reference to such an instance. Both of these cases are handled +the same way as if C<$template> were a reference to a scalar: its +content is processed, and C is not considered. -If C<< $options->{partial} >> or C<< $options->{inline} >> is trueish -then neither the HTTP response header nor the standard HTML header is -generated. +Other reference types, unknown options and unknown arguments to the +C option cause the function to L. -Otherwise at least the HTTP response header will be generated based on -the template type (C<< $options->{type} >>). +The following options are available (defaults: C = 'html', +C = 1, C = 1, C
= 1, C = 1): -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. +=over 2 -The template itself has access to the following variables: +=item C -=over 2 +The template type. Can be C (the default), C for JavaScript, +C for JSON and C for plain text content. Affects the +extension that's added to the file name given with a non-reference +C<$template> argument, the content type HTTP header that is output and +whether or not the layout will be output as well (see description of +C below). -=item * C -- C<$::auth> +=item C -=item * C
-- C<$::form> +If trueish (which is also the default) it causes the template/content +to be processed by the Template toolkit. Otherwise the +template/content is output as-is. -=item * C -- C<$::locale> +=item C -=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) +If trueish (the default) then the generated output will be sent to the +browser in addition to being returned. If falsish then the options +C
and C are set to 0 as well. -=item * C -- C<$::lxdebug> +=item C
-=item * C -- C<%::myconfig> +Determines whether or not to output the HTTP response +headers. Defaults to the same value that C is set to. If set +to falsish then the layout is not output either. -=item * C -- the controller instance +=item C -=item * All items from C<%locals> +Determines whether or not the basic HTML layout structure should be +output (HTML header, common JavaScript and stylesheet inclusions, menu +etc.). Defaults to 0 if C is not C and to the same value +C
is set to otherwise. =back -Unless C<< $options->{inline} >> is trueish the function will send the -output to the browser. +The template itself has access to several variables. These are listed +in the documentation to L. The function will always return the output. @@ -437,12 +448,13 @@ Example: Render a HTML template with a certain title and a few locals 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. +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 }); + my $content = $self->render(\'[% USE JavaScript %][% JavaScript.replace_with("#someid", "js/something") %]', + { output => 0 }); -Example: Render a JavaScript template and send it to the +Example: Render a JavaScript template +"templates/webpages/todo/single_item.js" and send it to the browser. Typical use for actions called via AJAX: $self->render('todo/single_item', { type => 'js' }, @@ -492,9 +504,15 @@ Usage from a template might look like this: =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>. +Redirects the browser to a new URL. The URL is generated by calling +L with C<%url_params>. + +This function implements the redirection depending on whether or not +the current request is an AJAX request as determined by +L. If it is a normal request then it outputs a +standard HTTP redirect header (HTTP code 302). If it is an AJAX +request then it outputs an AJAX response suitable for the +C function from the L module. =item C @@ -544,13 +562,16 @@ C (authentication as a normal user suffices) with a possible future value C (which would require no authentication but is not yet implemented). -=item C +=item C May be overridden by a controller. If falsish (the default) all form variables whose name starts with C<{AUTH}> are removed before the request is routed. Only controllers that handle login requests themselves should return trueish for this function. +C<$params{action}> contains the action name that the request will be +dispatched to. + =item C Returns the name of the curernt controller package without the @@ -563,6 +584,11 @@ Returns the name of the currently executing action. If the dispatcher mechanism was used then this is not C but the actual method name the dispatching resolved to. +=item C + +Returns the global presenter object by calling +L. + =back =head2 PRIVATE FUNCTIONS