SL/User.pm

   1 #=====================================================================
   2 # LX-Office ERP
   3 # Copyright (C) 2004
   4 # Based on SQL-Ledger Version 2.1.9
   5 # Web http://www.lx-office.org
   6 #
   7 #=====================================================================
   8 # SQL-Ledger Accounting
   9 # Copyright (C) 2001
  10 #
  11 #  Author: Dieter Simader
  12 #   Email: dsimader@sql-ledger.org
  13 #     Web: http://www.sql-ledger.org
  14 #
  15 #  Contributors:
  16 #
  17 # This program is free software; you can redistribute it and/or modify
  18 # it under the terms of the GNU General Public License as published by
  19 # the Free Software Foundation; either version 2 of the License, or
  20 # (at your option) any later version.
  21 #
  22 # This program is distributed in the hope that it will be useful,
  23 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  24 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25 # GNU General Public License for more details.
  26 # You should have received a copy of the GNU General Public License
  27 # along with this program; if not, write to the Free Software
  28 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  29 #=====================================================================
  30 #
  31 # user related functions
  32 #
  33 #=====================================================================
  34
  35 package User;
  36
  37 use IO::File;
  38 use Fcntl qw(:seek);
  39
  40 #use SL::Auth;
  41 use SL::DBConnect;
  42 use SL::DBUpgrade2;
  43 use SL::DBUtils;
  44 use SL::Iconv;
  45 use SL::Inifile;
  46 use SL::System::InstallationLock;
  47
  48 use strict;
  49
  50 sub new {
  51   $main::lxdebug->enter_sub();
  52
  53   my ($type, %params) = @_;
  54
  55   my $self = {};
  56
  57   if ($params{id} || $params{login}) {
  58     my %user_data = $main::auth->read_user(%params);
  59     map { $self->{$_} = $user_data{$_} } keys %user_data;
  60   }
  61
  62   $main::lxdebug->leave_sub();
  63
  64   bless $self, $type;
  65 }
  66
  67 sub country_codes {
  68   $main::lxdebug->enter_sub();
  69
  70   local *DIR;
  71
  72   my %cc       = ();
  73   my @language = ();
  74
  75   # scan the locale directory and read in the LANGUAGE files
  76   opendir(DIR, "locale");
  77
  78   my @dir = grep(!/(^\.\.?$|\..*)/, readdir(DIR));
  79
  80   foreach my $dir (@dir) {
  81     next unless open(my $fh, '<:encoding(UTF-8)', "locale/$dir/LANGUAGE");
  82     @language = <$fh>;
  83     close $fh;
  84
  85     $cc{$dir} = "@language";
  86   }
  87
  88   closedir(DIR);
  89
  90   $main::lxdebug->leave_sub();
  91
  92   return %cc;
  93 }
  94
  95 sub login {
  96   my ($self, $form) = @_;
  97
  98   return -3 if !$self->{login} || !$::auth->client;
  99
 100   my %myconfig = $main::auth->read_user(login => $self->{login});
 101
 102   # check if database is down
 103   my $dbh = $form->dbconnect_noauto;
 104
 105   # we got a connection, check the version
 106   my ($dbversion) = $dbh->selectrow_array(qq|SELECT version FROM defaults|);
 107
 108   $self->create_schema_info_table($form, $dbh);
 109
 110   # Auth DB upgrades available?
 111   my $dbupdater_auth = SL::DBUpgrade2->new(form => $form, auth => 1)->parse_dbupdate_controls;
 112   return -3 if $dbupdater_auth->unapplied_upgrade_scripts($::auth->dbconnect);
 113
 114   my $dbupdater = SL::DBUpgrade2->new(form => $form)->parse_dbupdate_controls;
 115
 116   my $update_available = $dbupdater->update_available($dbversion) || $dbupdater->update2_available($dbh);
 117   $dbh->disconnect;
 118
 119   return 0 if !$update_available;
 120
 121   $form->{$_} = $::auth->client->{$_} for qw(dbname dbhost dbport dbuser dbpasswd);
 122   $form->{$_} = $myconfig{$_}         for qw(datestyle);
 123
 124   $form->{"title"} = $main::locale->text("Dataset upgrade");
 125   $form->header(no_layout => $form->{no_layout});
 126   print $form->parse_html_template("dbupgrade/header");
 127
 128   $form->{dbupdate} = "db" . $::auth->client->{dbname};
 129
 130   if ($form->{"show_dbupdate_warning"}) {
 131     print $form->parse_html_template("dbupgrade/warning");
 132     ::end_of_request();
 133   }
 134
 135   # update the tables
 136   SL::System::InstallationLock->lock;
 137
 138   # ignore HUP, QUIT in case the webserver times out
 139   $SIG{HUP}  = 'IGNORE';
 140   $SIG{QUIT} = 'IGNORE';
 141
 142   $self->dbupdate($form);
 143   $self->dbupdate2(form => $form, updater => $dbupdater, database => $::auth->client->{dbname});
 144   SL::DBUpgrade2->new(form => $::form, auth => 1)->apply_admin_dbupgrade_scripts(0);
 145
 146   SL::System::InstallationLock->unlock;
 147
 148   print $form->parse_html_template("dbupgrade/footer");
 149
 150   return -2;
 151 }
 152
 153 sub dbconnect_vars {
 154   $main::lxdebug->enter_sub();
 155
 156   my ($form, $db) = @_;
 157
 158   my %dboptions = (
 159     'yy-mm-dd'   => 'set DateStyle to \'ISO\'',
 160     'yyyy-mm-dd' => 'set DateStyle to \'ISO\'',
 161     'mm/dd/yy'   => 'set DateStyle to \'SQL, US\'',
 162     'dd/mm/yy'   => 'set DateStyle to \'SQL, EUROPEAN\'',
 163     'dd.mm.yy'   => 'set DateStyle to \'GERMAN\''
 164   );
 165
 166   $form->{dboptions} = $dboptions{ $form->{dateformat} };
 167   $form->{dbconnect} = "dbi:Pg:dbname=${db};host=" . ($form->{dbhost} || 'localhost') . ";port=" . ($form->{dbport} || 5432);
 168
 169   $main::lxdebug->leave_sub();
 170 }
 171
 172 sub dbsources {
 173   $main::lxdebug->enter_sub();
 174
 175   my ($self, $form) = @_;
 176
 177   my @dbsources = ();
 178   my ($sth, $query);
 179
 180   $form->{dbdefault} = $form->{dbuser} unless $form->{dbdefault};
 181   &dbconnect_vars($form, $form->{dbdefault});
 182
 183   my $dbh = SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options)
 184     or $form->dberror;
 185
 186   $query =
 187     qq|SELECT datname FROM pg_database | .
 188     qq|WHERE NOT datname IN ('template0', 'template1')|;
 189   $sth = $dbh->prepare($query);
 190   $sth->execute() || $form->dberror($query);
 191
 192   while (my ($db) = $sth->fetchrow_array) {
 193
 194     if ($form->{only_acc_db}) {
 195
 196       next if ($db =~ /^template/);
 197
 198       &dbconnect_vars($form, $db);
 199       my $dbh = SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options)
 200         or $form->dberror;
 201
 202       $query =
 203         qq|SELECT tablename FROM pg_tables | .
 204         qq|WHERE (tablename = 'defaults') AND (tableowner = ?)|;
 205       my $sth = $dbh->prepare($query);
 206       $sth->execute($form->{dbuser}) ||
 207         $form->dberror($query . " ($form->{dbuser})");
 208
 209       if ($sth->fetchrow_array) {
 210         push(@dbsources, $db);
 211       }
 212       $sth->finish;
 213       $dbh->disconnect;
 214       next;
 215     }
 216     push(@dbsources, $db);
 217   }
 218
 219   $sth->finish;
 220   $dbh->disconnect;
 221
 222   $main::lxdebug->leave_sub();
 223
 224   return @dbsources;
 225 }
 226
 227 sub dbclusterencoding {
 228   $main::lxdebug->enter_sub();
 229
 230   my ($self, $form) = @_;
 231
 232   $form->{dbdefault} ||= $form->{dbuser};
 233
 234   dbconnect_vars($form, $form->{dbdefault});
 235
 236   my $dbh                = SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options) || $form->dberror();
 237   my $query              = qq|SELECT pg_encoding_to_char(encoding) FROM pg_database WHERE datname = 'template0'|;
 238   my ($cluster_encoding) = $dbh->selectrow_array($query);
 239   $dbh->disconnect();
 240
 241   $main::lxdebug->leave_sub();
 242
 243   return $cluster_encoding;
 244 }
 245
 246 sub dbcreate {
 247   $main::lxdebug->enter_sub();
 248
 249   my ($self, $form) = @_;
 250
 251   &dbconnect_vars($form, $form->{dbdefault});
 252   my $dbh =
 253     SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options)
 254     or $form->dberror;
 255   $form->{db} =~ s/\"//g;
 256
 257   my @dboptions;
 258
 259   push @dboptions, "ENCODING = " . $dbh->quote($form->{"encoding"}) if $form->{"encoding"};
 260   if ($form->{"dbdefault"}) {
 261     my $dbdefault = $form->{"dbdefault"};
 262     $dbdefault =~ s/[^a-zA-Z0-9_\-]//g;
 263     push @dboptions, "TEMPLATE = $dbdefault";
 264   }
 265
 266   my $query = qq|CREATE DATABASE "$form->{db}"|;
 267   $query   .= " WITH " . join(" ", @dboptions) if @dboptions;
 268
 269   # Ignore errors if the database exists.
 270   $dbh->do($query);
 271
 272   $dbh->disconnect;
 273
 274   &dbconnect_vars($form, $form->{db});
 275
 276   $dbh = SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options)
 277     or $form->dberror;
 278
 279   my $db_charset = $Common::db_encoding_to_charset{$form->{encoding}};
 280   $db_charset ||= Common::DEFAULT_CHARSET;
 281
 282   my $dbupdater = SL::DBUpgrade2->new(form => $form);
 283   # create the tables
 284   $dbupdater->process_query($dbh, "sql/lx-office.sql", undef, $db_charset);
 285
 286   # load chart of accounts
 287   $dbupdater->process_query($dbh, "sql/$form->{chart}-chart.sql", undef, $db_charset);
 288
 289   $query = "UPDATE defaults SET coa = ?";
 290   do_query($form, $dbh, $query, $form->{chart});
 291   $query = "UPDATE defaults SET accounting_method = ?";
 292   do_query($form, $dbh, $query, $form->{accounting_method});
 293   $query = "UPDATE defaults SET profit_determination = ?";
 294   do_query($form, $dbh, $query, $form->{profit_determination});
 295   $query = "UPDATE defaults SET inventory_system = ?";
 296   do_query($form, $dbh, $query, $form->{inventory_system});
 297   $query = "UPDATE defaults SET curr = ?";
 298   do_query($form, $dbh, $query, $form->{defaultcurrency});
 299
 300   $dbh->disconnect;
 301
 302   $main::lxdebug->leave_sub();
 303 }
 304
 305 sub dbdelete {
 306   $main::lxdebug->enter_sub();
 307
 308   my ($self, $form) = @_;
 309   $form->{db} =~ s/\"//g;
 310
 311   &dbconnect_vars($form, $form->{dbdefault});
 312   my $dbh = SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options)
 313     or $form->dberror;
 314   my $query = qq|DROP DATABASE "$form->{db}"|;
 315   do_query($form, $dbh, $query);
 316
 317   $dbh->disconnect;
 318
 319   $main::lxdebug->leave_sub();
 320 }
 321
 322 sub dbsources_unused {
 323   $main::lxdebug->enter_sub();
 324
 325   my ($self, $form) = @_;
 326
 327   $form->{only_acc_db} = 1;
 328
 329   my %members = $main::auth->read_all_users();
 330   my %dbexcl  = map { $_ => 1 } grep { $_ } map { $_->{dbname} } values %members;
 331
 332   $dbexcl{$form->{dbdefault}}             = 1;
 333   $dbexcl{$main::auth->{DB_config}->{db}} = 1;
 334
 335   my @dbunused = grep { !$dbexcl{$_} } dbsources("", $form);
 336
 337   $main::lxdebug->leave_sub();
 338
 339   return @dbunused;
 340 }
 341
 342 sub dbneedsupdate {
 343   $main::lxdebug->enter_sub();
 344
 345   my ($self, $form) = @_;
 346
 347   my %members   = $main::auth->read_all_users();
 348   my $dbupdater = SL::DBUpgrade2->new(form => $form)->parse_dbupdate_controls;
 349
 350   my ($query, $sth, %dbs_needing_updates);
 351
 352   foreach my $login (grep /[a-z]/, keys %members) {
 353     my $member = $members{$login};
 354
 355     map { $form->{$_} = $member->{$_} } qw(dbname dbuser dbpasswd dbhost dbport);
 356     dbconnect_vars($form, $form->{dbname});
 357
 358     my $dbh = SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options);
 359
 360     next unless $dbh;
 361
 362     my $version;
 363
 364     $query = qq|SELECT version FROM defaults|;
 365     $sth = prepare_query($form, $dbh, $query);
 366     if ($sth->execute()) {
 367       ($version) = $sth->fetchrow_array();
 368     }
 369     $sth->finish();
 370
 371     $dbh->disconnect and next unless $version;
 372
 373     my $update_available = $dbupdater->update_available($version) || $dbupdater->update2_available($dbh);
 374     $dbh->disconnect;
 375
 376    if ($update_available) {
 377       my $dbinfo = {};
 378       map { $dbinfo->{$_} = $member->{$_} } grep /^db/, keys %{ $member };
 379       $dbs_needing_updates{$member->{dbhost} . "::" . $member->{dbname}} = $dbinfo;
 380     }
 381   }
 382
 383   $main::lxdebug->leave_sub();
 384
 385   return values %dbs_needing_updates;
 386 }
 387
 388 sub calc_version {
 389   $main::lxdebug->enter_sub(2);
 390
 391   my (@v, $version, $i);
 392
 393   @v = split(/\./, $_[0]);
 394   while (scalar(@v) < 4) {
 395     push(@v, 0);
 396   }
 397   $version = 0;
 398   for ($i = 0; $i < 4; $i++) {
 399     $version *= 1000;
 400     $version += $v[$i];
 401   }
 402
 403   $main::lxdebug->leave_sub(2);
 404   return $version;
 405 }
 406
 407 sub cmp_script_version {
 408   my ($a_from, $a_to, $b_from, $b_to);
 409   my ($i, $res_a, $res_b);
 410   my ($my_a, $my_b) = ($a, $b);
 411
 412   $my_a =~ s/.*-upgrade-//;
 413   $my_a =~ s/.sql$//;
 414   $my_b =~ s/.*-upgrade-//;
 415   $my_b =~ s/.sql$//;
 416   my ($my_a_from, $my_a_to) = split(/-/, $my_a);
 417   my ($my_b_from, $my_b_to) = split(/-/, $my_b);
 418
 419   $res_a = calc_version($my_a_from);
 420   $res_b = calc_version($my_b_from);
 421
 422   if ($res_a == $res_b) {
 423     $res_a = calc_version($my_a_to);
 424     $res_b = calc_version($my_b_to);
 425   }
 426
 427   return $res_a <=> $res_b;
 428 }
 429
 430 sub create_schema_info_table {
 431   $main::lxdebug->enter_sub();
 432
 433   my ($self, $form, $dbh) = @_;
 434
 435   my $query = "SELECT tag FROM schema_info LIMIT 1";
 436   if (!$dbh->do($query)) {
 437     $dbh->rollback();
 438     $query =
 439       qq|CREATE TABLE schema_info (| .
 440       qq|  tag text, | .
 441       qq|  login text, | .
 442       qq|  itime timestamp DEFAULT now(), | .
 443       qq|  PRIMARY KEY (tag))|;
 444     $dbh->do($query) || $form->dberror($query);
 445   }
 446
 447   $main::lxdebug->leave_sub();
 448 }
 449
 450 sub dbupdate {
 451   $main::lxdebug->enter_sub();
 452
 453   my ($self, $form) = @_;
 454
 455   local *SQLDIR;
 456
 457   my @upgradescripts = ();
 458   my $query;
 459   my $rc = -2;
 460
 461   if ($form->{dbupdate}) {
 462
 463     # read update scripts into memory
 464     opendir(SQLDIR, "sql/Pg-upgrade")
 465       or &error("", "sql/Pg-upgrade : $!");
 466     @upgradescripts =
 467       sort(cmp_script_version
 468            grep(/Pg-upgrade-.*?\.(sql|pl)$/,
 469                 readdir(SQLDIR)));
 470     closedir(SQLDIR);
 471   }
 472
 473   my $db_charset = $::lx_office_conf{system}->{dbcharset};
 474   $db_charset ||= Common::DEFAULT_CHARSET;
 475
 476   my $dbupdater = SL::DBUpgrade2->new(form => $form);
 477
 478   foreach my $db (split(/ /, $form->{dbupdate})) {
 479
 480     next unless $form->{$db};
 481
 482     # strip db from dataset
 483     $db =~ s/^db//;
 484     &dbconnect_vars($form, $db);
 485
 486     my $dbh = SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options)
 487       or $form->dberror;
 488
 489     $dbh->do($form->{dboptions}) if ($form->{dboptions});
 490
 491     # check version
 492     $query = qq|SELECT version FROM defaults|;
 493     my ($version) = selectrow_query($form, $dbh, $query);
 494
 495     next unless $version;
 496
 497     $version = calc_version($version);
 498
 499     foreach my $upgradescript (@upgradescripts) {
 500       my $a = $upgradescript;
 501       $a =~ s/^Pg-upgrade-|\.(sql|pl)$//g;
 502
 503       my ($mindb, $maxdb) = split /-/, $a;
 504       my $str_maxdb = $maxdb;
 505       $mindb = calc_version($mindb);
 506       $maxdb = calc_version($maxdb);
 507
 508       next if ($version >= $maxdb);
 509
 510       # if there is no upgrade script exit
 511       last if ($version < $mindb);
 512
 513       # apply upgrade
 514       $main::lxdebug->message(LXDebug->DEBUG2(), "Applying Update $upgradescript");
 515       $dbupdater->process_file($dbh, "sql/Pg-upgrade/$upgradescript", $str_maxdb, $db_charset);
 516
 517       $version = $maxdb;
 518
 519     }
 520
 521     $rc = 0;
 522     $dbh->disconnect;
 523
 524   }
 525
 526   $main::lxdebug->leave_sub();
 527
 528   return $rc;
 529 }
 530
 531 sub dbupdate2 {
 532   $main::lxdebug->enter_sub();
 533
 534   my ($self, %params) = @_;
 535
 536   my $form            = $params{form};
 537   my $dbupdater       = $params{updater};
 538   my $db              = $params{database};
 539   my $rc              = -2;
 540   my $db_charset      = $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET;
 541
 542   map { $_->{description} = SL::Iconv::convert($_->{charset}, $db_charset, $_->{description}) } values %{ $dbupdater->{all_controls} };
 543
 544   &dbconnect_vars($form, $db);
 545
 546   my $dbh = SL::DBConnect->connect($form->{dbconnect}, $form->{dbuser}, $form->{dbpasswd}, SL::DBConnect->get_options) or $form->dberror;
 547
 548   $dbh->do($form->{dboptions}) if ($form->{dboptions});
 549
 550   $self->create_schema_info_table($form, $dbh);
 551
 552   my @upgradescripts = $dbupdater->unapplied_upgrade_scripts($dbh);
 553
 554   $dbh->disconnect and next if !@upgradescripts;
 555
 556   foreach my $control (@upgradescripts) {
 557     # apply upgrade
 558     $main::lxdebug->message(LXDebug->DEBUG2(), "Applying Update $control->{file}");
 559     print $form->parse_html_template("dbupgrade/upgrade_message2", $control);
 560
 561     $dbupdater->process_file($dbh, "sql/Pg-upgrade2/$control->{file}", $control, $db_charset);
 562   }
 563
 564   $rc = 0;
 565   $dbh->disconnect;
 566
 567   $main::lxdebug->leave_sub();
 568
 569   return $rc;
 570 }
 571
 572 sub data {
 573   +{ %{ $_[0] } }
 574 }
 575
 576 1;