SL/Controller/DownloadZip.pm

   1 package SL::Controller::DownloadZip;
   2
   3 use strict;
   4
   5 use parent qw(SL::Controller::Base);
   6
   7 use List::Util qw(first max);
   8
   9 use utf8;
  10 use Encode qw(decode encode);
  11 use Archive::Zip;
  12 use SL::File;
  13 use SL::SessionFile::Random;
  14
  15 sub action_download_orderitems_files {
  16   my ($self) = @_;
  17
  18   #
  19   # special case for customer which want to have not all
  20   # in kivitendo.conf some regex may be defined:
  21   # For no values just let it commented out
  22   # PA = Produktionsauftrag, L = Lieferschein, ML = Materialliste
  23   # If you want several options, please separate the letter with '|'. Example: '^(PA|L).*'
  24   #set_sales_documenttype_for_delivered_quantity = '^(LS).*'
  25   #set_purchase_documenttype_for_delivered_quantity = '^(EL).*'
  26   #
  27   # enbale this perl code:
  28   #  my $doctype = $::lx_office_conf{system}->{"set_documenttype_for_part_zip_download"};
  29   #  if ( $doctype ) {
  30   #    # eliminate first and last char (are quotes)
  31   #    $doctype =~ s/^.//;
  32   #    $doctype =~ s/.$//;
  33   #  }
  34
  35   #$Archive::Zip::UNICODE = 1;
  36
  37   my $object_id    = $::form->{object_id};
  38   my $object_type  = $::form->{object_type};
  39   my $element_type = $::form->{element_type};
  40   my $sfile = SL::SessionFile::Random->new(mode => "w");
  41   my $zip = Archive::Zip->new();
  42   #TODO Check client encoding !!
  43   #my $name_encoding = 'cp850';
  44   my $name_encoding = 'UTF-8';
  45
  46   # today only sales_order implementation !
  47   if ( $object_id && $object_type eq 'sales_order' && $element_type eq 'part' ) {
  48     my $orderitems = SL::DB::Manager::OrderItem->get_all(query => ['order.id' => $object_id ],
  49                                                          with_objects => [ 'order', 'part' ],
  50                                                          sort_by => 'part.partnumber ASC');
  51     my $part_id = 0;
  52     foreach my $item ( @{$orderitems} ) {
  53       next if $part_id == $item->parts_id;
  54
  55       my @files = SL::File->get_all(object_id   => $item->parts_id,
  56                                     object_type => $element_type,
  57                                   );
  58       my @wanted_files;
  59       ## also for filtering if needed:
  60       # if ( $doctype ) {
  61       #   @wanted_files = grep { $_->{file_name} =~ /$doctype/ } @files;
  62       # } else {
  63       @wanted_files = @files;
  64       # }
  65       if ( scalar (@wanted_files) > 0 ) {
  66         $zip->addDirectory($item->part->partnumber);
  67         $zip->addFile($_->get_file,
  68                       Encode::encode($name_encoding,$item->part->partnumber.'/'.$_->{file_name})
  69                       ) for @wanted_files;
  70       }
  71     }
  72   }
  73   unless ( $zip->writeToFileNamed($sfile->file_name) == Archive::Zip::AZ_OK ) {
  74     die 'zipfile write error';
  75   }
  76   $sfile->fh->close;
  77
  78   return $self->send_file(
  79     $sfile->file_name,
  80     type => 'application/zip',
  81     name => $::form->{zipname}.'.zip',
  82   );
  83 }
  84
  85 1;
  86
  87 __END__
  88
  89 =pod
  90
  91 =encoding utf-8
  92
  93 =head1 NAME
  94
  95 SL::Controller::DownloadZip - controller for download all files from parts of an order in one zip file
  96
  97 =head2  C<action_download_zip FORMPARAMS>
  98
  99 Some customer want all attached files for the parts of an sales order or sales delivery order in one zip to download.
 100 This is a special method for one customer, so it is moved into an extra controller.
 101 The $Archive::Zip::UNICODE = 1; doesnt work ok
 102 So today the filenames in cp850/DOS format for legacy windows.
 103 To ues it for Linux Clients an additinal effort must be done,
 104 for ex. a link to the same file with an utf-8 name.
 105
 106 There is also a special javascript method necessary which calles this controller method.
 107 THis method must be inserted into the customer branch:
 108
 109 =begin text
 110
 111   ns.downloadOrderitemsAtt = function(type,id) {
 112     var rowcount  = $('input[name=rowcount]').val() - 1;
 113     var data = {
 114         action:     'FileManagement/download_zip',
 115         type:       type,
 116         object_id:  id,
 117         rowcount:   rowcount
 118     };
 119     if ( rowcount == 0 ) {
 120         kivi.display_flash('error', kivi.t8('No articles have been added yet.'));
 121         return false;
 122     }
 123     for (var i = 1; i <= rowcount; i++) {
 124         data['parts_id_'+i] =  $('#id_' + i).val();
 125     };
 126     $.download("controller.pl", data);
 127     return false;
 128   }
 129
 130 =end text
 131
 132 See also L<SL::Controller::FileManagement>
 133
 134 =head1 DISCUSSION
 135
 136 Is this method needed in the master branch ?
 137
 138 =head1 AUTHOR
 139
 140 Martin Helmling E<lt>martin.helmling@opendynamic.deE<gt>
 141
 142 =cut