FS/FS/Record.pm

   1 package FS::Record;
   2
   3 use strict;
   4 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
   5              $me %virtual_fields_cache $nowarn_identical );
   6 use Exporter;
   7 use Carp qw(carp cluck croak confess);
   8 use File::CounterFile;
   9 use Locale::Country;
  10 use DBI qw(:sql_types);
  11 use DBIx::DBSchema 0.25;
  12 use FS::UID qw(dbh getotaker datasrc driver_name);
  13 use FS::Schema qw(dbdef);
  14 use FS::SearchCache;
  15 use FS::Msgcat qw(gettext);
  16 use FS::Conf;
  17
  18 use FS::part_virtual_field;
  19
  20 use Tie::IxHash;
  21
  22 @ISA = qw(Exporter);
  23
  24 #export dbdef for now... everything else expects to find it here
  25 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef jsearch);
  26
  27 $DEBUG = 0;
  28 $me = '[FS::Record]';
  29
  30 $nowarn_identical = 0;
  31
  32 my $conf;
  33 my $rsa_module;
  34 my $rsa_loaded;
  35 my $rsa_encrypt;
  36 my $rsa_decrypt;
  37
  38 FS::UID->install_callback( sub {
  39   $conf = new FS::Conf;
  40   $File::CounterFile::DEFAULT_DIR = "/usr/local/etc/freeside/counters.". datasrc;
  41 } );
  42
  43 =head1 NAME
  44
  45 FS::Record - Database record objects
  46
  47 =head1 SYNOPSIS
  48
  49     use FS::Record;
  50     use FS::Record qw(dbh fields qsearch qsearchs);
  51
  52     $record = new FS::Record 'table', \%hash;
  53     $record = new FS::Record 'table', { 'column' => 'value', ... };
  54
  55     $record  = qsearchs FS::Record 'table', \%hash;
  56     $record  = qsearchs FS::Record 'table', { 'column' => 'value', ... };
  57     @records = qsearch  FS::Record 'table', \%hash;
  58     @records = qsearch  FS::Record 'table', { 'column' => 'value', ... };
  59
  60     $table = $record->table;
  61     $dbdef_table = $record->dbdef_table;
  62
  63     $value = $record->get('column');
  64     $value = $record->getfield('column');
  65     $value = $record->column;
  66
  67     $record->set( 'column' => 'value' );
  68     $record->setfield( 'column' => 'value' );
  69     $record->column('value');
  70
  71     %hash = $record->hash;
  72
  73     $hashref = $record->hashref;
  74
  75     $error = $record->insert;
  76
  77     $error = $record->delete;
  78
  79     $error = $new_record->replace($old_record);
  80
  81     # external use deprecated - handled by the database (at least for Pg, mysql)
  82     $value = $record->unique('column');
  83
  84     $error = $record->ut_float('column');
  85     $error = $record->ut_number('column');
  86     $error = $record->ut_numbern('column');
  87     $error = $record->ut_money('column');
  88     $error = $record->ut_text('column');
  89     $error = $record->ut_textn('column');
  90     $error = $record->ut_alpha('column');
  91     $error = $record->ut_alphan('column');
  92     $error = $record->ut_phonen('column');
  93     $error = $record->ut_anything('column');
  94     $error = $record->ut_name('column');
  95
  96     $quoted_value = _quote($value,'table','field');
  97
  98     #deprecated
  99     $fields = hfields('table');
 100     if ( $fields->{Field} ) { # etc.
 101
 102     @fields = fields 'table'; #as a subroutine
 103     @fields = $record->fields; #as a method call
 104
 105
 106 =head1 DESCRIPTION
 107
 108 (Mostly) object-oriented interface to database records.  Records are currently
 109 implemented on top of DBI.  FS::Record is intended as a base class for
 110 table-specific classes to inherit from, i.e. FS::cust_main.
 111
 112 =head1 CONSTRUCTORS
 113
 114 =over 4
 115
 116 =item new [ TABLE, ] HASHREF
 117
 118 Creates a new record.  It doesn't store it in the database, though.  See
 119 L<"insert"> for that.
 120
 121 Note that the object stores this hash reference, not a distinct copy of the
 122 hash it points to.  You can ask the object for a copy with the I<hash>
 123 method.
 124
 125 TABLE can only be omitted when a dervived class overrides the table method.
 126
 127 =cut
 128
 129 sub new {
 130   my $proto = shift;
 131   my $class = ref($proto) || $proto;
 132   my $self = {};
 133   bless ($self, $class);
 134
 135   unless ( defined ( $self->table ) ) {
 136     $self->{'Table'} = shift;
 137     carp "warning: FS::Record::new called with table name ". $self->{'Table'};
 138   }
 139
 140   $self->{'Hash'} = shift;
 141
 142   foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
 143     $self->{'Hash'}{$field}='';
 144   }
 145
 146   $self->_rebless if $self->can('_rebless');
 147
 148   $self->{'modified'} = 0;
 149
 150   $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
 151
 152   $self;
 153 }
 154
 155 sub new_or_cached {
 156   my $proto = shift;
 157   my $class = ref($proto) || $proto;
 158   my $self = {};
 159   bless ($self, $class);
 160
 161   $self->{'Table'} = shift unless defined ( $self->table );
 162
 163   my $hashref = $self->{'Hash'} = shift;
 164   my $cache = shift;
 165   if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
 166     my $obj = $cache->cache->{$hashref->{$cache->key}};
 167     $obj->_cache($hashref, $cache) if $obj->can('_cache');
 168     $obj;
 169   } else {
 170     $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
 171   }
 172
 173 }
 174
 175 sub create {
 176   my $proto = shift;
 177   my $class = ref($proto) || $proto;
 178   my $self = {};
 179   bless ($self, $class);
 180   if ( defined $self->table ) {
 181     cluck "create constructor is deprecated, use new!";
 182     $self->new(@_);
 183   } else {
 184     croak "FS::Record::create called (not from a subclass)!";
 185   }
 186 }
 187
 188 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
 189
 190 Searches the database for all records matching (at least) the key/value pairs
 191 in HASHREF.  Returns all the records found as `FS::TABLE' objects if that
 192 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
 193 objects.
 194
 195 The preferred usage is to pass a hash reference of named parameters:
 196
 197   my @records = qsearch( {
 198                            'table'     => 'table_name',
 199                            'hashref'   => { 'field' => 'value'
 200                                             'field' => { 'op'    => '<',
 201                                                          'value' => '420',
 202                                                        },
 203                                           },
 204
 205                            #these are optional...
 206                            'select'    => '*',
 207                            'extra_sql' => 'AND field ',
 208                            #'cache_obj' => '', #optional
 209                            'addl_from' => 'LEFT JOIN othtable USING ( field )',
 210                          }
 211                        );
 212
 213 Much code still uses old-style positional parameters, this is also probably
 214 fine in the common case where there are only two parameters:
 215
 216   my @records = qsearch( 'table', { 'field' => 'value' } );
 217
 218 ###oops, argh, FS::Record::new only lets us create database fields.
 219 #Normal behaviour if SELECT is not specified is `*', as in
 220 #C<SELECT * FROM table WHERE ...>.  However, there is an experimental new
 221 #feature where you can specify SELECT - remember, the objects returned,
 222 #although blessed into the appropriate `FS::TABLE' package, will only have the
 223 #fields you specify.  This might have unwanted results if you then go calling
 224 #regular FS::TABLE methods
 225 #on it.
 226
 227 =cut
 228
 229 sub qsearch {
 230   my($stable, $record, $select, $extra_sql, $cache, $addl_from );
 231   if ( ref($_[0]) ) { #hashref for now, eventually maybe accept a list too
 232     my $opt = shift;
 233     $stable    = $opt->{'table'}     or die "table name is required";
 234     $record    = $opt->{'hashref'}   || {};
 235     $select    = $opt->{'select'}    || '*';
 236     $extra_sql = $opt->{'extra_sql'} || '';
 237     $cache     = $opt->{'cache_obj'} || '';
 238     $addl_from = $opt->{'addl_from'} || '';
 239   } else {
 240     ($stable, $record, $select, $extra_sql, $cache, $addl_from ) = @_;
 241     $select ||= '*';
 242   }
 243
 244   #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
 245   #for jsearch
 246   $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
 247   $stable = $1;
 248   my $dbh = dbh;
 249
 250   my $table = $cache ? $cache->table : $stable;
 251   my $dbdef_table = dbdef->table($table)
 252     or die "No schema for table $table found - ".
 253            "do you need to create it or run dbdef-create?";
 254   my $pkey = $dbdef_table->primary_key;
 255
 256   my @real_fields = grep exists($record->{$_}), real_fields($table);
 257   my @virtual_fields;
 258   if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
 259     @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
 260   } else {
 261     cluck "warning: FS::$table not loaded; virtual fields not searchable";
 262     @virtual_fields = ();
 263   }
 264
 265   my $statement = "SELECT $select FROM $stable";
 266   $statement .= " $addl_from" if $addl_from;
 267   if ( @real_fields or @virtual_fields ) {
 268     $statement .= ' WHERE '. join(' AND ',
 269       ( map {
 270
 271       my $op = '=';
 272       my $column = $_;
 273       if ( ref($record->{$_}) ) {
 274         $op = $record->{$_}{'op'} if $record->{$_}{'op'};
 275         #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
 276         if ( uc($op) eq 'ILIKE' ) {
 277           $op = 'LIKE';
 278           $record->{$_}{'value'} = lc($record->{$_}{'value'});
 279           $column = "LOWER($_)";
 280         }
 281         $record->{$_} = $record->{$_}{'value'}
 282       }
 283
 284       if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
 285         if ( $op eq '=' ) {
 286           if ( driver_name eq 'Pg' ) {
 287             my $type = dbdef->table($table)->column($column)->type;
 288             if ( $type =~ /(int|serial)/i ) {
 289               qq-( $column IS NULL )-;
 290             } else {
 291               qq-( $column IS NULL OR $column = '' )-;
 292             }
 293           } else {
 294             qq-( $column IS NULL OR $column = "" )-;
 295           }
 296         } elsif ( $op eq '!=' ) {
 297           if ( driver_name eq 'Pg' ) {
 298             my $type = dbdef->table($table)->column($column)->type;
 299             if ( $type =~ /(int|serial)/i ) {
 300               qq-( $column IS NOT NULL )-;
 301             } else {
 302               qq-( $column IS NOT NULL AND $column != '' )-;
 303             }
 304           } else {
 305             qq-( $column IS NOT NULL AND $column != "" )-;
 306           }
 307         } else {
 308           if ( driver_name eq 'Pg' ) {
 309             qq-( $column $op '' )-;
 310           } else {
 311             qq-( $column $op "" )-;
 312           }
 313         }
 314       } else {
 315         "$column $op ?";
 316       }
 317     } @real_fields ),
 318     ( map {
 319       my $op = '=';
 320       my $column = $_;
 321       if ( ref($record->{$_}) ) {
 322         $op = $record->{$_}{'op'} if $record->{$_}{'op'};
 323         if ( uc($op) eq 'ILIKE' ) {
 324           $op = 'LIKE';
 325           $record->{$_}{'value'} = lc($record->{$_}{'value'});
 326           $column = "LOWER($_)";
 327         }
 328         $record->{$_} = $record->{$_}{'value'};
 329       }
 330
 331       # ... EXISTS ( SELECT name, value FROM part_virtual_field
 332       #              JOIN virtual_field
 333       #              ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
 334       #              WHERE recnum = svc_acct.svcnum
 335       #              AND (name, value) = ('egad', 'brain') )
 336
 337       my $value = $record->{$_};
 338
 339       my $subq;
 340
 341       $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
 342       "( SELECT part_virtual_field.name, virtual_field.value ".
 343       "FROM part_virtual_field JOIN virtual_field ".
 344       "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
 345       "WHERE virtual_field.recnum = ${table}.${pkey} ".
 346       "AND part_virtual_field.name = '${column}'".
 347       ($value ?
 348         " AND virtual_field.value ${op} '${value}'"
 349       : "") . ")";
 350       $subq;
 351
 352     } @virtual_fields ) );
 353
 354   }
 355
 356   $statement .= " $extra_sql" if defined($extra_sql);
 357
 358   warn "[debug]$me $statement\n" if $DEBUG > 1;
 359   my $sth = $dbh->prepare($statement)
 360     or croak "$dbh->errstr doing $statement";
 361
 362   my $bind = 1;
 363
 364   foreach my $field (
 365     grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
 366   ) {
 367     if ( $record->{$field} =~ /^\d+(\.\d+)?$/
 368          && dbdef->table($table)->column($field)->type =~ /(int|serial)/i
 369     ) {
 370       $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_INTEGER } );
 371     } else {
 372       $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_VARCHAR } );
 373     }
 374   }
 375
 376 #  $sth->execute( map $record->{$_},
 377 #    grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
 378 #  ) or croak "Error executing \"$statement\": ". $sth->errstr;
 379
 380   $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
 381
 382   if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
 383     @virtual_fields = "FS::$table"->virtual_fields;
 384   } else {
 385     cluck "warning: FS::$table not loaded; virtual fields not returned either";
 386     @virtual_fields = ();
 387   }
 388
 389   my %result;
 390   tie %result, "Tie::IxHash";
 391   my @stuff = @{ $sth->fetchall_arrayref( {} ) };
 392   if($pkey) {
 393     %result = map { $_->{$pkey}, $_ } @stuff;
 394   } else {
 395     @result{@stuff} = @stuff;
 396   }
 397
 398   $sth->finish;
 399
 400   if ( keys(%result) and @virtual_fields ) {
 401     $statement =
 402       "SELECT virtual_field.recnum, part_virtual_field.name, ".
 403              "virtual_field.value ".
 404       "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
 405       "WHERE part_virtual_field.dbtable = '$table' AND ".
 406       "virtual_field.recnum IN (".
 407       join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
 408       join(q!', '!, @virtual_fields) . "')";
 409     warn "[debug]$me $statement\n" if $DEBUG > 1;
 410     $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
 411     $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
 412
 413     foreach (@{ $sth->fetchall_arrayref({}) }) {
 414       my $recnum = $_->{recnum};
 415       my $name = $_->{name};
 416       my $value = $_->{value};
 417       if (exists($result{$recnum})) {
 418         $result{$recnum}->{$name} = $value;
 419       }
 420     }
 421   }
 422   my @return;
 423   if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
 424     if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
 425       #derivied class didn't override new method, so this optimization is safe
 426       if ( $cache ) {
 427         @return = map {
 428           new_or_cached( "FS::$table", { %{$_} }, $cache )
 429         } values(%result);
 430       } else {
 431         @return = map {
 432           new( "FS::$table", { %{$_} } )
 433         } values(%result);
 434       }
 435     } else {
 436       #okay, its been tested
 437       # warn "untested code (class FS::$table uses custom new method)";
 438       @return = map {
 439         eval 'FS::'. $table. '->new( { %{$_} } )';
 440       } values(%result);
 441     }
 442
 443     # Check for encrypted fields and decrypt them.
 444     if ($conf->exists('encryption') && eval 'defined(@FS::'. $table . '::encrypted_fields)') {
 445       foreach my $record (@return) {
 446         foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
 447           # Set it directly... This may cause a problem in the future...
 448           $record->setfield($field, $record->decrypt($record->getfield($field)));
 449         }
 450       }
 451     }
 452   } else {
 453     cluck "warning: FS::$table not loaded; returning FS::Record objects";
 454     @return = map {
 455       FS::Record->new( $table, { %{$_} } );
 456     } values(%result);
 457   }
 458   return @return;
 459 }
 460
 461 =item by_key PRIMARY_KEY_VALUE
 462
 463 This is a class method that returns the record with the given primary key
 464 value.  This method is only useful in FS::Record subclasses.  For example:
 465
 466   my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
 467
 468 is equivalent to:
 469
 470   my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
 471
 472 =cut
 473
 474 sub by_key {
 475   my ($class, $pkey_value) = @_;
 476
 477   my $table = $class->table
 478     or croak "No table for $class found";
 479
 480   my $dbdef_table = dbdef->table($table)
 481     or die "No schema for table $table found - ".
 482            "do you need to create it or run dbdef-create?";
 483   my $pkey = $dbdef_table->primary_key
 484     or die "No primary key for table $table";
 485
 486   return qsearchs($table, { $pkey => $pkey_value });
 487 }
 488
 489 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
 490
 491 Experimental JOINed search method.  Using this method, you can execute a
 492 single SELECT spanning multiple tables, and cache the results for subsequent
 493 method calls.  Interface will almost definately change in an incompatible
 494 fashion.
 495
 496 Arguments:
 497
 498 =cut
 499
 500 sub jsearch {
 501   my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
 502   my $cache = FS::SearchCache->new( $ptable, $pkey );
 503   my %saw;
 504   ( $cache,
 505     grep { !$saw{$_->getfield($pkey)}++ }
 506       qsearch($table, $record, $select, $extra_sql, $cache )
 507   );
 508 }
 509
 510 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
 511
 512 Same as qsearch, except that if more than one record matches, it B<carp>s but
 513 returns the first.  If this happens, you either made a logic error in asking
 514 for a single item, or your data is corrupted.
 515
 516 =cut
 517
 518 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
 519   my $table = $_[0];
 520   my(@result) = qsearch(@_);
 521   cluck "warning: Multiple records in scalar search ($table)"
 522     if scalar(@result) > 1;
 523   #should warn more vehemently if the search was on a primary key?
 524   scalar(@result) ? ($result[0]) : ();
 525 }
 526
 527 =back
 528
 529 =head1 METHODS
 530
 531 =over 4
 532
 533 =item table
 534
 535 Returns the table name.
 536
 537 =cut
 538
 539 sub table {
 540 #  cluck "warning: FS::Record::table deprecated; supply one in subclass!";
 541   my $self = shift;
 542   $self -> {'Table'};
 543 }
 544
 545 =item dbdef_table
 546
 547 Returns the DBIx::DBSchema::Table object for the table.
 548
 549 =cut
 550
 551 sub dbdef_table {
 552   my($self)=@_;
 553   my($table)=$self->table;
 554   dbdef->table($table);
 555 }
 556
 557 =item get, getfield COLUMN
 558
 559 Returns the value of the column/field/key COLUMN.
 560
 561 =cut
 562
 563 sub get {
 564   my($self,$field) = @_;
 565   # to avoid "Use of unitialized value" errors
 566   if ( defined ( $self->{Hash}->{$field} ) ) {
 567     $self->{Hash}->{$field};
 568   } else {
 569     '';
 570   }
 571 }
 572 sub getfield {
 573   my $self = shift;
 574   $self->get(@_);
 575 }
 576
 577 =item set, setfield COLUMN, VALUE
 578
 579 Sets the value of the column/field/key COLUMN to VALUE.  Returns VALUE.
 580
 581 =cut
 582
 583 sub set {
 584   my($self,$field,$value) = @_;
 585   $self->{'modified'} = 1;
 586   $self->{'Hash'}->{$field} = $value;
 587 }
 588 sub setfield {
 589   my $self = shift;
 590   $self->set(@_);
 591 }
 592
 593 =item AUTLOADED METHODS
 594
 595 $record->column is a synonym for $record->get('column');
 596
 597 $record->column('value') is a synonym for $record->set('column','value');
 598
 599 =cut
 600
 601 # readable/safe
 602 sub AUTOLOAD {
 603   my($self,$value)=@_;
 604   my($field)=$AUTOLOAD;
 605   $field =~ s/.*://;
 606   if ( defined($value) ) {
 607     confess "errant AUTOLOAD $field for $self (arg $value)"
 608       unless ref($self) && $self->can('setfield');
 609     $self->setfield($field,$value);
 610   } else {
 611     confess "errant AUTOLOAD $field for $self (no args)"
 612       unless ref($self) && $self->can('getfield');
 613     $self->getfield($field);
 614   }
 615 }
 616
 617 # efficient
 618 #sub AUTOLOAD {
 619 #  my $field = $AUTOLOAD;
 620 #  $field =~ s/.*://;
 621 #  if ( defined($_[1]) ) {
 622 #    $_[0]->setfield($field, $_[1]);
 623 #  } else {
 624 #    $_[0]->getfield($field);
 625 #  }
 626 #}
 627
 628 =item hash
 629
 630 Returns a list of the column/value pairs, usually for assigning to a new hash.
 631
 632 To make a distinct duplicate of an FS::Record object, you can do:
 633
 634     $new = new FS::Record ( $old->table, { $old->hash } );
 635
 636 =cut
 637
 638 sub hash {
 639   my($self) = @_;
 640   confess $self. ' -> hash: Hash attribute is undefined'
 641     unless defined($self->{'Hash'});
 642   %{ $self->{'Hash'} };
 643 }
 644
 645 =item hashref
 646
 647 Returns a reference to the column/value hash.  This may be deprecated in the
 648 future; if there's a reason you can't just use the autoloaded or get/set
 649 methods, speak up.
 650
 651 =cut
 652
 653 sub hashref {
 654   my($self) = @_;
 655   $self->{'Hash'};
 656 }
 657
 658 =item modified
 659
 660 Returns true if any of this object's values have been modified with set (or via
 661 an autoloaded method).  Doesn't yet recognize when you retreive a hashref and
 662 modify that.
 663
 664 =cut
 665
 666 sub modified {
 667   my $self = shift;
 668   $self->{'modified'};
 669 }
 670
 671 =item insert
 672
 673 Inserts this record to the database.  If there is an error, returns the error,
 674 otherwise returns false.
 675
 676 =cut
 677
 678 sub insert {
 679   my $self = shift;
 680   my $saved = {};
 681
 682   my $error = $self->check;
 683   return $error if $error;
 684
 685   #single-field unique keys are given a value if false
 686   #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
 687   foreach ( $self->dbdef_table->unique->singles ) {
 688     $self->unique($_) unless $self->getfield($_);
 689   }
 690
 691   #and also the primary key, if the database isn't going to
 692   my $primary_key = $self->dbdef_table->primary_key;
 693   my $db_seq = 0;
 694   if ( $primary_key ) {
 695     my $col = $self->dbdef_table->column($primary_key);
 696
 697     $db_seq =
 698       uc($col->type) eq 'SERIAL'
 699       || ( driver_name eq 'Pg'
 700              && defined($col->default)
 701              && $col->default =~ /^nextval\(/i
 702          )
 703       || ( driver_name eq 'mysql'
 704              && defined($col->local)
 705              && $col->local =~ /AUTO_INCREMENT/i
 706          );
 707     $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
 708   }
 709
 710   my $table = $self->table;
 711
 712
 713   # Encrypt before the database
 714   if ($conf->exists('encryption') && defined(eval '@FS::'. $table . 'encrypted_fields')) {
 715     foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
 716       $self->{'saved'} = $self->getfield($field);
 717       $self->setfield($field, $self->enrypt($self->getfield($field)));
 718     }
 719   }
 720
 721
 722   #false laziness w/delete
 723   my @real_fields =
 724     grep defined($self->getfield($_)) && $self->getfield($_) ne "",
 725     real_fields($table)
 726   ;
 727   my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
 728   #eslaf
 729
 730   my $statement = "INSERT INTO $table ( ".
 731       join( ', ', @real_fields ).
 732     ") VALUES (".
 733       join( ', ', @values ).
 734     ")"
 735   ;
 736   warn "[debug]$me $statement\n" if $DEBUG > 1;
 737   my $sth = dbh->prepare($statement) or return dbh->errstr;
 738
 739   local $SIG{HUP} = 'IGNORE';
 740   local $SIG{INT} = 'IGNORE';
 741   local $SIG{QUIT} = 'IGNORE';
 742   local $SIG{TERM} = 'IGNORE';
 743   local $SIG{TSTP} = 'IGNORE';
 744   local $SIG{PIPE} = 'IGNORE';
 745
 746   $sth->execute or return $sth->errstr;
 747
 748   my $insertid = '';
 749   if ( $db_seq ) { # get inserted id from the database, if applicable
 750     warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
 751     if ( driver_name eq 'Pg' ) {
 752
 753       #my $oid = $sth->{'pg_oid_status'};
 754       #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
 755       my $i_sql = "SELECT currval('${table}_${primary_key}_seq')";
 756       my $i_sth = dbh->prepare($i_sql) or do {
 757         dbh->rollback if $FS::UID::AutoCommit;
 758         return dbh->errstr;
 759       };
 760       #$i_sth->execute($oid) or do {
 761       $i_sth->execute() or do {
 762         dbh->rollback if $FS::UID::AutoCommit;
 763         return $i_sth->errstr;
 764       };
 765       $insertid = $i_sth->fetchrow_arrayref->[0];
 766
 767     } elsif ( driver_name eq 'mysql' ) {
 768
 769       $insertid = dbh->{'mysql_insertid'};
 770       # work around mysql_insertid being null some of the time, ala RT :/
 771       unless ( $insertid ) {
 772         warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
 773              "using SELECT LAST_INSERT_ID();";
 774         my $i_sql = "SELECT LAST_INSERT_ID()";
 775         my $i_sth = dbh->prepare($i_sql) or do {
 776           dbh->rollback if $FS::UID::AutoCommit;
 777           return dbh->errstr;
 778         };
 779         $i_sth->execute or do {
 780           dbh->rollback if $FS::UID::AutoCommit;
 781           return $i_sth->errstr;
 782         };
 783         $insertid = $i_sth->fetchrow_arrayref->[0];
 784       }
 785
 786     } else {
 787       dbh->rollback if $FS::UID::AutoCommit;
 788       return "don't know how to retreive inserted ids from ". driver_name.
 789              ", try using counterfiles (maybe run dbdef-create?)";
 790     }
 791     $self->setfield($primary_key, $insertid);
 792   }
 793
 794   my @virtual_fields =
 795       grep defined($self->getfield($_)) && $self->getfield($_) ne "",
 796           $self->virtual_fields;
 797   if (@virtual_fields) {
 798     my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
 799
 800     my $vfieldpart = $self->vfieldpart_hashref;
 801
 802     my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
 803                     "VALUES (?, ?, ?)";
 804
 805     my $v_sth = dbh->prepare($v_statement) or do {
 806       dbh->rollback if $FS::UID::AutoCommit;
 807       return dbh->errstr;
 808     };
 809
 810     foreach (keys(%v_values)) {
 811       $v_sth->execute($self->getfield($primary_key),
 812                       $vfieldpart->{$_},
 813                       $v_values{$_})
 814       or do {
 815         dbh->rollback if $FS::UID::AutoCommit;
 816         return $v_sth->errstr;
 817       };
 818     }
 819   }
 820
 821
 822   my $h_sth;
 823   if ( defined dbdef->table('h_'. $table) ) {
 824     my $h_statement = $self->_h_statement('insert');
 825     warn "[debug]$me $h_statement\n" if $DEBUG > 2;
 826     $h_sth = dbh->prepare($h_statement) or do {
 827       dbh->rollback if $FS::UID::AutoCommit;
 828       return dbh->errstr;
 829     };
 830   } else {
 831     $h_sth = '';
 832   }
 833   $h_sth->execute or return $h_sth->errstr if $h_sth;
 834
 835   dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
 836
 837   # Now that it has been saved, reset the encrypted fields so that $new
 838   # can still be used.
 839   foreach my $field (keys %{$saved}) {
 840     $self->setfield($field, $saved->{$field});
 841   }
 842
 843   '';
 844 }
 845
 846 =item add
 847
 848 Depriciated (use insert instead).
 849
 850 =cut
 851
 852 sub add {
 853   cluck "warning: FS::Record::add deprecated!";
 854   insert @_; #call method in this scope
 855 }
 856
 857 =item delete
 858
 859 Delete this record from the database.  If there is an error, returns the error,
 860 otherwise returns false.
 861
 862 =cut
 863
 864 sub delete {
 865   my $self = shift;
 866
 867   my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
 868     map {
 869       $self->getfield($_) eq ''
 870         #? "( $_ IS NULL OR $_ = \"\" )"
 871         ? ( driver_name eq 'Pg'
 872               ? "$_ IS NULL"
 873               : "( $_ IS NULL OR $_ = \"\" )"
 874           )
 875         : "$_ = ". _quote($self->getfield($_),$self->table,$_)
 876     } ( $self->dbdef_table->primary_key )
 877           ? ( $self->dbdef_table->primary_key)
 878           : real_fields($self->table)
 879   );
 880   warn "[debug]$me $statement\n" if $DEBUG > 1;
 881   my $sth = dbh->prepare($statement) or return dbh->errstr;
 882
 883   my $h_sth;
 884   if ( defined dbdef->table('h_'. $self->table) ) {
 885     my $h_statement = $self->_h_statement('delete');
 886     warn "[debug]$me $h_statement\n" if $DEBUG > 2;
 887     $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
 888   } else {
 889     $h_sth = '';
 890   }
 891
 892   my $primary_key = $self->dbdef_table->primary_key;
 893   my $v_sth;
 894   my @del_vfields;
 895   my $vfp = $self->vfieldpart_hashref;
 896   foreach($self->virtual_fields) {
 897     next if $self->getfield($_) eq '';
 898     unless(@del_vfields) {
 899       my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
 900       $v_sth = dbh->prepare($st) or return dbh->errstr;
 901     }
 902     push @del_vfields, $_;
 903   }
 904
 905   local $SIG{HUP} = 'IGNORE';
 906   local $SIG{INT} = 'IGNORE';
 907   local $SIG{QUIT} = 'IGNORE';
 908   local $SIG{TERM} = 'IGNORE';
 909   local $SIG{TSTP} = 'IGNORE';
 910   local $SIG{PIPE} = 'IGNORE';
 911
 912   my $rc = $sth->execute or return $sth->errstr;
 913   #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
 914   $h_sth->execute or return $h_sth->errstr if $h_sth;
 915   $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
 916     or return $v_sth->errstr
 917         foreach (@del_vfields);
 918
 919   dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
 920
 921   #no need to needlessly destoy the data either (causes problems actually)
 922   #undef $self; #no need to keep object!
 923
 924   '';
 925 }
 926
 927 =item del
 928
 929 Depriciated (use delete instead).
 930
 931 =cut
 932
 933 sub del {
 934   cluck "warning: FS::Record::del deprecated!";
 935   &delete(@_); #call method in this scope
 936 }
 937
 938 =item replace OLD_RECORD
 939
 940 Replace the OLD_RECORD with this one in the database.  If there is an error,
 941 returns the error, otherwise returns false.
 942
 943 =cut
 944
 945 sub replace {
 946   my $new = shift;
 947   my $old = shift;
 948
 949   if (!defined($old)) {
 950     warn "[debug]$me replace called with no arguments; autoloading old record\n"
 951      if $DEBUG;
 952     my $primary_key = $new->dbdef_table->primary_key;
 953     if ( $primary_key ) {
 954       $old = qsearchs($new->table, { $primary_key => $new->$primary_key() } )
 955         or croak "can't find ". $new->table. ".$primary_key ".
 956                  $new->$primary_key();
 957     } else {
 958       croak $new->table. " has no primary key; pass old record as argument";
 959     }
 960   }
 961
 962   warn "[debug]$me $new ->replace $old\n" if $DEBUG;
 963
 964   return "Records not in same table!" unless $new->table eq $old->table;
 965
 966   my $primary_key = $old->dbdef_table->primary_key;
 967   return "Can't change primary key $primary_key ".
 968          'from '. $old->getfield($primary_key).
 969          ' to ' . $new->getfield($primary_key)
 970     if $primary_key
 971        && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
 972
 973   my $error = $new->check;
 974   return $error if $error;
 975
 976   # Encrypt for replace
 977   my $saved = {};
 978   if ($conf->exists('encryption') && defined(eval '@FS::'. $new->table . 'encrypted_fields')) {
 979     foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
 980       $saved->{$field} = $new->getfield($field);
 981       $new->setfield($field, $new->encrypt($new->getfield($field)));
 982     }
 983   }
 984
 985   #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
 986   my %diff = map { ($new->getfield($_) ne $old->getfield($_))
 987                    ? ($_, $new->getfield($_)) : () } $old->fields;
 988
 989   unless ( keys(%diff) ) {
 990     carp "[warning]$me $new -> replace $old: records identical"
 991       unless $nowarn_identical;
 992     return '';
 993   }
 994
 995   my $statement = "UPDATE ". $old->table. " SET ". join(', ',
 996     map {
 997       "$_ = ". _quote($new->getfield($_),$old->table,$_)
 998     } real_fields($old->table)
 999   ). ' WHERE '.
