Dateimanagement: Controller zum Laden und Generierung der Dateien

[kivitendo-erp.git] / SL / Controller / Base.pm

diff --git a/SL/Controller/Base.pm b/SL/Controller/Base.pm
index 17a1d61..01da48b 100644 (file)
--- 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) ],
 );
 
 #
@@ -98,6 +99,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.
 
@@ -116,18 +129,10 @@ sub render {
                         :                              '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};
 
@@ -135,19 +140,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 {
@@ -160,6 +180,10 @@ sub controller_name {
   return $class;
 }
 
+sub init_js {
+  SL::ClientJS->new(controller => $_[0])
+}
+
 #
 # Before/after run hooks
 #
@@ -460,10 +484,15 @@ browser. Typical use for actions called via AJAX:
   $self->render('todo/single_item', { type => 'js' },
                 item => $employee->most_important_todo_item);
 
-=item C<send_file $file_name, [%params]>
+=item C<send_file $file_name_or_content, [%params]>
 
-Sends the file C<$file_name> to the browser including appropriate HTTP
-headers for a download. C<%params> can include the following:
+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.
+
+C<%params> can include the following:
 
 =over 2
 
@@ -471,7 +500,11 @@ headers for a download. C<%params> can include the following:
 'application/octet_stream'
 
 =item * C<name> -- 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<unlink> -- 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
 
@@ -512,7 +545,7 @@ the current request is an AJAX request as determined by
 L<SL::Request/is_ajax>. 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<eval_json_result> function from the L<SL::ClientJS> module.
+C<kivi.eval_json_result> function from the L<SL::ClientJS> module.
 
 =item C<run_before $sub, %params>
 
@@ -562,13 +595,16 @@ C<user> (authentication as a normal user suffices) with a possible
 future value C<none> (which would require no authentication but is not
 yet implemented).
 
-=item C<keep_auth_vars_in_form>
+=item C<keep_auth_vars_in_form %params>
 
 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<controller_name>
 
 Returns the name of the curernt controller package without the
@@ -586,6 +622,10 @@ name the dispatching resolved to.
 Returns the global presenter object by calling
 L<SL::Presenter/get>.
 
+=item C<js>
+
+Returns an L<SL::ClientJS> instance for this controller.
+
 =back
 
 =head2 PRIVATE FUNCTIONS