X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FBase.pm;h=d50d519b71733c31c2c10d5759b1d52ed953b673;hb=3e8a8c572aa73c522df8c916d799cb30be276925;hp=8e7e721dde70dedd2e062e3dd4b10ae69004850e;hpb=f1c874c3725f159f1b00295bf825b2a270cf57bc;p=kivitendo-erp.git diff --git a/SL/Controller/Base.pm b/SL/Controller/Base.pm index 8e7e721dd..d50d519b7 100644 --- a/SL/Controller/Base.pm +++ b/SL/Controller/Base.pm @@ -5,6 +5,7 @@ use strict; use parent qw(Rose::Object); use Carp; +use IO::File; use List::Util qw(first); # @@ -37,32 +38,38 @@ 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, + FLASH => $::form->{FLASH}, 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, @@ -72,11 +79,27 @@ 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; } +sub send_file { + my ($self, $file_name, %params) = @_; + + 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; + $attachment_name =~ s:.*//::g; + + print $::form->create_http_response(content_type => $content_type, + content_disposition => 'attachment; filename="' . $attachment_name . '"', + content_length => -s $file); + + $::locale->with_raw_io(\*STDOUT, sub { print while <$file> }); + $file->close; +} + # # Before/after run hooks # @@ -167,7 +190,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}; @@ -287,7 +310,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 @@ -296,14 +319,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: @@ -315,9 +347,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> @@ -334,6 +367,39 @@ 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 + +Sends the file C<$file_name> to the browser including appropriate HTTP +headers for a download. C<%params> can include the following: + +=over 2 + +=item * C -- the file's content type; defaults to +'application/octet_stream' + +=item * C -- the name presented to the browser; defaults to +C<$file_name> + +=back + =item C =item C @@ -361,7 +427,7 @@ 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