FS/FS/Upgrade.pm

   1 package FS::Upgrade;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK $DEBUG );
   5 use Exporter;
   6 use Tie::IxHash;
   7 use File::Slurp;
   8 use FS::UID qw( dbh driver_name );
   9 use FS::Conf;
  10 use FS::Record qw(qsearchs qsearch str2time_sql);
  11 use FS::queue;
  12 use FS::upgrade_journal;
  13 use FS::Setup qw( enable_banned_pay_pad );
  14
  15 use FS::svc_domain;
  16 $FS::svc_domain::whois_hack = 1;
  17
  18 @ISA = qw( Exporter );
  19 @EXPORT_OK = qw( upgrade_schema upgrade_config upgrade upgrade_sqlradius );
  20
  21 $DEBUG = 1;
  22
  23 =head1 NAME
  24
  25 FS::Upgrade - Database upgrade routines
  26
  27 =head1 SYNOPSIS
  28
  29   use FS::Upgrade;
  30
  31 =head1 DESCRIPTION
  32
  33 Currently this module simply provides a place to store common subroutines for
  34 database upgrades.
  35
  36 =head1 SUBROUTINES
  37
  38 =over 4
  39
  40 =item upgrade_config
  41
  42 =cut
  43
  44 #config upgrades
  45 sub upgrade_config {
  46   my %opt = @_;
  47
  48   my $conf = new FS::Conf;
  49
  50   $conf->touch('payment_receipt')
  51     if $conf->exists('payment_receipt_email')
  52     || $conf->config('payment_receipt_msgnum');
  53
  54   $conf->touch('geocode-require_nw_coordinates')
  55     if $conf->exists('svc_broadband-require-nw-coordinates');
  56
  57   unless ( $conf->config('echeck-country') ) {
  58     if ( $conf->exists('cust_main-require-bank-branch') ) {
  59       $conf->set('echeck-country', 'CA');
  60     } elsif ( $conf->exists('echeck-nonus') ) {
  61       $conf->set('echeck-country', 'XX');
  62     } else {
  63       $conf->set('echeck-country', 'US');
  64     }
  65   }
  66
  67   my @agents = qsearch('agent', {});
  68
  69   upgrade_overlimit_groups($conf);
  70   map { upgrade_overlimit_groups($conf,$_->agentnum) } @agents;
  71
  72   upgrade_invoice_from($conf);
  73   foreach my $agent (@agents) {
  74     upgrade_invoice_from($conf,$agent->agentnum,1);
  75   }
  76
  77   my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
  78   $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
  79     foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
  80       qw( quotation_html quotation_latex quotation_latexnotes );
  81
  82   # change 'fslongtable' to 'longtable'
  83   # in invoice and quotation main templates, and also in all secondary
  84   # invoice templates
  85   my @latex_confs =
  86     qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
  87
  88   foreach my $c (@latex_confs) {
  89     my $value = $c->value;
  90     if (length($value) and $value =~ /fslongtable/) {
  91       $value =~ s/fslongtable/longtable/g;
  92       $conf->set($c->name, $value, $c->agentnum);
  93     }
  94   }
  95
  96   # if there's a USPS tools login, assume that's the standardization method
  97   # you want to use
  98   $conf->set('address_standardize_method', 'usps')
  99     if $conf->exists('usps_webtools-userid')
 100     && length($conf->config('usps_webtools-userid')) > 0
 101     && ! $conf->exists('address_standardize_method');
 102
 103   # this option has been renamed/expanded
 104   if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
 105     $conf->touch('cust_main-enable_spouse');
 106     $conf->delete('cust_main-enable_spouse_birthdate');
 107   }
 108
 109   # renamed/repurposed
 110   if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
 111     $conf->touch('part_pkg-show_fcc_options');
 112     $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
 113     warn "
 114 You have FCC Form 477 package options enabled.
 115
 116 Starting with the October 2014 filing date, the FCC has redesigned
 117 Form 477 and introduced new service categories.  See bin/convert-477-options
 118 to update your package configuration for the new report.
 119
 120 If you need to continue using the old Form 477 report, turn on the
 121 'old_fcc_report' configuration option.
 122 ";
 123   }
 124
 125   # boolean invoice_sections_by_location option is now
 126   # invoice_sections_method = 'location'
 127   my @invoice_sections_confs =
 128     qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
 129   foreach my $c (@invoice_sections_confs) {
 130     $c->name =~ /^(\w+)sections_by_location$/;
 131     $conf->delete($c->name);
 132     my $newname = $1.'sections_method';
 133     $conf->set($newname, 'location');
 134   }
 135
 136   # boolean enable_taxproducts is now tax_data_vendor = 'cch'
 137   if ( $conf->exists('enable_taxproducts') ) {
 138
 139     $conf->delete('enable_taxproducts');
 140     $conf->set('tax_data_vendor', 'cch');
 141
 142   }
 143
 144   # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
 145   if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
 146     $conf->set('tax-cust_exempt-groups-num_req', 'all');
 147     $conf->delete('tax-cust_exempt-groups-require_individual_nums');
 148   }
 149
 150   # boolean+text previous_balance-exclude_from_total is now two separate options
 151   my $total_new_charges = $conf->config('previous_balance-exclude_from_total');
 152   if (length($total_new_charges) > 0) {
 153     $conf->set('previous_balance-text-total_new_charges', $total_new_charges);
 154     $conf->set('previous_balance-exclude_from_total', '');
 155   }
 156
 157   # switch from specifying an email address to boolean check
 158   if ( $conf->exists('batch-errors_to') ) {
 159     $conf->touch('batch-errors_not_fatal');
 160     $conf->delete('batch-errors_to');
 161   }
 162
 163   if ( $conf->exists('voip-cust_email_csv_cdr') ) {
 164     $conf->set('voip_cdr_email_attach', 'csv');
 165     $conf->delete('voip-cust_email_csv_cdr') ;
 166   }
 167
 168   if ($conf->exists('unsuspendauto') && !$conf->config('unsuspend_balance')) {
 169     $conf->set('unsuspend_balance','Zero');
 170     $conf->delete('unsuspendauto');
 171   }
 172
 173   if ($conf->config('cust-fields') =~ / \| Payment Type/) {
 174     my $cust_fields = $conf->config('cust-fields');
 175     # so we can potentially use 'Payment Types' or somesuch in the future
 176     $cust_fields =~ s/ \| Payment Type( \|)/$1/;
 177     $cust_fields =~ s/ \| Payment Type$//;
 178     $conf->set('cust-fields',$cust_fields);
 179   }
 180
 181   #repurposed
 182   $conf->set('note-classes','Enabled')
 183     if $conf->exists('note-classes')
 184       and grep {$_ eq $conf->config('note-classes')} ('1','2');
 185   $conf->set('note-classes','')
 186     if $conf->exists('note-classes')
 187       and '0' eq $conf->config('note-classes');
 188
 189   enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
 190
 191   # if translate-auto-insert is enabled for a locale, ensure that invoice
 192   # terms are in the msgcat (is there a better place for this?)
 193   if (my $auto_locale = $conf->config('translate-auto-insert')) {
 194     my $lh = FS::L10N->get_handle($auto_locale);
 195     foreach (@FS::Conf::invoice_terms) {
 196       $lh->maketext($_) if length($_);
 197     }
 198   }
 199 }
 200
 201 sub upgrade_overlimit_groups {
 202     my $conf = shift;
 203     my $agentnum = shift;
 204     my @groups = $conf->config('overlimit_groups',$agentnum);
 205     if(scalar(@groups)) {
 206         my $groups = join(',',@groups);
 207         my @groupnums;
 208         my $error = '';
 209         if ( $groups !~ /^[\d,]+$/ ) {
 210             foreach my $groupname ( @groups ) {
 211                 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
 212                 unless ( $g ) {
 213                     $g = new FS::radius_group {
 214                                     'groupname' => $groupname,
 215                                     'description' => $groupname,
 216                                     };
 217                     $error = $g->insert;
 218                     die $error if $error;
 219                 }
 220                 push @groupnums, $g->groupnum;
 221             }
 222             $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
 223         }
 224     }
 225 }
 226
 227 sub upgrade_invoice_from {
 228   my ($conf, $agentnum, $agentonly) = @_;
 229   if (
 230           ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
 231        && $conf->exists('invoice_from',$agentnum,$agentonly)
 232        && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
 233   ) {
 234     my $realemail = $1;
 235     $realemail =~ s/^\s*//; # remove leading spaces
 236     $realemail =~ s/\s*$//; # remove trailing spaces
 237     my $realname = $conf->config('invoice_from',$agentnum);
 238     $realname =~ s/\<.*\>//; # remove email address
 239     $realname =~ s/^\s*//; # remove leading spaces
 240     $realname =~ s/\s*$//; # remove trailing spaces
 241     # properly quote names that contain punctuation
 242     if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
 243       $realname = '"' . $realname . '"';
 244     }
 245     $conf->set('invoice_from_name', $realname, $agentnum);
 246     $conf->set('invoice_from', $realemail, $agentnum);
 247   }
 248 }
 249
 250 =item upgrade
 251
 252 =cut
 253
 254 sub upgrade {
 255   my %opt = @_;
 256
 257   my $data = upgrade_data(%opt);
 258
 259   my $oldAutoCommit = $FS::UID::AutoCommit;
 260   local $FS::UID::AutoCommit = 0;
 261   local $FS::UID::AutoCommit = 0;
 262
 263   local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
 264
 265
 266   foreach my $table ( keys %$data ) {
 267
 268     my $class = "FS::$table";
 269     eval "use $class;";
 270     die $@ if $@;
 271
 272     if ( $class->can('_upgrade_data') ) {
 273       warn "Upgrading $table...\n";
 274
 275       my $start = time;
 276
 277       $class->_upgrade_data(%opt);
 278
 279       # New interface for async upgrades: a class can declare a
 280       # "queueable_upgrade" method, which will run as part of the normal
 281       # upgrade, but if the -j option is passed, will instead be run from
 282       # the job queue.
 283       if ( $class->can('queueable_upgrade') ) {
 284         my $jobname = $class . '::queueable_upgrade';
 285         my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
 286         if ($num_jobs > 0) {
 287           warn "$class upgrade already scheduled.\n";
 288         } else {
 289           if ( $opt{'queue'} ) {
 290             warn "Scheduling $class upgrade.\n";
 291             my $job = FS::queue->new({ job => $jobname });
 292             $job->insert($class, %opt);
 293           } else {
 294             $class->queueable_upgrade(%opt);
 295           }
 296         } #$num_jobs == 0
 297       }
 298
 299       if ( $oldAutoCommit ) {
 300         warn "  committing\n";
 301         dbh->commit or die dbh->errstr;
 302       }
 303
 304       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 305       warn "  done in ". (time-$start). " seconds\n";
 306
 307     } else {
 308       warn "WARNING: asked for upgrade of $table,".
 309            " but FS::$table has no _upgrade_data method\n";
 310     }
 311
 312 #    my @records = @{ $data->{$table} };
 313 #
 314 #    foreach my $record ( @records ) {
 315 #      my $args = delete($record->{'_upgrade_args'}) || [];
 316 #      my $object = $class->new( $record );
 317 #      my $error = $object->insert( @$args );
 318 #      die "error inserting record into $table: $error\n"
 319 #        if $error;
 320 #    }
 321
 322   }
 323
 324   local($FS::cust_main::ignore_expired_card) = 1;
 325   #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
 326   local($FS::cust_main::ignore_banned_card) = 1;
 327   local($FS::cust_main::skip_fuzzyfiles) = 1;
 328
 329   local($FS::cust_payby::ignore_expired_card) = 1;
 330   local($FS::cust_payby::ignore_banned_card) = 1;
 331
 332   # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
 333   # kind of a weird spot for this, but it's better than duplicating
 334   # all this code in each class...
 335   my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
 336   foreach my $table ( @decrypt_tables ) {
 337       my @objects = qsearch({
 338         'table'     => $table,
 339         'hashref'   => {},
 340         'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
 341                        " AND LENGTH(payinfo) > 100",
 342       });
 343       foreach my $object ( @objects ) {
 344           my $payinfo = $object->decrypt($object->payinfo);
 345           die "error decrypting payinfo" if $payinfo eq $object->payinfo;
 346           $object->payinfo($payinfo);
 347           my $error = $object->replace;
 348           die $error if $error;
 349       }
 350   }
 351
 352 }
 353
 354 =item upgrade_data
 355
 356 =cut
 357
 358 sub upgrade_data {
 359   my %opt = @_;
 360
 361   tie my %hash, 'Tie::IxHash',
 362
 363     #remap log levels
 364         'log' => [],
 365
 366     #payby conditions to new ones
 367     'part_event_condition' => [],
 368
 369     #payby actions to new ones
 370     'part_event' => [],
 371
 372     #fix whitespace - before cust_main
 373     'cust_location' => [],
 374
 375     #cust_main (remove paycvv from history, locations, cust_payby, etc)
 376     'cust_main' => [],
 377
 378     #contact -> cust_contact / prospect_contact
 379     'contact' => [],
 380
 381     #msgcat
 382     'msgcat' => [],
 383
 384     #reason type and reasons
 385     'reason_type'     => [],
 386     'cust_pkg_reason' => [],
 387
 388     #need part_pkg before cust_credit...
 389     'part_pkg' => [],
 390
 391     #customer credits
 392     'cust_credit' => [],
 393
 394     # reason / void_reason migration to reasonnum / void_reasonnum
 395     'cust_credit_void' => [],
 396     'cust_bill_void' => [],
 397     # also fix some tax allocation records
 398     'cust_bill_pkg_void' => [],
 399
 400     #duplicate history records
 401     'h_cust_svc'  => [],
 402
 403     #populate cust_pay.otaker
 404     'cust_pay'    => [],
 405
 406     #populate part_pkg_taxclass for starters
 407     'part_pkg_taxclass' => [],
 408
 409     #remove bad pending records
 410     'cust_pay_pending' => [],
 411
 412     #replace invnum and pkgnum with billpkgnum
 413     'cust_bill_pkg_detail' => [],
 414
 415     #usage_classes if we have none
 416     'usage_class' => [],
 417
 418     #phone_type if we have none
 419     'phone_type' => [],
 420
 421     #fixup access rights
 422     'access_right' => [],
 423
 424     #change recur_flat and enable_prorate
 425     'part_pkg_option' => [],
 426
 427     #add weights to pkg_category
 428     'pkg_category' => [],
 429
 430     #cdrbatch fixes
 431     'cdr' => [],
 432
 433     #otaker->usernum
 434     'cust_attachment' => [],
 435     #'cust_credit' => [],
 436     #'cust_main' => [],
 437     'cust_main_note' => [],
 438     #'cust_pay' => [],
 439     'cust_pay_void' => [],
 440     'cust_pkg' => [],
 441     #'cust_pkg_reason' => [],
 442     'cust_pkg_discount' => [],
 443     'cust_refund' => [],
 444     'banned_pay' => [],
 445
 446     #paycardtype
 447     'cust_payby' => [],
 448
 449     #default namespace
 450     'payment_gateway' => [],
 451
 452     #migrate to templates
 453     'msg_template' => [],
 454
 455     #return unprovisioned numbers to availability
 456     'phone_avail' => [],
 457
 458     #insert scripcondition
 459     'TicketSystem' => [],
 460
 461     #insert LATA data if not already present
 462     'lata' => [],
 463
 464     #insert MSA data if not already present
 465     'msa' => [],
 466
 467     # migrate to radius_group and groupnum instead of groupname
 468     'radius_usergroup' => [],
 469     'part_svc'         => [],
 470     'part_export'      => [],
 471
 472     #insert default tower_sector if not present
 473     'tower' => [],
 474
 475     #repair improperly deleted services
 476     'cust_svc' => [],
 477
 478     #routernum/blocknum
 479     'svc_broadband' => [],
 480
 481     #set up payment gateways if needed
 482     'pay_batch' => [],
 483
 484     #flag monthly tax exemptions
 485     'cust_tax_exempt_pkg' => [],
 486
 487     #kick off tax location history upgrade
 488     'cust_bill_pkg' => [],
 489
 490     #fix taxable line item links
 491     'cust_bill_pkg_tax_location' => [],
 492
 493     #populate state FIPS codes if not already done
 494     'state' => [],
 495
 496     #set default locations on quoted packages
 497     'quotation_pkg' => [],
 498
 499     #populate tax statuses
 500     'tax_status' => [],
 501
 502     #mark certain taxes as system-maintained,
 503     # and fix whitespace
 504     'cust_main_county' => [],
 505   ;
 506
 507   \%hash;
 508
 509 }
 510
 511 =item upgrade_schema
 512
 513 =cut
 514
 515 sub upgrade_schema {
 516   my %opt = @_;
 517
 518   my $data = upgrade_schema_data(%opt);
 519
 520   my $oldAutoCommit = $FS::UID::AutoCommit;
 521   local $FS::UID::AutoCommit = 0;
 522   local $FS::UID::AutoCommit = 0;
 523
 524   foreach my $table ( keys %$data ) {
 525
 526     my $class = "FS::$table";
 527     eval "use $class;";
 528     die $@ if $@;
 529
 530     if ( $class->can('_upgrade_schema') ) {
 531       warn "Upgrading $table schema...\n";
 532
 533       my $start = time;
 534
 535       $class->_upgrade_schema(%opt);
 536
 537       if ( $oldAutoCommit ) {
 538         warn "  committing\n";
 539         dbh->commit or die dbh->errstr;
 540       }
 541
 542       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 543       warn "  done in ". (time-$start). " seconds\n";
 544
 545     } else {
 546       warn "WARNING: asked for schema upgrade of $table,".
 547            " but FS::$table has no _upgrade_schema method\n";
 548     }
 549
 550   }
 551
 552 }
 553
 554 =item upgrade_schema_data
 555
 556 =cut
 557
 558 sub upgrade_schema_data {
 559   my %opt = @_;
 560
 561   tie my %hash, 'Tie::IxHash',
 562
 563     #fix classnum character(1)
 564     'cust_bill_pkg_detail' => [],
 565     #add necessary columns to RT schema
 566     'TicketSystem' => [],
 567     #remove possible dangling records
 568     'password_history' => [],
 569     'cust_pay_pending' => [],
 570   ;
 571
 572   \%hash;
 573
 574 }
 575
 576 sub upgrade_sqlradius {
 577   #my %opt = @_;
 578
 579   my $conf = new FS::Conf;
 580
 581   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
 582
 583   foreach my $part_export ( @part_export ) {
 584
 585     my $errmsg = 'Error adding FreesideStatus to '.
 586                  $part_export->option('datasrc'). ': ';
 587
 588     my $dbh = DBI->connect(
 589       ( map $part_export->option($_), qw ( datasrc username password ) ),
 590       { PrintError => 0, PrintWarn => 0 }
 591     ) or do {
 592       warn $errmsg.$DBI::errstr;
 593       next;
 594     };
 595
 596     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
 597     my $group = "UserName";
 598     $group .= ",Realm"
 599       if ref($part_export) =~ /withdomain/
 600       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
 601
 602     my $sth_alter = $dbh->prepare(
 603       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
 604     );
 605     if ( $sth_alter ) {
 606       if ( $sth_alter->execute ) {
 607         my $sth_update = $dbh->prepare(
 608          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
 609         ) or die $errmsg.$dbh->errstr;
 610         $sth_update->execute or die $errmsg.$sth_update->errstr;
 611       } else {
 612         my $error = $sth_alter->errstr;
 613         warn $errmsg.$error
 614           unless $error =~ /Duplicate column name/i  #mysql
 615               || $error =~ /already exists/i;        #Pg
 616 ;
 617       }
 618     } else {
 619       my $error = $dbh->errstr;
 620       warn $errmsg.$error; #unless $error =~ /exists/i;
 621     }
 622
 623     my $sth_index = $dbh->prepare(
 624       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
 625     );
 626     if ( $sth_index ) {
 627       unless ( $sth_index->execute ) {
 628         my $error = $sth_index->errstr;
 629         warn $errmsg.$error
 630           unless $error =~ /Duplicate key name/i #mysql
 631               || $error =~ /already exists/i;    #Pg
 632       }
 633     } else {
 634       my $error = $dbh->errstr;
 635       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
 636     }
 637
 638     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
 639       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
 640       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
 641
 642     my $sth = $dbh->prepare("SELECT UserName,
 643                                     Realm,
 644                                     $str2time max(AcctStartTime)),
 645                                     $str2time max(AcctStopTime))
 646                               FROM radacct
 647                               WHERE FreesideStatus = 'done'
 648                                 AND $times
 649                               GROUP BY $group
 650                             ")
 651       or die $errmsg.$dbh->errstr;
 652     $sth->execute() or die $errmsg.$sth->errstr;
 653
 654     while (my $row = $sth->fetchrow_arrayref ) {
 655       my ($username, $realm, $start, $stop) = @$row;
 656
 657       $username = lc($username) unless $conf->exists('username-uppercase');
 658
 659       my $exportnum = $part_export->exportnum;
 660       my $extra_sql = " AND exportnum = $exportnum ".
 661                       " AND exportsvcnum IS NOT NULL ";
 662
 663       if ( ref($part_export) =~ /withdomain/ ) {
 664         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
 665                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
 666       }
 667
 668       my $svc_acct = qsearchs({
 669         'select'    => 'svc_acct.*',
 670         'table'     => 'svc_acct',
 671         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
 672                        'LEFT JOIN export_svc USING ( svcpart )',
 673         'hashref'   => { 'username' => $username },
 674         'extra_sql' => $extra_sql,
 675       });
 676
 677       if ($svc_acct) {
 678         $svc_acct->last_login($start)
 679           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
 680         $svc_acct->last_logout($stop)
 681           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
 682       }
 683     }
 684   }
 685
 686 }
 687
 688 =back
 689
 690 =head1 BUGS
 691
 692 Sure.
 693
 694 =head1 SEE ALSO
 695
 696 =cut
 697
 698 1;
 699