1 package SL::Controller::CsvImport;
5 use SL::DB::Buchungsgruppe;
6 use SL::DB::CsvImportProfile;
7 use SL::DB::CsvImportReport;
9 use SL::DB::Helper::Paginated ();
10 use SL::Helper::Flash;
12 use SL::Controller::CsvImport::Contact;
13 use SL::Controller::CsvImport::CustomerVendor;
14 use SL::Controller::CsvImport::Part;
15 use SL::Controller::CsvImport::Shipto;
16 use SL::Controller::CsvImport::Project;
17 use SL::BackgroundJob::CsvImport;
18 use SL::System::TaskServer;
20 use List::MoreUtils qw(none);
21 use List::Util qw(min);
23 use parent qw(SL::Controller::Base);
25 use Rose::Object::MakeMethods::Generic
27 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
28 import_status errors headers raw_data_headers info_headers data num_imported num_importable displayable_columns file) ],
29 'scalar --get_set_init' => [ qw(worker) ],
31 progress_tracker => { },
32 add_progress_tracker => { interface => 'add', hash_key => 'progress_tracker' },
36 __PACKAGE__->run_before('check_auth');
37 __PACKAGE__->run_before('ensure_form_structure');
38 __PACKAGE__->run_before('check_type', except => [ qw(report) ]);
39 __PACKAGE__->run_before('load_all_profiles');
41 __PACKAGE__->run_after('cleanup_reports');
50 $self->load_default_profile unless $self->profile;
56 $self->test_and_import_deferred(test => 1);
61 $self->test_and_import_deferred(test => 0);
67 $self->profile_from_form(SL::DB::Manager::CsvImportProfile->find_by(name => $::form->{profile}->{name}, login => $::myconfig{login}));
70 flash_later('info', $::locale->text("The profile has been saved under the name '#1'.", $self->profile->name));
71 $self->redirect_to(action => 'new', 'profile.type' => $self->type, 'profile.id' => $self->profile->id);
77 my $profile = SL::DB::CsvImportProfile->new(id => $::form->{profile}->{id}, login => $::myconfig{login});
78 $profile->delete(cascade => 1);
80 flash_later('info', $::locale->text('The profile \'#1\' has been deleted.', $profile->name));
81 $self->redirect_to(action => 'new', 'profile.type' => $self->type);
88 $self->{background_job} = SL::DB::Manager::BackgroundJob->find_by(id => $::form->{job});
90 my $data = $self->{background_job}->data_as_hash;
92 my $profile = SL::DB::Manager::CsvImportProfile->find_by(id => $data->{profile_id});
94 $self->profile($profile);
96 if ($data->{errors} and my $first_error = $data->{errors}->[0]) {
97 flash('error', $::locale->text('There was an error parsing the csv file: #1 in line #2.', $first_error->[2], $first_error->[0]));
100 if ($data->{progress}{finished} || $data->{errors}) {
101 $self->render('csv_import/_deferred_report', { no_layout => 1 });
103 $self->render('csv_import/_deferred_results', { no_layout => 1 });
107 sub action_download_sample {
110 $self->profile_from_form;
113 my $file_name = 'csv_import_sample_' . $self->type . '.csv';
114 my $file = SL::SessionFile->new($file_name, mode => '>', encoding => $self->profile->get('charset'));
115 my $csv = Text::CSV_XS->new({ binary => 1, map { ( $_ => $self->profile->get($_) ) } qw(sep_char escape_char quote_char),});
117 $csv->print($file->fh, [ map { $_->{name} } @{ $self->displayable_columns } ]);
118 $file->fh->print("\r\n");
119 $csv->print($file->fh, [ map { $_->{description} } @{ $self->displayable_columns } ]);
120 $file->fh->print("\r\n");
124 $self->send_file($file->file_name, name => $file_name);
128 my ($self, %params) = @_;
130 my $report_id = $params{report_id} || $::form->{id};
132 $self->{report} = SL::DB::Manager::CsvImportReport->find_by(id => $report_id);
133 my $num_rows = SL::DB::Manager::CsvImportReportRow->get_all_count(query => [ csv_import_report_id => $report_id ]);
134 my $num_cols = SL::DB::Manager::CsvImportReportRow->get_all_count(query => [ csv_import_report_id => $report_id, row => 0 ]);
136 # manual paginating, yuck
137 my $page = $::form->{page} || 1;
139 $pages->{per_page} = $::form->{per_page} || 20;
140 $pages->{max} = SL::DB::Helper::Paginated::ceil($num_rows / ($num_cols || 1), $pages->{per_page}) || 1;
141 $pages->{cur} = $page < 1 ? 1
142 : $page > $pages->{max} ? $pages->{max}
144 $pages->{common} = SL::DB::Helper::Paginated::make_common_pages($pages->{cur}, $pages->{max});
146 $self->{display_rows} = [
148 $pages->{per_page} * ($pages->{cur}-1) + 1
150 min($pages->{per_page} * $pages->{cur}, $num_rows / ($num_cols || 1) - 1)
154 csv_import_report_id => $report_id,
158 row => { gt => $pages->{per_page} * ($pages->{cur}-1) },
159 row => { le => $pages->{per_page} * $pages->{cur} },
164 my $rows = SL::DB::Manager::CsvImportReportRow->get_all(query => \@query);
165 my $status = SL::DB::Manager::CsvImportReportStatus->get_all(query => \@query);
167 $self->{report_rows} = $self->{report}->folded_rows(rows => $rows);
168 $self->{report_status} = $self->{report}->folded_status(status => $status);
169 $self->{pages} = $pages;
170 $self->{base_url} = $self->url_for(action => 'report', id => $report_id, no_layout => $params{no_layout} || $::form->{no_layout} );
172 $self->render('csv_import/report', { no_layout => $params{no_layout} || $::form->{no_layout} });
181 $::auth->assert('config');
187 die "Invalid CSV import type" if none { $_ eq $::form->{profile}->{type} } qw(parts customers_vendors addresses contacts projects);
188 $self->type($::form->{profile}->{type});
191 sub ensure_form_structure {
192 my ($self, %params) = @_;
194 $::form->{profile} = {} unless ref $::form->{profile} eq 'HASH';
195 $::form->{settings} = {} unless ref $::form->{settings} eq 'HASH';
203 my ($self, %params) = @_;
205 $self->all_charsets([ [ 'UTF-8', 'UTF-8' ],
206 [ 'ISO-8859-1', 'ISO-8859-1 (Latin 1)' ],
207 [ 'ISO-8859-15', 'ISO-8859-15 (Latin 9)' ],
208 [ 'CP850', 'CP850 (DOS/ANSI)' ],
209 [ 'CP1252', 'CP1252 (Windows)' ],
212 my %char_map = $self->char_map;
214 foreach my $type (qw(sep quote escape)) {
215 my $sub = "all_${type}_chars";
216 $self->$sub([ sort { $a->[0] cmp $b->[0] } values %{ $char_map{$type} } ]);
218 my $char = $self->profile->get($type . '_char');
219 $sub = "${type}_char";
220 $self->$sub(($char_map{$type}->{$char} || [])->[0] || $char);
223 $self->file(SL::SessionFile->new($self->csv_file_name));
225 my $title = $self->type eq 'customers_vendors' ? $::locale->text('CSV import: customers and vendors')
226 : $self->type eq 'addresses' ? $::locale->text('CSV import: shipping addresses')
227 : $self->type eq 'contacts' ? $::locale->text('CSV import: contacts')
228 : $self->type eq 'parts' ? $::locale->text('CSV import: parts and services')
229 : $self->type eq 'projects' ? $::locale->text('CSV import: projects')
232 if ($self->{type} eq 'parts') {
233 $self->all_buchungsgruppen(SL::DB::Manager::Buchungsgruppe->get_all_sorted);
234 $self->all_units(SL::DB::Manager::Unit->get_all_sorted);
239 $self->render('csv_import/form', title => $title);
242 sub test_and_import_deferred {
243 my ($self, %params) = @_;
245 $self->profile_from_form;
247 if ($::form->{file}) {
248 my $file = SL::SessionFile->new($self->csv_file_name, mode => '>');
249 $file->fh->print($::form->{file});
253 my $file = SL::SessionFile->new($self->csv_file_name, mode => '<', encoding => $self->profile->get('charset'));
255 flash('error', $::locale->text('No file has been uploaded yet.'));
256 return $self->action_new;
259 $self->{background_job} = SL::BackgroundJob::CsvImport->create_job(
260 file => $self->csv_file_name,
261 profile => $self->profile,
262 type => $self->profile->type,
263 test => $params{test},
266 SL::System::TaskServer->start_if_not_running;
267 SL::System::TaskServer->wake_up;
269 flash('info', $::locale->text('Your import is beig processed.'));
271 $self->{deferred} = 1;
273 $self->render_inputs;
276 sub test_and_import {
277 my ($self, %params) = @_;
279 my $file = SL::SessionFile->new(
280 $self->csv_file_name,
282 encoding => $self->profile->get('charset'),
283 session_id => $params{session_id}
288 my $worker = $self->worker();
292 return if $self->errors;
294 $self->num_imported(0);
295 $worker->save_objects if !$params{test};
297 $self->num_importable(scalar grep { !$_ } map { scalar @{ $_->{errors} } } @{ $self->data || [] });
298 $self->import_status($params{test} ? 'tested' : 'imported');
300 # flash('info', $::locale->text('Objects have been imported.')) if !$params{test};
303 sub load_default_profile {
307 if ($::form->{profile}->{id}) {
308 $profile = SL::DB::Manager::CsvImportProfile->find_by(id => $::form->{profile}->{id}, login => $::myconfig{login});
310 $profile ||= SL::DB::Manager::CsvImportProfile->find_by(type => $self->{type}, is_default => 1, login => $::myconfig{login});
311 $profile ||= SL::DB::CsvImportProfile->new(type => $self->{type}, login => $::myconfig{login});
313 $self->profile($profile);
314 $self->profile->set_defaults;
317 sub load_all_profiles {
318 my ($self, %params) = @_;
320 $self->all_profiles(SL::DB::Manager::CsvImportProfile->get_all(
323 login => $::myconfig{login},
328 sub profile_from_form {
329 my ($self, $existing_profile) = @_;
331 delete $::form->{profile}->{id};
333 my %char_map = $self->char_map;
336 foreach my $type (qw(sep quote escape)) {
337 my %rev_chars = map { $char_map{$type}->{$_}->[0] => $_ } keys %{ $char_map{$type} };
338 my $char = $::form->{"${type}_char"} eq 'custom' ? $::form->{"custom_${type}_char"} : $rev_chars{ $::form->{"${type}_char"} };
340 push @settings, { key => "${type}_char", value => $char };
343 if ($self->type eq 'parts') {
344 $::form->{settings}->{sellprice_adjustment} = $::form->parse_amount(\%::myconfig, $::form->{settings}->{sellprice_adjustment});
347 delete $::form->{profile}->{id};
348 $self->profile($existing_profile || SL::DB::CsvImportProfile->new(login => $::myconfig{login}));
349 $self->profile->assign_attributes(%{ $::form->{profile} });
350 $self->profile->settings(map({ { key => $_, value => $::form->{settings}->{$_} } } keys %{ $::form->{settings} }),
352 $self->profile->set_defaults;
356 return ( sep => { ',' => [ 'comma', $::locale->text('Comma') ],
357 ';' => [ 'semicolon', $::locale->text('Semicolon') ],
358 "\t" => [ 'tab', $::locale->text('Tab') ],
359 ' ' => [ 'space', $::locale->text('Space') ],
361 quote => { '"' => [ 'quote', $::locale->text('Quotes') ],
362 "'" => [ 'singlequote', $::locale->text('Single quotes') ],
364 escape => { '"' => [ 'quote', $::locale->text('Quotes') ],
365 "'" => [ 'singlequote', $::locale->text('Single quotes') ],
371 my ($self, $report_id) = @_;
373 $self->track_progress(phase => 'building report', progress => 0);
375 my $clone_profile = $self->profile->clone_and_reset_deep;
376 $clone_profile->save; # weird bug. if this isn't saved before adding it to the report, it will default back to the last profile.
378 my $report = SL::DB::CsvImportReport->new(
379 session_id => $::auth->create_or_refresh_session,
380 profile => $clone_profile,
383 )->save(cascade => 1);
385 my $dbh = $::form->get_standard_dbh;
388 my $query = 'INSERT INTO csv_import_report_rows (csv_import_report_id, col, row, value) VALUES (?, ?, ?, ?)';
389 my $query2 = 'INSERT INTO csv_import_report_status (csv_import_report_id, row, type, value) VALUES (?, ?, ?, ?)';
391 my $sth = $dbh->prepare($query);
392 my $sth2 = $dbh->prepare($query2);
395 my (@headers, @info_methods, @raw_methods, @methods);
397 for my $i (0 .. $#{ $self->info_headers->{headers} }) {
398 next unless $self->info_headers->{used}->{ $self->info_headers->{headers}->[$i] };
399 push @headers, $self->info_headers->{headers}->[$i];
400 push @info_methods, $self->info_headers->{methods}->[$i];
402 for my $i (0 .. $#{ $self->headers->{headers} }) {
403 next unless $self->headers->{used}->{ $self->headers->{headers}->[$i] };
404 push @headers, $self->headers->{headers}->[$i];
405 push @methods, $self->headers->{methods}->[$i];
407 for my $i (0 .. $#{ $self->raw_data_headers->{headers} }) {
408 next unless $self->raw_data_headers->{used}->{ $self->raw_data_headers->{headers}->[$i] };
409 push @headers, $self->raw_data_headers->{headers}->[$i];
410 push @raw_methods, $self->raw_data_headers->{headers}->[$i];
413 $sth->execute($report->id, $_, 0, $headers[$_]) for 0 .. $#headers;
416 my $o1 = @info_methods;
417 my $o2 = $o1 + @methods;
419 for my $row (0 .. $#{ $self->data }) {
420 $self->track_progress(progress => $row / @{ $self->data } * 100) if $row % 100 == 0;
421 my $data_row = $self->{data}[$row];
423 $sth->execute($report->id, $_, $row + 1, $data_row->{info_data}{ $info_methods[$_] }) for 0 .. $#info_methods;
424 $sth->execute($report->id, $o1 + $_, $row + 1, $data_row->{object}->${ \ $methods[$_] }) for 0 .. $#methods;
425 $sth->execute($report->id, $o2 + $_, $row + 1, $data_row->{raw_data}{ $raw_methods[$_] }) for 0 .. $#raw_methods;
427 $sth2->execute($report->id, $row + 1, 'information', $_) for @{ $data_row->{information} || [] };
428 $sth2->execute($report->id, $row + 1, 'errors', $_) for @{ $data_row->{errors} || [] };
438 return "csv-import-" . $self->type . ".csv";
444 my @args = (controller => $self);
446 if ( $self->file() ) {
447 push(@args, file => $self->file());
450 return $self->{type} eq 'customers_vendors' ? SL::Controller::CsvImport::CustomerVendor->new(@args)
451 : $self->{type} eq 'contacts' ? SL::Controller::CsvImport::Contact->new(@args)
452 : $self->{type} eq 'addresses' ? SL::Controller::CsvImport::Shipto->new(@args)
453 : $self->{type} eq 'parts' ? SL::Controller::CsvImport::Part->new(@args)
454 : $self->{type} eq 'projects' ? SL::Controller::CsvImport::Project->new(@args)
455 : die "Program logic error";
461 $self->worker->setup_displayable_columns;
465 my ($self, %params) = @_;
467 for my $tracker ($self->progress_tracker) {
468 $tracker->track_progress(%params);
473 sub cleanup_reports {
474 SL::DB::Manager::CsvImportReport->cleanup;