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" };
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 return if $self->apply_dbupgrade_scripts;
89 my $group = (SL::DB::Manager::AuthGroup->get_all(limit => 1))[0];
91 SL::DB::AuthGroup->new(
92 name => t8('Full Access'),
93 description => t8('Full access to all functions'),
94 rights => [ map { SL::DB::AuthGroupRight->new(right => $_, granted => 1) } $::auth->all_rights ],
110 title => "kivitendo " . t8('Administration'),
114 sub action_new_user {
117 my $defaults = SL::DefaultManager->new($::lx_office_conf{system}->{default_manager});
118 $self->user(SL::DB::AuthUser->new(
120 countrycode => $defaults->language('de'),
121 numberformat => $defaults->numberformat('1.000,00'),
122 dateformat => $defaults->dateformat('dd.mm.yy'),
123 stylesheet => "kivitendo.css",
128 $self->edit_user_form(title => t8('Create a new user'));
131 sub action_edit_user {
133 $self->edit_user_form(title => t8('Edit User'));
136 sub action_save_user {
138 my $params = delete($::form->{user}) || { };
139 my $props = delete($params->{config_values}) || { };
140 my $is_new = !$params->{id};
142 # Assign empty arrays if the browser doesn't send those controls.
143 $params->{clients} ||= [];
144 $params->{groups} ||= [];
146 $self->user($is_new ? SL::DB::AuthUser->new : SL::DB::AuthUser->new(id => $params->{id})->load)
147 ->assign_attributes(%{ $params })
148 ->config_values({ %{ $self->user->config_values }, %{ $props } });
150 my @errors = $self->user->validate;
153 flash('error', @errors);
154 $self->edit_user_form(title => $is_new ? t8('Create a new user') : t8('Edit User'));
160 if ($::auth->can_change_password && $::form->{new_password}) {
161 $::auth->change_password($self->user->login, $::form->{new_password});
164 flash_later('info', $is_new ? t8('The user has been created.') : t8('The user has been saved.'));
165 $self->redirect_to(action => 'show');
168 sub action_delete_user {
171 my @clients = @{ $self->user->clients || [] };
173 # backup user metadata (email, name, etc)
174 my $user_config_values_ref = $self->user->config_values();
175 my $login =$self->user->login;
177 if (!$self->user->delete) {
178 flash('error', t8('The user could not be deleted.'));
179 $self->edit_user_form(title => t8('Edit User'));
183 # Flag corresponding entries in 'employee' as deleted.
184 # and restore the most important user data in employee
185 # TODO try and catch the whole transaction {user->delete; update employee} {exception}
186 foreach my $client (@clients) {
187 my $dbh = $client->dbconnect(AutoCommit => 1) || next;
188 $dbh->do(qq|UPDATE employee SET deleted = TRUE, name = ?, deleted_email = ?,
189 deleted_tel = ?, deleted_fax = ?, deleted_signature = ? WHERE login = ?|,undef,
190 $user_config_values_ref->{name}, $user_config_values_ref->{email},
191 $user_config_values_ref->{tel}, $user_config_values_ref->{fax},
192 $user_config_values_ref->{signature}, $self->user->login);
196 flash_later('info', t8('The user has been deleted.'));
197 $self->redirect_to(action => 'show');
204 sub action_new_client {
207 $self->client(SL::DB::AuthClient->new(
208 dbhost => $::auth->{DB_config}->{host},
209 dbport => $::auth->{DB_config}->{port},
210 dbuser => $::auth->{DB_config}->{user},
211 dbpasswd => $::auth->{DB_config}->{password},
214 $self->edit_client_form(title => t8('Create a new client'));
217 sub action_edit_client {
219 $self->edit_client_form(title => t8('Edit Client'));
222 sub action_save_client {
224 my $params = delete($::form->{client}) || { };
225 my $is_new = !$params->{id};
227 # Assign empty arrays if the browser doesn't send those controls.
228 $params->{groups} ||= [];
229 $params->{users} ||= [];
231 $self->client($is_new ? SL::DB::AuthClient->new : SL::DB::AuthClient->new(id => $params->{id})->load)->assign_attributes(%{ $params });
233 my @errors = $self->client->validate;
236 flash('error', @errors);
237 $self->edit_client_form(title => $is_new ? t8('Create a new client') : t8('Edit Client'));
242 if ($self->client->is_default) {
243 SL::DB::Manager::AuthClient->update_all(set => { is_default => 0 }, where => [ '!id' => $self->client->id ]);
246 flash_later('info', $is_new ? t8('The client has been created.') : t8('The client has been saved.'));
247 $self->redirect_to(action => 'show');
250 sub action_delete_client {
253 if (!$self->client->delete) {
254 flash('error', t8('The client could not be deleted.'));
255 $self->edit_client_form(title => t8('Edit Client'));
259 flash_later('info', t8('The client has been deleted.'));
260 $self->redirect_to(action => 'show');
263 sub action_test_database_connectivity {
266 my %cfg = %{ $::form->{client} || {} };
267 my $dbconnect = 'dbi:Pg:dbname=' . $cfg{dbname} . ';host=' . $cfg{dbhost} . ';port=' . $cfg{dbport};
268 my $dbh = DBI->connect($dbconnect, $cfg{dbuser}, $cfg{dbpasswd});
271 my $error = $DBI::errstr;
273 $dbh->disconnect if $dbh;
275 $self->render('admin/test_db_connection', { layout => 0 },
276 title => t8('Database Connection Test'),
285 sub action_new_group {
288 $self->group(SL::DB::AuthGroup->new);
289 $self->edit_group_form(title => t8('Create a new group'));
292 sub action_edit_group {
294 $self->edit_group_form(title => t8('Edit User Group'));
297 sub action_save_group {
300 my $params = delete($::form->{group}) || { };
301 my $is_new = !$params->{id};
303 # Assign empty arrays if the browser doesn't send those controls.
304 $params->{clients} ||= [];
305 $params->{users} ||= [];
307 $self->group($is_new ? SL::DB::AuthGroup->new : SL::DB::AuthGroup->new(id => $params->{id})->load)->assign_attributes(%{ $params });
309 my @errors = $self->group->validate;
312 flash('error', @errors);
313 $self->edit_group_form(title => $is_new ? t8('Create a new user group') : t8('Edit User Group'));
319 flash_later('info', $is_new ? t8('The user group has been created.') : t8('The user group has been saved.'));
320 $self->redirect_to(action => 'show');
323 sub action_delete_group {
326 if (!$self->group->delete) {
327 flash('error', t8('The user group could not be deleted.'));
328 $self->edit_group_form(title => t8('Edit User Group'));
332 flash_later('info', t8('The user group has been deleted.'));
333 $self->redirect_to(action => 'show');
340 sub action_list_printers {
342 $self->render('admin/list_printers', title => t8('Printer management'));
345 sub action_new_printer {
348 $self->printer(SL::DB::Printer->new);
349 $self->edit_printer_form(title => t8('Create a new printer'));
352 sub action_edit_printer {
354 $self->edit_printer_form(title => t8('Edit Printer'));
357 sub action_save_printer {
359 my $params = delete($::form->{printer}) || { };
360 my $is_new = !$params->{id};
362 $self->printer($is_new ? SL::DB::Printer->new : SL::DB::Printer->new(id => $params->{id})->load)->assign_attributes(%{ $params });
364 my @errors = $self->printer->validate;
367 flash('error', @errors);
368 $self->edit_printer_form(title => $is_new ? t8('Create a new printer') : t8('Edit Printer'));
372 $self->printer->save;
374 flash_later('info', $is_new ? t8('The printer has been created.') : t8('The printer has been saved.'));
375 $self->redirect_to(action => 'list_printers', 'client.id' => $self->client->id);
378 sub action_delete_printer {
381 if (!$self->printer->delete) {
382 flash('error', t8('The printer could not be deleted.'));
383 $self->edit_printer_form(title => t8('Edit Printer'));
387 flash_later('info', t8('The printer has been deleted.'));
388 $self->redirect_to(action => 'list_printers', 'client.id' => $self->client->id);
392 # actions: database administration
395 sub action_create_dataset_login {
398 $self->database_administration_login_form(
399 title => t8('Create Dataset'),
400 next_action => 'create_dataset',
404 sub action_create_dataset {
407 my %superuser = $self->check_database_superuser_privileges(no_credentials_not_an_error => 1);
408 $self->create_dataset_form(superuser => \%superuser);
411 sub action_do_create_dataset {
414 my %superuser = $self->check_database_superuser_privileges;
417 push @errors, t8("Dataset missing!") if !$::form->{db};
418 push @errors, t8("Default currency missing!") if !$::form->{defaultcurrency};
419 push @errors, $superuser{error} if !$superuser{have_privileges} && $superuser{error};
422 flash('error', @errors);
423 return $self->create_dataset_form(superuser => \%superuser);
426 $::form->{encoding} = 'UNICODE';
427 User->new->dbcreate($::form);
429 flash_later('info', t8("The dataset #1 has been created.", $::form->{db}));
430 $self->redirect_to(action => 'show');
433 sub action_delete_dataset_login {
436 $self->database_administration_login_form(
437 title => t8('Delete Dataset'),
438 next_action => 'delete_dataset',
442 sub action_delete_dataset {
444 $self->delete_dataset_form;
447 sub action_do_delete_dataset {
451 push @errors, t8("Dataset missing!") if !$::form->{db};
454 flash('error', @errors);
455 return $self->delete_dataset_form;
458 User->new->dbdelete($::form);
460 flash_later('info', t8("The dataset #1 has been deleted.", $::form->{db}));
461 $self->redirect_to(action => 'show');
465 # actions: locking, unlocking
468 sub action_show_lock {
473 title => "kivitendo " . t8('Administration'),
477 sub action_unlock_system {
480 SL::System::InstallationLock->unlock;
481 flash_later('info', t8('Lockfile removed!'));
482 $self->redirect_to(action => 'show');
485 sub action_lock_system {
488 SL::System::InstallationLock->lock;
489 flash_later('info', t8('Lockfile created!'));
490 $self->redirect_to(action => 'show');
497 sub init_db_cfg { $::lx_office_conf{'authentication/database'} }
498 sub init_is_locked { SL::System::InstallationLock->is_locked }
499 sub init_client { SL::DB::Manager::AuthClient->find_by(id => (($::form->{client} || {})->{id} || $::form->{id})) }
500 sub init_user { SL::DB::AuthUser ->new(id => ($::form->{id} || ($::form->{user} || {})->{id}))->load }
501 sub init_group { SL::DB::AuthGroup ->new(id => ($::form->{id} || ($::form->{group} || {})->{id}))->load }
502 sub init_printer { SL::DB::Printer ->new(id => ($::form->{id} || ($::form->{printer} || {})->{id}))->load }
503 sub init_all_clients { SL::DB::Manager::AuthClient->get_all_sorted }
504 sub init_all_users { SL::DB::Manager::AuthUser ->get_all_sorted }
505 sub init_all_groups { SL::DB::Manager::AuthGroup ->get_all_sorted }
506 sub init_all_printers { SL::DB::Manager::Printer ->get_all_sorted }
507 sub init_all_dateformats { [ qw(mm/dd/yy dd/mm/yy dd.mm.yy yyyy-mm-dd) ] }
508 sub init_all_numberformats { [ '1,000.00', '1000.00', '1.000,00', '1000,00', "1'000.00" ] }
509 sub init_all_stylesheets { [ qw(lx-office-erp.css Mobile.css kivitendo.css) ] }
510 sub init_all_dbsources { [ sort User->dbsources($::form) ] }
511 sub init_all_used_dbsources { { map { (join(':', $_->dbhost || 'localhost', $_->dbport || 5432, $_->dbname) => $_->name) } @{ $_[0]->all_clients } } }
512 sub init_all_accounting_methods { [ { id => 'accrual', name => t8('Accrual accounting') }, { id => 'cash', name => t8('Cash accounting') } ] }
513 sub init_all_inventory_systems { [ { id => 'perpetual', name => t8('Perpetual inventory') }, { id => 'periodic', name => t8('Periodic inventory') } ] }
514 sub init_all_profit_determinations { [ { id => 'balance', name => t8('Balancing') }, { id => 'income', name => t8('Cash basis accounting') } ] }
516 sub init_all_charts {
517 tie my %dir_h, 'IO::Dir', 'sql/';
520 map { s/-chart\.sql$//; +{ id => $_ } }
522 grep { /-chart\.sql\z/ && !/Default-chart.sql\z/ }
527 sub init_all_menustyles {
529 { id => 'old', title => $::locale->text('Old (on the side)') },
530 { id => 'v3', title => $::locale->text('Top (CSS)') },
531 { id => 'neu', title => $::locale->text('Top (Javascript)') },
535 sub init_all_rights {
536 my (@sections, $current_section);
538 foreach my $entry ($::auth->all_rights_full) {
540 push @sections, { description => t8($entry->[1]), rights => [] };
542 } elsif (@sections) {
543 push @{ $sections[-1]->{rights} }, {
545 description => t8($entry->[1]),
549 die "Right without sections: " . join('::', @{ $entry });
556 sub init_all_countrycodes {
557 my %cc = User->country_codes;
558 return [ map { id => $_, title => $cc{$_} }, sort { $cc{$a} cmp $cc{$b} } keys %cc ];
566 my ($self, $action) = @_;
568 my $defaults = SL::DefaultManager->new($::lx_office_conf{system}->{default_manager});
569 $::request->layout(SL::Layout::Dispatcher->new(style => 'admin'));
570 $::form->{favicon} = "favicon.ico";
572 countrycode => $defaults->language('de'),
573 numberformat => $defaults->numberformat('1.000,00'),
574 dateformat => $defaults->dateformat('dd.mm.yy'),
581 $self->client(SL::DB::Manager::AuthClient->get_default || $self->all_clients->[0]) if !$self->client;
582 $::auth->set_client($self->client->id) if $self->client;
589 sub use_multiselect_js {
592 $::request->layout->use_javascript("${_}.js") for qw(jquery.selectboxes jquery.multiselect2side);
597 my ($self, %params) = @_;
598 $::request->layout(SL::Layout::AdminLogin->new);
599 my $version = SL::Version->get_version;
600 $self->render('admin/adminlogin', title => t8('kivitendo v#1 administration', $version), %params, version => $version );
604 my ($self, %params) = @_;
605 $self->use_multiselect_js->render('admin/edit_user', %params);
608 sub edit_client_form {
609 my ($self, %params) = @_;
610 $self->use_multiselect_js->render('admin/edit_client', %params);
613 sub edit_group_form {
614 my ($self, %params) = @_;
615 $self->use_multiselect_js->render('admin/edit_group', %params);
618 sub edit_printer_form {
619 my ($self, %params) = @_;
620 $self->render('admin/edit_printer', %params);
623 sub database_administration_login_form {
624 my ($self, %params) = @_;
628 dbhost => $::form->{dbhost} || $::auth->{DB_config}->{host} || 'localhost',
629 dbport => $::form->{dbport} || $::auth->{DB_config}->{port} || 5432,
630 dbuser => $::form->{dbuser} || $::auth->{DB_config}->{user} || 'kivitendo',
631 dbpasswd => $::form->{dbpasswd} || $::auth->{DB_config}->{password},
632 dbdefault => $::form->{dbdefault} || 'template1',
637 sub create_dataset_form {
638 my ($self, %params) = @_;
640 my $defaults = SL::DefaultManager->new($::lx_office_conf{system}->{default_manager});
641 $::form->{favicon} = "favicon.ico";
642 $::form->{countrymode} = $defaults->country('DE');
643 $::form->{chart} = $defaults->chart_of_accounts('Germany-DATEV-SKR03EU');
644 $::form->{defaultcurrency} = $defaults->currency('EUR');
645 $::form->{precision} = $defaults->precision(0.01);
646 $::form->{accounting_method} = $defaults->accounting_method('cash');
647 $::form->{inventory_system} = $defaults->inventory_system('periodic');
648 $::form->{profit_determination} = $defaults->profit_determination('balance');
649 $::form->{feature_balance} = $defaults->feature_balance(1);
650 $::form->{feature_datev} = $defaults->feature_datev(1);
651 $::form->{feature_erfolgsrechnung} = $defaults->feature_erfolgsrechnung(0);
652 $::form->{feature_eurechnung} = $defaults->feature_eurechnung(1);
653 $::form->{feature_ustva} = $defaults->feature_ustva(1);
655 $self->render('admin/create_dataset', title => (t8('Database Administration') . " / " . t8('Create Dataset')), superuser => $params{superuser});
658 sub delete_dataset_form {
659 my ($self, %params) = @_;
660 $self->render('admin/delete_dataset', title => (t8('Database Administration') . " / " . t8('Delete Dataset')));
667 sub check_auth_db_and_tables {
670 if (!$::auth->check_database) {
671 $self->render('admin/check_auth_database', title => t8('Authentification database creation'));
675 if (!$::auth->check_tables) {
676 $self->render('admin/check_auth_tables', title => t8('Authentification tables creation'));
683 sub apply_dbupgrade_scripts {
684 return SL::DBUpgrade2->new(form => $::form, auth => 1)->apply_admin_dbupgrade_scripts(1);
687 sub authenticate_root {
690 return 1 if $::auth->authenticate_root($::form->{'{AUTH}admin_password'}) == $::auth->OK();
692 $::auth->punish_wrong_login;
693 $::auth->delete_session_value('admin_password');
695 $self->login_form(error => t8('Incorrect password!'));
700 sub is_user_used_for_task_server {
701 my ($self, $user) = @_;
703 return undef if !$user;
704 return join ', ', sort_by { lc } map { $_->name } @{ SL::DB::Manager::AuthClient->get_all(where => [ task_server_user_id => $user->id ]) };
707 sub check_database_superuser_privileges {
708 my ($self, %params) = @_;
710 my %dbconnect_form = %{ $::form };
712 username => $dbconnect_form{dbuser},
713 password => $dbconnect_form{dbpasswd},
716 my $check_privileges = sub {
717 my $dbh = SL::DBConnect->connect($dbconnect_form{dbconnect}, $result{username}, $result{password}, SL::DBConnect->get_options);
718 return (error => $::locale->text('The credentials (username & password) for connecting database are wrong.')) if !$dbh;
720 my $is_superuser = SL::DBUtils::role_is_superuser($dbh, $result{username});
724 return (have_privileges => $is_superuser);
727 User::dbconnect_vars(\%dbconnect_form, $dbconnect_form{dbdefault});
731 $check_privileges->(),
734 if (!$result{have_privileges}) {
735 $result{username} = $::form->{database_superuser_user};
736 $result{password} = $::form->{database_superuser_password};
738 if ($::form->{database_superuser_user}) {
741 $check_privileges->(),
746 if ($result{have_privileges}) {
747 $::auth->set_session_value(database_superuser_username => $result{username}, database_superuser_password => $result{password});
751 $::auth->delete_session_value(qw(database_superuser_username database_superuser_password));
753 return () if !$::form->{database_superuser_user} && $params{no_credentials_not_an_error};
754 return (%result, error => $::locale->text('No superuser credentials were entered.')) if !$::form->{database_superuser_user};
755 return %result if $result{error};
756 return (%result, error => $::locale->text('The database user \'#1\' does not have superuser privileges.', $result{username}));