Brieffunktion: Verwendung von HTML im Body
[kivitendo-erp.git] / SL / Controller / CsvImport.pm
index afa4adf..8e46daf 100644 (file)
@@ -6,31 +6,45 @@ use SL::DB::Buchungsgruppe;
 use SL::DB::CsvImportProfile;
 use SL::DB::CsvImportReport;
 use SL::DB::Unit;
+use SL::DB::Helper::Paginated ();
 use SL::Helper::Flash;
+use SL::Locale::String;
 use SL::SessionFile;
 use SL::Controller::CsvImport::Contact;
 use SL::Controller::CsvImport::CustomerVendor;
 use SL::Controller::CsvImport::Part;
+use SL::Controller::CsvImport::Inventory;
 use SL::Controller::CsvImport::Shipto;
 use SL::Controller::CsvImport::Project;
+use SL::Controller::CsvImport::Order;
+use SL::JSON;
+use SL::Controller::CsvImport::BankTransaction;
 use SL::BackgroundJob::CsvImport;
 use SL::System::TaskServer;
 
 use List::MoreUtils qw(none);
+use List::Util qw(min);
 
 use parent qw(SL::Controller::Base);
 
 use Rose::Object::MakeMethods::Generic
 (
  scalar                  => [ qw(type profile file all_profiles all_charsets sep_char all_sep_chars quote_char all_quote_chars escape_char all_escape_chars all_buchungsgruppen all_units
-                                 import_status errors headers raw_data_headers info_headers data num_imported num_importable displayable_columns file) ],
- 'scalar --get_set_init' => [ qw(worker) ]
+                                 import_status errors headers raw_data_headers info_headers data num_imported num_importable displayable_columns file all_taxzones) ],
+ 'scalar --get_set_init' => [ qw(worker task_server) ],
+ 'array'                 => [
+   progress_tracker     => { },
+   add_progress_tracker => {  interface => 'add', hash_key => 'progress_tracker' },
+ ],
 );
 
 __PACKAGE__->run_before('check_auth');
 __PACKAGE__->run_before('ensure_form_structure');
 __PACKAGE__->run_before('check_type', except => [ qw(report) ]);
 __PACKAGE__->run_before('load_all_profiles');
+__PACKAGE__->run_before('check_task_server');
+
+__PACKAGE__->run_after('cleanup_reports');
 
 #
 # actions
