4 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
6 $conf $conf_encryption $money_char $lat_lower $lon_upper
8 $nowarn_identical $nowarn_classload
9 $no_update_diff $no_check_foreign
13 use Carp qw(carp cluck croak confess);
14 use Scalar::Util qw( blessed );
15 use File::CounterFile;
18 use File::Slurp qw( slurp );
19 use DBI qw(:sql_types);
20 use DBIx::DBSchema 0.38;
21 use FS::UID qw(dbh getotaker datasrc driver_name);
23 use FS::Schema qw(dbdef);
25 use FS::Msgcat qw(gettext);
26 use NetAddr::IP; # for validation
28 #use FS::Conf; #dependency loop bs, in install_callback below instead
30 use FS::part_virtual_field;
36 @encrypt_payby = qw( CARD DCRD CHEK DCHK );
38 #export dbdef for now... everything else expects to find it here
40 dbh fields hfields qsearch qsearchs dbdef jsearch
41 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql concat_sql
47 $nowarn_identical = 0;
48 $nowarn_classload = 0;
50 $no_check_foreign = 0;
58 $conf_encryption = '';
59 FS::UID->install_callback( sub {
63 $conf = FS::Conf->new;
64 $conf_encryption = $conf->exists('encryption');
65 $money_char = $conf->config('money_char') || '$';
66 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
67 $lat_lower = $nw_coords ? 1 : -90;
68 $lon_upper = $nw_coords ? -1 : 180;
70 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
72 if ( driver_name eq 'Pg' ) {
73 eval "use DBD::Pg ':pg_types'";
76 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
83 FS::Record - Database record objects
88 use FS::Record qw(dbh fields qsearch qsearchs);
90 $record = new FS::Record 'table', \%hash;
91 $record = new FS::Record 'table', { 'column' => 'value', ... };
93 $record = qsearchs FS::Record 'table', \%hash;
94 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
95 @records = qsearch FS::Record 'table', \%hash;
96 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
98 $table = $record->table;
99 $dbdef_table = $record->dbdef_table;
101 $value = $record->get('column');
102 $value = $record->getfield('column');
103 $value = $record->column;
105 $record->set( 'column' => 'value' );
106 $record->setfield( 'column' => 'value' );
107 $record->column('value');
109 %hash = $record->hash;
111 $hashref = $record->hashref;
113 $error = $record->insert;
115 $error = $record->delete;
117 $error = $new_record->replace($old_record);
119 # external use deprecated - handled by the database (at least for Pg, mysql)
120 $value = $record->unique('column');
122 $error = $record->ut_float('column');
123 $error = $record->ut_floatn('column');
124 $error = $record->ut_number('column');
125 $error = $record->ut_numbern('column');
126 $error = $record->ut_snumber('column');
127 $error = $record->ut_snumbern('column');
128 $error = $record->ut_money('column');
129 $error = $record->ut_text('column');
130 $error = $record->ut_textn('column');
131 $error = $record->ut_alpha('column');
132 $error = $record->ut_alphan('column');
133 $error = $record->ut_phonen('column');
134 $error = $record->ut_anything('column');
135 $error = $record->ut_name('column');
137 $quoted_value = _quote($value,'table','field');
140 $fields = hfields('table');
141 if ( $fields->{Field} ) { # etc.
143 @fields = fields 'table'; #as a subroutine
144 @fields = $record->fields; #as a method call
149 (Mostly) object-oriented interface to database records. Records are currently
150 implemented on top of DBI. FS::Record is intended as a base class for
151 table-specific classes to inherit from, i.e. FS::cust_main.
157 =item new [ TABLE, ] HASHREF
159 Creates a new record. It doesn't store it in the database, though. See
160 L<"insert"> for that.
162 Note that the object stores this hash reference, not a distinct copy of the
163 hash it points to. You can ask the object for a copy with the I<hash>
166 TABLE can only be omitted when a dervived class overrides the table method.
172 my $class = ref($proto) || $proto;
174 bless ($self, $class);
176 unless ( defined ( $self->table ) ) {
177 $self->{'Table'} = shift;
178 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
179 unless $nowarn_classload;
182 $self->{'Hash'} = shift;
184 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
185 $self->{'Hash'}{$field}='';
188 $self->_rebless if $self->can('_rebless');
190 $self->{'modified'} = 0;
192 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
199 my $class = ref($proto) || $proto;
201 bless ($self, $class);
203 $self->{'Table'} = shift unless defined ( $self->table );
205 my $hashref = $self->{'Hash'} = shift;
207 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
208 my $obj = $cache->cache->{$hashref->{$cache->key}};
209 $obj->_cache($hashref, $cache) if $obj->can('_cache');
212 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
219 my $class = ref($proto) || $proto;
221 bless ($self, $class);
222 if ( defined $self->table ) {
223 cluck "create constructor is deprecated, use new!";
226 croak "FS::Record::create called (not from a subclass)!";
230 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
232 Searches the database for all records matching (at least) the key/value pairs
233 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
234 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
237 The preferred usage is to pass a hash reference of named parameters:
239 @records = qsearch( {
240 'table' => 'table_name',
241 'hashref' => { 'field' => 'value'
242 'field' => { 'op' => '<',
247 #these are optional...
249 'extra_sql' => 'AND field = ? AND intfield = ?',
250 'extra_param' => [ 'value', [ 5, 'int' ] ],
251 'order_by' => 'ORDER BY something',
252 #'cache_obj' => '', #optional
253 'addl_from' => 'LEFT JOIN othtable USING ( field )',
258 Much code still uses old-style positional parameters, this is also probably
259 fine in the common case where there are only two parameters:
261 my @records = qsearch( 'table', { 'field' => 'value' } );
263 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
264 the individual PARAMS_HASHREF queries
266 ###oops, argh, FS::Record::new only lets us create database fields.
267 #Normal behaviour if SELECT is not specified is `*', as in
268 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
269 #feature where you can specify SELECT - remember, the objects returned,
270 #although blessed into the appropriate `FS::TABLE' package, will only have the
271 #fields you specify. This might have unwanted results if you then go calling
272 #regular FS::TABLE methods
277 my %TYPE = (); #for debugging
280 my($type, $value) = @_;
282 my $bind_type = { TYPE => SQL_VARCHAR };
284 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
286 $bind_type = { TYPE => SQL_INTEGER };
288 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
290 if ( driver_name eq 'Pg' ) {
292 $bind_type = { pg_type => PG_BYTEA };
294 # $bind_type = ? #SQL_VARCHAR could be fine?
297 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
298 #fixed by DBD::Pg 2.11.8
299 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
300 #(make a Tron test first)
301 } elsif ( _is_fs_float( $type, $value ) ) {
303 $bind_type = { TYPE => SQL_DECIMAL };
312 my($type, $value) = @_;
313 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
314 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
322 my( @stable, @record, @cache );
323 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
325 my %union_options = ();
326 if ( ref($_[0]) eq 'ARRAY' ) {
329 foreach my $href ( @$optlist ) {
330 push @stable, ( $href->{'table'} or die "table name is required" );
331 push @record, ( $href->{'hashref'} || {} );
332 push @select, ( $href->{'select'} || '*' );
333 push @extra_sql, ( $href->{'extra_sql'} || '' );
334 push @extra_param, ( $href->{'extra_param'} || [] );
335 push @order_by, ( $href->{'order_by'} || '' );
336 push @cache, ( $href->{'cache_obj'} || '' );
337 push @addl_from, ( $href->{'addl_from'} || '' );
338 push @debug, ( $href->{'debug'} || '' );
340 die "at least one hashref is required" unless scalar(@stable);
341 } elsif ( ref($_[0]) eq 'HASH' ) {
343 $stable[0] = $opt->{'table'} or die "table name is required";
344 $record[0] = $opt->{'hashref'} || {};
345 $select[0] = $opt->{'select'} || '*';
346 $extra_sql[0] = $opt->{'extra_sql'} || '';
347 $extra_param[0] = $opt->{'extra_param'} || [];
348 $order_by[0] = $opt->{'order_by'} || '';
349 $cache[0] = $opt->{'cache_obj'} || '';
350 $addl_from[0] = $opt->{'addl_from'} || '';
351 $debug[0] = $opt->{'debug'} || '';
362 my $cache = $cache[0];
368 foreach my $stable ( @stable ) {
369 #stop altering the caller's hashref
370 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
371 my $select = shift @select;
372 my $extra_sql = shift @extra_sql;
373 my $extra_param = shift @extra_param;
374 my $order_by = shift @order_by;
375 my $cache = shift @cache;
376 my $addl_from = shift @addl_from;
377 my $debug = shift @debug;
379 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
381 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
384 my $table = $cache ? $cache->table : $stable;
385 my $dbdef_table = dbdef->table($table)
386 or die "No schema for table $table found - ".
387 "do you need to run freeside-upgrade?";
388 my $pkey = $dbdef_table->primary_key;
390 my @real_fields = grep exists($record->{$_}), real_fields($table);
392 my $statement .= "SELECT $select FROM $stable";
393 $statement .= " $addl_from" if $addl_from;
394 if ( @real_fields ) {
395 $statement .= ' WHERE '. join(' AND ',
396 get_real_fields($table, $record, \@real_fields));
399 $statement .= " $extra_sql" if defined($extra_sql);
400 $statement .= " $order_by" if defined($order_by);
402 push @statement, $statement;
404 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
408 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
411 my $value = $record->{$field};
412 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
413 $value = $value->{'value'} if ref($value);
414 my $type = dbdef->table($table)->column($field)->type;
416 my $bind_type = _bind_type($type, $value);
420 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
422 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
426 push @bind_type, $bind_type;
430 foreach my $param ( @$extra_param ) {
431 my $bind_type = { TYPE => SQL_VARCHAR };
434 $value = $param->[0];
435 my $type = $param->[1];
436 $bind_type = _bind_type($type, $value);
439 push @bind_type, $bind_type;
443 my $statement = join( ' ) UNION ( ', @statement );
444 $statement = "( $statement )" if scalar(@statement) > 1;
445 $statement .= " $union_options{order_by}" if $union_options{order_by};
447 my $sth = $dbh->prepare($statement)
448 or croak "$dbh->errstr doing $statement";
451 foreach my $value ( @value ) {
452 my $bind_type = shift @bind_type;
453 $sth->bind_param($bind++, $value, $bind_type );
456 # $sth->execute( map $record->{$_},
457 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
458 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
460 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
462 my $table = $stable[0];
464 $table = '' if grep { $_ ne $table } @stable;
465 $pkey = dbdef->table($table)->primary_key if $table;
468 tie %result, "Tie::IxHash";
469 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
470 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
471 %result = map { $_->{$pkey}, $_ } @stuff;
473 @result{@stuff} = @stuff;
479 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
480 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
481 #derivied class didn't override new method, so this optimization is safe
484 new_or_cached( "FS::$table", { %{$_} }, $cache )
488 new( "FS::$table", { %{$_} } )
492 #okay, its been tested
493 # warn "untested code (class FS::$table uses custom new method)";
495 eval 'FS::'. $table. '->new( { %{$_} } )';
499 # Check for encrypted fields and decrypt them.
500 ## only in the local copy, not the cached object
501 if ( $conf_encryption
502 && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
503 foreach my $record (@return) {
504 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
505 next if $field eq 'payinfo'
506 && ($record->isa('FS::payinfo_transaction_Mixin')
507 || $record->isa('FS::payinfo_Mixin') )
509 && !grep { $record->payby eq $_ } @encrypt_payby;
510 # Set it directly... This may cause a problem in the future...
511 $record->setfield($field, $record->decrypt($record->getfield($field)));
516 cluck "warning: FS::$table not loaded; returning FS::Record objects"
517 unless $nowarn_classload;
519 FS::Record->new( $table, { %{$_} } );
525 ## makes this easier to read
527 sub get_real_fields {
530 my $real_fields = shift;
532 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
538 my $type = dbdef->table($table)->column($column)->type;
539 my $value = $record->{$column};
540 $value = $value->{'value'} if ref($value);
541 if ( ref($record->{$_}) ) {
542 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
543 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
544 if ( uc($op) eq 'ILIKE' ) {
546 $record->{$_}{'value'} = lc($record->{$_}{'value'});
547 $column = "LOWER($_)";
549 $record->{$_} = $record->{$_}{'value'}
552 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
554 if ( driver_name eq 'Pg' ) {
555 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
556 qq-( $column IS NULL )-;
558 qq-( $column IS NULL OR $column = '' )-;
561 qq-( $column IS NULL OR $column = "" )-;
563 } elsif ( $op eq '!=' ) {
564 if ( driver_name eq 'Pg' ) {
565 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
566 qq-( $column IS NOT NULL )-;
568 qq-( $column IS NOT NULL AND $column != '' )-;
571 qq-( $column IS NOT NULL AND $column != "" )-;
574 if ( driver_name eq 'Pg' ) {
575 qq-( $column $op '' )-;
577 qq-( $column $op "" )-;
580 #if this needs to be re-enabled, it needs to use a custom op like
581 #"APPROX=" or something (better name?, not '=', to avoid affecting other
583 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
584 # ( "$column <= ?", "$column >= ?" );
588 } @{ $real_fields } );
591 =item by_key PRIMARY_KEY_VALUE
593 This is a class method that returns the record with the given primary key
594 value. This method is only useful in FS::Record subclasses. For example:
596 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
600 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
605 my ($class, $pkey_value) = @_;
607 my $table = $class->table
608 or croak "No table for $class found";
610 my $dbdef_table = dbdef->table($table)
611 or die "No schema for table $table found - ".
612 "do you need to create it or run dbdef-create?";
613 my $pkey = $dbdef_table->primary_key
614 or die "No primary key for table $table";
616 return qsearchs($table, { $pkey => $pkey_value });
619 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
621 Experimental JOINed search method. Using this method, you can execute a
622 single SELECT spanning multiple tables, and cache the results for subsequent
623 method calls. Interface will almost definately change in an incompatible
631 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
632 my $cache = FS::SearchCache->new( $ptable, $pkey );
635 grep { !$saw{$_->getfield($pkey)}++ }
636 qsearch($table, $record, $select, $extra_sql, $cache )
640 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
642 Same as qsearch, except that if more than one record matches, it B<carp>s but
643 returns the first. If this happens, you either made a logic error in asking
644 for a single item, or your data is corrupted.
648 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
650 my(@result) = qsearch(@_);
651 cluck "warning: Multiple records in scalar search ($table)"
652 if scalar(@result) > 1;
653 #should warn more vehemently if the search was on a primary key?
654 scalar(@result) ? ($result[0]) : ();
665 Returns the table name.
670 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
677 Returns the DBIx::DBSchema::Table object for the table.
683 my($table)=$self->table;
684 dbdef->table($table);
689 Returns the primary key for the table.
695 my $pkey = $self->dbdef_table->primary_key;
698 =item get, getfield COLUMN
700 Returns the value of the column/field/key COLUMN.
705 my($self,$field) = @_;
706 # to avoid "Use of unitialized value" errors
707 if ( defined ( $self->{Hash}->{$field} ) ) {
708 $self->{Hash}->{$field};
718 =item set, setfield COLUMN, VALUE
720 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
725 my($self,$field,$value) = @_;
726 $self->{'modified'} = 1;
727 $self->{'Hash'}->{$field} = $value;
736 Returns true if the column/field/key COLUMN exists.
741 my($self,$field) = @_;
742 exists($self->{Hash}->{$field});
745 =item AUTLOADED METHODS
747 $record->column is a synonym for $record->get('column');
749 $record->column('value') is a synonym for $record->set('column','value');
756 my($field)=$AUTOLOAD;
758 if ( defined($value) ) {
759 confess "errant AUTOLOAD $field for $self (arg $value)"
760 unless blessed($self) && $self->can('setfield');
761 $self->setfield($field,$value);
763 confess "errant AUTOLOAD $field for $self (no args)"
764 unless blessed($self) && $self->can('getfield');
765 $self->getfield($field);
771 # my $field = $AUTOLOAD;
773 # if ( defined($_[1]) ) {
774 # $_[0]->setfield($field, $_[1]);
776 # $_[0]->getfield($field);
782 Returns a list of the column/value pairs, usually for assigning to a new hash.
784 To make a distinct duplicate of an FS::Record object, you can do:
786 $new = new FS::Record ( $old->table, { $old->hash } );
792 confess $self. ' -> hash: Hash attribute is undefined'
793 unless defined($self->{'Hash'});
794 %{ $self->{'Hash'} };
799 Returns a reference to the column/value hash. This may be deprecated in the
800 future; if there's a reason you can't just use the autoloaded or get/set
812 Returns true if any of this object's values have been modified with set (or via
813 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
823 =item select_for_update
825 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
830 sub select_for_update {
832 my $primary_key = $self->primary_key;
835 'table' => $self->table,
836 'hashref' => { $primary_key => $self->$primary_key() },
837 'extra_sql' => 'FOR UPDATE',
843 Locks this table with a database-driver specific lock method. This is used
844 as a mutex in order to do a duplicate search.
846 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
848 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
850 Errors are fatal; no useful return value.
852 Note: To use this method for new tables other than svc_acct and svc_phone,
853 edit freeside-upgrade and add those tables to the duplicate_lock list.
859 my $table = $self->table;
861 warn "$me locking $table table\n" if $DEBUG;
863 if ( driver_name =~ /^Pg/i ) {
865 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
868 } elsif ( driver_name =~ /^mysql/i ) {
870 dbh->do("SELECT * FROM duplicate_lock
871 WHERE lockname = '$table'
873 ) or die dbh->errstr;
877 die "unknown database ". driver_name. "; don't know how to lock table";
881 warn "$me acquired $table table lock\n" if $DEBUG;
887 Inserts this record to the database. If there is an error, returns the error,
888 otherwise returns false.
896 warn "$self -> insert" if $DEBUG;
898 my $error = $self->check;
899 return $error if $error;
901 #single-field unique keys are given a value if false
902 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
903 foreach ( $self->dbdef_table->unique_singles) {
904 $self->unique($_) unless $self->getfield($_);
907 #and also the primary key, if the database isn't going to
908 my $primary_key = $self->dbdef_table->primary_key;
910 if ( $primary_key ) {
911 my $col = $self->dbdef_table->column($primary_key);
914 uc($col->type) =~ /^(BIG)?SERIAL\d?/
915 || ( driver_name eq 'Pg'
916 && defined($col->default)
917 && $col->quoted_default =~ /^nextval\(/i
919 || ( driver_name eq 'mysql'
920 && defined($col->local)
921 && $col->local =~ /AUTO_INCREMENT/i
923 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
926 my $table = $self->table;
928 # Encrypt before the database
929 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
930 && scalar( eval '@FS::'. $table . '::encrypted_fields')
931 && $conf->exists('encryption')
933 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
934 next if $field eq 'payinfo'
935 && ($self->isa('FS::payinfo_transaction_Mixin')
936 || $self->isa('FS::payinfo_Mixin') )
938 && !grep { $self->payby eq $_ } @encrypt_payby;
939 $saved->{$field} = $self->getfield($field);
940 $self->setfield($field, $self->encrypt($self->getfield($field)));
944 #false laziness w/delete
946 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
949 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
952 my $statement = "INSERT INTO $table ";
953 if ( @real_fields ) {
956 join( ', ', @real_fields ).
958 join( ', ', @values ).
962 $statement .= 'DEFAULT VALUES';
964 warn "[debug]$me $statement\n" if $DEBUG > 1;
965 my $sth = dbh->prepare($statement) or return dbh->errstr;
967 local $SIG{HUP} = 'IGNORE';
968 local $SIG{INT} = 'IGNORE';
969 local $SIG{QUIT} = 'IGNORE';
970 local $SIG{TERM} = 'IGNORE';
971 local $SIG{TSTP} = 'IGNORE';
972 local $SIG{PIPE} = 'IGNORE';
974 $sth->execute or return $sth->errstr;
976 # get inserted id from the database, if applicable & needed
977 if ( $db_seq && ! $self->getfield($primary_key) ) {
978 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
982 if ( driver_name eq 'Pg' ) {
984 #my $oid = $sth->{'pg_oid_status'};
985 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
987 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
988 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
989 dbh->rollback if $FS::UID::AutoCommit;
990 return "can't parse $table.$primary_key default value".
991 " for sequence name: $default";
995 my $i_sql = "SELECT currval('$sequence')";
996 my $i_sth = dbh->prepare($i_sql) or do {
997 dbh->rollback if $FS::UID::AutoCommit;
1000 $i_sth->execute() or do { #$i_sth->execute($oid)
1001 dbh->rollback if $FS::UID::AutoCommit;
1002 return $i_sth->errstr;
1004 $insertid = $i_sth->fetchrow_arrayref->[0];
1006 } elsif ( driver_name eq 'mysql' ) {
1008 $insertid = dbh->{'mysql_insertid'};
1009 # work around mysql_insertid being null some of the time, ala RT :/
1010 unless ( $insertid ) {
1011 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1012 "using SELECT LAST_INSERT_ID();";
1013 my $i_sql = "SELECT LAST_INSERT_ID()";
1014 my $i_sth = dbh->prepare($i_sql) or do {
1015 dbh->rollback if $FS::UID::AutoCommit;
1018 $i_sth->execute or do {
1019 dbh->rollback if $FS::UID::AutoCommit;
1020 return $i_sth->errstr;
1022 $insertid = $i_sth->fetchrow_arrayref->[0];
1027 dbh->rollback if $FS::UID::AutoCommit;
1028 return "don't know how to retreive inserted ids from ". driver_name.
1029 ", try using counterfiles (maybe run dbdef-create?)";
1033 $self->setfield($primary_key, $insertid);
1038 if ( defined dbdef->table('h_'. $table) ) {
1039 my $h_statement = $self->_h_statement('insert');
1040 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1041 $h_sth = dbh->prepare($h_statement) or do {
1042 dbh->rollback if $FS::UID::AutoCommit;
1048 $h_sth->execute or return $h_sth->errstr if $h_sth;
1050 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1052 # Now that it has been saved, reset the encrypted fields so that $new
1053 # can still be used.
1054 foreach my $field (keys %{$saved}) {
1055 $self->setfield($field, $saved->{$field});
1063 Depriciated (use insert instead).
1068 cluck "warning: FS::Record::add deprecated!";
1069 insert @_; #call method in this scope
1074 Delete this record from the database. If there is an error, returns the error,
1075 otherwise returns false.
1082 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1084 $self->getfield($_) eq ''
1085 #? "( $_ IS NULL OR $_ = \"\" )"
1086 ? ( driver_name eq 'Pg'
1088 : "( $_ IS NULL OR $_ = \"\" )"
1090 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1091 } ( $self->dbdef_table->primary_key )
1092 ? ( $self->dbdef_table->primary_key)
1093 : real_fields($self->table)
1095 warn "[debug]$me $statement\n" if $DEBUG > 1;
1096 my $sth = dbh->prepare($statement) or return dbh->errstr;
1099 if ( defined dbdef->table('h_'. $self->table) ) {
1100 my $h_statement = $self->_h_statement('delete');
1101 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1102 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1107 my $primary_key = $self->dbdef_table->primary_key;
1109 local $SIG{HUP} = 'IGNORE';
1110 local $SIG{INT} = 'IGNORE';
1111 local $SIG{QUIT} = 'IGNORE';
1112 local $SIG{TERM} = 'IGNORE';
1113 local $SIG{TSTP} = 'IGNORE';
1114 local $SIG{PIPE} = 'IGNORE';
1116 my $rc = $sth->execute or return $sth->errstr;
1117 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1118 $h_sth->execute or return $h_sth->errstr if $h_sth;
1120 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1122 #no need to needlessly destoy the data either (causes problems actually)
1123 #undef $self; #no need to keep object!
1130 Depriciated (use delete instead).
1135 cluck "warning: FS::Record::del deprecated!";
1136 &delete(@_); #call method in this scope
1139 =item replace OLD_RECORD
1141 Replace the OLD_RECORD with this one in the database. If there is an error,
1142 returns the error, otherwise returns false.
1147 my ($new, $old) = (shift, shift);
1149 $old = $new->replace_old unless defined($old);
1151 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1153 if ( $new->can('replace_check') ) {
1154 my $error = $new->replace_check($old);
1155 return $error if $error;
1158 return "Records not in same table!" unless $new->table eq $old->table;
1160 my $primary_key = $old->dbdef_table->primary_key;
1161 return "Can't change primary key $primary_key ".
1162 'from '. $old->getfield($primary_key).
1163 ' to ' . $new->getfield($primary_key)
1165 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1167 my $error = $new->check;
1168 return $error if $error;
1170 # Encrypt for replace
1172 if ( $conf->exists('encryption')
1173 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1174 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1176 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1177 next if $field eq 'payinfo'
1178 && ($new->isa('FS::payinfo_transaction_Mixin')
1179 || $new->isa('FS::payinfo_Mixin') )
1181 && !grep { $new->payby eq $_ } @encrypt_payby;
1182 $saved->{$field} = $new->getfield($field);
1183 $new->setfield($field, $new->encrypt($new->getfield($field)));
1187 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1188 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1189 ? ($_, $new->getfield($_)) : () } $old->fields;
1191 unless (keys(%diff) || $no_update_diff ) {
1192 carp "[warning]$me ". ref($new)."->replace ".
1193 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1194 ": records identical"
1195 unless $nowarn_identical;
1199 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1201 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1202 } real_fields($old->table)
1207 if ( $old->getfield($_) eq '' ) {
1209 #false laziness w/qsearch
1210 if ( driver_name eq 'Pg' ) {
1211 my $type = $old->dbdef_table->column($_)->type;
1212 if ( $type =~ /(int|(big)?serial)/i ) {
1215 qq-( $_ IS NULL OR $_ = '' )-;
1218 qq-( $_ IS NULL OR $_ = "" )-;
1222 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1225 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1228 warn "[debug]$me $statement\n" if $DEBUG > 1;
1229 my $sth = dbh->prepare($statement) or return dbh->errstr;
1232 if ( defined dbdef->table('h_'. $old->table) ) {
1233 my $h_old_statement = $old->_h_statement('replace_old');
1234 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1235 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1241 if ( defined dbdef->table('h_'. $new->table) ) {
1242 my $h_new_statement = $new->_h_statement('replace_new');
1243 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1244 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1249 local $SIG{HUP} = 'IGNORE';
1250 local $SIG{INT} = 'IGNORE';
1251 local $SIG{QUIT} = 'IGNORE';
1252 local $SIG{TERM} = 'IGNORE';
1253 local $SIG{TSTP} = 'IGNORE';
1254 local $SIG{PIPE} = 'IGNORE';
1256 my $rc = $sth->execute or return $sth->errstr;
1257 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1258 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1259 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1261 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1263 # Now that it has been saved, reset the encrypted fields so that $new
1264 # can still be used.
1265 foreach my $field (keys %{$saved}) {
1266 $new->setfield($field, $saved->{$field});
1274 my( $self ) = shift;
1275 warn "[$me] replace called with no arguments; autoloading old record\n"
1278 my $primary_key = $self->dbdef_table->primary_key;
1279 if ( $primary_key ) {
1280 $self->by_key( $self->$primary_key() ) #this is what's returned
1281 or croak "can't find ". $self->table. ".$primary_key ".
1282 $self->$primary_key();
1284 croak $self->table. " has no primary key; pass old record as argument";
1291 Depriciated (use replace instead).
1296 cluck "warning: FS::Record::rep deprecated!";
1297 replace @_; #call method in this scope
1302 Checks custom fields. Subclasses should still provide a check method to validate
1303 non-custom fields, foreign keys, etc., and call this method via $self->SUPER::check.
1309 foreach my $field ($self->virtual_fields) {
1310 my $error = $self->ut_textn($field);
1311 return $error if $error;
1316 =item virtual_fields [ TABLE ]
1318 Returns a list of virtual fields defined for the table. This should not
1319 be exported, and should only be called as an instance or class method.
1323 sub virtual_fields {
1326 $table = $self->table or confess "virtual_fields called on non-table";
1328 confess "Unknown table $table" unless dbdef->table($table);
1330 return () unless dbdef->table('part_virtual_field');
1332 unless ( $virtual_fields_cache{$table} ) {
1333 my $concat = [ "'cf_'", "name" ];
1334 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1335 "WHERE dbtable = '$table'";
1337 my $result = $dbh->selectcol_arrayref($query);
1338 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1340 $virtual_fields_cache{$table} = $result;
1343 @{$virtual_fields_cache{$table}};
1347 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1349 Processes a batch import as a queued JSRPC job
1351 JOB is an FS::queue entry.
1353 OPTIONS_HASHREF can have the following keys:
1359 Table name (required).
1363 Listref of field names for static fields. They will be given values from the
1364 PARAMS hashref and passed as a "params" hashref to batch_import.
1368 Formats hashref. Keys are field names, values are listrefs that define the
1371 Each listref value can be a column name or a code reference. Coderefs are run
1372 with the row object, data and a FS::Conf object as the three parameters.
1373 For example, this coderef does the same thing as using the "columnname" string:
1376 my( $record, $data, $conf ) = @_;
1377 $record->columnname( $data );
1380 Coderefs are run after all "column name" fields are assigned.
1384 Optional format hashref of types. Keys are field names, values are "csv",
1385 "xls" or "fixedlength". Overrides automatic determination of file type
1388 =item format_headers
1390 Optional format hashref of header lines. Keys are field names, values are 0
1391 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1394 =item format_sep_chars
1396 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1397 CSV separation character.
1399 =item format_fixedlenth_formats
1401 Optional format hashref of fixed length format defintiions. Keys are field
1402 names, values Parse::FixedLength listrefs of field definitions.
1406 Set true to default to CSV file type if the filename does not contain a
1407 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1412 PARAMS is a base64-encoded Storable string containing the POSTed data as
1413 a hash ref. It normally contains at least one field, "uploaded files",
1414 generated by /elements/file-upload.html and containing the list of uploaded
1415 files. Currently only supports a single file named "file".
1419 use Storable qw(thaw);
1422 sub process_batch_import {
1423 my($job, $opt) = ( shift, shift );
1425 my $table = $opt->{table};
1426 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1427 my %formats = %{ $opt->{formats} };
1429 my $param = thaw(decode_base64(shift));
1430 warn Dumper($param) if $DEBUG;
1432 my $files = $param->{'uploaded_files'}
1433 or die "No files provided.\n";
1435 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1437 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1438 my $file = $dir. $files{'file'};
1443 formats => \%formats,
1444 format_types => $opt->{format_types},
1445 format_headers => $opt->{format_headers},
1446 format_sep_chars => $opt->{format_sep_chars},
1447 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1448 format_xml_formats => $opt->{format_xml_formats},
1449 format_row_callbacks => $opt->{format_row_callbacks},
1454 format => $param->{format},
1455 params => { map { $_ => $param->{$_} } @pass_params },
1457 default_csv => $opt->{default_csv},
1458 postinsert_callback => $opt->{postinsert_callback},
1461 if ( $opt->{'batch_namecol'} ) {
1462 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1463 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1466 my $error = FS::Record::batch_import( \%iopt );
1470 die "$error\n" if $error;
1473 =item batch_import PARAM_HASHREF
1475 Class method for batch imports. Available params:
1481 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1487 =item format_headers
1489 =item format_sep_chars
1491 =item format_fixedlength_formats
1493 =item format_row_callbacks
1495 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1497 =item preinsert_callback
1499 =item postinsert_callback
1505 FS::queue object, will be updated with progress
1511 csv, xls, fixedlength, xml
1522 warn "$me batch_import call with params: \n". Dumper($param)
1525 my $table = $param->{table};
1527 my $job = $param->{job};
1528 my $file = $param->{file};
1529 my $params = $param->{params} || {};
1531 my( $type, $header, $sep_char, $fixedlength_format,
1532 $xml_format, $row_callback, @fields );
1534 my $postinsert_callback = '';
1535 $postinsert_callback = $param->{'postinsert_callback'}
1536 if $param->{'postinsert_callback'};
1537 my $preinsert_callback = '';
1538 $preinsert_callback = $param->{'preinsert_callback'}
1539 if $param->{'preinsert_callback'};
1541 if ( $param->{'format'} ) {
1543 my $format = $param->{'format'};
1544 my $formats = $param->{formats};
1545 die "unknown format $format" unless exists $formats->{ $format };
1547 $type = $param->{'format_types'}
1548 ? $param->{'format_types'}{ $format }
1549 : $param->{type} || 'csv';
1552 $header = $param->{'format_headers'}
1553 ? $param->{'format_headers'}{ $param->{'format'} }
1556 $sep_char = $param->{'format_sep_chars'}
1557 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1560 $fixedlength_format =
1561 $param->{'format_fixedlength_formats'}
1562 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1566 $param->{'format_xml_formats'}
1567 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1571 $param->{'format_row_callbacks'}
1572 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1575 @fields = @{ $formats->{ $format } };
1577 } elsif ( $param->{'fields'} ) {
1579 $type = ''; #infer from filename
1582 $fixedlength_format = '';
1584 @fields = @{ $param->{'fields'} };
1587 die "neither format nor fields specified";
1590 #my $file = $param->{file};
1593 if ( $file =~ /\.(\w+)$/i ) {
1597 warn "can't parse file type from filename $file; defaulting to CSV";
1601 if $param->{'default_csv'} && $type ne 'xls';
1609 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1611 if ( $type eq 'csv' ) {
1614 $attr{sep_char} = $sep_char if $sep_char;
1615 $parser = new Text::CSV_XS \%attr;
1617 } elsif ( $type eq 'fixedlength' ) {
1619 eval "use Parse::FixedLength;";
1621 $parser = Parse::FixedLength->new($fixedlength_format);
1625 die "Unknown file type $type\n";
1628 @buffer = split(/\r?\n/, slurp($file) );
1629 splice(@buffer, 0, ($header || 0) );
1630 $count = scalar(@buffer);
1632 } elsif ( $type eq 'xls' ) {
1634 eval "use Spreadsheet::ParseExcel;";
1637 eval "use DateTime::Format::Excel;";
1638 #for now, just let the error be thrown if it is used, since only CDR
1639 # formats bill_west and troop use it, not other excel-parsing things
1642 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1644 $parser = $excel->{Worksheet}[0]; #first sheet
1646 $count = $parser->{MaxRow} || $parser->{MinRow};
1649 $row = $header || 0;
1650 } elsif ( $type eq 'xml' ) {
1652 eval "use XML::Simple;";
1654 my $xmlrow = $xml_format->{'xmlrow'};
1655 $parser = $xml_format->{'xmlkeys'};
1656 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1657 my $data = XML::Simple::XMLin(
1659 'SuppressEmpty' => '', #sets empty values to ''
1663 $rows = $rows->{$_} foreach @$xmlrow;
1664 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1665 $count = @buffer = @$rows;
1667 die "Unknown file type $type\n";
1672 local $SIG{HUP} = 'IGNORE';
1673 local $SIG{INT} = 'IGNORE';
1674 local $SIG{QUIT} = 'IGNORE';
1675 local $SIG{TERM} = 'IGNORE';
1676 local $SIG{TSTP} = 'IGNORE';
1677 local $SIG{PIPE} = 'IGNORE';
1679 my $oldAutoCommit = $FS::UID::AutoCommit;
1680 local $FS::UID::AutoCommit = 0;
1683 #my $params = $param->{params} || {};
1684 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1685 my $batch_col = $param->{'batch_keycol'};
1687 my $batch_class = 'FS::'. $param->{'batch_table'};
1688 my $batch = $batch_class->new({
1689 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1691 my $error = $batch->insert;
1693 $dbh->rollback if $oldAutoCommit;
1694 return "can't insert batch record: $error";
1696 #primary key via dbdef? (so the column names don't have to match)
1697 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1699 $params->{ $batch_col } = $batch_value;
1702 #my $job = $param->{job};
1705 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1709 if ( $type eq 'csv' ) {
1711 last unless scalar(@buffer);
1712 $line = shift(@buffer);
1714 next if $line =~ /^\s*$/; #skip empty lines
1716 $line = &{$row_callback}($line) if $row_callback;
1718 next if $line =~ /^\s*$/; #skip empty lines
1720 $parser->parse($line) or do {
1721 $dbh->rollback if $oldAutoCommit;
1722 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
1724 @columns = $parser->fields();
1726 } elsif ( $type eq 'fixedlength' ) {
1728 last unless scalar(@buffer);
1729 $line = shift(@buffer);
1731 @columns = $parser->parse($line);
1733 } elsif ( $type eq 'xls' ) {
1735 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1736 || ! $parser->{Cells}[$row];
1738 my @row = @{ $parser->{Cells}[$row] };
1739 @columns = map $_->{Val}, @row;
1742 #warn $z++. ": $_\n" for @columns;
1744 } elsif ( $type eq 'xml' ) {
1745 # $parser = [ 'Column0Key', 'Column1Key' ... ]
1746 last unless scalar(@buffer);
1747 my $row = shift @buffer;
1748 @columns = @{ $row }{ @$parser };
1750 die "Unknown file type $type\n";
1754 my %hash = %$params;
1756 foreach my $field ( @fields ) {
1758 my $value = shift @columns;
1760 if ( ref($field) eq 'CODE' ) {
1761 #&{$field}(\%hash, $value);
1762 push @later, $field, $value;
1764 #??? $hash{$field} = $value if length($value);
1765 $hash{$field} = $value if defined($value) && length($value);
1770 #my $table = $param->{table};
1771 my $class = "FS::$table";
1773 my $record = $class->new( \%hash );
1776 while ( scalar(@later) ) {
1777 my $sub = shift @later;
1778 my $data = shift @later;
1780 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
1783 $dbh->rollback if $oldAutoCommit;
1784 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
1786 last if exists( $param->{skiprow} );
1788 next if exists( $param->{skiprow} );
1790 if ( $preinsert_callback ) {
1791 my $error = &{$preinsert_callback}($record, $param);
1793 $dbh->rollback if $oldAutoCommit;
1794 return "preinsert_callback error". ( $line ? " for $line" : '' ).
1797 next if exists $param->{skiprow} && $param->{skiprow};
1800 my $error = $record->insert;
1803 $dbh->rollback if $oldAutoCommit;
1804 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1810 if ( $postinsert_callback ) {
1811 my $error = &{$postinsert_callback}($record, $param);
1813 $dbh->rollback if $oldAutoCommit;
1814 return "postinsert_callback error". ( $line ? " for $line" : '' ).
1819 if ( $job && time - $min_sec > $last ) { #progress bar
1820 $job->update_statustext( int(100 * $imported / $count) );
1826 unless ( $imported || $param->{empty_ok} ) {
1827 $dbh->rollback if $oldAutoCommit;
1828 return "Empty file!";
1831 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1838 my( $self, $action, $time ) = @_;
1842 my %nohistory = map { $_=>1 } $self->nohistory_fields;
1845 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
1846 real_fields($self->table);
1849 # If we're encrypting then don't store the payinfo in the history
1850 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
1851 @fields = grep { $_ ne 'payinfo' } @fields;
1854 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1856 "INSERT INTO h_". $self->table. " ( ".
1857 join(', ', qw(history_date history_user history_action), @fields ).
1859 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1866 B<Warning>: External use is B<deprecated>.
1868 Replaces COLUMN in record with a unique number, using counters in the
1869 filesystem. Used by the B<insert> method on single-field unique columns
1870 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1871 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1873 Returns the new value.
1878 my($self,$field) = @_;
1879 my($table)=$self->table;
1881 croak "Unique called on field $field, but it is ",
1882 $self->getfield($field),
1884 if $self->getfield($field);
1886 #warn "table $table is tainted" if is_tainted($table);
1887 #warn "field $field is tainted" if is_tainted($field);
1889 my($counter) = new File::CounterFile "$table.$field",0;
1891 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1893 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1896 my $index = $counter->inc;
1897 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1899 $index =~ /^(\d*)$/;
1902 $self->setfield($field,$index);
1906 =item ut_float COLUMN
1908 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1909 null. If there is an error, returns the error, otherwise returns false.
1914 my($self,$field)=@_ ;
1915 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
1916 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
1917 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
1918 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
1919 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1920 $self->setfield($field,$1);
1923 =item ut_floatn COLUMN
1925 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1926 null. If there is an error, returns the error, otherwise returns false.
1930 #false laziness w/ut_ipn
1932 my( $self, $field ) = @_;
1933 if ( $self->getfield($field) =~ /^()$/ ) {
1934 $self->setfield($field,'');
1937 $self->ut_float($field);
1941 =item ut_sfloat COLUMN
1943 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
1944 May not be null. If there is an error, returns the error, otherwise returns
1950 my($self,$field)=@_ ;
1951 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
1952 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
1953 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
1954 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
1955 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1956 $self->setfield($field,$1);
1959 =item ut_sfloatn COLUMN
1961 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1962 null. If there is an error, returns the error, otherwise returns false.
1967 my( $self, $field ) = @_;
1968 if ( $self->getfield($field) =~ /^()$/ ) {
1969 $self->setfield($field,'');
1972 $self->ut_sfloat($field);
1976 =item ut_snumber COLUMN
1978 Check/untaint signed numeric data (whole numbers). If there is an error,
1979 returns the error, otherwise returns false.
1984 my($self, $field) = @_;
1985 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
1986 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1987 $self->setfield($field, "$1$2");
1991 =item ut_snumbern COLUMN
1993 Check/untaint signed numeric data (whole numbers). If there is an error,
1994 returns the error, otherwise returns false.
1999 my($self, $field) = @_;
2000 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2001 or return "Illegal (numeric) $field: ". $self->getfield($field);
2003 return "Illegal (numeric) $field: ". $self->getfield($field)
2006 $self->setfield($field, "$1$2");
2010 =item ut_number COLUMN
2012 Check/untaint simple numeric data (whole numbers). May not be null. If there
2013 is an error, returns the error, otherwise returns false.
2018 my($self,$field)=@_;
2019 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2020 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2021 $self->setfield($field,$1);
2025 =item ut_numbern COLUMN
2027 Check/untaint simple numeric data (whole numbers). May be null. If there is
2028 an error, returns the error, otherwise returns false.
2033 my($self,$field)=@_;
2034 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2035 or return "Illegal (numeric) $field: ". $self->getfield($field);
2036 $self->setfield($field,$1);
2040 =item ut_money COLUMN
2042 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2043 is an error, returns the error, otherwise returns false.
2048 my($self,$field)=@_;
2049 $self->setfield($field, 0) if $self->getfield($field) eq '';
2050 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
2051 or return "Illegal (money) $field: ". $self->getfield($field);
2052 #$self->setfield($field, "$1$2$3" || 0);
2053 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2057 =item ut_moneyn COLUMN
2059 Check/untaint monetary numbers. May be negative. If there
2060 is an error, returns the error, otherwise returns false.
2065 my($self,$field)=@_;
2066 if ($self->getfield($field) eq '') {
2067 $self->setfield($field, '');
2070 $self->ut_money($field);
2073 =item ut_text COLUMN
2075 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2076 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2077 May not be null. If there is an error, returns the error, otherwise returns
2083 my($self,$field)=@_;
2084 #warn "msgcat ". \&msgcat. "\n";
2085 #warn "notexist ". \¬exist. "\n";
2086 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2087 $self->getfield($field)
2088 =~ /^([\wô \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2089 or return gettext('illegal_or_empty_text'). " $field: ".
2090 $self->getfield($field);
2091 $self->setfield($field,$1);
2095 =item ut_textn COLUMN
2097 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2098 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2099 May be null. If there is an error, returns the error, otherwise returns false.
2104 my($self,$field)=@_;
2105 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2106 $self->ut_text($field);
2109 =item ut_alpha COLUMN
2111 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2112 an error, returns the error, otherwise returns false.
2117 my($self,$field)=@_;
2118 $self->getfield($field) =~ /^(\w+)$/
2119 or return "Illegal or empty (alphanumeric) $field: ".
2120 $self->getfield($field);
2121 $self->setfield($field,$1);
2125 =item ut_alphan COLUMN
2127 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2128 error, returns the error, otherwise returns false.
2133 my($self,$field)=@_;
2134 $self->getfield($field) =~ /^(\w*)$/
2135 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2136 $self->setfield($field,$1);
2140 =item ut_alphasn COLUMN
2142 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2143 an error, returns the error, otherwise returns false.
2148 my($self,$field)=@_;
2149 $self->getfield($field) =~ /^([\w ]*)$/
2150 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2151 $self->setfield($field,$1);
2156 =item ut_alpha_lower COLUMN
2158 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2159 there is an error, returns the error, otherwise returns false.
2163 sub ut_alpha_lower {
2164 my($self,$field)=@_;
2165 $self->getfield($field) =~ /[[:upper:]]/
2166 and return "Uppercase characters are not permitted in $field";
2167 $self->ut_alpha($field);
2170 =item ut_phonen COLUMN [ COUNTRY ]
2172 Check/untaint phone numbers. May be null. If there is an error, returns
2173 the error, otherwise returns false.
2175 Takes an optional two-letter ISO country code; without it or with unsupported
2176 countries, ut_phonen simply calls ut_alphan.
2181 my( $self, $field, $country ) = @_;
2182 return $self->ut_alphan($field) unless defined $country;
2183 my $phonen = $self->getfield($field);
2184 if ( $phonen eq '' ) {
2185 $self->setfield($field,'');
2186 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2188 $phonen = $conf->config('cust_main-default_areacode').$phonen
2189 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2190 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2191 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2192 $phonen = "$1-$2-$3";
2193 $phonen .= " x$4" if $4;
2194 $self->setfield($field,$phonen);
2196 warn "warning: don't know how to check phone numbers for country $country";
2197 return $self->ut_textn($field);
2204 Check/untaint hexadecimal values.
2209 my($self, $field) = @_;
2210 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2211 or return "Illegal (hex) $field: ". $self->getfield($field);
2212 $self->setfield($field, uc($1));
2216 =item ut_hexn COLUMN
2218 Check/untaint hexadecimal values. May be null.
2223 my($self, $field) = @_;
2224 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2225 or return "Illegal (hex) $field: ". $self->getfield($field);
2226 $self->setfield($field, uc($1));
2230 =item ut_mac_addr COLUMN
2232 Check/untaint mac addresses. May be null.
2237 my($self, $field) = @_;
2239 my $mac = $self->get($field);
2242 $self->set($field, $mac);
2244 my $e = $self->ut_hex($field);
2247 return "Illegal (mac address) $field: ". $self->getfield($field)
2248 unless length($self->getfield($field)) == 12;
2254 =item ut_mac_addrn COLUMN
2256 Check/untaint mac addresses. May be null.
2261 my($self, $field) = @_;
2262 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2267 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2273 my( $self, $field ) = @_;
2274 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2275 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2276 or return "Illegal (IP address) $field: ". $self->getfield($field);
2277 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2278 $self->setfield($field, "$1.$2.$3.$4");
2284 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2285 to 127.0.0.1. May be null.
2290 my( $self, $field ) = @_;
2291 if ( $self->getfield($field) =~ /^()$/ ) {
2292 $self->setfield($field,'');
2295 $self->ut_ip($field);
2299 =item ut_ip46 COLUMN
2301 Check/untaint IPv4 or IPv6 address.
2306 my( $self, $field ) = @_;
2307 my $ip = NetAddr::IP->new($self->getfield($field))
2308 or return "Illegal (IP address) $field: ".$self->getfield($field);
2309 $self->setfield($field, lc($ip->addr));
2315 Check/untaint IPv6 or IPv6 address. May be null.
2320 my( $self, $field ) = @_;
2321 if ( $self->getfield($field) =~ /^$/ ) {
2322 $self->setfield($field, '');
2325 $self->ut_ip46($field);
2328 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2330 Check/untaint coordinates.
2331 Accepts the following forms:
2341 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2342 The latter form (that is, the MMM are thousands of minutes) is
2343 assumed if the "MMM" is exactly three digits or two digits > 59.
2345 To be safe, just use the DDD.DDDDD form.
2347 If LOWER or UPPER are specified, then the coordinate is checked
2348 for lower and upper bounds, respectively.
2353 my ($self, $field) = (shift, shift);
2356 if ( $field =~ /latitude/ ) {
2357 $lower = $lat_lower;
2359 } elsif ( $field =~ /longitude/ ) {
2361 $upper = $lon_upper;
2364 my $coord = $self->getfield($field);
2365 my $neg = $coord =~ s/^(-)//;
2367 my ($d, $m, $s) = (0, 0, 0);
2370 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2371 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2372 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2374 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2377 return "Invalid (coordinate with minutes > 59) $field: "
2378 . $self->getfield($field);
2381 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2383 if (defined($lower) and ($coord < $lower)) {
2384 return "Invalid (coordinate < $lower) $field: "
2385 . $self->getfield($field);;
2388 if (defined($upper) and ($coord > $upper)) {
2389 return "Invalid (coordinate > $upper) $field: "
2390 . $self->getfield($field);;
2393 $self->setfield($field, $coord);
2397 return "Invalid (coordinate) $field: " . $self->getfield($field);
2401 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2403 Same as ut_coord, except optionally null.
2409 my ($self, $field) = (shift, shift);
2411 if ($self->getfield($field) =~ /^\s*$/) {
2414 return $self->ut_coord($field, @_);
2420 =item ut_domain COLUMN
2422 Check/untaint host and domain names.
2427 my( $self, $field ) = @_;
2428 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2429 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2430 or return "Illegal (domain) $field: ". $self->getfield($field);
2431 $self->setfield($field,$1);
2435 =item ut_name COLUMN
2437 Check/untaint proper names; allows alphanumerics, spaces and the following
2438 punctuation: , . - '
2445 my( $self, $field ) = @_;
2446 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2447 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2448 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2449 $self->setfield($field,$1);
2455 Check/untaint zip codes.
2459 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2462 my( $self, $field, $country ) = @_;
2464 if ( $country eq 'US' ) {
2466 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2467 or return gettext('illegal_zip'). " $field for country $country: ".
2468 $self->getfield($field);
2469 $self->setfield($field, $1);
2471 } elsif ( $country eq 'CA' ) {
2473 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2474 or return gettext('illegal_zip'). " $field for country $country: ".
2475 $self->getfield($field);
2476 $self->setfield($field, "$1 $2");
2480 if ( $self->getfield($field) =~ /^\s*$/
2481 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2484 $self->setfield($field,'');
2486 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2487 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2488 $self->setfield($field,$1);
2496 =item ut_country COLUMN
2498 Check/untaint country codes. Country names are changed to codes, if possible -
2499 see L<Locale::Country>.
2504 my( $self, $field ) = @_;
2505 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2506 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2507 && country2code($1) ) {
2508 $self->setfield($field,uc(country2code($1)));
2511 $self->getfield($field) =~ /^(\w\w)$/
2512 or return "Illegal (country) $field: ". $self->getfield($field);
2513 $self->setfield($field,uc($1));
2517 =item ut_anything COLUMN
2519 Untaints arbitrary data. Be careful.
2524 my( $self, $field ) = @_;
2525 $self->getfield($field) =~ /^(.*)$/s
2526 or return "Illegal $field: ". $self->getfield($field);
2527 $self->setfield($field,$1);
2531 =item ut_enum COLUMN CHOICES_ARRAYREF
2533 Check/untaint a column, supplying all possible choices, like the "enum" type.
2538 my( $self, $field, $choices ) = @_;
2539 foreach my $choice ( @$choices ) {
2540 if ( $self->getfield($field) eq $choice ) {
2541 $self->setfield($field, $choice);
2545 return "Illegal (enum) field $field: ". $self->getfield($field);
2548 =item ut_enumn COLUMN CHOICES_ARRAYREF
2550 Like ut_enum, except the null value is also allowed.
2555 my( $self, $field, $choices ) = @_;
2556 $self->getfield($field)
2557 ? $self->ut_enum($field, $choices)
2562 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2564 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2565 on the column first.
2569 sub ut_foreign_key {
2570 my( $self, $field, $table, $foreign ) = @_;
2571 return '' if $no_check_foreign;
2572 qsearchs($table, { $foreign => $self->getfield($field) })
2573 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2574 " in $table.$foreign";
2578 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2580 Like ut_foreign_key, except the null value is also allowed.
2584 sub ut_foreign_keyn {
2585 my( $self, $field, $table, $foreign ) = @_;
2586 $self->getfield($field)
2587 ? $self->ut_foreign_key($field, $table, $foreign)
2591 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2593 Checks this column as an agentnum, taking into account the current users's
2594 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2595 right or rights allowing no agentnum.
2599 sub ut_agentnum_acl {
2600 my( $self, $field ) = (shift, shift);
2601 my $null_acl = scalar(@_) ? shift : [];
2602 $null_acl = [ $null_acl ] unless ref($null_acl);
2604 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2605 return "Illegal agentnum: $error" if $error;
2607 my $curuser = $FS::CurrentUser::CurrentUser;
2609 if ( $self->$field() ) {
2611 return "Access denied"
2612 unless $curuser->agentnum($self->$field());
2616 return "Access denied"
2617 unless grep $curuser->access_right($_), @$null_acl;
2625 =item fields [ TABLE ]
2627 This is a wrapper for real_fields. Code that called
2628 fields before should probably continue to call fields.
2633 my $something = shift;
2635 if($something->isa('FS::Record')) {
2636 $table = $something->table;
2638 $table = $something;
2639 $something = "FS::$table";
2641 return (real_fields($table));
2645 =item encrypt($value)
2647 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2649 Returns the encrypted string.
2651 You should generally not have to worry about calling this, as the system handles this for you.
2656 my ($self, $value) = @_;
2659 if ($conf->exists('encryption')) {
2660 if ($self->is_encrypted($value)) {
2661 # Return the original value if it isn't plaintext.
2662 $encrypted = $value;
2665 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2666 # RSA doesn't like the empty string so let's pack it up
2667 # The database doesn't like the RSA data so uuencode it
2668 my $length = length($value)+1;
2669 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2671 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2678 =item is_encrypted($value)
2680 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2686 my ($self, $value) = @_;
2687 # Possible Bug - Some work may be required here....
2689 if ($value =~ /^M/ && length($value) > 80) {
2696 =item decrypt($value)
2698 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2700 You should generally not have to worry about calling this, as the system handles this for you.
2705 my ($self,$value) = @_;
2706 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2707 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2709 if (ref($rsa_decrypt) =~ /::RSA/) {
2710 my $encrypted = unpack ("u*", $value);
2711 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2712 if ($@) {warn "Decryption Failed"};
2720 #Initialize the Module
2721 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2723 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2724 $rsa_module = $conf->config('encryptionmodule');
2728 eval ("require $rsa_module"); # No need to import the namespace
2731 # Initialize Encryption
2732 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2733 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2734 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2737 # Intitalize Decryption
2738 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2739 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2740 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2744 =item h_search ACTION
2746 Given an ACTION, either "insert", or "delete", returns the appropriate history
2747 record corresponding to this record, if any.
2752 my( $self, $action ) = @_;
2754 my $table = $self->table;
2757 my $primary_key = dbdef->table($table)->primary_key;
2760 'table' => "h_$table",
2761 'hashref' => { $primary_key => $self->$primary_key(),
2762 'history_action' => $action,
2770 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2771 appropriate history record corresponding to this record, if any.
2776 my($self, $action) = @_;
2777 my $h = $self->h_search($action);
2778 $h ? $h->history_date : '';
2781 =item scalar_sql SQL [ PLACEHOLDER, ... ]
2783 A class or object method. Executes the sql statement represented by SQL and
2784 returns a scalar representing the result: the first column of the first row.
2786 Dies on bogus SQL. Returns an empty string if no row is returned.
2788 Typically used for statments which return a single value such as "SELECT
2789 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
2794 my($self, $sql) = (shift, shift);
2795 my $sth = dbh->prepare($sql) or die dbh->errstr;
2797 or die "Unexpected error executing statement $sql: ". $sth->errstr;
2798 my $row = $sth->fetchrow_arrayref or return '';
2799 my $scalar = $row->[0];
2800 defined($scalar) ? $scalar : '';
2809 =item real_fields [ TABLE ]
2811 Returns a list of the real columns in the specified table. Called only by
2812 fields() and other subroutines elsewhere in FS::Record.
2819 my($table_obj) = dbdef->table($table);
2820 confess "Unknown table $table" unless $table_obj;
2821 $table_obj->columns;
2824 =item pvf FIELD_NAME
2826 Returns the FS::part_virtual_field object corresponding to a field in the
2827 record (specified by FIELD_NAME).
2832 my ($self, $name) = (shift, shift);
2834 if(grep /^$name$/, $self->virtual_fields) {
2836 my $concat = [ "'cf_'", "name" ];
2837 return qsearchs({ table => 'part_virtual_field',
2838 hashref => { dbtable => $self->table,
2841 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
2847 =item _quote VALUE, TABLE, COLUMN
2849 This is an internal function used to construct SQL statements. It returns
2850 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2851 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2856 my($value, $table, $column) = @_;
2857 my $column_obj = dbdef->table($table)->column($column);
2858 my $column_type = $column_obj->type;
2859 my $nullable = $column_obj->null;
2861 warn " $table.$column: $value ($column_type".
2862 ( $nullable ? ' NULL' : ' NOT NULL' ).
2863 ")\n" if $DEBUG > 2;
2865 if ( $value eq '' && $nullable ) {
2867 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2868 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2871 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2872 ! $column_type =~ /(char|binary|text)$/i ) {
2874 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
2875 && driver_name eq 'Pg'
2879 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
2880 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
2881 # single-quote the whole mess, and put an "E" in front.
2882 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
2890 This is deprecated. Don't use it.
2892 It returns a hash-type list with the fields of this record's table set true.
2897 carp "warning: hfields is deprecated";
2900 foreach (fields($table)) {
2909 "$_: ". $self->getfield($_). "|"
2910 } (fields($self->table)) );
2913 sub DESTROY { return; }
2917 # #use Carp qw(cluck);
2918 # #cluck "DESTROYING $self";
2919 # warn "DESTROYING $self";
2923 # return ! eval { join('',@_), kill 0; 1; };
2926 =item str2time_sql [ DRIVER_NAME ]
2928 Returns a function to convert to unix time based on database type, such as
2929 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
2930 the str2time_sql_closing method to return a closing string rather than just
2931 using a closing parenthesis as previously suggested.
2933 You can pass an optional driver name such as "Pg", "mysql" or
2934 $dbh->{Driver}->{Name} to return a function for that database instead of
2935 the current database.
2940 my $driver = shift || driver_name;
2942 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
2943 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
2945 warn "warning: unknown database type $driver; guessing how to convert ".
2946 "dates to UNIX timestamps";
2947 return 'EXTRACT(EPOCH FROM ';
2951 =item str2time_sql_closing [ DRIVER_NAME ]
2953 Returns the closing suffix of a function to convert to unix time based on
2954 database type, such as ")::integer" for Pg or ")" for mysql.
2956 You can pass an optional driver name such as "Pg", "mysql" or
2957 $dbh->{Driver}->{Name} to return a function for that database instead of
2958 the current database.
2962 sub str2time_sql_closing {
2963 my $driver = shift || driver_name;
2965 return ' )::INTEGER ' if $driver =~ /^Pg/i;
2969 =item regexp_sql [ DRIVER_NAME ]
2971 Returns the operator to do a regular expression comparison based on database
2972 type, such as '~' for Pg or 'REGEXP' for mysql.
2974 You can pass an optional driver name such as "Pg", "mysql" or
2975 $dbh->{Driver}->{Name} to return a function for that database instead of
2976 the current database.
2981 my $driver = shift || driver_name;
2983 return '~' if $driver =~ /^Pg/i;
2984 return 'REGEXP' if $driver =~ /^mysql/i;
2986 die "don't know how to use regular expressions in ". driver_name." databases";
2990 =item not_regexp_sql [ DRIVER_NAME ]
2992 Returns the operator to do a regular expression negation based on database
2993 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
2995 You can pass an optional driver name such as "Pg", "mysql" or
2996 $dbh->{Driver}->{Name} to return a function for that database instead of
2997 the current database.
3001 sub not_regexp_sql {
3002 my $driver = shift || driver_name;
3004 return '!~' if $driver =~ /^Pg/i;
3005 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3007 die "don't know how to use regular expressions in ". driver_name." databases";
3011 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3013 Returns the items concatendated based on database type, using "CONCAT()" for
3014 mysql and " || " for Pg and other databases.
3016 You can pass an optional driver name such as "Pg", "mysql" or
3017 $dbh->{Driver}->{Name} to return a function for that database instead of
3018 the current database.
3023 my $driver = ref($_[0]) ? driver_name : shift;
3026 if ( $driver =~ /^mysql/i ) {
3027 'CONCAT('. join(',', @$items). ')';
3029 join('||', @$items);
3038 This module should probably be renamed, since much of the functionality is
3039 of general use. It is not completely unlike Adapter::DBI (see below).
3041 Exported qsearch and qsearchs should be deprecated in favor of method calls
3042 (against an FS::Record object like the old search and searchs that qsearch
3043 and qsearchs were on top of.)
3045 The whole fields / hfields mess should be removed.
3047 The various WHERE clauses should be subroutined.
3049 table string should be deprecated in favor of DBIx::DBSchema::Table.
3051 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3052 true maps to the database (and WHERE clauses) would also help.
3054 The ut_ methods should ask the dbdef for a default length.
3056 ut_sqltype (like ut_varchar) should all be defined
3058 A fallback check method should be provided which uses the dbdef.
3060 The ut_money method assumes money has two decimal digits.
3062 The Pg money kludge in the new method only strips `$'.
3064 The ut_phonen method only checks US-style phone numbers.
3066 The _quote function should probably use ut_float instead of a regex.
3068 All the subroutines probably should be methods, here or elsewhere.
3070 Probably should borrow/use some dbdef methods where appropriate (like sub
3073 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3074 or allow it to be set. Working around it is ugly any way around - DBI should
3075 be fixed. (only affects RDBMS which return uppercase column names)
3077 ut_zip should take an optional country like ut_phone.
3081 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3083 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.