X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FBase.pm;h=5847b98b5fd9e9b2840ecb86062d212e810be497;hb=9508e215c78bc172721e14d41d21858abb23672e;hp=ce6af16b5d0d3105154ab72525329d2eed87e39d;hpb=3ce4cab393c398fe802d4d5cef08b7ad64773294;p=kivitendo-erp.git diff --git a/SL/Controller/Base.pm b/SL/Controller/Base.pm index ce6af16b5..5847b98b5 100644 --- a/SL/Controller/Base.pm +++ b/SL/Controller/Base.pm @@ -13,7 +13,8 @@ use SL::Presenter; use Rose::Object::MakeMethods::Generic ( - scalar => [ qw(action_name) ], + scalar => [ qw(action_name) ], + 'scalar --get_set_init' => [ qw(js) ], ); # @@ -28,6 +29,7 @@ sub url_for { my %params = ref($_[0]) eq 'HASH' ? %{ $_[0] } : @_; my $controller = delete($params{controller}) || $self->controller_name; my $action = $params{action} || 'dispatch'; + my $fragment = delete $params{fragment}; my $script; if ($controller =~ m/\.pl$/) { @@ -40,7 +42,7 @@ sub url_for { my $query = join '&', map { uri_encode($_->[0]) . '=' . uri_encode($_->[1]) } @{ flatten(\%params) }; - return "${script}?${query}"; + return "${script}?${query}" . (defined $fragment ? "#$fragment" : ''); } sub redirect_to { @@ -82,7 +84,7 @@ sub render { } # Only certain types are supported. - croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json)$/; + croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json|text)$/; # 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'); @@ -98,6 +100,18 @@ sub render { $options->{layout} = 0 if $options->{type} ne 'html'; } + # Let the presenter do the rest of the work. + my $output; + { + local $::form->{title} = $locals{title} if $locals{title}; + $output = $self->presenter->render( + $template, + { type => $options->{type}, process => $options->{process} }, + %locals, + SELF => $self, + ); + } + if ($options->{header}) { # Output the HTTP response and the layout in case of HTML output. @@ -112,21 +126,14 @@ sub render { $::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 => $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET()); + charset => 'UTF-8'); } } - # 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 the output if wanted. print $output if $options->{output}; @@ -134,19 +141,34 @@ sub render { } 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; + unlink $file_name_or_content if $params{unlink}; + } else { + $::locale->with_raw_io(\*STDOUT, sub { print $$file_name_or_content }); + } + + return 1; } sub presenter { @@ -159,6 +181,10 @@ sub controller_name { return $class; } +sub init_js { + SL::ClientJS->new(controller => $_[0]) +} + # # Before/after run hooks # @@ -401,11 +427,12 @@ C = 1, C = 1, C
= 1, C = 1): =item C -The template type. Can be C (the default), C for JavaScript -or C for JSON 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). +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 @@ -458,10 +485,15 @@ 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 @@ -469,7 +501,11 @@ 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 + +=item * C -- if trueish and C<$file_name_or_content> refers to +a file name then unlink the file after it has been sent to the browser +(e.g. for temporary files) =back @@ -493,6 +529,9 @@ L. The action to call is given by C<$params{action}>. It defaults to C. +If C<$params{fragment}> is present, it's used as the fragment of the resulting +URL. + All other key/value pairs in C<%params> are appended as GET parameters to the URL. @@ -510,7 +549,7 @@ 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. +C function from the L module. =item C @@ -560,13 +599,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 @@ -584,6 +626,10 @@ name the dispatching resolved to. Returns the global presenter object by calling L. +=item C + +Returns an L instance for this controller. + =back =head2 PRIVATE FUNCTIONS