SL/Controller/CsvImport.pm

   1 package SL::Controller::CsvImport;
   2
   3 use strict;
   4
   5 use SL::DB::Buchungsgruppe;
   6 use SL::DB::CsvImportProfile;
   7 use SL::DB::CsvImportReport;
   8 use SL::DB::Unit;
   9 use SL::DB::Helper::Paginated ();
  10 use SL::Helper::Flash;
  11 use SL::Locale::String;
  12 use SL::SessionFile;
  13 use SL::Controller::CsvImport::Contact;
  14 use SL::Controller::CsvImport::CustomerVendor;
  15 use SL::Controller::CsvImport::Part;
  16 use SL::Controller::CsvImport::Shipto;
  17 use SL::Controller::CsvImport::Project;
  18 use SL::BackgroundJob::CsvImport;
  19 use SL::System::TaskServer;
  20
  21 use List::MoreUtils qw(none);
  22 use List::Util qw(min);
  23
  24 use parent qw(SL::Controller::Base);
  25
  26 use Rose::Object::MakeMethods::Generic
  27 (
  28  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
  29                                  import_status errors headers raw_data_headers info_headers data num_imported num_importable displayable_columns file) ],
  30  'scalar --get_set_init' => [ qw(worker task_server) ],
  31  'array'                 => [
  32    progress_tracker     => { },
  33    add_progress_tracker => {  interface => 'add', hash_key => 'progress_tracker' },
  34  ],
  35 );
  36
  37 __PACKAGE__->run_before('check_auth');
  38 __PACKAGE__->run_before('ensure_form_structure');
  39 __PACKAGE__->run_before('check_type', except => [ qw(report) ]);
  40 __PACKAGE__->run_before('load_all_profiles');
  41
  42 __PACKAGE__->run_after('cleanup_reports');
  43
  44 #
  45 # actions
  46 #
  47
  48 sub action_new {
  49   my ($self) = @_;
  50
  51   $self->load_default_profile unless $self->profile;
  52   $self->render_inputs;
  53 }
  54
  55 sub action_test {
  56   my ($self) = @_;
  57   $self->test_and_import_deferred(test => 1);
  58 }
  59
  60 sub action_import {
  61   my $self = shift;
  62   $self->test_and_import_deferred(test => 0);
  63 }
  64
  65 sub action_save {
  66   my ($self) = @_;
  67
  68   $self->profile_from_form(SL::DB::Manager::CsvImportProfile->find_by(name => $::form->{profile}->{name}, login => $::myconfig{login}));
  69   $self->profile->save;
  70
  71   flash_later('info', $::locale->text("The profile has been saved under the name '#1'.", $self->profile->name));
  72   $self->redirect_to(action => 'new', 'profile.type' => $self->type, 'profile.id' => $self->profile->id);
  73 }
  74
  75 sub action_destroy {
  76   my $self = shift;
  77
  78   my $profile = SL::DB::CsvImportProfile->new(id => $::form->{profile}->{id}, login => $::myconfig{login});
  79   $profile->delete(cascade => 1);
  80
  81   flash_later('info', $::locale->text('The profile \'#1\' has been deleted.', $profile->name));
  82   $self->redirect_to(action => 'new', 'profile.type' => $self->type);
  83 }
  84
  85 sub action_result {
  86   my $self = shift;
  87
  88   # load resultobject
  89   $self->{background_job} = SL::DB::Manager::BackgroundJob->find_by(id => $::form->{job});
  90
  91   my $data = $self->{background_job}->data_as_hash;
  92
  93   my $profile = SL::DB::Manager::CsvImportProfile->find_by(id => $data->{profile_id});
  94
  95   $self->profile($profile);
  96
  97   if ($data->{errors} and my $first_error =  $data->{errors}->[0]) {
  98     flash('error', $::locale->text('There was an error parsing the csv file: #1 in line #2.', $first_error->[2], $first_error->[0]));
  99   }
 100
 101   if ($data->{progress}{finished} || $data->{errors}) {
 102     $self->render('csv_import/_deferred_report', { no_layout => 1 });
 103   } else {
 104     if (!$self->task_server->is_running) {
 105       $self->task_server->start;
 106       $self->{status_text} = t8('Task Server is not running, starting it now. If this does not change, please check your task server config');
 107     } elsif (my $phase = $data->{progress}{phase}) {
 108       $self->{status_text} = "$data->{progress}{plan}{$phase} / $data->{progress}{num_phases} " . t8($phase);
 109     } else {
 110       $self->{status_text} = t8('Import not started yet, please wait...');
 111     }
 112
 113     $self->render('csv_import/_deferred_results', { no_layout => 1 });
 114   }
 115 }
 116
 117 sub action_download_sample {
 118   my $self = shift;
 119
 120   $self->profile_from_form;
 121   $self->setup_help;
 122
 123   my $file_name = 'csv_import_sample_' . $self->type . '.csv';
 124   my $file      = SL::SessionFile->new($file_name, mode => '>', encoding => $self->profile->get('charset'));
 125   my $csv       = Text::CSV_XS->new({ binary => 1, map { ( $_ => $self->profile->get($_) ) } qw(sep_char escape_char quote_char),});
 126
 127   $csv->print($file->fh, [ map { $_->{name}        } @{ $self->displayable_columns } ]);
 128   $file->fh->print("\r\n");
 129   $csv->print($file->fh, [ map { $_->{description} } @{ $self->displayable_columns } ]);
 130   $file->fh->print("\r\n");
 131
 132   $file->fh->close;
 133
 134   $self->send_file($file->file_name, name => $file_name);
 135 }
 136
 137 sub action_report {
 138   my ($self, %params) = @_;
 139
 140   my $report_id = $params{report_id} || $::form->{id};
 141
 142   $self->{report}      = SL::DB::Manager::CsvImportReport->find_by(id => $report_id);
 143
 144   if (!$self->{report}) {
 145     $::form->error(t8('No report with id #1', $report_id));
 146   }
 147   my $num_rows         = $self->{report}->numrows;
 148   my $num_cols         = SL::DB::Manager::CsvImportReportRow->get_all_count(query => [ csv_import_report_id => $report_id, row => 0 ]);
 149
 150   # manual paginating, yuck
 151   my $page = $::form->{page} || 1;
 152   my $pages = {};
 153   $pages->{per_page}        = $::form->{per_page} || 20;
 154   $pages->{max}             = SL::DB::Helper::Paginated::ceil($num_rows / ($num_cols || 1), $pages->{per_page}) || 1;
 155   $pages->{cur}             = $page < 1 ? 1
 156                             : $page > $pages->{max} ? $pages->{max}
 157                             : $page;
 158   $pages->{common}          = [ grep { $_->{visible} } @{ SL::DB::Helper::Paginated::make_common_pages($pages->{cur}, $pages->{max}) } ];
 159
 160   $self->{display_rows} = [
 161     0,
 162     $pages->{per_page} * ($pages->{cur}-1) + 1
 163       ..
 164     min($pages->{per_page} * $pages->{cur}, $num_rows / ($num_cols || 1) - 1)
 165   ];
 166
 167   my @query = (
 168     csv_import_report_id => $report_id,
 169     or => [
 170       row => 0,
 171       and => [
 172         row => { gt => $pages->{per_page} * ($pages->{cur}-1) },
 173         row => { le => $pages->{per_page} * $pages->{cur} },
 174       ]
 175     ]
 176   );
 177
 178   my $rows             = SL::DB::Manager::CsvImportReportRow->get_all(query => \@query);
 179   my $status           = SL::DB::Manager::CsvImportReportStatus->get_all(query => \@query);
 180
 181   $self->{report_rows}   = $self->{report}->folded_rows(rows => $rows);
 182   $self->{report_status} = $self->{report}->folded_status(status => $status);
 183   $self->{pages} = $pages;
 184   $self->{base_url} = $self->url_for(action => 'report', id => $report_id, no_layout => $params{no_layout} || $::form->{no_layout} );
 185
 186   $self->render('csv_import/report', { no_layout => $params{no_layout} || $::form->{no_layout} });
 187 }
 188
 189
 190 #
 191 # filters
 192 #
 193
 194 sub check_auth {
 195   $::auth->assert('config');
 196 }
 197
 198 sub check_type {
 199   my ($self) = @_;
 200
 201   die "Invalid CSV import type" if none { $_ eq $::form->{profile}->{type} } qw(parts customers_vendors addresses contacts projects);
 202   $self->type($::form->{profile}->{type});
 203 }
 204
 205 sub ensure_form_structure {
 206   my ($self, %params) = @_;
 207
 208   $::form->{profile}  = {} unless ref $::form->{profile}  eq 'HASH';
 209   $::form->{settings} = {} unless ref $::form->{settings} eq 'HASH';
 210 }
 211
 212 #
 213 # helpers
 214 #
 215
 216 sub render_inputs {
 217   my ($self, %params) = @_;
 218
 219   $self->all_charsets([ [ 'UTF-8',       'UTF-8'                 ],
 220                         [ 'ISO-8859-1',  'ISO-8859-1 (Latin 1)'  ],
 221                         [ 'ISO-8859-15', 'ISO-8859-15 (Latin 9)' ],
 222                         [ 'CP850',       'CP850 (DOS/ANSI)'      ],
 223                         [ 'CP1252',      'CP1252 (Windows)'      ],
 224                       ]);
 225
 226   my %char_map = $self->char_map;
 227
 228   foreach my $type (qw(sep quote escape)) {
 229     my $sub = "all_${type}_chars";
 230     $self->$sub([ sort { $a->[0] cmp $b->[0] } values %{ $char_map{$type} } ]);
 231
 232     my $char = $self->profile->get($type . '_char');
 233     $sub     = "${type}_char";
 234     $self->$sub(($char_map{$type}->{$char} || [])->[0] || $char);
 235   }
 236
 237   $self->file(SL::SessionFile->new($self->csv_file_name));
 238
 239   my $title = $self->type eq 'customers_vendors' ? $::locale->text('CSV import: customers and vendors')
 240             : $self->type eq 'addresses'         ? $::locale->text('CSV import: shipping addresses')
 241             : $self->type eq 'contacts'          ? $::locale->text('CSV import: contacts')
 242             : $self->type eq 'parts'             ? $::locale->text('CSV import: parts and services')
 243             : $self->type eq 'projects'          ? $::locale->text('CSV import: projects')
 244             : die;
 245
 246   if ($self->{type} eq 'parts') {
 247     $self->all_buchungsgruppen(SL::DB::Manager::Buchungsgruppe->get_all_sorted);
 248     $self->all_units(SL::DB::Manager::Unit->get_all_sorted);
 249   }
 250
 251   $self->setup_help;
 252
 253   $self->render('csv_import/form', title => $title);
 254 }
 255
 256 sub test_and_import_deferred {
 257   my ($self, %params) = @_;
 258
 259   $self->profile_from_form;
 260
 261   if ($::form->{file}) {
 262     my $file = SL::SessionFile->new($self->csv_file_name, mode => '>');
 263     $file->fh->print($::form->{file});
 264     $file->fh->close;
 265   }
 266
 267   my $file = SL::SessionFile->new($self->csv_file_name, mode => '<', encoding => $self->profile->get('charset'));
 268   if (!$file->fh) {
 269     flash('error', $::locale->text('No file has been uploaded yet.'));
 270     return $self->action_new;
 271   }
 272
 273   $self->{background_job} = SL::BackgroundJob::CsvImport->create_job(
 274     file    => $self->csv_file_name,
 275     profile => $self->profile,
 276     type    => $self->profile->type,
 277     test    => $params{test},
 278   )->save;
 279
 280   if ($self->task_server->is_running) {
 281     $self->task_server->wake_up;
 282   } else {
 283     $self->task_server->start;
 284   }
 285
 286   flash('info', $::locale->text('Your import is beig processed.'));
 287
 288   $self->{deferred} = 1;
 289
 290   $self->render_inputs;
 291 }
 292
 293 sub test_and_import {
 294   my ($self, %params) = @_;
 295
 296   my $file = SL::SessionFile->new(
 297     $self->csv_file_name,
 298     mode       => '<',
 299     encoding   => $self->profile->get('charset'),
 300     session_id => $params{session_id}
 301   );
 302
 303   $self->file($file);
 304
 305   my $worker = $self->worker();
 306
 307   $worker->run;
 308
 309   return if $self->errors;
 310
 311   $self->num_imported(0);
 312   $worker->save_objects if !$params{test};
 313
 314   $self->num_importable(scalar grep { !$_ } map { scalar @{ $_->{errors} } } @{ $self->data || [] });
 315   $self->import_status($params{test} ? 'tested' : 'imported');
 316
 317 #  flash('info', $::locale->text('Objects have been imported.')) if !$params{test};
 318 }
 319
 320 sub load_default_profile {
 321   my ($self) = @_;
 322
 323   my $profile;
 324   if ($::form->{profile}->{id}) {
 325     $profile = SL::DB::Manager::CsvImportProfile->find_by(id => $::form->{profile}->{id}, login => $::myconfig{login});
 326   }
 327   $profile ||= SL::DB::Manager::CsvImportProfile->find_by(type => $self->{type}, is_default => 1, login => $::myconfig{login});
 328   $profile ||= SL::DB::CsvImportProfile->new(type => $self->{type}, login => $::myconfig{login});
 329
 330   $self->profile($profile);
 331   $self->profile->set_defaults;
 332 }
 333
 334 sub load_all_profiles {
 335   my ($self, %params) = @_;
 336
 337   $self->all_profiles(SL::DB::Manager::CsvImportProfile->get_all(
 338     where => [
 339       type  => $self->type,
 340       login => $::myconfig{login},
 341     ],
 342   sort_by => 'name'));
 343 }
 344
 345 sub profile_from_form {
 346   my ($self, $existing_profile) = @_;
 347
 348   delete $::form->{profile}->{id};
 349
 350   my %char_map = $self->char_map;
 351   my @settings;
 352
 353   foreach my $type (qw(sep quote escape)) {
 354     my %rev_chars = map { $char_map{$type}->{$_}->[0] => $_ } keys %{ $char_map{$type} };
 355     my $char      = $::form->{"${type}_char"} eq 'custom' ? $::form->{"custom_${type}_char"} : $rev_chars{ $::form->{"${type}_char"} };
 356
 357     push @settings, { key => "${type}_char", value => $char };
 358   }
 359
 360   if ($self->type eq 'parts') {
 361     $::form->{settings}->{sellprice_adjustment} = $::form->parse_amount(\%::myconfig, $::form->{settings}->{sellprice_adjustment});
 362   }
 363
 364   delete $::form->{profile}->{id};
 365   $self->profile($existing_profile || SL::DB::CsvImportProfile->new(login => $::myconfig{login}));
 366   $self->profile->assign_attributes(%{ $::form->{profile} });
 367   $self->profile->settings(map({ { key => $_, value => $::form->{settings}->{$_} } } keys %{ $::form->{settings} }),
 368                            @settings);
 369   $self->profile->set_defaults;
 370 }
 371
 372 sub char_map {
 373   return ( sep    => { ','  => [ 'comma',     $::locale->text('Comma')     ],
 374                        ';'  => [ 'semicolon', $::locale->text('Semicolon') ],
 375                        "\t" => [ 'tab',       $::locale->text('Tab')       ],
 376                        ' '  => [ 'space',     $::locale->text('Space')     ],
 377                      },
 378            quote  => { '"' => [ 'quote', $::locale->text('Quotes') ],
 379                        "'" => [ 'singlequote', $::locale->text('Single quotes') ],
 380                      },
 381            escape => { '"' => [ 'quote', $::locale->text('Quotes') ],
 382                        "'" => [ 'singlequote', $::locale->text('Single quotes') ],
 383                      },
 384          );
 385 }
 386
 387 sub save_report {
 388   my ($self, $report_id) = @_;
 389
 390   $self->track_progress(phase => 'building report', progress => 0);
 391
 392   my $clone_profile = $self->profile->clone_and_reset_deep;
 393   $clone_profile->save; # weird bug. if this isn't saved before adding it to the report, it will default back to the last profile.
 394
 395   my $report = SL::DB::CsvImportReport->new(
 396     session_id => $::auth->create_or_refresh_session,
 397     profile    => $clone_profile,
 398     type       => $self->type,
 399     file       => '',
 400     numrows    => scalar @{ $self->data },
 401   );
 402
 403   $report->save(cascade => 1) or die $report->db->error;
 404
 405   my $dbh = $::form->get_standard_dbh;
 406   $dbh->begin_work;
 407
 408   my $query  = 'INSERT INTO csv_import_report_rows (csv_import_report_id, col, row, value) VALUES (?, ?, ?, ?)';
 409   my $query2 = 'INSERT INTO csv_import_report_status (csv_import_report_id, row, type, value) VALUES (?, ?, ?, ?)';
 410
 411   my $sth = $dbh->prepare($query);
 412   my $sth2 = $dbh->prepare($query2);
 413
 414   # save headers
 415   my (@headers, @info_methods, @raw_methods, @methods);
 416
 417   for my $i (0 .. $#{ $self->info_headers->{headers} }) {
 418     next unless         $self->info_headers->{used}->{ $self->info_headers->{headers}->[$i] };
 419     push @headers,      $self->info_headers->{headers}->[$i];
 420     push @info_methods, $self->info_headers->{methods}->[$i];
 421   }
 422   for my $i (0 .. $#{ $self->headers->{headers} }) {
 423     next unless         $self->headers->{used}->{ $self->headers->{headers}->[$i] };
 424     push @headers,      $self->headers->{headers}->[$i];
 425     push @methods,      $self->headers->{methods}->[$i];
 426   }
 427   for my $i (0 .. $#{ $self->raw_data_headers->{headers} }) {
 428     next unless         $self->raw_data_headers->{used}->{ $self->raw_data_headers->{headers}->[$i] };
 429     push @headers,      $self->raw_data_headers->{headers}->[$i];
 430     push @raw_methods,  $self->raw_data_headers->{headers}->[$i];
 431   }
 432
 433   $sth->execute($report->id, $_, 0, $headers[$_]) for 0 .. $#headers;
 434
 435   # col offsets
 436   my $o1 =       @info_methods;
 437   my $o2 = $o1 + @methods;
 438
 439   for my $row (0 .. $#{ $self->data }) {
 440     $self->track_progress(progress => $row / @{ $self->data } * 100) if $row % 1000 == 0;
 441     my $data_row = $self->{data}[$row];
 442
 443     $sth->execute($report->id,       $_, $row + 1, $data_row->{info_data}{ $info_methods[$_] }) for 0 .. $#info_methods;
 444     $sth->execute($report->id, $o1 + $_, $row + 1, $data_row->{object}->${ \ $methods[$_] })    for 0 .. $#methods;
 445     $sth->execute($report->id, $o2 + $_, $row + 1, $data_row->{raw_data}{ $raw_methods[$_] })   for 0 .. $#raw_methods;
 446
 447     $sth2->execute($report->id, $row + 1, 'information', $_) for @{ $data_row->{information} || [] };
 448     $sth2->execute($report->id, $row + 1, 'errors', $_)      for @{ $data_row->{errors}      || [] };
 449   }
 450
 451   $dbh->commit;
 452
 453   return $report->id;
 454 }
 455
 456 sub csv_file_name {
 457   my ($self) = @_;
 458   return "csv-import-" . $self->type . ".csv";
 459 }
 460
 461 sub init_worker {
 462   my $self = shift;
 463
 464   my @args = (controller => $self);
 465
 466   if ( $self->file() ) {
 467     push(@args, file => $self->file());
 468   }
 469
 470   return $self->{type} eq 'customers_vendors' ? SL::Controller::CsvImport::CustomerVendor->new(@args)
 471        : $self->{type} eq 'contacts'          ? SL::Controller::CsvImport::Contact->new(@args)
 472        : $self->{type} eq 'addresses'         ? SL::Controller::CsvImport::Shipto->new(@args)
 473        : $self->{type} eq 'parts'             ? SL::Controller::CsvImport::Part->new(@args)
 474        : $self->{type} eq 'projects'          ? SL::Controller::CsvImport::Project->new(@args)
 475        :                                        die "Program logic error";
 476 }
 477
 478 sub setup_help {
 479   my ($self) = @_;
 480
 481   $self->worker->setup_displayable_columns;
 482 }
 483
 484 sub track_progress {
 485   my ($self, %params) = @_;
 486
 487   for my $tracker ($self->progress_tracker) {
 488     $tracker->track_progress(%params);
 489   }
 490 }
 491
 492 sub init_task_server {
 493   SL::System::TaskServer->new;
 494 }
 495
 496 sub cleanup_reports {
 497   SL::DB::Manager::CsvImportReport->cleanup;
 498 }
 499
 500 1;