1 package SL::Controller::File;
5 use parent qw(SL::Controller::Base);
7 use List::Util qw(first max);
10 use Encode qw(decode);
16 use File::Spec::Win32;
17 use File::MimeInfo::Magic;
18 use SL::DB::Helper::Mappings;
20 use SL::DB::DeliveryOrder;
23 use SL::DB::PurchaseInvoice;
25 use SL::DB::GLTransaction;
29 use SL::Helper::CreatePDF qw(:all);
30 use SL::Locale::String;
33 use SL::Controller::Helper::ThumbnailCreator qw(file_probe_image_type);
35 use constant DO_DELETE => 0;
36 use constant DO_UNIMPORT => 1;
38 use Rose::Object::MakeMethods::Generic
40 'scalar --get_set_init' => [ qw() ],
41 'scalar' => [ qw(object object_type object_model object_id object_right file_type files is_global existing) ],
44 __PACKAGE__->run_before('check_object_params', only => [ qw(list ajax_delete ajax_importdialog ajax_import ajax_unimport ajax_upload ajax_files_uploaded) ]);
47 'sales_quotation' => { gen => 1, gltype => '', dir =>'SalesQuotation', model => 'Order', right => 'import_ar' },
48 'sales_order' => { gen => 1, gltype => '', dir =>'SalesOrder', model => 'Order', right => 'import_ar' },
49 'sales_delivery_order' => { gen => 1, gltype => '', dir =>'SalesDeliveryOrder', model => 'DeliveryOrder', right => 'import_ar' },
50 'invoice' => { gen => 1, gltype => 'ar', dir =>'SalesInvoice', model => 'Invoice', right => 'import_ar' },
51 'credit_note' => { gen => 1, gltype => '', dir =>'CreditNote', model => 'Invoice', right => 'import_ar' },
52 'request_quotation' => { gen => 3, gltype => '', dir =>'RequestForQuotation', model => 'Order', right => 'import_ap' },
53 'purchase_order' => { gen => 3, gltype => '', dir =>'PurchaseOrder', model => 'Order', right => 'import_ap' },
54 'purchase_delivery_order' => { gen => 3, gltype => '', dir =>'PurchaseDeliveryOrder',model => 'DeliveryOrder', right => 'import_ap' },
55 'purchase_invoice' => { gen => 2, gltype => 'ap', dir =>'PurchaseInvoice', model => 'PurchaseInvoice',right => 'import_ap' },
56 'vendor' => { gen => 0, gltype => '', dir =>'Vendor', model => 'Vendor', right => 'xx' },
57 'customer' => { gen => 1, gltype => '', dir =>'Customer', model => 'Customer', right => 'xx' },
58 'part' => { gen => 0, gltype => '', dir =>'Part', model => 'Part', right => 'xx' },
59 'gl_transaction' => { gen => 2, gltype => 'gl', dir =>'GeneralLedger', model => 'GLTransaction', right => 'import_ap' },
60 'draft' => { gen => 0, gltype => '', dir =>'Draft', model => 'Draft', right => 'xx' },
61 'csv_customer' => { gen => 1, gltype => '', dir =>'Reports', model => 'Customer', right => 'xx' },
62 'csv_vendor' => { gen => 1, gltype => '', dir =>'Reports', model => 'Vendor', right => 'xx' },
63 'shop_image' => { gen => 0, gltype => '', dir =>'ShopImages', model => 'Part', right => 'xx' },
67 # $main::locale->text('imported')
77 $is_json = 1 if $::form->{json};
79 $self->_do_list($is_json);
82 sub action_ajax_importdialog {
84 $::auth->assert($self->object_right);
85 my $path = $::form->{path};
86 my @files = $self->_get_from_import($path);
88 'name' => $::form->{source},
90 'chk_action' => $::form->{source}.'_import',
91 'chk_title' => $main::locale->text('Import scanned documents'),
92 'chkall_title' => $main::locale->text('Import all'),
95 $self->render('file/import_dialog',
102 sub action_ajax_import {
104 $::auth->assert($self->object_right);
105 my $ids = $::form->{ids};
106 my $source = $::form->{source};
107 my $path = $::form->{path};
108 my @files = $self->_get_from_import($path);
109 foreach my $filename (@{ $::form->{$ids} || [] }) {
110 my ($file, undef) = grep { $_->{name} eq $filename } @files;
112 my $obj = SL::File->save(object_id => $self->object_id,
113 object_type => $self->object_type,
114 mime_type => 'application/pdf',
116 file_type => 'document',
117 file_name => $file->{filename},
118 file_path => $file->{path}
120 unlink($file->{path}) if $obj;
126 sub action_ajax_delete {
128 $self->_delete_all(DO_DELETE, $::locale->text('Following files are deleted:'));
131 sub action_ajax_unimport {
133 $self->_delete_all(DO_UNIMPORT, $::locale->text('Following files are unimported:'));
136 sub action_ajax_rename {
138 my $file = SL::File->get(id => $::form->{id});
140 $self->js->flash('error', $::locale->text('File not exists !'))->render();
143 my $sessionfile = $::form->{sessionfile};
144 if ( $sessionfile && -f $sessionfile ) {
146 if ( $::form->{to} eq $file->file_name ) {
147 # no rename so use as new version
148 $file->save_file($sessionfile);
149 $self->js->flash('warning', $::locale->text('File \'#1\' is used as new Version !', $file->file_name));
152 # new filename, so it is a new file with the same attributes as the old file
154 SL::File->save(object_id => $file->object_id,
155 object_type => $file->object_type,
156 mime_type => $file->mime_type,
157 source => $file->source,
158 file_type => $file->file_type,
159 file_name => $::form->{to},
160 file_path => $sessionfile
162 unlink($sessionfile);
165 $self->js->flash( 'error', t8('internal error (see details)'))
166 ->flash_detail('error', $@)->render;
176 $result = $file->rename($::form->{to});
179 $self->js->flash( 'error', t8('internal error (see details)'))
180 ->flash_detail('error', $@)->render;
184 if ($result != SL::File::RENAME_OK) {
185 $self->js->flash('error',
186 $result == SL::File::RENAME_EXISTS ? $::locale->text('File still exists !')
187 : $result == SL::File::RENAME_SAME ? $::locale->text('Same Filename !')
188 : $::locale->text('File not exists !'))
193 $self->is_global($::form->{is_global});
194 $self->file_type( $file->file_type);
195 $self->object_type($file->object_type);
196 $self->object_id( $file->object_id);
197 #$self->object_model($file_types{$file->module}->{model});
198 #$self->object_right($file_types{$file->module}->{right});
199 if ( $::form->{next_ids} ) {
200 my @existing = split(/,/, $::form->{next_ids});
201 $self->existing(\@existing);
206 sub action_ajax_upload {
208 $self->{maxsize} = $::instance_conf->get_doc_max_filesize;
209 $self->{accept_types} = '';
210 $self->{accept_types} = 'image/png,image/gif,image/jpeg,image/tiff,*png,*gif,*.jpg,*.tif' if $self->{file_type} eq 'image';
211 $self->render('file/upload_dialog',
217 sub action_ajax_files_uploaded {
220 my $source = 'uploaded';
222 if ( $::form->{ATTACHMENTS}->{uploadfiles} ) {
223 my @upfiles = @{ $::form->{ATTACHMENTS}->{uploadfiles} };
224 foreach my $idx (0 .. scalar(@upfiles) - 1) {
226 my $fname = uri_unescape($upfiles[$idx]->{filename});
227 # normalize and find basename
228 # first split with unix rules
229 # after that split with windows rules
230 my ($volume, $directories, $basefile) = File::Spec::Unix->splitpath($fname);
231 ($volume, $directories, $basefile) = File::Spec::Win32->splitpath($basefile);
233 # to find real mime_type by magic we must save the filedata
235 my $sess_fname = "file_upload_" . $self->object_type . "_" . $self->object_id . "_" . $idx;
236 my $sfile = SL::SessionFile->new($sess_fname, mode => 'w');
238 $sfile->fh->print(${$upfiles[$idx]->{data}});
240 my $mime_type = File::MimeInfo::Magic::magic($sfile->file_name);
243 # if filename has the suffix "pdf", but isn't really a pdf, set mimetype for no suffix
244 $mime_type = File::MimeInfo::Magic::mimetype($basefile);
245 $mime_type = 'application/octet-stream' if $mime_type eq 'application/pdf' || !$mime_type;
247 if ( $self->file_type eq 'image' && $self->file_probe_image_type($mime_type, $basefile)) {
250 my ($existobj) = SL::File->get_all(object_id => $self->object_id,
251 object_type => $self->object_type,
252 mime_type => $mime_type,
254 file_type => $self->file_type,
255 file_name => $basefile,
259 push @existing, $existobj->id.'_'.$sfile->file_name;
261 my $fileobj = SL::File->save(object_id => $self->object_id,
262 object_type => $self->object_type,
263 mime_type => $mime_type,
265 file_type => $self->file_type,
266 file_name => $basefile,
267 title => $::form->{title},
268 description => $::form->{description},
269 ## two possibilities: what is better ? content or sessionfile ??
270 file_contents => ${$upfiles[$idx]->{data}},
271 file_path => $sfile->file_name
273 unlink($sfile->file_name);
277 $self->js->flash( 'error', t8('internal error (see details)'))
278 ->flash_detail('error', $@)->render;
283 $self->existing(\@existing);
287 sub action_download {
289 my ($id, $version) = split /_/, $::form->{id};
290 my $file = SL::File->get(id => $id );
291 $file->version($version) if $version;
292 my $ref = $file->get_content;
293 if ( $file && $ref ) {
294 return $self->send_file($ref,
295 type => $file->mime_type,
296 name => $file->file_name,
305 sub check_object_params {
308 my $id = ($::form->{object_id} // 0) * 1;
309 my $draftid = ($::form->{draft_id} // 0) * 1;
313 if ( $draftid == 0 && $id == 0 && $::form->{is_global} ) {
315 $type = $::form->{object_type};
318 $id = $::form->{draft_id};
320 } elsif ( $::form->{object_type} ) {
321 $type = $::form->{object_type};
323 die "No object type" unless $type;
324 die "No file type" unless $::form->{file_type};
325 die "Unkown object type" unless $file_types{$type};
327 $self->is_global($gldoc);
328 $self->file_type($::form->{file_type});
329 $self->object_type($type);
330 $self->object_id($id);
331 $self->object_model($file_types{$type}->{model});
332 $self->object_right($file_types{$type}->{right});
334 # $::auth->assert($self->object_right);
336 # my $model = 'SL::DB::' . $self->object_model;
337 # $self->object($model->new(id => $self->object_id)->load || die "Record not found");
347 my ($self, $do_unimport, $infotext) = @_;
349 my $ids = $::form->{ids};
350 foreach my $id_version (@{ $::form->{$ids} || [] }) {
351 my ($id, $version) = split /_/, $id_version;
352 my $dbfile = SL::File->get(id => $id);
353 $dbfile->version($version) if $dbfile && $version;
354 if ( $dbfile && $dbfile->delete ) {
355 $files .= ' ' . $dbfile->file_name;
358 $self->js->flash('info', $infotext . $files) if $files;
363 my ($self, $json) = @_;
365 if ( $self->file_type eq 'document' ) {
367 push @object_types, $self->object_type;
368 push @object_types, qw(dunning dunning1 dunning2 dunning3) if $self->object_type eq 'invoice'; # hardcoded object types?
369 @files = SL::File->get_all_versions(object_id => $self->object_id,
370 object_type => \@object_types,
371 file_type => $self->file_type,
375 elsif ( $self->file_type eq 'attachment' || $self->file_type eq 'image' ) {
376 @files = SL::File->get_all(object_id => $self->object_id,
377 object_type => $self->object_type,
378 file_type => $self->file_type,
381 $self->files(\@files);
383 if($self->object_type eq 'shop_image'){
385 ->run('kivi.ShopPart.show_images', $self->object_id)
388 $self->_mk_render('file/list', 1, 0, $json);
392 sub _get_from_import {
393 my ($self, $path) = @_;
396 my $language = $::lx_office_conf{system}->{language};
397 my $timezone = $::locale->get_local_time_zone()->name;
398 if (opendir my $dir, $path) {
399 my @files = ( readdir $dir);
400 foreach my $file ( @files) {
401 next if (($file eq '.') || ($file eq '..'));
402 $file = Encode::decode('utf-8', $file);
404 next if ( -d "$path/$file" );
406 my $tmppath = File::Spec->catfile( $path, $file );
407 next if( ! -f $tmppath );
409 my $st = stat($tmppath);
410 my $dt = DateTime->from_epoch( epoch => $st->mtime, time_zone => $timezone, locale => $language );
411 my $sname = $main::locale->quote_special_chars('HTML', $file);
414 'filename' => $sname,
416 'mtime' => $st->mtime,
417 'date' => $dt->dmy('.') . " " . $dt->hms,
426 my ($self, $template, $edit, $scanner, $json) = @_;
429 ##TODO make code configurable
432 my @sources = $self->_get_sources();
433 foreach my $source ( @sources ) {
434 @{$source->{files}} = grep { $_->source eq $source->{name}} @{ $self->files };
436 if ( $self->file_type eq 'document' ) {
437 $title = $main::locale->text('Documents');
438 } elsif ( $self->file_type eq 'attachment' ) {
439 $title = $main::locale->text('Attachments');
440 } elsif ( $self->file_type eq 'image' ) {
441 $title = $main::locale->text('Images');
444 my $output = SL::Presenter->get->render(
447 SOURCES => \@sources,
448 edit_attachments => $edit,
449 object_type => $self->object_type,
450 object_id => $self->object_id,
451 file_type => $self->file_type,
452 is_global => $self->is_global,
456 $self->js->html('#'.$self->file_type.'_list_'.$self->object_type, $output);
457 if ( $self->existing && scalar(@{$self->existing}) > 0) {
458 my $first = shift @{$self->existing};
459 my ($first_id, $sfile) = split('_', $first, 2);
460 my $file = SL::File->get(id => $first_id );
461 $self->js->run('kivi.File.askForRename', $first_id, $file->file_name, $sfile, join (',', @{$self->existing}), $self->is_global);
465 $self->render(\$output, { layout => 0, process => 0 });
470 $self->js->flash( 'error', t8('internal error (see details)'))
471 ->flash_detail('error', $@)->render;
473 $self->render('generic/error', { layout => 0 }, label_error => $@);
482 if ( $self->file_type eq 'document' ) {
483 # TODO statt gen neue attribute in filetypes :
484 if (($file_types{$self->object_type}->{gen}*1 & 1)==1) {
487 'title' => $main::locale->text('generated Files'),
488 'chk_action' => 'documents_delete',
489 'chk_title' => $main::locale->text('Delete Documents'),
490 'chkall_title' => $main::locale->text('Delete all'),
491 'file_title' => $main::locale->text('filename'),
492 'confirm_text' => $main::locale->text('delete'),
494 'rename_title' => $main::locale->text('Rename Documents'),
495 'done_text' => $main::locale->text('deleted')
497 push @sources , $gendata;
499 if (($file_types{$self->object_type}->{gen}*1 & 2)==2) {
500 my @others = SL::File->get_other_sources();
501 foreach my $scanner_or_mailrx (@others) {
503 'name' => $scanner_or_mailrx->{name},
504 'title' => $main::locale->text('from \'#1\' imported Files', $scanner_or_mailrx->{description}),
505 'chk_action' => $scanner_or_mailrx->{name}.'_unimport',
506 'chk_title' => $main::locale->text('Unimport documents'),
507 'chkall_title' => $main::locale->text('Unimport all'),
508 'file_title' => $main::locale->text('filename'),
509 'confirm_text' => $main::locale->text('unimport'),
511 'rename_title' => $main::locale->text('Rename Documents'),
513 'import_title' => $main::locale->text('Add Document from \'#1\'', $scanner_or_mailrx->{name}),
514 'path' => $scanner_or_mailrx->{directory},
515 'done_text' => $main::locale->text('unimported')
517 push @sources , $other;
521 elsif ( $self->file_type eq 'attachment' ) {
523 'name' => 'uploaded',
524 'title' => $main::locale->text(''),
525 'chk_action' => 'attachments_delete',
526 'chk_title' => $main::locale->text('Delete Attachments'),
527 'chkall_title' => $main::locale->text('Delete all'),
528 'file_title' => $main::locale->text('filename'),
529 'confirm_text' => $main::locale->text('delete'),
531 'are_existing' => $self->existing ? 1 : 0,
532 'rename_title' => $main::locale->text('Rename Attachments'),
534 'upload_title' => $main::locale->text('Upload Attachments'),
535 'done_text' => $main::locale->text('deleted')
537 push @sources , $attdata;
539 elsif ( $self->file_type eq 'image' ) {
541 'name' => 'uploaded',
542 'title' => $main::locale->text(''),
543 'chk_action' => 'images_delete',
544 'chk_title' => $main::locale->text('Delete Images'),
545 'chkall_title' => $main::locale->text('Delete all'),
546 'file_title' => $main::locale->text('filename'),
547 'confirm_text' => $main::locale->text('delete'),
549 'are_existing' => $self->existing ? 1 : 0,
550 'rename_title' => $main::locale->text('Rename Images'),
552 'upload_title' => $main::locale->text('Upload Images'),
553 'done_text' => $main::locale->text('deleted')
555 push @sources , $attdata;
570 SL::Controller::File - Controller for managing files
574 The Controller is called directly from the webpages
576 <a href="controller.pl?action=File/list&file_type=document\
577 &object_type=[% HTML.escape(type) %]&object_id=[% HTML.url(id) %]">
580 or indirectly via javascript functions from js/kivi.File.js
582 kivi.popup_dialog({ url: 'controller.pl',
583 data: { action : 'File/ajax_upload',
584 file_type : 'uploaded',
592 This is a controller for handling files in a storage independent way.
593 The storage may be a Filesystem,a WebDAV, a Database or DMS.
594 These backends must be configered in ClientConfig.
595 This Controller use as intermediate layer for storage C<SL::File>.
597 The Controller is responsible to display forms for displaying the files at the ERP-objects and
598 for uploading and downloading the files.
600 More description of the intermediate layer see L<SL::File>.
604 =head2 C<action_list>
606 This loads a list of files on a webpage. This can be done with a normal submit or via an ajax/json call.
607 Dependent of file_type different sources are available.
609 For documents there are the 'created' source and the imports from scanners or email.
610 For attachments and images only the 'uploaded' source available.
612 Available C<FORM PARAMS>:
616 =item C<form.object_id>
618 The Id of the ERP-object.
620 =item C<form.object_type>
622 The Type of the ERP-object like "sales_quotation". A clear mapping to the class/model exists in the controller.
624 =item C<form.file_type>
626 For one ERP-object may exists different type of documents the type may be "documents","attachments" or "images".
627 This file_type is a filter for the list.
631 The method can be used as normal HTTP-Request (json=0) or as AJAX-JSON call to refresh the list if the parameter is set to 1.
636 =head2 C<action_ajax_upload>
639 A new file or more files can selected by a dialog and insert into the system.
642 Available C<FORM PARAMS>:
646 =item C<form.file_type>
648 This parameter describe here the source for a new file :
649 "attachments" and "images"
651 This is a normal upload selection, which may be more then one file to upload.
653 =item C<form.object_id>
657 =item C<form.object_type>
659 are the same as at C<action_list>
663 =head2 C<action_ajax_files_uploaded>
665 The Upload of selected Files. The "multipart_formdata" is parsed in SL::Request into the formsvariable "form.ATTACHMENTS".
666 The filepaths are checked about Unix and Windows paths. Also the MIME type of the files are verified ( IS the contents of a *.pdf real PDF?).
667 If the same filename still exists at this object after the download for each existing filename a rename dialog will be opened.
669 If the filename is not changed the new uploaded file is a new version of the file, if the name is changed it is a new file.
671 Available C<FORM PARAMS>:
675 =item C<form.ATTACHMENTS.uploadfiles>
677 This is an array of elements which have {filename} for the name and {data} for the contents.
679 Also object_id, object_type and file_type
683 =head2 C<action_download>
685 This is the real download of a file normally called via javascript "$.download("controller.pl", data);"
687 Available C<FORM PARAMS>:
691 Also object_id, object_type and file_type
695 =head2 C<action_ajax_importdialog>
697 A Dialog with all available and not imported files to import is open.
698 More then one file can be selected.
700 Available C<FORM PARAMS>:
706 The name of the source like "scanner1" or "email"
710 The full path to the directory on the server, where the files to import can found
712 Also object_id, object_type and file_type
716 =head2 C<action_ajax_delete>
718 Some files can be deleted
720 Available C<FORM PARAMS>:
726 The ids of the files to delete. Only this files are deleted not all versions of a file if the exists
730 =head2 C<action_ajax_unimport>
732 Some files can be unimported, dependent of the source of the file. This means they are moved
733 back to the directory of the source
735 Available C<FORM PARAMS>:
741 The ids of the files to unimport. Only these files are unimported not all versions of a file if the exists
745 =head2 C<action_ajax_rename>
747 One file can be renamed. There can be some checks if the same filename still exists at one object.
751 Martin Helmling E<lt>martin.helmling@opendynamic.deE<gt>