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