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;
39 use Rose::Object::MakeMethods::Generic
41 'scalar --get_set_init' => [ qw() ],
42 'scalar' => [ qw(object object_type object_model object_id object_right file_type files is_global existing) ],
45 __PACKAGE__->run_before('check_object_params', only => [ qw(list ajax_delete ajax_importdialog ajax_import ajax_unimport ajax_upload ajax_files_uploaded) ]);
48 'sales_quotation' => { gen => 1 ,gltype => '', dir =>'SalesQuotation', model => 'Order', right => 'import_ar' },
49 'sales_order' => { gen => 1 ,gltype => '', dir =>'SalesOrder', model => 'Order', right => 'import_ar' },
50 'sales_delivery_order' => { gen => 1 ,gltype => '', dir =>'SalesDeliveryOrder', model => 'DeliveryOrder', right => 'import_ar' },
51 'invoice' => { gen => 1 ,gltype => 'ar', dir =>'SalesInvoice', model => 'Invoice', right => 'import_ar' },
52 'credit_note' => { gen => 1 ,gltype => '', dir =>'CreditNote', model => 'Invoice', right => 'import_ar' },
53 'request_quotation' => { gen => 3 ,gltype => '', dir =>'RequestForQuotation', model => 'Order', right => 'import_ap' },
54 'purchase_order' => { gen => 3 ,gltype => '', dir =>'PurchaseOrder', model => 'Order', right => 'import_ap' },
55 'purchase_delivery_order' => { gen => 3 ,gltype => '', dir =>'PurchaseDeliveryOrder',model => 'DeliveryOrder', right => 'import_ap' },
56 'purchase_invoice' => { gen => 2 ,gltype => 'ap', dir =>'PurchaseInvoice', model => 'PurchaseInvoice',right => 'import_ap' },
57 'vendor' => { gen => 0 ,gltype => '', dir =>'Vendor', model => 'Vendor', right => 'xx' },
58 'customer' => { gen => 1 ,gltype => '', dir =>'Customer', model => 'Customer', right => 'xx' },
59 'part' => { gen => 0 ,gltype => '', dir =>'Part', model => 'Part', right => 'xx' },
60 'gl_transaction' => { gen => 2 ,gltype => 'gl', dir =>'GeneralLedger', model => 'GLTransaction', right => 'import_ap' },
61 'draft' => { gen => 0 ,gltype => '', dir =>'Draft', model => 'Draft', right => 'xx' },
62 'csv_customer' => { gen => 1 ,gltype => '', dir =>'Reports', model => 'Customer', right => 'xx' },
63 'csv_vendor' => { gen => 1 ,gltype => '', dir =>'Reports', model => 'Vendor', right => 'xx' },
67 # $main::locale->text('imported')
77 $isjson = 1 if $::form->{json};
79 $self->_do_list($isjson);
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 same attributes as 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 $res = $file->rename($::form->{to});
179 $self->js->flash( 'error', t8('internal error (see details)'))
180 ->flash_detail('error', $@)->render;
184 if ($res != SL::File::RENAME_OK) {
185 $self->js->flash('error',
186 $res == SL::File::RENAME_EXISTS ? $::locale->text('File still exists !')
187 : $res == 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 is really no 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 ## two possibilities: what is better ? content or sessionfile ??
268 #file_contents => ${$upfiles[$idx]->{data}},
269 file_path => $sfile->file_name
271 unlink($sfile->file_name);
275 $self->js->flash( 'error', t8('internal error (see details)'))
276 ->flash_detail('error', $@)->render;
281 $self->existing(\@existing);
285 sub action_download {
287 my ($id,$version) = split /_/, $::form->{id};
288 my $file = SL::File->get(id => $id );
289 $file->version($version) if $version;
290 my $ref = $file->get_content;
291 if ( $file && $ref ) {
292 return $self->send_file($ref,
293 type => $file->mime_type,
294 name => $file->file_name,
303 sub check_object_params {
306 my $id = ($::form->{object_id} // 0) * 1;
307 my $draftid = ($::form->{draft_id} // 0) * 1;
311 if ( $draftid == 0 && $id == 0 && $::form->{is_global} ) {
313 $type = $::form->{object_type};
316 $id = $::form->{draft_id};
318 } elsif ( $::form->{object_type} ) {
319 $type = $::form->{object_type};
321 die "No object type" if ! $type;
322 die "No file type" if ! $::form->{file_type};
323 die "Unkown object type" if ! $file_types{$type};
325 $self->is_global($gldoc);
326 $self->file_type($::form->{file_type});
327 $self->object_type($type);
328 $self->object_id($id);
329 $self->object_model($file_types{$type}->{model});
330 $self->object_right($file_types{$type}->{right});
332 # $::auth->assert($self->object_right);
334 # my $model = 'SL::DB::' . $self->object_model;
335 # $self->object($model->new(id => $self->object_id)->load || die "Record not found");
345 my ($self,$do_unimport,$infotext) = @_;
347 my $ids = $::form->{ids};
348 foreach my $id_version (@{ $::form->{$ids} || [] }) {
349 my ($id,$version) = split /_/, $id_version;
350 my $dbfile = SL::File->get(id => $id);
351 $dbfile->version($version) if $dbfile && $version;
352 if ( $dbfile && $dbfile->delete ) {
353 $files .= ' '.$dbfile->file_name;
356 $self->js->flash('info',$infotext.$files) if $files;
361 my ($self,$json) = @_;
363 if ( $self->file_type eq 'document' ) {
365 push @object_types, $self->object_type;
366 push @object_types, ('dunning','dunning1','dunning2','dunning3') if $self->object_type eq 'invoice';
367 @files = SL::File->get_all_versions(object_id => $self->object_id ,
368 object_type => \@object_types,
369 file_type => $self->file_type );
372 elsif ( $self->file_type eq 'attachment' || $self->file_type eq 'image' ) {
373 @files = SL::File->get_all(object_id => $self->object_id ,
374 object_type => $self->object_type,
375 file_type => $self->file_type );
377 $self->files(\@files);
378 $self->_mk_render('file/list',1,0,$json);
381 sub _get_from_import {
382 my ($self,$path) = @_;
385 my $language = $::lx_office_conf{system}->{language};
386 my $timezone = $::locale->get_local_time_zone()->name;
387 if (opendir my $dir, $path) {
388 my @files = ( readdir $dir);
389 foreach my $file ( @files) {
390 next if (($file eq '.') || ($file eq '..'));
391 $file = Encode::decode('utf-8', $file);
393 next if( -d "$path/$file");
395 my $tmppath = File::Spec->catfile( $path, $file );
396 next if( ! -f $tmppath);
398 my $st = stat($tmppath);
399 my $dt = DateTime->from_epoch( epoch => $st->mtime, time_zone => $timezone, locale => $language);
400 my $sname = $main::locale->quote_special_chars('HTML',$file);
403 'filename' => $sname,
405 'mtime' => $st->mtime,
406 'date' => $dt->dmy('.')." ".$dt->hms,
415 my ($self,$template,$edit,$scanner,$json) = @_;
418 ##TODO here a configurable code must be implemented
421 my @sources = $self->_get_sources();
422 foreach my $source ( @sources ) {
423 @{$source->{files}} = grep { $_->source eq $source->{name}} @{ $self->files };
425 if ( $self->file_type eq 'document' ) {
426 $title = $main::locale->text('Documents');
427 } elsif ( $self->file_type eq 'attachment' ) {
428 $title = $main::locale->text('Attachments');
429 } elsif ( $self->file_type eq 'image' ) {
430 $title = $main::locale->text('Images');
433 my $output = SL::Presenter->get->render(
436 SOURCES => \@sources,
437 edit_attachments => $edit,
438 object_type => $self->object_type,
439 object_id => $self->object_id,
440 file_type => $self->file_type,
441 is_global => $self->is_global,
445 $self->js->html('#'.$self->file_type.'_list_'.$self->object_type, $output);
446 if ( $self->existing && scalar(@{$self->existing}) > 0) {
447 my $first = shift @{$self->existing};
448 my ($first_id,$sfile) = split('_',$first,2);
449 my $file = SL::File->get(id => $first_id );
450 $self->js->run('kivi.File.askForRename',$first_id,$file->file_name,$sfile,join (',', @{$self->existing}), $self->is_global);
454 $self->render(\$output, { layout => 0, process => 0 });
459 $self->js->flash( 'error', t8('internal error (see details)'))
460 ->flash_detail('error', $@)->render;
462 $self->render('generic/error', { layout => 0 }, label_error => $@);
471 if ( $self->file_type eq 'document' ) {
472 ##TODO statt gen neue attribute in filetypes :
473 if (($file_types{$self->object_type}->{gen}*1 & 1)==1) {
476 'title' => $main::locale->text('generated Files'),
477 'chk_action' => 'documents_delete',
478 'chk_title' => $main::locale->text('Delete Documents'),
479 'chkall_title' => $main::locale->text('Delete all'),
480 'file_title' => $main::locale->text('filename'),
481 'confirm_text' => $main::locale->text('delete'),
483 'rename_title' => $main::locale->text('Rename Documents'),
484 'done_text' => $main::locale->text('deleted')
486 push @sources , $gendata;
488 if (($file_types{$self->object_type}->{gen}*1 & 2)==2) {
489 my @others = SL::File->get_other_sources();
490 foreach my $scanner_or_mailrx (@others) {
492 'name' => $scanner_or_mailrx->{name},
493 'title' => $main::locale->text('from \'#1\' imported Files',$scanner_or_mailrx->{description}),
494 'chk_action' => $scanner_or_mailrx->{name}.'_unimport',
495 'chk_title' => $main::locale->text('Unimport documents'),
496 'chkall_title' => $main::locale->text('Unimport all'),
497 'file_title' => $main::locale->text('filename'),
498 'confirm_text' => $main::locale->text('unimport'),
500 'rename_title' => $main::locale->text('Rename Documents'),
502 'import_title' => $main::locale->text('Add Document from \'#1\'',$scanner_or_mailrx->{name}),
503 'path' => $scanner_or_mailrx->{directory},
504 'done_text' => $main::locale->text('unimported')
506 push @sources , $other;
510 elsif ( $self->file_type eq 'attachment' ) {
512 'name' => 'uploaded',
513 'title' => $main::locale->text(''),
514 'chk_action' => 'attachments_delete',
515 'chk_title' => $main::locale->text('Delete Attachments'),
516 'chkall_title' => $main::locale->text('Delete all'),
517 'file_title' => $main::locale->text('filename'),
518 'confirm_text' => $main::locale->text('delete'),
520 'are_existing' => $self->existing ? 1 : 0,
521 'rename_title' => $main::locale->text('Rename Attachments'),
523 'upload_title' => $main::locale->text('Upload Attachments'),
524 'done_text' => $main::locale->text('deleted')
526 push @sources , $attdata;
528 elsif ( $self->file_type eq 'image' ) {
530 'name' => 'uploaded',
531 'title' => $main::locale->text(''),
532 'chk_action' => 'images_delete',
533 'chk_title' => $main::locale->text('Delete Images'),
534 'chkall_title' => $main::locale->text('Delete all'),
535 'file_title' => $main::locale->text('filename'),
536 'confirm_text' => $main::locale->text('delete'),
538 'are_existing' => $self->existing ? 1 : 0,
539 'rename_title' => $main::locale->text('Rename Images'),
541 'upload_title' => $main::locale->text('Upload Images'),
542 'done_text' => $main::locale->text('deleted')
544 push @sources , $attdata;
559 SL::Controller::File - Controller for managing files
566 # The Controller is called direct from the webpages
569 <a href="controller.pl?action=File/list&file_type=document\
570 &object_type=[% HTML.escape(type) %]&object_id=[% HTML.url(id) %]">
573 # or indirect via javascript functions from js/kivi.File.js
576 kivi.popup_dialog({ url: 'controller.pl',
577 data: { action : 'File/ajax_upload',
578 file_type : 'uploaded',
589 This is a controller for handling files in a storage independent way.
590 The storage may be a Filesystem,a WebDAV, a Database or DMS.
591 These backends must be configered in ClientConfig.
592 This Controller use as intermediate layer for storage C<SL::File>.
594 The Controller is responsible to display forms for displaying the files at the ERP-objects and
595 for uploading and downloading the files.
597 More description of the intermediate layer see L<SL::File>.
601 =head2 C<action_list>
603 This loads a list of files on a webpage. This can be done with a normal submit or via an ajax/json call.
604 Dependent of file_type different sources are available.
606 For documents there are the 'created' source and the imports from scanners or email.
607 For attachments and images only the 'uploaded' source available.
609 Available C<FORM PARAMS>:
613 =item C<form.object_id>
615 The Id of the ERP-object.
617 =item C<form.object_type>
619 The Type of the ERP-object like "sales_quotation". A clear mapping to the class/model exists in the controller.
621 =item C<form.file_type>
623 For one ERP-object may exists different type of documents the type may be "documents","attachments" or "images".
624 This file_type is a filter for the list.
628 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.
633 =head2 C<action_ajax_upload>
636 A new file or more files can selected by a dialog and insert into the system.
639 Available C<FORM PARAMS>:
643 =item C<form.file_type>
645 This parameter describe here the source for a new file :
646 "attachments" and "images"
648 This is a normal upload selection, which may be more then one file to upload.
650 =item C<form.object_id>
654 =item C<form.object_type>
656 are the same as at C<action_list>
660 =head2 C<action_ajax_files_uploaded>
662 The Upload of selected Files. The "multipart_formdata" is parsed in SL::Request into the formsvariable "form.ATTACHMENTS".
663 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?).
664 If the same filename still exists at this object after the download for each existing filename a rename dialog will be opened.
666 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.
668 Available C<FORM PARAMS>:
672 =item C<form.ATTACHMENTS.uploadfiles>
674 This is an array of elements which have {filename} for the name and {data} for the contents.
676 Also object_id, object_type and file_type
680 =head2 C<action_download>
682 This is the real download of a file normally called via javascript "$.download("controller.pl", data);"
684 Available C<FORM PARAMS>:
688 Also object_id, object_type and file_type
692 =head2 C<action_ajax_importdialog>
694 A Dialog with all available and not imported files to import is open.
695 More then one file can be selected.
697 Available C<FORM PARAMS>:
703 The name of the source like "scanner1" or "email"
707 The full path to the directory on the server, where the files to import can found
709 Also object_id, object_type and file_type
713 =head2 C<action_ajax_delete>
715 Some files can be deleted
717 Available C<FORM PARAMS>:
723 The ids of the files to delete. Only this files are deleted not all versions of a file if the exists
727 =head2 C<action_ajax_unimport>
729 Some files can be unimported, dependent of the source of the file. This means they are moved
730 back to the directory of the source
732 Available C<FORM PARAMS>:
738 The ids of the files to unimport. Only this files are unimported not all versions of a file if the exists
742 =head2 C<action_ajax_rename>
744 One file can be renamed. There can be some checks if the same filename still exists at one object.
749 Martin Helmling E<lt>martin.helmling@opendynamic.deE<gt>