X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FCsvImport.pm;h=b74b04be038926c822cbd8471030d2abec34a3d4;hb=d180d84e035a21291e2dc186b4430e3336998156;hp=c2f2a6ce06f017eb0aec6c2c5ecdaafa2f960dd4;hpb=7caf72fffe2dfe58d11da0acd0e2892e6737330a;p=kivitendo-erp.git diff --git a/SL/Controller/CsvImport.pm b/SL/Controller/CsvImport.pm index c2f2a6ce0..b74b04be0 100644 --- a/SL/Controller/CsvImport.pm +++ b/SL/Controller/CsvImport.pm @@ -4,27 +4,47 @@ use strict; use SL::DB::Buchungsgruppe; use SL::DB::CsvImportProfile; +use SL::DB::CsvImportReport; +use SL::DB::Unit; +use SL::DB::Helper::Paginated (); use SL::Helper::Flash; +use SL::Locale::String; use SL::SessionFile; use SL::Controller::CsvImport::Contact; use SL::Controller::CsvImport::CustomerVendor; use SL::Controller::CsvImport::Part; +use SL::Controller::CsvImport::Inventory; use SL::Controller::CsvImport::Shipto; +use SL::Controller::CsvImport::Project; +use SL::Controller::CsvImport::Order; +use SL::JSON; +use SL::Controller::CsvImport::BankTransaction; +use SL::BackgroundJob::CsvImport; +use SL::System::TaskServer; use List::MoreUtils qw(none); +use List::Util qw(min); use parent qw(SL::Controller::Base); use Rose::Object::MakeMethods::Generic ( - 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 - import_status errors headers raw_data_headers data num_imported num_importable worker displayable_columns) ], + 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 + import_status errors headers raw_data_headers info_headers data num_imported num_importable displayable_columns file all_taxzones) ], + 'scalar --get_set_init' => [ qw(worker task_server) ], + 'array' => [ + progress_tracker => { }, + add_progress_tracker => { interface => 'add', hash_key => 'progress_tracker' }, + ], ); __PACKAGE__->run_before('check_auth'); __PACKAGE__->run_before('ensure_form_structure'); -__PACKAGE__->run_before('check_type'); +__PACKAGE__->run_before('check_type', except => [ qw(report) ]); __PACKAGE__->run_before('load_all_profiles'); +__PACKAGE__->run_before('check_task_server'); + +__PACKAGE__->run_after('cleanup_reports'); # # actions @@ -39,18 +59,18 @@ sub action_new { sub action_test { my ($self) = @_; - $self->test_and_import(test => 1); + $self->test_and_import_deferred(test => 1); } sub action_import { my $self = shift; - $self->test_and_import(test => 0); + $self->test_and_import_deferred(test => 0); } sub action_save { my ($self) = @_; - $self->profile_from_form(SL::DB::Manager::CsvImportProfile->find_by(name => $::form->{profile}->{name})); + $self->profile_from_form(SL::DB::Manager::CsvImportProfile->find_by(name => $::form->{profile}->{name}, login => $::myconfig{login})); $self->profile->save; flash_later('info', $::locale->text("The profile has been saved under the name '#1'.", $self->profile->name)); @@ -60,13 +80,139 @@ sub action_save { sub action_destroy { my $self = shift; - my $profile = SL::DB::CsvImportProfile->new(id => $::form->{profile}->{id}); + my $profile = SL::DB::CsvImportProfile->new(id => $::form->{profile}->{id}, login => $::myconfig{login}); $profile->delete(cascade => 1); flash_later('info', $::locale->text('The profile \'#1\' has been deleted.', $profile->name)); $self->redirect_to(action => 'new', 'profile.type' => $self->type); } +sub action_result { + my $self = shift; + + # load resultobject + $self->{background_job} = SL::DB::Manager::BackgroundJob->find_by(id => $::form->{job}); + + my $data = $self->{background_job}->data_as_hash; + + my $profile = SL::DB::Manager::CsvImportProfile->find_by(id => $data->{profile_id}); + + $self->profile($profile); + + if ($data->{errors} and my $first_error = $data->{errors}->[0]) { + flash('error', $::locale->text('There was an error parsing the csv file: #1 in line #2.', $first_error->[2], $first_error->[0])); + } + + if ($data->{progress}{finished} || $data->{errors}) { + $self->render('csv_import/_deferred_report', { layout => 0 }); + } else { + if (!$self->task_server->is_running) { + $self->task_server->start; + $self->{status_text} = t8('Task Server is not running, starting it now. If this does not change, please check your task server config'); + } elsif (my $phase = $data->{progress}{phase}) { + $self->{status_text} = "$data->{progress}{plan}{$phase} / $data->{progress}{num_phases} " . t8($phase); + } else { + $self->{status_text} = t8('Import not started yet, please wait...'); + } + + $self->render('csv_import/_deferred_results', { layout => 0 }); + } +} + +sub action_download_sample { + my $self = shift; + + $self->profile_from_form; + $self->setup_help; + + my $file_name = 'csv_import_sample_' . $self->type . '.csv'; + my $file = SL::SessionFile->new($file_name, mode => '>', encoding => $self->profile->get('charset')); + my $csv = Text::CSV_XS->new({ binary => 1, map { ( $_ => $self->profile->get($_) ) } qw(sep_char escape_char quote_char),}); + + if ($self->worker->is_multiplexed) { + foreach my $p (@{ $self->worker->profile }) { + $csv->print($file->fh, [ map { $_->{name} } @{ $self->displayable_columns->{$p->{row_ident}} } ]); + $file->fh->print("\r\n"); + } + foreach my $p (@{ $self->worker->profile }) { + $csv->print($file->fh, [ map { $_->{description} } @{ $self->displayable_columns->{$p->{row_ident}} } ]); + $file->fh->print("\r\n"); + } + } else { + $csv->print($file->fh, [ map { $_->{name} } @{ $self->displayable_columns } ]); + $file->fh->print("\r\n"); + $csv->print($file->fh, [ map { $_->{description} } @{ $self->displayable_columns } ]); + $file->fh->print("\r\n"); + } + + $file->fh->close; + + $self->send_file($file->file_name, name => $file_name); +} + +sub action_report { + my ($self, %params) = @_; + + my $report_id = $params{report_id} || $::form->{id}; + + $self->{report} = SL::DB::Manager::CsvImportReport->find_by(id => $report_id); + + if (!$self->{report}) { + $::form->error(t8('No report with id #1', $report_id)); + } + my $num_rows = $self->{report}->numrows; + my $num_cols = SL::DB::Manager::CsvImportReportRow->get_all_count(query => [ csv_import_report_id => $report_id, row => 0 ]); + + # manual paginating, yuck + my $page = $::form->{page} || 1; + my $pages = {}; + $pages->{per_page} = $::form->{per_page} || 20; + $pages->{max} = SL::DB::Helper::Paginated::ceil($num_rows, $pages->{per_page}) || 1; + $pages->{page} = $page < 1 ? 1 + : $page > $pages->{max} ? $pages->{max} + : $page; + $pages->{common} = [ grep { $_->{visible} } @{ SL::DB::Helper::Paginated::make_common_pages($pages->{page}, $pages->{max}) } ]; + + $self->{report_numheaders} = $self->{report}->numheaders; + my $first_row_header = 0; + my $last_row_header = $self->{report_numheaders} - 1; + my $first_row_data = $pages->{per_page} * ($pages->{page}-1) + $self->{report_numheaders}; + my $last_row_data = min($pages->{per_page} * $pages->{page}, $num_rows) + $self->{report_numheaders} - 1; + $self->{display_rows} = [ + $first_row_header + .. + $last_row_header, + $first_row_data + .. + $last_row_data + ]; + + my @query = ( + csv_import_report_id => $report_id, + or => [ + and => [ + row => { ge => $first_row_header }, + row => { le => $last_row_header }, + ], + and => [ + row => { ge => $first_row_data }, + row => { le => $last_row_data }, + ] + ] + ); + + my $rows = SL::DB::Manager::CsvImportReportRow->get_all(query => \@query); + my $status = SL::DB::Manager::CsvImportReportStatus->get_all(query => \@query); + + $self->{report_rows} = $self->{report}->folded_rows(rows => $rows); + $self->{report_status} = $self->{report}->folded_status(status => $status); + $self->{pages} = $pages; + $self->{base_url} = $self->url_for(action => 'report', id => $report_id, no_layout => $params{no_layout} || $::form->{no_layout} ); + + $self->render('csv_import/report', { layout => !($params{no_layout} || $::form->{no_layout}) }); +} + + # # filters # @@ -78,7 +224,7 @@ sub check_auth { sub check_type { my ($self) = @_; - die "Invalid CSV import type" if none { $_ eq $::form->{profile}->{type} } qw(parts customers_vendors addresses contacts); + die "Invalid CSV import type" if none { $_ eq $::form->{profile}->{type} } qw(parts inventories customers_vendors addresses contacts projects orders bank_transactions); $self->type($::form->{profile}->{type}); } @@ -120,19 +266,34 @@ sub render_inputs { : $self->type eq 'addresses' ? $::locale->text('CSV import: shipping addresses') : $self->type eq 'contacts' ? $::locale->text('CSV import: contacts') : $self->type eq 'parts' ? $::locale->text('CSV import: parts and services') + : $self->type eq 'inventories' ? $::locale->text('CSV import: inventories') + : $self->type eq 'projects' ? $::locale->text('CSV import: projects') + : $self->type eq 'orders' ? $::locale->text('CSV import: orders') + : $self->type eq 'bank_transactions' ? $::locale->text('CSV import: bank transactions') : die; - $self->all_buchungsgruppen(SL::DB::Manager::Buchungsgruppe->get_all_sorted); + if ($self->{type} eq 'customers_vendors' or $self->{type} eq 'orders' ) { + $self->all_taxzones(SL::DB::Manager::TaxZone->get_all_sorted(query => [ obsolete => 0 ])); + }; + + if ($self->{type} eq 'parts') { + $self->all_buchungsgruppen(SL::DB::Manager::Buchungsgruppe->get_all_sorted); + $self->all_units(SL::DB::Manager::Unit->get_all_sorted); + } $self->setup_help; $self->render('csv_import/form', title => $title); } -sub test_and_import { +sub test_and_import_deferred { my ($self, %params) = @_; - $self->profile_from_form; + if ( $::form->{force_profile} && $::form->{profile}->{id} ) { + $self->load_default_profile; + } else { + $self->profile_from_form; + }; if ($::form->{file}) { my $file = SL::SessionFile->new($self->csv_file_name, mode => '>'); @@ -146,36 +307,83 @@ sub test_and_import { return $self->action_new; } - my $worker = $self->create_worker($file); - $worker->run; + $self->{background_job} = SL::BackgroundJob::CsvImport->create_job( + file => $self->csv_file_name, + profile => $self->profile, + type => $self->profile->type, + test => $params{test}, + employee_id => SL::DB::Manager::Employee->current->id, + )->save; + + if ($self->task_server->is_running) { + $self->task_server->wake_up; + } else { + $self->task_server->start; + } + + flash('info', $::locale->text('Your import is being processed.')); + + $self->{deferred} = 1; + + if ($::request->type eq 'json') { + $self->render(\ SL::JSON::to_json($self->{background_job}->as_tree), { type => 'json' }) + } else { + $self->render_inputs; + } +} + +sub test_and_import { + my ($self, %params) = @_; + + my $file = SL::SessionFile->new( + $self->csv_file_name, + mode => '<', + encoding => $self->profile->get('charset'), + session_id => $params{session_id} + ); + + $self->file($file); + + my $worker = $self->worker(); + + $worker->run(%params); + + return if $self->errors; + + $self->num_imported(0); $worker->save_objects if !$params{test}; $self->num_importable(scalar grep { !$_ } map { scalar @{ $_->{errors} } } @{ $self->data || [] }); $self->import_status($params{test} ? 'tested' : 'imported'); - flash('info', $::locale->text('Objects have been imported.')) if !$params{test}; - - $self->action_new; +# flash('info', $::locale->text('Objects have been imported.')) if !$params{test}; } sub load_default_profile { my ($self) = @_; + my $profile; if ($::form->{profile}->{id}) { - $self->profile(SL::DB::CsvImportProfile->new(id => $::form->{profile}->{id})->load); - - } else { - $self->profile(SL::DB::Manager::CsvImportProfile->find_by(type => $self->{type}, is_default => 1)); - $self->profile(SL::DB::CsvImportProfile->new(type => $self->{type})) unless $self->profile; + $profile = SL::DB::Manager::CsvImportProfile->find_by(id => $::form->{profile}->{id}, login => $::myconfig{login}); } + $profile ||= SL::DB::Manager::CsvImportProfile->find_by(type => $self->{type}, is_default => 1, login => $::myconfig{login}); + $profile ||= SL::DB::CsvImportProfile->new(type => $self->{type}, login => $::myconfig{login}); + $self->profile($profile); + $self->worker->set_profile_defaults; $self->profile->set_defaults; } sub load_all_profiles { my ($self, %params) = @_; - $self->all_profiles(SL::DB::Manager::CsvImportProfile->get_all(where => [ type => $self->type ], sort_by => 'name')); + $self->all_profiles(SL::DB::Manager::CsvImportProfile->get_all( + where => [ + type => $self->type, + login => $::myconfig{login}, + '!name' => '', + ], + sort_by => 'name')); } sub profile_from_form { @@ -197,8 +405,12 @@ sub profile_from_form { $::form->{settings}->{sellprice_adjustment} = $::form->parse_amount(\%::myconfig, $::form->{settings}->{sellprice_adjustment}); } + if ($self->type eq 'orders') { + $::form->{settings}->{max_amount_diff} = $::form->parse_amount(\%::myconfig, $::form->{settings}->{max_amount_diff}); + } + delete $::form->{profile}->{id}; - $self->profile($existing_profile || SL::DB::CsvImportProfile->new); + $self->profile($existing_profile || SL::DB::CsvImportProfile->new(login => $::myconfig{login})); $self->profile->assign_attributes(%{ $::form->{profile} }); $self->profile->settings(map({ { key => $_, value => $::form->{settings}->{$_} } } keys %{ $::form->{settings} }), @settings); @@ -220,26 +432,231 @@ sub char_map { ); } +sub save_report { + my ($self, %params) = @_; + + if ($self->worker->is_multiplexed) { + return $self->save_report_multi(%params); + } else { + return $self->save_report_single(%params); + } +} + +sub save_report_single { + my ($self, %params) = @_; + + $self->track_progress(phase => 'building report', progress => 0); + + my $clone_profile = $self->profile->clone_and_reset_deep; + $clone_profile->save; # weird bug. if this isn't saved before adding it to the report, it will default back to the last profile. + + my $report = SL::DB::CsvImportReport->new( + session_id => $params{session_id}, + profile => $clone_profile, + type => $self->type, + file => '', + numrows => scalar @{ $self->data }, + numheaders => 1, + ); + + $report->save(cascade => 1) or die $report->db->error; + + my $dbh = $::form->get_standard_dbh; + $dbh->begin_work; + + my $query = 'INSERT INTO csv_import_report_rows (csv_import_report_id, col, row, value) VALUES (?, ?, ?, ?)'; + my $query2 = 'INSERT INTO csv_import_report_status (csv_import_report_id, row, type, value) VALUES (?, ?, ?, ?)'; + + my $sth = $dbh->prepare($query); + my $sth2 = $dbh->prepare($query2); + + # save headers + my (@headers, @info_methods, @raw_methods, @methods); + + for my $i (0 .. $#{ $self->info_headers->{headers} }) { + next unless $self->info_headers->{used}->{ $self->info_headers->{methods}->[$i] }; + push @headers, $self->info_headers->{headers}->[$i]; + push @info_methods, $self->info_headers->{methods}->[$i]; + } + for my $i (0 .. $#{ $self->headers->{headers} }) { + next unless $self->headers->{used}->{ $self->headers->{headers}->[$i] }; + push @headers, $self->headers->{headers}->[$i]; + push @methods, $self->headers->{methods}->[$i]; + } + for my $i (0 .. $#{ $self->raw_data_headers->{headers} }) { + next unless $self->raw_data_headers->{used}->{ $self->raw_data_headers->{headers}->[$i] }; + push @headers, $self->raw_data_headers->{headers}->[$i]; + push @raw_methods, $self->raw_data_headers->{headers}->[$i]; + } + + $sth->execute($report->id, $_, 0, $headers[$_]) for 0 .. $#headers; + + # col offsets + my $o1 = @info_methods; + my $o2 = $o1 + @methods; + + for my $row (0 .. $#{ $self->data }) { + $self->track_progress(progress => $row / @{ $self->data } * 100) if $row % 1000 == 0; + my $data_row = $self->{data}[$row]; + + $sth->execute($report->id, $_, $row + 1, $data_row->{info_data}{ $info_methods[$_] }) for 0 .. $#info_methods; + $sth->execute($report->id, $o1 + $_, $row + 1, $data_row->{object}->${ \ $methods[$_] }) for 0 .. $#methods; + $sth->execute($report->id, $o2 + $_, $row + 1, $data_row->{raw_data}{ $raw_methods[$_] }) for 0 .. $#raw_methods; + + $sth2->execute($report->id, $row + 1, 'information', $_) for @{ $data_row->{information} || [] }; + $sth2->execute($report->id, $row + 1, 'errors', $_) for @{ $data_row->{errors} || [] }; + } + + $dbh->commit; + + return $report->id; +} + +sub save_report_multi { + my ($self, %params) = @_; + + $self->track_progress(phase => 'building report', progress => 0); + + my $clone_profile = $self->profile->clone_and_reset_deep; + $clone_profile->save; # weird bug. if this isn't saved before adding it to the report, it will default back to the last profile. + + my $report = SL::DB::CsvImportReport->new( + session_id => $params{session_id}, + profile => $clone_profile, + type => $self->type, + file => '', + numrows => scalar @{ $self->data }, + numheaders => scalar @{ $self->worker->profile }, + ); + + $report->save(cascade => 1) or die $report->db->error; + + my $dbh = $::form->get_standard_dbh; + $dbh->begin_work; + + my $query = 'INSERT INTO csv_import_report_rows (csv_import_report_id, col, row, value) VALUES (?, ?, ?, ?)'; + my $query2 = 'INSERT INTO csv_import_report_status (csv_import_report_id, row, type, value) VALUES (?, ?, ?, ?)'; + + my $sth = $dbh->prepare($query); + my $sth2 = $dbh->prepare($query2); + + # save headers + my ($headers, $info_methods, $raw_methods, $methods); + + for my $i (0 .. $#{ $self->worker->profile }) { + my $row_ident = $self->worker->profile->[$i]->{row_ident}; + + for my $i (0 .. $#{ $self->info_headers->{$row_ident}->{headers} }) { + next unless $self->info_headers->{$row_ident}->{used}->{ $self->info_headers->{$row_ident}->{methods}->[$i] }; + push @{ $headers->{$row_ident} }, $self->info_headers->{$row_ident}->{headers}->[$i]; + push @{ $info_methods->{$row_ident} }, $self->info_headers->{$row_ident}->{methods}->[$i]; + } + for my $i (0 .. $#{ $self->headers->{$row_ident}->{headers} }) { + next unless $self->headers->{$row_ident}->{used}->{ $self->headers->{$row_ident}->{headers}->[$i] }; + push @{ $headers->{$row_ident} }, $self->headers->{$row_ident}->{headers}->[$i]; + push @{ $methods->{$row_ident} }, $self->headers->{$row_ident}->{methods}->[$i]; + } + + for my $i (0 .. $#{ $self->raw_data_headers->{$row_ident}->{headers} }) { + next unless $self->raw_data_headers->{$row_ident}->{used}->{ $self->raw_data_headers->{$row_ident}->{headers}->[$i] }; + push @{ $headers->{$row_ident} }, $self->raw_data_headers->{$row_ident}->{headers}->[$i]; + push @{ $raw_methods->{$row_ident} }, $self->raw_data_headers->{$row_ident}->{headers}->[$i]; + } + + } + + for my $i (0 .. $#{ $self->worker->profile }) { + my $row_ident = $self->worker->profile->[$i]->{row_ident}; + $sth->execute($report->id, $_, $i, $headers->{$row_ident}->[$_]) for 0 .. $#{ $headers->{$row_ident} }; + } + + # col offsets + my ($off1, $off2); + for my $i (0 .. $#{ $self->worker->profile }) { + my $row_ident = $self->worker->profile->[$i]->{row_ident}; + my $n_info_methods = $info_methods->{$row_ident} ? scalar @{ $info_methods->{$row_ident} } : 0; + my $n_methods = $methods->{$row_ident} ? scalar @{ $methods->{$row_ident} } : 0; + + $off1->{$row_ident} = $n_info_methods; + $off2->{$row_ident} = $off1->{$row_ident} + $n_methods; + } + + my $n_header_rows = scalar @{ $self->worker->profile }; + + for my $row (0 .. $#{ $self->data }) { + $self->track_progress(progress => $row / @{ $self->data } * 100) if $row % 1000 == 0; + my $data_row = $self->{data}[$row]; + my $row_ident = $data_row->{raw_data}{datatype}; + + my $o1 = $off1->{$row_ident}; + my $o2 = $off2->{$row_ident}; + + $sth->execute($report->id, $_, $row + $n_header_rows, $data_row->{info_data}{ $info_methods->{$row_ident}->[$_] }) for 0 .. $#{ $info_methods->{$row_ident} }; + $sth->execute($report->id, $o1 + $_, $row + $n_header_rows, $data_row->{object}->${ \ $methods->{$row_ident}->[$_] }) for 0 .. $#{ $methods->{$row_ident} }; + $sth->execute($report->id, $o2 + $_, $row + $n_header_rows, $data_row->{raw_data}{ $raw_methods->{$row_ident}->[$_] }) for 0 .. $#{ $raw_methods->{$row_ident} }; + + $sth2->execute($report->id, $row + $n_header_rows, 'information', $_) for @{ $data_row->{information} || [] }; + $sth2->execute($report->id, $row + $n_header_rows, 'errors', $_) for @{ $data_row->{errors} || [] }; + } + + $dbh->commit; + + return $report->id; +} + sub csv_file_name { my ($self) = @_; return "csv-import-" . $self->type . ".csv"; } -sub create_worker { - my ($self, $file) = @_; +sub init_worker { + my $self = shift; + + my @args = (controller => $self); + + if ( $self->file() ) { + push(@args, file => $self->file()); + } - return $self->{type} eq 'customers_vendors' ? SL::Controller::CsvImport::CustomerVendor->new(controller => $self, file => $file) - : $self->{type} eq 'contacts' ? SL::Controller::CsvImport::Contact->new( controller => $self, file => $file) - : $self->{type} eq 'addresses' ? SL::Controller::CsvImport::Shipto->new( controller => $self, file => $file) - : $self->{type} eq 'parts' ? SL::Controller::CsvImport::Part->new( controller => $self, file => $file) + return $self->{type} eq 'customers_vendors' ? SL::Controller::CsvImport::CustomerVendor->new(@args) + : $self->{type} eq 'contacts' ? SL::Controller::CsvImport::Contact->new(@args) + : $self->{type} eq 'addresses' ? SL::Controller::CsvImport::Shipto->new(@args) + : $self->{type} eq 'parts' ? SL::Controller::CsvImport::Part->new(@args) + : $self->{type} eq 'inventories' ? SL::Controller::CsvImport::Inventory->new(@args) + : $self->{type} eq 'projects' ? SL::Controller::CsvImport::Project->new(@args) + : $self->{type} eq 'orders' ? SL::Controller::CsvImport::Order->new(@args) + : $self->{type} eq 'bank_transactions' ? SL::Controller::CsvImport::BankTransaction->new(@args) : die "Program logic error"; } sub setup_help { my ($self) = @_; - $self->create_worker->setup_displayable_columns; + $self->worker->setup_displayable_columns; +} + +sub track_progress { + my ($self, %params) = @_; + + for my $tracker ($self->progress_tracker) { + $tracker->track_progress(%params); + } +} + +sub init_task_server { + SL::System::TaskServer->new; +} + +sub cleanup_reports { + SL::DB::Manager::CsvImportReport->cleanup; } +sub check_task_server { + return 1 if $_[0]->task_server->is_running; + + flash('info', t8('The task server is not running at the moment but needed for this module')); + + 1; +} 1;