cgi-files/Modules/Database/MySQL5.pm

   1 #################################################################################
   2 # Kiriwrite Database Module - MySQL 5.x Database Module (MySQL5.pm)             #
   3 # Database module for mainipulating data in a MySQL 5.x database.               #
   4 #                                                                               #
   5 # Copyright (C) 2007 Steve Brokenshire <sbrokenshire@xestia.co.uk>              #
   6 #                                                                               #
   7 # This module is licensed under the same license as Kiriwrite which is the GPL. #
   8 #                                                                               #
   9 # This program is free software; you can redistribute it and/or modify it under #
  10 # the terms of the GNU General Public License as published by the Free          #
  11 # Software Foundation; as version 2 of the License.                             #
  12 #                                                                               #
  13 # This program is distributed in the hope that it will be useful, but WITHOUT   #
  14 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
  15 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.#
  16 #                                                                               #
  17 # You should have received a copy of the GNU General Public License along with  #
  18 # this program; if not, write to the Free Software Foundation, Inc., 51         #
  19 # Franklin St, Fifth Floor, Boston, MA 02110-1301 USA                           #
  20 #################################################################################
  21
  22 # Define the package (perl module) name.
  23
  24 package Kiriwrite::Database::MySQL5;
  25
  26 # Enable strict and use warnings.
  27
  28 use strict;
  29 use warnings;
  30 use Encode qw(decode_utf8);
  31
  32 # Load the following Perl modules.
  33
  34 use DBI qw(:sql_types);
  35
  36 # Set the following values.
  37
  38 our $VERSION    = "0.1.0";
  39 my ($options, %options);
  40 my $database_handle;
  41 my $string_handle;
  42 my $error;
  43 my $errorext;
  44 my $database_filename;
  45 my $second_database_filename;
  46
  47 #################################################################################
  48 # Generic Subroutines.                                                          #
  49 #################################################################################
  50
  51 sub new{
  52 #################################################################################
  53 # new: Create an instance of Kiriwrite::Database::MySQL                         #
  54 #                                                                               #
  55 # Usage:                                                                        #
  56 #                                                                               #
  57 # $dbmodule = Kiriwrite::Database::SQLite->new();                               #
  58 #################################################################################
  59
  60         # Get the perl module name.
  61
  62         my $class = shift;
  63         my $self = {};
  64
  65         return bless($self, $class);
  66
  67 }
  68
  69 sub loadsettings{
  70 #################################################################################
  71 # loadsettings: Loads settings into the SQLite database module                  #
  72 #                                                                               #
  73 # Usage:                                                                        #
  74 #                                                                               #
  75 # $dbmodule->loadsettings(Directory, options);                                  #
  76 #                                                                               #
  77 # options       Specifies the following options (in any order).                 #
  78 #                                                                               #
  79 # Directory     Specifies the directory to use for getting databases.           #
  80 # DateTime      Specifies the date and time format to use.                      #
  81 # Server        Specifies the server to use.                                    #
  82 # Database      Specifies the database to use.                                  #
  83 # Username      Specifies the username to use.                                  #
  84 # Password      Specifies the password to use.                                  #
  85 # Port          Specifies the server port to use.                               #
  86 # Protocol      Specifies the protocol to use.                                  #
  87 # TablePrefix   Specifies the table prefix to use.                              #
  88 #################################################################################
  89
  90         # Get the data passed to the subroutine.
  91
  92         my $class = shift;
  93         my ($passedoptions)     = @_;
  94
  95         # Add the directory setting to the list of options (as it's the only
  96         # one needed for this database module).
  97
  98         %options = (
  99                 "Directory"     => $passedoptions->{"Directory"},
 100                 "DateTime"      => $passedoptions->{"DateTime"},
 101                 "Server"        => $passedoptions->{"Server"},
 102                 "Database"      => $passedoptions->{"Database"},
 103                 "Username"      => $passedoptions->{"Username"},
 104                 "Password"      => $passedoptions->{"Password"},
 105                 "Port"          => $passedoptions->{"Port"},
 106                 "Protocol"      => $passedoptions->{"Protocol"},
 107                 "TablePrefix"   => $passedoptions->{"TablePrefix"}
 108         );
 109
 110 }
 111
 112 sub convert{
 113 #################################################################################
 114 # convert: Converts data into SQL formatted data.                               #
 115 #                                                                               #
 116 # Usage:                                                                        #
 117 #                                                                               #
 118 # $dbmodule->convert(data);                                                     #
 119 #                                                                               #
 120 # data          Specifies the data to convert.                                  #
 121 #################################################################################
 122
 123         # Get the data passed to the subroutine.
 124
 125         my $class       = shift;
 126         my $data        = shift;
 127
 128         if (!$data){
 129                 $data = "";
 130         }
 131
 132         $data =~ s/'/''/g;
 133         $data =~ s/\b//g;
 134
 135         return $data;
 136
 137 }
 138
 139 sub dateconvert{
 140 #################################################################################
 141 # dateconvert: Converts a SQL date into a proper date.                          #
 142 #                                                                               #
 143 # Usage:                                                                        #
 144 #                                                                               #
 145 # $dbmodule->dateconvert(date);                                                 #
 146 #                                                                               #
 147 # date          Specifies the date to convert.                                  #
 148 #################################################################################
 149
 150         # Get the date passed to the subroutine.
 151
 152         my $class       = shift;
 153         my $data        = shift;
 154
 155         # Convert the date given into the proper date.
 156
 157         # Create the following varialbes to be used later.
 158
 159         my $date;
 160         my $time;
 161         my $day;
 162         my $day_full;
 163         my $month;
 164         my $month_check;
 165         my $month_full;
 166         my $year;
 167         my $year_short;
 168         my $hour;
 169         my $hour_full;
 170         my $minute;
 171         my $minute_full;
 172         my $second;
 173         my $second_full;
 174         my $seek = 0;
 175         my $timelength;
 176         my $datelength;
 177         my $daylength;
 178         my $secondlength;
 179         my $startchar = 0;
 180         my $char;
 181         my $length;
 182         my $count = 0;
 183
 184         # Split the date and time.
 185
 186         $length = length($data);
 187
 188         if ($length > 0){
 189
 190                 do {
 191
 192                         # Get the character and check if it is a space.
 193
 194                         $char = substr($data, $seek, 1);
 195
 196                         if ($char eq ' '){
 197
 198                                 # The character is a space, so get the date and time.
 199
 200                                 $date           = substr($data, 0, $seek);
 201                                 $timelength     = $length - $seek - 1;
 202                                 $time           = substr($data, $seek + 1, $timelength);
 203
 204                         }
 205
 206                         $seek++;
 207
 208                 } until ($seek eq $length);
 209
 210                 # Get the year, month and date.
 211
 212                 $length = length($date);
 213                 $seek = 0;
 214
 215                 do {
 216
 217                         # Get the character and check if it is a dash.
 218
 219                         $char = substr($date, $seek, 1);
 220
 221                         if ($char eq '-'){
 222
 223                                 # The character is a dash, so get the year, month or day.
 224
 225                                 $datelength = $seek - $startchar;
 226
 227                                 if ($count eq 0){
 228
 229                                         # Get the year from the date.
 230
 231                                         $year           = substr($date, 0, $datelength) + 1900;
 232                                         $startchar      = $seek;
 233                                         $count = 1;
 234
 235                                         # Get the last two characters to get the short year
 236                                         # version.
 237
 238                                         $year_short     = substr($year, 2, 2);
 239
 240                                 } elsif ($count eq 1){
 241
 242                                         # Get the month and day from the date.
 243
 244                                         $month  = substr($date, $startchar + 1, $datelength - 1) + 1;
 245
 246                                         # Check if the month is less then 10, if it is
 247                                         # add a zero to the value.
 248
 249                                         if ($month < 10){
 250
 251                                                 $month_full = '0' . $month;
 252
 253                                         } else {
 254
 255                                                 $month_full = $month;
 256
 257                                         }
 258
 259                                         $startchar      = $seek;
 260                                         $count = 2;
 261
 262                                         $daylength      = $length - $seek + 1;
 263                                         $day            = substr($date, $startchar + 1, $daylength);
 264
 265                                         $day =~ s/^0//;
 266
 267                                         # Check if the day is less than 10, if it is
 268                                         # add a zero to the value.
 269
 270                                         if ($day < 10){
 271
 272                                                 $day_full       = '0' . $day;
 273
 274                                         } else {
 275
 276                                                 $day_full       = $day;
 277
 278                                         }
 279
 280                                 }
 281
 282                         }
 283
 284                         $seek++;
 285
 286                 } until ($seek eq $length);
 287
 288                 # Get the length of the time value and reset certain
 289                 # values to 0.
 290
 291                 $length = length($time);
 292                 $seek = 0;
 293                 $count = 0;
 294                 $startchar = 0;
 295
 296                 do {
 297
 298                         # Get the character and check if it is a colon.
 299
 300                         $char = substr($time, $seek, 1);
 301
 302                         if ($char eq ':'){
 303
 304                                 # The character is a colon, so get the hour, minute and day.
 305
 306                                 $timelength = $seek - $startchar;
 307
 308                                 if ($count eq 0){
 309
 310                                         # Get the hour from the time.
 311
 312                                         $hour = substr($time, 0, $timelength);
 313                                         $hour =~ s/^0//;
 314                                         $count = 1;
 315                                         $startchar = $seek;
 316
 317                                         # If the hour is less than ten then add a
 318                                         # zero.
 319
 320                                         if ($hour < 10){
 321
 322                                                 $hour_full = '0' . $hour;
 323
 324                                         } else {
 325
 326                                                 $hour_full = $hour;
 327
 328                                         }
 329
 330                                 } elsif ($count eq 1){
 331
 332                                         # Get the minute and second from the time.
 333
 334                                         $minute = substr($time, $startchar + 1, $timelength - 1);
 335                                         $minute =~ s/^0//;
 336                                         $count = 2;
 337
 338                                         # If the minute is less than ten then add a
 339                                         # zero.
 340
 341                                         if ($minute < 10){
 342
 343                                                 $minute_full = '0' . $minute;
 344
 345                                         } else {
 346
 347                                                 $minute_full = $minute;
 348
 349                                         }
 350
 351                                         $startchar = $seek;
 352
 353                                         $secondlength = $length - $seek + 1;
 354                                         $second = substr($time, $startchar + 1, $secondlength);
 355                                         $second =~ s/^0//;
 356
 357                                         # If the second is less than ten then add a
 358                                         # zero.
 359
 360                                         if ($second < 10){
 361
 362                                                 $second_full = '0' . $second;
 363
 364                                         } else {
 365
 366                                                 $second_full = $second;
 367
 368                                         }
 369
 370                                 }
 371
 372                         }
 373
 374                         $seek++;
 375
 376                 } until ($seek eq $length);
 377
 378                 # Get the setting for displaying the date and time.
 379
 380                 $data = $options{"DateTime"};
 381
 382                 # Process the setting for displaying the date and time
 383                 # using regular expressions
 384
 385                 $data =~ s/DD/$day_full/g;
 386                 $data =~ s/D/$day/g;
 387                 $data =~ s/MM/$month_full/g;
 388                 $data =~ s/M/$month/g;
 389                 $data =~ s/YY/$year/g;
 390                 $data =~ s/Y/$year_short/g;
 391
 392                 $data =~ s/hh/$hour_full/g;
 393                 $data =~ s/h/$hour/g;
 394                 $data =~ s/mm/$minute_full/g;
 395                 $data =~ s/m/$minute/g;
 396                 $data =~ s/ss/$second_full/g;
 397                 $data =~ s/s/$second/g;
 398
 399         }
 400
 401         return $data;
 402
 403 }
 404
 405 sub geterror{
 406 #################################################################################
 407 # geterror: Gets the error message (or extended error message).                 #
 408 #                                                                               #
 409 # Usage:                                                                        #
 410 #                                                                               #
 411 # $dbmodule->geterror(extended);                                                #
 412 #                                                                               #
 413 # Extended      Specifies if the extended error should be retrieved.            #
 414 #################################################################################
 415
 416         # Get the data passed to the subroutine.
 417
 418         my $class       = shift;
 419         my $extended    = shift;
 420
 421         if (!$extended){
 422                 $extended = 0;
 423         }
 424
 425         if (!$errorext){
 426                 $errorext = "";
 427         }
 428
 429         if (!$error){
 430                 $error = "";
 431         }
 432
 433         # Check to see if extended information should be returned.
 434
 435         if ($extended eq 1){
 436
 437                 # Extended information should be returned.
 438
 439                 return $errorext;
 440
 441         } else {
 442
 443                 # Basic information should be returned.
 444
 445                 return $error;
 446
 447         }
 448
 449 }
 450
 451 sub dbpermissions{
 452 #################################################################################
 453 # dbpermissions: Check if the permissions for the database are valid.           #
 454 #                                                                               #
 455 # Usage:                                                                        #
 456 #                                                                               #
 457 # $database->dbpermissions(dbname, read, write);                                #
 458 #                                                                               #
 459 # dbname        Specifies the database name to check.                           #
 460 # read          Check to see if the database can be read.                       #
 461 # write         Check to see if the database can be written.                    #
 462 #################################################################################
 463
 464         # This subroutine is not needed for this database module.
 465
 466         return 0;
 467
 468 }
 469
 470 sub dbexists{
 471 #################################################################################
 472 # dbexists: Check if the database exists.                                       #
 473 #                                                                               #
 474 # Usage:                                                                        #
 475 #                                                                               #
 476 # $dbmodule->dbexists(dbname);                                                  #
 477 #                                                                               #
 478 # dbname        Specifies the database name to check.                           #
 479 #################################################################################
 480
 481         $error = "";
 482         $errorext = "";
 483
 484         # Get the value that was passed to the subroutine.
 485
 486         my $class       = shift;
 487         my ($filename)  = @_;
 488
 489         my @table_data;
 490         my $table_exists = 0;
 491
 492         # Check if the table exists.
 493
 494         $string_handle = $database_handle->prepare('SHOW TABLES LIKE \'' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($filename) . '_database_info\'') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 495         $string_handle->execute();
 496
 497         while (@table_data = $string_handle->fetchrow_array()){
 498
 499                 $table_exists = 1;
 500
 501         }
 502
 503         # Check if the table really does exist.
 504
 505         if ($table_exists eq 1){
 506
 507                 # The table exists so return a value of 0.
 508
 509                 return 0;
 510
 511         } else {
 512
 513                 # The table does not exist so return a value of 1.
 514
 515                 return 1;
 516
 517         }
 518
 519 }
 520
 521
 522 #################################################################################
 523 # General subroutines.                                                          #
 524 #################################################################################
 525
 526 sub connect{
 527 #################################################################################
 528 # connect: Connect to the server.                                               #
 529 #                                                                               #
 530 # Usage:                                                                        #
 531 #                                                                               #
 532 # $dbmodule->connect();                                                         #
 533 #################################################################################
 534
 535         $error = "";
 536         $errorext = "";
 537
 538         # Connect to the server.
 539
 540         $database_handle = DBI->connect("DBI:mysql:database=" . $options{"Database"} . ";host=" . $options{"Server"} . ";protocol=" . $options{"Protocol"} . "port=" . $options{"Port"}, $options{"Username"}, $options{"Password"}, { "mysql_enable_utf8" => 1 }) or ( $error = "DatabaseConnectionError", $errorext = DBI->errstr, return );
 541         $database_handle->do('SET CHARACTER SET utf8');
 542         $database_handle->do('SET NAMES utf8');
 543
 544 }
 545
 546 sub disconnect{
 547 #################################################################################
 548 # connect: Disconnect from the server.                                          #
 549 #                                                                               #
 550 # Usage:                                                                        #
 551 #                                                                               #
 552 # $dbmodule->disconnect();                                                      #
 553 #################################################################################
 554
 555         # Disconnect from the server.
 556
 557         if ($string_handle){
 558
 559                 $string_handle->finish();
 560
 561         }
 562
 563         if ($database_handle){
 564
 565                 $database_handle->disconnect();
 566
 567         }
 568
 569 }
 570
 571 #################################################################################
 572 # Database Subroutines.                                                         #
 573 #################################################################################
 574
 575 sub getdblist{
 576 #################################################################################
 577 # getdblist: Gets the list of available databases.                              #
 578 #                                                                               #
 579 # Usage:                                                                        #
 580 #                                                                               #
 581 # $dbmodule->getdblist();                                                       #
 582 #################################################################################
 583
 584         $error = "";
 585         $errorext = "";
 586
 587         # Get the list of databases.
 588
 589         $string_handle = $database_handle->prepare("SHOW TABLES") or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 590         $string_handle->execute();
 591
 592         my @final_table_list;
 593         my @database_table_list;
 594         my @table_name;
 595         my $table;
 596
 597         while (@table_name = $string_handle->fetchrow_array()){
 598
 599                 push(@database_table_list, decode_utf8($table_name[0]));
 600
 601         }
 602
 603         my $table_prefix = $options{"TablePrefix"};
 604
 605         # Find all the database information tables with the correct table prefix.
 606
 607         @database_table_list = grep /^$table_prefix/ , @database_table_list;
 608         @database_table_list = grep /m*database_info$/ , @database_table_list;
 609
 610         foreach $table (@database_table_list){
 611
 612                 # Process each table name removing the table prefix name and
 613                 # the _database_info part.
 614
 615                 $table =~ s/^$table_prefix(_)//g;
 616                 $table =~ s/_database_info$//g;
 617
 618                 push (@final_table_list, $table);
 619
 620         }
 621
 622         # Return the final list of databases.
 623
 624         return @final_table_list;
 625
 626 }
 627
 628 sub selectdb{
 629 #################################################################################
 630 # selectdb: Selects the Kiriwrite database.                                     #
 631 #                                                                               #
 632 # Usage:                                                                        #
 633 #                                                                               #
 634 # $dbmodule->connect(options);                                                  #
 635 #                                                                               #
 636 # options       Specifies the following options in any order.                   #
 637 #                                                                               #
 638 # DatabaseName  Specifies the Kiriwrite database to use.                        #
 639 #################################################################################
 640
 641         # Get the database name.
 642
 643         $error = "";
 644         $errorext = "";
 645
 646         my $class = shift;
 647         my ($passedoptions) = @_;
 648
 649         my $dbname = $passedoptions->{"DatabaseName"};
 650
 651         my $database_exists = $class->dbexists($dbname);
 652
 653         if ($database_exists eq 1){
 654
 655                 # The database does not exist so return an error value
 656                 # saying that the database does not exist.
 657
 658                 $error = "DoesNotExist";
 659
 660                 return;
 661
 662         }
 663
 664         $database_filename = $dbname;
 665
 666 }
 667
 668 sub getdatabaseinfo{
 669 #################################################################################
 670 # getdatabaseinfo: Get information about the database.                          #
 671 #                                                                               #
 672 # Usage:                                                                        #
 673 #                                                                               #
 674 # $dbmodule->getdatabaseinfo();                                                 #
 675 #################################################################################
 676
 677         # Get the database information.
 678
 679         $error = "";
 680         $errorext = "";
 681
 682         my $class = shift;
 683         my ($databaseinfo, %databaseinfo);
 684         my ($sqldata, @sqldata);
 685
 686         $string_handle = $database_handle->prepare('SELECT name, description, notes, categories, kiriwrite_version_major, kiriwrite_version_minor, kiriwrite_version_revision FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_info LIMIT 1') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 687         $string_handle->execute();
 688
 689         @sqldata = $string_handle->fetchrow_array();
 690
 691         # Process the database information into a hash.
 692
 693         %databaseinfo = (
 694
 695                 "DatabaseName"  => decode_utf8($sqldata[0]),
 696                 "Description"   => decode_utf8($sqldata[1]),
 697                 "Notes"         => decode_utf8($sqldata[2]),
 698                 "Categories"    => decode_utf8($sqldata[3]),
 699                 "Major"         => decode_utf8($sqldata[4]),
 700                 "Minor"         => decode_utf8($sqldata[5]),
 701                 "Revision"      => decode_utf8($sqldata[6])
 702         );
 703
 704         $string_handle->finish();
 705
 706         return %databaseinfo;
 707
 708 }
 709
 710 sub selectseconddb{
 711 #################################################################################
 712 # selectseconddb: Selects a second Kiriwrite database for moving and copying    #
 713 # pages to.                                                                     #
 714 #                                                                               #
 715 # Usage:                                                                        #
 716 #                                                                               #
 717 # $dbmodule->selectseconddb(options);                                           #
 718 #                                                                               #
 719 # options       Specifies the following options in any order.                   #
 720 #                                                                               #
 721 # DatabaseName  Specifies the Kiriwrite database to use.                        #
 722 #################################################################################
 723
 724         # Get the database name.
 725
 726         $error = "";
 727         $errorext = "";
 728
 729         my $class = shift;
 730         my ($passedoptions) = @_;
 731         my (%database, $database);
 732
 733         my $dbname = $passedoptions->{"DatabaseName"};
 734
 735         # Check if the database exists.
 736
 737         my $database_exists = $class->dbexists($dbname);
 738
 739         if ($database_exists eq 1){
 740
 741                 # The database does not exist so return an error value
 742                 # saying that the database does not exist.
 743
 744                 $error = "DoesNotExist";
 745
 746                 return;
 747
 748         }
 749
 750         # Set the second database filename.
 751
 752         $second_database_filename = $dbname;
 753
 754 }
 755
 756 sub getseconddatabaseinfo{
 757 #################################################################################
 758 # getseconddatabaseinfo: Get information about the database that pages will be  #
 759 # moved or copied to.                                                           #
 760 #                                                                               #
 761 # Usage:                                                                        #
 762 #                                                                               #
 763 # $dbmodule->getseconddatabaseinfo();                                           #
 764 #################################################################################
 765
 766
 767         # Get the database information.
 768
 769         my $class = shift;
 770         my ($databaseinfo, %databaseinfo);
 771         my ($sqldata, @sqldata);
 772
 773         $error = "";
 774         $errorext = "";
 775
 776         $string_handle = $database_handle->prepare('SELECT name, description, notes, categories, kiriwrite_version_major, kiriwrite_version_minor, kiriwrite_version_revision FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($second_database_filename) . '_database_info LIMIT 1') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 777         $string_handle->execute();
 778
 779         @sqldata = $string_handle->fetchrow_array();
 780
 781         # Process the database information into a hash.
 782
 783         %databaseinfo = (
 784                 "DatabaseName"  => decode_utf8($sqldata[0]),
 785                 "Description"   => decode_utf8($sqldata[1]),
 786                 "Notes"         => decode_utf8($sqldata[2]),
 787                 "Categories"    => decode_utf8($sqldata[3]),
 788                 "Major"         => decode_utf8($sqldata[4]),
 789                 "Minor"         => decode_utf8($sqldata[5]),
 790                 "Revision"      => decode_utf8($sqldata[6])
 791         );
 792
 793         $string_handle->finish();
 794
 795         return %databaseinfo;
 796
 797 }
 798
 799 sub adddatabase{
 800 #################################################################################
 801 # adddatabase: Adds a Kiriwrite database.                                       #
 802 #                                                                               #
 803 # Usage:                                                                        #
 804 #                                                                               #
 805 # $dbmodule->adddatabase(options);                                              #
 806 #                                                                               #
 807 # options       Specifies the following options in any order.                   #
 808 #                                                                               #
 809 # DatabaseFilename      Specifies the database file/shortname to use.           #
 810 # DatabaseName          Specifies the database name to use.                     #
 811 # DatabaseDescription   Specifies the database description to use.              #
 812 # DatabaseNotes         Specifies the database notes to use.                    #
 813 # DatabaseCategories    Specifies the database categories to use.               #
 814 # VersionMajor          Specifies the major version.                            #
 815 # VersionMinor          Specifies the minor version.                            #
 816 # VersionRevision       Specifies the revision version.                         #
 817 #################################################################################
 818
 819         # Get the database that was passed to the subroutine.
 820
 821         $error  = "";
 822         $errorext = "";
 823
 824         my $class       = shift;
 825         my ($passedoptions) = @_;
 826
 827         my $dbfilename          = $passedoptions->{"DatabaseFilename"};
 828         my $dbname              = $passedoptions->{"DatabaseName"};
 829         my $dbdescription       = $passedoptions->{"DatabaseDescription"};
 830         my $dbnotes             = $passedoptions->{"DatabaseNotes"};
 831         my $dbcategories        = $passedoptions->{"DatabaseCategories"};
 832         my $dbmajorver          = $passedoptions->{"VersionMajor"};
 833         my $dbminorver          = $passedoptions->{"VersionMinor"};
 834         my $dbrevisionver       = $passedoptions->{"VersionRevision"};
 835
 836         # Check if the database with the filename given already exists.
 837
 838         my $database_exists     = $class->dbexists($dbfilename);
 839
 840         if ($database_exists eq 0){
 841
 842                 # The database filename exists so set the error value.
 843
 844                 $error = "DatabaseExists";
 845                 return;
 846
 847         }
 848
 849         # Create the database structure (info and page tables);
 850
 851         $string_handle  = $database_handle->prepare('CREATE TABLE ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($dbfilename) . '_database_info (
 852                         name varchar(256) primary key,
 853                         description varchar(512),
 854                         notes mediumtext,
 855                         categories varchar(512),
 856                         kiriwrite_version_major int(4),
 857                         kiriwrite_version_minor int(4),
 858                         kiriwrite_version_revision int(4)
 859         ) DEFAULT CHARSET=utf8') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 860         $string_handle->execute();
 861
 862         $string_handle  = $database_handle->prepare('CREATE TABLE ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($dbfilename) . '_database_pages (
 863                         filename varchar(256) primary key,
 864                         pagename varchar(512),
 865                         pagedescription varchar(512),
 866                         pagesection varchar(256),
 867                         pagetemplate varchar(64),
 868                         pagedata mediumtext,
 869                         pagesettings int(1),
 870                         lastmodified datetime
 871         ) DEFAULT CHARSET=utf8') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 872         $string_handle->execute();
 873
 874         # Convert the values into SQL query formatted values and add an entry
 875         # to the kiriwrite_database_info table.
 876
 877         $string_handle = $database_handle->prepare('INSERT INTO ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($dbfilename) . '_database_info (name, description, notes, categories, kiriwrite_version_major, kiriwrite_version_minor, kiriwrite_version_revision) VALUES(
 878                 \'' . $class->convert($dbname) . '\',
 879                 \'' . $class->convert($dbdescription) . '\',
 880                 \'' . $class->convert($dbnotes) . '\',
 881                 \'' . $class->convert($dbcategories) . '\',
 882                 \'' . $class->convert($dbmajorver) . '\',
 883                 \'' . $class->convert($dbminorver) . '\',
 884                 \'' . $class->convert($dbrevisionver) . '\'
 885         )') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 886         $string_handle->execute();
 887
 888 }
 889
 890 sub editdatabase{
 891 #################################################################################
 892 # editdatabase: Edits a Kiriwrite Database.                                     #
 893 #                                                                               #
 894 # Usage:                                                                        #
 895 #                                                                               #
 896 # $dbmodule->editdatabase(options);                                             #
 897 #                                                                               #
 898 # options               Specifies the following options in any order.           #
 899 #                                                                               #
 900 # NewDatabaseFilename   Specifies the new database filename to use.             #
 901 # DatabaseName          Specifies the new database name.                        #
 902 # DatabaseDescription   Specifies the new database description.                 #
 903 # DatabaseNotes         Specifies the new database notes.                       #
 904 # DatabaseCategories    Specifies the new database categories.                  #
 905 #################################################################################
 906
 907         $error          = "";
 908         $errorext       = "";
 909
 910         my $class       = shift;
 911         my ($passedoptions) = @_;
 912
 913         my $dbnewfilename       = $passedoptions->{"DatabaseNewFilename"};
 914         my $dbname              = $passedoptions->{"DatabaseName"};
 915         my $dbdescription       = $passedoptions->{"DatabaseDescription"};
 916         my $dbnotes             = $passedoptions->{"DatabaseNotes"};
 917         my $dbcategories        = $passedoptions->{"DatabaseCategories"};
 918
 919         # Check if a new database filename has been specified and if a
 920         # new database filename has been specified then change the
 921         # database filename.
 922
 923         if ($database_filename ne $dbnewfilename){
 924
 925                 # Check if a table with the filename already exists before using the
 926                 # new filename.
 927
 928                 my $database_newexists          = $class->dbexists($dbnewfilename);
 929
 930                 if ($database_newexists eq 0){
 931
 932                         # The database filename exists so set the error value.
 933
 934                         $error = "DatabaseExists";
 935                         return;
 936
 937                 }
 938
 939                 # Rename the tables.
 940
 941                 $string_handle = $database_handle->prepare('RENAME TABLE ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_info TO ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($dbnewfilename) . '_database_info, ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages TO ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($dbnewfilename) . '_database_pages');
 942                 $string_handle->execute();
 943
 944         }
 945
 946         # Get the current database information.
 947
 948         $string_handle = $database_handle->prepare('SELECT name FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($dbnewfilename) . '_database_info LIMIT 1') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 949         $string_handle->execute();
 950
 951         my @database_oldinfo    = $string_handle->fetchrow_array();
 952
 953         my $dboldname           = decode_utf8($database_oldinfo[0]);
 954
 955         # Update the database information.
 956
 957         $string_handle = $database_handle->prepare('UPDATE ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($dbnewfilename) . '_database_info SET name = \'' . $class->convert($dbname) . '\',
 958         description = \'' . $class->convert($dbdescription) . '\',
 959         notes = \'' . $class->convert($dbnotes) . '\',
 960         categories = \'' . $class->convert($dbcategories) . '\'') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
 961         $string_handle->execute();
 962
 963 }
 964
 965 sub deletedatabase{
 966 #################################################################################
 967 # deletedatabase: Deletes a Kiriwrite database.                                 #
 968 #                                                                               #
 969 # Usage:                                                                        #
 970 #                                                                               #
 971 # $dbmodule->deletedatabase(options);                                           #
 972 #                                                                               #
 973 # options       Specifies the following options in any order.                   #
 974 #                                                                               #
 975 # DatabaseName  Specifies the Kiriwrite database to delete.                     #
 976 #################################################################################
 977
 978         $error          = "";
 979         $errorext       = "";
 980
 981         # Get the database filename.
 982
 983         my $class               = shift;
 984         my ($passedoptions)     = shift;
 985
 986         my $databasename        = $passedoptions->{"DatabaseName"};
 987
 988         my @table_data;
 989         my $table_exists;
 990
 991         # Check if the database with the filename given already exists.
 992
 993         my $database_exists     = $class->dbexists($databasename);
 994
 995         if ($database_exists eq 1){
 996
 997                 # The database does not exist so set the error value.
 998
 999                 $error = "DoesNotExist";
1000                 return;
1001
1002         }
1003
1004
1005
1006         # Delete the database tables.
1007
1008         $string_handle = $database_handle->prepare('DROP TABLE ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($databasename) . '_database_info')  or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1009         $string_handle->execute();
1010
1011         # Check if the _database_pages table exists and delete it if it exists.
1012
1013         $string_handle = $database_handle->prepare('SHOW TABLES LIKE \'' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($databasename) . '_database_pages\'')  or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1014         $string_handle->execute();
1015
1016         while (@table_data = $string_handle->fetchrow_array()){
1017
1018                 $table_exists = 1;
1019
1020         }
1021
1022         # Check if the _database_pages table really does exist.
1023
1024         if ($table_exists eq 1){
1025
1026                 # the _database_pages table really does exist so delete it.
1027
1028                 $string_handle = $database_handle->prepare('DROP TABLE ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($databasename) . '_database_pages')  or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1029                 $string_handle->execute();
1030
1031         }
1032
1033 }
1034
1035 #################################################################################
1036 # Template subroutines.                                                         #
1037 #################################################################################
1038
1039 sub connecttemplate{
1040 #################################################################################
1041 # connecttemplate: Connect to the template database.                            #
1042 #                                                                               #
1043 # Usage:                                                                        #
1044 #                                                                               #
1045 # $dbmodule->connecttemplate(missingignore);                                    #
1046 #                                                                               #
1047 # missingignore Ignore errror about database being missing.                     #
1048 #################################################################################
1049
1050         $error = "";
1051         $errorext = "";
1052
1053         my $class = shift;
1054         my $ignoremissing = shift;
1055         my $templatedb_exists = 0;
1056         my @templatedb_check;
1057
1058         # Check if the template database exists.
1059
1060         $string_handle = $database_handle->prepare('SHOW TABLES LIKE \'' . $class->convert($options{"TablePrefix"}) . '_templates\'') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1061         $string_handle->execute();
1062
1063         while (@templatedb_check = $string_handle->fetchrow_array()){
1064
1065                 $templatedb_exists = 1;
1066
1067         }
1068
1069         if (!$templatedb_exists){
1070
1071                 if (!$ignoremissing){
1072
1073                         $error = "TemplateDatabaseDoesNotExist";
1074                         return;
1075
1076                 }
1077
1078         }
1079
1080 }
1081
1082 sub disconnecttemplate{
1083 #################################################################################
1084 # disconnecttemplate: Disconnect from the template database.                    #
1085 #                                                                               #
1086 # Usage:                                                                        #
1087 #                                                                               #
1088 # $dbmodule->disconnecttemplate();                                              #
1089 #################################################################################
1090
1091         # This subroutine is not used.
1092
1093 }
1094
1095 sub gettemplatelist{
1096 #################################################################################
1097 # gettemplatelist: Gets the list of templates.                                  #
1098 #                                                                               #
1099 # Usage:                                                                        #
1100 #                                                                               #
1101 # $dbmodule->gettemplatelist();                                                 #
1102 #################################################################################
1103
1104         my $error = "";
1105         my $errorext = "";
1106
1107         my $class = shift;
1108
1109         $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_templates ORDER BY filename ASC') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1110         $string_handle->execute();
1111
1112         my @database_template;
1113         my @templates_list;
1114         my $template_filename;
1115
1116         while (@database_template = $string_handle->fetchrow_array()){
1117
1118                 # Get certain values from the array.
1119
1120                 $template_filename      = decode_utf8($database_template[0]);
1121
1122                 # Add the template to the list of templates.
1123
1124                 push(@templates_list, $template_filename);
1125
1126         }
1127
1128         return @templates_list;
1129
1130 }
1131
1132 sub gettemplateinfo{
1133 #################################################################################
1134 # gettemplateinfo: Get information on a template.                               #
1135 #                                                                               #
1136 # Usage:                                                                        #
1137 #                                                                               #
1138 # $dbmodule->gettemplateinfo(options);                                          #
1139 #                                                                               #
1140 # options       Specifies the following options in any order.                   #
1141 #                                                                               #
1142 # TemplateFilename      Specifies the template filename to use.                 #
1143 #################################################################################
1144
1145         $error = "";
1146         $errorext = "";
1147
1148         # Get the data passed to the subroutine.
1149
1150         my $class = shift;
1151         my ($passedoptions) = @_;
1152
1153         my %page_info;
1154         my @template_data;
1155
1156         my $template_filename;
1157         my $template_name;
1158         my $template_description;
1159         my $template_datemodified;
1160         my $template_layout;
1161
1162         my $template_found = 0;
1163
1164         my $filename    = $passedoptions->{"TemplateFilename"};
1165
1166         $string_handle = $database_handle->prepare('SELECT filename, templatename, templatedescription, templatelayout, datemodified FROM ' . $class->convert($options{"TablePrefix"}) . '_templates WHERE filename = \'' . $class->convert($filename) . '\'') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1167         $string_handle->execute();
1168
1169         while (@template_data = $string_handle->fetchrow_array()){
1170
1171                 # Get certain values from the array.
1172
1173                 $template_filename      = decode_utf8($template_data[0]);
1174                 $template_name          = decode_utf8($template_data[1]);
1175                 $template_description   = decode_utf8($template_data[2]);
1176                 $template_layout        = decode_utf8($template_data[3]);
1177                 $template_datemodified  = decode_utf8($template_data[4]);
1178
1179                 # Process them into the hash.
1180
1181                 %page_info = (
1182                         "TemplateFilename" => $template_filename,
1183                         "TemplateName" => $template_name,
1184                         "TemplateDescription" => $template_description,
1185                         "TemplateLayout" => $template_layout,
1186                         "TemplateLastModified" => $template_datemodified
1187                 );
1188
1189                 $template_found = 1;
1190
1191         }
1192
1193         if ($template_found eq 0){
1194
1195                 # The template was not found in the template database so
1196                 # write an error value.
1197
1198                 $error = "TemplateDoesNotExist";
1199                 return;
1200
1201         }
1202
1203         return %page_info;
1204
1205 }
1206
1207
1208 sub addtemplate{
1209 #################################################################################
1210 # addtemplate: Adds a template to the template database.                        #
1211 #                                                                               #
1212 # Usage:                                                                        #
1213 #                                                                               #
1214 # $dbmodule->addtemplate(options);                                              #
1215 #                                                                               #
1216 # options       Specifies the following options in any order.                   #
1217 #                                                                               #
1218 # TemplateFilename      Specifies the new template filename.                    #
1219 # TemplateName          Specifies the new template name.                        #
1220 # TemplateDescription   Specifies the new template description.                 #
1221 # TemplateLayout        Specifies the new template layout.                      #
1222 #################################################################################
1223
1224         $error = "";
1225         $errorext = "";
1226
1227         # Get the data passed to the subroutine.
1228
1229         my $class = shift;
1230         my ($passedoptions) = @_;
1231
1232         my @page_exists;
1233         my @templatedb_check;
1234         my $templatedb_exists;
1235         my $blankfile = 0;
1236
1237         my $template_filename           = $passedoptions->{"TemplateFilename"};
1238         my $template_name               = $passedoptions->{"TemplateName"};
1239         my $template_description        = $passedoptions->{"TemplateDescription"};
1240         my $template_layout             = $passedoptions->{"TemplateLayout"};
1241
1242         # Check if the template database exists.
1243
1244         $string_handle = $database_handle->prepare('SHOW TABLES LIKE \'' . $class->convert($options{"TablePrefix"}) . '_templates\'') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1245         $string_handle->execute();
1246
1247         while (@templatedb_check = $string_handle->fetchrow_array()){
1248
1249                 $templatedb_exists = 1;
1250
1251         }
1252
1253         # Check if the template database table exists and if it doesn't
1254         # then create the template database table.
1255
1256         if (!$templatedb_exists){
1257
1258                 $string_handle = $database_handle->prepare('CREATE TABLE ' . $class->convert($options{"TablePrefix"}) . '_templates (
1259                         filename varchar(256) primary key,
1260                         templatename varchar(512),
1261                         templatedescription varchar(512),
1262                         templatelayout mediumtext,
1263                         datemodified datetime
1264                 ) DEFAULT CHARSET=utf8') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1265                 $string_handle->execute();
1266
1267         }
1268
1269         # Check if the template already exists before adding.
1270
1271         if (!$templatedb_exists){
1272
1273                 $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_templates WHERE filename = \'' . $class->convert($template_filename) . '\' LIMIT 1') or ($blankfile = 1);
1274
1275                 if ($blankfile eq 0){
1276
1277                         $string_handle->execute();
1278
1279                         while (@page_exists = $string_handle->fetchrow_array()){
1280
1281                                 $error = "TemplatePageExists";
1282                                 return;
1283
1284                         }
1285
1286                 }
1287
1288         }
1289
1290         # Get the current date.
1291
1292         my ($created_second, $created_minute, $created_hour, $created_day, $created_month, $created_year, $created_weekday, $created_yearday, $created_dst) = localtime;
1293
1294         my $template_date = $created_year . '-' . $created_month . '-' . $created_day . ' ' . $created_hour . ':' . $created_minute . ':' . $created_second;
1295
1296         # Check if certain values are undefined and if they
1297         # are then set them blank.
1298
1299         if (!$template_name){
1300
1301                 $template_name = "";
1302
1303         }
1304
1305         if (!$template_description){
1306
1307                 $template_description = "";
1308
1309         }
1310
1311         if (!$template_layout){
1312
1313                 $template_layout = "";
1314
1315         }
1316
1317         $string_handle = $database_handle->prepare('INSERT INTO ' . $class->convert($options{"TablePrefix"}) . '_templates (filename, templatename, templatedescription, templatelayout, datemodified) VALUES(
1318                         \'' . $class->convert($template_filename) . '\',
1319                         \'' . $class->convert($template_name) . '\',
1320                         \'' . $class->convert($template_description) . '\',
1321                         \'' . $class->convert($template_layout) . '\',
1322                         \'' . $class->convert($template_date) . '\'
1323         )') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1324         $string_handle->execute();
1325
1326 }
1327
1328 sub edittemplate{
1329 #################################################################################
1330 # editttemplate: Edits a Kiriwrite template.                                    #
1331 #                                                                               #
1332 # Usage:                                                                        #
1333 #                                                                               #
1334 # $dbmodule->edittemplate(options);                                             #
1335 #                                                                               #
1336 # options       Specifies the following options in any order.                   #
1337 #                                                                               #
1338 # TemplateFilename              Specifies the template filename to edit.        #
1339 # NewTemplateFilename           Specifies the new template filename.            #
1340 # NewTemplateName               Specifies the new template name.                #
1341 # NewTemplateDescription        Specifies the new template description.         #
1342 # NewTemplateLayout             Specifies the new template layout.              #
1343 #################################################################################
1344
1345         # Get the values passed.
1346
1347         my $class = shift;
1348         my ($passedoptions) = @_;
1349         my $template_found = 0;
1350         my @template_info;
1351
1352         # Process the values passed.
1353
1354         my $template_filename           = $passedoptions->{"TemplateFilename"};
1355         my $new_template_filename       = $passedoptions->{"NewTemplateFilename"};
1356         my $new_template_name           = $passedoptions->{"NewTemplateName"};
1357         my $new_template_description    = $passedoptions->{"NewTemplateDescription"};
1358         my $new_template_layout         = $passedoptions->{"NewTemplateLayout"};
1359
1360         # Check if the template exists.
1361
1362         $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_templates WHERE filename = \'' . $class->convert($template_filename) . '\' LIMIT 1') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1363         $string_handle->execute();
1364
1365         while (@template_info = $string_handle->fetchrow_array()){
1366
1367                 $template_found = 1;
1368
1369         }
1370
1371         # Check to see if the template was found and set an error value if
1372         # it wasn't.
1373
1374         if ($template_found eq 0){
1375
1376                 $error = "TemplateDoesNotExist";
1377                 return;
1378
1379         }
1380
1381         # Get the date and time.
1382
1383         my ($created_second, $created_minute, $created_hour, $created_day, $created_month, $created_year, $created_weekday, $created_yearday, $created_dst) = localtime;
1384         my $templatenewdate = $created_year . '-' . $created_month . '-' . $created_day . ' ' . $created_hour . ':' . $created_minute . ':' . $created_second;
1385
1386         # Update the template information.
1387
1388         $string_handle = $database_handle->prepare('UPDATE ' . $class->convert($options{"TablePrefix"}) . '_templates SET
1389                 filename = \'' . $class->convert($new_template_filename) . '\',
1390                 templatename = \'' . $class->convert($new_template_name) . '\',
1391                 templatedescription = \'' . $class->convert($new_template_description) . '\',
1392                 templatelayout = \'' . $class->convert($new_template_layout) . '\',
1393                 datemodified = \'' . $class->convert($templatenewdate) . '\'
1394                 WHERE filename = \'' . $class->convert($template_filename) . '\'
1395         ') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1396         $string_handle->execute();
1397
1398 }
1399
1400 sub deletetemplate{
1401 #################################################################################
1402 # deletetemplate: Deletes a template from the template database.                #
1403 #                                                                               #
1404 # Usage:                                                                        #
1405 #                                                                               #
1406 # $dbmodule->deletetemplate(options);                                           #
1407 #                                                                               #
1408 # options       Specifies the following options in any order.                   #
1409 #                                                                               #
1410 # TemplateFilename      Specifies the template filename to delete.              #
1411 #################################################################################
1412
1413         $error = "";
1414         $errorext = "";
1415
1416         # Get the data passed to the subroutine.
1417
1418         my $class = shift;
1419         my ($passedoptions) = @_;
1420
1421         my @pagedata;
1422         my $template_filename = $passedoptions->{"TemplateFilename"};
1423         my $template_count = 0;
1424
1425         # Check if the template exists.
1426
1427         $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_templates WHERE filename = \'' . $class->convert($template_filename) . '\' LIMIT 1') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1428         $string_handle->execute();
1429
1430         while (@pagedata = $string_handle->fetchrow_array()){
1431
1432                 $template_count++;
1433
1434         }
1435
1436         if ($template_count eq 0){
1437
1438                 # No pages were returned so return an error value.
1439
1440                 $error = "TemplateDoesNotExist";
1441                 return;
1442
1443         }
1444
1445         # Delete the template from the template database.
1446
1447         $string_handle = $database_handle->prepare('DELETE FROM ' . $class->convert($options{"TablePrefix"}) . '_templates WHERE filename = \'' . $class->convert($template_filename) . '\'') or ( $error = "TemplateDatabaseError", $errorext = $database_handle->errstr, return );
1448         $string_handle->execute();
1449
1450 }
1451
1452 #################################################################################
1453 # Page subroutines.                                                             #
1454 #################################################################################
1455
1456 sub getpagelist{
1457 #################################################################################
1458 # getpagelist: Gets the list of pages from the database.                        #
1459 #                                                                               #
1460 # Usage:                                                                        #
1461 #                                                                               #
1462 # $dbmodule->getpagelist();                                                     #
1463 #################################################################################
1464
1465         $error = "";
1466         $errorext = "";
1467
1468         my $class       = shift;
1469
1470         $string_handle  = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1471         $string_handle->execute();
1472
1473         my @database_pagefilenames;
1474         my @database_pagefilenames_final;
1475
1476         # Process the collected pages.
1477
1478         while (@database_pagefilenames = $string_handle->fetchrow_array){
1479
1480                 # Add each page to the list of pages in the database.
1481
1482                 push(@database_pagefilenames_final, decode_utf8($database_pagefilenames[0]));
1483
1484         }
1485
1486         return @database_pagefilenames_final;
1487
1488 }
1489
1490 sub getpageinfo{
1491 #################################################################################
1492 # getpageinfo: Gets the page information from the filename passed.              #
1493 #                                                                               #
1494 # Usage:                                                                        #
1495 #                                                                               #
1496 # $dbmodule->getpageinfo(options);                                              #
1497 #                                                                               #
1498 # options       Specifies the following options in any order.                   #
1499 #                                                                               #
1500 # PageFilename  Specifies the page filename to get the page information from.   #
1501 #################################################################################
1502
1503         $error = "";
1504         $errorext = "";
1505
1506         my $class               = shift;
1507         my ($passedoptions)     = shift;
1508         my (%database_page, $database_page);
1509         my ($pagefilename, $pagename, $pagedescription, $pagesection, $pagetemplate, $pagedata, $pagesettings, $pagelastmodified);
1510
1511         my @data_page;
1512         my $page_found = 0;
1513
1514         # Get the page from the database.
1515
1516         my $page_filename       = $passedoptions->{"PageFilename"};
1517
1518         $string_handle  = $database_handle->prepare('SELECT filename, pagename, pagedescription, pagesection, pagetemplate, pagedata, pagesettings, lastmodified FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\' LIMIT 1') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1519         $string_handle->execute();
1520
1521         # Check if the page exists in the database.
1522
1523         while (@data_page = $string_handle->fetchrow_array()){
1524
1525                 # Get the values from the array.
1526
1527                 $pagefilename           = decode_utf8($data_page[0]);
1528                 $pagename               = decode_utf8($data_page[1]);
1529                 $pagedescription        = decode_utf8($data_page[2]);
1530                 $pagesection            = decode_utf8($data_page[3]);
1531                 $pagetemplate           = decode_utf8($data_page[4]);
1532                 $pagedata               = decode_utf8($data_page[5]);
1533                 $pagesettings           = decode_utf8($data_page[6]);
1534                 $pagelastmodified       = decode_utf8($data_page[7]);
1535
1536                 # Put the values into the page hash.
1537
1538                 %database_page = (
1539                         "PageFilename"          => $pagefilename,
1540                         "PageName"              => $pagename,
1541                         "PageDescription"       => $pagedescription,
1542                         "PageSection"           => $pagesection,
1543                         "PageTemplate"          => $pagetemplate,
1544                         "PageContent"           => $pagedata,
1545                         "PageSettings"          => $pagesettings,
1546                         "PageLastModified"      => $class->dateconvert($pagelastmodified),
1547                 );
1548
1549                 $page_found = 1;
1550
1551         }
1552
1553         # Check if the page did exist.
1554
1555         if (!$page_found){
1556
1557                 $error = "PageDoesNotExist";
1558                 return;
1559
1560         }
1561
1562         return %database_page;
1563
1564 }
1565
1566
1567 sub addpage{
1568 #################################################################################
1569 # addpage: Add a page to the selected database.                                 #
1570 #                                                                               #
1571 # Usage:                                                                        #
1572 #                                                                               #
1573 # $dbmodule->addpage(options);                                                  #
1574 #                                                                               #
1575 # options       Specifies the following options in any order.                   #
1576 #                                                                               #
1577 # PageFilename          Specifies the page filename to use.                     #
1578 # PageName              Specifies the page name to use.                         #
1579 # PageDescription       Specifies the page description to use.                  #
1580 # PageSection           Specifies the page section to use.                      #
1581 # PageTemplate          Specifies the page template to use.                     #
1582 # PageContent           Specifies the page content to use.                      #
1583 # PageSettings          Specifies the page settings to use.                     #
1584 #################################################################################
1585
1586         # Get the data that was passed to the subroutine.
1587
1588         $error = "";
1589         $errorext = "";
1590
1591         my $class               = shift;
1592         my ($passedoptions)     = shift;
1593
1594         my @database_page;
1595         my $page_count = 0;
1596
1597         # Get the values passed to the hash.
1598
1599         my $page_filename       = $passedoptions->{"PageFilename"};
1600         my $page_name           = $passedoptions->{"PageName"};
1601         my $page_description    = $passedoptions->{"PageDescription"};
1602         my $page_section        = $passedoptions->{"PageSection"};
1603         my $page_template       = $passedoptions->{"PageTemplate"};
1604         my $page_content        = $passedoptions->{"PageContent"};
1605         my $page_settings       = $passedoptions->{"PageSettings"};
1606
1607         # Check to see if the filename given already exists
1608         # in the page database.
1609
1610         $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\' LIMIT 1') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1611         $string_handle->execute();
1612
1613         # Check if a page with the filename given really does
1614         # exist.
1615
1616         while (@database_page = $string_handle->fetchrow_array()){
1617
1618                 # A page does exist so increment the count to 1.
1619
1620                 $page_count++;
1621
1622         }
1623
1624         if ($page_count ne 0){
1625
1626                 # The page does exist so set the error value.
1627
1628                 $error = "PageExists";
1629                 return;
1630
1631         }
1632
1633         # Check if certain values are undefined.
1634
1635         if (!$page_name){
1636
1637                 $page_name = "";
1638
1639         }
1640
1641         if (!$page_description){
1642
1643                 $page_description = "";
1644
1645         }
1646
1647         if (!$page_section){
1648
1649                 $page_section = "";
1650
1651         }
1652
1653         if (!$page_content){
1654
1655                 $page_content = "";
1656
1657         }
1658
1659         my ($created_second, $created_minute, $created_hour, $created_day, $created_month, $created_year, $created_weekday, $created_yearday, $created_dst) = localtime;
1660         my $page_date = $created_year . '-' . $created_month . '-' . $created_day . ' ' . $created_hour . ':' . $created_minute . ':' . $created_second;
1661
1662         # Add the page to the selected database.
1663
1664         $string_handle = $database_handle->prepare('INSERT INTO ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages (filename, pagename, pagedescription, pagesection, pagetemplate, pagedata, pagesettings, lastmodified) VALUES (
1665                 \'' . $class->convert($page_filename) . '\',
1666                 \'' . $class->convert($page_name) . '\',
1667                 \'' . $class->convert($page_description) . '\',
1668                 \'' . $class->convert($page_section) . '\',
1669                 \'' . $class->convert($page_template) . '\',
1670                 \'' . $class->convert($page_content) . '\',
1671                 \'' . $class->convert($page_settings) . '\',
1672                 \'' . $class->convert($page_date) . '\'
1673         )') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1674         $string_handle->execute();
1675
1676 }
1677
1678 sub deletepage{
1679 #################################################################################
1680 # deletepage: Delete a page from the selected database.                         #
1681 #                                                                               #
1682 # Usage:                                                                        #
1683 #                                                                               #
1684 # $dbmodule->deletepage(options)                                                #
1685 #                                                                               #
1686 # options       Specifies the following options in any order.                   #
1687 #                                                                               #
1688 # PageFilename  Specifies the page filename to delete.                          #
1689 #################################################################################
1690
1691         $error = "";
1692         $errorext = "";
1693
1694         # Get the data that was passed to the subroutine.
1695
1696         my $class = shift;
1697         my ($passedoptions) = @_;
1698         my @page_info;
1699         my $page_found = 0;
1700
1701         # Get the page filename.
1702
1703         my $page_filename = $passedoptions->{"PageFilename"};
1704
1705         # Check if the page exists before deleting it.
1706
1707         $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\' LIMIT 1') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1708         $string_handle->execute();
1709
1710         while (@page_info = $string_handle->fetchrow_array()){
1711
1712                 $page_found = 1;
1713
1714         }
1715
1716         # Check if the page really does exist.
1717
1718         if (!$page_found){
1719
1720                 $error = "PageDoesNotExist";
1721                 return;
1722
1723         }
1724
1725         # Delete the page.
1726
1727         $string_handle = $database_handle->prepare('DELETE FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\'') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1728         $string_handle->execute();
1729
1730 }
1731
1732 sub editpage{
1733 #################################################################################
1734 # editpage: Edit a page from the selected database.                             #
1735 #                                                                               #
1736 # Usage:                                                                        #
1737 #                                                                               #
1738 # $dbmodule->editpage(options);                                                 #
1739 #                                                                               #
1740 # options       Specifies the following options in any order.                   #
1741 #                                                                               #
1742 # PageFilename          Specifies the filename to edit.                         #
1743 # PageNewFilename       Specifies the new filename to use.                      #
1744 # PageNewName           Specifies the new page name to use.                     #
1745 # PageNewDescription    Specifies the new page description to use.              #
1746 # PageNewSection        Specifies the new page section to use.                  #
1747 # PageNewTemplate       Specifies the new page template to use.                 #
1748 # PageNewContent        Specifies the new page content to use.                  #
1749 # PageNewSettings       Specifies the new page settings to use.                 #
1750 #################################################################################
1751
1752         $error = "";
1753         $errorext = "";
1754
1755         # Get the values passed to the subroutine.
1756
1757         my $class = shift;
1758         my ($passedoptions) = @_;
1759         my $page_found = 0;
1760         my @page_info;
1761
1762         # Get the data that was passed to the subroutine.
1763
1764         my $page_filename       = $passedoptions->{"PageFilename"};
1765         my $page_newfilename    = $passedoptions->{"PageNewFilename"};
1766         my $page_newname        = $passedoptions->{"PageNewName"};
1767         my $page_newdescription = $passedoptions->{"PageNewDescription"};
1768         my $page_newsection     = $passedoptions->{"PageNewSection"};
1769         my $page_newtemplate    = $passedoptions->{"PageNewTemplate"};
1770         my $page_newcontent     = $passedoptions->{"PageNewContent"};
1771         my $page_newsettings    = $passedoptions->{"PageNewSettings"};
1772
1773         # Check if the page with the filename given exists.
1774
1775         $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\' LIMIT 1') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1776         $string_handle->execute();
1777
1778         # Check if the page really does exist.
1779
1780         while (@page_info = $string_handle->fetchrow_array()){
1781
1782                 # The page information is found.
1783
1784                 $page_found = 1;
1785
1786         }
1787
1788         # Check if the page really does exist.
1789
1790         if (!$page_found){
1791
1792                 $error = "PageDoesNotExist";
1793                 return;
1794
1795         }
1796
1797         # Check if there is a page that already exists with the new
1798         # filename.
1799
1800         if ($page_filename ne $page_newfilename){
1801
1802                 $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_newfilename) . '\' LIMIT 1') or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1803                 $string_handle->execute();
1804
1805                 # Check if a page really is using the new filename.
1806
1807                 while (@page_info = $string_handle->fetchrow_array()){
1808
1809                         # The page information is found.
1810
1811                         $page_found = 1;
1812
1813                 }
1814
1815                 if ($page_found eq 1){
1816
1817                         $error = "PageAlreadyExists";
1818                         return;
1819
1820                 }
1821
1822         }
1823
1824         # Get the current date.
1825
1826         my ($created_second, $created_minute, $created_hour, $created_day, $created_month, $created_year, $created_weekday, $created_yearday, $created_dst) = localtime;
1827         my $page_date = $created_year . '-' . $created_month . '-' . $created_day . ' ' . $created_hour . ':' . $created_minute . ':' . $created_second;
1828
1829         # Edit the selected page.
1830
1831         $string_handle = $database_handle->prepare('UPDATE ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages SET filename = \'' . $class->convert($page_newfilename) . '\', pagename = \'' . $class->convert($page_newname) . '\', pagedescription = \'' . $class->convert($page_newdescription) . '\', pagesection = \'' . $class->convert($page_newsection) . '\', pagetemplate = \'' . $class->convert($page_newtemplate) . '\', pagedata = \'' . $class->convert($page_newcontent) . '\', pagedata = \'' . $class->convert($page_newcontent) . '\', pagesettings = \'' . $class->convert($page_newsettings) . '\', lastmodified = \'' . $page_date . '\' WHERE filename = \'' . $class->convert($page_filename) . '\'')  or ( $error = "DatabaseError", $errorext = $database_handle->errstr, return );
1832         $string_handle->execute();
1833
1834 }
1835
1836 sub movepage{
1837 #################################################################################
1838 # movepage: Moves a page from the old database to the new database.             #
1839 #                                                                               #
1840 # Usage:                                                                        #
1841 #                                                                               #
1842 # $dbmodule->movepage(options);                                                 #
1843 #                                                                               #
1844 # options       Specifies the following options in any order.                   #
1845 #                                                                               #
1846 # PageFilename  Specifies the page with the filename to move.                   #
1847 #################################################################################
1848
1849         $error = "";
1850         $errorext = "";
1851
1852         # Get the values passed to the subroutine.
1853
1854         my $class = shift;
1855         my ($passedoptions) = @_;
1856
1857         my (%database_page, $database_page);
1858         my ($pagefilename, $pagename, $pagedescription, $pagesection, $pagetemplate, $pagedata, $pagesettings, $pagelastmodified);
1859         my @page_info;
1860         my $page_found = 0;
1861
1862         # Get the data that was passed to the subroutine.
1863
1864         my $page_filename = $passedoptions->{"PageFilename"};
1865
1866         # Check if the page with the filename given exists.
1867
1868         $string_handle = $database_handle->prepare('SELECT filename, pagename, pagedescription, pagesection, pagetemplate, pagedata, pagesettings, lastmodified FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\' LIMIT 1') or ( $error = "OldDatabaseError", $errorext = $database_handle->errstr, return );
1869         $string_handle->execute();
1870
1871         # Check if the page really does exist.
1872
1873         while (@page_info = $string_handle->fetchrow_array()){
1874
1875                 # Get the values from the array.
1876
1877                 $pagefilename           = decode_utf8($page_info[0]);
1878                 $pagename               = decode_utf8($page_info[1]);
1879                 $pagedescription        = decode_utf8($page_info[2]);
1880                 $pagesection            = decode_utf8($page_info[3]);
1881                 $pagetemplate           = decode_utf8($page_info[4]);
1882                 $pagedata               = decode_utf8($page_info[5]);
1883                 $pagesettings           = decode_utf8($page_info[6]);
1884                 $pagelastmodified       = decode_utf8($page_info[7]);
1885
1886                 # Put the values into the page hash.
1887
1888                 %database_page = (
1889                         "PageFilename"          => $pagefilename,
1890                         "PageName"              => $pagename,
1891                         "PageDescription"       => $pagedescription,
1892                         "PageSection"           => $pagesection,
1893                         "PageTemplate"          => $pagetemplate,
1894                         "PageContent"           => $pagedata,
1895                         "PageSettings"          => $pagesettings,
1896                         "PageLastModified"      => $pagelastmodified,
1897                 );
1898
1899                 # The page information is found.
1900
1901                 $page_found = 1;
1902
1903         }
1904
1905         # Check if the page really does exist.
1906
1907         if (!$page_found){
1908
1909                 $error = "PageDoesNotExist";
1910                 return;
1911
1912         }
1913
1914         # Check if the page with the filename given already exists in
1915         # the database the page is being moved to.
1916
1917         $page_found = 0;
1918         @page_info = ();
1919
1920         $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($second_database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\' LIMIT 1') or ( $error = "NewDatabaseError", $errorext = $database_handle->errstr, return );
1921         $string_handle->execute();
1922
1923         while (@page_info = $string_handle->fetchrow_array()){
1924
1925                 $page_found = 1;
1926
1927         }
1928
1929         # Check if the page really does exist.
1930
1931         if ($page_found){
1932
1933                 $error = "PageAlreadyExists";
1934                 return;
1935
1936         }
1937
1938         # Add the page to the new database.
1939
1940         $string_handle = $database_handle->prepare('INSERT INTO ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($second_database_filename) . '_database_pages (filename, pagename, pagedescription, pagesection, pagetemplate, pagedata, pagesettings, lastmodified) VALUES (
1941                 \'' . $class->convert($database_page{"PageFilename"}) . '\',
1942                 \'' . $class->convert($database_page{"PageName"}) . '\',
1943                 \'' . $class->convert($database_page{"PageDescription"}) . '\',
1944                 \'' . $class->convert($database_page{"PageSection"}) . '\',
1945                 \'' . $class->convert($database_page{"PageTemplate"}) . '\',
1946                 \'' . $class->convert($database_page{"PageContent"}) . '\',
1947                 \'' . $class->convert($database_page{"PageSettings"}) . '\',
1948                 \'' . $class->convert($database_page{"PageLastModified"}) . '\'
1949         )') or ( $error = "NewDatabaseError", $errorext = $database_handle->errstr, return );
1950         $string_handle->execute();
1951
1952         # Delete the page from the old database.
1953
1954         $string_handle = $database_handle->prepare('DELETE FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($database_page{"PageFilename"}) . '\'') or ( $error = "OldDatabaseError", $errorext = $database_handle->errstr, return );
1955         $string_handle->execute();
1956
1957 }
1958
1959 sub copypage{
1960 #################################################################################
1961 # copypage: Copies a page from the old database to the new database.            #
1962 #                                                                               #
1963 # Usage:                                                                        #
1964 #                                                                               #
1965 # $dbmodule->copypage(options);                                                 #
1966 #                                                                               #
1967 # options       Specifies the following options in any order.                   #
1968 #                                                                               #
1969 # PageFilename  Specifies the page with the filename to copy.                   #
1970 #################################################################################
1971
1972         $error = "";
1973         $errorext = "";
1974
1975         # Get the values passed to the subroutine.
1976
1977         my $class = shift;
1978         my ($passedoptions) = @_;
1979
1980         my (%database_page, $database_page);
1981         my ($pagefilename, $pagename, $pagedescription, $pagesection, $pagetemplate, $pagedata, $pagesettings, $pagelastmodified);
1982         my @page_info;
1983         my $page_found = 0;
1984
1985         # Get the data that was passed to the subroutine.
1986
1987         my $page_filename = $passedoptions->{"PageFilename"};
1988
1989         # Check if the page with the filename given exists.
1990
1991         $string_handle = $database_handle->prepare('SELECT filename, pagename, pagedescription, pagesection, pagetemplate, pagedata, pagesettings, lastmodified FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\' LIMIT 1') or ( $error = "OldDatabaseError", $errorext = $database_handle->errstr, return );
1992         $string_handle->execute();
1993
1994         # Check if the page really does exist.
1995
1996         while (@page_info = $string_handle->fetchrow_array()){
1997
1998                 # Get the values from the array.
1999
2000                 $pagefilename           = decode_utf8($page_info[0]);
2001                 $pagename               = decode_utf8($page_info[1]);
2002                 $pagedescription        = decode_utf8($page_info[2]);
2003                 $pagesection            = decode_utf8($page_info[3]);
2004                 $pagetemplate           = decode_utf8($page_info[4]);
2005                 $pagedata               = decode_utf8($page_info[5]);
2006                 $pagesettings           = decode_utf8($page_info[6]);
2007                 $pagelastmodified       = decode_utf8($page_info[7]);
2008
2009                 # Put the values into the page hash.
2010
2011                 %database_page = (
2012                         "PageFilename"          => $pagefilename,
2013                         "PageName"              => $pagename,
2014                         "PageDescription"       => $pagedescription,
2015                         "PageSection"           => $pagesection,
2016                         "PageTemplate"          => $pagetemplate,
2017                         "PageContent"           => $pagedata,
2018                         "PageSettings"          => $pagesettings,
2019                         "PageLastModified"      => $pagelastmodified,
2020                 );
2021
2022                 # The page information is found.
2023
2024                 $page_found = 1;
2025
2026         }
2027
2028         # Check if the page really does exist.
2029
2030         if (!$page_found){
2031
2032                 $error = "PageDoesNotExist";
2033                 return;
2034
2035         }
2036
2037         # Check if the page with the filename given already exists in
2038         # the database the page is being moved to.
2039
2040         $page_found = 0;
2041         @page_info = ();
2042
2043         $string_handle = $database_handle->prepare('SELECT filename FROM ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($second_database_filename) . '_database_pages WHERE filename = \'' . $class->convert($page_filename) . '\' LIMIT 1') or ( $error = "NewDatabaseError", $errorext = $database_handle->errstr, return );
2044         $string_handle->execute();
2045
2046         while (@page_info = $string_handle->fetchrow_array()){
2047
2048                 $page_found = 1;
2049
2050         }
2051
2052         # Check if the page really does exist.
2053
2054         if ($page_found){
2055
2056                 $error = "PageAlreadyExists";
2057                 return;
2058
2059         }
2060
2061         # Add the page to the new database.
2062
2063         $string_handle = $database_handle->prepare('INSERT INTO ' . $class->convert($options{"TablePrefix"}) . '_' . $class->convert($second_database_filename) . '_database_pages (filename, pagename, pagedescription, pagesection, pagetemplate, pagedata, pagesettings, lastmodified) VALUES (
2064                 \'' . $class->convert($database_page{"PageFilename"}) . '\',
2065                 \'' . $class->convert($database_page{"PageName"}) . '\',
2066                 \'' . $class->convert($database_page{"PageDescription"}) . '\',
2067                 \'' . $class->convert($database_page{"PageSection"}) . '\',
2068                 \'' . $class->convert($database_page{"PageTemplate"}) . '\',
2069                 \'' . $class->convert($database_page{"PageContent"}) . '\',
2070                 \'' . $class->convert($database_page{"PageSettings"}) . '\',
2071                 \'' . $class->convert($database_page{"PageLastModified"}) . '\'
2072         )') or ( $error = "NewDatabaseError", $errorext = $database_handle->errstr, return );
2073         $string_handle->execute();
2074
2075 }
2076
2077 #################################################################################
2078 # Filter subroutines.                                                           #
2079 #################################################################################
2080
2081 sub connectfilter{
2082 #################################################################################
2083 # connectfilter: Connect to the filter database.                                #
2084 #                                                                               #
2085 # Usage:                                                                        #
2086 #                                                                               #
2087 # $dbmodule->connectfilter(missingignore);                                      #
2088 #                                                                               #
2089 # missingignore Ignore error about database being missing.                      #
2090 #################################################################################
2091
2092         $error = "";
2093         $errorext = "";
2094
2095         my $class = shift;
2096         my $ignoremissing = shift;
2097         my @filterdb_check;
2098         my $filterdb_exists = 0;
2099
2100         # Check if the template database exists.
2101
2102         $string_handle = $database_handle->prepare('SHOW TABLES LIKE \'' . $class->convert($options{"TablePrefix"}) . '_filters\'') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2103         $string_handle->execute();
2104
2105         while (@filterdb_check = $string_handle->fetchrow_array()){
2106
2107                 $filterdb_exists = 1;
2108
2109         }
2110
2111         if (!$filterdb_exists){
2112
2113                 if (!$ignoremissing){
2114
2115                         $error = "FilterDatabaseDoesNotExist";
2116                         return;
2117
2118                 }
2119
2120         }
2121
2122 }
2123
2124 sub disconnectfilter{
2125 #################################################################################
2126 # disconnectfilter: Disconnect from the filter database.                        #
2127 #                                                                               #
2128 # Usage:                                                                        #
2129 #                                                                               #
2130 # $dbmodule->disconnectfilter();                                                #
2131 #################################################################################
2132
2133         # This subroutine is not used.
2134
2135 }
2136
2137 sub getfilterlist{
2138 #################################################################################
2139 # getfilterlist: Gets the list of filters in the filter database.               #
2140 #                                                                               #
2141 # Usage:                                                                        #
2142 #                                                                               #
2143 # $dbmodule->getfilterlist();                                                   #
2144 #################################################################################
2145
2146         $error = "";
2147         $errorext = "";
2148
2149         my $class = shift;
2150
2151         my @filter_list;
2152         my @filter_data;
2153
2154         # Get the list of filters available.
2155
2156         $string_handle  = $database_handle->prepare('SELECT id, priority FROM ' . $class->convert($options{"TablePrefix"}) . '_filters ORDER BY priority ASC') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2157         $string_handle->execute();
2158
2159         while (@filter_data = $string_handle->fetchrow_array()){
2160
2161                 # Add the filter to the list of available filters.
2162
2163                 push(@filter_list, decode_utf8($filter_data[0]));
2164
2165         }
2166
2167         return @filter_list;
2168
2169 }
2170
2171 sub getfilterinfo{
2172 #################################################################################
2173 # getfilterinfo: Gets information about the filter.                             #
2174 #                                                                               #
2175 # Usage:                                                                        #
2176 #                                                                               #
2177 # $dbmodule->getfilterinfo(options);                                            #
2178 #                                                                               #
2179 # options       Specifies the following options in any order.                   #
2180 #                                                                               #
2181 # FilterID      Specifies the filter ID number to get information from.         #
2182 #################################################################################
2183
2184         $error = "";
2185         $errorext = "";
2186
2187         # Get the values passed to the subroutine.
2188
2189         my $class               = shift;
2190         my ($passedoptions)     = @_;
2191
2192         my %filter_info;
2193         my $filter_exists       = 0;
2194         my @filter_data;
2195
2196         # Get the values that are in the hash.
2197
2198         my $filter_id           = $passedoptions->{"FilterID"};
2199
2200         $string_handle = $database_handle->prepare('SELECT id, priority, findsetting, replacesetting, notes FROM ' . $class->convert($options{"TablePrefix"}) . '_filters where id = \'' . $class->convert($filter_id) . '\'') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2201         $string_handle->execute();
2202
2203         # Get the filter information.
2204
2205         while (@filter_data = $string_handle->fetchrow_array()){
2206
2207                 $filter_info{"FilterID"}        = decode_utf8($filter_data[0]);
2208                 $filter_info{"FilterPriority"}  = decode_utf8($filter_data[1]);
2209                 $filter_info{"FilterFind"}      = decode_utf8($filter_data[2]);
2210                 $filter_info{"FilterReplace"}   = decode_utf8($filter_data[3]);
2211                 $filter_info{"FilterNotes"}     = decode_utf8($filter_data[4]);
2212
2213                 $filter_exists = 1;
2214
2215         }
2216
2217         # Check if the filter exists.
2218
2219         if (!$filter_exists){
2220
2221                 # The filter does not exist so return
2222                 # an error value.
2223
2224                 $error = "FilterDoesNotExist";
2225                 return;
2226
2227         }
2228
2229         # Return the filter information.
2230
2231         return %filter_info;
2232
2233 }
2234
2235 sub addfilter{
2236 #################################################################################
2237 # addfilter: Adds a filter to the filter database.                              #
2238 #                                                                               #
2239 # Usage:                                                                        #
2240 #                                                                               #
2241 # $dbmodule->addfilter(options);                                                #
2242 #                                                                               #
2243 # options       Specifies the following options in any order.                   #
2244 #                                                                               #
2245 # FindFilter    Specifies the find filter to add.                               #
2246 # ReplaceFilter Specifies the replace filter to add.                            #
2247 # Priority      Specifies the filter priority to use.                           #
2248 # Notes         Specifies the notes to use.                                     #
2249 #################################################################################
2250
2251         $error = "";
2252         $errorext = "";
2253
2254         # Get the values passed to the subroutine.
2255
2256         my $class = shift;
2257         my ($passedoptions) = @_;
2258
2259         # Define some variables for later.
2260
2261         my @database_filters;
2262         my @filterdb_check;
2263         my @filterid_list;
2264         my @filterid_check;
2265         my $nofiltertable = 0;
2266         my $filter_found = 0;
2267         my $filter_count = 0;
2268         my $filterdb_exists = 0;
2269         my $filter_id;
2270         my $new_id;
2271
2272         # Get the values from the hash.
2273
2274         my $filter_find         = $passedoptions->{"FindFilter"};
2275         my $filter_replace      = $passedoptions->{"ReplaceFilter"};
2276         my $filter_priority     = $passedoptions->{"Priority"};
2277         my $filter_notes        = $passedoptions->{"Notes"};
2278
2279         # Check if the template database exists.
2280
2281         $string_handle = $database_handle->prepare('SHOW TABLES LIKE \'' . $class->convert($options{"TablePrefix"}) . '_filters\'') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2282         $string_handle->execute();
2283
2284         while (@filterdb_check = $string_handle->fetchrow_array()){
2285
2286                 $filterdb_exists = 1;
2287
2288         }
2289
2290         # Check if certain values are undefined and if they
2291         # are then set them blank.
2292
2293         if (!$filter_find){
2294
2295                 $filter_find = "";
2296
2297         }
2298
2299         if (!$filter_replace){
2300
2301                 $filter_replace = "";
2302
2303         }
2304
2305         if (!$filter_priority){
2306
2307                 $filter_priority = 1;
2308
2309         }
2310
2311         if (!$filter_notes){
2312
2313                 $filter_notes = "";
2314
2315         }
2316
2317         # Check if there is really no filter table.
2318
2319         if (!$filterdb_exists){
2320
2321                 # Create the filter database table.
2322
2323                 $string_handle = $database_handle->prepare('CREATE TABLE ' . $class->convert($options{"TablePrefix"}) . '_filters (
2324                         id int(7) primary key,
2325                         priority int(5),
2326                         findsetting varchar(1024),
2327                         replacesetting varchar(1024),
2328                         notes text
2329                 ) DEFAULT CHARSET=utf8') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2330                 $string_handle->execute();
2331
2332         }
2333
2334         # Find the lowest filter identification number available.
2335
2336         $string_handle = $database_handle->prepare('SELECT id FROM ' . $class->convert($options{"TablePrefix"}) . '_filters ORDER BY id ASC') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2337         $string_handle->execute();
2338
2339         while (@database_filters = $string_handle->fetchrow_array()){
2340
2341                 $filter_id      = decode_utf8($database_filters[0]);
2342
2343                 # Add the filter identification to the list of filter IDs.
2344
2345                 push(@filterid_list, $filter_id);
2346
2347         }
2348
2349         $filter_id = "";
2350
2351         # Process each filter looking for a blank available filter.
2352
2353         foreach $filter_id (@filterid_list){
2354
2355                 # Check the next filter ID to see if it's blank.
2356
2357                 $new_id = $filter_id + 1;
2358
2359                 $string_handle = $database_handle->prepare('SELECT id FROM ' . $class->convert($options{"TablePrefix"}) . '_filters WHERE id = \'' . $class->convert($new_id) . '\'') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2360                 $string_handle->execute();
2361
2362                 # Get the filter identification number.
2363
2364                 while (@filterid_check = $string_handle->fetchrow_array()){
2365
2366                         $filter_found = 1;
2367
2368                 }
2369
2370                 # Check if a filter was found.
2371
2372                 if (!$filter_found){
2373
2374                         # No filter was found using this ID so exit the loop.
2375
2376                         last;
2377
2378                 }
2379
2380                 # Increment the filter count and reset the filter found value.
2381
2382                 $filter_count++;
2383                 $filter_found = 0;
2384                 $new_id = 0;
2385
2386         }
2387
2388         # Check if there were any filters in the filters database.
2389
2390         if (!$filter_count && !$new_id){
2391
2392                 # There were no filters in the filters database so set
2393                 # the new filter identification value to 1.
2394
2395                 $new_id = 1;
2396
2397         }
2398
2399         # Add the filter to the filter database.
2400
2401         $string_handle = $database_handle->prepare('INSERT INTO ' . $class->convert($options{"TablePrefix"}) . '_filters (id, priority, findsetting, replacesetting, notes) VALUES (
2402                 \'' . $class->convert($new_id) . '\',
2403                 \'' . $class->convert($filter_priority) . '\',
2404                 \'' . $class->convert($filter_find) . '\',
2405                 \'' . $class->convert($filter_replace) .'\',
2406                 \'' . $class->convert($filter_notes) . '\'
2407         )') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2408         $string_handle->execute();
2409
2410 }
2411
2412
2413 sub editfilter{
2414 #################################################################################
2415 # editfilter: Edits a filter in the filter database.                            #
2416 #                                                                               #
2417 # Usage:                                                                        #
2418 #                                                                               #
2419 # $dbmodule->editfilter(options);                                               #
2420 #                                                                               #
2421 # options       Specifies the following options in any order.                   #
2422 #                                                                               #
2423 # FilterID              Specifies the filter to edit.                           #
2424 # NewFindFilter         Specifies the new find filter setting.                  #
2425 # NewReplaceFilter      Specifies the new replace filter setting.               #
2426 # NewFilterPriority     Specifies the new filter priority setting.              #
2427 # NewFilterNotes        Specifies the new notes for the filter.                 #
2428 #################################################################################
2429
2430         $error = "";
2431         $errorext = "";
2432
2433         # Get the values passed to the subroutine.
2434
2435         my $class = shift;
2436         my ($passedoptions) = @_;
2437
2438         my @filter_data;
2439         my $filter_exists = 1;
2440         my $blankfile = 0;
2441
2442         # Get the values from the hash.
2443
2444         my $filter_id           = $passedoptions->{"FilterID"};
2445         my $filter_newfind      = $passedoptions->{"NewFindFilter"};
2446         my $filter_newreplace   = $passedoptions->{"NewReplaceFilter"};
2447         my $filter_newpriority  = $passedoptions->{"NewFilterPriority"};
2448         my $filter_newnotes     = $passedoptions->{"NewFilterNotes"};
2449
2450         # Check if the filter exists before editing it.
2451
2452         $string_handle = $database_handle->prepare('SELECT id FROM ' . $class->convert($options{"TablePrefix"}) . '_filters where id = \'' . $class->convert($filter_id) . '\'') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2453         $string_handle->execute();
2454
2455         # Check if the filter exists.
2456
2457         while (@filter_data = $string_handle->fetchrow_array()){
2458
2459                 $filter_exists = 1;
2460
2461         }
2462
2463         # Check if the filter really does exist.
2464
2465         if (!$filter_exists){
2466
2467                 # The filter does not exist so return
2468                 # an error value.
2469
2470                 $error = "FilterDoesNotExist";
2471                 return;
2472
2473         }
2474
2475         # Edit the selected filter.
2476
2477         $string_handle = $database_handle->prepare('UPDATE ' . $class->convert($options{"TablePrefix"}) . '_filters SET
2478                 findsetting = \'' . $class->convert($filter_newfind) . '\',
2479                 replacesetting = \'' . $class->convert($filter_newreplace) . '\',
2480                 priority = \'' . $class->convert($filter_newpriority) . '\',
2481                 notes = \'' . $class->convert($filter_newnotes) . '\'
2482         WHERE id = \'' . $class->convert($filter_id) . '\'') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2483         $string_handle->execute();
2484
2485         return;
2486
2487 }
2488
2489 sub deletefilter{
2490 #################################################################################
2491 # deletefilter: Deletes a filter from the filter database.                      #
2492 #                                                                               #
2493 # Usage:                                                                        #
2494 #                                                                               #
2495 # $dbmodule->deletefilter(options);                                             #
2496 #                                                                               #
2497 # options       Specifies the following options in any order.                   #
2498 #                                                                               #
2499 # FilterID      Specifies the filter to delete from the filter database.        #
2500 #################################################################################
2501
2502         $error = "";
2503         $errorext = "";
2504
2505         # Get the values passed to the subroutine.
2506
2507         my $class = shift;
2508         my ($passedoptions) = @_;
2509
2510         my $filter_exists = 0;
2511         my @filter_data;
2512
2513         # Get the values from the hash.
2514
2515         my $filter_id           = $passedoptions->{"FilterID"};
2516
2517         # Check if the filter exists before deleting.
2518
2519         $string_handle = $database_handle->prepare('SELECT id FROM ' . $class->convert($options{"TablePrefix"}) . '_filters where id = \'' . $class->convert($filter_id) . '\'') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2520         $string_handle->execute();
2521
2522         while (@filter_data = $string_handle->fetchrow_array()){
2523
2524                 $filter_exists = 1;
2525
2526         }
2527
2528         # Check to see if the filter really does exist.
2529
2530         if (!$filter_exists){
2531
2532                 $error = "FilterDoesNotExist";
2533                 return;
2534
2535         }
2536
2537         # Delete the filter from the filter database.
2538
2539         $string_handle = $database_handle->prepare('DELETE FROM ' . $class->convert($options{"TablePrefix"}) . '_filters where id = \'' . $class->convert($filter_id) . '\'') or ( $error = "FilterDatabaseError", $errorext = $database_handle->errstr, return );
2540         $string_handle->execute();
2541
2542 }
2543
2544 1;