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