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::Unit;
   8 use SL::Helper::Flash;
   9 use SL::SessionFile;
  10 use SL::Controller::CsvImport::Contact;
  11 use SL::Controller::CsvImport::CustomerVendor;
  12 use SL::Controller::CsvImport::Part;
  13 use SL::Controller::CsvImport::Shipto;
  14
  15 use List::MoreUtils qw(none);
  16
  17 use parent qw(SL::Controller::Base);
  18
  19 use Rose::Object::MakeMethods::Generic
  20 (
  21  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
  22                 import_status errors headers raw_data_headers info_headers data num_imported num_importable displayable_columns) ],
  23 );
  24
  25 __PACKAGE__->run_before('check_auth');
  26 __PACKAGE__->run_before('ensure_form_structure');
  27 __PACKAGE__->run_before('check_type');
  28 __PACKAGE__->run_before('load_all_profiles');
  29
  30 #
  31 # actions
  32 #
  33
  34 sub action_new {
  35   my ($self) = @_;
  36
  37   $self->load_default_profile unless $self->profile;
  38   $self->render_inputs;
  39 }
  40
  41 sub action_test {
  42   my ($self) = @_;
  43   $self->test_and_import(test => 1);
  44 }
  45
  46 sub action_import {
  47   my $self = shift;
  48   $self->test_and_import(test => 0);
  49 }
  50
  51 sub action_save {
  52   my ($self) = @_;
  53
  54   $self->profile_from_form(SL::DB::Manager::CsvImportProfile->find_by(name => $::form->{profile}->{name}));
  55   $self->profile->save;
  56
  57   flash_later('info', $::locale->text("The profile has been saved under the name '#1'.", $self->profile->name));
  58   $self->redirect_to(action => 'new', 'profile.type' => $self->type, 'profile.id' => $self->profile->id);
  59 }
  60
  61 sub action_destroy {
  62   my $self = shift;
  63
  64   my $profile = SL::DB::CsvImportProfile->new(id => $::form->{profile}->{id});
  65   $profile->delete(cascade => 1);
  66
  67   flash_later('info', $::locale->text('The profile \'#1\' has been deleted.', $profile->name));
  68   $self->redirect_to(action => 'new', 'profile.type' => $self->type);
  69 }
  70
  71 sub action_download_sample {
  72   my $self = shift;
  73
  74   $self->profile_from_form;
  75   $self->setup_help;
  76
  77   my $file_name = 'csv_import_sample_' . $self->type . '.csv';
  78   my $file      = SL::SessionFile->new($file_name, mode => '>', encoding => $self->profile->get('charset'));
  79   my $csv       = Text::CSV_XS->new({ binary => 1, map { ( $_ => $self->profile->get($_) ) } qw(sep_char escape_char quote_char),});
  80
  81   $csv->print($file->fh, [ map { $_->{name}        } @{ $self->displayable_columns } ]);
  82   $file->fh->print("\r\n");
  83   $csv->print($file->fh, [ map { $_->{description} } @{ $self->displayable_columns } ]);
  84   $file->fh->print("\r\n");
  85
  86   $file->fh->close;
  87
  88   $self->send_file($file->file_name, name => $file_name);
  89 }
  90
  91 #
  92 # filters
  93 #
  94
  95 sub check_auth {
  96   $::auth->assert('config');
  97 }
  98
  99 sub check_type {
 100   my ($self) = @_;
 101
 102   die "Invalid CSV import type" if none { $_ eq $::form->{profile}->{type} } qw(parts customers_vendors addresses contacts);
 103   $self->type($::form->{profile}->{type});
 104 }
 105
 106 sub ensure_form_structure {
 107   my ($self, %params) = @_;
 108
 109   $::form->{profile}  = {} unless ref $::form->{profile}  eq 'HASH';
 110   $::form->{settings} = {} unless ref $::form->{settings} eq 'HASH';
 111 }
 112
 113 #
 114 # helpers
 115 #
 116
 117 sub render_inputs {
 118   my ($self, %params) = @_;
 119
 120   $self->all_charsets([ [ 'UTF-8',       'UTF-8'                 ],
 121                         [ 'ISO-8859-1',  'ISO-8859-1 (Latin 1)'  ],
 122                         [ 'ISO-8859-15', 'ISO-8859-15 (Latin 9)' ],
 123                         [ 'CP850',       'CP850 (DOS/ANSI)'      ],
 124                         [ 'CP1252',      'CP1252 (Windows)'      ],
 125                       ]);
 126
 127   my %char_map = $self->char_map;
 128
 129   foreach my $type (qw(sep quote escape)) {
 130     my $sub = "all_${type}_chars";
 131     $self->$sub([ sort { $a->[0] cmp $b->[0] } values %{ $char_map{$type} } ]);
 132
 133     my $char = $self->profile->get($type . '_char');
 134     $sub     = "${type}_char";
 135     $self->$sub(($char_map{$type}->{$char} || [])->[0] || $char);
 136   }
 137
 138   $self->file(SL::SessionFile->new($self->csv_file_name));
 139
 140   my $title = $self->type eq 'customers_vendors' ? $::locale->text('CSV import: customers and vendors')
 141             : $self->type eq 'addresses'         ? $::locale->text('CSV import: shipping addresses')
 142             : $self->type eq 'contacts'          ? $::locale->text('CSV import: contacts')
 143             : $self->type eq 'parts'             ? $::locale->text('CSV import: parts and services')
 144             : die;
 145
 146   if ($self->{type} eq 'parts') {
 147     $self->all_buchungsgruppen(SL::DB::Manager::Buchungsgruppe->get_all_sorted);
 148     $self->all_units(SL::DB::Manager::Unit->get_all_sorted);
 149   }
 150
 151   $self->setup_help;
 152
 153   $self->render('csv_import/form', title => $title);
 154 }
 155
 156 sub test_and_import {
 157   my ($self, %params) = @_;
 158
 159   $self->profile_from_form;
 160
 161   if ($::form->{file}) {
 162     my $file = SL::SessionFile->new($self->csv_file_name, mode => '>');
 163     $file->fh->print($::form->{file});
 164     $file->fh->close;
 165   }
 166
 167   my $file = SL::SessionFile->new($self->csv_file_name, mode => '<', encoding => $self->profile->get('charset'));
 168   if (!$file->fh) {
 169     flash('error', $::locale->text('No file has been uploaded yet.'));
 170     return $self->action_new;
 171   }
 172
 173   my $worker = $self->create_worker($file);
 174   $worker->run;
 175
 176   $self->num_imported(0);
 177   $worker->save_objects if !$params{test};
 178
 179   $self->num_importable(scalar grep { !$_ } map { scalar @{ $_->{errors} } } @{ $self->data || [] });
 180   $self->import_status($params{test} ? 'tested' : 'imported');
 181
 182   flash('info', $::locale->text('Objects have been imported.')) if !$params{test};
 183
 184   $self->action_new;
 185 }
 186
 187 sub load_default_profile {
 188   my ($self) = @_;
 189
 190   if ($::form->{profile}->{id}) {
 191     $self->profile(SL::DB::CsvImportProfile->new(id => $::form->{profile}->{id})->load);
 192
 193   } else {
 194     $self->profile(SL::DB::Manager::CsvImportProfile->find_by(type => $self->{type}, is_default => 1));
 195     $self->profile(SL::DB::CsvImportProfile->new(type => $self->{type})) unless $self->profile;
 196   }
 197
 198   $self->profile->set_defaults;
 199 }
 200
 201 sub load_all_profiles {
 202   my ($self, %params) = @_;
 203
 204   $self->all_profiles(SL::DB::Manager::CsvImportProfile->get_all(where => [ type => $self->type ], sort_by => 'name'));
 205 }
 206
 207 sub profile_from_form {
 208   my ($self, $existing_profile) = @_;
 209
 210   delete $::form->{profile}->{id};
 211
 212   my %char_map = $self->char_map;
 213   my @settings;
 214
 215   foreach my $type (qw(sep quote escape)) {
 216     my %rev_chars = map { $char_map{$type}->{$_}->[0] => $_ } keys %{ $char_map{$type} };
 217     my $char      = $::form->{"${type}_char"} eq 'custom' ? $::form->{"custom_${type}_char"} : $rev_chars{ $::form->{"${type}_char"} };
 218
 219     push @settings, { key => "${type}_char", value => $char };
 220   }
 221
 222   if ($self->type eq 'parts') {
 223     $::form->{settings}->{sellprice_adjustment} = $::form->parse_amount(\%::myconfig, $::form->{settings}->{sellprice_adjustment});
 224   }
 225
 226   delete $::form->{profile}->{id};
 227   $self->profile($existing_profile || SL::DB::CsvImportProfile->new);
 228   $self->profile->assign_attributes(%{ $::form->{profile} });
 229   $self->profile->settings(map({ { key => $_, value => $::form->{settings}->{$_} } } keys %{ $::form->{settings} }),
 230                            @settings);
 231   $self->profile->set_defaults;
 232 }
 233
 234 sub char_map {
 235   return ( sep    => { ','  => [ 'comma',     $::locale->text('Comma')     ],
 236                        ';'  => [ 'semicolon', $::locale->text('Semicolon') ],
 237                        "\t" => [ 'tab',       $::locale->text('Tab')       ],
 238                        ' '  => [ 'space',     $::locale->text('Space')     ],
 239                      },
 240            quote  => { '"' => [ 'quote', $::locale->text('Quotes') ],
 241                        "'" => [ 'singlequote', $::locale->text('Single quotes') ],
 242                      },
 243            escape => { '"' => [ 'quote', $::locale->text('Quotes') ],
 244                        "'" => [ 'singlequote', $::locale->text('Single quotes') ],
 245                      },
 246          );
 247 }
 248
 249 sub csv_file_name {
 250   my ($self) = @_;
 251   return "csv-import-" . $self->type . ".csv";
 252 }
 253
 254 sub create_worker {
 255   my ($self, $file) = @_;
 256
 257   return $self->{type} eq 'customers_vendors' ? SL::Controller::CsvImport::CustomerVendor->new(controller => $self, file => $file)
 258        : $self->{type} eq 'contacts'          ? SL::Controller::CsvImport::Contact->new(       controller => $self, file => $file)
 259        : $self->{type} eq 'addresses'         ? SL::Controller::CsvImport::Shipto->new(        controller => $self, file => $file)
 260        : $self->{type} eq 'parts'             ? SL::Controller::CsvImport::Part->new(          controller => $self, file => $file)
 261        :                                        die "Program logic error";
 262 }
 263
 264 sub setup_help {
 265   my ($self) = @_;
 266
 267   $self->create_worker->setup_displayable_columns;
 268 }
 269
 270
 271 1;