X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FBase.pm;h=4b27cd98244588a63b162a7e40bfcd2bd3e2fef3;hb=efb9a24f2252104ab4af5c25334119d7c5c70a8c;hp=d6bfd42e5d2c7d75b5128b8c63e8574848a6a774;hpb=d445880375bce1462b8f9a8b1a502b34c296d41f;p=kivitendo-erp.git diff --git a/SL/Controller/Base.pm b/SL/Controller/Base.pm index d6bfd42e5..4b27cd982 100644 --- a/SL/Controller/Base.pm +++ b/SL/Controller/Base.pm @@ -52,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); } @@ -60,53 +62,104 @@ 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{$_}; + } - 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'; + # Only certain types are supported. + croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json|text)$/; - print $::form->create_http_response(content_type => $content_type, - charset => $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET()); + # 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)$/); - } else { + # If all output is turned off then don't output the header either. + if (!$options->{output}) { + $options->{header} = 0; + $options->{layout} = 0; + + } else { + # Layout only makes sense if we're outputting HTML. + $options->{layout} = 0 if $options->{type} ne 'html'; + } + + if ($options->{header}) { + # Output the HTTP response and the layout in case of HTML output. + + if ($options->{layout}) { $::form->{title} = $locals{title} if $locals{title}; - $::form->header(no_menu => $options->{no_menu}); + $::form->header; + + } else { + # 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 $output; - if ($options->{raw}) { - $output = $$template; - } else { - $output = $self->presenter->render( - $template, $options, - %locals, - SELF => $self, - ); - } + # 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; } sub send_file { - my ($self, $file_name, %params) = @_; + my ($self, $file_name_or_content, %params) = @_; + + my ($file, $size); + + if (!ref $file_name_or_content) { + $file = IO::File->new($file_name_or_content, 'r') || croak("Cannot open file '${file_name_or_content}'"); + $size = -s $file_name_or_content; + } else { + $size = length $$file_name_or_content; + } - my $file = IO::File->new($file_name, 'r') || croak("Cannot open file '${file_name}'"); my $content_type = $params{type} || 'application/octet_stream'; - my $attachment_name = $params{name} || $file_name; + my $attachment_name = $params{name} || (!ref($file_name_or_content) ? $file_name_or_content : ''); $attachment_name =~ s:.*//::g; print $::form->create_http_response(content_type => $content_type, content_disposition => 'attachment; filename="' . $attachment_name . '"', - content_length => -s $file); + content_length => $size); - $::locale->with_raw_io(\*STDOUT, sub { print while <$file> }); - $file->close; + if (!ref $file_name_or_content) { + $::locale->with_raw_io(\*STDOUT, sub { print while <$file> }); + $file->close; + } else { + $::locale->with_raw_io(\*STDOUT, sub { print $$file_name_or_content }); + } } sub presenter { @@ -334,46 +387,70 @@ 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. The +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<$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. + +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. + +Other reference types, unknown options and unknown arguments to the +C option cause the function to L. + +The following options are available (defaults: C = 'html', +C = 1, C = 1, C
= 1, C = 1): + +=over 2 + +=item C -If C<< $options->{raw} >> is trueish, the function will treat the -input as already parsed, and will not filter the input through -Template. This also means that L is not -called either. Unlike C, the input is taken as a reference. +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). -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. +=item C -If C<< $options->{partial} >> or C<< $options->{inline} >> is trueish -then neither the HTTP response header nor the standard HTML header is -generated. +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. -Otherwise at least the HTTP response header will be generated based on -the template type (C<< $options->{type} >>). +=item C -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. +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
+ +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 + +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 The template itself has access to several variables. These are listed in the documentation to L. -Unless C<< $options->{inline} >> is trueish the function will send the -output to the browser. - The function will always return the output. Example: Render a HTML template with a certain title and a few locals @@ -383,21 +460,27 @@ 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' }, item => $employee->most_important_todo_item); -=item C +=item C + +Sends the file C<$file_name_or_content> to the browser including +appropriate HTTP headers for a download. If C<$file_name_or_content> +is a scalar then it is interpreted as a file name which is opened and +whose content is sent. Otherwise (C<$file_name_or_content> being a +reference) the referenced scalar's data itself is sent. -Sends the file C<$file_name> to the browser including appropriate HTTP -headers for a download. C<%params> can include the following: +C<%params> can include the following: =over 2 @@ -405,7 +488,7 @@ headers for a download. C<%params> can include the following: 'application/octet_stream' =item * C -- the name presented to the browser; defaults to -C<$file_name> +C<$file_name>; mandatory if C<$file_name_or_content> is a reference =back @@ -438,9 +521,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 @@ -490,13 +579,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