@@ -81,18 +95,27 @@ sub action_result {
 
   my $data = $self->{background_job}->data_as_hash;
 
-  my $profile = SL::DB::CsvImportProfile->new(type => $data->{type});
-  my $profile_data = $data->{profile};
-  for (keys %$profile_data) {
-    $profile->set($_ => $profile_data->{$_});
-  }
+  my $profile = SL::DB::Manager::CsvImportProfile->find_by(id => $data->{profile_id});
 
   $self->profile($profile);
 
-  if ($data->{progress} < 100) {
-    $self->render('csv_import/_deferred_results', { no_layout => 1 });
+  if ($data->{errors} and my $first_error =  $data->{errors}->[0]) {
+    flash('error', $::locale->text('There was an error parsing the csv file: #1 in line #2: #3', $first_error->[2], $first_error->[0], $first_error->[1]));
+  }
+
+  if ($data->{progress}{finished} || $data->{errors}) {
+    $self->render('csv_import/_deferred_report', { layout => 0 });
   } else {
-   die 'what? done? panic, no idea what to do';
+    if (!$self->task_server->is_running) {
+      $self->task_server->start;
+      $self->{status_text} = t8('Task Server is not running, starting it now. If this does not change, please check your task server config');
+    } elsif (my $phase = $data->{progress}{phase}) {
+      $self->{status_text} = "$data->{progress}{plan}{$phase} / $data->{progress}{num_phases} " . t8($phase);
+    } else {
+      $self->{status_text} = t8('Import not started yet, please wait...');
+    }
+
+    $self->render('csv_import/_deferred_results', { layout => 0 });
   }
 }
 
@@ -106,10 +129,21 @@ sub action_download_sample {
   my $file      = SL::SessionFile->new($file_name, mode => '>', encoding => $self->profile->get('charset'));
   my $csv       = Text::CSV_XS->new({ binary => 1, map { ( $_ => $self->profile->get($_) ) } qw(sep_char escape_char quote_char),});
 
-  $csv->print($file->fh, [ map { $_->{name}        } @{ $self->displayable_columns } ]);
-  $file->fh->print("\r\n");
-  $csv->print($file->fh, [ map { $_->{description} } @{ $self->displayable_columns } ]);
-  $file->fh->print("\r\n");
+  if ($self->worker->is_multiplexed) {
+    foreach my $p (@{ $self->worker->profile }) {
+      $csv->print($file->fh, [ map { $_->{name}        } @{ $self->displayable_columns->{$p->{row_ident}} } ]);
+      $file->fh->print("\r\n");
+    }
+    foreach my $p (@{ $self->worker->profile }) {
+      $csv->print($file->fh, [ map { $_->{description} } @{ $self->displayable_columns->{$p->{row_ident}} } ]);
+      $file->fh->print("\r\n");
+    }
+  } else {
+    $csv->print($file->fh, [ map { $_->{name}        } @{ $self->displayable_columns } ]);
+    $file->fh->print("\r\n");
+    $csv->print($file->fh, [ map { $_->{description} } @{ $self->displayable_columns } ]);
+    $file->fh->print("\r\n");
+  }
 
   $file->fh->close;
 
@@ -119,9 +153,63 @@ sub action_download_sample {
 sub action_report {
   my ($self, %params) = @_;
 
-  $self->{report} = SL::DB::Manager::CsvImportReport->find_by(id => $params{report_id} || $::form->{id});
+  my $report_id = $params{report_id} || $::form->{id};
 
-  $self->render('csv_import/report', { no_layout => $params{no_layout} });
+  $self->{report}      = SL::DB::Manager::CsvImportReport->find_by(id => $report_id);
+
+  if (!$self->{report}) {
+    $::form->error(t8('No report with id #1', $report_id));
+  }
+  my $num_rows         = $self->{report}->numrows;
+  my $num_cols         = SL::DB::Manager::CsvImportReportRow->get_all_count(query => [ csv_import_report_id => $report_id, row => 0 ]);
+
+  # manual paginating, yuck
+  my $page = $::form->{page} || 1;
+  my $pages = {};
+  $pages->{per_page}        = $::form->{per_page} || 20;
+  $pages->{max}             = SL::DB::Helper::Paginated::ceil($num_rows, $pages->{per_page}) || 1;
+  $pages->{page}             = $page < 1 ? 1
+                            : $page > $pages->{max} ? $pages->{max}
+                            : $page;
+  $pages->{common}          = [ grep { $_->{visible} } @{ SL::DB::Helper::Paginated::make_common_pages($pages->{page}, $pages->{max}) } ];
+
+  $self->{report_numheaders} = $self->{report}->numheaders;
+  my $first_row_header = 0;
+  my $last_row_header  = $self->{report_numheaders} - 1;
+  my $first_row_data   = $pages->{per_page} * ($pages->{page}-1) + $self->{report_numheaders};
+  my $last_row_data    = min($pages->{per_page} * $pages->{page}, $num_rows) + $self->{report_numheaders} - 1;
+  $self->{display_rows} = [
+    $first_row_header
+      ..
+    $last_row_header,
+    $first_row_data
+      ..
+    $last_row_data
+  ];
+
+  my @query = (
+    csv_import_report_id => $report_id,
+    or => [
+      and => [
+        row => { ge => $first_row_header },
+        row => { le => $last_row_header },
+      ],
+      and => [
+        row => { ge => $first_row_data },
+        row => { le => $last_row_data },
+      ]
+    ]
+  );
+
+  my $rows             = SL::DB::Manager::CsvImportReportRow->get_all(query => \@query);
+  my $status           = SL::DB::Manager::CsvImportReportStatus->get_all(query => \@query);
+
+  $self->{report_rows}   = $self->{report}->folded_rows(rows => $rows);
+  $self->{report_status} = $self->{report}->folded_status(status => $status);
+  $self->{pages} = $pages;
+  $self->{base_url} = $self->url_for(action => 'report', id => $report_id, no_layout => $params{no_layout} || $::form->{no_layout} );
+
+  $self->render('csv_import/report', { layout => !($params{no_layout} || $::form->{no_layout}) });
 }
 
 
@@ -136,7 +224,7 @@ sub check_auth {
 sub check_type {
   my ($self) = @_;
 
-  die "Invalid CSV import type" if none { $_ eq $::form->{profile}->{type} } qw(parts customers_vendors addresses contacts projects);
+  die "Invalid CSV import type" if none { $_ eq $::form->{profile}->{type} } qw(parts inventories customers_vendors addresses contacts projects orders bank_transactions);
   $self->type($::form->{profile}->{type});
 }
 
@@ -178,9 +266,16 @@ sub render_inputs {
             : $self->type eq 'addresses'         ? $::locale->text('CSV import: shipping addresses')
             : $self->type eq 'contacts'          ? $::locale->text('CSV import: contacts')
             : $self->type eq 'parts'             ? $::locale->text('CSV import: parts and services')
+            : $self->type eq 'inventories'       ? $::locale->text('CSV import: inventories')
             : $self->type eq 'projects'          ? $::locale->text('CSV import: projects')
+            : $self->type eq 'orders'            ? $::locale->text('CSV import: orders')
+            : $self->type eq 'bank_transactions' ? $::locale->text('CSV import: bank transactions')
             : die;
 
+  if ($self->{type} eq 'customers_vendors' or $self->{type} eq 'orders'  ) {
+    $self->all_taxzones(SL::DB::Manager::TaxZone->get_all_sorted(query => [ obsolete => 0 ]));
+  };
+
   if ($self->{type} eq 'parts') {
     $self->all_buchungsgruppen(SL::DB::Manager::Buchungsgruppe->get_all_sorted);
     $self->all_units(SL::DB::Manager::Unit->get_all_sorted);
@@ -194,7 +289,11 @@ sub render_inputs {
 sub test_and_import_deferred {
   my ($self, %params) = @_;
 
-  $self->profile_from_form;
+  if ( $::form->{force_profile} && $::form->{profile}->{id} ) {
+    $self->load_default_profile;
+  }  else {
+    $self->profile_from_form;
+  };
 
   if ($::form->{file}) {
     my $file = SL::SessionFile->new($self->csv_file_name, mode => '>');
@@ -202,54 +301,62 @@ sub test_and_import_deferred {
     $file->fh->close;
   }
 
+  my $file = SL::SessionFile->new($self->csv_file_name, mode => '<', encoding => $self->profile->get('charset'));
+  if (!$file->fh) {
+    flash('error', $::locale->text('No file has been uploaded yet.'));
+    return $self->action_new;
+  }
+
   $self->{background_job} = SL::BackgroundJob::CsvImport->create_job(
-    file    => $self->csv_file_name,
-    profile => $self->profile,
-    type    => $self->profile->type,
+    file        => $self->csv_file_name,
+    profile     => $self->profile,
+    type        => $self->profile->type,
+    test        => $params{test},
+    employee_id => SL::DB::Manager::Employee->current->id,
   )->save;
 
-  SL::System::TaskServer->start_if_not_running;
-  SL::System::TaskServer->wake_up;
+  if ($self->task_server->is_running) {
+    $self->task_server->wake_up;
+  } else {
+    $self->task_server->start;
+  }
 
-  flash('info', $::locale->text('Your import is beig processed.'));
+  flash('info', $::locale->text('Your import is being processed.'));
 
   $self->{deferred} = 1;
 
-  $self->render_inputs;
+  if ($::request->type eq 'json') {
+    $self->render(\ SL::JSON::to_json($self->{background_job}->as_tree), { type => 'json' })
+  } else {
+    $self->render_inputs;
+  }
 }
 
 sub test_and_import {
   my ($self, %params) = @_;
 
-  $self->profile_from_form;
-
-  if ($::form->{file}) {
-    my $file = SL::SessionFile->new($self->csv_file_name, mode => '>');
-    $file->fh->print($::form->{file});
-    $file->fh->close;
-  }
-
-  my $file = SL::SessionFile->new($self->csv_file_name, mode => '<', encoding => $self->profile->get('charset'));
-  if (!$file->fh) {
-    flash('error', $::locale->text('No file has been uploaded yet.'));
-    return $self->action_new;
-  }
+  my $file = SL::SessionFile->new(
+    $self->csv_file_name,
+    mode       => '<',
+    encoding   => $self->profile->get('charset'),
+    session_id => $params{session_id}
+  );
 
   $self->file($file);
 
   my $worker = $self->worker();
 
-  $worker->run;
+  $worker->run(%params);
+
+  return if $self->errors;
 
   $self->num_imported(0);
   $worker->save_objects if !$params{test};
 
-  $self->save_report;
-
   $self->num_importable(scalar grep { !$_ } map { scalar @{ $_->{errors} } } @{ $self->data || [] });
   $self->import_status($params{test} ? 'tested' : 'imported');
 
-  flash('info', $::locale->text('Objects have been imported.')) if !$params{test};
+#  flash('info', $::locale->text('Objects have been imported.')) if !$params{test};
 }
 
 sub load_default_profile {
@@ -263,6 +370,7 @@ sub load_default_profile {
   $profile ||= SL::DB::CsvImportProfile->new(type => $self->{type}, login => $::myconfig{login});
 
   $self->profile($profile);
+  $self->worker->set_profile_defaults;
   $self->profile->set_defaults;
 }
 
@@ -273,6 +381,7 @@ sub load_all_profiles {
     where => [
       type  => $self->type,
       login => $::myconfig{login},
+      '!name'  => '',
     ],
   sort_by => 'name'));
 }
@@ -296,6 +405,10 @@ sub profile_from_form {
     $::form->{settings}->{sellprice_adjustment} = $::form->parse_amount(\%::myconfig, $::form->{settings}->{sellprice_adjustment});
   }
 
+  if ($self->type eq 'orders') {
+    $::form->{settings}->{max_amount_diff} = $::form->parse_amount(\%::myconfig, $::form->{settings}->{max_amount_diff});
+  }
+
   delete $::form->{profile}->{id};
   $self->profile($existing_profile || SL::DB::CsvImportProfile->new(login => $::myconfig{login}));
   $self->profile->assign_attributes(%{ $::form->{profile} });
@@ -320,17 +433,33 @@ sub char_map {
 }
 
 sub save_report {
-  my ($self, $report_id) = @_;
+  my ($self, %params) = @_;
+
+  if ($self->worker->is_multiplexed) {
+    return $self->save_report_multi(%params);
+  } else {
+    return $self->save_report_single(%params);
+  }
+}
+
+sub save_report_single {
+  my ($self, %params) = @_;
+
+  $self->track_progress(phase => 'building report', progress => 0);
 
   my $clone_profile = $self->profile->clone_and_reset_deep;
   $clone_profile->save; # weird bug. if this isn't saved before adding it to the report, it will default back to the last profile.
 
   my $report = SL::DB::CsvImportReport->new(
-    session_id => $::auth->create_or_refresh_session,
+    session_id => $params{session_id},
     profile    => $clone_profile,
     type       => $self->type,
     file       => '',
-  )->save(cascade => 1);
+    numrows    => scalar @{ $self->data },
+    numheaders => 1,
+  );
+
+  $report->save(cascade => 1) or die $report->db->error;
 
   my $dbh = $::form->get_standard_dbh;
   $dbh->begin_work;
@@ -341,19 +470,24 @@ sub save_report {
   my $sth = $dbh->prepare($query);
   my $sth2 = $dbh->prepare($query2);
 
-#  $::lxdebug->dump(0,  "self", $self->info_headers);
-#  $::lxdebug->dump(0,  "self", $self->headers);
-#  $::lxdebug->dump(0,  "self", $self->raw_data_headers);
-
   # save headers
-  my @headers = (
-    grep({ $self->info_headers->{used}->{$_}     } @{ $self->info_headers->{headers} }),
-    grep({ $self->headers->{used}->{$_}          } @{ $self->headers->{headers} }),
-    grep({ $self->raw_data_headers->{used}->{$_} } @{ $self->raw_data_headers->{headers} }),
-  );
-  my @info_methods = grep { $self->info_headers->{used}->{$_}     } @{ $self->info_headers->{headers} };
-  my @methods      = grep { $self->headers->{used}->{$_}          } @{ $self->headers->{methods} };
-  my @raw_methods  = grep { $self->raw_data_headers->{used}->{$_} } @{ $self->raw_data_headers->{headers} };
+  my (@headers, @info_methods, @raw_methods, @methods);
+
+  for my $i (0 .. $#{ $self->info_headers->{headers} }) {
+    next unless         $self->info_headers->{used}->{ $self->info_headers->{methods}->[$i] };
+    push @headers,      $self->info_headers->{headers}->[$i];
+    push @info_methods, $self->info_headers->{methods}->[$i];
+  }
+  for my $i (0 .. $#{ $self->headers->{headers} }) {
+    next unless         $self->headers->{used}->{ $self->headers->{headers}->[$i] };
+    push @headers,      $self->headers->{headers}->[$i];
+    push @methods,      $self->headers->{methods}->[$i];
+  }
+  for my $i (0 .. $#{ $self->raw_data_headers->{headers} }) {
+    next unless         $self->raw_data_headers->{used}->{ $self->raw_data_headers->{headers}->[$i] };
+    push @headers,      $self->raw_data_headers->{headers}->[$i];
+    push @raw_methods,  $self->raw_data_headers->{headers}->[$i];
+  }
 
   $sth->execute($report->id, $_, 0, $headers[$_]) for 0 .. $#headers;
 
@@ -362,6 +496,7 @@ sub save_report {
   my $o2 = $o1 + @methods;
 
   for my $row (0 .. $#{ $self->data }) {
+    $self->track_progress(progress => $row / @{ $self->data } * 100) if $row % 1000 == 0;
     my $data_row = $self->{data}[$row];
 
     $sth->execute($report->id,       $_, $row + 1, $data_row->{info_data}{ $info_methods[$_] }) for 0 .. $#info_methods;
@@ -377,6 +512,98 @@ sub save_report {
   return $report->id;
 }
 
+sub save_report_multi {
+  my ($self, %params) = @_;
+
+  $self->track_progress(phase => 'building report', progress => 0);
+
+  my $clone_profile = $self->profile->clone_and_reset_deep;
+  $clone_profile->save; # weird bug. if this isn't saved before adding it to the report, it will default back to the last profile.
+
+  my $report = SL::DB::CsvImportReport->new(
+    session_id => $params{session_id},
+    profile    => $clone_profile,
+    type       => $self->type,
+    file       => '',
+    numrows    => scalar @{ $self->data },
+    numheaders => scalar @{ $self->worker->profile },
+  );
+
+  $report->save(cascade => 1) or die $report->db->error;
+
+  my $dbh = $::form->get_standard_dbh;
+  $dbh->begin_work;
+
+  my $query  = 'INSERT INTO csv_import_report_rows (csv_import_report_id, col, row, value) VALUES (?, ?, ?, ?)';
+  my $query2 = 'INSERT INTO csv_import_report_status (csv_import_report_id, row, type, value) VALUES (?, ?, ?, ?)';
+
+  my $sth = $dbh->prepare($query);
+  my $sth2 = $dbh->prepare($query2);
+
+  # save headers
+  my ($headers, $info_methods, $raw_methods, $methods);
+
+  for my $i (0 .. $#{ $self->worker->profile }) {
+    my $row_ident = $self->worker->profile->[$i]->{row_ident};
+
+    for my $i (0 .. $#{ $self->info_headers->{$row_ident}->{headers} }) {
+      next unless                            $self->info_headers->{$row_ident}->{used}->{ $self->info_headers->{$row_ident}->{methods}->[$i] };
+      push @{ $headers->{$row_ident} },      $self->info_headers->{$row_ident}->{headers}->[$i];
+      push @{ $info_methods->{$row_ident} }, $self->info_headers->{$row_ident}->{methods}->[$i];
+    }
+    for my $i (0 .. $#{ $self->headers->{$row_ident}->{headers} }) {
+      next unless                       $self->headers->{$row_ident}->{used}->{ $self->headers->{$row_ident}->{headers}->[$i] };
+      push @{ $headers->{$row_ident} }, $self->headers->{$row_ident}->{headers}->[$i];
+      push @{ $methods->{$row_ident} }, $self->headers->{$row_ident}->{methods}->[$i];
+    }
+
+    for my $i (0 .. $#{ $self->raw_data_headers->{$row_ident}->{headers} }) {
+    next unless                           $self->raw_data_headers->{$row_ident}->{used}->{ $self->raw_data_headers->{$row_ident}->{headers}->[$i] };
+    push @{ $headers->{$row_ident} },     $self->raw_data_headers->{$row_ident}->{headers}->[$i];
+    push @{ $raw_methods->{$row_ident} }, $self->raw_data_headers->{$row_ident}->{headers}->[$i];
+  }
+
+  }
+
+  for my $i (0 .. $#{ $self->worker->profile }) {
+    my $row_ident = $self->worker->profile->[$i]->{row_ident};
+    $sth->execute($report->id, $_, $i, $headers->{$row_ident}->[$_]) for 0 .. $#{ $headers->{$row_ident} };
+  }
+
+  # col offsets
+  my ($off1, $off2);
+  for my $i (0 .. $#{ $self->worker->profile }) {
+    my $row_ident = $self->worker->profile->[$i]->{row_ident};
+    my $n_info_methods = $info_methods->{$row_ident} ? scalar @{ $info_methods->{$row_ident} } : 0;
+    my $n_methods      = $methods->{$row_ident} ?      scalar @{ $methods->{$row_ident} }      : 0;
+
+    $off1->{$row_ident} = $n_info_methods;
+    $off2->{$row_ident} = $off1->{$row_ident} + $n_methods;
+  }
+
+  my $n_header_rows = scalar @{ $self->worker->profile };
+
+  for my $row (0 .. $#{ $self->data }) {
+    $self->track_progress(progress => $row / @{ $self->data } * 100) if $row % 1000 == 0;
+    my $data_row = $self->{data}[$row];
+    my $row_ident = $data_row->{raw_data}{datatype};
+
+    my $o1 = $off1->{$row_ident};
+    my $o2 = $off2->{$row_ident};
+
+    $sth->execute($report->id,       $_, $row + $n_header_rows, $data_row->{info_data}{ $info_methods->{$row_ident}->[$_] }) for 0 .. $#{ $info_methods->{$row_ident} };
+    $sth->execute($report->id, $o1 + $_, $row + $n_header_rows, $data_row->{object}->${ \ $methods->{$row_ident}->[$_] })    for 0 .. $#{ $methods->{$row_ident} };
+    $sth->execute($report->id, $o2 + $_, $row + $n_header_rows, $data_row->{raw_data}{ $raw_methods->{$row_ident}->[$_] })   for 0 .. $#{ $raw_methods->{$row_ident} };
+
+    $sth2->execute($report->id, $row + $n_header_rows, 'information', $_) for @{ $data_row->{information} || [] };
+    $sth2->execute($report->id, $row + $n_header_rows, 'errors', $_)      for @{ $data_row->{errors}      || [] };
+  }
+
+  $dbh->commit;
+
+  return $report->id;
+}
+
 sub csv_file_name {
   my ($self) = @_;
   return "csv-import-" . $self->type . ".csv";
@@ -395,7 +622,10 @@ sub init_worker {
        : $self->{type} eq 'contacts'          ? SL::Controller::CsvImport::Contact->new(@args)
        : $self->{type} eq 'addresses'         ? SL::Controller::CsvImport::Shipto->new(@args)
        : $self->{type} eq 'parts'             ? SL::Controller::CsvImport::Part->new(@args)
+       : $self->{type} eq 'inventories'       ? SL::Controller::CsvImport::Inventory->new(@args)
        : $self->{type} eq 'projects'          ? SL::Controller::CsvImport::Project->new(@args)
+       : $self->{type} eq 'orders'            ? SL::Controller::CsvImport::Order->new(@args)
+       : $self->{type} eq 'bank_transactions' ? SL::Controller::CsvImport::BankTransaction->new(@args)
        :                                        die "Program logic error";
 }
 
@@ -405,5 +635,28 @@ sub setup_help {
   $self->worker->setup_displayable_columns;
 }
 
+sub track_progress {
+  my ($self, %params) = @_;
+
+  for my $tracker ($self->progress_tracker) {
+    $tracker->track_progress(%params);
+  }
+}
+
+sub init_task_server {
+  SL::System::TaskServer->new;
+}
+
+sub cleanup_reports {
+  SL::DB::Manager::CsvImportReport->cleanup;
+}
+
+sub check_task_server {
+  return 1 if $_[0]->task_server->is_running;
+
+  flash('info', t8('The task server is not running at the moment but needed for this module'));
+
+  1;
+}
 
 1;