cgi-files/lib/filter.lib

   1 #################################################################################
   2 # filter.lib: Kiriwrite Filter Library                                          #
   3 #                                                                               #
   4 # This library is under the same license as the main Kiriwrite script.          #
   5 #################################################################################
   6
   7 # This section of the file is for when the library is called from the main
   8 # Kiriwrite script.
   9
  10 if ($form_data->{'action'}){
  11
  12         # There is a value for action in the HTTP query,
  13         # so get the value from it.
  14
  15         my $http_query_action = $form_data->{'action'};
  16
  17         if ($http_query_action eq "add"){
  18
  19                 # The action the user requested is to add a filter to the
  20                 # filter database.
  21
  22                 # Check if there is a value in confirm and if there is
  23                 # then pass it on to the new find and replace words
  24                 # to add to the filter database.
  25
  26                 my $http_query_confirm = $form_data->{'confirm'};
  27
  28                 if ($http_query_confirm){
  29
  30                         # There is a value in http_query_confirm, so pass on the
  31                         # new find and replace words so that they can be added
  32                         # to the filter database.
  33
  34                         my $http_query_findwords        = $form_data->{'findword'};
  35                         my $http_query_replacewords     = $form_data->{'replaceword'};
  36                         my $http_query_priority         = $form_data->{'priority'};
  37                         my $http_query_notes            = $form_data->{'notes'};
  38
  39                         my $pagedata = kiriwrite_filter_add($http_query_findwords, $http_query_replacewords, $http_query_priority, $http_query_notes, $http_query_confirm);
  40
  41                         kiriwrite_output_header;        # Output the header to browser/console/stdout.
  42                         kiriwrite_output_page($kiriwrite_lang->{filter}->{addfilter}, $pagedata, "filter"); # Output the page to browser/console/stdout.
  43                         exit;                           # End the script.
  44
  45                 }
  46
  47                 my $pagedata = kiriwrite_filter_add();
  48
  49                 kiriwrite_output_header;        # Output the header to browser/console/stdout.
  50                 kiriwrite_output_page($kiriwrite_lang->{filter}->{addfilter}, $pagedata, "filter"); # Output the page to browser/console/stdout.
  51                 exit;                           # End the script.
  52
  53         } elsif ($http_query_action eq "edit"){
  54
  55                 # The action the user requested is to edit an filter from
  56                 # the filter database.
  57
  58                 my $http_query_number   = $form_data->{'filter'};
  59                 my $http_query_confirm  = $form_data->{'confirm'};
  60
  61                 if ($http_query_confirm){
  62
  63                         # There is a value in http_query_confirm, so pass on the
  64                         # new find and replace words so that the filter database
  65                         # can be edited.
  66
  67                         my $http_query_findwords        = $form_data->{'filterfind'};
  68                         my $http_query_replacewords     = $form_data->{'filterreplace'};
  69                         my $http_query_priority         = $form_data->{'priority'};
  70                         my $http_query_notes            = $form_data->{'notes'};
  71
  72                         my $pagedata = kiriwrite_filter_edit($http_query_number, $http_query_findwords, $http_query_replacewords, $http_query_priority, $http_query_notes, $http_query_confirm);
  73
  74                         kiriwrite_output_header;        # Output the header to browser/console/stdout.
  75                         kiriwrite_output_page($kiriwrite_lang->{filter}->{editfilter}, $pagedata, "filter");    # Output the page to browser/console/stdout.
  76                         exit;                           # End the script.
  77
  78                 }
  79
  80                 my $pagedata = kiriwrite_filter_edit($http_query_number);
  81
  82                 kiriwrite_output_header;                # Output the header to browser/console/stdout.
  83                 kiriwrite_output_page($kiriwrite_lang->{filter}->{editfilter}, $pagedata, "filter");    # Output the page to browser/console/stdout.
  84                 exit;                                   # End the script.
  85
  86         } elsif ($http_query_action eq "delete"){
  87
  88                 # The action the user requested is to delete an filter
  89                 # from the filter database.
  90
  91                 my $http_query_number = $form_data->{'filter'};
  92                 my $http_query_confirm = $form_data->{'confirm'};
  93
  94                 if ($http_query_confirm){
  95
  96                         my $pagedata = kiriwrite_filter_delete($http_query_number, $http_query_confirm);
  97
  98                         kiriwrite_output_header;                # Output the header to browser/console/stdout.
  99                         kiriwrite_output_page($kiriwrite_lang->{filter}->{deletefilter}, $pagedata, "filter"); # Output the page to browser/console/stdout.
 100                         exit;                                   # End the script
 101
 102                 }
 103
 104                 my $pagedata = kiriwrite_filter_delete($http_query_number);
 105
 106                 kiriwrite_output_header;                # Output the header to browser/console/stdout.
 107                 kiriwrite_output_page($kiriwrite_lang->{filter}->{deletefilter}, $pagedata, "filter");  # Output the page to browser/console/stdout.
 108                 exit;                                   # End the script.
 109
 110         } elsif ($http_query_action eq "view"){
 111
 112                 # The action the user requested is to view the list
 113                 # filters on the filter database.
 114
 115                 my $http_query_browsenumber = $form_data->{'browsenumber'};
 116
 117                 my $pagedata = kiriwrite_filter_list($http_query_browsenumber);
 118
 119                 kiriwrite_output_header;        # Output the header to browser/console/stdout.
 120                 kiriwrite_output_page($kiriwrite_lang->{filter}->{viewfilters}, $pagedata, "filter"); # Output the page to browser/console/stdout.
 121                 exit;                           # End the script.
 122
 123         } else {
 124
 125                 # Another action was requested that was not one of
 126                 # the ones prcedding this catch all, so return
 127                 # an error saying that an invalid option was
 128                 # specified.
 129
 130                 kiriwrite_error("invalidaction");
 131
 132         }
 133
 134 } else {
 135
 136         my $pagedata = kiriwrite_filter_list();
 137
 138         kiriwrite_output_header;        # Output the header to browser/console/stdout.
 139         kiriwrite_output_page($kiriwrite_lang->{filter}->{viewfilters}, $pagedata, "filter"); # Output the page to browser/console/stdout.
 140         exit;                           # End the script.
 141
 142 }
 143
 144 #################################################################################
 145 # Begin list of relevant subroutines.                                           #
 146 #################################################################################
 147
 148 sub kiriwrite_filter_list{
 149 #################################################################################
 150 # kiriwrite_filter_list: Lists the filters that will be used when compiling a   #
 151 # webpage.                                                                      #
 152 #                                                                               #
 153 # Usage:                                                                        #
 154 #                                                                               #
 155 # kiriwrite_filter_list([browsenumber]);                                        #
 156 #                                                                               #
 157 # browsenumber  Specifies the page browse number to use.                        #
 158 #################################################################################
 159
 160         my $filter_browsenumber = shift;
 161
 162         my $filtersdb_notexist = 0;
 163
 164         # Connect to the database server.
 165
 166         $kiriwrite_dbmodule->connect();
 167
 168         # Check if any errors occured while connecting to the database server.
 169
 170         if ($kiriwrite_dbmodule->geterror eq "DatabaseConnectionError"){
 171
 172                 # A database connection error has occured so return
 173                 # an error.
 174
 175                 kiriwrite_error("databaseconnectionerror", $kiriwrite_dbmodule->geterror(1));
 176
 177         }
 178
 179         # Connect to the filter database.
 180
 181         $kiriwrite_dbmodule->connectfilter();
 182
 183         # Check if any error has occured while connecting to the filter
 184         # database.
 185
 186         if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseDoesNotExist"){
 187
 188                 # The filter database does not exist.
 189
 190                 $filtersdb_notexist = 1;
 191
 192         } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseInvalidPermissionsSet"){
 193
 194                 # The filter database has invalid permissions set so return
 195                 # an error.
 196
 197                 kiriwrite_error("filtersdbpermissions");
 198
 199         } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
 200
 201                 # A database error has occured with the filter database.
 202
 203                 kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
 204
 205         }
 206
 207         # Define some variables required for processing the filters list.
 208
 209         my %filter_list;
 210         my %filter_info;
 211         my @database_filters;
 212         my $blankfindfilter = 0;
 213         my $filterswarning = "";
 214         my $filter;
 215         my $filter_split = 50;
 216         my $filter_list = 0;
 217         my $filter_count = 0;
 218         my $filter_style = 0;
 219         my $filter_list_count = 0;
 220         my $filter_style_name = "";
 221
 222         tie(%filter_list, 'Tie::IxHash');
 223
 224         $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{viewfilters}, { Style => "pageheader" });
 225         $kiriwrite_presmodule->addlinebreak();
 226         $kiriwrite_presmodule->addlinebreak();
 227
 228         # If the filter database exists then get the list of filters,
 229         # otherwise write a message saying that the filter database
 230         # does not exist and will be created when a filter is added.
 231
 232         if ($filtersdb_notexist eq 0){
 233
 234                 if (!$filter_browsenumber || $filter_browsenumber eq 0){
 235
 236                         $filter_browsenumber = 1;
 237
 238                 }
 239
 240                 # Check if the filter browse number is valid and if it isn't
 241                 # then return an error.
 242
 243                 my $kiriwrite_browsenumber_length_check         = kiriwrite_variablecheck($filter_browsenumber, "maxlength", 7, 1);
 244                 my $kiriwrite_browsenumber_number_check         = kiriwrite_variablecheck($filter_browsenumber, "numbers", 0, 1);
 245
 246                 if ($kiriwrite_browsenumber_length_check eq 1){
 247
 248                         # The browse number was too long so return
 249                         # an error.
 250
 251                         kiriwrite_error("browsenumbertoolong");
 252
 253                 }
 254
 255                 if ($kiriwrite_browsenumber_number_check eq 1){
 256
 257                         # The browse number wasn't a number so
 258                         # return an error.
 259
 260                         kiriwrite_error("browsenumberinvalid");
 261
 262                 }
 263
 264                 # Get the total count of filters in the filter database.
 265
 266                 my $filter_total_count  = $kiriwrite_dbmodule->getfiltercount();
 267
 268                 # Check if any errors occured while getting the count of filters.
 269
 270                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
 271
 272                         # A database error has occured with the filter database.
 273
 274                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
 275
 276                 }
 277
 278                 if ($filter_total_count ne 0){
 279
 280                         if ($filter_total_count eq $filter_split){
 281
 282                                 $filter_list = substr(($filter_total_count / $filter_split), 0, 1);
 283
 284                         } else {
 285
 286                                 $filter_list = substr(($filter_total_count / $filter_split), 0, 1) + 1;
 287
 288                         }
 289
 290                 }
 291
 292                 my $start_from = ($filter_browsenumber - 1) * $filter_split;
 293
 294                 # Get the list of available filters.
 295
 296                 @database_filters       = $kiriwrite_dbmodule->getfilterlist({ StartFrom => $start_from, Limit => $filter_split });
 297
 298                 # Check if any errors occured while getting the list of filters.
 299
 300                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
 301
 302                         # A database error has occured with the filter database.
 303
 304                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
 305
 306                 }
 307
 308                 # Process each filter getting the priority, find setting and
 309                 # replace setting.
 310
 311                 foreach $filter (@database_filters){
 312
 313                         # Get the information about the filter.
 314
 315                         %filter_info = $kiriwrite_dbmodule->getfilterinfo({ FilterID => $filter });
 316
 317                         # Check if any errors occured while getting the filter information.
 318
 319                         if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
 320
 321                                 # A database error occured while using the filter database.
 322
 323                                 kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
 324
 325                         } elsif ($kiriwrite_dbmodule->geterror eq "FilterDoesNotExist"){
 326
 327                                 # The filter does not exist so process the next filter.
 328
 329                                 next;
 330
 331                         }
 332
 333                         # Check if the find filter is blank.
 334
 335                         if (!$filter_info{"FilterFind"}){
 336
 337                                 # The find filter is blank, so set the value to write a warning
 338                                 # message saying that a find filter given is blank.
 339
 340                                 $blankfindfilter = 1;
 341
 342                         }
 343
 344                         $filter_list{$filter_count}{ID}         = $filter_info{"FilterID"};
 345                         $filter_list{$filter_count}{Priority}   = $filter_info{"FilterPriority"};
 346                         $filter_list{$filter_count}{Find}       = $filter_info{"FilterFind"};
 347                         $filter_list{$filter_count}{Replace}    = $filter_info{"FilterReplace"};
 348                         $filter_list{$filter_count}{Notes}      = $filter_info{"FilterNotes"};
 349
 350                         $filter_count++;
 351
 352                 }
 353
 354                 # Check if there are filters in the filter database and
 355                 # write a message if there isn't.
 356
 357         }
 358
 359         # Check if the database wasn't found and if it
 360         # wasn't then write a message saying that the
 361         # database will be created when a filter is
 362         # added.
 363
 364         if ($filtersdb_notexist eq 1){
 365
 366                 # The filter database doesn't exist so write
 367                 # a message.
 368
 369                 $kiriwrite_presmodule->clear();
 370                 $kiriwrite_presmodule->addtext(kiriwrite_language($kiriwrite_lang->{filter}->{viewfilters}, $db_name), { Style => "pageheader" });
 371                 $kiriwrite_presmodule->addlinebreak();
 372                 $kiriwrite_presmodule->addlinebreak();
 373                 $kiriwrite_presmodule->startbox("errorbox");
 374                 $kiriwrite_presmodule->enterdata($kiriwrite_lang->{filter}->{filterdatabasedoesnotexist});
 375                 $kiriwrite_presmodule->endbox();
 376
 377                 # Disconnect from the filter database.
 378
 379                 $kiriwrite_dbmodule->disconnectfilter();
 380
 381                 # Disconnect from the database server.
 382
 383                 $kiriwrite_dbmodule->disconnect();
 384                 return $kiriwrite_presmodule->grab();
 385
 386         }
 387
 388         # Check if there is a warning message and if
 389         # there is then write that warning message
 390         # else write the list of filters.
 391
 392         if ($filterswarning){
 393
 394                 $kiriwrite_presmodule->startbox("errorbox");
 395                 $kiriwrite_presmodule->addtext($filterswarning);
 396                 $kiriwrite_presmodule->endbox();
 397
 398         } elsif ($filter_count) {
 399
 400                 # The filter database exists so write out the
 401                 # list of filters.
 402
 403                 if ($blankfindfilter eq 1){
 404
 405                         $kiriwrite_presmodule->addboldtext($kiriwrite_lang->{filter}->{warningtitle});
 406                         $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{blankfindfilters});
 407                         $kiriwrite_presmodule->addtext();
 408                         $kiriwrite_presmodule->addlinebreak();
 409                         $kiriwrite_presmodule->addlinebreak();
 410
 411                 }
 412
 413                 # Start a form for using the filter browsing list with.
 414
 415                 $kiriwrite_presmodule->startform($kiriwrite_env{"script_filename"}, "GET");
 416                 $kiriwrite_presmodule->addhiddendata("mode", "filter");
 417
 418                 # Write out the filter browsing list.
 419
 420                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{showlistpage});
 421                 $kiriwrite_presmodule->addselectbox("browsenumber");
 422
 423                 # Write out the list of available pages to browse.
 424
 425                 while ($filter_list_count ne $filter_list){
 426
 427                         $filter_list_count++;
 428
 429                         if ($filter_list_count eq 1 && !$filter_browsenumber){
 430
 431                                 $kiriwrite_presmodule->addoption($filter_list_count, { Value => $filter_list_count, Selected => 1 });
 432
 433                         } else {
 434
 435                                 if ($filter_browsenumber eq $filter_list_count){
 436
 437                                         $kiriwrite_presmodule->addoption($filter_list_count, { Value => $filter_list_count, Selected => 1 });
 438
 439                                 } else {
 440
 441                                         $kiriwrite_presmodule->addoption($filter_list_count, { Value => $filter_list_count });
 442
 443                                 }
 444
 445                         }
 446
 447                 }
 448
 449                 $kiriwrite_presmodule->endselectbox();
 450                 $kiriwrite_presmodule->addbutton("action", { Value => "view", Description => $kiriwrite_lang->{filter}->{show} });
 451
 452                 if ($filter_list ne $filter_browsenumber){
 453
 454                         $kiriwrite_presmodule->addtext(" | ");
 455                         $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter&action=view&browsenumber=" . ($filter_browsenumber + 1), { Text => $kiriwrite_lang->{filter}->{nextpage} });
 456
 457                 }
 458
 459                 # Check if the filter browse number is not blank and
 460                 # not set as 0 and hide the Previous page link if
 461                 # it is.
 462
 463                 if ($filter_browsenumber > 1){
 464
 465                         $kiriwrite_presmodule->addtext(" | ");
 466                         $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter&action=view&browsenumber=" . ($filter_browsenumber - 1), { Text => $kiriwrite_lang->{filter}->{previouspage} });
 467
 468                 }
 469
 470                 $kiriwrite_presmodule->addlinebreak();
 471                 $kiriwrite_presmodule->addlinebreak();
 472
 473                 $kiriwrite_presmodule->starttable("", { CellPadding => 5, CellSpacing => 0 });
 474
 475                 $kiriwrite_presmodule->startheader();
 476                 $kiriwrite_presmodule->addheader($kiriwrite_lang->{filter}->{priority}, { Style => "tablecellheader" });
 477                 $kiriwrite_presmodule->addheader($kiriwrite_lang->{filter}->{findsetting}, { Style => "tablecellheader" });
 478                 $kiriwrite_presmodule->addheader($kiriwrite_lang->{filter}->{replacesetting}, { Style => "tablecellheader" });
 479                 $kiriwrite_presmodule->addheader($kiriwrite_lang->{common}->{options}, { Style => "tablecellheader" });
 480                 $kiriwrite_presmodule->endheader();
 481
 482                 foreach $filter (keys %filter_list){
 483
 484                         # Check which style should be used.
 485
 486                         if ($filter_style eq 0){
 487
 488                                 $filter_style_name = "tablecell1";
 489                                 $filter_style = 1;
 490
 491                         } else {
 492
 493                                 $filter_style_name = "tablecell2";
 494                                 $filter_style = 0;
 495
 496                         }
 497
 498                         $kiriwrite_presmodule->startrow();
 499                         $kiriwrite_presmodule->addcell($filter_style_name);
 500                         $kiriwrite_presmodule->addtext($filter_list{$filter}{Priority});
 501                         $kiriwrite_presmodule->endcell();
 502                         $kiriwrite_presmodule->addcell($filter_style_name);
 503
 504                         # Check if the find filter is blank.
 505
 506                         if (!$filter_list{$filter}{Find}){
 507
 508                                 # The find filter is blank.
 509
 510                                 $kiriwrite_presmodule->additalictext($kiriwrite_lang->{filter}->{blankfindsetting});
 511
 512                         } else {
 513
 514                                 # The find filter is not blank.
 515
 516                                 $kiriwrite_presmodule->addtext($filter_list{$filter}{Find});
 517
 518                         }
 519
 520                         $kiriwrite_presmodule->endcell();
 521                         $kiriwrite_presmodule->addcell($filter_style_name);
 522
 523                         # Check if the replace filter is blank.
 524
 525                         if (!$filter_list{$filter}{Replace}){
 526
 527                                 # The replace filter is blank.
 528
 529                                 $kiriwrite_presmodule->additalictext($kiriwrite_lang->{filter}->{blankreplacesetting});
 530
 531                         } else {
 532
 533                                 # The replace filter is not blank.
 534
 535                                 $kiriwrite_presmodule->addtext($filter_list{$filter}{Replace});
 536
 537                         }
 538
 539                         $kiriwrite_presmodule->endcell();
 540                         $kiriwrite_presmodule->addcell($filter_style_name);
 541                         $kiriwrite_presmodule->addlink("?mode=filter&action=edit&filter=" . $filter_list{$filter}{ID}, { Text => $kiriwrite_lang->{options}->{edit} });
 542                         $kiriwrite_presmodule->addlink("?mode=filter&action=delete&filter=" . $filter_list{$filter}{ID}, { Text => $kiriwrite_lang->{options}->{delete} });
 543                         $kiriwrite_presmodule->endcell();
 544                         $kiriwrite_presmodule->endrow();
 545
 546                 }
 547
 548                 $kiriwrite_presmodule->endtable();
 549                 $kiriwrite_presmodule->endform();
 550
 551         }
 552
 553         if (!@database_filters && $filter_browsenumber > 1){
 554
 555                 # There were no values given for the page browse
 556                 # number given so write a message saying that
 557                 # there were no pages for the page browse number
 558                 # given.
 559
 560                 $kiriwrite_presmodule->clear();
 561                 $kiriwrite_presmodule->addtext(kiriwrite_language($kiriwrite_lang->{filter}->{viewfilters}, $db_name), { Style => "pageheader" });
 562                 $kiriwrite_presmodule->addlinebreak();
 563                 $kiriwrite_presmodule->addlinebreak();
 564                 $kiriwrite_presmodule->startbox("errorbox");
 565                 $kiriwrite_presmodule->enterdata($kiriwrite_lang->{filter}->{nofiltersinpagebrowse});
 566                 $kiriwrite_presmodule->addlinebreak();
 567                 $kiriwrite_presmodule->addlinebreak();
 568                 $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter", { Text => $kiriwrite_lang->{filter}->{returntofirstpagebrowse} });
 569                 $kiriwrite_presmodule->endbox();
 570
 571         } elsif (!@database_filters || !$filter_count || $filter_total_count eq 0){
 572
 573                 # There are no filters in the filter database.
 574
 575                 $kiriwrite_presmodule->clear();
 576                 $kiriwrite_presmodule->addtext(kiriwrite_language($kiriwrite_lang->{filter}->{viewfilters}, $db_name), { Style => "pageheader" });
 577                 $kiriwrite_presmodule->addlinebreak();
 578                 $kiriwrite_presmodule->addlinebreak();
 579                 $kiriwrite_presmodule->startbox("errorbox");
 580                 $kiriwrite_presmodule->enterdata($kiriwrite_lang->{filter}->{nofiltersavailable});
 581                 $kiriwrite_presmodule->endbox();
 582
 583         }
 584
 585         # Disconnect from the filter database.
 586
 587         $kiriwrite_dbmodule->disconnectfilter();
 588
 589         # Disconnect from the database server.
 590
 591         $kiriwrite_dbmodule->disconnect();
 592
 593         return $kiriwrite_presmodule->grab();
 594
 595 }
 596
 597 sub kiriwrite_filter_add{
 598 #################################################################################
 599 # kiriwrite_filter_add: Adds a filter to the filter list.                       #
 600 #                                                                               #
 601 # Usage:                                                                        #
 602 #                                                                               #
 603 # kiriwrite_filter_add(filterfind, filterreplace, filterpriority,               #
 604 #                       filternotes, [confirm]);                                #
 605 #                                                                               #
 606 # filterfind            Specifies the new word(s) to find.                      #
 607 # filterreplace         Specifies the new word(s) to replace.                   #
 608 # filterpriority        Specifies the new priority to use.                      #
 609 # filternotes           Specifies the new notes to use.                         #
 610 # confirm               Confirms the action to add a filter.                    #
 611 #################################################################################
 612
 613         # Get the values that have been passed to the subroutine.
 614
 615         my ($filter_new_find, $filter_new_replace, $filter_new_priority, $filter_new_notes, $confirm) = @_;
 616
 617         # Check the confirm value to make sure it is no more than
 618         # one character long.
 619
 620         kiriwrite_variablecheck($confirm, "maxlength", 1, 0);
 621
 622         if (!$confirm){
 623
 624                 # The confirm value is undefined, so set the
 625                 # value of the confirm integer to '0'.
 626
 627                 $confirm = 0;
 628
 629         }
 630
 631         if ($confirm eq 1){
 632
 633                 # The confirm integer is '1', so add the word
 634                 # to the filter list.
 635
 636                 # First, check the variables recieved are UTF8
 637                 # copliant.
 638
 639                 kiriwrite_variablecheck($filter_new_find, "utf8", 0, 0);
 640                 kiriwrite_variablecheck($filter_new_replace, "utf8", 0, 0);
 641                 kiriwrite_variablecheck($filter_new_priority, "utf8", 0, 0);
 642                 kiriwrite_variablecheck($filter_new_notes, "utf8", 0, 0);
 643
 644                 # Convert the UTF8 values so that the length can
 645                 # checked properly.
 646
 647                 $filter_new_find        = kiriwrite_utf8convert($filter_new_find);
 648                 $filter_new_replace     = kiriwrite_utf8convert($filter_new_replace);
 649                 $filter_new_priority    = kiriwrite_utf8convert($filter_new_priority);
 650                 $filter_new_notes       = kiriwrite_utf8convert($filter_new_notes);
 651
 652                 # Check if the find filter is blank and return an error
 653                 # if it is.
 654
 655                 if (!$filter_new_find){
 656
 657                         # The find filter given is blank so return an
 658                         # error.
 659
 660                         kiriwrite_error("blankfindfilter");
 661
 662                 }
 663
 664                 if (!$filter_new_priority){
 665
 666                         # The filter priority is blank so set it
 667                         # to 1.
 668
 669                         $filter_new_priority = 1;
 670
 671                 }
 672
 673                 # Check the length and contents of the values given
 674                 # to make sure they are valid.
 675
 676                 my $filterfind_maxlength_check          = kiriwrite_variablecheck($filter_new_find, "maxlength", 1024, 1);
 677                 my $filterreplace_maxlength_check       = kiriwrite_variablecheck($filter_new_replace, "maxlength", 1024, 1);
 678                 my $filterpriority_maxlength_check      = kiriwrite_variablecheck($filter_new_priority, "maxlength", 5, 1);
 679                 my $filterpriority_numbers_check        = kiriwrite_variablecheck($filter_new_priority, "numbers", 0, 1);
 680
 681                 # Check if the result of the tests to see if they
 682                 # are valid.
 683
 684                 if ($filterfind_maxlength_check eq 1){
 685
 686                         # The find filter is too long, so return
 687                         # an error.
 688
 689                         kiriwrite_error("findfiltertoolong");
 690
 691                 }
 692
 693                 if ($filterreplace_maxlength_check eq 1){
 694
 695                         # The replace filter is too long, so
 696                         # return an error.
 697
 698                         kiriwrite_error("replacefiltertoolong");
 699
 700                 }
 701
 702                 if ($filterpriority_maxlength_check eq 1){
 703
 704                         # The length of the filter priority
 705                         # given is too long, so return an
 706                         # error.
 707
 708                         kiriwrite_error("filterprioritytoolong");
 709
 710                 }
 711
 712                 if ($filterpriority_numbers_check eq 1){
 713
 714                         # The priority of the filter given
 715                         # contains characters other than
 716                         # numbers.
 717
 718                         kiriwrite_error("filterpriorityinvalidchars");
 719
 720                 }
 721
 722                 # Check if the filter priority is less than 1
 723                 # and more than 10000 and return an error
 724                 # if it is.
 725
 726                 if ($filter_new_priority < 1 || $filter_new_priority > 50000){
 727
 728                         # The filter priority is less than 1 and
 729                         # more than 10000, so return an error.
 730
 731                         kiriwrite_error("filterpriorityinvalid");
 732
 733                 }
 734
 735                 # Connect to the database server.
 736
 737                 $kiriwrite_dbmodule->connect();
 738
 739                 # Check if any errors occured while connecting to the database server.
 740
 741                 if ($kiriwrite_dbmodule->geterror eq "DatabaseConnectionError"){
 742
 743                         # A database connection error has occured so return
 744                         # an error.
 745
 746                         kiriwrite_error("databaseconnectionerror", $kiriwrite_dbmodule->geterror(1));
 747
 748                 }
 749
 750                 # Connect to the filter database.
 751
 752                 $kiriwrite_dbmodule->connectfilter(1);
 753
 754                 # Check if any error has occured while connecting to the filter
 755                 # database.
 756
 757                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseDoesNotExist"){
 758
 759                         # The filter database does not exist.
 760
 761                         kiriwrite_error("filtersdbmissing");
 762
 763                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseInvalidPermissionsSet"){
 764
 765                         # The filter database has invalid permissions set so return
 766                         # an error.
 767
 768                         kiriwrite_error("filtersdbpermissions");
 769
 770                 }
 771
 772                 # Add the filter to the filter database.
 773
 774                 $kiriwrite_dbmodule->addfilter({ FindFilter => $filter_new_find, ReplaceFilter => $filter_new_replace, Priority => $filter_new_priority, Notes => $filter_new_notes});
 775
 776                 # Check if any errors have occured while adding the filter.
 777
 778                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseInvalidPermissionsSet"){
 779
 780                         # The filter database has invalid permissions set so return
 781                         # an error.
 782
 783                         kiriwrite_error("filtersdbpermissions");
 784
 785                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseUncreatable"){
 786
 787                         # The filter database is uncreatable so return an error.
 788
 789                         kiriwrite_error("filterdatabase");
 790
 791                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
 792
 793                         # A database error with the filter database has occured so return
 794                         # an error with the extended error information.
 795
 796                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
 797
 798                 }
 799
 800                 # Disconnect from the filter database.
 801
 802                 $kiriwrite_dbmodule->disconnectfilter();
 803
 804                 # Disconnect from the database server.
 805
 806                 $kiriwrite_dbmodule->disconnect();
 807
 808                 # Write out a message saying that the filter was added to the
 809                 # filter database.
 810
 811                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{filteradded}, { Style => "pageheader" });
 812                 $kiriwrite_presmodule->addlinebreak();
 813                 $kiriwrite_presmodule->addlinebreak();
 814                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{filteraddedmessage});
 815                 $kiriwrite_presmodule->addlinebreak();
 816                 $kiriwrite_presmodule->addlinebreak();
 817                 $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter", { Text => $kiriwrite_lang->{filter}->{returnfilterlist} });
 818
 819                 return $kiriwrite_presmodule->grab();
 820
 821         } elsif ($confirm ne 0) {
 822
 823                 # The confirm integer is another value (which
 824                 # it shouldn't be) so return an error.
 825
 826                 kiriwrite_error("invalidvalue");
 827
 828         }
 829
 830         # The confirm integer was blank so print out a form
 831         # for adding a new filter.
 832
 833         $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{addfilter}, { Style => "pageheader" });
 834         $kiriwrite_presmodule->addlinebreak();
 835         $kiriwrite_presmodule->addlinebreak();
 836         $kiriwrite_presmodule->startform($kiriwrite_env{"script_filename"}, "POST");
 837         $kiriwrite_presmodule->startbox();
 838         $kiriwrite_presmodule->addhiddendata("mode", "filter");
 839         $kiriwrite_presmodule->addhiddendata("action", "add");
 840         $kiriwrite_presmodule->addhiddendata("confirm", 1);
 841         $kiriwrite_presmodule->starttable("", { CellPadding => 5, CellSpacing => 0 });
 842
 843         $kiriwrite_presmodule->startheader();
 844         $kiriwrite_presmodule->addheader($kiriwrite_lang->{common}->{setting}, { Style => "tablecellheader" });
 845         $kiriwrite_presmodule->addheader($kiriwrite_lang->{common}->{value}, { Style => "tablecellheader" });
 846         $kiriwrite_presmodule->endheader();
 847
 848         $kiriwrite_presmodule->startrow();
 849         $kiriwrite_presmodule->addcell("tablecell1");
 850         $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{findfilter});
 851         $kiriwrite_presmodule->endcell();
 852         $kiriwrite_presmodule->addcell("tablecell2");
 853         $kiriwrite_presmodule->addinputbox("findword", { Size => 64, MaxLength => 1024 });
 854         $kiriwrite_presmodule->endcell();
 855         $kiriwrite_presmodule->endrow();
 856
 857         $kiriwrite_presmodule->startrow();
 858         $kiriwrite_presmodule->addcell("tablecell1");
 859         $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{replacefilter});
 860         $kiriwrite_presmodule->endcell();
 861         $kiriwrite_presmodule->addcell("tablecell2");
 862         $kiriwrite_presmodule->addinputbox("replaceword", { Size => 64, MaxLength => 1024 });
 863         $kiriwrite_presmodule->endcell();
 864         $kiriwrite_presmodule->endrow();
 865
 866         $kiriwrite_presmodule->startrow();
 867         $kiriwrite_presmodule->addcell("tablecell1");
 868         $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{priority});
 869         $kiriwrite_presmodule->endcell();
 870         $kiriwrite_presmodule->addcell("tablecell2");
 871         $kiriwrite_presmodule->addinputbox("priority", { Size => 5, MaxLength => 5 });
 872         $kiriwrite_presmodule->startlist();
 873         $kiriwrite_presmodule->additem($kiriwrite_lang->{filter}->{noprioritygiven});
 874         $kiriwrite_presmodule->endlist();
 875         $kiriwrite_presmodule->endcell();
 876         $kiriwrite_presmodule->endrow();
 877
 878         $kiriwrite_presmodule->startrow();
 879         $kiriwrite_presmodule->addcell("tablecell1");
 880         $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{notes});
 881         $kiriwrite_presmodule->endcell();
 882         $kiriwrite_presmodule->addcell("tablecell2");
 883         $kiriwrite_presmodule->addtextbox("notes", { Columns => 50, Rows => 10 });
 884         $kiriwrite_presmodule->endcell();
 885         $kiriwrite_presmodule->endrow();
 886
 887         $kiriwrite_presmodule->endtable();
 888
 889         $kiriwrite_presmodule->addlinebreak();
 890         $kiriwrite_presmodule->addsubmit($kiriwrite_lang->{filter}->{addfilterbutton});
 891         $kiriwrite_presmodule->addtext(" | ");
 892         $kiriwrite_presmodule->addreset($kiriwrite_lang->{common}->{clearvalues});
 893         $kiriwrite_presmodule->addtext(" | ");
 894         $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter", { Text => $kiriwrite_lang->{filter}->{returnfilterlist} });
 895
 896         $kiriwrite_presmodule->endbox();
 897         $kiriwrite_presmodule->endform();
 898
 899         return $kiriwrite_presmodule->grab();
 900
 901 }
 902
 903 sub kiriwrite_filter_edit{
 904 #################################################################################
 905 # kiriwrite_filter_edit: Edits a filter from the filter list.                   #
 906 #                                                                               #
 907 # Usage:                                                                        #
 908 #                                                                               #
 909 # kiriwrite_filter_edit(filternumber, newfilterfind, newfilterreplace,          #
 910 #                       newfilterpriority, newfilternotes, confirm);            #
 911 #                                                                               #
 912 # filterid              Specifies the filter number (line number) in the        #
 913 #                       filter database.                                        #
 914 # newfilterfind         Specifies the new word to find.                         #
 915 # newfilterreplace      Specifies the new word to replace.                      #
 916 # newfilterpriority     Specifies the new filter priority.                      #
 917 # newfilternotes        Specifies the new filter notes.                         #
 918 # confirm               Confirms the action to edit a filter.                   #
 919 #################################################################################
 920
 921         # Get the values that have been passed to the subroutine.
 922
 923         my ($filter_id, $filter_new_find, $filter_new_replace, $filter_new_priority, $filter_new_notes, $confirm) = @_;
 924
 925         # Check the confirm value to make sure it is no more than
 926         # one character long.
 927
 928         kiriwrite_variablecheck($confirm, "maxlength", 1, 0);
 929
 930         # Check if the confirm value is blank and if it is
 931         # srt the confirm value to 0.
 932
 933         if (!$confirm){
 934
 935                 # The confirm value does not have any value
 936                 # set so set it to 0.
 937
 938                 $confirm = 0;
 939
 940         }
 941
 942         # Check if the filter identification number is blank,
 943         # contains characters other than numbers and is more
 944         # than seven characters long.
 945
 946         if (!$filter_id){
 947
 948                 # The filter identification number is blank,
 949                 # so return an error.
 950
 951                 kiriwrite_error("filteridblank");
 952
 953         }
 954
 955         my $filter_id_numbers_check     = kiriwrite_variablecheck($filter_id, "numbers", 0, 1);
 956
 957         if ($filter_id_numbers_check eq 1){
 958
 959                 # The filter identification number contains
 960                 # characters other than numbers, so return
 961                 # an error.
 962
 963                 kiriwrite_error("filteridinvalid");
 964
 965         }
 966
 967         my $filter_id_maxlength_check   = kiriwrite_variablecheck($filter_id, "maxlength", 7, 1);
 968
 969         if ($filter_id_maxlength_check eq 1){
 970
 971                 # The filter identification number given
 972                 # is more than seven characters long, so
 973                 # return an error.
 974
 975                 kiriwrite_error("filteridtoolong");
 976
 977         }
 978
 979         my $filter_priority;
 980         my $filter_find;
 981         my $filter_replace;
 982         my $filter_notes;
 983
 984         # Check if the action to edit a filter has been
 985         # confirmed.
 986
 987         if ($confirm eq 1){
 988
 989                 # The action to edit a filter has been confirmed so
 990                 # edit the selected filter.
 991
 992                 # First, check the variables recieved are UTF8
 993                 # copliant.
 994
 995                 kiriwrite_variablecheck($filter_new_find, "utf8", 0, 0);
 996                 kiriwrite_variablecheck($filter_new_replace, "utf8", 0, 0);
 997                 kiriwrite_variablecheck($filter_new_priority, "utf8", 0, 0);
 998                 kiriwrite_variablecheck($filter_new_notes, "utf8", 0, 0);
 999
1000                 # Convert the UTF8 values so that the length can
1001                 # checked properly.
1002
1003                 $filter_find            = kiriwrite_utf8convert($filter_new_find);
1004                 $filter_replace         = kiriwrite_utf8convert($filter_new_replace);
1005                 $filter_priority        = kiriwrite_utf8convert($filter_new_priority);
1006                 $filter_notes           = kiriwrite_utf8convert($filter_new_notes);
1007
1008                 # Check if the find filter is blank and return an error
1009                 # if it is.
1010
1011                 if (!$filter_new_find){
1012
1013                         # The find filter given is blank so return an
1014                         # error.
1015
1016                         kiriwrite_error("blankfindfilter");
1017
1018                 }
1019
1020                 if (!$filter_new_priority){
1021
1022                         # The filter priority is blank so set it
1023                         # to 1.
1024
1025                         $filter_new_priority = 1;
1026
1027                 }
1028
1029                 # Check the length and contents of the values given
1030                 # to make sure they are valid.
1031
1032                 my $filterfind_maxlength_check          = kiriwrite_variablecheck($filter_new_find, "maxlength", 1024, 1);
1033                 my $filterreplace_maxlength_check       = kiriwrite_variablecheck($filter_new_replace, "maxlength", 1024, 1);
1034                 my $filterpriority_maxlength_check      = kiriwrite_variablecheck($filter_new_priority, "maxlength", 5, 1);
1035                 my $filterpriority_numbers_check        = kiriwrite_variablecheck($filter_new_priority, "numbers", 0, 1);
1036
1037                 # Check if the result of the tests to see if they
1038                 # are valid.
1039
1040                 if ($filterfind_maxlength_check eq 1){
1041
1042                         # The find filter is too long, so return
1043                         # an error.
1044
1045                         kiriwrite_error("findfiltertoolong");
1046
1047                 }
1048
1049                 if ($filterreplace_maxlength_check eq 1){
1050
1051                         # The replace filter is too long, so
1052                         # return an error.
1053
1054                         kiriwrite_error("replacefiltertoolong");
1055
1056                 }
1057
1058                 if ($filterpriority_maxlength_check eq 1){
1059
1060                         # The length of the filter priority
1061                         # given is too long, so return an
1062                         # error.
1063
1064                         kiriwrite_error("filterprioritytoolong");
1065
1066                 }
1067
1068                 if ($filterpriority_numbers_check eq 1){
1069
1070                         # The priority of the filter given
1071                         # contains characters other than
1072                         # numbers.
1073
1074                         kiriwrite_error("filterpriorityinvalidchars");
1075
1076                 }
1077
1078                 # Check if the filter priority is less than 1
1079                 # and more than 10000 and return an error
1080                 # if it is.
1081
1082                 if ($filter_new_priority < 1 || $filter_new_priority > 50000){
1083
1084                         # The filter priority is less than 1 and
1085                         # more than 10000, so return an error.
1086
1087                         kiriwrite_error("filterpriorityinvalid");
1088
1089                 }
1090
1091                 # Connect to the database server.
1092
1093                 $kiriwrite_dbmodule->connect();
1094
1095                 # Check if any errors occured while connecting to the database server.
1096
1097                 if ($kiriwrite_dbmodule->geterror eq "DatabaseConnectionError"){
1098
1099                         # A database connection error has occured so return
1100                         # an error.
1101
1102                         kiriwrite_error("databaseconnectionerror", $kiriwrite_dbmodule->geterror(1));
1103
1104                 }
1105
1106                 # Connect to the filter database.
1107
1108                 $kiriwrite_dbmodule->connectfilter();
1109
1110                 # Check if any error has occured while connecting to the filter
1111                 # database.
1112
1113                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseDoesNotExist"){
1114
1115                         # The filter database does not exist.
1116
1117                         kiriwrite_error("filtersdbmissing");
1118
1119                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseInvalidPermissionsSet"){
1120
1121                         # The filter database has invalid permissions set so return
1122                         # an error.
1123
1124                         kiriwrite_error("filtersdbpermissions");
1125
1126                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
1127
1128                         # A database error has occured with the filter database.
1129
1130                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
1131
1132                 }
1133
1134                 # Edit the selected filter in the filter database.
1135
1136                 $kiriwrite_dbmodule->editfilter({ FilterID => $filter_id, NewFindFilter => $filter_new_find, NewReplaceFilter => $filter_new_replace, NewFilterPriority => $filter_new_priority, NewFilterNotes => $filter_new_notes });
1137
1138                 # Check if any errors occured while editing the filter.
1139
1140                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseInvalidPermissionsSet"){
1141
1142                         # The filter database has invalid permissions set so return
1143                         # an error.
1144
1145                         kiriwrite_error("filtersdbpermissions");
1146
1147                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
1148
1149                         # A database error has occured while using the filter database
1150                         # so return an error.
1151
1152                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
1153
1154                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDoesNotExist"){
1155
1156                         # The specified filter does not exist so return an error.
1157
1158                         kiriwrite_error("filterdoesnotexist");
1159
1160                 }
1161
1162                 # Disconnect from the filter database.
1163
1164                 $kiriwrite_dbmodule->disconnectfilter();
1165
1166                 # Disconnect from the database server.
1167
1168                 $kiriwrite_dbmodule->disconnect();
1169
1170                 # Write a message saying that the filter was edited.
1171
1172                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{editedfilter}, { Style => "pageheader" });
1173                 $kiriwrite_presmodule->addlinebreak();
1174                 $kiriwrite_presmodule->addlinebreak();
1175                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{editedfiltermessage});
1176                 $kiriwrite_presmodule->addlinebreak();
1177                 $kiriwrite_presmodule->addlinebreak();
1178                 $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter", { Text => $kiriwrite_lang->{filter}->{returnfilterlist}});
1179
1180                 return $kiriwrite_presmodule->grab();
1181
1182         } elsif ($confirm eq 0){
1183
1184                 # The action to edit a filter has not been confirmed
1185                 # so write a form for editing the filter with.
1186
1187                 # Connect to the database server.
1188
1189                 $kiriwrite_dbmodule->connect();
1190
1191                 # Check if any errors occured while connecting to the database server.
1192
1193                 if ($kiriwrite_dbmodule->geterror eq "DatabaseConnectionError"){
1194
1195                         # A database connection error has occured so return
1196                         # an error.
1197
1198                         kiriwrite_error("databaseconnectionerror", $kiriwrite_dbmodule->geterror(1));
1199
1200                 }
1201
1202                 # Connect to the database server.
1203
1204                 $kiriwrite_dbmodule->connect();
1205
1206                 # Check if any errors occured while connecting to the database server.
1207
1208                 if ($kiriwrite_dbmodule->geterror eq "DatabaseConnectionError"){
1209
1210                         # A database connection error has occured so return
1211                         # an error.
1212
1213                         kiriwrite_error("databaseconnectionerror", $kiriwrite_dbmodule->geterror(1));
1214
1215                 }
1216
1217                 # Connect to the filter database.
1218
1219                 $kiriwrite_dbmodule->connectfilter();
1220
1221                 # Check if any error has occured while connecting to the filter
1222                 # database.
1223
1224                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseDoesNotExist"){
1225
1226                         # The filter database does not exist.
1227
1228                         kiriwrite_error("filtersdbmissing");
1229
1230                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseInvalidPermissionsSet"){
1231
1232                         # The filter database has invalid permissions set so return
1233                         # an error.
1234
1235                         kiriwrite_error("filtersdbpermissions");
1236
1237                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
1238
1239                         # A database error has occured with the filter database.
1240
1241                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
1242
1243                 }
1244
1245                 # Get information about the filter.
1246
1247                 my %filter_info = $kiriwrite_dbmodule->getfilterinfo({ FilterID => $filter_id });
1248
1249                 # Check if any errors occured while getting information about the filter.
1250
1251                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
1252
1253                         # A database error occured while using the filter database so
1254                         # return an error.
1255
1256                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
1257
1258                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDoesNotExist"){
1259
1260                         # The filter does not exist so return an error.
1261
1262                         kiriwrite_error("filterdoesnotexist");
1263
1264                 }
1265
1266                 # Get the required information.
1267
1268                 $filter_priority        = $filter_info{"FilterPriority"};
1269                 $filter_find            = $filter_info{"FilterFind"};
1270                 $filter_replace         = $filter_info{"FilterReplace"};
1271                 $filter_notes           = $filter_info{"FilterNotes"};
1272
1273                 # Disconnect from the filter database.
1274
1275                 $kiriwrite_dbmodule->disconnectfilter();
1276
1277                 # Disconnect from the database server.
1278
1279                 $kiriwrite_dbmodule->disconnect();
1280
1281                 # Write out the form.
1282
1283                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{editfilter}, { Style => "pageheader" });
1284                 $kiriwrite_presmodule->startform($kiriwrite_env{"script_filename"}, "POST");
1285                 $kiriwrite_presmodule->startbox();
1286                 $kiriwrite_presmodule->addhiddendata("mode", "filter");
1287                 $kiriwrite_presmodule->addhiddendata("action", "edit");
1288                 $kiriwrite_presmodule->addhiddendata("filter", $filter_id);
1289                 $kiriwrite_presmodule->addhiddendata("confirm", 1);
1290
1291                 $kiriwrite_presmodule->addlinebreak();
1292                 $kiriwrite_presmodule->starttable("", { CellPadding => 5, CellSpacing => 0 });
1293
1294                 $kiriwrite_presmodule->startheader();
1295                 $kiriwrite_presmodule->addheader($kiriwrite_lang->{common}->{setting}, { Style => "tablecellheader" });
1296                 $kiriwrite_presmodule->addheader($kiriwrite_lang->{common}->{value}, { Style => "tablecellheader" });
1297                 $kiriwrite_presmodule->endheader();
1298
1299                 $kiriwrite_presmodule->startrow();
1300                 $kiriwrite_presmodule->addcell("tablecell1");
1301                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{findfilter});
1302                 $kiriwrite_presmodule->endcell();
1303                 $kiriwrite_presmodule->addcell("tablecell2");
1304                 $kiriwrite_presmodule->addinputbox("filterfind", { Size => 64, MaxLength => 1024, Value => $filter_find });
1305                 $kiriwrite_presmodule->endcell();
1306                 $kiriwrite_presmodule->endrow();
1307
1308                 $kiriwrite_presmodule->startrow();
1309                 $kiriwrite_presmodule->addcell("tablecell1");
1310                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{replacefilter});
1311                 $kiriwrite_presmodule->endcell();
1312                 $kiriwrite_presmodule->addcell("tablecell2");
1313                 $kiriwrite_presmodule->addinputbox("filterreplace", { Size => 64, MaxLength => 1024, Value => $filter_replace });
1314                 $kiriwrite_presmodule->endcell();
1315                 $kiriwrite_presmodule->endrow();
1316
1317                 $kiriwrite_presmodule->startrow();
1318                 $kiriwrite_presmodule->addcell("tablecell1");
1319                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{priority});
1320                 $kiriwrite_presmodule->endcell();
1321                 $kiriwrite_presmodule->addcell("tablecell2");
1322                 $kiriwrite_presmodule->addinputbox("priority", { Size => 5, MaxLength => 5, Value => $filter_priority });
1323                 $kiriwrite_presmodule->startlist();
1324                 $kiriwrite_presmodule->additem($kiriwrite_lang->{filter}->{noprioritygiven});
1325                 $kiriwrite_presmodule->endlist();
1326                 $kiriwrite_presmodule->endcell();
1327                 $kiriwrite_presmodule->endrow();
1328
1329                 $kiriwrite_presmodule->startrow();
1330                 $kiriwrite_presmodule->addcell("tablecell1");
1331                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{notes});
1332                 $kiriwrite_presmodule->endcell();
1333                 $kiriwrite_presmodule->addcell("tablecell2");
1334                 $kiriwrite_presmodule->addtextbox("notes", { Columns => 50, Rows => 10});
1335                 $kiriwrite_presmodule->endcell();
1336                 $kiriwrite_presmodule->endrow();
1337
1338                 $kiriwrite_presmodule->endtable();
1339
1340                 $kiriwrite_presmodule->addlinebreak();
1341                 $kiriwrite_presmodule->addsubmit($kiriwrite_lang->{filter}->{editfilterbutton});
1342                 $kiriwrite_presmodule->addtext(" | ");
1343                 $kiriwrite_presmodule->addreset($kiriwrite_lang->{common}->{restorecurrent});
1344                 $kiriwrite_presmodule->addtext(" | ");
1345                 $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter", { Text => $kiriwrite_lang->{filter}->{returnfilterlist} });
1346                 $kiriwrite_presmodule->endbox();
1347                 $kiriwrite_presmodule->endform();
1348
1349                 return $kiriwrite_presmodule->grab();
1350
1351         } else {
1352
1353                 # A confirm value other than 0 or 1 has been
1354                 # specified, so return an error.
1355
1356                 kiriwrite_error("invalidvalue");
1357
1358         }
1359
1360 }
1361
1362 sub kiriwrite_filter_delete{
1363 #################################################################################
1364 # kiriwrite_filter_delete: Deletes a filter from the filter list.               #
1365 #                                                                               #
1366 # Usage:                                                                        #
1367 #                                                                               #
1368 # kiriwrite_filter_delete(filterid, confirm);                                   #
1369 #                                                                               #
1370 # filterid      Specifies the filter line number to delete.                     #
1371 # confirm       Confirms the deletion of the selected filter.                   #
1372 #################################################################################
1373
1374         # Get the values that were passed to this subroutine.
1375
1376         my ($filter_id, $confirm) = @_;
1377
1378         # Check the confirm value to make sure it is no more than
1379         # one character long.
1380
1381         kiriwrite_variablecheck($confirm, "maxlength", 1, 0);
1382
1383         # Check if the confirm value is blank and if it is
1384         # srt the confirm value to 0.
1385
1386         if (!$confirm){
1387
1388                 # The confirm value does not have any value
1389                 # set so set it to 0.
1390
1391                 $confirm = 0;
1392
1393         }
1394
1395         # Check if the filter identification number is blank,
1396         # contains characters other than numbers and is more
1397         # than seven characters long.
1398
1399         if (!$filter_id){
1400
1401                 # The filter identification number is blank,
1402                 # so return an error.
1403
1404                 kiriwrite_error("filteridblank");
1405
1406         }
1407
1408         my $filter_id_numbers_check     = kiriwrite_variablecheck($filter_id, "numbers", 0, 1);
1409
1410         if ($filter_id_numbers_check eq 1){
1411
1412                 # The filter identification number contains
1413                 # characters other than numbers, so return
1414                 # an error.
1415
1416                 kiriwrite_error("filteridinvalid");
1417
1418         }
1419
1420         my $filter_id_maxlength_check   = kiriwrite_variablecheck($filter_id, "maxlength", 7, 1);
1421
1422         if ($filter_id_maxlength_check eq 1){
1423
1424                 # The filter identification number given
1425                 # is more than seven characters long, so
1426                 # return an error.
1427
1428                 kiriwrite_error("filteridtoolong");
1429
1430         }
1431
1432         # Define some values for later.
1433
1434         my @database_filter;
1435         my $filter_exists = 0;
1436
1437         # Check if the confirm integer has a value of '1'.
1438
1439         if ($confirm eq 1){
1440
1441                 # The action to delete a filter has been confirmed.
1442
1443                 # Connect to the database server.
1444
1445                 $kiriwrite_dbmodule->connect();
1446
1447                 # Check if any errors occured while connecting to the database server.
1448
1449                 if ($kiriwrite_dbmodule->geterror eq "DatabaseConnectionError"){
1450
1451                         # A database connection error has occured so return
1452                         # an error.
1453
1454                         kiriwrite_error("databaseconnectionerror", $kiriwrite_dbmodule->geterror(1));
1455
1456                 }
1457
1458                 # Connect to the filter database.
1459
1460                 $kiriwrite_dbmodule->connectfilter();
1461
1462                 # Check if any error has occured while connecting to the filter
1463                 # database.
1464
1465                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseDoesNotExist"){
1466
1467                         # The filter database does not exist.
1468
1469                         kiriwrite_error("filtersdbmissing");
1470
1471                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseInvalidPermissionsSet"){
1472
1473                         # The filter database has invalid permissions set so return
1474                         # an error.
1475
1476                         kiriwrite_error("filtersdbpermissions");
1477
1478                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
1479
1480                         # A database error has occured with the filter database.
1481
1482                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
1483
1484                 }
1485
1486                 # Delete the filter from the filter database.
1487
1488                 $kiriwrite_dbmodule->deletefilter({ FilterID => $filter_id });
1489
1490                 # Check if any errors occured while deleting the filter.
1491
1492                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
1493
1494                         # A database error has occured while trying to delete a filter so
1495                         # return an error.
1496
1497                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
1498
1499                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDoesNotExist"){
1500
1501                         # The filter does not exist so return an error.
1502
1503                         kiriwrite_error("filterdoesnotexist");
1504
1505                 }
1506
1507                 # Disconnect from the filter database.
1508
1509                 $kiriwrite_dbmodule->disconnectfilter();
1510
1511                 # Disconnect from the database server.
1512
1513                 $kiriwrite_dbmodule->disconnect();
1514
1515                 # Write a message saying that the filter was deleted
1516                 # from the filter database.
1517
1518                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{deletedfilter}, { Style => "pageheader" });
1519                 $kiriwrite_presmodule->addlinebreak();
1520                 $kiriwrite_presmodule->addlinebreak();
1521                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{deletedfiltermessage});
1522                 $kiriwrite_presmodule->addlinebreak();
1523                 $kiriwrite_presmodule->addlinebreak();
1524                 $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter", { Text => $kiriwrite_lang->{filter}->{returnfilterlist} });
1525
1526         } elsif ($confirm eq 0) {
1527
1528                 # Connect to the database server.
1529
1530                 $kiriwrite_dbmodule->connect();
1531
1532                 # Check if any errors occured while connecting to the database server.
1533
1534                 if ($kiriwrite_dbmodule->geterror eq "DatabaseConnectionError"){
1535
1536                         # A database connection error has occured so return
1537                         # an error.
1538
1539                         kiriwrite_error("databaseconnectionerror", $kiriwrite_dbmodule->geterror(1));
1540
1541                 }
1542
1543                 # Connect to the filter database.
1544
1545                 $kiriwrite_dbmodule->connectfilter();
1546
1547                 # Check if any error has occured while connecting to the filter
1548                 # database.
1549
1550                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseDoesNotExist"){
1551
1552                         # The filter database does not exist.
1553
1554                         kiriwrite_error("filtersdbmissing");
1555
1556                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseInvalidPermissionsSet"){
1557
1558                         # The filter database has invalid permissions set so return
1559                         # an error.
1560
1561                         kiriwrite_error("filtersdbpermissions");
1562
1563                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
1564
1565                         # A database error has occured with the filter database.
1566
1567                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
1568
1569                 }
1570
1571                 # Get information about the filter (to check if it exists).
1572
1573                 my %filter_info = $kiriwrite_dbmodule->getfilterinfo({ FilterID => $filter_id });
1574
1575                 # Check if any errors occured while getting information about the filter.
1576
1577                 if ($kiriwrite_dbmodule->geterror eq "FilterDatabaseError"){
1578
1579                         # A database error occured while using the filter database so
1580                         # return an error.
1581
1582                         kiriwrite_error("filtersdbdatabaseerror", $kiriwrite_dbmodule->geterror(1));
1583
1584                 } elsif ($kiriwrite_dbmodule->geterror eq "FilterDoesNotExist"){
1585
1586                         # The filter does not exist so return an error.
1587
1588                         kiriwrite_error("filterdoesnotexist");
1589
1590                 }
1591
1592                 # Disconnect from the filter database.
1593
1594                 $kiriwrite_dbmodule->disconnectfilter();
1595
1596                 # Disconnect from the database
1597
1598                 # The confirm integer is '0', so continue write out
1599                 # a form asking the user to confirm the deletion
1600                 # pf the filter.
1601
1602                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{deletefilter}, { Style => "pageheader" });
1603                 $kiriwrite_presmodule->addlinebreak();
1604                 $kiriwrite_presmodule->addlinebreak();
1605                 $kiriwrite_presmodule->addtext($kiriwrite_lang->{filter}->{deletefiltermessage});
1606                 $kiriwrite_presmodule->addlinebreak();
1607                 $kiriwrite_presmodule->addlinebreak();
1608                 $kiriwrite_presmodule->startform($kiriwrite_env{"script_filename"}, "POST");
1609                 $kiriwrite_presmodule->startbox();
1610                 $kiriwrite_presmodule->addhiddendata("mode", "filter");
1611                 $kiriwrite_presmodule->addhiddendata("action", "delete");
1612                 $kiriwrite_presmodule->addhiddendata("filter", $filter_id);
1613                 $kiriwrite_presmodule->addhiddendata("confirm", 1);
1614                 $kiriwrite_presmodule->addsubmit($kiriwrite_lang->{filter}->{deletefilterbutton});
1615                 $kiriwrite_presmodule->addtext(" | ");
1616                 $kiriwrite_presmodule->addlink($kiriwrite_env{"script_filename"} . "?mode=filter", { Text => $kiriwrite_lang->{filter}->{deletefilterreturn} });
1617                 $kiriwrite_presmodule->endbox();
1618                 $kiriwrite_presmodule->endform();
1619
1620         } else {
1621
1622                 kiriwrite_error("invalidvalue");
1623
1624         }
1625
1626         return $kiriwrite_presmodule->grab();
1627
1628 }
1629
1630 1;