Merge branch 'gewicht'
[kivitendo-erp.git] / SL / Controller / CsvImport.pm
index cb54de9..c509e21 100644 (file)
@@ -6,15 +6,20 @@ 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::Shipto;
 use SL::Controller::CsvImport::Project;
+use SL::BackgroundJob::CsvImport;
+use SL::System::TaskServer;
 
 use List::MoreUtils qw(none);
+use List::Util qw(min);
 
 use parent qw(SL::Controller::Base);
 
@@ -22,13 +27,20 @@ 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) ]
+ '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
@@ -43,12 +55,12 @@ sub action_new {
 
 sub action_test {
   my ($self) = @_;
-  $self->test_and_import(test => 1);
+  $self->test_and_import_deferred(test => 1);
 }
 
 sub action_import {
   my $self = shift;
-  $self->test_and_import(test => 0);
+  $self->test_and_import_deferred(test => 0);
 }
 
 sub action_save {
@@ -71,6 +83,38 @@ sub action_destroy {
   $self->redirect_to(action => 'new', 'profile.type' => $self->type);
 }
 
+sub action_result {
+  my $self = shift;
+
+  # load resultobject
+  $self->{background_job} = SL::DB::Manager::BackgroundJob->find_by(id => $::form->{job});
+
+  my $data = $self->{background_job}->data_as_hash;
+
+  my $profile = SL::DB::Manager::CsvImportProfile->find_by(id => $data->{profile_id});
+
+  $self->profile($profile);
+
+  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.', $first_error->[2], $first_error->[0]));
+  }
+
+  if ($data->{progress}{finished} || $data->{errors}) {
+    $self->render('csv_import/_deferred_report', { layout => 0 });
+  } else {
+    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 });
+  }
+}
+
 sub action_download_sample {
   my $self = shift;
 
@@ -91,6 +135,59 @@ sub action_download_sample {
   $self->send_file($file->file_name, name => $file_name);
 }
 
+sub action_report {
+  my ($self, %params) = @_;
+
+  my $report_id = $params{report_id} || $::form->{id};
+
+  $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->{cur}             = $page < 1 ? 1
+                            : $page > $pages->{max} ? $pages->{max}
+                            : $page;
+  $pages->{common}          = [ grep { $_->{visible} } @{ SL::DB::Helper::Paginated::make_common_pages($pages->{cur}, $pages->{max}) } ];
+
+  $self->{display_rows} = [
+    0,
+    $pages->{per_page} * ($pages->{cur}-1) + 1
+      ..
+    min($pages->{per_page} * $pages->{cur}, $num_rows)
+  ];
+
+  my @query = (
+    csv_import_report_id => $report_id,
+    or => [
+      row => 0,
+      and => [
+        row => { gt => $pages->{per_page} * ($pages->{cur}-1) },
+        row => { le => $pages->{per_page} * $pages->{cur} },
+      ]
+    ]
+  );
+
+  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}) });
+}
+
+
 #
 # filters
 #
@@ -157,7 +254,7 @@ sub render_inputs {
   $self->render('csv_import/form', title => $title);
 }
 
-sub test_and_import {
+sub test_and_import_deferred {
   my ($self, %params) = @_;
 
   $self->profile_from_form;
@@ -174,23 +271,51 @@ sub test_and_import {
     return $self->action_new;
   }
 
+  $self->{background_job} = SL::BackgroundJob::CsvImport->create_job(
+    file    => $self->csv_file_name,
+    profile => $self->profile,
+    type    => $self->profile->type,
+    test    => $params{test},
+  )->save;
+
+  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.'));
+
+  $self->{deferred} = 1;
+
+  $self->render_inputs;
+}
+
+sub test_and_import {
+  my ($self, %params) = @_;
+
+  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};
-
-  $self->action_new;
+#  flash('info', $::locale->text('Objects have been imported.')) if !$params{test};
 }
 
 sub load_default_profile {
@@ -263,6 +388,8 @@ sub char_map {
 sub save_report {
   my ($self, $report_id) = @_;
 
+  $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.
 
@@ -271,7 +398,10 @@ sub save_report {
     profile    => $clone_profile,
     type       => $self->type,
     file       => '',
-  )->save(cascade => 1);
+    numrows    => scalar @{ $self->data },
+  );
+
+  $report->save(cascade => 1) or die $report->db->error;
 
   my $dbh = $::form->get_standard_dbh;
   $dbh->begin_work;
@@ -282,19 +412,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;
 
@@ -303,6 +438,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;
@@ -314,14 +450,8 @@ sub save_report {
   }
 
   $dbh->commit;
-}
-
-sub action_report {
-  my ($self) = @_;
-
-  $self->{report} = SL::DB::Manager::CsvImportReport->find_by(id => $::form->{id});
 
-  $self->render('csv_import/report');
+  return $report->id;
 }
 
 sub csv_file_name {
@@ -352,5 +482,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;