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