1 package SL::Controller::Admin;
 
   5 use parent qw(SL::Controller::Base);
 
   8 use List::Util qw(first);
 
   9 use List::UtilsBy qw(sort_by);
 
  13 use SL::DB::AuthGroup;
 
  16 use SL::Helper::Flash;
 
  17 use SL::Locale::String qw(t8);
 
  18 use SL::System::InstallationLock;
 
  21 use SL::Layout::AdminLogin;
 
  23 use Rose::Object::MakeMethods::Generic
 
  25   'scalar --get_set_init' => [ qw(client user group printer db_cfg is_locked
 
  26                                   all_dateformats all_numberformats all_countrycodes all_stylesheets all_menustyles all_clients all_groups all_users all_rights all_printers
 
  27                                   all_dbsources all_used_dbsources all_accounting_methods all_inventory_systems all_profit_determinations all_charts) ],
 
  30 __PACKAGE__->run_before(\&setup_layout);
 
  31 __PACKAGE__->run_before(\&setup_client, only => [ qw(list_printers new_printer edit_printer save_printer delete_printer) ]);
 
  33 sub get_auth_level { "admin" };
 
  34 sub keep_auth_vars_in_form {
 
  35   my ($class, %params) = @_;
 
  36   return $params{action} eq 'login';
 
  40 # actions: login, logout
 
  46   return $self->login_form if !$::form->{do_login};
 
  47   return                   if !$self->authenticate_root;
 
  48   return                   if !$self->check_auth_db_and_tables;
 
  49   return                   if  $self->apply_dbupgrade_scripts;
 
  51   $self->redirect_to(action => 'show');
 
  56   $::auth->destroy_session;
 
  57   $self->redirect_to(action => 'login');
 
  61 # actions: creating the authentication database & tables, applying database ugprades
 
  64 sub action_apply_dbupgrade_scripts {
 
  67   return if $self->apply_dbupgrade_scripts;
 
  68   $self->redirect_to(action => 'show');
 
  71 sub action_create_auth_db {
 
  74   $::auth->create_database(superuser          => $::form->{db_superuser},
 
  75                            superuser_password => $::form->{db_superuser_password},
 
  76                            template           => $::form->{db_template});
 
  77   $self->check_auth_db_and_tables;
 
  80 sub action_create_auth_tables {
 
  83   $::auth->create_tables;
 
  84   $::auth->set_session_value('admin_password', $::lx_office_conf{authentication}->{admin_password});
 
  85   $::auth->create_or_refresh_session;
 
  87   my $scripts_applied = $self->apply_dbupgrade_scripts;
 
  89   if (! SL::DB::Manager::AuthGroup->get_all_count) {
 
  90     SL::DB::AuthGroup->new(
 
  91       name        => t8('Full Access'),
 
  92       description => t8('Full access to all functions'),
 
  93       rights      => [ map { SL::DB::AuthGroupRight->new(right => $_, granted => 1) } $::auth->all_rights ],
 
  97   $self->action_login unless $scripts_applied;
 
 109     title => "kivitendo " . t8('Administration'),
 
 113 sub action_new_user {
 
 116   my $defaults = SL::DefaultManager->new($::lx_office_conf{system}->{default_manager});
 
 117   $self->user(SL::DB::AuthUser->new(
 
 119       countrycode  => $defaults->language('de'),
 
 120       numberformat => $defaults->numberformat('1.000,00'),
 
 121       dateformat   => $defaults->dateformat('dd.mm.yy'),
 
 122       stylesheet   => "kivitendo.css",
 
 127   $self->edit_user_form(title => t8('Create a new user'));
 
 130 sub action_edit_user {
 
 132   $self->edit_user_form(title => t8('Edit User'));
 
 135 sub action_save_user {
 
 137   my $params = delete($::form->{user})          || { };
 
 138   my $props  = delete($params->{config_values}) || { };
 
 139   my $is_new = !$params->{id};
 
 141   # Assign empty arrays if the browser doesn't send those controls.
 
 142   $params->{clients} ||= [];
 
 143   $params->{groups}  ||= [];
 
 145   $self->user($is_new ? SL::DB::AuthUser->new : SL::DB::AuthUser->new(id => $params->{id})->load)
 
 146     ->assign_attributes(%{ $params })
 
 147     ->config_values({ %{ $self->user->config_values }, %{ $props } });
 
 149   my @errors = $self->user->validate;
 
 152     flash('error', @errors);
 
 153     $self->edit_user_form(title => $is_new ? t8('Create a new user') : t8('Edit User'));
 
 159   if ($::auth->can_change_password && $::form->{new_password}) {
 
 160     $::auth->change_password($self->user->login, $::form->{new_password});
 
 163   flash_later('info', $is_new ? t8('The user has been created.') : t8('The user has been saved.'));
 
 164   $self->redirect_to(action => 'show');
 
 167 sub action_delete_user {
 
 170   my @clients = @{ $self->user->clients || [] };
 
 172   # backup user metadata (email, name, etc)
 
 173   my $user_config_values_ref = $self->user->config_values();
 
 174   my $login =$self->user->login;
 
 176   if (!$self->user->delete) {
 
 177     flash('error', t8('The user could not be deleted.'));
 
 178     $self->edit_user_form(title => t8('Edit User'));
 
 182   # Flag corresponding entries in 'employee' as deleted.
 
 183   # and restore the most important user data in employee
 
 184   # TODO try and catch the whole transaction {user->delete; update employee} {exception}
 
 185   foreach my $client (@clients) {
 
 186     my $dbh = $client->dbconnect(AutoCommit => 1) || next;
 
 187     $dbh->do(qq|UPDATE employee SET deleted = TRUE, name = ?, deleted_email = ?,
 
 188                 deleted_tel = ?, deleted_fax = ?, deleted_signature = ? WHERE login = ?|,undef,
 
 189               $user_config_values_ref->{name}, $user_config_values_ref->{email},
 
 190               $user_config_values_ref->{tel}, $user_config_values_ref->{fax},
 
 191               $user_config_values_ref->{signature}, $self->user->login);
 
 195   flash_later('info', t8('The user has been deleted.'));
 
 196   $self->redirect_to(action => 'show');
 
 203 sub action_new_client {
 
 206   $self->client(SL::DB::AuthClient->new(
 
 207     dbhost   => $::auth->{DB_config}->{host},
 
 208     dbport   => $::auth->{DB_config}->{port},
 
 209     dbuser   => $::auth->{DB_config}->{user},
 
 210     dbpasswd => $::auth->{DB_config}->{password},
 
 213   $self->edit_client_form(title => t8('Create a new client'));
 
 216 sub action_edit_client {
 
 218   $self->edit_client_form(title => t8('Edit Client'));
 
 221 sub action_save_client {
 
 223   my $params = delete($::form->{client}) || { };
 
 224   my $is_new = !$params->{id};
 
 226   # Assign empty arrays if the browser doesn't send those controls.
 
 227   $params->{groups} ||= [];
 
 228   $params->{users}  ||= [];
 
 230   $self->client($is_new ? SL::DB::AuthClient->new : SL::DB::AuthClient->new(id => $params->{id})->load)->assign_attributes(%{ $params });
 
 232   my @errors = $self->client->validate;
 
 235     flash('error', @errors);
 
 236     $self->edit_client_form(title => $is_new ? t8('Create a new client') : t8('Edit Client'));
 
 241   if ($self->client->is_default) {
 
 242     SL::DB::Manager::AuthClient->update_all(set => { is_default => 0 }, where => [ '!id' => $self->client->id ]);
 
 245   flash_later('info', $is_new ? t8('The client has been created.') : t8('The client has been saved.'));
 
 246   $self->redirect_to(action => 'show');
 
 249 sub action_delete_client {
 
 252   if (!$self->client->delete) {
 
 253     flash('error', t8('The client could not be deleted.'));
 
 254     $self->edit_client_form(title => t8('Edit Client'));
 
 258   flash_later('info', t8('The client has been deleted.'));
 
 259   $self->redirect_to(action => 'show');
 
 262 sub action_test_database_connectivity {
 
 265   my %cfg       = %{ $::form->{client} || {} };
 
 266   my $dbconnect = 'dbi:Pg:dbname=' . $cfg{dbname} . ';host=' . $cfg{dbhost} . ';port=' . $cfg{dbport};
 
 267   my $dbh       = DBI->connect($dbconnect, $cfg{dbuser}, $cfg{dbpasswd});
 
 270   my $error     = $DBI::errstr;
 
 272   $dbh->disconnect if $dbh;
 
 274   $self->render('admin/test_db_connection', { layout => 0 },
 
 275                 title => t8('Database Connection Test'),
 
 284 sub action_new_group {
 
 287   $self->group(SL::DB::AuthGroup->new);
 
 288   $self->edit_group_form(title => t8('Create a new group'));
 
 291 sub action_edit_group {
 
 293   $self->edit_group_form(title => t8('Edit User Group'));
 
 296 sub action_save_group {
 
 299   my $params = delete($::form->{group}) || { };
 
 300   my $is_new = !$params->{id};
 
 302   # Assign empty arrays if the browser doesn't send those controls.
 
 303   $params->{clients} ||= [];
 
 304   $params->{users}   ||= [];
 
 306   $self->group($is_new ? SL::DB::AuthGroup->new : SL::DB::AuthGroup->new(id => $params->{id})->load)->assign_attributes(%{ $params });
 
 308   my @errors = $self->group->validate;
 
 311     flash('error', @errors);
 
 312     $self->edit_group_form(title => $is_new ? t8('Create a new user group') : t8('Edit User Group'));
 
 318   flash_later('info', $is_new ? t8('The user group has been created.') : t8('The user group has been saved.'));
 
 319   $self->redirect_to(action => 'show');
 
 322 sub action_delete_group {
 
 325   if (!$self->group->delete) {
 
 326     flash('error', t8('The user group could not be deleted.'));
 
 327     $self->edit_group_form(title => t8('Edit User Group'));
 
 331   flash_later('info', t8('The user group has been deleted.'));
 
 332   $self->redirect_to(action => 'show');
 
 339 sub action_list_printers {
 
 341   $self->render('admin/list_printers', title => t8('Printer management'));
 
 344 sub action_new_printer {
 
 347   $self->printer(SL::DB::Printer->new);
 
 348   $self->edit_printer_form(title => t8('Create a new printer'));
 
 351 sub action_edit_printer {
 
 353   $self->edit_printer_form(title => t8('Edit Printer'));
 
 356 sub action_save_printer {
 
 358   my $params = delete($::form->{printer}) || { };
 
 359   my $is_new = !$params->{id};
 
 361   $self->printer($is_new ? SL::DB::Printer->new : SL::DB::Printer->new(id => $params->{id})->load)->assign_attributes(%{ $params });
 
 363   my @errors = $self->printer->validate;
 
 366     flash('error', @errors);
 
 367     $self->edit_printer_form(title => $is_new ? t8('Create a new printer') : t8('Edit Printer'));
 
 371   $self->printer->save;
 
 373   flash_later('info', $is_new ? t8('The printer has been created.') : t8('The printer has been saved.'));
 
 374   $self->redirect_to(action => 'list_printers', 'client.id' => $self->client->id);
 
 377 sub action_delete_printer {
 
 380   if (!$self->printer->delete) {
 
 381     flash('error', t8('The printer could not be deleted.'));
 
 382     $self->edit_printer_form(title => t8('Edit Printer'));
 
 386   flash_later('info', t8('The printer has been deleted.'));
 
 387   $self->redirect_to(action => 'list_printers', 'client.id' => $self->client->id);
 
 391 # actions: database administration
 
 394 sub action_create_dataset_login {
 
 397   $self->database_administration_login_form(
 
 398     title       => t8('Create Dataset'),
 
 399     next_action => 'create_dataset',
 
 403 sub action_create_dataset {
 
 406   my %superuser = $self->check_database_superuser_privileges(no_credentials_not_an_error => 1);
 
 407   $self->create_dataset_form(superuser => \%superuser);
 
 410 sub action_do_create_dataset {
 
 413   my %superuser = $self->check_database_superuser_privileges;
 
 416   push @errors, t8("Dataset missing!")          if !$::form->{db};
 
 417   push @errors, t8("Default currency missing!") if !$::form->{defaultcurrency};
 
 418   push @errors, $superuser{error}               if !$superuser{have_privileges} && $superuser{error};
 
 421     flash('error', @errors);
 
 422     return $self->create_dataset_form(superuser => \%superuser);
 
 425   $::form->{encoding} = 'UNICODE';
 
 426   User->new->dbcreate($::form);
 
 428   flash_later('info', t8("The dataset #1 has been created.", $::form->{db}));
 
 429   $self->redirect_to(action => 'show');
 
 432 sub action_delete_dataset_login {
 
 435   $self->database_administration_login_form(
 
 436     title       => t8('Delete Dataset'),
 
 437     next_action => 'delete_dataset',
 
 441 sub action_delete_dataset {
 
 443   $self->delete_dataset_form;
 
 446 sub action_do_delete_dataset {
 
 450   push @errors, t8("Dataset missing!") if !$::form->{db};
 
 453     flash('error', @errors);
 
 454     return $self->delete_dataset_form;
 
 457   User->new->dbdelete($::form);
 
 459   flash_later('info', t8("The dataset #1 has been deleted.", $::form->{db}));
 
 460   $self->redirect_to(action => 'show');
 
 464 # actions: locking, unlocking
 
 467 sub action_show_lock {
 
 472     title => "kivitendo " . t8('Administration'),
 
 476 sub action_unlock_system {
 
 479   SL::System::InstallationLock->unlock;
 
 480   flash_later('info', t8('Lockfile removed!'));
 
 481   $self->redirect_to(action => 'show');
 
 484 sub action_lock_system {
 
 487   SL::System::InstallationLock->lock;
 
 488   flash_later('info', t8('Lockfile created!'));
 
 489   $self->redirect_to(action => 'show');
 
 496 sub init_db_cfg            { $::lx_office_conf{'authentication/database'}                                                    }
 
 497 sub init_is_locked         { SL::System::InstallationLock->is_locked                                                         }
 
 498 sub init_client            { SL::DB::Manager::AuthClient->find_by(id => (($::form->{client} || {})->{id} || $::form->{id}))  }
 
 499 sub init_user              { SL::DB::AuthUser  ->new(id => ($::form->{id} || ($::form->{user}    || {})->{id}))->load        }
 
 500 sub init_group             { SL::DB::AuthGroup ->new(id => ($::form->{id} || ($::form->{group}   || {})->{id}))->load        }
 
 501 sub init_printer           { SL::DB::Printer   ->new(id => ($::form->{id} || ($::form->{printer} || {})->{id}))->load        }
 
 502 sub init_all_clients       { SL::DB::Manager::AuthClient->get_all_sorted                                                     }
 
 503 sub init_all_users         { SL::DB::Manager::AuthUser  ->get_all_sorted                                                     }
 
 504 sub init_all_groups        { SL::DB::Manager::AuthGroup ->get_all_sorted                                                     }
 
 505 sub init_all_printers      { SL::DB::Manager::Printer   ->get_all_sorted                                                     }
 
 506 sub init_all_dateformats   { [ qw(mm/dd/yy dd/mm/yy dd.mm.yy yyyy-mm-dd)      ]                                              }
 
 507 sub init_all_numberformats { [ '1,000.00', '1000.00', '1.000,00', '1000,00', "1'000.00" ]                                    }
 
 508 sub init_all_stylesheets   { [ qw(lx-office-erp.css Mobile.css kivitendo.css) ]                                              }
 
 509 sub init_all_dbsources             { [ sort User->dbsources($::form)                               ] }
 
 510 sub init_all_used_dbsources        { { map { (join(':', $_->dbhost || 'localhost', $_->dbport || 5432, $_->dbname) => $_->name) } @{ $_[0]->all_clients }  } }
 
 511 sub init_all_accounting_methods    { [ { id => 'accrual',   name => t8('Accrual accounting')  }, { id => 'cash',     name => t8('Cash accounting')       } ] }
 
 512 sub init_all_inventory_systems     { [ { id => 'perpetual', name => t8('Perpetual inventory') }, { id => 'periodic', name => t8('Periodic inventory')    } ] }
 
 513 sub init_all_profit_determinations { [ { id => 'balance',   name => t8('Balancing')           }, { id => 'income',   name => t8('Cash basis accounting') } ] }
 
 515 sub init_all_charts {
 
 516   tie my %dir_h, 'IO::Dir', 'sql/';
 
 519     map { s/-chart\.sql$//; +{ id => $_ } }
 
 521     grep { /-chart\.sql\z/ && !/Default-chart.sql\z/ }
 
 526 sub init_all_menustyles    {
 
 528     { id => 'old', title => $::locale->text('Old (on the side)') },
 
 529     { id => 'v3',  title => $::locale->text('Top (CSS)') },
 
 530     { id => 'neu', title => $::locale->text('Top (Javascript)') },
 
 534 sub init_all_rights {
 
 535   my (@sections, $current_section);
 
 537   foreach my $entry ($::auth->all_rights_full) {
 
 539       push @sections, { description => t8($entry->[1]), rights => [] };
 
 541     } elsif (@sections) {
 
 542       push @{ $sections[-1]->{rights} }, {
 
 544         description => t8($entry->[1]),
 
 548       die "Right without sections: " . join('::', @{ $entry });
 
 555 sub init_all_countrycodes {
 
 556   my %cc = User->country_codes;
 
 557   return [ map { id => $_, title => $cc{$_} }, sort { $cc{$a} cmp $cc{$b} } keys %cc ];
 
 565   my ($self, $action) = @_;
 
 567   my $defaults = SL::DefaultManager->new($::lx_office_conf{system}->{default_manager});
 
 568   $::request->layout(SL::Layout::Dispatcher->new(style => 'admin'));
 
 569   $::form->{favicon} = "favicon.ico";
 
 571     countrycode      => $defaults->language('de'),
 
 572     numberformat     => $defaults->numberformat('1.000,00'),
 
 573     dateformat       => $defaults->dateformat('dd.mm.yy'),
 
 580   $self->client(SL::DB::Manager::AuthClient->get_default || $self->all_clients->[0]) if !$self->client;
 
 581   $::auth->set_client($self->client->id) if $self->client;
 
 588 sub use_multiselect_js {
 
 591   $::request->layout->use_javascript("${_}.js") for qw(jquery.selectboxes jquery.multiselect2side);
 
 596   my ($self, %params) = @_;
 
 597   $::request->layout(SL::Layout::AdminLogin->new);
 
 598   my $version         = SL::Version->get_version;
 
 599   $self->render('admin/adminlogin', title => t8('kivitendo v#1 administration', $version), %params, version => $version );
 
 603   my ($self, %params) = @_;
 
 604   $self->use_multiselect_js->render('admin/edit_user', %params);
 
 607 sub edit_client_form {
 
 608   my ($self, %params) = @_;
 
 609   $self->use_multiselect_js->render('admin/edit_client', %params);
 
 612 sub edit_group_form {
 
 613   my ($self, %params) = @_;
 
 614   $self->use_multiselect_js->render('admin/edit_group', %params);
 
 617 sub edit_printer_form {
 
 618   my ($self, %params) = @_;
 
 619   $self->render('admin/edit_printer', %params);
 
 622 sub database_administration_login_form {
 
 623   my ($self, %params) = @_;
 
 627     dbhost    => $::form->{dbhost}    || $::auth->{DB_config}->{host} || 'localhost',
 
 628     dbport    => $::form->{dbport}    || $::auth->{DB_config}->{port} || 5432,
 
 629     dbuser    => $::form->{dbuser}    || $::auth->{DB_config}->{user} || 'kivitendo',
 
 630     dbpasswd  => $::form->{dbpasswd}  || $::auth->{DB_config}->{password},
 
 631     dbdefault => $::form->{dbdefault} || 'template1',
 
 636 sub create_dataset_form {
 
 637   my ($self, %params) = @_;
 
 639   my $defaults = SL::DefaultManager->new($::lx_office_conf{system}->{default_manager});
 
 640   $::form->{favicon} = "favicon.ico";
 
 641   $::form->{countrymode}             = $defaults->country('DE');
 
 642   $::form->{chart}                   = $defaults->chart_of_accounts('Germany-DATEV-SKR03EU');
 
 643   $::form->{defaultcurrency}         = $defaults->currency('EUR');
 
 644   $::form->{precision}               = $defaults->precision(0.01);
 
 645   $::form->{accounting_method}       = $defaults->accounting_method('cash');
 
 646   $::form->{inventory_system}        = $defaults->inventory_system('periodic');
 
 647   $::form->{profit_determination}    = $defaults->profit_determination('balance');
 
 648   $::form->{feature_balance}         = $defaults->feature_balance(1);
 
 649   $::form->{feature_datev}           = $defaults->feature_datev(1);
 
 650   $::form->{feature_erfolgsrechnung} = $defaults->feature_erfolgsrechnung(0);
 
 651   $::form->{feature_eurechnung}      = $defaults->feature_eurechnung(1);
 
 652   $::form->{feature_ustva}           = $defaults->feature_ustva(1);
 
 654   $self->render('admin/create_dataset', title => (t8('Database Administration') . " / " . t8('Create Dataset')), superuser => $params{superuser});
 
 657 sub delete_dataset_form {
 
 658   my ($self, %params) = @_;
 
 659   $self->render('admin/delete_dataset', title => (t8('Database Administration') . " / " . t8('Delete Dataset')));
 
 666 sub check_auth_db_and_tables {
 
 669   if (!$::auth->check_database) {
 
 670     $self->render('admin/check_auth_database', title => t8('Authentification database creation'));
 
 674   if (!$::auth->check_tables) {
 
 675     $self->render('admin/check_auth_tables', title => t8('Authentification tables creation'));
 
 682 sub apply_dbupgrade_scripts {
 
 683   return SL::DBUpgrade2->new(form => $::form, auth => 1)->apply_admin_dbupgrade_scripts(1);
 
 686 sub authenticate_root {
 
 689   return 1 if $::auth->authenticate_root($::form->{'{AUTH}admin_password'}) == $::auth->OK();
 
 691   $::auth->punish_wrong_login;
 
 692   $::auth->delete_session_value('admin_password');
 
 694   $self->login_form(error => t8('Incorrect password!'));
 
 699 sub is_user_used_for_task_server {
 
 700   my ($self, $user) = @_;
 
 702   return undef if !$user;
 
 703   return join ', ', sort_by { lc } map { $_->name } @{ SL::DB::Manager::AuthClient->get_all(where => [ task_server_user_id => $user->id ]) };
 
 706 sub check_database_superuser_privileges {
 
 707   my ($self, %params) = @_;
 
 709   my %dbconnect_form = %{ $::form };
 
 711     username => $dbconnect_form{dbuser},
 
 712     password => $dbconnect_form{dbpasswd},
 
 715   my $check_privileges = sub {
 
 716     my $dbh = SL::DBConnect->connect($dbconnect_form{dbconnect}, $result{username}, $result{password}, SL::DBConnect->get_options);
 
 717     return (error => $::locale->text('The credentials (username & password) for connecting database are wrong.')) if !$dbh;
 
 719     my $is_superuser = SL::DBUtils::role_is_superuser($dbh, $result{username});
 
 723     return (have_privileges => $is_superuser);
 
 726   User::dbconnect_vars(\%dbconnect_form, $dbconnect_form{dbdefault});
 
 730     $check_privileges->(),
 
 733   if (!$result{have_privileges}) {
 
 734     $result{username} = $::form->{database_superuser_user};
 
 735     $result{password} = $::form->{database_superuser_password};
 
 737     if ($::form->{database_superuser_user}) {
 
 740         $check_privileges->(),
 
 745   if ($result{have_privileges}) {
 
 746     $::auth->set_session_value(database_superuser_username => $result{username}, database_superuser_password => $result{password});
 
 750   $::auth->delete_session_value(qw(database_superuser_username database_superuser_password));
 
 752   return ()                                                                            if !$::form->{database_superuser_user} && $params{no_credentials_not_an_error};
 
 753   return (%result, error => $::locale->text('No superuser credentials were entered.')) if !$::form->{database_superuser_user};
 
 754   return %result                                                                       if $result{error};
 
 755   return (%result, error => $::locale->text('The database user \'#1\' does not have superuser privileges.', $result{username}));