X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;ds=inline;f=SL%2FAuth.pm;h=e8d6c72e1f21a69c48ba400b2c21d623232b5f97;hb=5737ce39a18326f1c3ae70a5afcc2d494fb901c7;hp=22cef8d0d87c3ddb9e5877e673eeed858ddda4db;hpb=705b8473dadb67940c396af5519689506d1c0845;p=kivitendo-erp.git
diff --git a/SL/Auth.pm b/SL/Auth.pm
index 22cef8d0d..e8d6c72e1 100644
--- a/SL/Auth.pm
+++ b/SL/Auth.pm
@@ -1,70 +1,123 @@
package SL::Auth;
-use constant OK => 0;
-use constant ERR_PASSWORD => 1;
-use constant ERR_BACKEND => 100;
-
-use constant SESSION_OK => 0;
-use constant SESSION_NONE => 1;
-use constant SESSION_EXPIRED => 2;
+use DBI;
use Digest::MD5 qw(md5_hex);
use IO::File;
use Time::HiRes qw(gettimeofday);
+use List::MoreUtils qw(uniq);
+use YAML;
+use Regexp::IPv6 qw($IPv6_re);
+use SL::Auth::ColumnInformation;
+use SL::Auth::Constants qw(:all);
use SL::Auth::DB;
use SL::Auth::LDAP;
+use SL::Auth::Password;
+use SL::Auth::SessionValue;
+use SL::SessionFile;
use SL::User;
-use SL::DBUtils;
+use SL::DBConnect;
+use SL::DBUpgrade2;
+use SL::DBUtils qw(do_query do_statement prepare_execute_query prepare_query selectall_array_query selectrow_query);
-sub new {
- $main::lxdebug->enter_sub();
+use strict;
- my $type = shift;
- my $self = {};
+use constant SESSION_KEY_ROOT_AUTH => 'session_auth_status_root';
+use constant SESSION_KEY_USER_AUTH => 'session_auth_status_user';
- bless $self, $type;
+use Rose::Object::MakeMethods::Generic (
+ scalar => [ qw(client) ],
+);
- $self->{SESSION} = { };
- $self->_read_auth_config();
+sub new {
+ my ($type, %params) = @_;
+ my $self = bless {}, $type;
- $main::lxdebug->leave_sub();
+ $self->_read_auth_config(%params);
+ $self->init;
return $self;
}
+sub init {
+ my ($self, %params) = @_;
+
+ $self->{SESSION} = { };
+ $self->{FULL_RIGHTS} = { };
+ $self->{RIGHTS} = { };
+ $self->{unique_counter} = 0;
+ $self->{column_information} = SL::Auth::ColumnInformation->new(auth => $self);
+}
+
+sub reset {
+ my ($self, %params) = @_;
+
+ $self->{SESSION} = { };
+ $self->{FULL_RIGHTS} = { };
+ $self->{RIGHTS} = { };
+ $self->{unique_counter} = 0;
+ $self->{column_information} = SL::Auth::ColumnInformation->new(auth => $self);
+ $self->{column_information}->_fetch;
+ $self->{authenticator}->reset;
+
+ $self->client(undef);
+}
+
+sub set_client {
+ my ($self, $id_or_name) = @_;
+
+ $self->client(undef);
+
+ return undef unless $id_or_name;
+
+ my $column = $id_or_name =~ m/^\d+$/ ? 'id' : 'name';
+ my $dbh = $self->dbconnect;
+
+ return undef unless $dbh;
+
+ $self->client($dbh->selectrow_hashref(qq|SELECT * FROM auth.clients WHERE ${column} = ?|, undef, $id_or_name));
+
+ return $self->client;
+}
+
sub DESTROY {
my $self = shift;
$self->{dbh}->disconnect() if ($self->{dbh});
}
-sub _read_auth_config {
- $main::lxdebug->enter_sub();
-
- my $self = shift;
+# form isn't loaded yet, so auth needs it's own error.
+sub mini_error {
+ $::lxdebug->show_backtrace();
- my $form = $main::form;
- my $locale = $main::locale;
+ my ($self, @msg) = @_;
+ if ($ENV{HTTP_USER_AGENT}) {
+ print Form->create_http_response(content_type => 'text/html');
+ print "
", join ('
', @msg), "
";
+ } else {
+ print STDERR "Error: @msg\n";
+ }
+ $::dispatcher->end_request;
+}
- my $code;
- my $in = IO::File->new('config/authentication.pl', 'r');
+sub _read_auth_config {
+ my ($self, %params) = @_;
- if (!$in) {
- $form->error($locale->text('The config file "config/authentication.pl" was not found.'));
- }
+ map { $self->{$_} = $::lx_office_conf{authentication}->{$_} } keys %{ $::lx_office_conf{authentication} };
- while (<$in>) {
- $code .= $_;
- }
- $in->close();
+ # Prevent password leakage to log files when dumping Auth instances.
+ $self->{admin_password} = sub { $::lx_office_conf{authentication}->{admin_password} };
- eval $code;
+ if ($params{unit_tests_database}) {
+ $self->{DB_config} = $::lx_office_conf{'testing/database'};
+ $self->{module} = 'DB';
- if ($@) {
- $form->error($locale->text('The config file "config/authentication.pl" contained invalid Perl code:') . "\n" . $@);
+ } else {
+ $self->{DB_config} = $::lx_office_conf{'authentication/database'};
+ $self->{LDAP_config} = $::lx_office_conf{'authentication/ldap'};
}
if ($self->{module} eq 'DB') {
@@ -75,60 +128,110 @@ sub _read_auth_config {
}
if (!$self->{authenticator}) {
- $form->error($locale->text('No or an unknown authenticantion module specified in "config/authentication.pl".'));
+ my $locale = Locale->new('en');
+ $self->mini_error($locale->text('No or an unknown authenticantion module specified in "config/kivitendo.conf".'));
}
my $cfg = $self->{DB_config};
if (!$cfg) {
- $form->error($locale->text('config/authentication.pl: Key "DB_config" is missing.'));
+ my $locale = Locale->new('en');
+ $self->mini_error($locale->text('config/kivitendo.conf: Key "DB_config" is missing.'));
}
if (!$cfg->{host} || !$cfg->{db} || !$cfg->{user}) {
- $form->error($locale->text('config/authentication.pl: Missing parameters in "DB_config". Required parameters are "host", "db" and "user".'));
+ my $locale = Locale->new('en');
+ $self->mini_error($locale->text('config/kivitendo.conf: Missing parameters in "authentication/database". Required parameters are "host", "db" and "user".'));
}
$self->{authenticator}->verify_config();
$self->{session_timeout} *= 1;
$self->{session_timeout} = 8 * 60 if (!$self->{session_timeout});
+}
+
+sub has_access_to_client {
+ my ($self, $login) = @_;
+
+ return 0 if !$self->client || !$self->client->{id};
- $main::lxdebug->leave_sub();
+ my $sql = <dbconnect->selectrow_array($sql, undef, $login, $self->client->{id});
+ return $has_access;
}
sub authenticate_root {
- $main::lxdebug->enter_sub();
+ my ($self, $password) = @_;
+
+ my $session_root_auth = $self->get_session_value(SESSION_KEY_ROOT_AUTH());
+ if (defined $session_root_auth && $session_root_auth == OK) {
+ return OK;
+ }
- my $self = shift;
- my $password = shift;
- my $is_crypted = shift;
+ if (!defined $password) {
+ return ERR_PASSWORD;
+ }
- $password = crypt $password, 'ro' if (!$password || !$is_crypted);
- my $admin_password = crypt "$self->{admin_password}", 'ro';
+ my $admin_password = SL::Auth::Password->hash_if_unhashed(login => 'root', password => $self->{admin_password}->());
+ $password = SL::Auth::Password->hash(login => 'root', password => $password, stored_password => $admin_password);
- $main::lxdebug->leave_sub();
+ my $result = $password eq $admin_password ? OK : ERR_PASSWORD;
+ $self->set_session_value(SESSION_KEY_ROOT_AUTH() => $result);
- return $password eq $admin_password ? OK : ERR_PASSWORD;
+ return $result;
}
sub authenticate {
- $main::lxdebug->enter_sub();
+ my ($self, $login, $password) = @_;
- my $self = shift;
+ if (!$self->client || !$self->has_access_to_client($login)) {
+ return ERR_PASSWORD;
+ }
- $main::lxdebug->leave_sub();
+ my $session_auth = $self->get_session_value(SESSION_KEY_USER_AUTH());
+ if (defined $session_auth && $session_auth == OK) {
+ return OK;
+ }
- return $self->{authenticator}->authenticate(@_);
+ if (!defined $password) {
+ return ERR_PASSWORD;
+ }
+
+ my $result = $login ? $self->{authenticator}->authenticate($login, $password) : ERR_USER;
+ $self->set_session_value(SESSION_KEY_USER_AUTH() => $result, login => $login, client_id => $self->client->{id});
+ return $result;
}
-sub dbconnect {
- $main::lxdebug->enter_sub(2);
+sub punish_wrong_login {
+ my $failed_login_penalty = ($::lx_office_conf{authentication} || {})->{failed_login_penalty};
+ sleep $failed_login_penalty if $failed_login_penalty;
+}
+sub get_stored_password {
+ my ($self, $login) = @_;
+
+ my $dbh = $self->dbconnect;
+
+ return undef unless $dbh;
+
+ my $query = qq|SELECT password FROM auth."user" WHERE login = ?|;
+ my ($stored_password) = $dbh->selectrow_array($query, undef, $login);
+
+ return $stored_password;
+}
+
+sub dbconnect {
my $self = shift;
my $may_fail = shift;
if ($self->{dbh}) {
- $main::lxdebug->leave_sub(2);
return $self->{dbh};
}
@@ -139,62 +242,46 @@ sub dbconnect {
$dsn .= ';port=' . $cfg->{port};
}
- $main::lxdebug->message(LXDebug::DEBUG1, "Auth::dbconnect DSN: $dsn");
+ $main::lxdebug->message(LXDebug->DEBUG1, "Auth::dbconnect DSN: $dsn");
- $self->{dbh} = DBI->connect($dsn, $cfg->{user}, $cfg->{password}, { 'AutoCommit' => 0 });
+ $self->{dbh} = SL::DBConnect->connect($dsn, $cfg->{user}, $cfg->{password}, { pg_enable_utf8 => 1, AutoCommit => 1 });
if (!$may_fail && !$self->{dbh}) {
$main::form->error($main::locale->text('The connection to the authentication database failed:') . "\n" . $DBI::errstr);
}
- $main::lxdebug->leave_sub();
-
return $self->{dbh};
}
sub dbdisconnect {
- $main::lxdebug->enter_sub();
-
my $self = shift;
if ($self->{dbh}) {
$self->{dbh}->disconnect();
delete $self->{dbh};
}
-
- $main::lxdebug->leave_sub();
}
sub check_tables {
- $main::lxdebug->enter_sub();
-
- my $self = shift;
+ my ($self, $dbh) = @_;
- my $dbh = $self->dbconnect();
+ $dbh ||= $self->dbconnect();
my $query = qq|SELECT COUNT(*) FROM pg_tables WHERE (schemaname = 'auth') AND (tablename = 'user')|;
my ($count) = $dbh->selectrow_array($query);
- $main::lxdebug->leave_sub();
-
return $count > 0;
}
sub check_database {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $dbh = $self->dbconnect(1);
- $main::lxdebug->leave_sub();
-
return $dbh ? 1 : 0;
}
sub create_database {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my %params = @_;
@@ -214,22 +301,17 @@ sub create_database {
$dsn .= ';port=' . $cfg->{port};
}
- $main::lxdebug->message(LXDebug::DEBUG1, "Auth::create_database DSN: $dsn");
+ $main::lxdebug->message(LXDebug->DEBUG1(), "Auth::create_database DSN: $dsn");
- my $dbh = DBI->connect($dsn, $params{superuser}, $params{superuser_password});
+ my $dbh = SL::DBConnect->connect($dsn, $params{superuser}, $params{superuser_password}, { pg_enable_utf8 => 1 });
if (!$dbh) {
$main::form->error($main::locale->text('The connection to the template database failed:') . "\n" . $DBI::errstr);
}
- my $charset = $main::dbcharset;
- $charset ||= Common::DEFAULT_CHARSET;
- my $encoding = $Common::charset_to_db_encoding{$charset};
- $encoding ||= 'UNICODE';
+ my $query = qq|CREATE DATABASE "$cfg->{db}" OWNER "$cfg->{user}" TEMPLATE "$params{template}" ENCODING 'UNICODE'|;
- my $query = qq|CREATE DATABASE "$cfg->{db}" OWNER "$cfg->{user}" TEMPLATE "$params{template}" ENCODING '$encoding'|;
-
- $main::lxdebug->message(LXDebug::DEBUG1, "Auth::create_database query: $query");
+ $main::lxdebug->message(LXDebug->DEBUG1(), "Auth::create_database query: $query");
$dbh->do($query);
@@ -239,8 +321,8 @@ sub create_database {
$query = qq|SELECT pg_encoding_to_char(encoding) FROM pg_database WHERE datname = 'template0'|;
my ($cluster_encoding) = $dbh->selectrow_array($query);
- if ($cluster_encoding && ($cluster_encoding =~ m/^(?:UTF-?8|UNICODE)$/i) && ($encoding !~ m/^(?:UTF-?8|UNICODE)$/i)) {
- $error = $main::locale->text('Your PostgreSQL installationen uses UTF-8 as its encoding. Therefore you have to configure Lx-Office to use UTF-8 as well.');
+ if ($cluster_encoding && ($cluster_encoding !~ m/^(?:UTF-?8|UNICODE)$/i)) {
+ $error = $::locale->text('Your PostgreSQL installationen does not use Unicode as its encoding. This is not supported anymore.');
}
$dbh->disconnect();
@@ -249,28 +331,17 @@ sub create_database {
}
$dbh->disconnect();
-
- $main::lxdebug->leave_sub();
}
sub create_tables {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $dbh = $self->dbconnect();
- my $charset = $main::dbcharset;
- $charset ||= Common::DEFAULT_CHARSET;
-
$dbh->rollback();
- User->process_query($main::form, $dbh, 'sql/auth_db.sql', undef, $charset);
-
- $main::lxdebug->leave_sub();
+ SL::DBUpgrade2->new(form => $::form)->process_query($dbh, 'sql/auth_db.sql');
}
sub save_user {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $login = shift;
my %params = @_;
@@ -281,6 +352,8 @@ sub save_user {
my ($sth, $query, $user_id);
+ $dbh->begin_work;
+
$query = qq|SELECT id FROM auth."user" WHERE login = ?|;
($user_id) = selectrow_query($form, $dbh, $query, $login);
@@ -305,8 +378,6 @@ sub save_user {
}
$dbh->commit();
-
- $main::lxdebug->leave_sub();
}
sub can_change_password {
@@ -316,103 +387,124 @@ sub can_change_password {
}
sub change_password {
- $main::lxdebug->enter_sub();
-
- my $self = shift;
- my $result = $self->{authenticator}->change_password(@_);
+ my ($self, $login, $new_password) = @_;
- $main::lxdebug->leave_sub();
+ my $result = $self->{authenticator}->change_password($login, $new_password);
return $result;
}
sub read_all_users {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $dbh = $self->dbconnect();
- my $query = qq|SELECT u.id, u.login, cfg.cfg_key, cfg.cfg_value
- FROM auth.user_config cfg
- LEFT JOIN auth."user" u ON (cfg.user_id = u.id)|;
+ my $query = qq|SELECT u.id, u.login, cfg.cfg_key, cfg.cfg_value, s.mtime AS last_action
+
+ FROM auth."user" AS u
+
+ LEFT JOIN auth.user_config AS cfg
+ ON (cfg.user_id = u.id)
+
+ LEFT JOIN auth.session_content AS sc_login
+ ON (sc_login.sess_key = 'login' AND sc_login.sess_value = ('--- ' \|\| u.login \|\| '\n'))
+
+ LEFT JOIN auth.session AS s
+ ON (s.id = sc_login.session_id)
+ |;
my $sth = prepare_execute_query($main::form, $dbh, $query);
my %users;
while (my $ref = $sth->fetchrow_hashref()) {
- $users{$ref->{login}} ||= { 'login' => $ref->{login}, 'id' => $ref->{id} };
+
+ $users{$ref->{login}} ||= {
+ 'login' => $ref->{login},
+ 'id' => $ref->{id},
+ 'last_action' => $ref->{last_action},
+ };
$users{$ref->{login}}->{$ref->{cfg_key}} = $ref->{cfg_value} if (($ref->{cfg_key} ne 'login') && ($ref->{cfg_key} ne 'id'));
}
$sth->finish();
- $main::lxdebug->leave_sub();
-
return %users;
}
sub read_user {
- $main::lxdebug->enter_sub();
-
- my $self = shift;
- my $login = shift;
+ my ($self, %params) = @_;
my $dbh = $self->dbconnect();
- my $query = qq|SELECT cfg.cfg_key, cfg.cfg_value
+
+ my (@where, @values);
+ if ($params{login}) {
+ push @where, 'u.login = ?';
+ push @values, $params{login};
+ }
+ if ($params{id}) {
+ push @where, 'u.id = ?';
+ push @values, $params{id};
+ }
+ my $where = join ' AND ', '1 = 1', @where;
+ my $query = qq|SELECT u.id, u.login, cfg.cfg_key, cfg.cfg_value
FROM auth.user_config cfg
LEFT JOIN auth."user" u ON (cfg.user_id = u.id)
- WHERE (u.login = ?)|;
- my $sth = prepare_execute_query($main::form, $dbh, $query, $login);
+ WHERE $where|;
+ my $sth = prepare_execute_query($main::form, $dbh, $query, @values);
my %user_data;
while (my $ref = $sth->fetchrow_hashref()) {
$user_data{$ref->{cfg_key}} = $ref->{cfg_value};
- $user_data{login} = $login;
+ @user_data{qw(id login)} = @{$ref}{qw(id login)};
}
- $sth->finish();
+ # The XUL/XML & 'CSS new' backed menus have been removed.
+ my %menustyle_map = ( xml => 'new', v4 => 'v3' );
+ $user_data{menustyle} = $menustyle_map{lc($user_data{menustyle} || '')} || $user_data{menustyle};
+
+ # The 'Win2000.css' stylesheet has been removed.
+ $user_data{stylesheet} = 'kivitendo.css' if ($user_data{stylesheet} || '') =~ m/win2000/i;
+
+ # Set default language if selected language does not exist (anymore).
+ $user_data{countrycode} = $::lx_office_conf{system}->{language} unless $user_data{countrycode} && -d "locale/$user_data{countrycode}";
- $main::lxdebug->leave_sub();
+ $sth->finish();
return %user_data;
}
sub get_user_id {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $login = shift;
my $dbh = $self->dbconnect();
my ($id) = selectrow_query($main::form, $dbh, qq|SELECT id FROM auth."user" WHERE login = ?|, $login);
- $main::lxdebug->leave_sub();
-
return $id;
}
sub delete_user {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $login = shift;
- my $form = $main::form;
+ my $dbh = $self->dbconnect;
+ my $id = $self->get_user_id($login);
- my $dbh = $self->dbconnect();
- my $query = qq|SELECT id FROM auth."user" WHERE login = ?|;
-
- my ($id) = selectrow_query($form, $dbh, $query, $login);
+ if (!$id) {
+ $dbh->rollback;
+ return;
+ }
- return $main::lxdebug->leave_sub() if (!$id);
+ $dbh->begin_work;
- do_query($form, $dbh, qq|DELETE FROM auth.user_group WHERE user_id = ?|, $id);
- do_query($form, $dbh, qq|DELETE FROM auth.user_config WHERE user_id = ?|, $id);
+ do_query($::form, $dbh, qq|DELETE FROM auth.user_group WHERE user_id = ?|, $id);
+ do_query($::form, $dbh, qq|DELETE FROM auth.user_config WHERE user_id = ?|, $id);
+ do_query($::form, $dbh, qq|DELETE FROM auth.user WHERE id = ?|, $id);
- $dbh->commit();
+ # TODO: SL::Auth::delete_user
+ # do_query($::form, $u_dbh, qq|UPDATE employee SET deleted = 't' WHERE login = ?|, $login) if $u_dbh && $user_db_exists;
- $main::lxdebug->leave_sub();
+ $dbh->commit;
}
# --------------------------------------
@@ -420,168 +512,358 @@ sub delete_user {
my $session_id;
sub restore_session {
- $main::lxdebug->enter_sub();
-
my $self = shift;
- my $cgi = $main::cgi;
- $cgi ||= CGI->new('');
-
- $session_id = $cgi->cookie($self->get_session_cookie_name());
- $session_id =~ s|[^0-9a-f]||g;
+ $session_id = $::request->{cgi}->cookie($self->get_session_cookie_name());
+ $session_id =~ s|[^0-9a-f]||g if $session_id;
$self->{SESSION} = { };
if (!$session_id) {
- $main::lxdebug->leave_sub();
- return SESSION_NONE;
+ return $self->session_restore_result(SESSION_NONE());
}
my ($dbh, $query, $sth, $cookie, $ref, $form);
$form = $main::form;
- $dbh = $self->dbconnect();
+ # Don't fail if the auth DB doesn't exist yet.
+ if (!( $dbh = $self->dbconnect(1) )) {
+ return $self->session_restore_result(SESSION_NONE());
+ }
+
+ # Don't fail if the "auth" schema doesn't exist yet, e.g. if the
+ # admin is creating the session tables at the moment.
$query = qq|SELECT *, (mtime < (now() - '$self->{session_timeout}m'::interval)) AS is_expired FROM auth.session WHERE id = ?|;
- $cookie = selectfirst_hashref_query($form, $dbh, $query, $session_id);
+ if (!($sth = $dbh->prepare($query)) || !$sth->execute($session_id)) {
+ $sth->finish if $sth;
+ return $self->session_restore_result(SESSION_NONE());
+ }
- if (!$cookie || $cookie->{is_expired} || ($cookie->{ip_address} ne $ENV{REMOTE_ADDR})) {
+ $cookie = $sth->fetchrow_hashref;
+ $sth->finish;
+
+ # The session ID provided is valid in the following cases:
+ # 1. session ID exists in the database
+ # 2. hasn't expired yet
+ # 3. if cookie for the API token is given: the cookie's value equal database column 'auth.session.api_token' for the session ID
+ # 4. if cookie for the API token is NOT given then: the requestee's IP address must match the stored IP address
+ $self->{api_token} = $cookie->{api_token} if $cookie;
+ my $api_token_cookie = $self->get_api_token_cookie;
+ my $cookie_is_bad = !$cookie || $cookie->{is_expired};
+ $cookie_is_bad ||= $api_token_cookie && ($api_token_cookie ne $cookie->{api_token}) if $api_token_cookie;
+ $cookie_is_bad ||= $cookie->{ip_address} ne $ENV{REMOTE_ADDR} if !$api_token_cookie && $ENV{REMOTE_ADDR} !~ /^$IPv6_re$/;
+ if ($cookie_is_bad) {
$self->destroy_session();
- $main::lxdebug->leave_sub();
- return SESSION_EXPIRED;
+ return $self->session_restore_result($cookie ? SESSION_EXPIRED() : SESSION_NONE());
}
- $query = qq|SELECT sess_key, sess_value FROM auth.session_content WHERE session_id = ?|;
- $sth = prepare_execute_query($form, $dbh, $query, $session_id);
+ if ($self->{column_information}->has('auto_restore')) {
+ $self->_load_with_auto_restore_column($dbh, $session_id);
+ } else {
+ $self->_load_without_auto_restore_column($dbh, $session_id);
+ }
- while (my $ref = $sth->fetchrow_hashref()) {
- $self->{SESSION}->{$ref->{sess_key}} = $ref->{sess_value};
- $form->{$ref->{sess_key}} = $ref->{sess_value} if (!defined $form->{$ref->{sess_key}});
+ return $self->session_restore_result(SESSION_OK());
+}
+
+sub session_restore_result {
+ my $self = shift;
+ if (@_) {
+ $self->{session_restore_result} = $_[0];
}
+ return $self->{session_restore_result};
+}
- $sth->finish();
+sub _load_without_auto_restore_column {
+ my ($self, $dbh, $session_id) = @_;
+
+ my $query = <leave_sub();
+ while (my $ref = $sth->fetchrow_hashref) {
+ my $value = SL::Auth::SessionValue->new(auth => $self,
+ key => $ref->{sess_key},
+ value => $ref->{sess_value},
+ raw => 1);
+ $self->{SESSION}->{ $ref->{sess_key} } = $value;
- return SESSION_OK;
+ next if defined $::form->{$ref->{sess_key}};
+
+ my $data = $value->get;
+ $::form->{$ref->{sess_key}} = $data if $value->{auto_restore} || !ref $data;
+ }
}
-sub destroy_session {
- $main::lxdebug->enter_sub();
+sub _load_with_auto_restore_column {
+ my ($self, $dbh, $session_id) = @_;
+
+ my %auto_restore_keys = map { $_ => 1 } qw(login password rpw client_id), SESSION_KEY_ROOT_AUTH, SESSION_KEY_USER_AUTH;
+
+ my $query = <fetchrow_hashref) {
+ if ($ref->{auto_restore} || $auto_restore_keys{$ref->{sess_key}}) {
+ my $value = SL::Auth::SessionValue->new(auth => $self,
+ key => $ref->{sess_key},
+ value => $ref->{sess_value},
+ auto_restore => $ref->{auto_restore},
+ raw => 1);
+ $self->{SESSION}->{ $ref->{sess_key} } = $value;
+
+ next if defined $::form->{$ref->{sess_key}};
+
+ my $data = $value->get;
+ $::form->{$ref->{sess_key}} = $data if $value->{auto_restore} || !ref $data;
+ } else {
+ my $value = SL::Auth::SessionValue->new(auth => $self,
+ key => $ref->{sess_key});
+ $self->{SESSION}->{ $ref->{sess_key} } = $value;
+ }
+ }
+
+ $sth->finish;
+}
+sub destroy_session {
my $self = shift;
if ($session_id) {
my $dbh = $self->dbconnect();
+ $dbh->begin_work;
+
do_query($main::form, $dbh, qq|DELETE FROM auth.session_content WHERE session_id = ?|, $session_id);
do_query($main::form, $dbh, qq|DELETE FROM auth.session WHERE id = ?|, $session_id);
$dbh->commit();
+ SL::SessionFile->destroy_session($session_id);
+
$session_id = undef;
$self->{SESSION} = { };
}
+}
- $main::lxdebug->leave_sub();
+sub active_session_ids {
+ my $self = shift;
+ my $dbh = $self->dbconnect;
+
+ my $query = qq|SELECT id FROM auth.session|;
+
+ my @ids = selectall_array_query($::form, $dbh, $query);
+
+ return @ids;
}
sub expire_sessions {
- $main::lxdebug->enter_sub();
-
my $self = shift;
+ return if !$self->session_tables_present;
+
my $dbh = $self->dbconnect();
- my $query =
- qq|DELETE FROM auth.session_content
- WHERE session_id IN
- (SELECT id
- FROM auth.session
- WHERE (mtime < (now() - '$self->{session_timeout}m'::interval)))|;
- do_query($main::form, $dbh, $query);
+ my $query = qq|SELECT id
+ FROM auth.session
+ WHERE (mtime < (now() - '$self->{session_timeout}m'::interval))|;
- $query =
- qq|DELETE FROM auth.session
- WHERE (mtime < (now() - '$self->{session_timeout}m'::interval))|;
+ my @ids = selectall_array_query($::form, $dbh, $query);
- do_query($main::form, $dbh, $query);
+ if (@ids) {
+ $dbh->begin_work;
- $dbh->commit();
+ SL::SessionFile->destroy_session($_) for @ids;
- $main::lxdebug->leave_sub();
-}
+ $query = qq|DELETE FROM auth.session_content
+ WHERE session_id IN (| . join(', ', ('?') x scalar(@ids)) . qq|)|;
+ do_query($main::form, $dbh, $query, @ids);
-sub _create_session_id {
- $main::lxdebug->enter_sub();
+ $query = qq|DELETE FROM auth.session
+ WHERE id IN (| . join(', ', ('?') x scalar(@ids)) . qq|)|;
+ do_query($main::form, $dbh, $query, @ids);
- my @secs = gettimeofday();
- srand $secs[1] + $$;
+ $dbh->commit();
+ }
+}
+sub _create_session_id {
my @data;
map { push @data, int(rand() * 255); } (1..32);
my $id = md5_hex(pack 'C*', @data);
- $main::lxdebug->leave_sub();
-
return $id;
}
sub create_or_refresh_session {
- $main::lxdebug->enter_sub();
+ $session_id ||= shift->_create_session_id;
+}
- my $self = shift;
+sub save_session {
+ my $self = shift;
+ my $provided_dbh = shift;
- $session_id ||= $self->_create_session_id();
+ my $dbh = $provided_dbh || $self->dbconnect(1);
- my ($form, $dbh, $query, $sth, $id);
+ return unless $dbh && $session_id;
- $form = $main::form;
- $dbh = $self->dbconnect();
+ $dbh->begin_work unless $provided_dbh;
- $query = qq|SELECT id FROM auth.session WHERE id = ?|;
+ # If this fails then the "auth" schema might not exist yet, e.g. if
+ # the admin is just trying to create the auth database.
+ if (!$dbh->do(qq|LOCK auth.session_content|)) {
+ $dbh->rollback unless $provided_dbh;
+ return;
+ }
- ($id) = selectrow_query($form, $dbh, $query, $session_id);
+ my @unfetched_keys = map { $_->{key} }
+ grep { ! $_->{fetched} }
+ values %{ $self->{SESSION} };
+ # $::lxdebug->dump(0, "unfetched_keys", [ sort @unfetched_keys ]);
+ # $::lxdebug->dump(0, "all keys", [ sort map { $_->{key} } values %{ $self->{SESSION} } ]);
+ my $query = qq|DELETE FROM auth.session_content WHERE (session_id = ?)|;
+ $query .= qq| AND (sess_key NOT IN (| . join(', ', ('?') x scalar @unfetched_keys) . qq|))| if @unfetched_keys;
- if ($id) {
- do_query($form, $dbh, qq|UPDATE auth.session SET mtime = now() WHERE id = ?|, $session_id);
- do_query($form, $dbh, qq|DELETE FROM auth.session_content WHERE session_id = ?|, $session_id);
+ do_query($::form, $dbh, $query, $session_id, @unfetched_keys);
+
+ my ($id) = selectrow_query($::form, $dbh, qq|SELECT id FROM auth.session WHERE id = ?|, $session_id);
+ if ($id) {
+ do_query($::form, $dbh, qq|UPDATE auth.session SET mtime = now() WHERE id = ?|, $session_id);
} else {
- do_query($form, $dbh, qq|INSERT INTO auth.session (id, ip_address, mtime) VALUES (?, ?, now())|, $session_id, $ENV{REMOTE_ADDR});
+ do_query($::form, $dbh, qq|INSERT INTO auth.session (id, ip_address, mtime) VALUES (?, ?, now())|, $session_id, $ENV{REMOTE_ADDR});
+ }
+ if ($self->{column_information}->has('api_token', 'session')) {
+ my ($stored_api_token) = $dbh->selectrow_array(qq|SELECT api_token FROM auth.session WHERE id = ?|, undef, $session_id);
+ do_query($::form, $dbh, qq|UPDATE auth.session SET api_token = ? WHERE id = ?|, $self->_create_session_id, $session_id) unless $stored_api_token;
}
- $query = qq|INSERT INTO auth.session_content (session_id, sess_key, sess_value) VALUES (?, ?, ?)|;
- $sth = prepare_query($form, $dbh, $query);
+ my @values_to_save = grep { $_->{fetched} }
+ values %{ $self->{SESSION} };
+ if (@values_to_save) {
+ my ($columns, $placeholders) = ('', '');
+ my $auto_restore = $self->{column_information}->has('auto_restore');
- foreach my $key (sort keys %{ $self->{SESSION} }) {
- do_statement($form, $sth, $query, $session_id, $key, $self->{SESSION}->{$key});
- }
+ if ($auto_restore) {
+ $columns .= ', auto_restore';
+ $placeholders .= ', ?';
+ }
- $sth->finish();
- $dbh->commit();
+ $query = qq|INSERT INTO auth.session_content (session_id, sess_key, sess_value ${columns}) VALUES (?, ?, ? ${placeholders})|;
+ my $sth = prepare_query($::form, $dbh, $query);
+
+ foreach my $value (@values_to_save) {
+ my @values = ($value->{key}, $value->get_dumped);
+ push @values, $value->{auto_restore} if $auto_restore;
+
+ do_statement($::form, $sth, $query, $session_id, @values);
+ }
+
+ $sth->finish();
+ }
- $main::lxdebug->leave_sub();
+ $dbh->commit() unless $provided_dbh;
}
sub set_session_value {
- $main::lxdebug->enter_sub();
+ my $self = shift;
+ my @params = @_;
- my $self = shift;
+ $self->{SESSION} ||= { };
+
+ while (@params) {
+ my $key = shift @params;
+
+ if (ref $key eq 'HASH') {
+ $self->{SESSION}->{ $key->{key} } = SL::Auth::SessionValue->new(key => $key->{key},
+ value => $key->{value},
+ auto_restore => $key->{auto_restore});
+
+ } else {
+ my $value = shift @params;
+ $self->{SESSION}->{ $key } = SL::Auth::SessionValue->new(key => $key,
+ value => $value);
+ }
+ }
+
+ return $self;
+}
+
+sub delete_session_value {
+ my $self = shift;
+
+ $self->{SESSION} ||= { };
+ delete @{ $self->{SESSION} }{ @_ };
+
+ return $self;
+}
+
+sub get_session_value {
+ my $self = shift;
+ my $data = $self->{SESSION} && $self->{SESSION}->{ $_[0] } ? $self->{SESSION}->{ $_[0] }->get : undef;
+
+ return $data;
+}
+
+sub create_unique_sesion_value {
+ my ($self, $value, %params) = @_;
$self->{SESSION} ||= { };
- while (2 <= scalar @_) {
- my $key = shift;
- my $value = shift;
+ my @now = gettimeofday();
+ my $key = "$$-" . ($now[0] * 1000000 + $now[1]) . "-";
+ $self->{unique_counter} ||= 0;
+
+ my $hashed_key;
+ do {
+ $self->{unique_counter}++;
+ $hashed_key = md5_hex($key . $self->{unique_counter});
+ } while (exists $self->{SESSION}->{$hashed_key});
+
+ $self->set_session_value($hashed_key => $value);
- $self->{SESSION}->{$key} = $value;
+ return $hashed_key;
+}
+
+sub save_form_in_session {
+ my ($self, %params) = @_;
+
+ my $form = delete($params{form}) || $::form;
+ my $non_scalars = delete $params{non_scalars};
+ my $data = {};
+
+ my %skip_keys = map { ( $_ => 1 ) } (qw(login password stylesheet version titlebar), @{ $params{skip_keys} || [] });
+
+ foreach my $key (grep { !$skip_keys{$_} } keys %{ $form }) {
+ $data->{$key} = $form->{$key} if !ref($form->{$key}) || $non_scalars;
}
- $main::lxdebug->leave_sub();
+ return $self->create_unique_sesion_value($data, %params);
+}
+
+sub restore_form_from_session {
+ my ($self, $key, %params) = @_;
+
+ my $data = $self->get_session_value($key);
+ return $self unless $data;
+
+ my $form = delete($params{form}) || $::form;
+ my $clobber = exists $params{clobber} ? $params{clobber} : 1;
+
+ map { $form->{$_} = $data->{$_} if $clobber || !exists $form->{$_} } keys %{ $data };
+
+ return $self;
}
sub set_cookie_environment_variable {
@@ -590,100 +872,80 @@ sub set_cookie_environment_variable {
}
sub get_session_cookie_name {
- my $self = shift;
+ my ($self, %params) = @_;
+
+ $params{type} ||= 'id';
+ my $name = $self->{cookie_name} || 'lx_office_erp_session_id';
+ $name .= '_api_token' if $params{type} eq 'api_token';
- return $self->{cookie_name} || 'lx_office_erp_session_id';
+ return $name;
}
sub get_session_id {
return $session_id;
}
-sub session_tables_present {
- $main::lxdebug->enter_sub();
+sub get_api_token_cookie {
+ my ($self) = @_;
- my $self = shift;
- my $dbh = $self->dbconnect(1);
+ $::request->{cgi}->cookie($self->get_session_cookie_name(type => 'api_token'));
+}
- if (!$dbh) {
- $main::lxdebug->leave_sub();
- return 0;
- }
+sub is_api_token_cookie_valid {
+ my ($self) = @_;
+ my $provided_api_token = $self->get_api_token_cookie;
+ return $self->{api_token} && $provided_api_token && ($self->{api_token} eq $provided_api_token);
+}
- my $query =
- qq|SELECT COUNT(*)
- FROM pg_tables
- WHERE (schemaname = 'auth')
- AND (tablename IN ('session', 'session_content'))|;
+sub _tables_present {
+ my ($self, @tables) = @_;
+ my $cache_key = join '_', @tables;
- my ($count) = selectrow_query($main::form, $dbh, $query);
+ # Only re-check for the presence of auth tables if either the check
+ # hasn't been done before of if they weren't present.
+ return $self->{"$cache_key\_tables_present"} ||= do {
+ my $dbh = $self->dbconnect(1);
+
+ if (!$dbh) {
+ return 0;
+ }
- $main::lxdebug->leave_sub();
+ my $query =
+ qq|SELECT COUNT(*)
+ FROM pg_tables
+ WHERE (schemaname = 'auth')
+ AND (tablename IN (@{[ join ', ', ('?') x @tables ]}))|;
- return 2 == $count;
+ my ($count) = selectrow_query($main::form, $dbh, $query, @tables);
+
+ scalar @tables == $count;
+ }
+}
+
+sub session_tables_present {
+ $_[0]->_tables_present('session', 'session_content');
+}
+
+sub master_rights_present {
+ $_[0]->_tables_present('master_rights');
}
# --------------------------------------
sub all_rights_full {
- my $locale = $main::locale;
-
- my @all_rights = (
- ["--crm", $locale->text("CRM optional software")],
- ["crm_search", $locale->text("CRM search")],
- ["crm_new", $locale->text("CRM create customers, vendors and contacts")],
- ["crm_service", $locale->text("CRM services")],
- ["crm_admin", $locale->text("CRM admin")],
- ["crm_adminuser", $locale->text("CRM user")],
- ["crm_adminstatus", $locale->text("CRM status")],
- ["crm_email", $locale->text("CRM send email")],
- ["crm_termin", $locale->text("CRM termin")],
- ["crm_opportunity", $locale->text("CRM opportunity")],
- ["crm_knowhow", $locale->text("CRM know how")],
- ["crm_follow", $locale->text("CRM follow up")],
- ["crm_notices", $locale->text("CRM notices")],
- ["crm_other", $locale->text("CRM other")],
- ["--master_data", $locale->text("Master Data")],
- ["customer_vendor_edit", $locale->text("Create and edit customers and vendors")],
- ["part_service_assembly_edit", $locale->text("Create and edit parts, services, assemblies")],
- ["project_edit", $locale->text("Create and edit projects")],
- ["license_edit", $locale->text("Manage license keys")],
- ["--ar", $locale->text("AR")],
- ["sales_quotation_edit", $locale->text("Create and edit sales quotations")],
- ["sales_order_edit", $locale->text("Create and edit sales orders")],
- ["sales_delivery_order_edit", $locale->text("Create and edit sales delivery orders")],
- ["invoice_edit", $locale->text("Create and edit invoices and credit notes")],
- ["dunning_edit", $locale->text("Create and edit dunnings")],
- ["--ap", $locale->text("AP")],
- ["request_quotation_edit", $locale->text("Create and edit RFQs")],
- ["purchase_order_edit", $locale->text("Create and edit purchase orders")],
- ["purchase_delivery_order_edit", $locale->text("Create and edit purchase delivery orders")],
- ["vendor_invoice_edit", $locale->text("Create and edit vendor invoices")],
- ["--warehouse_management", $locale->text("Warehouse management")],
- ["warehouse_contents", $locale->text("View warehouse content")],
- ["warehouse_management", $locale->text("Warehouse management")],
- ["--general_ledger_cash", $locale->text("General ledger and cash")],
- ["general_ledger", $locale->text("Transactions, AR transactions, AP transactions")],
- ["datev_export", $locale->text("DATEV Export")],
- ["cash", $locale->text("Receipt, payment, reconciliation")],
- ["--reports", $locale->text('Reports')],
- ["report", $locale->text('All reports')],
- ["advance_turnover_tax_return", $locale->text('Advance turnover tax return')],
- ["--others", $locale->text("Others")],
- ["email_bcc", $locale->text("May set the BCC field when sending emails")],
- ["config", $locale->text("Change Lx-Office installation settings (all menu entries beneath 'System')")],
- );
-
- return @all_rights;
+ my ($self) = @_;
+
+ @{ $self->{master_rights} ||= do {
+ $self->dbconnect->selectall_arrayref("SELECT name, description, category FROM auth.master_rights ORDER BY position");
+ }
+ }
}
sub all_rights {
- return grep !/^--/, map { $_->[0] } all_rights_full();
+ return map { $_->[0] } grep { !$_->[2] } $_[0]->all_rights_full;
}
sub read_groups {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $form = $main::form;
@@ -704,13 +966,14 @@ sub read_groups {
$sth = prepare_query($form, $dbh, $query);
foreach $group (values %{$groups}) {
- $group->{members} = [];
+ my @members;
do_statement($form, $sth, $query, $group->{id});
while ($row = $sth->fetchrow_hashref()) {
- push @{$group->{members}}, $row->{user_id};
+ push @members, $row->{user_id};
}
+ $group->{members} = [ uniq @members ];
}
$sth->finish();
@@ -726,24 +989,22 @@ sub read_groups {
$group->{rights}->{$row->{right}} |= $row->{granted};
}
- map { $group->{rights}->{$_} = 0 if (!defined $group->{rights}->{$_}); } all_rights();
+ map { $group->{rights}->{$_} = 0 if (!defined $group->{rights}->{$_}); } $self->all_rights;
}
$sth->finish();
- $main::lxdebug->leave_sub();
-
return $groups;
}
sub save_group {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $group = shift;
my $form = $main::form;
my $dbh = $self->dbconnect();
+ $dbh->begin_work;
+
my ($query, $sth, $row, $rights);
if (!$group->{id}) {
@@ -760,7 +1021,7 @@ sub save_group {
$query = qq|INSERT INTO auth.user_group (user_id, group_id) VALUES (?, ?)|;
$sth = prepare_query($form, $dbh, $query);
- foreach my $user_id (@{ $group->{members} }) {
+ foreach my $user_id (uniq @{ $group->{members} }) {
do_statement($form, $sth, $query, $user_id, $group->{id});
}
$sth->finish();
@@ -776,32 +1037,25 @@ sub save_group {
$sth->finish();
$dbh->commit();
-
- $main::lxdebug->leave_sub();
}
sub delete_group {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $id = shift;
- my $form = $main::from;
+ my $form = $main::form;
my $dbh = $self->dbconnect();
+ $dbh->begin_work;
do_query($form, $dbh, qq|DELETE FROM auth.user_group WHERE group_id = ?|, $id);
do_query($form, $dbh, qq|DELETE FROM auth.group_rights WHERE group_id = ?|, $id);
do_query($form, $dbh, qq|DELETE FROM auth."group" WHERE id = ?|, $id);
$dbh->commit();
-
- $main::lxdebug->leave_sub();
}
sub evaluate_rights_ary {
- $main::lxdebug->enter_sub(2);
-
my $ary = shift;
my $value = 0;
@@ -827,14 +1081,10 @@ sub evaluate_rights_ary {
}
}
- $main::lxdebug->enter_sub(2);
-
return $value;
}
sub _parse_rights_string {
- $main::lxdebug->enter_sub(2);
-
my $self = shift;
my $login = shift;
@@ -861,7 +1111,6 @@ sub _parse_rights_string {
pop @stack;
if (!@stack) {
- $main::lxdebug->enter_sub(2);
return 0;
}
@@ -871,20 +1120,16 @@ sub _parse_rights_string {
push @{$cur_ary}, $token;
} else {
- push @{$cur_ary}, $self->{RIGHTS}->{$login}->{$token} * 1;
+ push @{$cur_ary}, ($self->{RIGHTS}->{$login}->{$token} // 0) * 1;
}
}
my $result = ($access || (1 < scalar @stack)) ? 0 : evaluate_rights_ary($stack[0]);
- $main::lxdebug->enter_sub(2);
-
return $result;
}
sub check_right {
- $main::lxdebug->enter_sub(2);
-
my $self = shift;
my $login = shift;
my $right = shift;
@@ -903,47 +1148,32 @@ sub check_right {
my $granted = $self->{FULL_RIGHTS}->{$login}->{$right};
$granted = $default if (!defined $granted);
- $main::lxdebug->leave_sub(2);
-
return $granted;
}
sub assert {
- $main::lxdebug->enter_sub(2);
-
- my $self = shift;
- my $right = shift;
- my $dont_abort = shift;
-
- my $form = $main::form;
+ my ($self, $right, $dont_abort) = @_;
- if ($self->check_right($form->{login}, $right)) {
- $main::lxdebug->leave_sub(2);
+ if ($self->check_right($::myconfig{login}, $right)) {
return 1;
}
if (!$dont_abort) {
- delete $form->{title};
- $form->show_generic_error($main::locale->text("You do not have the permissions to access this function."));
+ delete $::form->{title};
+ $::form->show_generic_error($::locale->text("You do not have the permissions to access this function."));
}
- $main::lxdebug->leave_sub(2);
-
return 0;
}
sub load_rights_for_user {
- $main::lxdebug->enter_sub();
-
- my $self = shift;
- my $login = shift;
-
- my $form = $main::form;
- my $dbh = $self->dbconnect();
-
+ my ($self, $login) = @_;
+ my $dbh = $self->dbconnect;
my ($query, $sth, $row, $rights);
- $rights = {};
+ $rights = { map { $_ => 0 } $self->all_rights };
+
+ return $rights if !$self->client || !$login;
$query =
qq|SELECT gr."right", gr.granted
@@ -952,20 +1182,124 @@ sub load_rights_for_user {
(SELECT ug.group_id
FROM auth.user_group ug
LEFT JOIN auth."user" u ON (ug.user_id = u.id)
- WHERE u.login = ?)|;
+ WHERE u.login = ?)
+ AND group_id IN
+ (SELECT cg.group_id
+ FROM auth.clients_groups cg
+ WHERE cg.client_id = ?)|;
- $sth = prepare_execute_query($form, $dbh, $query, $login);
+ $sth = prepare_execute_query($::form, $dbh, $query, $login, $self->client->{id});
while ($row = $sth->fetchrow_hashref()) {
$rights->{$row->{right}} |= $row->{granted};
}
$sth->finish();
- map({ $rights->{$_} = 0 unless (defined $rights->{$_}); } SL::Auth::all_rights());
-
- $main::lxdebug->leave_sub();
-
return $rights;
}
1;
+__END__
+
+=pod
+
+=encoding utf8
+
+=head1 NAME
+
+SL::Auth - Authentication and session handling
+
+=head1 METHODS
+
+=over 4
+
+=item C
+
+=item C
+
+Store all values of C<@values> or C<%values> in the session. Each
+member of C<@values> is tested if it is a hash reference. If it is
+then it must contain the keys C and C and can optionally
+contain the key C. In this case C is associated
+with C and restored to C<$::form> upon the next request
+automatically if C is trueish or if C is a scalar
+value.
+
+If the current member of C<@values> is not a hash reference then it
+will be used as the C and the next entry of C<@values> is used as
+the C to store. In this case setting C is not
+possible.
+
+Therefore the following two invocations are identical:
+
+ $::auth-Eset_session_value(name =E "Charlie");
+ $::auth-Eset_session_value({ key =E "name", value =E "Charlie" });
+
+All of these values are copied back into C<$::form> for the next
+request automatically if they're scalar values or if they have
+C set to trueish.
+
+The values can be any Perl structure. They are stored as YAML dumps.
+
+=item C
+
+Retrieve a value from the session. Returns C if the value
+doesn't exist.
+
+=item C
+
+Create a unique key in the session and store C<$value>
+there.
+
+Returns the key created in the session.
+
+=item C
+
+Stores the session values in the database. This is the only function
+that actually stores stuff in the database. Neither the various
+setters nor the deleter access the database.
+
+=item C
+
+Stores the content of C<$params{form}> (default: C<$::form>) in the
+session using L.
+
+If C<$params{non_scalars}> is trueish then non-scalar values will be
+stored as well. Default is to only store scalar values.
+
+The following keys will never be saved: C, C,
+C, C, C. Additional keys not to save
+can be given as an array ref in C<$params{skip_keys}>.
+
+Returns the unique key under which the form is stored.
+
+=item C
+
+Restores the form from the session into C<$params{form}> (default:
+C<$::form>).
+
+If C<$params{clobber}> is falsish then existing values with the same
+key in C<$params{form}> will not be overwritten. C<$params{clobber}>
+is on by default.
+
+Returns C<$self>.
+
+=item C
+
+C deletes every state information from previous requests, but does not
+close the database connection.
+
+Creating a new database handle on each request can take up to 30% of the
+pre-request startup time, so we want to avoid that for fast ajax calls.
+
+=back
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus Em.bunkus@linet-services.deE
+
+=cut