1000     join(' AND ',
1001       map {
1002
1003         if ( $old->getfield($_) eq '' ) {
1004
1005          #false laziness w/qsearch
1006          if ( driver_name eq 'Pg' ) {
1007             my $type = $old->dbdef_table->column($_)->type;
1008             if ( $type =~ /(int|serial)/i ) {
1009               qq-( $_ IS NULL )-;
1010             } else {
1011               qq-( $_ IS NULL OR $_ = '' )-;
1012             }
1013           } else {
1014             qq-( $_ IS NULL OR $_ = "" )-;
1015           }
1016
1017         } else {
1018           "$_ = ". _quote($old->getfield($_),$old->table,$_);
1019         }
1020
1021       } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1022     )
1023   ;
1024   warn "[debug]$me $statement\n" if $DEBUG > 1;
1025   my $sth = dbh->prepare($statement) or return dbh->errstr;
1026
1027   my $h_old_sth;
1028   if ( defined dbdef->table('h_'. $old->table) ) {
1029     my $h_old_statement = $old->_h_statement('replace_old');
1030     warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1031     $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1032   } else {
1033     $h_old_sth = '';
1034   }
1035
1036   my $h_new_sth;
1037   if ( defined dbdef->table('h_'. $new->table) ) {
1038     my $h_new_statement = $new->_h_statement('replace_new');
1039     warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1040     $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1041   } else {
1042     $h_new_sth = '';
1043   }
1044
1045   # For virtual fields we have three cases with different SQL
1046   # statements: add, replace, delete
1047   my $v_add_sth;
1048   my $v_rep_sth;
1049   my $v_del_sth;
1050   my (@add_vfields, @rep_vfields, @del_vfields);
1051   my $vfp = $old->vfieldpart_hashref;
1052   foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
1053     if($diff{$_} eq '') {
1054       # Delete
1055       unless(@del_vfields) {
1056         my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
1057                  "AND vfieldpart = ?";
1058         warn "[debug]$me $st\n" if $DEBUG > 2;
1059         $v_del_sth = dbh->prepare($st) or return dbh->errstr;
1060       }
1061       push @del_vfields, $_;
1062     } elsif($old->getfield($_) eq '') {
1063       # Add
1064       unless(@add_vfields) {
1065         my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
1066                  "VALUES (?, ?, ?)";
1067         warn "[debug]$me $st\n" if $DEBUG > 2;
1068         $v_add_sth = dbh->prepare($st) or return dbh->errstr;
1069       }
1070       push @add_vfields, $_;
1071     } else {
1072       # Replace
1073       unless(@rep_vfields) {
1074         my $st = "UPDATE virtual_field SET value = ? ".
1075                  "WHERE recnum = ? AND vfieldpart = ?";
1076         warn "[debug]$me $st\n" if $DEBUG > 2;
1077         $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
1078       }
1079       push @rep_vfields, $_;
1080     }
1081   }
1082
1083   local $SIG{HUP} = 'IGNORE';
1084   local $SIG{INT} = 'IGNORE';
1085   local $SIG{QUIT} = 'IGNORE';
1086   local $SIG{TERM} = 'IGNORE';
1087   local $SIG{TSTP} = 'IGNORE';
1088   local $SIG{PIPE} = 'IGNORE';
1089
1090   my $rc = $sth->execute or return $sth->errstr;
1091   #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1092   $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1093   $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1094
1095   $v_del_sth->execute($old->getfield($primary_key),
1096                       $vfp->{$_})
1097         or return $v_del_sth->errstr
1098       foreach(@del_vfields);
1099
1100   $v_add_sth->execute($new->getfield($_),
1101                       $old->getfield($primary_key),
1102                       $vfp->{$_})
1103         or return $v_add_sth->errstr
1104       foreach(@add_vfields);
1105
1106   $v_rep_sth->execute($new->getfield($_),
1107                       $old->getfield($primary_key),
1108                       $vfp->{$_})
1109         or return $v_rep_sth->errstr
1110       foreach(@rep_vfields);
1111
1112   dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1113
1114   # Now that it has been saved, reset the encrypted fields so that $new
1115   # can still be used.
1116   foreach my $field (keys %{$saved}) {
1117     $new->setfield($field, $saved->{$field});
1118   }
1119
1120   '';
1121
1122 }
1123
1124 =item rep
1125
1126 Depriciated (use replace instead).
1127
1128 =cut
1129
1130 sub rep {
1131   cluck "warning: FS::Record::rep deprecated!";
1132   replace @_; #call method in this scope
1133 }
1134
1135 =item check
1136
1137 Checks virtual fields (using check_blocks).  Subclasses should still provide
1138 a check method to validate real fields, foreign keys, etc., and call this
1139 method via $self->SUPER::check.
1140
1141 (FIXME: Should this method try to make sure that it I<is> being called from
1142 a subclass's check method, to keep the current semantics as far as possible?)
1143
1144 =cut
1145
1146 sub check {
1147   #confess "FS::Record::check not implemented; supply one in subclass!";
1148   my $self = shift;
1149
1150   foreach my $field ($self->virtual_fields) {
1151     for ($self->getfield($field)) {
1152       # See notes on check_block in FS::part_virtual_field.
1153       eval $self->pvf($field)->check_block;
1154       if ( $@ ) {
1155         #this is bad, probably want to follow the stack backtrace up and see
1156         #wtf happened
1157         my $err = "Fatal error checking $field for $self";
1158         cluck "$err: $@";
1159         return "$err (see log for backtrace): $@";
1160
1161       }
1162       $self->setfield($field, $_);
1163     }
1164   }
1165   '';
1166 }
1167
1168 sub _h_statement {
1169   my( $self, $action, $time ) = @_;
1170
1171   $time ||= time;
1172
1173   my @fields =
1174     grep defined($self->getfield($_)) && $self->getfield($_) ne "",
1175     real_fields($self->table);
1176   ;
1177   my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1178
1179   "INSERT INTO h_". $self->table. " ( ".
1180       join(', ', qw(history_date history_user history_action), @fields ).
1181     ") VALUES (".
1182       join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1183     ")"
1184   ;
1185 }
1186
1187 =item unique COLUMN
1188
1189 B<Warning>: External use is B<deprecated>.
1190
1191 Replaces COLUMN in record with a unique number, using counters in the
1192 filesystem.  Used by the B<insert> method on single-field unique columns
1193 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1194 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1195
1196 Returns the new value.
1197
1198 =cut
1199
1200 sub unique {
1201   my($self,$field) = @_;
1202   my($table)=$self->table;
1203
1204   croak "Unique called on field $field, but it is ",
1205         $self->getfield($field),
1206         ", not null!"
1207     if $self->getfield($field);
1208
1209   #warn "table $table is tainted" if is_tainted($table);
1210   #warn "field $field is tainted" if is_tainted($field);
1211
1212   my($counter) = new File::CounterFile "$table.$field",0;
1213 # hack for web demo
1214 #  getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1215 #  my($user)=$1;
1216 #  my($counter) = new File::CounterFile "$user/$table.$field",0;
1217 # endhack
1218
1219   my $index = $counter->inc;
1220   $index = $counter->inc while qsearchs($table, { $field=>$index } );
1221
1222   $index =~ /^(\d*)$/;
1223   $index=$1;
1224
1225   $self->setfield($field,$index);
1226
1227 }
1228
1229 =item ut_float COLUMN
1230
1231 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10.  May not be
1232 null.  If there is an error, returns the error, otherwise returns false.
1233
1234 =cut
1235
1236 sub ut_float {
1237   my($self,$field)=@_ ;
1238   ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
1239    $self->getfield($field) =~ /^(\d+)$/ ||
1240    $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
1241    $self->getfield($field) =~ /^(\d+e\d+)$/)
1242     or return "Illegal or empty (float) $field: ". $self->getfield($field);
1243   $self->setfield($field,$1);
1244   '';
1245 }
1246
1247 =item ut_snumber COLUMN
1248
1249 Check/untaint signed numeric data (whole numbers).  May not be null.  If there
1250 is an error, returns the error, otherwise returns false.
1251
1252 =cut
1253
1254 sub ut_snumber {
1255   my($self, $field) = @_;
1256   $self->getfield($field) =~ /^(-?)\s*(\d+)$/
1257     or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1258   $self->setfield($field, "$1$2");
1259   '';
1260 }
1261
1262 =item ut_number COLUMN
1263
1264 Check/untaint simple numeric data (whole numbers).  May not be null.  If there
1265 is an error, returns the error, otherwise returns false.
1266
1267 =cut
1268
1269 sub ut_number {
1270   my($self,$field)=@_;
1271   $self->getfield($field) =~ /^(\d+)$/
1272     or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1273   $self->setfield($field,$1);
1274   '';
1275 }
1276
1277 =item ut_numbern COLUMN
1278
1279 Check/untaint simple numeric data (whole numbers).  May be null.  If there is
1280 an error, returns the error, otherwise returns false.
1281
1282 =cut
1283
1284 sub ut_numbern {
1285   my($self,$field)=@_;
1286   $self->getfield($field) =~ /^(\d*)$/
1287     or return "Illegal (numeric) $field: ". $self->getfield($field);
1288   $self->setfield($field,$1);
1289   '';
1290 }
1291
1292 =item ut_money COLUMN
1293
1294 Check/untaint monetary numbers.  May be negative.  Set to 0 if null.  If there
1295 is an error, returns the error, otherwise returns false.
1296
1297 =cut
1298
1299 sub ut_money {
1300   my($self,$field)=@_;
1301   $self->setfield($field, 0) if $self->getfield($field) eq '';
1302   $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
1303     or return "Illegal (money) $field: ". $self->getfield($field);
1304   #$self->setfield($field, "$1$2$3" || 0);
1305   $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
1306   '';
1307 }
1308
1309 =item ut_text COLUMN
1310
1311 Check/untaint text.  Alphanumerics, spaces, and the following punctuation
1312 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / =
1313 May not be null.  If there is an error, returns the error, otherwise returns
1314 false.
1315
1316 =cut
1317
1318 sub ut_text {
1319   my($self,$field)=@_;
1320   #warn "msgcat ". \&msgcat. "\n";
1321   #warn "notexist ". \&notexist. "\n";
1322   #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
1323   $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]+)$/
1324     or return gettext('illegal_or_empty_text'). " $field: ".
1325                $self->getfield($field);
1326   $self->setfield($field,$1);
1327   '';
1328 }
1329
1330 =item ut_textn COLUMN
1331
1332 Check/untaint text.  Alphanumerics, spaces, and the following punctuation
1333 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
1334 May be null.  If there is an error, returns the error, otherwise returns false.
1335
1336 =cut
1337
1338 sub ut_textn {
1339   my($self,$field)=@_;
1340   $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]*)$/
1341     or return gettext('illegal_text'). " $field: ". $self->getfield($field);
1342   $self->setfield($field,$1);
1343   '';
1344 }
1345
1346 =item ut_alpha COLUMN
1347
1348 Check/untaint alphanumeric strings (no spaces).  May not be null.  If there is
1349 an error, returns the error, otherwise returns false.
1350
1351 =cut
1352
1353 sub ut_alpha {
1354   my($self,$field)=@_;
1355   $self->getfield($field) =~ /^(\w+)$/
1356     or return "Illegal or empty (alphanumeric) $field: ".
1357               $self->getfield($field);
1358   $self->setfield($field,$1);
1359   '';
1360 }
1361
1362 =item ut_alpha COLUMN
1363
1364 Check/untaint alphanumeric strings (no spaces).  May be null.  If there is an
1365 error, returns the error, otherwise returns false.
1366
1367 =cut
1368
1369 sub ut_alphan {
1370   my($self,$field)=@_;
1371   $self->getfield($field) =~ /^(\w*)$/
1372     or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
1373   $self->setfield($field,$1);
1374   '';
1375 }
1376
1377 =item ut_phonen COLUMN [ COUNTRY ]
1378
1379 Check/untaint phone numbers.  May be null.  If there is an error, returns
1380 the error, otherwise returns false.
1381
1382 Takes an optional two-letter ISO country code; without it or with unsupported
1383 countries, ut_phonen simply calls ut_alphan.
1384
1385 =cut
1386
1387 sub ut_phonen {
1388   my( $self, $field, $country ) = @_;
1389   return $self->ut_alphan($field) unless defined $country;
1390   my $phonen = $self->getfield($field);
1391   if ( $phonen eq '' ) {
1392     $self->setfield($field,'');
1393   } elsif ( $country eq 'US' || $country eq 'CA' ) {
1394     $phonen =~ s/\D//g;
1395     $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
1396       or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
1397     $phonen = "$1-$2-$3";
1398     $phonen .= " x$4" if $4;
1399     $self->setfield($field,$phonen);
1400   } else {
1401     warn "warning: don't know how to check phone numbers for country $country";
1402     return $self->ut_textn($field);
1403   }
1404   '';
1405 }
1406
1407 =item ut_ip COLUMN
1408
1409 Check/untaint ip addresses.  IPv4 only for now.
1410
1411 =cut
1412
1413 sub ut_ip {
1414   my( $self, $field ) = @_;
1415   $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
1416     or return "Illegal (IP address) $field: ". $self->getfield($field);
1417   for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
1418   $self->setfield($field, "$1.$2.$3.$4");
1419   '';
1420 }
1421
1422 =item ut_ipn COLUMN
1423
1424 Check/untaint ip addresses.  IPv4 only for now.  May be null.
1425
1426 =cut
1427
1428 sub ut_ipn {
1429   my( $self, $field ) = @_;
1430   if ( $self->getfield($field) =~ /^()$/ ) {
1431     $self->setfield($field,'');
1432     '';
1433   } else {
1434     $self->ut_ip($field);
1435   }
1436 }
1437
1438 =item ut_domain COLUMN
1439
1440 Check/untaint host and domain names.
1441
1442 =cut
1443
1444 sub ut_domain {
1445   my( $self, $field ) = @_;
1446   #$self->getfield($field) =~/^(\w+\.)*\w+$/
1447   $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
1448     or return "Illegal (domain) $field: ". $self->getfield($field);
1449   $self->setfield($field,$1);
1450   '';
1451 }
1452
1453 =item ut_name COLUMN
1454
1455 Check/untaint proper names; allows alphanumerics, spaces and the following
1456 punctuation: , . - '
1457
1458 May not be null.
1459
1460 =cut
1461
1462 sub ut_name {
1463   my( $self, $field ) = @_;
1464   $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
1465     or return gettext('illegal_name'). " $field: ". $self->getfield($field);
1466   $self->setfield($field,$1);
1467   '';
1468 }
1469
1470 =item ut_zip COLUMN
1471
1472 Check/untaint zip codes.
1473
1474 =cut
1475
1476 my @zip_reqd_countries = qw( CA ); #US implicit...
1477
1478 sub ut_zip {
1479   my( $self, $field, $country ) = @_;
1480   if ( $country eq 'US' ) {
1481     $self->getfield($field) =~ /\s*(\d{5}(\-\d{4})?)\s*$/
1482       or return gettext('illegal_zip'). " $field for country $country: ".
1483                 $self->getfield($field);
1484     $self->setfield($field,$1);
1485   } else {
1486     if ( $self->getfield($field) =~ /^\s*$/
1487          && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
1488        )
1489     {
1490       $self->setfield($field,'');
1491     } else {
1492       $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
1493         or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
1494       $self->setfield($field,$1);
1495     }
1496   }
1497   '';
1498 }
1499
1500 =item ut_country COLUMN
1501
1502 Check/untaint country codes.  Country names are changed to codes, if possible -
1503 see L<Locale::Country>.
1504
1505 =cut
1506
1507 sub ut_country {
1508   my( $self, $field ) = @_;
1509   unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
1510     if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
1511          && country2code($1) ) {
1512       $self->setfield($field,uc(country2code($1)));
1513     }
1514   }
1515   $self->getfield($field) =~ /^(\w\w)$/
1516     or return "Illegal (country) $field: ". $self->getfield($field);
1517   $self->setfield($field,uc($1));
1518   '';
1519 }
1520
1521 =item ut_anything COLUMN
1522
1523 Untaints arbitrary data.  Be careful.
1524
1525 =cut
1526
1527 sub ut_anything {
1528   my( $self, $field ) = @_;
1529   $self->getfield($field) =~ /^(.*)$/s
1530     or return "Illegal $field: ". $self->getfield($field);
1531   $self->setfield($field,$1);
1532   '';
1533 }
1534
1535 =item ut_enum COLUMN CHOICES_ARRAYREF
1536
1537 Check/untaint a column, supplying all possible choices, like the "enum" type.
1538
1539 =cut
1540
1541 sub ut_enum {
1542   my( $self, $field, $choices ) = @_;
1543   foreach my $choice ( @$choices ) {
1544     if ( $self->getfield($field) eq $choice ) {
1545       $self->setfield($choice);
1546       return '';
1547     }
1548   }
1549   return "Illegal (enum) field $field: ". $self->getfield($field);
1550 }
1551
1552 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1553
1554 Check/untaint a foreign column key.  Call a regular ut_ method (like ut_number)
1555 on the column first.
1556
1557 =cut
1558
1559 sub ut_foreign_key {
1560   my( $self, $field, $table, $foreign ) = @_;
1561   qsearchs($table, { $foreign => $self->getfield($field) })
1562     or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
1563               " in $table.$foreign";
1564   '';
1565 }
1566
1567 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1568
1569 Like ut_foreign_key, except the null value is also allowed.
1570
1571 =cut
1572
1573 sub ut_foreign_keyn {
1574   my( $self, $field, $table, $foreign ) = @_;
1575   $self->getfield($field)
1576     ? $self->ut_foreign_key($field, $table, $foreign)
1577     : '';
1578 }
1579
1580
1581 =item virtual_fields [ TABLE ]
1582
1583 Returns a list of virtual fields defined for the table.  This should not
1584 be exported, and should only be called as an instance or class method.
1585
1586 =cut
1587
1588 sub virtual_fields {
1589   my $self = shift;
1590   my $table;
1591   $table = $self->table or confess "virtual_fields called on non-table";
1592
1593   confess "Unknown table $table" unless dbdef->table($table);
1594
1595   return () unless dbdef->table('part_virtual_field');
1596
1597   unless ( $virtual_fields_cache{$table} ) {
1598     my $query = 'SELECT name from part_virtual_field ' .
1599                 "WHERE dbtable = '$table'";
1600     my $dbh = dbh;
1601     my $result = $dbh->selectcol_arrayref($query);
1602     confess $dbh->errstr if $dbh->err;
1603     $virtual_fields_cache{$table} = $result;
1604   }
1605
1606   @{$virtual_fields_cache{$table}};
1607
1608 }
1609
1610
1611 =item fields [ TABLE ]
1612
1613 This is a wrapper for real_fields and virtual_fields.  Code that called
1614 fields before should probably continue to call fields.
1615
1616 =cut
1617
1618 sub fields {
1619   my $something = shift;
1620   my $table;
1621   if($something->isa('FS::Record')) {
1622     $table = $something->table;
1623   } else {
1624     $table = $something;
1625     $something = "FS::$table";
1626   }
1627   return (real_fields($table), $something->virtual_fields());
1628 }
1629
1630 =back
1631
1632 =item pvf FIELD_NAME
1633
1634 Returns the FS::part_virtual_field object corresponding to a field in the
1635 record (specified by FIELD_NAME).
1636
1637 =cut
1638
1639 sub pvf {
1640   my ($self, $name) = (shift, shift);
1641
1642   if(grep /^$name$/, $self->virtual_fields) {
1643     return qsearchs('part_virtual_field', { dbtable => $self->table,
1644                                             name    => $name } );
1645   }
1646   ''
1647 }
1648
1649 =head1 SUBROUTINES
1650
1651 =over 4
1652
1653 =item real_fields [ TABLE ]
1654
1655 Returns a list of the real columns in the specified table.  Called only by
1656 fields() and other subroutines elsewhere in FS::Record.
1657
1658 =cut
1659
1660 sub real_fields {
1661   my $table = shift;
1662
1663   my($table_obj) = dbdef->table($table);
1664   confess "Unknown table $table" unless $table_obj;
1665   $table_obj->columns;
1666 }
1667
1668 =item _quote VALUE, TABLE, COLUMN
1669
1670 This is an internal function used to construct SQL statements.  It returns
1671 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
1672 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
1673
1674 =cut
1675
1676 sub _quote {
1677   my($value, $table, $column) = @_;
1678   my $column_obj = dbdef->table($table)->column($column);
1679   my $column_type = $column_obj->type;
1680   my $nullable = $column_obj->null;
1681
1682   warn "  $table.$column: $value ($column_type".
1683        ( $nullable ? ' NULL' : ' NOT NULL' ).
1684        ")\n" if $DEBUG > 2;
1685
1686   if ( $value eq '' && $column_type =~ /^int/ ) {
1687     if ( $nullable ) {
1688       'NULL';
1689     } else {
1690       cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
1691             "using 0 instead";
1692       0;
1693     }
1694   } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
1695             ! $column_type =~ /(char|binary|text)$/i ) {
1696     $value;
1697   } else {
1698     dbh->quote($value);
1699   }
1700 }
1701
1702 =item vfieldpart_hashref TABLE
1703
1704 Returns a hashref of virtual field names and vfieldparts applicable to the given
1705 TABLE.
1706
1707 =cut
1708
1709 sub vfieldpart_hashref {
1710   my $self = shift;
1711   my $table = $self->table;
1712
1713   return {} unless dbdef->table('part_virtual_field');
1714
1715   my $dbh = dbh;
1716   my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
1717                   "dbtable = '$table'";
1718   my $sth = $dbh->prepare($statement);
1719   $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
1720   return { map { $_->{name}, $_->{vfieldpart} }
1721     @{$sth->fetchall_arrayref({})} };
1722
1723 }
1724
1725
1726 =item hfields TABLE
1727
1728 This is deprecated.  Don't use it.
1729
1730 It returns a hash-type list with the fields of this record's table set true.
1731
1732 =cut
1733
1734 sub hfields {
1735   carp "warning: hfields is deprecated";
1736   my($table)=@_;
1737   my(%hash);
1738   foreach (fields($table)) {
1739     $hash{$_}=1;
1740   }
1741   \%hash;
1742 }
1743
1744 sub _dump {
1745   my($self)=@_;
1746   join("\n", map {
1747     "$_: ". $self->getfield($_). "|"
1748   } (fields($self->table)) );
1749 }
1750
1751 sub encrypt {
1752   my ($self, $value) = @_;
1753   my $encrypted;
1754
1755   if ($conf->exists('encryption')) {
1756     if ($self->is_encrypted($value)) {
1757       # Return the original value if it isn't plaintext.
1758       $encrypted = $value;
1759     } else {
1760       $self->loadRSA;
1761       if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
1762         # RSA doesn't like the empty string so let's pack it up
1763         # The database doesn't like the RSA data so uuencode it
1764         my $length = length($value)+1;
1765         $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
1766       } else {
1767         die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
1768       }
1769     }
1770   }
1771   return $encrypted;
1772 }
1773
1774 sub is_encrypted {
1775   my ($self, $value) = @_;
1776   # Possible Bug - Some work may be required here....
1777
1778   if (length($value) > 80) {
1779     return 1;
1780   } else {
1781     return 0;
1782   }
1783 }
1784
1785 sub decrypt {
1786   my ($self,$value) = @_;
1787   my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
1788   if ($conf->exists('encryption') && $self->is_encrypted($value)) {
1789     $self->loadRSA;
1790     if (ref($rsa_decrypt) =~ /::RSA/) {
1791       my $encrypted = unpack ("u*", $value);
1792       $decrypted =  unpack("Z*", $rsa_decrypt->decrypt($encrypted));
1793     }
1794   }
1795   return $decrypted;
1796 }
1797
1798 sub loadRSA {
1799     my $self = shift;
1800     #Initialize the Module
1801     $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
1802
1803     if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
1804       $rsa_module = $conf->config('encryptionmodule');
1805     }
1806
1807     if (!$rsa_loaded) {
1808         eval ("require $rsa_module"); # No need to import the namespace
1809         $rsa_loaded++;
1810     }
1811     # Initialize Encryption
1812     if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
1813       my $public_key = join("\n",$conf->config('encryptionpublickey'));
1814       $rsa_encrypt = $rsa_module->new_public_key($public_key);
1815     }
1816
1817     # Intitalize Decryption
1818     if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
1819       my $private_key = join("\n",$conf->config('encryptionprivatekey'));
1820       $rsa_decrypt = $rsa_module->new_private_key($private_key);
1821     }
1822 }
1823
1824 sub DESTROY { return; }
1825
1826 #sub DESTROY {
1827 #  my $self = shift;
1828 #  #use Carp qw(cluck);
1829 #  #cluck "DESTROYING $self";
1830 #  warn "DESTROYING $self";
1831 #}
1832
1833 #sub is_tainted {
1834 #             return ! eval { join('',@_), kill 0; 1; };
1835 #         }
1836
1837 =back
1838
1839 =head1 BUGS
1840
1841 This module should probably be renamed, since much of the functionality is
1842 of general use.  It is not completely unlike Adapter::DBI (see below).
1843
1844 Exported qsearch and qsearchs should be deprecated in favor of method calls
1845 (against an FS::Record object like the old search and searchs that qsearch
1846 and qsearchs were on top of.)
1847
1848 The whole fields / hfields mess should be removed.
1849
1850 The various WHERE clauses should be subroutined.
1851
1852 table string should be deprecated in favor of DBIx::DBSchema::Table.
1853
1854 No doubt we could benefit from a Tied hash.  Documenting how exists / defined
1855 true maps to the database (and WHERE clauses) would also help.
1856
1857 The ut_ methods should ask the dbdef for a default length.
1858
1859 ut_sqltype (like ut_varchar) should all be defined
1860
1861 A fallback check method should be provided which uses the dbdef.
1862
1863 The ut_money method assumes money has two decimal digits.
1864
1865 The Pg money kludge in the new method only strips `$'.
1866
1867 The ut_phonen method only checks US-style phone numbers.
1868
1869 The _quote function should probably use ut_float instead of a regex.
1870
1871 All the subroutines probably should be methods, here or elsewhere.
1872
1873 Probably should borrow/use some dbdef methods where appropriate (like sub
1874 fields)
1875
1876 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
1877 or allow it to be set.  Working around it is ugly any way around - DBI should
1878 be fixed.  (only affects RDBMS which return uppercase column names)
1879
1880 ut_zip should take an optional country like ut_phone.
1881
1882 =head1 SEE ALSO
1883
1884 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
1885
1886 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.
1887
1888 http://poop.sf.net/
1889
1890 =cut
1891
1892 1;
1893