FS/FS/Record.pm

   1 package FS::Record;
   2
   3 use strict;
   4 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
   5              %virtual_fields_cache
   6              $conf $conf_encryption $money_char $lat_lower $lon_upper
   7              $me
   8              $nowarn_identical $nowarn_classload
   9              $no_update_diff $no_check_foreign
  10              @encrypt_payby
  11            );
  12 use Exporter;
  13 use Carp qw(carp cluck croak confess);
  14 use Scalar::Util qw( blessed );
  15 use File::CounterFile;
  16 use Locale::Country;
  17 use Text::CSV_XS;
  18 use File::Slurp qw( slurp );
  19 use DBI qw(:sql_types);
  20 use DBIx::DBSchema 0.38;
  21 use FS::UID qw(dbh datasrc driver_name);
  22 use FS::CurrentUser;
  23 use FS::Schema qw(dbdef);
  24 use FS::SearchCache;
  25 use FS::Msgcat qw(gettext);
  26 use NetAddr::IP; # for validation
  27 use Data::Dumper;
  28 #use FS::Conf; #dependency loop bs, in install_callback below instead
  29
  30 use FS::part_virtual_field;
  31
  32 use Tie::IxHash;
  33
  34 @ISA = qw(Exporter);
  35
  36 @encrypt_payby = qw( CARD DCRD CHEK DCHK );
  37
  38 #export dbdef for now... everything else expects to find it here
  39 @EXPORT_OK = qw(
  40   dbh fields hfields qsearch qsearchs dbdef jsearch
  41   str2time_sql str2time_sql_closing regexp_sql not_regexp_sql concat_sql
  42   midnight_sql
  43 );
  44
  45 $DEBUG = 0;
  46 $me = '[FS::Record]';
  47
  48 $nowarn_identical = 0;
  49 $nowarn_classload = 0;
  50 $no_update_diff = 0;
  51 $no_check_foreign = 0;
  52
  53 my $rsa_module;
  54 my $rsa_loaded;
  55 my $rsa_encrypt;
  56 my $rsa_decrypt;
  57
  58 $conf = '';
  59 $conf_encryption = '';
  60 FS::UID->install_callback( sub {
  61
  62   eval "use FS::Conf;";
  63   die $@ if $@;
  64   $conf = FS::Conf->new;
  65   $conf_encryption = $conf->exists('encryption');
  66   $money_char = $conf->config('money_char') || '$';
  67   my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
  68   $lat_lower = $nw_coords ? 1 : -90;
  69   $lon_upper = $nw_coords ? -1 : 180;
  70
  71   $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
  72
  73   if ( driver_name eq 'Pg' ) {
  74     eval "use DBD::Pg ':pg_types'";
  75     die $@ if $@;
  76   } else {
  77     eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
  78   }
  79
  80 } );
  81
  82 =head1 NAME
  83
  84 FS::Record - Database record objects
  85
  86 =head1 SYNOPSIS
  87
  88     use FS::Record;
  89     use FS::Record qw(dbh fields qsearch qsearchs);
  90
  91     $record = new FS::Record 'table', \%hash;
  92     $record = new FS::Record 'table', { 'column' => 'value', ... };
  93
  94     $record  = qsearchs FS::Record 'table', \%hash;
  95     $record  = qsearchs FS::Record 'table', { 'column' => 'value', ... };
  96     @records = qsearch  FS::Record 'table', \%hash;
  97     @records = qsearch  FS::Record 'table', { 'column' => 'value', ... };
  98
  99     $table = $record->table;
 100     $dbdef_table = $record->dbdef_table;
 101
 102     $value = $record->get('column');
 103     $value = $record->getfield('column');
 104     $value = $record->column;
 105
 106     $record->set( 'column' => 'value' );
 107     $record->setfield( 'column' => 'value' );
 108     $record->column('value');
 109
 110     %hash = $record->hash;
 111
 112     $hashref = $record->hashref;
 113
 114     $error = $record->insert;
 115
 116     $error = $record->delete;
 117
 118     $error = $new_record->replace($old_record);
 119
 120     # external use deprecated - handled by the database (at least for Pg, mysql)
 121     $value = $record->unique('column');
 122
 123     $error = $record->ut_float('column');
 124     $error = $record->ut_floatn('column');
 125     $error = $record->ut_number('column');
 126     $error = $record->ut_numbern('column');
 127     $error = $record->ut_snumber('column');
 128     $error = $record->ut_snumbern('column');
 129     $error = $record->ut_money('column');
 130     $error = $record->ut_text('column');
 131     $error = $record->ut_textn('column');
 132     $error = $record->ut_alpha('column');
 133     $error = $record->ut_alphan('column');
 134     $error = $record->ut_phonen('column');
 135     $error = $record->ut_anything('column');
 136     $error = $record->ut_name('column');
 137
 138     $quoted_value = _quote($value,'table','field');
 139
 140     #deprecated
 141     $fields = hfields('table');
 142     if ( $fields->{Field} ) { # etc.
 143
 144     @fields = fields 'table'; #as a subroutine
 145     @fields = $record->fields; #as a method call
 146
 147
 148 =head1 DESCRIPTION
 149
 150 (Mostly) object-oriented interface to database records.  Records are currently
 151 implemented on top of DBI.  FS::Record is intended as a base class for
 152 table-specific classes to inherit from, i.e. FS::cust_main.
 153
 154 =head1 CONSTRUCTORS
 155
 156 =over 4
 157
 158 =item new [ TABLE, ] HASHREF
 159
 160 Creates a new record.  It doesn't store it in the database, though.  See
 161 L<"insert"> for that.
 162
 163 Note that the object stores this hash reference, not a distinct copy of the
 164 hash it points to.  You can ask the object for a copy with the I<hash>
 165 method.
 166
 167 TABLE can only be omitted when a dervived class overrides the table method.
 168
 169 =cut
 170
 171 sub new {
 172   my $proto = shift;
 173   my $class = ref($proto) || $proto;
 174   my $self = {};
 175   bless ($self, $class);
 176
 177   unless ( defined ( $self->table ) ) {
 178     $self->{'Table'} = shift;
 179     carp "warning: FS::Record::new called with table name ". $self->{'Table'}
 180       unless $nowarn_classload;
 181   }
 182
 183   $self->{'Hash'} = shift;
 184
 185   foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
 186     $self->{'Hash'}{$field}='';
 187   }
 188
 189   $self->_rebless if $self->can('_rebless');
 190
 191   $self->{'modified'} = 0;
 192
 193   $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
 194
 195   $self;
 196 }
 197
 198 sub new_or_cached {
 199   my $proto = shift;
 200   my $class = ref($proto) || $proto;
 201   my $self = {};
 202   bless ($self, $class);
 203
 204   $self->{'Table'} = shift unless defined ( $self->table );
 205
 206   my $hashref = $self->{'Hash'} = shift;
 207   my $cache = shift;
 208   if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
 209     my $obj = $cache->cache->{$hashref->{$cache->key}};
 210     $obj->_cache($hashref, $cache) if $obj->can('_cache');
 211     $obj;
 212   } else {
 213     $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
 214   }
 215
 216 }
 217
 218 sub create {
 219   my $proto = shift;
 220   my $class = ref($proto) || $proto;
 221   my $self = {};
 222   bless ($self, $class);
 223   if ( defined $self->table ) {
 224     cluck "create constructor is deprecated, use new!";
 225     $self->new(@_);
 226   } else {
 227     croak "FS::Record::create called (not from a subclass)!";
 228   }
 229 }
 230
 231 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
 232
 233 Searches the database for all records matching (at least) the key/value pairs
 234 in HASHREF.  Returns all the records found as `FS::TABLE' objects if that
 235 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
 236 objects.
 237
 238 The preferred usage is to pass a hash reference of named parameters:
 239
 240   @records = qsearch( {
 241                         'table'       => 'table_name',
 242                         'hashref'     => { 'field' => 'value'
 243                                            'field' => { 'op'    => '<',
 244                                                         'value' => '420',
 245                                                       },
 246                                          },
 247
 248                         #these are optional...
 249                         'select'      => '*',
 250                         'extra_sql'   => 'AND field = ? AND intfield = ?',
 251                         'extra_param' => [ 'value', [ 5, 'int' ] ],
 252                         'order_by'    => 'ORDER BY something',
 253                         #'cache_obj'   => '', #optional
 254                         'addl_from'   => 'LEFT JOIN othtable USING ( field )',
 255                         'debug'       => 1,
 256                       }
 257                     );
 258
 259 Much code still uses old-style positional parameters, this is also probably
 260 fine in the common case where there are only two parameters:
 261
 262   my @records = qsearch( 'table', { 'field' => 'value' } );
 263
 264 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
 265 the individual PARAMS_HASHREF queries
 266
 267 ###oops, argh, FS::Record::new only lets us create database fields.
 268 #Normal behaviour if SELECT is not specified is `*', as in
 269 #C<SELECT * FROM table WHERE ...>.  However, there is an experimental new
 270 #feature where you can specify SELECT - remember, the objects returned,
 271 #although blessed into the appropriate `FS::TABLE' package, will only have the
 272 #fields you specify.  This might have unwanted results if you then go calling
 273 #regular FS::TABLE methods
 274 #on it.
 275
 276 =cut
 277
 278 my %TYPE = (); #for debugging
 279
 280 sub _bind_type {
 281   my($type, $value) = @_;
 282
 283   my $bind_type = { TYPE => SQL_VARCHAR };
 284
 285   if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
 286
 287     $bind_type = { TYPE => SQL_INTEGER };
 288
 289   } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
 290
 291     if ( driver_name eq 'Pg' ) {
 292       no strict 'subs';
 293       $bind_type = { pg_type => PG_BYTEA };
 294     #} else {
 295     #  $bind_type = ? #SQL_VARCHAR could be fine?
 296     }
 297
 298   #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
 299   #fixed by DBD::Pg 2.11.8
 300   #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
 301   #(make a Tron test first)
 302   } elsif ( _is_fs_float( $type, $value ) ) {
 303
 304     $bind_type = { TYPE => SQL_DECIMAL };
 305
 306   }
 307
 308   $bind_type;
 309
 310 }
 311
 312 sub _is_fs_float {
 313   my($type, $value) = @_;
 314   if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
 315        ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
 316      ) {
 317     return 1;
 318   }
 319   '';
 320 }
 321
 322 sub qsearch {
 323   my( @stable, @record, @cache );
 324   my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
 325   my @debug = ();
 326   my %union_options = ();
 327   if ( ref($_[0]) eq 'ARRAY' ) {
 328     my $optlist = shift;
 329     %union_options = @_;
 330     foreach my $href ( @$optlist ) {
 331       push @stable,      ( $href->{'table'} or die "table name is required" );
 332       push @record,      ( $href->{'hashref'}     || {} );
 333       push @select,      ( $href->{'select'}      || '*' );
 334       push @extra_sql,   ( $href->{'extra_sql'}   || '' );
 335       push @extra_param, ( $href->{'extra_param'} || [] );
 336       push @order_by,    ( $href->{'order_by'}    || '' );
 337       push @cache,       ( $href->{'cache_obj'}   || '' );
 338       push @addl_from,   ( $href->{'addl_from'}   || '' );
 339       push @debug,       ( $href->{'debug'}       || '' );
 340     }
 341     die "at least one hashref is required" unless scalar(@stable);
 342   } elsif ( ref($_[0]) eq 'HASH' ) {
 343     my $opt = shift;
 344     $stable[0]      = $opt->{'table'}       or die "table name is required";
 345     $record[0]      = $opt->{'hashref'}     || {};
 346     $select[0]      = $opt->{'select'}      || '*';
 347     $extra_sql[0]   = $opt->{'extra_sql'}   || '';
 348     $extra_param[0] = $opt->{'extra_param'} || [];
 349     $order_by[0]    = $opt->{'order_by'}    || '';
 350     $cache[0]       = $opt->{'cache_obj'}   || '';
 351     $addl_from[0]   = $opt->{'addl_from'}   || '';
 352     $debug[0]       = $opt->{'debug'}       || '';
 353   } else {
 354     ( $stable[0],
 355       $record[0],
 356       $select[0],
 357       $extra_sql[0],
 358       $cache[0],
 359       $addl_from[0]
 360     ) = @_;
 361     $select[0] ||= '*';
 362   }
 363   my $cache = $cache[0];
 364
 365   my @statement = ();
 366   my @value = ();
 367   my @bind_type = ();
 368   my $dbh = dbh;
 369   foreach my $stable ( @stable ) {
 370     #stop altering the caller's hashref
 371     my $record      = { %{ shift(@record) || {} } };#and be liberal in receipt
 372     my $select      = shift @select;
 373     my $extra_sql   = shift @extra_sql;
 374     my $extra_param = shift @extra_param;
 375     my $order_by    = shift @order_by;
 376     my $cache       = shift @cache;
 377     my $addl_from   = shift @addl_from;
 378     my $debug       = shift @debug;
 379
 380     #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
 381     #for jsearch
 382     $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
 383     $stable = $1;
 384
 385     my $table = $cache ? $cache->table : $stable;
 386     my $dbdef_table = dbdef->table($table)
 387       or die "No schema for table $table found - ".
 388              "do you need to run freeside-upgrade?";
 389     my $pkey = $dbdef_table->primary_key;
 390
 391     my @real_fields = grep exists($record->{$_}), real_fields($table);
 392
 393     my $statement .= "SELECT $select FROM $stable";
 394     $statement .= " $addl_from" if $addl_from;
 395     if ( @real_fields ) {
 396       $statement .= ' WHERE '. join(' AND ',
 397         get_real_fields($table, $record, \@real_fields));
 398     }
 399
 400     $statement .= " $extra_sql" if defined($extra_sql);
 401     $statement .= " $order_by"  if defined($order_by);
 402
 403     push @statement, $statement;
 404
 405     warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
 406
 407
 408     foreach my $field (
 409       grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
 410     ) {
 411
 412       my $value = $record->{$field};
 413       my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
 414       $value = $value->{'value'} if ref($value);
 415       my $type = dbdef->table($table)->column($field)->type;
 416
 417       my $bind_type = _bind_type($type, $value);
 418
 419       #if ( $DEBUG > 2 ) {
 420       #  no strict 'refs';
 421       #  %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
 422       #    unless keys %TYPE;
 423       #  warn "  bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
 424       #}
 425
 426       push @value, $value;
 427       push @bind_type, $bind_type;
 428
 429     }
 430
 431     foreach my $param ( @$extra_param ) {
 432       my $bind_type = { TYPE => SQL_VARCHAR };
 433       my $value = $param;
 434       if ( ref($param) ) {
 435         $value = $param->[0];
 436         my $type = $param->[1];
 437         $bind_type = _bind_type($type, $value);
 438       }
 439       push @value, $value;
 440       push @bind_type, $bind_type;
 441     }
 442   }
 443
 444   my $statement = join( ' ) UNION ( ', @statement );
 445   $statement = "( $statement )" if scalar(@statement) > 1;
 446   $statement .= " $union_options{order_by}" if $union_options{order_by};
 447
 448   my $sth = $dbh->prepare($statement)
 449     or croak "$dbh->errstr doing $statement";
 450
 451   my $bind = 1;
 452   foreach my $value ( @value ) {
 453     my $bind_type = shift @bind_type;
 454     $sth->bind_param($bind++, $value, $bind_type );
 455   }
 456
 457 #  $sth->execute( map $record->{$_},
 458 #    grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
 459 #  ) or croak "Error executing \"$statement\": ". $sth->errstr;
 460
 461   $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
 462
 463   my $table = $stable[0];
 464   my $pkey = '';
 465   $table = '' if grep { $_ ne $table } @stable;
 466   $pkey = dbdef->table($table)->primary_key if $table;
 467
 468   my %result;
 469   tie %result, "Tie::IxHash";
 470   my @stuff = @{ $sth->fetchall_arrayref( {} ) };
 471   if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
 472     %result = map { $_->{$pkey}, $_ } @stuff;
 473   } else {
 474     @result{@stuff} = @stuff;
 475   }
 476
 477   $sth->finish;
 478
 479   my @return;
 480   if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
 481     if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
 482       #derivied class didn't override new method, so this optimization is safe
 483       if ( $cache ) {
 484         @return = map {
 485           new_or_cached( "FS::$table", { %{$_} }, $cache )
 486         } values(%result);
 487       } else {
 488         @return = map {
 489           new( "FS::$table", { %{$_} } )
 490         } values(%result);
 491       }
 492     } else {
 493       #okay, its been tested
 494       # warn "untested code (class FS::$table uses custom new method)";
 495       @return = map {
 496         eval 'FS::'. $table. '->new( { %{$_} } )';
 497       } values(%result);
 498     }
 499
 500     # Check for encrypted fields and decrypt them.
 501    ## only in the local copy, not the cached object
 502     if ( $conf_encryption
 503          && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
 504       foreach my $record (@return) {
 505         foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
 506           next if $field eq 'payinfo'
 507                     && ($record->isa('FS::payinfo_transaction_Mixin')
 508                         || $record->isa('FS::payinfo_Mixin') )
 509                     && $record->payby
 510                     && !grep { $record->payby eq $_ } @encrypt_payby;
 511           # Set it directly... This may cause a problem in the future...
 512           $record->setfield($field, $record->decrypt($record->getfield($field)));
 513         }
 514       }
 515     }
 516   } else {
 517     cluck "warning: FS::$table not loaded; returning FS::Record objects"
 518       unless $nowarn_classload;
 519     @return = map {
 520       FS::Record->new( $table, { %{$_} } );
 521     } values(%result);
 522   }
 523   return @return;
 524 }
 525
 526 ## makes this easier to read
 527
 528 sub get_real_fields {
 529   my $table = shift;
 530   my $record = shift;
 531   my $real_fields = shift;
 532
 533    ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
 534       return (
 535       map {
 536
 537       my $op = '=';
 538       my $column = $_;
 539       my $type = dbdef->table($table)->column($column)->type;
 540       my $value = $record->{$column};
 541       $value = $value->{'value'} if ref($value);
 542       if ( ref($record->{$_}) ) {
 543         $op = $record->{$_}{'op'} if $record->{$_}{'op'};
 544         #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
 545         if ( uc($op) eq 'ILIKE' ) {
 546           $op = 'LIKE';
 547           $record->{$_}{'value'} = lc($record->{$_}{'value'});
 548           $column = "LOWER($_)";
 549         }
 550         $record->{$_} = $record->{$_}{'value'}
 551       }
 552
 553       if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
 554         if ( $op eq '=' ) {
 555           if ( driver_name eq 'Pg' ) {
 556             if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
 557               qq-( $column IS NULL )-;
 558             } else {
 559               qq-( $column IS NULL OR $column = '' )-;
 560             }
 561           } else {
 562             qq-( $column IS NULL OR $column = "" )-;
 563           }
 564         } elsif ( $op eq '!=' ) {
 565           if ( driver_name eq 'Pg' ) {
 566             if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
 567               qq-( $column IS NOT NULL )-;
 568             } else {
 569               qq-( $column IS NOT NULL AND $column != '' )-;
 570             }
 571           } else {
 572             qq-( $column IS NOT NULL AND $column != "" )-;
 573           }
 574         } else {
 575           if ( driver_name eq 'Pg' ) {
 576             qq-( $column $op '' )-;
 577           } else {
 578             qq-( $column $op "" )-;
 579           }
 580         }
 581       } elsif ( $op eq '!=' ) {
 582         qq-( $column IS NULL OR $column != ? )-;
 583       #if this needs to be re-enabled, it needs to use a custom op like
 584       #"APPROX=" or something (better name?, not '=', to avoid affecting other
 585       # searches
 586       #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
 587       #  ( "$column <= ?", "$column >= ?" );
 588       } else {
 589         "$column $op ?";
 590       }
 591     } @{ $real_fields } );
 592 }
 593
 594 =item by_key PRIMARY_KEY_VALUE
 595
 596 This is a class method that returns the record with the given primary key
 597 value.  This method is only useful in FS::Record subclasses.  For example:
 598
 599   my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
 600
 601 is equivalent to:
 602
 603   my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
 604
 605 =cut
 606
 607 sub by_key {
 608   my ($class, $pkey_value) = @_;
 609
 610   my $table = $class->table
 611     or croak "No table for $class found";
 612
 613   my $dbdef_table = dbdef->table($table)
 614     or die "No schema for table $table found - ".
 615            "do you need to create it or run dbdef-create?";
 616   my $pkey = $dbdef_table->primary_key
 617     or die "No primary key for table $table";
 618
 619   return qsearchs($table, { $pkey => $pkey_value });
 620 }
 621
 622 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
 623
 624 Experimental JOINed search method.  Using this method, you can execute a
 625 single SELECT spanning multiple tables, and cache the results for subsequent
 626 method calls.  Interface will almost definately change in an incompatible
 627 fashion.
 628
 629 Arguments:
 630
 631 =cut
 632
 633 sub jsearch {
 634   my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
 635   my $cache = FS::SearchCache->new( $ptable, $pkey );
 636   my %saw;
 637   ( $cache,
 638     grep { !$saw{$_->getfield($pkey)}++ }
 639       qsearch($table, $record, $select, $extra_sql, $cache )
 640   );
 641 }
 642
 643 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
 644
 645 Same as qsearch, except that if more than one record matches, it B<carp>s but
 646 returns the first.  If this happens, you either made a logic error in asking
 647 for a single item, or your data is corrupted.
 648
 649 =cut
 650
 651 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
 652   my $table = $_[0];
 653   my(@result) = qsearch(@_);
 654   cluck "warning: Multiple records in scalar search ($table)"
 655     if scalar(@result) > 1;
 656   #should warn more vehemently if the search was on a primary key?
 657   scalar(@result) ? ($result[0]) : ();
 658 }
 659
 660 =back
 661
 662 =head1 METHODS
 663
 664 =over 4
 665
 666 =item table
 667
 668 Returns the table name.
 669
 670 =cut
 671
 672 sub table {
 673 #  cluck "warning: FS::Record::table deprecated; supply one in subclass!";
 674   my $self = shift;
 675   $self -> {'Table'};
 676 }
 677
 678 =item dbdef_table
 679
 680 Returns the DBIx::DBSchema::Table object for the table.
 681
 682 =cut
 683
 684 sub dbdef_table {
 685   my($self)=@_;
 686   my($table)=$self->table;
 687   dbdef->table($table);
 688 }
 689
 690 =item primary_key
 691
 692 Returns the primary key for the table.
 693
 694 =cut
 695
 696 sub primary_key {
 697   my $self = shift;
 698   my $pkey = $self->dbdef_table->primary_key;
 699 }
 700
 701 =item get, getfield COLUMN
 702
 703 Returns the value of the column/field/key COLUMN.
 704
 705 =cut
 706
 707 sub get {
 708   my($self,$field) = @_;
 709   # to avoid "Use of unitialized value" errors
 710   if ( defined ( $self->{Hash}->{$field} ) ) {
 711     $self->{Hash}->{$field};
 712   } else {
 713     '';
 714   }
 715 }
 716 sub getfield {
 717   my $self = shift;
 718   $self->get(@_);
 719 }
 720
 721 =item set, setfield COLUMN, VALUE
 722
 723 Sets the value of the column/field/key COLUMN to VALUE.  Returns VALUE.
 724
 725 =cut
 726
 727 sub set {
 728   my($self,$field,$value) = @_;
 729   $self->{'modified'} = 1;
 730   $self->{'Hash'}->{$field} = $value;
 731 }
 732 sub setfield {
 733   my $self = shift;
 734   $self->set(@_);
 735 }
 736
 737 =item exists COLUMN
 738
 739 Returns true if the column/field/key COLUMN exists.
 740
 741 =cut
 742
 743 sub exists {
 744   my($self,$field) = @_;
 745   exists($self->{Hash}->{$field});
 746 }
 747
 748 =item AUTLOADED METHODS
 749
 750 $record->column is a synonym for $record->get('column');
 751
 752 $record->column('value') is a synonym for $record->set('column','value');
 753
 754 =cut
 755
 756 # readable/safe
 757 sub AUTOLOAD {
 758   my($self,$value)=@_;
 759   my($field)=$AUTOLOAD;
 760   $field =~ s/.*://;
 761   if ( defined($value) ) {
 762     confess "errant AUTOLOAD $field for $self (arg $value)"
 763       unless blessed($self) && $self->can('setfield');
 764     $self->setfield($field,$value);
 765   } else {
 766     confess "errant AUTOLOAD $field for $self (no args)"
 767       unless blessed($self) && $self->can('getfield');
 768     $self->getfield($field);
 769   }
 770 }
 771
 772 # efficient
 773 #sub AUTOLOAD {
 774 #  my $field = $AUTOLOAD;
 775 #  $field =~ s/.*://;
 776 #  if ( defined($_[1]) ) {
 777 #    $_[0]->setfield($field, $_[1]);
 778 #  } else {
 779 #    $_[0]->getfield($field);
 780 #  }
 781 #}
 782
 783 =item hash
 784
 785 Returns a list of the column/value pairs, usually for assigning to a new hash.
 786
 787 To make a distinct duplicate of an FS::Record object, you can do:
 788
 789     $new = new FS::Record ( $old->table, { $old->hash } );
 790
 791 =cut
 792
 793 sub hash {
 794   my($self) = @_;
 795   confess $self. ' -> hash: Hash attribute is undefined'
 796     unless defined($self->{'Hash'});
 797   %{ $self->{'Hash'} };
 798 }
 799
 800 =item hashref
 801
 802 Returns a reference to the column/value hash.  This may be deprecated in the
 803 future; if there's a reason you can't just use the autoloaded or get/set
 804 methods, speak up.
 805
 806 =cut
 807
 808 sub hashref {
 809   my($self) = @_;
 810   $self->{'Hash'};
 811 }
 812
 813 =item modified
 814
 815 Returns true if any of this object's values have been modified with set (or via
 816 an autoloaded method).  Doesn't yet recognize when you retreive a hashref and
 817 modify that.
 818
 819 =cut
 820
 821 sub modified {
 822   my $self = shift;
 823   $self->{'modified'};
 824 }
 825
 826 =item select_for_update
 827
 828 Selects this record with the SQL "FOR UPDATE" command.  This can be useful as
 829 a mutex.
 830
 831 =cut
 832
 833 sub select_for_update {
 834   my $self = shift;
 835   my $primary_key = $self->primary_key;
 836   qsearchs( {
 837     'select'    => '*',
 838     'table'     => $self->table,
 839     'hashref'   => { $primary_key => $self->$primary_key() },
 840     'extra_sql' => 'FOR UPDATE',
 841   } );
 842 }
 843
 844 =item lock_table
 845
 846 Locks this table with a database-driver specific lock method.  This is used
 847 as a mutex in order to do a duplicate search.
 848
 849 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
 850
 851 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
 852
 853 Errors are fatal; no useful return value.
 854
 855 Note: To use this method for new tables other than svc_acct and svc_phone,
 856 edit freeside-upgrade and add those tables to the duplicate_lock list.
 857
 858 =cut
 859
 860 sub lock_table {
 861   my $self = shift;
 862   my $table = $self->table;
 863
 864   warn "$me locking $table table\n" if $DEBUG;
 865
 866   if ( driver_name =~ /^Pg/i ) {
 867
 868     dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
 869       or die dbh->errstr;
 870
 871   } elsif ( driver_name =~ /^mysql/i ) {
 872
 873     dbh->do("SELECT * FROM duplicate_lock
 874                WHERE lockname = '$table'
 875                FOR UPDATE"
 876            ) or die dbh->errstr;
 877
 878   } else {
 879
 880     die "unknown database ". driver_name. "; don't know how to lock table";
 881
 882   }
 883
 884   warn "$me acquired $table table lock\n" if $DEBUG;
 885
 886 }
 887
 888 =item insert
 889
 890 Inserts this record to the database.  If there is an error, returns the error,
 891 otherwise returns false.
 892
 893 =cut
 894
 895 sub insert {
 896   my $self = shift;
 897   my $saved = {};
 898
 899   warn "$self -> insert" if $DEBUG;
 900
 901   my $error = $self->check;
 902   return $error if $error;
 903
 904   #single-field non-null unique keys are given a value if empty
 905   #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
 906   foreach ( $self->dbdef_table->unique_singles) {
 907     next if $self->getfield($_);
 908     next if $self->dbdef_table->column($_)->null eq 'NULL';
 909     $self->unique($_);
 910   }
 911
 912   #and also the primary key, if the database isn't going to
 913   my $primary_key = $self->dbdef_table->primary_key;
 914   my $db_seq = 0;
 915   if ( $primary_key ) {
 916     my $col = $self->dbdef_table->column($primary_key);
 917
 918     $db_seq =
 919       uc($col->type) =~ /^(BIG)?SERIAL\d?/
 920       || ( driver_name eq 'Pg'
 921              && defined($col->default)
 922              && $col->quoted_default =~ /^nextval\(/i
 923          )
 924       || ( driver_name eq 'mysql'
 925              && defined($col->local)
 926              && $col->local =~ /AUTO_INCREMENT/i
 927          );
 928     $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
 929   }
 930
 931   my $table = $self->table;
 932
 933   # Encrypt before the database
 934   if (    defined(eval '@FS::'. $table . '::encrypted_fields')
 935        && scalar( eval '@FS::'. $table . '::encrypted_fields')
 936        && $conf->exists('encryption')
 937   ) {
 938     foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
 939       next if $field eq 'payinfo'
 940                 && ($self->isa('FS::payinfo_transaction_Mixin')
 941                     || $self->isa('FS::payinfo_Mixin') )
 942                 && $self->payby
 943                 && !grep { $self->payby eq $_ } @encrypt_payby;
 944       $saved->{$field} = $self->getfield($field);
 945       $self->setfield($field, $self->encrypt($self->getfield($field)));
 946     }
 947   }
 948
 949   #false laziness w/delete
 950   my @real_fields =
 951     grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
 952     real_fields($table)
 953   ;
 954   my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
 955   #eslaf
 956
 957   my $statement = "INSERT INTO $table ";
 958   if ( @real_fields ) {
 959     $statement .=
 960       "( ".
 961         join( ', ', @real_fields ).
 962       ") VALUES (".
 963         join( ', ', @values ).
 964        ")"
 965     ;
 966   } else {
 967     $statement .= 'DEFAULT VALUES';
 968   }
 969   warn "[debug]$me $statement\n" if $DEBUG > 1;
 970   my $sth = dbh->prepare($statement) or return dbh->errstr;
 971
 972   local $SIG{HUP} = 'IGNORE';
 973   local $SIG{INT} = 'IGNORE';
 974   local $SIG{QUIT} = 'IGNORE';
 975   local $SIG{TERM} = 'IGNORE';
 976   local $SIG{TSTP} = 'IGNORE';
 977   local $SIG{PIPE} = 'IGNORE';
 978
 979   $sth->execute or return $sth->errstr;
 980
 981   # get inserted id from the database, if applicable & needed
 982   if ( $db_seq && ! $self->getfield($primary_key) ) {
 983     warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
 984
 985     my $insertid = '';
 986
 987     if ( driver_name eq 'Pg' ) {
 988
 989       #my $oid = $sth->{'pg_oid_status'};
 990       #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
 991
 992       my $default = $self->dbdef_table->column($primary_key)->quoted_default;
 993       unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
 994         dbh->rollback if $FS::UID::AutoCommit;
 995         return "can't parse $table.$primary_key default value".
 996                " for sequence name: $default";
 997       }
 998       my $sequence = $1;
 999
1000       my $i_sql = "SELECT currval('$sequence')";
1001       my $i_sth = dbh->prepare($i_sql) or do {
1002         dbh->rollback if $FS::UID::AutoCommit;
1003         return dbh->errstr;
1004       };
1005       $i_sth->execute() or do { #$i_sth->execute($oid)
1006         dbh->rollback if $FS::UID::AutoCommit;
1007         return $i_sth->errstr;
1008       };
1009       $insertid = $i_sth->fetchrow_arrayref->[0];
1010
1011     } elsif ( driver_name eq 'mysql' ) {
1012
1013       $insertid = dbh->{'mysql_insertid'};
1014       # work around mysql_insertid being null some of the time, ala RT :/
1015       unless ( $insertid ) {
1016         warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1017              "using SELECT LAST_INSERT_ID();";
1018         my $i_sql = "SELECT LAST_INSERT_ID()";
1019         my $i_sth = dbh->prepare($i_sql) or do {
1020           dbh->rollback if $FS::UID::AutoCommit;
1021           return dbh->errstr;
1022         };
1023         $i_sth->execute or do {
1024           dbh->rollback if $FS::UID::AutoCommit;
1025           return $i_sth->errstr;
1026         };
1027         $insertid = $i_sth->fetchrow_arrayref->[0];
1028       }
1029
1030     } else {
1031
1032       dbh->rollback if $FS::UID::AutoCommit;
1033       return "don't know how to retreive inserted ids from ". driver_name.
1034              ", try using counterfiles (maybe run dbdef-create?)";
1035
1036     }
1037
1038     $self->setfield($primary_key, $insertid);
1039
1040   }
1041
1042   my $h_sth;
1043   if ( defined dbdef->table('h_'. $table) ) {
1044     my $h_statement = $self->_h_statement('insert');
1045     warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1046     $h_sth = dbh->prepare($h_statement) or do {
1047       dbh->rollback if $FS::UID::AutoCommit;
1048       return dbh->errstr;
1049     };
1050   } else {
1051     $h_sth = '';
1052   }
1053   $h_sth->execute or return $h_sth->errstr if $h_sth;
1054
1055   dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1056
1057   # Now that it has been saved, reset the encrypted fields so that $new
1058   # can still be used.
1059   foreach my $field (keys %{$saved}) {
1060     $self->setfield($field, $saved->{$field});
1061   }
1062
1063   '';
1064 }
1065
1066 =item add
1067
1068 Depriciated (use insert instead).
1069
1070 =cut
1071
1072 sub add {
1073   cluck "warning: FS::Record::add deprecated!";
1074   insert @_; #call method in this scope
1075 }
1076
1077 =item delete
1078
1079 Delete this record from the database.  If there is an error, returns the error,
1080 otherwise returns false.
1081
1082 =cut
1083
1084 sub delete {
1085   my $self = shift;
1086
1087   my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1088     map {
1089       $self->getfield($_) eq ''
1090         #? "( $_ IS NULL OR $_ = \"\" )"
1091         ? ( driver_name eq 'Pg'
1092               ? "$_ IS NULL"
1093               : "( $_ IS NULL OR $_ = \"\" )"
1094           )
1095         : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1096     } ( $self->dbdef_table->primary_key )
1097           ? ( $self->dbdef_table->primary_key)
1098           : real_fields($self->table)
1099   );
1100   warn "[debug]$me $statement\n" if $DEBUG > 1;
1101   my $sth = dbh->prepare($statement) or return dbh->errstr;
1102
1103   my $h_sth;
1104   if ( defined dbdef->table('h_'. $self->table) ) {
1105     my $h_statement = $self->_h_statement('delete');
1106     warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1107     $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1108   } else {
1109     $h_sth = '';
1110   }
1111
1112   my $primary_key = $self->dbdef_table->primary_key;
1113
1114   local $SIG{HUP} = 'IGNORE';
1115   local $SIG{INT} = 'IGNORE';
1116   local $SIG{QUIT} = 'IGNORE';
1117   local $SIG{TERM} = 'IGNORE';
1118   local $SIG{TSTP} = 'IGNORE';
1119   local $SIG{PIPE} = 'IGNORE';
1120
1121   my $rc = $sth->execute or return $sth->errstr;
1122   #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1123   $h_sth->execute or return $h_sth->errstr if $h_sth;
1124
1125   dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1126
1127   #no need to needlessly destoy the data either (causes problems actually)
1128   #undef $self; #no need to keep object!
1129
1130   '';
1131 }
1132
1133 =item del
1134
1135 Depriciated (use delete instead).
1136
1137 =cut
1138
1139 sub del {
1140   cluck "warning: FS::Record::del deprecated!";
1141   &delete(@_); #call method in this scope
1142 }
1143
1144 =item replace OLD_RECORD
1145
1146 Replace the OLD_RECORD with this one in the database.  If there is an error,
1147 returns the error, otherwise returns false.
1148
1149 =cut
1150
1151 sub replace {
1152   my ($new, $old) = (shift, shift);
1153
1154   $old = $new->replace_old unless defined($old);
1155
1156   warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1157
1158   if ( $new->can('replace_check') ) {
1159     my $error = $new->replace_check($old);
1160     return $error if $error;
1161   }
1162
1163   return "Records not in same table!" unless $new->table eq $old->table;
1164
1165   my $primary_key = $old->dbdef_table->primary_key;
1166   return "Can't change primary key $primary_key ".
1167          'from '. $old->getfield($primary_key).
1168          ' to ' . $new->getfield($primary_key)
1169     if $primary_key
1170        && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1171
1172   my $error = $new->check;
1173   return $error if $error;
1174
1175   # Encrypt for replace
1176   my $saved = {};
1177   if (    $conf->exists('encryption')
1178        && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1179        && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1180   ) {
1181     foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1182       next if $field eq 'payinfo'
1183                 && ($new->isa('FS::payinfo_transaction_Mixin')
1184                     || $new->isa('FS::payinfo_Mixin') )
1185                 && $new->payby
1186                 && !grep { $new->payby eq $_ } @encrypt_payby;
1187       $saved->{$field} = $new->getfield($field);
1188       $new->setfield($field, $new->encrypt($new->getfield($field)));
1189     }
1190   }
1191
1192   #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1193   my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1194                    ? ($_, $new->getfield($_)) : () } $old->fields;
1195
1196   unless (keys(%diff) || $no_update_diff ) {
1197     carp "[warning]$me ". ref($new)."->replace ".
1198            ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1199          ": records identical"
1200       unless $nowarn_identical;
1201     return '';
1202   }
1203
1204   my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1205     map {
1206       "$_ = ". _quote($new->getfield($_),$old->table,$_)
1207     } real_fields($old->table)
1208   ). ' WHERE '.
1209     join(' AND ',
1210       map {
1211
1212         if ( $old->getfield($_) eq '' ) {
1213
1214          #false laziness w/qsearch
1215          if ( driver_name eq 'Pg' ) {
1216             my $type = $old->dbdef_table->column($_)->type;
1217             if ( $type =~ /(int|(big)?serial)/i ) {
1218               qq-( $_ IS NULL )-;
1219             } else {
1220               qq-( $_ IS NULL OR $_ = '' )-;
1221             }
1222           } else {
1223             qq-( $_ IS NULL OR $_ = "" )-;
1224           }
1225
1226         } else {
1227           "$_ = ". _quote($old->getfield($_),$old->table,$_);
1228         }
1229
1230       } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1231     )
1232   ;
1233   warn "[debug]$me $statement\n" if $DEBUG > 1;
1234   my $sth = dbh->prepare($statement) or return dbh->errstr;
1235
1236   my $h_old_sth;
1237   if ( defined dbdef->table('h_'. $old->table) ) {
1238     my $h_old_statement = $old->_h_statement('replace_old');
1239     warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1240     $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1241   } else {
1242     $h_old_sth = '';
1243   }
1244
1245   my $h_new_sth;
1246   if ( defined dbdef->table('h_'. $new->table) ) {
1247     my $h_new_statement = $new->_h_statement('replace_new');
1248     warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1249     $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1250   } else {
1251     $h_new_sth = '';
1252   }
1253
1254   local $SIG{HUP} = 'IGNORE';
1255   local $SIG{INT} = 'IGNORE';
1256   local $SIG{QUIT} = 'IGNORE';
1257   local $SIG{TERM} = 'IGNORE';
1258   local $SIG{TSTP} = 'IGNORE';
1259   local $SIG{PIPE} = 'IGNORE';
1260
1261   my $rc = $sth->execute or return $sth->errstr;
1262   #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1263   $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1264   $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1265
1266   dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1267
1268   # Now that it has been saved, reset the encrypted fields so that $new
1269   # can still be used.
1270   foreach my $field (keys %{$saved}) {
1271     $new->setfield($field, $saved->{$field});
1272   }
1273
1274   '';
1275
1276 }
1277
1278 sub replace_old {
1279   my( $self ) = shift;
1280   warn "[$me] replace called with no arguments; autoloading old record\n"
1281     if $DEBUG;
1282
1283   my $primary_key = $self->dbdef_table->primary_key;
1284   if ( $primary_key ) {
1285     $self->by_key( $self->$primary_key() ) #this is what's returned
1286       or croak "can't find ". $self->table. ".$primary_key ".
1287         $self->$primary_key();
1288   } else {
1289     croak $self->table. " has no primary key; pass old record as argument";
1290   }
1291
1292 }
1293
1294 =item rep
1295
1296 Depriciated (use replace instead).
1297
1298 =cut
1299
1300 sub rep {
1301   cluck "warning: FS::Record::rep deprecated!";
1302   replace @_; #call method in this scope
1303 }
1304
1305 =item check
1306
1307 Checks custom fields. Subclasses should still provide a check method to validate
1308 non-custom fields, foreign keys, etc., and call this method via $self->SUPER::check.
1309
1310 =cut
1311
1312 sub check {
1313     my $self = shift;
1314     foreach my $field ($self->virtual_fields) {
1315         my $error = $self->ut_textn($field);
1316         return $error if $error;
1317     }
1318     '';
1319 }
1320
1321 =item virtual_fields [ TABLE ]
1322
1323 Returns a list of virtual fields defined for the table.  This should not
1324 be exported, and should only be called as an instance or class method.
1325
1326 =cut
1327
1328 sub virtual_fields {
1329   my $self = shift;
1330   my $table;
1331   $table = $self->table or confess "virtual_fields called on non-table";
1332
1333   confess "Unknown table $table" unless dbdef->table($table);
1334
1335   return () unless dbdef->table('part_virtual_field');
1336
1337   unless ( $virtual_fields_cache{$table} ) {
1338     my $concat = [ "'cf_'", "name" ];
1339     my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1340                 "WHERE dbtable = '$table'";
1341     my $dbh = dbh;
1342     my $result = $dbh->selectcol_arrayref($query);
1343     confess "Error executing virtual fields query: $query: ". $dbh->errstr
1344       if $dbh->err;
1345     $virtual_fields_cache{$table} = $result;
1346   }
1347
1348   @{$virtual_fields_cache{$table}};
1349
1350 }
1351
1352 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1353
1354 Processes a batch import as a queued JSRPC job
1355
1356 JOB is an FS::queue entry.
1357
1358 OPTIONS_HASHREF can have the following keys:
1359
1360 =over 4
1361
1362 =item table
1363
1364 Table name (required).
1365
1366 =item params
1367
1368 Listref of field names for static fields.  They will be given values from the
1369 PARAMS hashref and passed as a "params" hashref to batch_import.
1370
1371 =item formats
1372
1373 Formats hashref.  Keys are field names, values are listrefs that define the
1374 format.
1375
1376 Each listref value can be a column name or a code reference.  Coderefs are run
1377 with the row object, data and a FS::Conf object as the three parameters.
1378 For example, this coderef does the same thing as using the "columnname" string:
1379
1380   sub {
1381     my( $record, $data, $conf ) = @_;
1382     $record->columnname( $data );
1383   },
1384
1385 Coderefs are run after all "column name" fields are assigned.
1386
1387 =item format_types
1388
1389 Optional format hashref of types.  Keys are field names, values are "csv",
1390 "xls" or "fixedlength".  Overrides automatic determination of file type
1391 from extension.
1392
1393 =item format_headers
1394
1395 Optional format hashref of header lines.  Keys are field names, values are 0
1396 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1397 number of lines.
1398
1399 =item format_sep_chars
1400
1401 Optional format hashref of CSV sep_chars.  Keys are field names, values are the
1402 CSV separation character.
1403
1404 =item format_fixedlenth_formats
1405
1406 Optional format hashref of fixed length format defintiions.  Keys are field
1407 names, values Parse::FixedLength listrefs of field definitions.
1408
1409 =item default_csv
1410
1411 Set true to default to CSV file type if the filename does not contain a
1412 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1413 format_types).
1414
1415 =back
1416
1417 PARAMS is a base64-encoded Storable string containing the POSTed data as
1418 a hash ref.  It normally contains at least one field, "uploaded files",
1419 generated by /elements/file-upload.html and containing the list of uploaded
1420 files.  Currently only supports a single file named "file".
1421
1422 =cut
1423
1424 use Storable qw(thaw);
1425 use Data::Dumper;
1426 use MIME::Base64;
1427 sub process_batch_import {
1428   my($job, $opt) = ( shift, shift );
1429
1430   my $table = $opt->{table};
1431   my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1432   my %formats = %{ $opt->{formats} };
1433
1434   my $param = thaw(decode_base64(shift));
1435   warn Dumper($param) if $DEBUG;
1436
1437   my $files = $param->{'uploaded_files'}
1438     or die "No files provided.\n";
1439
1440   my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1441
1442   my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1443   my $file = $dir. $files{'file'};
1444
1445   my %iopt = (
1446     #class-static
1447     table                      => $table,
1448     formats                    => \%formats,
1449     format_types               => $opt->{format_types},
1450     format_headers             => $opt->{format_headers},
1451     format_sep_chars           => $opt->{format_sep_chars},
1452     format_fixedlength_formats => $opt->{format_fixedlength_formats},
1453     format_xml_formats         => $opt->{format_xml_formats},
1454     format_asn_formats         => $opt->{format_asn_formats},
1455     format_row_callbacks       => $opt->{format_row_callbacks},
1456     #per-import
1457     job                        => $job,
1458     file                       => $file,
1459     #type                       => $type,
1460     format                     => $param->{format},
1461     params                     => { map { $_ => $param->{$_} } @pass_params },
1462     #?
1463     default_csv                => $opt->{default_csv},
1464     postinsert_callback        => $opt->{postinsert_callback},
1465   );
1466
1467   if ( $opt->{'batch_namecol'} ) {
1468     $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1469     $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1470   }
1471
1472   my $error = FS::Record::batch_import( \%iopt );
1473
1474   unlink $file;
1475
1476   die "$error\n" if $error;
1477 }
1478
1479 =item batch_import PARAM_HASHREF
1480
1481 Class method for batch imports.  Available params:
1482
1483 =over 4
1484
1485 =item table
1486
1487 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1488
1489 =item formats
1490
1491 =item format_types
1492
1493 =item format_headers
1494
1495 =item format_sep_chars
1496
1497 =item format_fixedlength_formats
1498
1499 =item format_row_callbacks
1500
1501 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1502
1503 =item preinsert_callback
1504
1505 =item postinsert_callback
1506
1507 =item params
1508
1509 =item job
1510
1511 FS::queue object, will be updated with progress
1512
1513 =item file
1514
1515 =item type
1516
1517 csv, xls, fixedlength, xml
1518
1519 =item empty_ok
1520
1521 =back
1522
1523 =cut
1524
1525 sub batch_import {
1526   my $param = shift;
1527
1528   warn "$me batch_import call with params: \n". Dumper($param)
1529     if $DEBUG;
1530
1531   my $table   = $param->{table};
1532
1533   my $job     = $param->{job};
1534   my $file    = $param->{file};
1535   my $params  = $param->{params} || {};
1536
1537   my( $type, $header, $sep_char,
1538       $fixedlength_format, $xml_format, $asn_format,
1539       $row_callback, @fields );
1540
1541   my $postinsert_callback = '';
1542   $postinsert_callback = $param->{'postinsert_callback'}
1543           if $param->{'postinsert_callback'};
1544   my $preinsert_callback = '';
1545   $preinsert_callback = $param->{'preinsert_callback'}
1546           if $param->{'preinsert_callback'};
1547
1548   if ( $param->{'format'} ) {
1549
1550     my $format  = $param->{'format'};
1551     my $formats = $param->{formats};
1552     die "unknown format $format" unless exists $formats->{ $format };
1553
1554     $type = $param->{'format_types'}
1555             ? $param->{'format_types'}{ $format }
1556             : $param->{type} || 'csv';
1557
1558
1559     $header = $param->{'format_headers'}
1560                ? $param->{'format_headers'}{ $param->{'format'} }
1561                : 0;
1562
1563     $sep_char = $param->{'format_sep_chars'}
1564                   ? $param->{'format_sep_chars'}{ $param->{'format'} }
1565                   : ',';
1566
1567     $fixedlength_format =
1568       $param->{'format_fixedlength_formats'}
1569         ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1570         : '';
1571
1572     $xml_format =
1573       $param->{'format_xml_formats'}
1574         ? $param->{'format_xml_formats'}{ $param->{'format'} }
1575         : '';
1576
1577     $asn_format =
1578       $param->{'format_asn_formats'}
1579         ? $param->{'format_asn_formats'}{ $param->{'format'} }
1580         : '';
1581
1582     $row_callback =
1583       $param->{'format_row_callbacks'}
1584         ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1585         : '';
1586
1587     @fields = @{ $formats->{ $format } };
1588
1589   } elsif ( $param->{'fields'} ) {
1590
1591     $type = ''; #infer from filename
1592     $header = 0;
1593     $sep_char = ',';
1594     $fixedlength_format = '';
1595     $row_callback = '';
1596     @fields = @{ $param->{'fields'} };
1597
1598   } else {
1599     die "neither format nor fields specified";
1600   }
1601
1602   #my $file    = $param->{file};
1603
1604   unless ( $type ) {
1605     if ( $file =~ /\.(\w+)$/i ) {
1606       $type = lc($1);
1607     } else {
1608       #or error out???
1609       warn "can't parse file type from filename $file; defaulting to CSV";
1610       $type = 'csv';
1611     }
1612     $type = 'csv'
1613       if $param->{'default_csv'} && $type ne 'xls';
1614   }
1615
1616
1617   my $row = 0;
1618   my $count;
1619   my $parser;
1620   my @buffer = ();
1621   my $asn_header_buffer;
1622   if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1623
1624     if ( $type eq 'csv' ) {
1625
1626       my %attr = ( 'binary' => 1, );
1627       $attr{sep_char} = $sep_char if $sep_char;
1628       $parser = new Text::CSV_XS \%attr;
1629
1630     } elsif ( $type eq 'fixedlength' ) {
1631
1632       eval "use Parse::FixedLength;";
1633       die $@ if $@;
1634       $parser = Parse::FixedLength->new($fixedlength_format);
1635
1636     }
1637     else {
1638       die "Unknown file type $type\n";
1639     }
1640
1641     @buffer = split(/\r?\n/, slurp($file) );
1642     splice(@buffer, 0, ($header || 0) );
1643     $count = scalar(@buffer);
1644
1645   } elsif ( $type eq 'xls' ) {
1646
1647     eval "use Spreadsheet::ParseExcel;";
1648     die $@ if $@;
1649
1650     eval "use DateTime::Format::Excel;";
1651     #for now, just let the error be thrown if it is used, since only CDR
1652     # formats bill_west and troop use it, not other excel-parsing things
1653     #die $@ if $@;
1654
1655     my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1656
1657     $parser = $excel->{Worksheet}[0]; #first sheet
1658
1659     $count = $parser->{MaxRow} || $parser->{MinRow};
1660     $count++;
1661
1662     $row = $header || 0;
1663
1664   } elsif ( $type eq 'xml' ) {
1665
1666     # FS::pay_batch
1667     eval "use XML::Simple;";
1668     die $@ if $@;
1669     my $xmlrow = $xml_format->{'xmlrow'};
1670     $parser = $xml_format->{'xmlkeys'};
1671     die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1672     my $data = XML::Simple::XMLin(
1673       $file,
1674       'SuppressEmpty' => '', #sets empty values to ''
1675       'KeepRoot'      => 1,
1676     );
1677     my $rows = $data;
1678     $rows = $rows->{$_} foreach @$xmlrow;
1679     $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1680     $count = @buffer = @$rows;
1681
1682   } elsif ( $type eq 'asn.1' ) {
1683
1684     eval "use Convert::ASN1";
1685     die $@ if $@;
1686
1687     my $asn = Convert::ASN1->new;
1688     $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
1689
1690     $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
1691
1692     my $data = slurp($file);
1693     my $asn_output = $parser->decode( $data )
1694       or die "No ". $asn_format->{'macro'}. " found\n";
1695
1696     $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
1697
1698     my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
1699     $count = @buffer = @$rows;
1700
1701   } else {
1702     die "Unknown file type $type\n";
1703   }
1704
1705   #my $columns;
1706
1707   local $SIG{HUP} = 'IGNORE';
1708   local $SIG{INT} = 'IGNORE';
1709   local $SIG{QUIT} = 'IGNORE';
1710   local $SIG{TERM} = 'IGNORE';
1711   local $SIG{TSTP} = 'IGNORE';
1712   local $SIG{PIPE} = 'IGNORE';
1713
1714   my $oldAutoCommit = $FS::UID::AutoCommit;
1715   local $FS::UID::AutoCommit = 0;
1716   my $dbh = dbh;
1717
1718   #my $params  = $param->{params} || {};
1719   if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1720     my $batch_col   = $param->{'batch_keycol'};
1721
1722     my $batch_class = 'FS::'. $param->{'batch_table'};
1723     my $batch = $batch_class->new({
1724       $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1725     });
1726     my $error = $batch->insert;
1727     if ( $error ) {
1728       $dbh->rollback if $oldAutoCommit;
1729       return "can't insert batch record: $error";
1730     }
1731     #primary key via dbdef? (so the column names don't have to match)
1732     my $batch_value = $batch->get( $param->{'batch_keycol'} );
1733
1734     $params->{ $batch_col } = $batch_value;
1735   }
1736
1737   #my $job     = $param->{job};
1738   my $line;
1739   my $imported = 0;
1740   my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1741   while (1) {
1742
1743     my @columns = ();
1744     my %hash = %$params;
1745     if ( $type eq 'csv' ) {
1746
1747       last unless scalar(@buffer);
1748       $line = shift(@buffer);
1749
1750       next if $line =~ /^\s*$/; #skip empty lines
1751
1752       $line = &{$row_callback}($line) if $row_callback;
1753
1754       next if $line =~ /^\s*$/; #skip empty lines
1755
1756       $parser->parse($line) or do {
1757         $dbh->rollback if $oldAutoCommit;
1758         return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
1759       };
1760       @columns = $parser->fields();
1761
1762     } elsif ( $type eq 'fixedlength' ) {
1763
1764       last unless scalar(@buffer);
1765       $line = shift(@buffer);
1766
1767       @columns = $parser->parse($line);
1768
1769     } elsif ( $type eq 'xls' ) {
1770
1771       last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1772            || ! $parser->{Cells}[$row];
1773
1774       my @row = @{ $parser->{Cells}[$row] };
1775       @columns = map $_->{Val}, @row;
1776
1777       #my $z = 'A';
1778       #warn $z++. ": $_\n" for @columns;
1779
1780     } elsif ( $type eq 'xml' ) {
1781
1782       # $parser = [ 'Column0Key', 'Column1Key' ... ]
1783       last unless scalar(@buffer);
1784       my $row = shift @buffer;
1785       @columns = @{ $row }{ @$parser };
1786
1787     } elsif ( $type eq 'asn.1' ) {
1788
1789       last unless scalar(@buffer);
1790       my $row = shift @buffer;
1791       foreach my $key ( keys %{ $asn_format->{map} } ) {
1792         $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
1793       }
1794
1795     } else {
1796       die "Unknown file type $type\n";
1797     }
1798
1799     my @later = ();
1800
1801     foreach my $field ( @fields ) {
1802
1803       my $value = shift @columns;
1804
1805       if ( ref($field) eq 'CODE' ) {
1806         #&{$field}(\%hash, $value);
1807         push @later, $field, $value;
1808       } else {
1809         #??? $hash{$field} = $value if length($value);
1810         $hash{$field} = $value if defined($value) && length($value);
1811       }
1812
1813     }
1814
1815     #my $table   = $param->{table};
1816     my $class = "FS::$table";
1817
1818     my $record = $class->new( \%hash );
1819
1820     my $param = {};
1821     while ( scalar(@later) ) {
1822       my $sub = shift @later;
1823       my $data = shift @later;
1824       eval {
1825         &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
1826       };
1827       if ( $@ ) {
1828         $dbh->rollback if $oldAutoCommit;
1829         return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
1830       }
1831       last if exists( $param->{skiprow} );
1832     }
1833     next if exists( $param->{skiprow} );
1834
1835     if ( $preinsert_callback ) {
1836       my $error = &{$preinsert_callback}($record, $param);
1837       if ( $error ) {
1838         $dbh->rollback if $oldAutoCommit;
1839         return "preinsert_callback error". ( $line ? " for $line" : '' ).
1840                ": $error";
1841       }
1842       next if exists $param->{skiprow} && $param->{skiprow};
1843     }
1844
1845     my $error = $record->insert;
1846
1847     if ( $error ) {
1848       $dbh->rollback if $oldAutoCommit;
1849       return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1850     }
1851
1852     $row++;
1853     $imported++;
1854
1855     if ( $postinsert_callback ) {
1856       my $error = &{$postinsert_callback}($record, $param);
1857       if ( $error ) {
1858         $dbh->rollback if $oldAutoCommit;
1859         return "postinsert_callback error". ( $line ? " for $line" : '' ).
1860                ": $error";
1861       }
1862     }
1863
1864     if ( $job && time - $min_sec > $last ) { #progress bar
1865       $job->update_statustext( int(100 * $imported / $count) );
1866       $last = time;
1867     }
1868
1869   }
1870
1871   unless ( $imported || $param->{empty_ok} ) {
1872     $dbh->rollback if $oldAutoCommit;
1873     return "Empty file!";
1874   }
1875
1876   $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1877
1878   ''; #no error
1879
1880 }
1881
1882 sub _h_statement {
1883   my( $self, $action, $time ) = @_;
1884
1885   $time ||= time;
1886
1887   my %nohistory = map { $_=>1 } $self->nohistory_fields;
1888
1889   my @fields =
1890     grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
1891     real_fields($self->table);
1892   ;
1893
1894   # If we're encrypting then don't store the payinfo in the history
1895   if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
1896     @fields = grep { $_ ne 'payinfo' } @fields;
1897   }
1898
1899   my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1900
1901   "INSERT INTO h_". $self->table. " ( ".
1902       join(', ', qw(history_date history_user history_action), @fields ).
1903     ") VALUES (".
1904       join(', ', $time,
1905                  dbh->quote( $FS::CurrentUser::CurrentUser->username ),
1906                  dbh->quote($action),
1907                  @values
1908       ).
1909     ")"
1910   ;
1911 }
1912
1913 =item unique COLUMN
1914
1915 B<Warning>: External use is B<deprecated>.
1916
1917 Replaces COLUMN in record with a unique number, using counters in the
1918 filesystem.  Used by the B<insert> method on single-field unique columns
1919 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1920 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1921
1922 Returns the new value.
1923
1924 =cut
1925
1926 sub unique {
1927   my($self,$field) = @_;
1928   my($table)=$self->table;
1929
1930   croak "Unique called on field $field, but it is ",
1931         $self->getfield($field),
1932         ", not null!"
1933     if $self->getfield($field);
1934
1935   #warn "table $table is tainted" if is_tainted($table);
1936   #warn "field $field is tainted" if is_tainted($field);
1937
1938   my($counter) = new File::CounterFile "$table.$field",0;
1939
1940   my $index = $counter->inc;
1941   $index = $counter->inc while qsearchs($table, { $field=>$index } );
1942
1943   $index =~ /^(\d*)$/;
1944   $index=$1;
1945
1946   $self->setfield($field,$index);
1947
1948 }
1949
1950 =item ut_float COLUMN
1951
1952 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10.  May not be
1953 null.  If there is an error, returns the error, otherwise returns false.
1954
1955 =cut
1956
1957 sub ut_float {
1958   my($self,$field)=@_ ;
1959   ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
1960    $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
1961    $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
1962    $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
1963     or return "Illegal or empty (float) $field: ". $self->getfield($field);
1964   $self->setfield($field,$1);
1965   '';
1966 }
1967 =item ut_floatn COLUMN
1968
1969 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10.  May be
1970 null.  If there is an error, returns the error, otherwise returns false.
1971
1972 =cut
1973
1974 #false laziness w/ut_ipn
1975 sub ut_floatn {
1976   my( $self, $field ) = @_;
1977   if ( $self->getfield($field) =~ /^()$/ ) {
1978     $self->setfield($field,'');
1979     '';
1980   } else {
1981     $self->ut_float($field);
1982   }
1983 }
1984
1985 =item ut_sfloat COLUMN
1986
1987 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
1988 May not be null.  If there is an error, returns the error, otherwise returns
1989 false.
1990
1991 =cut
1992
1993 sub ut_sfloat {
1994   my($self,$field)=@_ ;
1995   ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
1996    $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
1997    $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
1998    $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
1999     or return "Illegal or empty (float) $field: ". $self->getfield($field);
2000   $self->setfield($field,$1);
2001   '';
2002 }
2003 =item ut_sfloatn COLUMN
2004
2005 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.  May be
2006 null.  If there is an error, returns the error, otherwise returns false.
2007
2008 =cut
2009
2010 sub ut_sfloatn {
2011   my( $self, $field ) = @_;
2012   if ( $self->getfield($field) =~ /^()$/ ) {
2013     $self->setfield($field,'');
2014     '';
2015   } else {
2016     $self->ut_sfloat($field);
2017   }
2018 }
2019
2020 =item ut_snumber COLUMN
2021
2022 Check/untaint signed numeric data (whole numbers).  If there is an error,
2023 returns the error, otherwise returns false.
2024
2025 =cut
2026
2027 sub ut_snumber {
2028   my($self, $field) = @_;
2029   $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2030     or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2031   $self->setfield($field, "$1$2");
2032   '';
2033 }
2034
2035 =item ut_snumbern COLUMN
2036
2037 Check/untaint signed numeric data (whole numbers).  If there is an error,
2038 returns the error, otherwise returns false.
2039
2040 =cut
2041
2042 sub ut_snumbern {
2043   my($self, $field) = @_;
2044   $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2045     or return "Illegal (numeric) $field: ". $self->getfield($field);
2046   if ($1) {
2047     return "Illegal (numeric) $field: ". $self->getfield($field)
2048       unless $2;
2049   }
2050   $self->setfield($field, "$1$2");
2051   '';
2052 }
2053
2054 =item ut_number COLUMN
2055
2056 Check/untaint simple numeric data (whole numbers).  May not be null.  If there
2057 is an error, returns the error, otherwise returns false.
2058
2059 =cut
2060
2061 sub ut_number {
2062   my($self,$field)=@_;
2063   $self->getfield($field) =~ /^\s*(\d+)\s*$/
2064     or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2065   $self->setfield($field,$1);
2066   '';
2067 }
2068
2069 =item ut_numbern COLUMN
2070
2071 Check/untaint simple numeric data (whole numbers).  May be null.  If there is
2072 an error, returns the error, otherwise returns false.
2073
2074 =cut
2075
2076 sub ut_numbern {
2077   my($self,$field)=@_;
2078   $self->getfield($field) =~ /^\s*(\d*)\s*$/
2079     or return "Illegal (numeric) $field: ". $self->getfield($field);
2080   $self->setfield($field,$1);
2081   '';
2082 }
2083
2084 =item ut_money COLUMN
2085
2086 Check/untaint monetary numbers.  May be negative.  Set to 0 if null.  If there
2087 is an error, returns the error, otherwise returns false.
2088
2089 =cut
2090
2091 sub ut_money {
2092   my($self,$field)=@_;
2093
2094   if ( $self->getfield($field) eq '' ) {
2095     $self->setfield($field, 0);
2096   } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2097     #handle one decimal place without barfing out
2098     $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2099   } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2100     $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2101   } else {
2102     return "Illegal (money) $field: ". $self->getfield($field);
2103   }
2104
2105   '';
2106 }
2107
2108 =item ut_moneyn COLUMN
2109
2110 Check/untaint monetary numbers.  May be negative.  If there
2111 is an error, returns the error, otherwise returns false.
2112
2113 =cut
2114
2115 sub ut_moneyn {
2116   my($self,$field)=@_;
2117   if ($self->getfield($field) eq '') {
2118     $self->setfield($field, '');
2119     return '';
2120   }
2121   $self->ut_money($field);
2122 }
2123
2124 =item ut_text COLUMN
2125
2126 Check/untaint text.  Alphanumerics, spaces, and the following punctuation
2127 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2128 May not be null.  If there is an error, returns the error, otherwise returns
2129 false.
2130
2131 =cut
2132
2133 sub ut_text {
2134   my($self,$field)=@_;
2135   #warn "msgcat ". \&msgcat. "\n";
2136   #warn "notexist ". \&notexist. "\n";
2137   #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2138   $self->getfield($field)
2139     =~ /^([\wô \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2140       or return gettext('illegal_or_empty_text'). " $field: ".
2141                  $self->getfield($field);
2142   $self->setfield($field,$1);
2143   '';
2144 }
2145
2146 =item ut_textn COLUMN
2147
2148 Check/untaint text.  Alphanumerics, spaces, and the following punctuation
2149 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2150 May be null.  If there is an error, returns the error, otherwise returns false.
2151
2152 =cut
2153
2154 sub ut_textn {
2155   my($self,$field)=@_;
2156   return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2157   $self->ut_text($field);
2158 }
2159
2160 =item ut_alpha COLUMN
2161
2162 Check/untaint alphanumeric strings (no spaces).  May not be null.  If there is
2163 an error, returns the error, otherwise returns false.
2164
2165 =cut
2166
2167 sub ut_alpha {
2168   my($self,$field)=@_;
2169   $self->getfield($field) =~ /^(\w+)$/
2170     or return "Illegal or empty (alphanumeric) $field: ".
2171               $self->getfield($field);
2172   $self->setfield($field,$1);
2173   '';
2174 }
2175
2176 =item ut_alphan COLUMN
2177
2178 Check/untaint alphanumeric strings (no spaces).  May be null.  If there is an
2179 error, returns the error, otherwise returns false.
2180
2181 =cut
2182
2183 sub ut_alphan {
2184   my($self,$field)=@_;
2185   $self->getfield($field) =~ /^(\w*)$/
2186     or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2187   $self->setfield($field,$1);
2188   '';
2189 }
2190
2191 =item ut_alphasn COLUMN
2192
2193 Check/untaint alphanumeric strings, spaces allowed.  May be null.  If there is
2194 an error, returns the error, otherwise returns false.
2195
2196 =cut
2197
2198 sub ut_alphasn {
2199   my($self,$field)=@_;
2200   $self->getfield($field) =~ /^([\w ]*)$/
2201     or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2202   $self->setfield($field,$1);
2203   '';
2204 }
2205
2206
2207 =item ut_alpha_lower COLUMN
2208
2209 Check/untaint lowercase alphanumeric strings (no spaces).  May not be null.  If
2210 there is an error, returns the error, otherwise returns false.
2211
2212 =cut
2213
2214 sub ut_alpha_lower {
2215   my($self,$field)=@_;
2216   $self->getfield($field) =~ /[[:upper:]]/
2217     and return "Uppercase characters are not permitted in $field";
2218   $self->ut_alpha($field);
2219 }
2220
2221 =item ut_phonen COLUMN [ COUNTRY ]
2222
2223 Check/untaint phone numbers.  May be null.  If there is an error, returns
2224 the error, otherwise returns false.
2225
2226 Takes an optional two-letter ISO country code; without it or with unsupported
2227 countries, ut_phonen simply calls ut_alphan.
2228
2229 =cut
2230
2231 sub ut_phonen {
2232   my( $self, $field, $country ) = @_;
2233   return $self->ut_alphan($field) unless defined $country;
2234   my $phonen = $self->getfield($field);
2235   if ( $phonen eq '' ) {
2236     $self->setfield($field,'');
2237   } elsif ( $country eq 'US' || $country eq 'CA' ) {
2238     $phonen =~ s/\D//g;
2239     $phonen = $conf->config('cust_main-default_areacode').$phonen
2240       if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2241     $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2242       or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2243     $phonen = "$1-$2-$3";
2244     $phonen .= " x$4" if $4;
2245     $self->setfield($field,$phonen);
2246   } else {
2247     warn "warning: don't know how to check phone numbers for country $country";
2248     return $self->ut_textn($field);
2249   }
2250   '';
2251 }
2252
2253 =item ut_hex COLUMN
2254
2255 Check/untaint hexadecimal values.
2256
2257 =cut
2258
2259 sub ut_hex {
2260   my($self, $field) = @_;
2261   $self->getfield($field) =~ /^([\da-fA-F]+)$/
2262     or return "Illegal (hex) $field: ". $self->getfield($field);
2263   $self->setfield($field, uc($1));
2264   '';
2265 }
2266
2267 =item ut_hexn COLUMN
2268
2269 Check/untaint hexadecimal values.  May be null.
2270
2271 =cut
2272
2273 sub ut_hexn {
2274   my($self, $field) = @_;
2275   $self->getfield($field) =~ /^([\da-fA-F]*)$/
2276     or return "Illegal (hex) $field: ". $self->getfield($field);
2277   $self->setfield($field, uc($1));
2278   '';
2279 }
2280
2281 =item ut_mac_addr COLUMN
2282
2283 Check/untaint mac addresses.  May be null.
2284
2285 =cut
2286
2287 sub ut_mac_addr {
2288   my($self, $field) = @_;
2289
2290   my $mac = $self->get($field);
2291   $mac =~ s/\s+//g;
2292   $mac =~ s/://g;
2293   $self->set($field, $mac);
2294
2295   my $e = $self->ut_hex($field);
2296   return $e if $e;
2297
2298   return "Illegal (mac address) $field: ". $self->getfield($field)
2299     unless length($self->getfield($field)) == 12;
2300
2301   '';
2302
2303 }
2304
2305 =item ut_mac_addrn COLUMN
2306
2307 Check/untaint mac addresses.  May be null.
2308
2309 =cut
2310
2311 sub ut_mac_addrn {
2312   my($self, $field) = @_;
2313   ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2314 }
2315
2316 =item ut_ip COLUMN
2317
2318 Check/untaint ip addresses.  IPv4 only for now, though ::1 is auto-translated
2319 to 127.0.0.1.
2320
2321 =cut
2322
2323 sub ut_ip {
2324   my( $self, $field ) = @_;
2325   $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2326   $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2327     or return "Illegal (IP address) $field: ". $self->getfield($field);
2328   for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2329   $self->setfield($field, "$1.$2.$3.$4");
2330   '';
2331 }
2332
2333 =item ut_ipn COLUMN
2334
2335 Check/untaint ip addresses.  IPv4 only for now, though ::1 is auto-translated
2336 to 127.0.0.1.  May be null.
2337
2338 =cut
2339
2340 sub ut_ipn {
2341   my( $self, $field ) = @_;
2342   if ( $self->getfield($field) =~ /^()$/ ) {
2343     $self->setfield($field,'');
2344     '';
2345   } else {
2346     $self->ut_ip($field);
2347   }
2348 }
2349
2350 =item ut_ip46 COLUMN
2351
2352 Check/untaint IPv4 or IPv6 address.
2353
2354 =cut
2355
2356 sub ut_ip46 {
2357   my( $self, $field ) = @_;
2358   my $ip = NetAddr::IP->new($self->getfield($field))
2359     or return "Illegal (IP address) $field: ".$self->getfield($field);
2360   $self->setfield($field, lc($ip->addr));
2361   return '';
2362 }
2363
2364 =item ut_ip46n
2365
2366 Check/untaint IPv6 or IPv6 address.  May be null.
2367
2368 =cut
2369
2370 sub ut_ip46n {
2371   my( $self, $field ) = @_;
2372   if ( $self->getfield($field) =~ /^$/ ) {
2373     $self->setfield($field, '');
2374     return '';
2375   }
2376   $self->ut_ip46($field);
2377 }
2378
2379 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2380
2381 Check/untaint coordinates.
2382 Accepts the following forms:
2383 DDD.DDDDD
2384 -DDD.DDDDD
2385 DDD MM.MMM
2386 -DDD MM.MMM
2387 DDD MM SS
2388 -DDD MM SS
2389 DDD MM MMM
2390 -DDD MM MMM
2391
2392 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2393 The latter form (that is, the MMM are thousands of minutes) is
2394 assumed if the "MMM" is exactly three digits or two digits > 59.
2395
2396 To be safe, just use the DDD.DDDDD form.
2397
2398 If LOWER or UPPER are specified, then the coordinate is checked
2399 for lower and upper bounds, respectively.
2400
2401 =cut
2402
2403 sub ut_coord {
2404   my ($self, $field) = (shift, shift);
2405
2406   my($lower, $upper);
2407   if ( $field =~ /latitude/ ) {
2408     $lower = $lat_lower;
2409     $upper = 90;
2410   } elsif ( $field =~ /longitude/ ) {
2411     $lower = -180;
2412     $upper = $lon_upper;
2413   }
2414
2415   my $coord = $self->getfield($field);
2416   my $neg = $coord =~ s/^(-)//;
2417
2418   my ($d, $m, $s) = (0, 0, 0);
2419
2420   if (
2421     (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2422     (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2423     (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2424   ) {
2425     $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2426     $m = $m / 60;
2427     if ($m > 59) {
2428       return "Invalid (coordinate with minutes > 59) $field: "
2429              . $self->getfield($field);
2430     }
2431
2432     $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2433
2434     if (defined($lower) and ($coord < $lower)) {
2435       return "Invalid (coordinate < $lower) $field: "
2436              . $self->getfield($field);;
2437     }
2438
2439     if (defined($upper) and ($coord > $upper)) {
2440       return "Invalid (coordinate > $upper) $field: "
2441              . $self->getfield($field);;
2442     }
2443
2444     $self->setfield($field, $coord);
2445     return '';
2446   }
2447
2448   return "Invalid (coordinate) $field: " . $self->getfield($field);
2449
2450 }
2451
2452 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2453
2454 Same as ut_coord, except optionally null.
2455
2456 =cut
2457
2458 sub ut_coordn {
2459
2460   my ($self, $field) = (shift, shift);
2461
2462   if ($self->getfield($field) =~ /^\s*$/) {
2463     return '';
2464   } else {
2465     return $self->ut_coord($field, @_);
2466   }
2467
2468 }
2469
2470 =item ut_domain COLUMN
2471
2472 Check/untaint host and domain names.  May not be null.
2473
2474 =cut
2475
2476 sub ut_domain {
2477   my( $self, $field ) = @_;
2478   #$self->getfield($field) =~/^(\w+\.)*\w+$/
2479   $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2480     or return "Illegal (hostname) $field: ". $self->getfield($field);
2481   $self->setfield($field,$1);
2482   '';
2483 }
2484
2485 =item ut_domainn COLUMN
2486
2487 Check/untaint host and domain names.  May be null.
2488
2489 =cut
2490
2491 sub ut_domainn {
2492   my( $self, $field ) = @_;
2493   if ( $self->getfield($field) =~ /^()$/ ) {
2494     $self->setfield($field,'');
2495     '';
2496   } else {
2497     $self->ut_domain($field);
2498   }
2499 }
2500
2501 =item ut_name COLUMN
2502
2503 Check/untaint proper names; allows alphanumerics, spaces and the following
2504 punctuation: , . - '
2505
2506 May not be null.
2507
2508 =cut
2509
2510 sub ut_name {
2511   my( $self, $field ) = @_;
2512 #  warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2513   $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2514     or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2515   my $name = $1;
2516   $name =~ s/^\s+//;
2517   $name =~ s/\s+$//;
2518   $name =~ s/\s+/ /g;
2519   $self->setfield($field, $name);
2520   '';
2521 }
2522
2523 =item ut_namen COLUMN
2524
2525 Check/untaint proper names; allows alphanumerics, spaces and the following
2526 punctuation: , . - '
2527
2528 May not be null.
2529
2530 =cut
2531
2532 sub ut_namen {
2533   my( $self, $field ) = @_;
2534   return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2535   $self->ut_name($field);
2536 }
2537
2538 =item ut_zip COLUMN
2539
2540 Check/untaint zip codes.
2541
2542 =cut
2543
2544 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2545
2546 sub ut_zip {
2547   my( $self, $field, $country ) = @_;
2548
2549   if ( $country eq 'US' ) {
2550
2551     $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2552       or return gettext('illegal_zip'). " $field for country $country: ".
2553                 $self->getfield($field);
2554     $self->setfield($field, $1);
2555
2556   } elsif ( $country eq 'CA' ) {
2557
2558     $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2559       or return gettext('illegal_zip'). " $field for country $country: ".
2560                 $self->getfield($field);
2561     $self->setfield($field, "$1 $2");
2562
2563   } else {
2564
2565     if ( $self->getfield($field) =~ /^\s*$/
2566          && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2567        )
2568     {
2569       $self->setfield($field,'');
2570     } else {
2571       $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2572         or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2573       $self->setfield($field,$1);
2574     }
2575
2576   }
2577
2578   '';
2579 }
2580
2581 =item ut_country COLUMN
2582
2583 Check/untaint country codes.  Country names are changed to codes, if possible -
2584 see L<Locale::Country>.
2585
2586 =cut
2587
2588 sub ut_country {
2589   my( $self, $field ) = @_;
2590   unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2591     if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2592          && country2code($1) ) {
2593       $self->setfield($field,uc(country2code($1)));
2594     }
2595   }
2596   $self->getfield($field) =~ /^(\w\w)$/
2597     or return "Illegal (country) $field: ". $self->getfield($field);
2598   $self->setfield($field,uc($1));
2599   '';
2600 }
2601
2602 =item ut_anything COLUMN
2603
2604 Untaints arbitrary data.  Be careful.
2605
2606 =cut
2607
2608 sub ut_anything {
2609   my( $self, $field ) = @_;
2610   $self->getfield($field) =~ /^(.*)$/s
2611     or return "Illegal $field: ". $self->getfield($field);
2612   $self->setfield($field,$1);
2613   '';
2614 }
2615
2616 =item ut_enum COLUMN CHOICES_ARRAYREF
2617
2618 Check/untaint a column, supplying all possible choices, like the "enum" type.
2619
2620 =cut
2621
2622 sub ut_enum {
2623   my( $self, $field, $choices ) = @_;
2624   foreach my $choice ( @$choices ) {
2625     if ( $self->getfield($field) eq $choice ) {
2626       $self->setfield($field, $choice);
2627       return '';
2628     }
2629   }
2630   return "Illegal (enum) field $field: ". $self->getfield($field);
2631 }
2632
2633 =item ut_enumn COLUMN CHOICES_ARRAYREF
2634
2635 Like ut_enum, except the null value is also allowed.
2636
2637 =cut
2638
2639 sub ut_enumn {
2640   my( $self, $field, $choices ) = @_;
2641   $self->getfield($field)
2642     ? $self->ut_enum($field, $choices)
2643     : '';
2644 }
2645
2646 =item ut_flag COLUMN
2647
2648 Check/untaint a column if it contains either an empty string or 'Y'.  This
2649 is the standard form for boolean flags in Freeside.
2650
2651 =cut
2652
2653 sub ut_flag {
2654   my( $self, $field ) = @_;
2655   my $value = uc($self->getfield($field));
2656   if ( $value eq '' or $value eq 'Y' ) {
2657     $self->setfield($field, $value);
2658     return '';
2659   }
2660   return "Illegal (flag) field $field: $value";
2661 }
2662
2663 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2664
2665 Check/untaint a foreign column key.  Call a regular ut_ method (like ut_number)
2666 on the column first.
2667
2668 =cut
2669
2670 sub ut_foreign_key {
2671   my( $self, $field, $table, $foreign ) = @_;
2672   return '' if $no_check_foreign;
2673   qsearchs($table, { $foreign => $self->getfield($field) })
2674     or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2675               " in $table.$foreign";
2676   '';
2677 }
2678
2679 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2680
2681 Like ut_foreign_key, except the null value is also allowed.
2682
2683 =cut
2684
2685 sub ut_foreign_keyn {
2686   my( $self, $field, $table, $foreign ) = @_;
2687   $self->getfield($field)
2688     ? $self->ut_foreign_key($field, $table, $foreign)
2689     : '';
2690 }
2691
2692 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2693
2694 Checks this column as an agentnum, taking into account the current users's
2695 ACLs.  NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2696 right or rights allowing no agentnum.
2697
2698 =cut
2699
2700 sub ut_agentnum_acl {
2701   my( $self, $field ) = (shift, shift);
2702   my $null_acl = scalar(@_) ? shift : [];
2703   $null_acl = [ $null_acl ] unless ref($null_acl);
2704
2705   my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2706   return "Illegal agentnum: $error" if $error;
2707
2708   my $curuser = $FS::CurrentUser::CurrentUser;
2709
2710   if ( $self->$field() ) {
2711
2712     return "Access denied"
2713       unless $curuser->agentnum($self->$field());
2714
2715   } else {
2716
2717     return "Access denied"
2718       unless grep $curuser->access_right($_), @$null_acl;
2719
2720   }
2721
2722   '';
2723
2724 }
2725
2726 =item fields [ TABLE ]
2727
2728 This is a wrapper for real_fields.  Code that called
2729 fields before should probably continue to call fields.
2730
2731 =cut
2732
2733 sub fields {
2734   my $something = shift;
2735   my $table;
2736   if($something->isa('FS::Record')) {
2737     $table = $something->table;
2738   } else {
2739     $table = $something;
2740     $something = "FS::$table";
2741   }
2742   return (real_fields($table));
2743 }
2744
2745
2746 =item encrypt($value)
2747
2748 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2749
2750 Returns the encrypted string.
2751
2752 You should generally not have to worry about calling this, as the system handles this for you.
2753
2754 =cut
2755
2756 sub encrypt {
2757   my ($self, $value) = @_;
2758   my $encrypted;
2759
2760   if ($conf->exists('encryption')) {
2761     if ($self->is_encrypted($value)) {
2762       # Return the original value if it isn't plaintext.
2763       $encrypted = $value;
2764     } else {
2765       $self->loadRSA;
2766       if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2767         # RSA doesn't like the empty string so let's pack it up
2768         # The database doesn't like the RSA data so uuencode it
2769         my $length = length($value)+1;
2770         $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2771       } else {
2772         die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2773       }
2774     }
2775   }
2776   return $encrypted;
2777 }
2778
2779 =item is_encrypted($value)
2780
2781 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2782
2783 =cut
2784
2785
2786 sub is_encrypted {
2787   my ($self, $value) = @_;
2788   # Possible Bug - Some work may be required here....
2789
2790   if ($value =~ /^M/ && length($value) > 80) {
2791     return 1;
2792   } else {
2793     return 0;
2794   }
2795 }
2796
2797 =item decrypt($value)
2798
2799 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2800
2801 You should generally not have to worry about calling this, as the system handles this for you.
2802
2803 =cut
2804
2805 sub decrypt {
2806   my ($self,$value) = @_;
2807   my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2808   if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2809     $self->loadRSA;
2810     if (ref($rsa_decrypt) =~ /::RSA/) {
2811       my $encrypted = unpack ("u*", $value);
2812       $decrypted =  unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2813       if ($@) {warn "Decryption Failed"};
2814     }
2815   }
2816   return $decrypted;
2817 }
2818
2819 sub loadRSA {
2820     my $self = shift;
2821     #Initialize the Module
2822     $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2823
2824     if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2825       $rsa_module = $conf->config('encryptionmodule');
2826     }
2827
2828     if (!$rsa_loaded) {
2829         eval ("require $rsa_module"); # No need to import the namespace
2830         $rsa_loaded++;
2831     }
2832     # Initialize Encryption
2833     if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2834       my $public_key = join("\n",$conf->config('encryptionpublickey'));
2835       $rsa_encrypt = $rsa_module->new_public_key($public_key);
2836     }
2837
2838     # Intitalize Decryption
2839     if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2840       my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2841       $rsa_decrypt = $rsa_module->new_private_key($private_key);
2842     }
2843 }
2844
2845 =item h_search ACTION
2846
2847 Given an ACTION, either "insert", or "delete", returns the appropriate history
2848 record corresponding to this record, if any.
2849
2850 =cut
2851
2852 sub h_search {
2853   my( $self, $action ) = @_;
2854
2855   my $table = $self->table;
2856   $table =~ s/^h_//;
2857
2858   my $primary_key = dbdef->table($table)->primary_key;
2859
2860   qsearchs({
2861     'table'   => "h_$table",
2862     'hashref' => { $primary_key     => $self->$primary_key(),
2863                    'history_action' => $action,
2864                  },
2865   });
2866
2867 }
2868
2869 =item h_date ACTION
2870
2871 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2872 appropriate history record corresponding to this record, if any.
2873
2874 =cut
2875
2876 sub h_date {
2877   my($self, $action) = @_;
2878   my $h = $self->h_search($action);
2879   $h ? $h->history_date : '';
2880 }
2881
2882 =item scalar_sql SQL [ PLACEHOLDER, ... ]
2883
2884 A class or object method.  Executes the sql statement represented by SQL and
2885 returns a scalar representing the result: the first column of the first row.
2886
2887 Dies on bogus SQL.  Returns an empty string if no row is returned.
2888
2889 Typically used for statments which return a single value such as "SELECT
2890 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
2891
2892 =cut
2893
2894 sub scalar_sql {
2895   my($self, $sql) = (shift, shift);
2896   my $sth = dbh->prepare($sql) or die dbh->errstr;
2897   $sth->execute(@_)
2898     or die "Unexpected error executing statement $sql: ". $sth->errstr;
2899   my $row = $sth->fetchrow_arrayref or return '';
2900   my $scalar = $row->[0];
2901   defined($scalar) ? $scalar : '';
2902 }
2903
2904 =item count [ WHERE ]
2905
2906 Convenience method for the common case of "SELECT COUNT(*) FROM table",
2907 with optional WHERE.  Must be called as method on a class with an
2908 associated table.
2909
2910 =cut
2911
2912 sub count {
2913   my($self, $where) = (shift, shift);
2914   my $table = $self->table or die 'count called on object of class '.ref($self);
2915   my $sql = "SELECT COUNT(*) FROM $table";
2916   $sql .= " WHERE $where" if $where;
2917   $self->scalar_sql($sql);
2918 }
2919
2920 =back
2921
2922 =head1 SUBROUTINES
2923
2924 =over 4
2925
2926 =item real_fields [ TABLE ]
2927
2928 Returns a list of the real columns in the specified table.  Called only by
2929 fields() and other subroutines elsewhere in FS::Record.
2930
2931 =cut
2932
2933 sub real_fields {
2934   my $table = shift;
2935
2936   my($table_obj) = dbdef->table($table);
2937   confess "Unknown table $table" unless $table_obj;
2938   $table_obj->columns;
2939 }
2940
2941 =item pvf FIELD_NAME
2942
2943 Returns the FS::part_virtual_field object corresponding to a field in the
2944 record (specified by FIELD_NAME).
2945
2946 =cut
2947
2948 sub pvf {
2949   my ($self, $name) = (shift, shift);
2950
2951   if(grep /^$name$/, $self->virtual_fields) {
2952     $name =~ s/^cf_//;
2953     my $concat = [ "'cf_'", "name" ];
2954     return qsearchs({   table   =>  'part_virtual_field',
2955                         hashref =>  { dbtable => $self->table,
2956                                       name    => $name
2957                                     },
2958                         select  =>  'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
2959                     });
2960   }
2961   ''
2962 }
2963
2964 =item _quote VALUE, TABLE, COLUMN
2965
2966 This is an internal function used to construct SQL statements.  It returns
2967 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2968 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2969
2970 =cut
2971
2972 sub _quote {
2973   my($value, $table, $column) = @_;
2974   my $column_obj = dbdef->table($table)->column($column);
2975   my $column_type = $column_obj->type;
2976   my $nullable = $column_obj->null;
2977
2978   warn "  $table.$column: $value ($column_type".
2979        ( $nullable ? ' NULL' : ' NOT NULL' ).
2980        ")\n" if $DEBUG > 2;
2981
2982   if ( $value eq '' && $nullable ) {
2983     'NULL';
2984   } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2985     cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2986           "using 0 instead";
2987     0;
2988   } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2989             ! $column_type =~ /(char|binary|text)$/i ) {
2990     $value;
2991   } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
2992            && driver_name eq 'Pg'
2993           )
2994   {
2995     no strict 'subs';
2996 #    dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
2997     # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
2998     # single-quote the whole mess, and put an "E" in front.
2999     return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3000   } else {
3001     dbh->quote($value);
3002   }
3003 }
3004
3005 =item hfields TABLE
3006
3007 This is deprecated.  Don't use it.
3008
3009 It returns a hash-type list with the fields of this record's table set true.
3010
3011 =cut
3012
3013 sub hfields {
3014   carp "warning: hfields is deprecated";
3015   my($table)=@_;
3016   my(%hash);
3017   foreach (fields($table)) {
3018     $hash{$_}=1;
3019   }
3020   \%hash;
3021 }
3022
3023 sub _dump {
3024   my($self)=@_;
3025   join("\n", map {
3026     "$_: ". $self->getfield($_). "|"
3027   } (fields($self->table)) );
3028 }
3029
3030 sub DESTROY { return; }
3031
3032 #sub DESTROY {
3033 #  my $self = shift;
3034 #  #use Carp qw(cluck);
3035 #  #cluck "DESTROYING $self";
3036 #  warn "DESTROYING $self";
3037 #}
3038
3039 #sub is_tainted {
3040 #             return ! eval { join('',@_), kill 0; 1; };
3041 #         }
3042
3043 =item str2time_sql [ DRIVER_NAME ]
3044
3045 Returns a function to convert to unix time based on database type, such as
3046 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql.  See
3047 the str2time_sql_closing method to return a closing string rather than just
3048 using a closing parenthesis as previously suggested.
3049
3050 You can pass an optional driver name such as "Pg", "mysql" or
3051 $dbh->{Driver}->{Name} to return a function for that database instead of
3052 the current database.
3053
3054 =cut
3055
3056 sub str2time_sql {
3057   my $driver = shift || driver_name;
3058
3059   return 'UNIX_TIMESTAMP('      if $driver =~ /^mysql/i;
3060   return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3061
3062   warn "warning: unknown database type $driver; guessing how to convert ".
3063        "dates to UNIX timestamps";
3064   return 'EXTRACT(EPOCH FROM ';
3065
3066 }
3067
3068 =item str2time_sql_closing [ DRIVER_NAME ]
3069
3070 Returns the closing suffix of a function to convert to unix time based on
3071 database type, such as ")::integer" for Pg or ")" for mysql.
3072
3073 You can pass an optional driver name such as "Pg", "mysql" or
3074 $dbh->{Driver}->{Name} to return a function for that database instead of
3075 the current database.
3076
3077 =cut
3078
3079 sub str2time_sql_closing {
3080   my $driver = shift || driver_name;
3081
3082   return ' )::INTEGER ' if $driver =~ /^Pg/i;
3083   return ' ) ';
3084 }
3085
3086 =item regexp_sql [ DRIVER_NAME ]
3087
3088 Returns the operator to do a regular expression comparison based on database
3089 type, such as '~' for Pg or 'REGEXP' for mysql.
3090
3091 You can pass an optional driver name such as "Pg", "mysql" or
3092 $dbh->{Driver}->{Name} to return a function for that database instead of
3093 the current database.
3094
3095 =cut
3096
3097 sub regexp_sql {
3098   my $driver = shift || driver_name;
3099
3100   return '~'      if $driver =~ /^Pg/i;
3101   return 'REGEXP' if $driver =~ /^mysql/i;
3102
3103   die "don't know how to use regular expressions in ". driver_name." databases";
3104
3105 }
3106
3107 =item not_regexp_sql [ DRIVER_NAME ]
3108
3109 Returns the operator to do a regular expression negation based on database
3110 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3111
3112 You can pass an optional driver name such as "Pg", "mysql" or
3113 $dbh->{Driver}->{Name} to return a function for that database instead of
3114 the current database.
3115
3116 =cut
3117
3118 sub not_regexp_sql {
3119   my $driver = shift || driver_name;
3120
3121   return '!~'         if $driver =~ /^Pg/i;
3122   return 'NOT REGEXP' if $driver =~ /^mysql/i;
3123
3124   die "don't know how to use regular expressions in ". driver_name." databases";
3125
3126 }
3127
3128 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3129
3130 Returns the items concatenated based on database type, using "CONCAT()" for
3131 mysql and " || " for Pg and other databases.
3132
3133 You can pass an optional driver name such as "Pg", "mysql" or
3134 $dbh->{Driver}->{Name} to return a function for that database instead of
3135 the current database.
3136
3137 =cut
3138
3139 sub concat_sql {
3140   my $driver = ref($_[0]) ? driver_name : shift;
3141   my $items = shift;
3142
3143   if ( $driver =~ /^mysql/i ) {
3144     'CONCAT('. join(',', @$items). ')';
3145   } else {
3146     join('||', @$items);
3147   }
3148
3149 }
3150
3151 =item midnight_sql DATE
3152
3153 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3154 on that day in the system timezone, using the default driver name.
3155
3156 =cut
3157
3158 sub midnight_sql {
3159   my $driver = driver_name;
3160   my $expr = shift;
3161   if ( $driver =~ /^mysql/i ) {
3162     "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3163   }
3164   else {
3165     "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3166   }
3167 }
3168
3169 =back
3170
3171 =head1 BUGS
3172
3173 This module should probably be renamed, since much of the functionality is
3174 of general use.  It is not completely unlike Adapter::DBI (see below).
3175
3176 Exported qsearch and qsearchs should be deprecated in favor of method calls
3177 (against an FS::Record object like the old search and searchs that qsearch
3178 and qsearchs were on top of.)
3179
3180 The whole fields / hfields mess should be removed.
3181
3182 The various WHERE clauses should be subroutined.
3183
3184 table string should be deprecated in favor of DBIx::DBSchema::Table.
3185
3186 No doubt we could benefit from a Tied hash.  Documenting how exists / defined
3187 true maps to the database (and WHERE clauses) would also help.
3188
3189 The ut_ methods should ask the dbdef for a default length.
3190
3191 ut_sqltype (like ut_varchar) should all be defined
3192
3193 A fallback check method should be provided which uses the dbdef.
3194
3195 The ut_money method assumes money has two decimal digits.
3196
3197 The Pg money kludge in the new method only strips `$'.
3198
3199 The ut_phonen method only checks US-style phone numbers.
3200
3201 The _quote function should probably use ut_float instead of a regex.
3202
3203 All the subroutines probably should be methods, here or elsewhere.
3204
3205 Probably should borrow/use some dbdef methods where appropriate (like sub
3206 fields)
3207
3208 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3209 or allow it to be set.  Working around it is ugly any way around - DBI should
3210 be fixed.  (only affects RDBMS which return uppercase column names)
3211
3212 ut_zip should take an optional country like ut_phone.
3213
3214 =head1 SEE ALSO
3215
3216 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3217
3218 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.
3219
3220 http://poop.sf.net/
3221
3222 =cut
3223
3224 1;
3225