trunk/gosa-si/modules/DBsqlite.pm

   1 package GOSA::DBsqlite;
   2
   3 use strict;
   4 use warnings;
   5 use Carp;
   6 use DBI;
   7 use GOSA::GosaSupportDaemon;
   8 use Time::HiRes qw(usleep);
   9 use Fcntl qw/:DEFAULT :flock/; # import LOCK_* constants
  10
  11 our $col_names = {};
  12
  13 sub new {
  14         my $class = shift;
  15         my $db_name = shift;
  16
  17         my $lock = $db_name.".si.lock";
  18         my $self = {dbh=>undef,db_name=>undef,db_lock=>undef,db_lock_handle=>undef};
  19         my $dbh = DBI->connect("dbi:SQLite:dbname=$db_name", "", "", {RaiseError => 1, AutoCommit => 1, PrintError => 0});
  20
  21         $self->{dbh} = $dbh;
  22         $self->{db_name} = $db_name;
  23         $self->{db_lock} = $lock;
  24         bless($self,$class);
  25
  26         my $sth = $self->{dbh}->prepare("pragma integrity_check");
  27            $sth->execute();
  28         my @ret = $sth->fetchall_arrayref();
  29            $sth->finish();
  30         if(length(@ret)==1 && $ret[0][0][0] eq 'ok') {
  31                 &main::daemon_log("0 DEBUG: Database disk image '".$self->{db_name}."' is ok.", 7);
  32         } else {
  33                 &main::daemon_log("0 ERROR: Database disk image '".$self->{db_name}."' is malformed, creating new database!", 1);
  34                 $self->{dbh}->disconnect() or &main::daemon_log("0 ERROR: Could not disconnect from database '".$self->{db_name}."'!", 1);
  35                 $self->{dbh}= undef;
  36                 unlink($db_name);
  37         }
  38         return($self);
  39 }
  40
  41
  42 sub connect {
  43         my $self = shift;
  44         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
  45                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::connect was called static! Argument was '$self'!", 1);
  46                 return;
  47         }
  48
  49         $self->{dbh} = DBI->connect("dbi:SQLite:dbname=".$self->{db_name}, "", "", {PrintError => 0, RaiseError => 1, AutoCommit => 1}) or
  50           &main::daemon_log("0 ERROR: Could not connect to database '".$self->{db_name}."'!", 1);
  51
  52         return;
  53 }
  54
  55
  56 sub disconnect {
  57         my $self = shift;
  58         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
  59                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::disconnect was called static! Argument was '$self'!", 1);
  60                 return;
  61         }
  62
  63         eval {
  64                 $self->{dbh}->disconnect();
  65         };
  66   if($@) {
  67                 &main::daemon_log("ERROR: Could not disconnect from database '".$self->{db_name}."'!", 1);
  68         }
  69
  70         $self->{dbh}= undef;
  71
  72         return;
  73 }
  74
  75
  76 sub lock {
  77         my $self = shift;
  78         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
  79                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::lock was called static! Argument was '$self'!", 1);
  80                 return;
  81         }
  82
  83         if(not ref $self->{db_lock_handle} or not fileno $self->{db_lock_handle}) {
  84                 sysopen($self->{db_lock_handle}, $self->{db_lock}, O_RDWR | O_CREAT, 0600) or &main::daemon_log("0 ERROR: Opening the database ".$self->{db_name}." failed with $!", 1);
  85         }
  86 get_lock:
  87         my $lock_result = flock($self->{db_lock_handle}, LOCK_EX | LOCK_NB);
  88         if(not $lock_result) {
  89                 &main::daemon_log("0 ERROR: Could not acquire lock for database ".$self->{db_name}, 1);
  90                 usleep(250+rand(500));
  91                 goto get_lock;
  92         } else {
  93                 seek($self->{db_lock_handle}, 0, 2);
  94                 &main::daemon_log("0 DEBUG: Acquired lock for database ".$self->{db_name}, 8);
  95                 $self->connect();
  96         }
  97         return;
  98 }
  99
 100
 101 sub unlock {
 102         my $self = shift;
 103         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 104                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::unlock was called static! Argument was '$self'!", 1);
 105                 return;
 106         }
 107         if(not ref $self->{db_lock_handle}) {
 108                 &main::daemon_log("0 BIG ERROR: Lockfile for database ".$self->{db_name}."got closed within critical section!", 1);
 109         }
 110         flock($self->{db_lock_handle}, LOCK_UN);
 111         &main::daemon_log("0 DEBUG: Released lock for database ".$self->{db_name}, 8);
 112         $self->disconnect();
 113         return;
 114 }
 115
 116
 117 sub create_table {
 118         my $self = shift;
 119         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 120                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::create_table was called static! Statement was '$self'!", 1);
 121                 return;
 122         }
 123         my $table_name = shift;
 124         my $col_names_ref = shift;
 125         my $index_names_ref = shift || undef;
 126         my @col_names;
 127         my @col_names_creation;
 128         foreach my $col_name (@$col_names_ref) {
 129                 push(@col_names, $col_name);
 130         }
 131
 132         $col_names->{ $table_name } = \@col_names;
 133         my $col_names_string = join(", ", @col_names);
 134         my $sql_statement = "CREATE TABLE IF NOT EXISTS $table_name ( $col_names_string )";
 135         my $res = $self->exec_statement($sql_statement);
 136         if ($@) {
 137                 &main::daemon_log("0 ERROR: CREATE TABLE IF NOT EXISTS $table_name failed", 1);
 138                 return 1;
 139         }
 140
 141         # Add indices
 142         if(defined($index_names_ref) and ref($index_names_ref) eq 'ARRAY') {
 143                 foreach my $index_name (@$index_names_ref) {
 144                         $self->exec_statement("CREATE ".(($index_name eq 'id')?'UNIQUE':'')." INDEX IF NOT EXISTS $index_name on $table_name ($index_name);");
 145                         if ($@) {
 146                                 &main::daemon_log("0 ERROR: CREATE $index_name on $table_name failed", 1);
 147                                 return 1;
 148                         }
 149                 }
 150         }
 151
 152         return 0;
 153 }
 154
 155
 156 sub add_dbentry {
 157         my $self = shift;
 158         my $arg = shift;
 159         my $res = 0;   # default value
 160
 161         # if dbh not specified, return errorflag 1
 162         my $table = $arg->{table};
 163         if( not defined $table ) {
 164                 return 1 ;
 165         }
 166
 167         # if timestamp is not provided, add timestamp
 168         if( not exists $arg->{timestamp} ) {
 169                 $arg->{timestamp} = &get_time;
 170         }
 171
 172         # check primkey and run insert or update
 173         my $primkeys = $arg->{'primkey'};
 174         my $prim_statement="";
 175         if( 0 != @$primkeys ) {   # more than one primkey exist in list
 176                 my @prim_list;
 177                 foreach my $primkey (@$primkeys) {
 178                         if( not exists $arg->{$primkey} ) {
 179                                 return (3, "primkey '$primkey' has no value for add_dbentry");
 180                         }
 181                         push(@prim_list, "$primkey='".$arg->{$primkey}."'");
 182                 }
 183                 $prim_statement = "WHERE ".join(" AND ", @prim_list);
 184
 185                 # check wether primkey is unique in table, otherwise return errorflag
 186                 my $sql_statement = "SELECT * FROM $table $prim_statement";
 187                 $res = @{ $self->exec_statement($sql_statement) };
 188         }
 189
 190         # primkey is unique or no primkey specified -> run insert
 191         if ($res == 0) {
 192                 # fetch column names of table
 193                 my $col_names = &get_table_columns($self, $table);
 194
 195                 my $create_id=0;
 196                 foreach my $col_name (@{$col_names}) {
 197                         if($col_name eq "id" && (! exists $arg->{$col_name})) {
 198                                 $create_id=1;
 199                         }
 200                 }
 201                 # assign values to column name variables
 202                 my @col_list;
 203                 my @val_list;
 204                 foreach my $col_name (@{$col_names}) {
 205                         # use function parameter for column values
 206                         if (exists $arg->{$col_name}) {
 207                                 push(@col_list, "'".$col_name."'");
 208                                 push(@val_list, "'".$arg->{$col_name}."'");
 209                         }
 210                 }
 211
 212                 my $sql_statement;
 213                 if($create_id==1) {
 214                         $sql_statement = "INSERT INTO $table (id, ".join(", ", @col_list).") VALUES (null, ".join(", ", @val_list).")";
 215                 } else {
 216                         $sql_statement = "INSERT INTO $table (".join(", ", @col_list).") VALUES (".join(", ", @val_list).")";
 217                 }
 218                 my $db_res;
 219                 my $success=0;
 220                 $self->lock();
 221                 eval {
 222                         my $sth = $self->{dbh}->prepare($sql_statement);
 223                         $db_res = $sth->execute();
 224                         $sth->finish();
 225                         &main::daemon_log("0 DEBUG: Execution of statement '$sql_statement' succeeded!", 9);
 226                         $success = 1;
 227                 };
 228                 if($@) {
 229                         eval {
 230                                 $self->{dbh}->do("ANALYZE");
 231                                 $self->{dbh}->do("VACUUM");
 232                         };
 233                 }
 234                 if($success==0) {
 235                         eval {
 236                                 my $sth = $self->{dbh}->prepare($sql_statement);
 237                                 $db_res = $sth->execute();
 238                                 $sth->finish();
 239                                 &main::daemon_log("0 DEBUG: Execution of statement '$sql_statement' succeeded!", 9);
 240                                 $success = 1;
 241                         };
 242                         if($@) {
 243                                 eval {
 244                                         $self->{dbh}->do("ANALYZE");
 245                                         $self->{dbh}->do("VACUUM");
 246                                 };
 247                         }
 248                 }
 249                 if($success==0) {
 250                         eval {
 251                                 my $sth = $self->{dbh}->prepare($sql_statement);
 252                                 $db_res = $sth->execute();
 253                                 $sth->finish();
 254                                 &main::daemon_log("0 DEBUG: Execution of statement '$sql_statement' succeeded!", 7);
 255                                 $success = 1;
 256                         };
 257                         if($@) {
 258                                 &main::daemon_log("0 ERROR: Execution of statement '$sql_statement' failed with $@", 1);
 259                         }
 260                 }
 261                 $self->unlock();
 262
 263                 if( $db_res != 1 ) {
 264                         return (4, $sql_statement);
 265                 }
 266
 267                 # entry already exists -> run update
 268         } else  {
 269                 my @update_l;
 270                 while( my ($pram, $val) = each %{$arg} ) {
 271                         if( $pram eq 'table' ) { next; }
 272                         if( $pram eq 'primkey' ) { next; }
 273                         push(@update_l, "$pram='$val'");
 274                 }
 275                 my $update_str= join(", ", @update_l);
 276                 $update_str= " SET $update_str";
 277
 278                 my $sql_statement= "UPDATE $table $update_str $prim_statement";
 279                 my $db_res = &update_dbentry($self, $sql_statement );
 280         }
 281
 282         return 0;
 283 }
 284
 285
 286 sub update_dbentry {
 287         my ($self, $sql)= @_;
 288         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 289                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::update_dbentry was called static! Statement was '$self'!", 1);
 290                 return;
 291         }
 292         my $db_answer= $self->exec_statement($sql);
 293         return $db_answer;
 294 }
 295
 296
 297 sub del_dbentry {
 298         my ($self, $sql)= @_;;
 299         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 300                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::del_dbentry was called static! Statement was '$self'!", 1);
 301                 return;
 302         }
 303         my $db_res= $self->exec_statement($sql);
 304         return $db_res;
 305 }
 306
 307
 308 sub get_table_columns {
 309         my $self = shift;
 310         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 311                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::get_table_columns was called static! Statement was '$self'!", 1);
 312                 return;
 313         }
 314         my $table = shift;
 315         my @column_names;
 316
 317         if(exists $col_names->{$table}) {
 318                 foreach my $col_name (@{$col_names->{$table}}) {
 319                         push @column_names, ($1) if $col_name =~ /^(.*?)\s.*$/;
 320                 }
 321         } else {
 322                 my @res;
 323                 foreach my $column ( @{ $self->exec_statement ( "pragma table_info('$table')" ) } ) {
 324                         push(@column_names, @$column[1]);
 325                 }
 326         }
 327
 328         return \@column_names;
 329 }
 330
 331
 332 sub select_dbentry {
 333         my ($self, $sql)= @_;
 334         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 335                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::select_dbentry was called static! Statement was '$self'!", 1);
 336                 return;
 337         }
 338         my $error= 0;
 339         my $answer= {};
 340         my $db_answer= $self->exec_statement($sql);
 341         my @column_list;
 342
 343         # fetch column list of db and create a hash with column_name->column_value of the select query
 344         $sql =~ /SELECT ([\S\s]*?) FROM ([\S]*?)( |$)/g;
 345         my $selected_cols = $1;
 346         my $table = $2;
 347
 348         # all columns are used for creating answer
 349         if ($selected_cols eq '*') {
 350                 @column_list = @{ $self->get_table_columns($table) };
 351
 352                 # specific columns are used for creating answer
 353         } else {
 354                 # remove all blanks and split string to list of column names
 355                 $selected_cols =~ s/ //g;
 356                 @column_list = split(/,/, $selected_cols);
 357         }
 358
 359         # create answer
 360         my $hit_counter = 0;
 361         my $list_len = @column_list;
 362         foreach my $hit ( @{$db_answer} ){
 363                 $hit_counter++;
 364                 for ( my $i = 0; $i < $list_len; $i++) {
 365                         $answer->{ $hit_counter }->{ $column_list[$i] } = @{ $hit }[$i];
 366                 }
 367         }
 368
 369         return $answer;
 370 }
 371
 372
 373 sub show_table {
 374         my $self = shift;
 375         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 376                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::show_table was called static! Statement was '$self'!", 1);
 377                 return;
 378         }
 379         my $table_name = shift;
 380
 381         my $sql_statement= "SELECT * FROM $table_name ORDER BY timestamp";
 382         my $res= $self->exec_statement($sql_statement);
 383         my @answer;
 384         foreach my $hit (@{$res}) {
 385                 push(@answer, "hit: ".join(', ', @{$hit}));
 386         }
 387
 388         return join("\n", @answer);
 389 }
 390
 391
 392 sub exec_statement {
 393         my $self = shift;
 394         my $sql_statement = shift;
 395         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 396                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::exec_statement was called static! Statement was '$self'!", 1);
 397                 return;
 398         }
 399
 400         if(not defined($sql_statement) or length($sql_statement) == 0) {
 401                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::exec_statement was called with empty statement!", 1);
 402                 return;
 403         }
 404
 405         my @db_answer;
 406         my $success= 0;
 407         $self->lock();
 408         # Give three chances to the sqlite database
 409         # 1st chance
 410         eval {
 411                 my $sth = $self->{dbh}->prepare($sql_statement);
 412                 my $res = $sth->execute();
 413                 @db_answer = @{$sth->fetchall_arrayref()};
 414                 $sth->finish();
 415                 $success=1;
 416                 &main::daemon_log("0 DEBUG: $sql_statement succeeded.", 9);
 417         };
 418         if($@) {
 419                 eval {
 420                         $self->{dbh}->do("ANALYZE");
 421                         $self->{dbh}->do("VACUUM");
 422                         $self->{dbh}->do("pragma integrity_check");
 423                 };
 424         }
 425         if($success) {
 426                 $self->unlock();
 427                 return \@db_answer ;
 428         }
 429
 430         # 2nd chance
 431         eval {
 432                 usleep(200);
 433                 my $sth = $self->{dbh}->prepare($sql_statement);
 434                 my $res = $sth->execute();
 435                 @db_answer = @{$sth->fetchall_arrayref()};
 436                 $sth->finish();
 437                 $success=1;
 438                 &main::daemon_log("0 DEBUG: $sql_statement succeeded.", 9);
 439         };
 440         if($@) {
 441                 eval {
 442                         $self->{dbh}->do("ANALYZE");
 443                         $self->{dbh}->do("VACUUM");
 444                         $self->{dbh}->do("pragma integrity_check");
 445                 };
 446         }
 447         if($success) {
 448                 $self->unlock();
 449                 return \@db_answer ;
 450         }
 451
 452         # 3rd chance
 453         eval {
 454                 usleep(200);
 455                 DBI->trace(6) if($main::verbose >= 7);
 456                 my $sth = $self->{dbh}->prepare($sql_statement);
 457                 my $res = $sth->execute();
 458                 @db_answer = @{$sth->fetchall_arrayref()};
 459                 $sth->finish();
 460                 DBI->trace(0);
 461                 &main::daemon_log("0 DEBUG: $sql_statement succeeded.", 9);
 462         };
 463         if($@) {
 464                 DBI->trace(0);
 465                 &main::daemon_log("ERROR: $sql_statement failed with $@", 1);
 466         }
 467         # TODO : maybe an error handling and an erro feedback to invoking function
 468         #my $error = @$self->{dbh}->err;
 469         #if ($error) {
 470         #       my $error_string = @$self->{dbh}->errstr;
 471         #}
 472
 473         $self->unlock();
 474         return \@db_answer;
 475 }
 476
 477
 478 sub exec_statementlist {
 479         my $self = shift;
 480         my $sql_list = shift;
 481         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 482                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::exec_statementlist was called static!", 1);
 483                 return;
 484         }
 485         my @db_answer;
 486
 487         foreach my $sql_statement (@$sql_list) {
 488                 if(defined($sql_statement) && length($sql_statement) > 0) {
 489                         push @db_answer, $self->exec_statement($sql_statement);
 490                 } else {
 491                         next;
 492                 }
 493         }
 494
 495         return \@db_answer;
 496 }
 497
 498
 499 sub count_dbentries {
 500         my ($self, $table)= @_;
 501         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 502                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::count_dbentries was called static!", 1);
 503                 return;
 504         }
 505         my $error= 0;
 506         my $count= -1;
 507
 508         my $sql_statement= "SELECT count() FROM $table";
 509         my $db_answer= $self->select_dbentry($sql_statement);
 510         if(defined($db_answer) && defined($db_answer->{1}) && defined($db_answer->{1}->{'count()'})) {
 511                 $count = $db_answer->{1}->{'count()'};
 512         }
 513
 514         return $count;
 515 }
 516
 517
 518 sub move_table {
 519         my ($self, $from, $to) = @_;
 520         if(not defined($self) or ref($self) ne 'GOSA::DBsqlite') {
 521                 &main::daemon_log("0 ERROR: GOSA::DBsqlite::move_table was called static!", 1);
 522                 return;
 523         }
 524
 525         my $sql_statement_drop = "DROP TABLE IF EXISTS $to";
 526         my $sql_statement_alter = "ALTER TABLE $from RENAME TO $to";
 527         my $success = 0;
 528
 529         $self->lock();
 530         eval {
 531                 $self->{dbh}->begin_work();
 532                 $self->{dbh}->do($sql_statement_drop);
 533                 $self->{dbh}->do($sql_statement_alter);
 534                 $self->{dbh}->commit();
 535                 $success = 1;
 536         };
 537         if($@) {
 538                 $self->{dbh}->rollback();
 539                 eval {
 540                         $self->{dbh}->do("ANALYZE");
 541                 };
 542                 if($@) {
 543                         &main::daemon_log("ERROR: 'ANALYZE' on database '".$self->{db_name}."' failed with $@", 1);
 544                 }
 545                 eval {
 546                         $self->{dbh}->do("VACUUM");
 547                 };
 548                 if($@) {
 549                         &main::daemon_log("ERROR: 'VACUUM' on database '".$self->{db_name}."' failed with $@", 1);
 550                 }
 551         }
 552
 553         if($success == 0) {
 554                 eval {
 555                         $self->{dbh}->begin_work();
 556                         $self->{dbh}->do($sql_statement_drop);
 557                         $self->{dbh}->do($sql_statement_alter);
 558                         $self->{dbh}->commit();
 559                         $success = 1;
 560                 };
 561                 if($@) {
 562                         $self->{dbh}->rollback();
 563                         eval {
 564                                 $self->{dbh}->do("ANALYZE");
 565                         };
 566                         if($@) {
 567                                 &main::daemon_log("ERROR: 'ANALYZE' on database '".$self->{db_name}."' failed with $@", 1);
 568                         }
 569                         eval {
 570                                 $self->{dbh}->do("VACUUM");
 571                         };
 572                         if($@) {
 573                                 &main::daemon_log("ERROR: 'VACUUM' on database '".$self->{db_name}."' failed with $@", 1);
 574                         }
 575                 }
 576         }
 577
 578         if($success == 0) {
 579                 eval {
 580                         $self->{dbh}->begin_work();
 581                         $self->{dbh}->do($sql_statement_drop);
 582                         $self->{dbh}->do($sql_statement_alter);
 583                         $self->{dbh}->commit();
 584                         $success = 1;
 585                 };
 586                 if($@) {
 587                         $self->{dbh}->rollback();
 588                         &main::daemon_log("0 ERROR: GOSA::DBsqlite::move_table crashed! Operation failed with $@", 1);
 589                 }
 590         }
 591
 592         &main::daemon_log("0 INFO: GOSA::DBsqlite::move_table: Operation successful!", 7);
 593         $self->unlock();
 594
 595         return;
 596 }
 597
 598
 599 1;