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 } elsif ( $op eq '!=' ) {
581 qq-( $column IS NULL OR $column != ? )-;
582 #if this needs to be re-enabled, it needs to use a custom op like
583 #"APPROX=" or something (better name?, not '=', to avoid affecting other
585 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
586 # ( "$column <= ?", "$column >= ?" );
590 } @{ $real_fields } );
593 =item by_key PRIMARY_KEY_VALUE
595 This is a class method that returns the record with the given primary key
596 value. This method is only useful in FS::Record subclasses. For example:
598 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
602 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
607 my ($class, $pkey_value) = @_;
609 my $table = $class->table
610 or croak "No table for $class found";
612 my $dbdef_table = dbdef->table($table)
613 or die "No schema for table $table found - ".
614 "do you need to create it or run dbdef-create?";
615 my $pkey = $dbdef_table->primary_key
616 or die "No primary key for table $table";
618 return qsearchs($table, { $pkey => $pkey_value });
621 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
623 Experimental JOINed search method. Using this method, you can execute a
624 single SELECT spanning multiple tables, and cache the results for subsequent
625 method calls. Interface will almost definately change in an incompatible
633 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
634 my $cache = FS::SearchCache->new( $ptable, $pkey );
637 grep { !$saw{$_->getfield($pkey)}++ }
638 qsearch($table, $record, $select, $extra_sql, $cache )
642 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
644 Same as qsearch, except that if more than one record matches, it B<carp>s but
645 returns the first. If this happens, you either made a logic error in asking
646 for a single item, or your data is corrupted.
650 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
652 my(@result) = qsearch(@_);
653 cluck "warning: Multiple records in scalar search ($table)"
654 if scalar(@result) > 1;
655 #should warn more vehemently if the search was on a primary key?
656 scalar(@result) ? ($result[0]) : ();
667 Returns the table name.
672 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
679 Returns the DBIx::DBSchema::Table object for the table.
685 my($table)=$self->table;
686 dbdef->table($table);
691 Returns the primary key for the table.
697 my $pkey = $self->dbdef_table->primary_key;
700 =item get, getfield COLUMN
702 Returns the value of the column/field/key COLUMN.
707 my($self,$field) = @_;
708 # to avoid "Use of unitialized value" errors
709 if ( defined ( $self->{Hash}->{$field} ) ) {
710 $self->{Hash}->{$field};
720 =item set, setfield COLUMN, VALUE
722 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
727 my($self,$field,$value) = @_;
728 $self->{'modified'} = 1;
729 $self->{'Hash'}->{$field} = $value;
738 Returns true if the column/field/key COLUMN exists.
743 my($self,$field) = @_;
744 exists($self->{Hash}->{$field});
747 =item AUTLOADED METHODS
749 $record->column is a synonym for $record->get('column');
751 $record->column('value') is a synonym for $record->set('column','value');
758 my($field)=$AUTOLOAD;
760 if ( defined($value) ) {
761 confess "errant AUTOLOAD $field for $self (arg $value)"
762 unless blessed($self) && $self->can('setfield');
763 $self->setfield($field,$value);
765 confess "errant AUTOLOAD $field for $self (no args)"
766 unless blessed($self) && $self->can('getfield');
767 $self->getfield($field);
773 # my $field = $AUTOLOAD;
775 # if ( defined($_[1]) ) {
776 # $_[0]->setfield($field, $_[1]);
778 # $_[0]->getfield($field);
784 Returns a list of the column/value pairs, usually for assigning to a new hash.
786 To make a distinct duplicate of an FS::Record object, you can do:
788 $new = new FS::Record ( $old->table, { $old->hash } );
794 confess $self. ' -> hash: Hash attribute is undefined'
795 unless defined($self->{'Hash'});
796 %{ $self->{'Hash'} };
801 Returns a reference to the column/value hash. This may be deprecated in the
802 future; if there's a reason you can't just use the autoloaded or get/set
814 Returns true if any of this object's values have been modified with set (or via
815 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
825 =item select_for_update
827 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
832 sub select_for_update {
834 my $primary_key = $self->primary_key;
837 'table' => $self->table,
838 'hashref' => { $primary_key => $self->$primary_key() },
839 'extra_sql' => 'FOR UPDATE',
845 Locks this table with a database-driver specific lock method. This is used
846 as a mutex in order to do a duplicate search.
848 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
850 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
852 Errors are fatal; no useful return value.
854 Note: To use this method for new tables other than svc_acct and svc_phone,
855 edit freeside-upgrade and add those tables to the duplicate_lock list.
861 my $table = $self->table;
863 warn "$me locking $table table\n" if $DEBUG;
865 if ( driver_name =~ /^Pg/i ) {
867 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
870 } elsif ( driver_name =~ /^mysql/i ) {
872 dbh->do("SELECT * FROM duplicate_lock
873 WHERE lockname = '$table'
875 ) or die dbh->errstr;
879 die "unknown database ". driver_name. "; don't know how to lock table";
883 warn "$me acquired $table table lock\n" if $DEBUG;
889 Inserts this record to the database. If there is an error, returns the error,
890 otherwise returns false.
898 warn "$self -> insert" if $DEBUG;
900 my $error = $self->check;
901 return $error if $error;
903 #single-field unique keys are given a value if false
904 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
905 foreach ( $self->dbdef_table->unique_singles) {
906 $self->unique($_) unless $self->getfield($_);
909 #and also the primary key, if the database isn't going to
910 my $primary_key = $self->dbdef_table->primary_key;
912 if ( $primary_key ) {
913 my $col = $self->dbdef_table->column($primary_key);
916 uc($col->type) =~ /^(BIG)?SERIAL\d?/
917 || ( driver_name eq 'Pg'
918 && defined($col->default)
919 && $col->quoted_default =~ /^nextval\(/i
921 || ( driver_name eq 'mysql'
922 && defined($col->local)
923 && $col->local =~ /AUTO_INCREMENT/i
925 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
928 my $table = $self->table;
930 # Encrypt before the database
931 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
932 && scalar( eval '@FS::'. $table . '::encrypted_fields')
933 && $conf->exists('encryption')
935 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
936 next if $field eq 'payinfo'
937 && ($self->isa('FS::payinfo_transaction_Mixin')
938 || $self->isa('FS::payinfo_Mixin') )
940 && !grep { $self->payby eq $_ } @encrypt_payby;
941 $saved->{$field} = $self->getfield($field);
942 $self->setfield($field, $self->encrypt($self->getfield($field)));
946 #false laziness w/delete
948 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
951 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
954 my $statement = "INSERT INTO $table ";
955 if ( @real_fields ) {
958 join( ', ', @real_fields ).
960 join( ', ', @values ).
964 $statement .= 'DEFAULT VALUES';
966 warn "[debug]$me $statement\n" if $DEBUG > 1;
967 my $sth = dbh->prepare($statement) or return dbh->errstr;
969 local $SIG{HUP} = 'IGNORE';
970 local $SIG{INT} = 'IGNORE';
971 local $SIG{QUIT} = 'IGNORE';
972 local $SIG{TERM} = 'IGNORE';
973 local $SIG{TSTP} = 'IGNORE';
974 local $SIG{PIPE} = 'IGNORE';
976 $sth->execute or return $sth->errstr;
978 # get inserted id from the database, if applicable & needed
979 if ( $db_seq && ! $self->getfield($primary_key) ) {
980 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
984 if ( driver_name eq 'Pg' ) {
986 #my $oid = $sth->{'pg_oid_status'};
987 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
989 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
990 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
991 dbh->rollback if $FS::UID::AutoCommit;
992 return "can't parse $table.$primary_key default value".
993 " for sequence name: $default";
997 my $i_sql = "SELECT currval('$sequence')";
998 my $i_sth = dbh->prepare($i_sql) or do {
999 dbh->rollback if $FS::UID::AutoCommit;
1002 $i_sth->execute() or do { #$i_sth->execute($oid)
1003 dbh->rollback if $FS::UID::AutoCommit;
1004 return $i_sth->errstr;
1006 $insertid = $i_sth->fetchrow_arrayref->[0];
1008 } elsif ( driver_name eq 'mysql' ) {
1010 $insertid = dbh->{'mysql_insertid'};
1011 # work around mysql_insertid being null some of the time, ala RT :/
1012 unless ( $insertid ) {
1013 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1014 "using SELECT LAST_INSERT_ID();";
1015 my $i_sql = "SELECT LAST_INSERT_ID()";
1016 my $i_sth = dbh->prepare($i_sql) or do {
1017 dbh->rollback if $FS::UID::AutoCommit;
1020 $i_sth->execute or do {
1021 dbh->rollback if $FS::UID::AutoCommit;
1022 return $i_sth->errstr;
1024 $insertid = $i_sth->fetchrow_arrayref->[0];
1029 dbh->rollback if $FS::UID::AutoCommit;
1030 return "don't know how to retreive inserted ids from ". driver_name.
1031 ", try using counterfiles (maybe run dbdef-create?)";
1035 $self->setfield($primary_key, $insertid);
1040 if ( defined dbdef->table('h_'. $table) ) {
1041 my $h_statement = $self->_h_statement('insert');
1042 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1043 $h_sth = dbh->prepare($h_statement) or do {
1044 dbh->rollback if $FS::UID::AutoCommit;
1050 $h_sth->execute or return $h_sth->errstr if $h_sth;
1052 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1054 # Now that it has been saved, reset the encrypted fields so that $new
1055 # can still be used.
1056 foreach my $field (keys %{$saved}) {
1057 $self->setfield($field, $saved->{$field});
1065 Depriciated (use insert instead).
1070 cluck "warning: FS::Record::add deprecated!";
1071 insert @_; #call method in this scope
1076 Delete this record from the database. If there is an error, returns the error,
1077 otherwise returns false.
1084 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1086 $self->getfield($_) eq ''
1087 #? "( $_ IS NULL OR $_ = \"\" )"
1088 ? ( driver_name eq 'Pg'
1090 : "( $_ IS NULL OR $_ = \"\" )"
1092 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1093 } ( $self->dbdef_table->primary_key )
1094 ? ( $self->dbdef_table->primary_key)
1095 : real_fields($self->table)
1097 warn "[debug]$me $statement\n" if $DEBUG > 1;
1098 my $sth = dbh->prepare($statement) or return dbh->errstr;
1101 if ( defined dbdef->table('h_'. $self->table) ) {
1102 my $h_statement = $self->_h_statement('delete');
1103 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1104 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1109 my $primary_key = $self->dbdef_table->primary_key;
1111 local $SIG{HUP} = 'IGNORE';
1112 local $SIG{INT} = 'IGNORE';
1113 local $SIG{QUIT} = 'IGNORE';
1114 local $SIG{TERM} = 'IGNORE';
1115 local $SIG{TSTP} = 'IGNORE';
1116 local $SIG{PIPE} = 'IGNORE';
1118 my $rc = $sth->execute or return $sth->errstr;
1119 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1120 $h_sth->execute or return $h_sth->errstr if $h_sth;
1122 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1124 #no need to needlessly destoy the data either (causes problems actually)
1125 #undef $self; #no need to keep object!
1132 Depriciated (use delete instead).
1137 cluck "warning: FS::Record::del deprecated!";
1138 &delete(@_); #call method in this scope
1141 =item replace OLD_RECORD
1143 Replace the OLD_RECORD with this one in the database. If there is an error,
1144 returns the error, otherwise returns false.
1149 my ($new, $old) = (shift, shift);
1151 $old = $new->replace_old unless defined($old);
1153 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1155 if ( $new->can('replace_check') ) {
1156 my $error = $new->replace_check($old);
1157 return $error if $error;
1160 return "Records not in same table!" unless $new->table eq $old->table;
1162 my $primary_key = $old->dbdef_table->primary_key;
1163 return "Can't change primary key $primary_key ".
1164 'from '. $old->getfield($primary_key).
1165 ' to ' . $new->getfield($primary_key)
1167 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1169 my $error = $new->check;
1170 return $error if $error;
1172 # Encrypt for replace
1174 if ( $conf->exists('encryption')
1175 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1176 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1178 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1179 next if $field eq 'payinfo'
1180 && ($new->isa('FS::payinfo_transaction_Mixin')
1181 || $new->isa('FS::payinfo_Mixin') )
1183 && !grep { $new->payby eq $_ } @encrypt_payby;
1184 $saved->{$field} = $new->getfield($field);
1185 $new->setfield($field, $new->encrypt($new->getfield($field)));
1189 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1190 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1191 ? ($_, $new->getfield($_)) : () } $old->fields;
1193 unless (keys(%diff) || $no_update_diff ) {
1194 carp "[warning]$me ". ref($new)."->replace ".
1195 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1196 ": records identical"
1197 unless $nowarn_identical;
1201 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1203 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1204 } real_fields($old->table)
1209 if ( $old->getfield($_) eq '' ) {
1211 #false laziness w/qsearch
1212 if ( driver_name eq 'Pg' ) {
1213 my $type = $old->dbdef_table->column($_)->type;
1214 if ( $type =~ /(int|(big)?serial)/i ) {
1217 qq-( $_ IS NULL OR $_ = '' )-;
1220 qq-( $_ IS NULL OR $_ = "" )-;
1224 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1227 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1230 warn "[debug]$me $statement\n" if $DEBUG > 1;
1231 my $sth = dbh->prepare($statement) or return dbh->errstr;
1234 if ( defined dbdef->table('h_'. $old->table) ) {
1235 my $h_old_statement = $old->_h_statement('replace_old');
1236 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1237 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1243 if ( defined dbdef->table('h_'. $new->table) ) {
1244 my $h_new_statement = $new->_h_statement('replace_new');
1245 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1246 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1251 local $SIG{HUP} = 'IGNORE';
1252 local $SIG{INT} = 'IGNORE';
1253 local $SIG{QUIT} = 'IGNORE';
1254 local $SIG{TERM} = 'IGNORE';
1255 local $SIG{TSTP} = 'IGNORE';
1256 local $SIG{PIPE} = 'IGNORE';
1258 my $rc = $sth->execute or return $sth->errstr;
1259 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1260 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1261 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1263 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1265 # Now that it has been saved, reset the encrypted fields so that $new
1266 # can still be used.
1267 foreach my $field (keys %{$saved}) {
1268 $new->setfield($field, $saved->{$field});
1276 my( $self ) = shift;
1277 warn "[$me] replace called with no arguments; autoloading old record\n"
1280 my $primary_key = $self->dbdef_table->primary_key;
1281 if ( $primary_key ) {
1282 $self->by_key( $self->$primary_key() ) #this is what's returned
1283 or croak "can't find ". $self->table. ".$primary_key ".
1284 $self->$primary_key();
1286 croak $self->table. " has no primary key; pass old record as argument";
1293 Depriciated (use replace instead).
1298 cluck "warning: FS::Record::rep deprecated!";
1299 replace @_; #call method in this scope
1304 Checks custom fields. Subclasses should still provide a check method to validate
1305 non-custom fields, foreign keys, etc., and call this method via $self->SUPER::check.
1311 foreach my $field ($self->virtual_fields) {
1312 my $error = $self->ut_textn($field);
1313 return $error if $error;
1318 =item virtual_fields [ TABLE ]
1320 Returns a list of virtual fields defined for the table. This should not
1321 be exported, and should only be called as an instance or class method.
1325 sub virtual_fields {
1328 $table = $self->table or confess "virtual_fields called on non-table";
1330 confess "Unknown table $table" unless dbdef->table($table);
1332 return () unless dbdef->table('part_virtual_field');
1334 unless ( $virtual_fields_cache{$table} ) {
1335 my $concat = [ "'cf_'", "name" ];
1336 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1337 "WHERE dbtable = '$table'";
1339 my $result = $dbh->selectcol_arrayref($query);
1340 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1342 $virtual_fields_cache{$table} = $result;
1345 @{$virtual_fields_cache{$table}};
1349 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1351 Processes a batch import as a queued JSRPC job
1353 JOB is an FS::queue entry.
1355 OPTIONS_HASHREF can have the following keys:
1361 Table name (required).
1365 Listref of field names for static fields. They will be given values from the
1366 PARAMS hashref and passed as a "params" hashref to batch_import.
1370 Formats hashref. Keys are field names, values are listrefs that define the
1373 Each listref value can be a column name or a code reference. Coderefs are run
1374 with the row object, data and a FS::Conf object as the three parameters.
1375 For example, this coderef does the same thing as using the "columnname" string:
1378 my( $record, $data, $conf ) = @_;
1379 $record->columnname( $data );
1382 Coderefs are run after all "column name" fields are assigned.
1386 Optional format hashref of types. Keys are field names, values are "csv",
1387 "xls" or "fixedlength". Overrides automatic determination of file type
1390 =item format_headers
1392 Optional format hashref of header lines. Keys are field names, values are 0
1393 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1396 =item format_sep_chars
1398 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1399 CSV separation character.
1401 =item format_fixedlenth_formats
1403 Optional format hashref of fixed length format defintiions. Keys are field
1404 names, values Parse::FixedLength listrefs of field definitions.
1408 Set true to default to CSV file type if the filename does not contain a
1409 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1414 PARAMS is a base64-encoded Storable string containing the POSTed data as
1415 a hash ref. It normally contains at least one field, "uploaded files",
1416 generated by /elements/file-upload.html and containing the list of uploaded
1417 files. Currently only supports a single file named "file".
1421 use Storable qw(thaw);
1424 sub process_batch_import {
1425 my($job, $opt) = ( shift, shift );
1427 my $table = $opt->{table};
1428 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1429 my %formats = %{ $opt->{formats} };
1431 my $param = thaw(decode_base64(shift));
1432 warn Dumper($param) if $DEBUG;
1434 my $files = $param->{'uploaded_files'}
1435 or die "No files provided.\n";
1437 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1439 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1440 my $file = $dir. $files{'file'};
1445 formats => \%formats,
1446 format_types => $opt->{format_types},
1447 format_headers => $opt->{format_headers},
1448 format_sep_chars => $opt->{format_sep_chars},
1449 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1450 format_xml_formats => $opt->{format_xml_formats},
1451 format_row_callbacks => $opt->{format_row_callbacks},
1456 format => $param->{format},
1457 params => { map { $_ => $param->{$_} } @pass_params },
1459 default_csv => $opt->{default_csv},
1460 postinsert_callback => $opt->{postinsert_callback},
1463 if ( $opt->{'batch_namecol'} ) {
1464 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1465 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1468 my $error = FS::Record::batch_import( \%iopt );
1472 die "$error\n" if $error;
1475 =item batch_import PARAM_HASHREF
1477 Class method for batch imports. Available params:
1483 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1489 =item format_headers
1491 =item format_sep_chars
1493 =item format_fixedlength_formats
1495 =item format_row_callbacks
1497 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1499 =item preinsert_callback
1501 =item postinsert_callback
1507 FS::queue object, will be updated with progress
1513 csv, xls, fixedlength, xml
1524 warn "$me batch_import call with params: \n". Dumper($param)
1527 my $table = $param->{table};
1529 my $job = $param->{job};
1530 my $file = $param->{file};
1531 my $params = $param->{params} || {};
1533 my( $type, $header, $sep_char, $fixedlength_format,
1534 $xml_format, $row_callback, @fields );
1536 my $postinsert_callback = '';
1537 $postinsert_callback = $param->{'postinsert_callback'}
1538 if $param->{'postinsert_callback'};
1539 my $preinsert_callback = '';
1540 $preinsert_callback = $param->{'preinsert_callback'}
1541 if $param->{'preinsert_callback'};
1543 if ( $param->{'format'} ) {
1545 my $format = $param->{'format'};
1546 my $formats = $param->{formats};
1547 die "unknown format $format" unless exists $formats->{ $format };
1549 $type = $param->{'format_types'}
1550 ? $param->{'format_types'}{ $format }
1551 : $param->{type} || 'csv';
1554 $header = $param->{'format_headers'}
1555 ? $param->{'format_headers'}{ $param->{'format'} }
1558 $sep_char = $param->{'format_sep_chars'}
1559 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1562 $fixedlength_format =
1563 $param->{'format_fixedlength_formats'}
1564 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1568 $param->{'format_xml_formats'}
1569 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1573 $param->{'format_row_callbacks'}
1574 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1577 @fields = @{ $formats->{ $format } };
1579 } elsif ( $param->{'fields'} ) {
1581 $type = ''; #infer from filename
1584 $fixedlength_format = '';
1586 @fields = @{ $param->{'fields'} };
1589 die "neither format nor fields specified";
1592 #my $file = $param->{file};
1595 if ( $file =~ /\.(\w+)$/i ) {
1599 warn "can't parse file type from filename $file; defaulting to CSV";
1603 if $param->{'default_csv'} && $type ne 'xls';
1611 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1613 if ( $type eq 'csv' ) {
1616 $attr{sep_char} = $sep_char if $sep_char;
1617 $parser = new Text::CSV_XS \%attr;
1619 } elsif ( $type eq 'fixedlength' ) {
1621 eval "use Parse::FixedLength;";
1623 $parser = Parse::FixedLength->new($fixedlength_format);
1627 die "Unknown file type $type\n";
1630 @buffer = split(/\r?\n/, slurp($file) );
1631 splice(@buffer, 0, ($header || 0) );
1632 $count = scalar(@buffer);
1634 } elsif ( $type eq 'xls' ) {
1636 eval "use Spreadsheet::ParseExcel;";
1639 eval "use DateTime::Format::Excel;";
1640 #for now, just let the error be thrown if it is used, since only CDR
1641 # formats bill_west and troop use it, not other excel-parsing things
1644 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1646 $parser = $excel->{Worksheet}[0]; #first sheet
1648 $count = $parser->{MaxRow} || $parser->{MinRow};
1651 $row = $header || 0;
1652 } elsif ( $type eq 'xml' ) {
1654 eval "use XML::Simple;";
1656 my $xmlrow = $xml_format->{'xmlrow'};
1657 $parser = $xml_format->{'xmlkeys'};
1658 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1659 my $data = XML::Simple::XMLin(
1661 'SuppressEmpty' => '', #sets empty values to ''
1665 $rows = $rows->{$_} foreach @$xmlrow;
1666 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1667 $count = @buffer = @$rows;
1669 die "Unknown file type $type\n";
1674 local $SIG{HUP} = 'IGNORE';
1675 local $SIG{INT} = 'IGNORE';
1676 local $SIG{QUIT} = 'IGNORE';
1677 local $SIG{TERM} = 'IGNORE';
1678 local $SIG{TSTP} = 'IGNORE';
1679 local $SIG{PIPE} = 'IGNORE';
1681 my $oldAutoCommit = $FS::UID::AutoCommit;
1682 local $FS::UID::AutoCommit = 0;
1685 #my $params = $param->{params} || {};
1686 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1687 my $batch_col = $param->{'batch_keycol'};
1689 my $batch_class = 'FS::'. $param->{'batch_table'};
1690 my $batch = $batch_class->new({
1691 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1693 my $error = $batch->insert;
1695 $dbh->rollback if $oldAutoCommit;
1696 return "can't insert batch record: $error";
1698 #primary key via dbdef? (so the column names don't have to match)
1699 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1701 $params->{ $batch_col } = $batch_value;
1704 #my $job = $param->{job};
1707 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1711 if ( $type eq 'csv' ) {
1713 last unless scalar(@buffer);
1714 $line = shift(@buffer);
1716 next if $line =~ /^\s*$/; #skip empty lines
1718 $line = &{$row_callback}($line) if $row_callback;
1720 next if $line =~ /^\s*$/; #skip empty lines
1722 $parser->parse($line) or do {
1723 $dbh->rollback if $oldAutoCommit;
1724 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
1726 @columns = $parser->fields();
1728 } elsif ( $type eq 'fixedlength' ) {
1730 last unless scalar(@buffer);
1731 $line = shift(@buffer);
1733 @columns = $parser->parse($line);
1735 } elsif ( $type eq 'xls' ) {
1737 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1738 || ! $parser->{Cells}[$row];
1740 my @row = @{ $parser->{Cells}[$row] };
1741 @columns = map $_->{Val}, @row;
1744 #warn $z++. ": $_\n" for @columns;
1746 } elsif ( $type eq 'xml' ) {
1747 # $parser = [ 'Column0Key', 'Column1Key' ... ]
1748 last unless scalar(@buffer);
1749 my $row = shift @buffer;
1750 @columns = @{ $row }{ @$parser };
1752 die "Unknown file type $type\n";
1756 my %hash = %$params;
1758 foreach my $field ( @fields ) {
1760 my $value = shift @columns;
1762 if ( ref($field) eq 'CODE' ) {
1763 #&{$field}(\%hash, $value);
1764 push @later, $field, $value;
1766 #??? $hash{$field} = $value if length($value);
1767 $hash{$field} = $value if defined($value) && length($value);
1772 #my $table = $param->{table};
1773 my $class = "FS::$table";
1775 my $record = $class->new( \%hash );
1778 while ( scalar(@later) ) {
1779 my $sub = shift @later;
1780 my $data = shift @later;
1782 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
1785 $dbh->rollback if $oldAutoCommit;
1786 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
1788 last if exists( $param->{skiprow} );
1790 next if exists( $param->{skiprow} );
1792 if ( $preinsert_callback ) {
1793 my $error = &{$preinsert_callback}($record, $param);
1795 $dbh->rollback if $oldAutoCommit;
1796 return "preinsert_callback error". ( $line ? " for $line" : '' ).
1799 next if exists $param->{skiprow} && $param->{skiprow};
1802 my $error = $record->insert;
1805 $dbh->rollback if $oldAutoCommit;
1806 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1812 if ( $postinsert_callback ) {
1813 my $error = &{$postinsert_callback}($record, $param);
1815 $dbh->rollback if $oldAutoCommit;
1816 return "postinsert_callback error". ( $line ? " for $line" : '' ).
1821 if ( $job && time - $min_sec > $last ) { #progress bar
1822 $job->update_statustext( int(100 * $imported / $count) );
1828 unless ( $imported || $param->{empty_ok} ) {
1829 $dbh->rollback if $oldAutoCommit;
1830 return "Empty file!";
1833 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1840 my( $self, $action, $time ) = @_;
1844 my %nohistory = map { $_=>1 } $self->nohistory_fields;
1847 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
1848 real_fields($self->table);
1851 # If we're encrypting then don't store the payinfo in the history
1852 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
1853 @fields = grep { $_ ne 'payinfo' } @fields;
1856 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1858 "INSERT INTO h_". $self->table. " ( ".
1859 join(', ', qw(history_date history_user history_action), @fields ).
1861 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1868 B<Warning>: External use is B<deprecated>.
1870 Replaces COLUMN in record with a unique number, using counters in the
1871 filesystem. Used by the B<insert> method on single-field unique columns
1872 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1873 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1875 Returns the new value.
1880 my($self,$field) = @_;
1881 my($table)=$self->table;
1883 croak "Unique called on field $field, but it is ",
1884 $self->getfield($field),
1886 if $self->getfield($field);
1888 #warn "table $table is tainted" if is_tainted($table);
1889 #warn "field $field is tainted" if is_tainted($field);
1891 my($counter) = new File::CounterFile "$table.$field",0;
1893 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1895 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1898 my $index = $counter->inc;
1899 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1901 $index =~ /^(\d*)$/;
1904 $self->setfield($field,$index);
1908 =item ut_float COLUMN
1910 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1911 null. If there is an error, returns the error, otherwise returns false.
1916 my($self,$field)=@_ ;
1917 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
1918 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
1919 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
1920 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
1921 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1922 $self->setfield($field,$1);
1925 =item ut_floatn COLUMN
1927 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1928 null. If there is an error, returns the error, otherwise returns false.
1932 #false laziness w/ut_ipn
1934 my( $self, $field ) = @_;
1935 if ( $self->getfield($field) =~ /^()$/ ) {
1936 $self->setfield($field,'');
1939 $self->ut_float($field);
1943 =item ut_sfloat COLUMN
1945 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
1946 May not be null. If there is an error, returns the error, otherwise returns
1952 my($self,$field)=@_ ;
1953 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
1954 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
1955 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
1956 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
1957 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1958 $self->setfield($field,$1);
1961 =item ut_sfloatn COLUMN
1963 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1964 null. If there is an error, returns the error, otherwise returns false.
1969 my( $self, $field ) = @_;
1970 if ( $self->getfield($field) =~ /^()$/ ) {
1971 $self->setfield($field,'');
1974 $self->ut_sfloat($field);
1978 =item ut_snumber COLUMN
1980 Check/untaint signed numeric data (whole numbers). If there is an error,
1981 returns the error, otherwise returns false.
1986 my($self, $field) = @_;
1987 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
1988 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1989 $self->setfield($field, "$1$2");
1993 =item ut_snumbern COLUMN
1995 Check/untaint signed numeric data (whole numbers). If there is an error,
1996 returns the error, otherwise returns false.
2001 my($self, $field) = @_;
2002 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2003 or return "Illegal (numeric) $field: ". $self->getfield($field);
2005 return "Illegal (numeric) $field: ". $self->getfield($field)
2008 $self->setfield($field, "$1$2");
2012 =item ut_number COLUMN
2014 Check/untaint simple numeric data (whole numbers). May not be null. If there
2015 is an error, returns the error, otherwise returns false.
2020 my($self,$field)=@_;
2021 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2022 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2023 $self->setfield($field,$1);
2027 =item ut_numbern COLUMN
2029 Check/untaint simple numeric data (whole numbers). May be null. If there is
2030 an error, returns the error, otherwise returns false.
2035 my($self,$field)=@_;
2036 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2037 or return "Illegal (numeric) $field: ". $self->getfield($field);
2038 $self->setfield($field,$1);
2042 =item ut_money COLUMN
2044 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2045 is an error, returns the error, otherwise returns false.
2050 my($self,$field)=@_;
2051 $self->setfield($field, 0) if $self->getfield($field) eq '';
2052 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
2053 or return "Illegal (money) $field: ". $self->getfield($field);
2054 #$self->setfield($field, "$1$2$3" || 0);
2055 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2059 =item ut_moneyn COLUMN
2061 Check/untaint monetary numbers. May be negative. If there
2062 is an error, returns the error, otherwise returns false.
2067 my($self,$field)=@_;
2068 if ($self->getfield($field) eq '') {
2069 $self->setfield($field, '');
2072 $self->ut_money($field);
2075 =item ut_text COLUMN
2077 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2078 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2079 May not be null. If there is an error, returns the error, otherwise returns
2085 my($self,$field)=@_;
2086 #warn "msgcat ". \&msgcat. "\n";
2087 #warn "notexist ". \¬exist. "\n";
2088 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2089 $self->getfield($field)
2090 =~ /^([\wô \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2091 or return gettext('illegal_or_empty_text'). " $field: ".
2092 $self->getfield($field);
2093 $self->setfield($field,$1);
2097 =item ut_textn COLUMN
2099 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2100 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2101 May be null. If there is an error, returns the error, otherwise returns false.
2106 my($self,$field)=@_;
2107 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2108 $self->ut_text($field);
2111 =item ut_alpha COLUMN
2113 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2114 an error, returns the error, otherwise returns false.
2119 my($self,$field)=@_;
2120 $self->getfield($field) =~ /^(\w+)$/
2121 or return "Illegal or empty (alphanumeric) $field: ".
2122 $self->getfield($field);
2123 $self->setfield($field,$1);
2127 =item ut_alphan COLUMN
2129 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2130 error, returns the error, otherwise returns false.
2135 my($self,$field)=@_;
2136 $self->getfield($field) =~ /^(\w*)$/
2137 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2138 $self->setfield($field,$1);
2142 =item ut_alphasn COLUMN
2144 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2145 an error, returns the error, otherwise returns false.
2150 my($self,$field)=@_;
2151 $self->getfield($field) =~ /^([\w ]*)$/
2152 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2153 $self->setfield($field,$1);
2158 =item ut_alpha_lower COLUMN
2160 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2161 there is an error, returns the error, otherwise returns false.
2165 sub ut_alpha_lower {
2166 my($self,$field)=@_;
2167 $self->getfield($field) =~ /[[:upper:]]/
2168 and return "Uppercase characters are not permitted in $field";
2169 $self->ut_alpha($field);
2172 =item ut_phonen COLUMN [ COUNTRY ]
2174 Check/untaint phone numbers. May be null. If there is an error, returns
2175 the error, otherwise returns false.
2177 Takes an optional two-letter ISO country code; without it or with unsupported
2178 countries, ut_phonen simply calls ut_alphan.
2183 my( $self, $field, $country ) = @_;
2184 return $self->ut_alphan($field) unless defined $country;
2185 my $phonen = $self->getfield($field);
2186 if ( $phonen eq '' ) {
2187 $self->setfield($field,'');
2188 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2190 $phonen = $conf->config('cust_main-default_areacode').$phonen
2191 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2192 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2193 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2194 $phonen = "$1-$2-$3";
2195 $phonen .= " x$4" if $4;
2196 $self->setfield($field,$phonen);
2198 warn "warning: don't know how to check phone numbers for country $country";
2199 return $self->ut_textn($field);
2206 Check/untaint hexadecimal values.
2211 my($self, $field) = @_;
2212 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2213 or return "Illegal (hex) $field: ". $self->getfield($field);
2214 $self->setfield($field, uc($1));
2218 =item ut_hexn COLUMN
2220 Check/untaint hexadecimal values. May be null.
2225 my($self, $field) = @_;
2226 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2227 or return "Illegal (hex) $field: ". $self->getfield($field);
2228 $self->setfield($field, uc($1));
2232 =item ut_mac_addr COLUMN
2234 Check/untaint mac addresses. May be null.
2239 my($self, $field) = @_;
2241 my $mac = $self->get($field);
2244 $self->set($field, $mac);
2246 my $e = $self->ut_hex($field);
2249 return "Illegal (mac address) $field: ". $self->getfield($field)
2250 unless length($self->getfield($field)) == 12;
2256 =item ut_mac_addrn COLUMN
2258 Check/untaint mac addresses. May be null.
2263 my($self, $field) = @_;
2264 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2269 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2275 my( $self, $field ) = @_;
2276 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2277 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2278 or return "Illegal (IP address) $field: ". $self->getfield($field);
2279 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2280 $self->setfield($field, "$1.$2.$3.$4");
2286 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2287 to 127.0.0.1. May be null.
2292 my( $self, $field ) = @_;
2293 if ( $self->getfield($field) =~ /^()$/ ) {
2294 $self->setfield($field,'');
2297 $self->ut_ip($field);
2301 =item ut_ip46 COLUMN
2303 Check/untaint IPv4 or IPv6 address.
2308 my( $self, $field ) = @_;
2309 my $ip = NetAddr::IP->new($self->getfield($field))
2310 or return "Illegal (IP address) $field: ".$self->getfield($field);
2311 $self->setfield($field, lc($ip->addr));
2317 Check/untaint IPv6 or IPv6 address. May be null.
2322 my( $self, $field ) = @_;
2323 if ( $self->getfield($field) =~ /^$/ ) {
2324 $self->setfield($field, '');
2327 $self->ut_ip46($field);
2330 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2332 Check/untaint coordinates.
2333 Accepts the following forms:
2343 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2344 The latter form (that is, the MMM are thousands of minutes) is
2345 assumed if the "MMM" is exactly three digits or two digits > 59.
2347 To be safe, just use the DDD.DDDDD form.
2349 If LOWER or UPPER are specified, then the coordinate is checked
2350 for lower and upper bounds, respectively.
2355 my ($self, $field) = (shift, shift);
2358 if ( $field =~ /latitude/ ) {
2359 $lower = $lat_lower;
2361 } elsif ( $field =~ /longitude/ ) {
2363 $upper = $lon_upper;
2366 my $coord = $self->getfield($field);
2367 my $neg = $coord =~ s/^(-)//;
2369 my ($d, $m, $s) = (0, 0, 0);
2372 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2373 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2374 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2376 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2379 return "Invalid (coordinate with minutes > 59) $field: "
2380 . $self->getfield($field);
2383 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2385 if (defined($lower) and ($coord < $lower)) {
2386 return "Invalid (coordinate < $lower) $field: "
2387 . $self->getfield($field);;
2390 if (defined($upper) and ($coord > $upper)) {
2391 return "Invalid (coordinate > $upper) $field: "
2392 . $self->getfield($field);;
2395 $self->setfield($field, $coord);
2399 return "Invalid (coordinate) $field: " . $self->getfield($field);
2403 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2405 Same as ut_coord, except optionally null.
2411 my ($self, $field) = (shift, shift);
2413 if ($self->getfield($field) =~ /^\s*$/) {
2416 return $self->ut_coord($field, @_);
2422 =item ut_domain COLUMN
2424 Check/untaint host and domain names.
2429 my( $self, $field ) = @_;
2430 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2431 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2432 or return "Illegal (domain) $field: ". $self->getfield($field);
2433 $self->setfield($field,$1);
2437 =item ut_name COLUMN
2439 Check/untaint proper names; allows alphanumerics, spaces and the following
2440 punctuation: , . - '
2447 my( $self, $field ) = @_;
2448 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2449 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2450 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2451 $self->setfield($field,$1);
2457 Check/untaint zip codes.
2461 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2464 my( $self, $field, $country ) = @_;
2466 if ( $country eq 'US' ) {
2468 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2469 or return gettext('illegal_zip'). " $field for country $country: ".
2470 $self->getfield($field);
2471 $self->setfield($field, $1);
2473 } elsif ( $country eq 'CA' ) {
2475 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2476 or return gettext('illegal_zip'). " $field for country $country: ".
2477 $self->getfield($field);
2478 $self->setfield($field, "$1 $2");
2482 if ( $self->getfield($field) =~ /^\s*$/
2483 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2486 $self->setfield($field,'');
2488 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2489 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2490 $self->setfield($field,$1);
2498 =item ut_country COLUMN
2500 Check/untaint country codes. Country names are changed to codes, if possible -
2501 see L<Locale::Country>.
2506 my( $self, $field ) = @_;
2507 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2508 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2509 && country2code($1) ) {
2510 $self->setfield($field,uc(country2code($1)));
2513 $self->getfield($field) =~ /^(\w\w)$/
2514 or return "Illegal (country) $field: ". $self->getfield($field);
2515 $self->setfield($field,uc($1));
2519 =item ut_anything COLUMN
2521 Untaints arbitrary data. Be careful.
2526 my( $self, $field ) = @_;
2527 $self->getfield($field) =~ /^(.*)$/s
2528 or return "Illegal $field: ". $self->getfield($field);
2529 $self->setfield($field,$1);
2533 =item ut_enum COLUMN CHOICES_ARRAYREF
2535 Check/untaint a column, supplying all possible choices, like the "enum" type.
2540 my( $self, $field, $choices ) = @_;
2541 foreach my $choice ( @$choices ) {
2542 if ( $self->getfield($field) eq $choice ) {
2543 $self->setfield($field, $choice);
2547 return "Illegal (enum) field $field: ". $self->getfield($field);
2550 =item ut_enumn COLUMN CHOICES_ARRAYREF
2552 Like ut_enum, except the null value is also allowed.
2557 my( $self, $field, $choices ) = @_;
2558 $self->getfield($field)
2559 ? $self->ut_enum($field, $choices)
2564 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2566 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2567 on the column first.
2571 sub ut_foreign_key {
2572 my( $self, $field, $table, $foreign ) = @_;
2573 return '' if $no_check_foreign;
2574 qsearchs($table, { $foreign => $self->getfield($field) })
2575 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2576 " in $table.$foreign";
2580 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2582 Like ut_foreign_key, except the null value is also allowed.
2586 sub ut_foreign_keyn {
2587 my( $self, $field, $table, $foreign ) = @_;
2588 $self->getfield($field)
2589 ? $self->ut_foreign_key($field, $table, $foreign)
2593 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2595 Checks this column as an agentnum, taking into account the current users's
2596 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2597 right or rights allowing no agentnum.
2601 sub ut_agentnum_acl {
2602 my( $self, $field ) = (shift, shift);
2603 my $null_acl = scalar(@_) ? shift : [];
2604 $null_acl = [ $null_acl ] unless ref($null_acl);
2606 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2607 return "Illegal agentnum: $error" if $error;
2609 my $curuser = $FS::CurrentUser::CurrentUser;
2611 if ( $self->$field() ) {
2613 return "Access denied"
2614 unless $curuser->agentnum($self->$field());
2618 return "Access denied"
2619 unless grep $curuser->access_right($_), @$null_acl;
2627 =item fields [ TABLE ]
2629 This is a wrapper for real_fields. Code that called
2630 fields before should probably continue to call fields.
2635 my $something = shift;
2637 if($something->isa('FS::Record')) {
2638 $table = $something->table;
2640 $table = $something;
2641 $something = "FS::$table";
2643 return (real_fields($table));
2647 =item encrypt($value)
2649 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2651 Returns the encrypted string.
2653 You should generally not have to worry about calling this, as the system handles this for you.
2658 my ($self, $value) = @_;
2661 if ($conf->exists('encryption')) {
2662 if ($self->is_encrypted($value)) {
2663 # Return the original value if it isn't plaintext.
2664 $encrypted = $value;
2667 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2668 # RSA doesn't like the empty string so let's pack it up
2669 # The database doesn't like the RSA data so uuencode it
2670 my $length = length($value)+1;
2671 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2673 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2680 =item is_encrypted($value)
2682 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2688 my ($self, $value) = @_;
2689 # Possible Bug - Some work may be required here....
2691 if ($value =~ /^M/ && length($value) > 80) {
2698 =item decrypt($value)
2700 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2702 You should generally not have to worry about calling this, as the system handles this for you.
2707 my ($self,$value) = @_;
2708 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2709 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2711 if (ref($rsa_decrypt) =~ /::RSA/) {
2712 my $encrypted = unpack ("u*", $value);
2713 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2714 if ($@) {warn "Decryption Failed"};
2722 #Initialize the Module
2723 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2725 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2726 $rsa_module = $conf->config('encryptionmodule');
2730 eval ("require $rsa_module"); # No need to import the namespace
2733 # Initialize Encryption
2734 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2735 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2736 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2739 # Intitalize Decryption
2740 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2741 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2742 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2746 =item h_search ACTION
2748 Given an ACTION, either "insert", or "delete", returns the appropriate history
2749 record corresponding to this record, if any.
2754 my( $self, $action ) = @_;
2756 my $table = $self->table;
2759 my $primary_key = dbdef->table($table)->primary_key;
2762 'table' => "h_$table",
2763 'hashref' => { $primary_key => $self->$primary_key(),
2764 'history_action' => $action,
2772 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2773 appropriate history record corresponding to this record, if any.
2778 my($self, $action) = @_;
2779 my $h = $self->h_search($action);
2780 $h ? $h->history_date : '';
2783 =item scalar_sql SQL [ PLACEHOLDER, ... ]
2785 A class or object method. Executes the sql statement represented by SQL and
2786 returns a scalar representing the result: the first column of the first row.
2788 Dies on bogus SQL. Returns an empty string if no row is returned.
2790 Typically used for statments which return a single value such as "SELECT
2791 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
2796 my($self, $sql) = (shift, shift);
2797 my $sth = dbh->prepare($sql) or die dbh->errstr;
2799 or die "Unexpected error executing statement $sql: ". $sth->errstr;
2800 my $row = $sth->fetchrow_arrayref or return '';
2801 my $scalar = $row->[0];
2802 defined($scalar) ? $scalar : '';
2811 =item real_fields [ TABLE ]
2813 Returns a list of the real columns in the specified table. Called only by
2814 fields() and other subroutines elsewhere in FS::Record.
2821 my($table_obj) = dbdef->table($table);
2822 confess "Unknown table $table" unless $table_obj;
2823 $table_obj->columns;
2826 =item pvf FIELD_NAME
2828 Returns the FS::part_virtual_field object corresponding to a field in the
2829 record (specified by FIELD_NAME).
2834 my ($self, $name) = (shift, shift);
2836 if(grep /^$name$/, $self->virtual_fields) {
2838 my $concat = [ "'cf_'", "name" ];
2839 return qsearchs({ table => 'part_virtual_field',
2840 hashref => { dbtable => $self->table,
2843 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
2849 =item _quote VALUE, TABLE, COLUMN
2851 This is an internal function used to construct SQL statements. It returns
2852 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2853 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2858 my($value, $table, $column) = @_;
2859 my $column_obj = dbdef->table($table)->column($column);
2860 my $column_type = $column_obj->type;
2861 my $nullable = $column_obj->null;
2863 warn " $table.$column: $value ($column_type".
2864 ( $nullable ? ' NULL' : ' NOT NULL' ).
2865 ")\n" if $DEBUG > 2;
2867 if ( $value eq '' && $nullable ) {
2869 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2870 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2873 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2874 ! $column_type =~ /(char|binary|text)$/i ) {
2876 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
2877 && driver_name eq 'Pg'
2881 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
2882 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
2883 # single-quote the whole mess, and put an "E" in front.
2884 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
2892 This is deprecated. Don't use it.
2894 It returns a hash-type list with the fields of this record's table set true.
2899 carp "warning: hfields is deprecated";
2902 foreach (fields($table)) {
2911 "$_: ". $self->getfield($_). "|"
2912 } (fields($self->table)) );
2915 sub DESTROY { return; }
2919 # #use Carp qw(cluck);
2920 # #cluck "DESTROYING $self";
2921 # warn "DESTROYING $self";
2925 # return ! eval { join('',@_), kill 0; 1; };
2928 =item str2time_sql [ DRIVER_NAME ]
2930 Returns a function to convert to unix time based on database type, such as
2931 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
2932 the str2time_sql_closing method to return a closing string rather than just
2933 using a closing parenthesis as previously suggested.
2935 You can pass an optional driver name such as "Pg", "mysql" or
2936 $dbh->{Driver}->{Name} to return a function for that database instead of
2937 the current database.
2942 my $driver = shift || driver_name;
2944 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
2945 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
2947 warn "warning: unknown database type $driver; guessing how to convert ".
2948 "dates to UNIX timestamps";
2949 return 'EXTRACT(EPOCH FROM ';
2953 =item str2time_sql_closing [ DRIVER_NAME ]
2955 Returns the closing suffix of a function to convert to unix time based on
2956 database type, such as ")::integer" for Pg or ")" for mysql.
2958 You can pass an optional driver name such as "Pg", "mysql" or
2959 $dbh->{Driver}->{Name} to return a function for that database instead of
2960 the current database.
2964 sub str2time_sql_closing {
2965 my $driver = shift || driver_name;
2967 return ' )::INTEGER ' if $driver =~ /^Pg/i;
2971 =item regexp_sql [ DRIVER_NAME ]
2973 Returns the operator to do a regular expression comparison based on database
2974 type, such as '~' for Pg or 'REGEXP' for mysql.
2976 You can pass an optional driver name such as "Pg", "mysql" or
2977 $dbh->{Driver}->{Name} to return a function for that database instead of
2978 the current database.
2983 my $driver = shift || driver_name;
2985 return '~' if $driver =~ /^Pg/i;
2986 return 'REGEXP' if $driver =~ /^mysql/i;
2988 die "don't know how to use regular expressions in ". driver_name." databases";
2992 =item not_regexp_sql [ DRIVER_NAME ]
2994 Returns the operator to do a regular expression negation based on database
2995 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
2997 You can pass an optional driver name such as "Pg", "mysql" or
2998 $dbh->{Driver}->{Name} to return a function for that database instead of
2999 the current database.
3003 sub not_regexp_sql {
3004 my $driver = shift || driver_name;
3006 return '!~' if $driver =~ /^Pg/i;
3007 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3009 die "don't know how to use regular expressions in ". driver_name." databases";
3013 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3015 Returns the items concatendated based on database type, using "CONCAT()" for
3016 mysql and " || " for Pg and other databases.
3018 You can pass an optional driver name such as "Pg", "mysql" or
3019 $dbh->{Driver}->{Name} to return a function for that database instead of
3020 the current database.
3025 my $driver = ref($_[0]) ? driver_name : shift;
3028 if ( $driver =~ /^mysql/i ) {
3029 'CONCAT('. join(',', @$items). ')';
3031 join('||', @$items);
3040 This module should probably be renamed, since much of the functionality is
3041 of general use. It is not completely unlike Adapter::DBI (see below).
3043 Exported qsearch and qsearchs should be deprecated in favor of method calls
3044 (against an FS::Record object like the old search and searchs that qsearch
3045 and qsearchs were on top of.)
3047 The whole fields / hfields mess should be removed.
3049 The various WHERE clauses should be subroutined.
3051 table string should be deprecated in favor of DBIx::DBSchema::Table.
3053 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3054 true maps to the database (and WHERE clauses) would also help.
3056 The ut_ methods should ask the dbdef for a default length.
3058 ut_sqltype (like ut_varchar) should all be defined
3060 A fallback check method should be provided which uses the dbdef.
3062 The ut_money method assumes money has two decimal digits.
3064 The Pg money kludge in the new method only strips `$'.
3066 The ut_phonen method only checks US-style phone numbers.
3068 The _quote function should probably use ut_float instead of a regex.
3070 All the subroutines probably should be methods, here or elsewhere.
3072 Probably should borrow/use some dbdef methods where appropriate (like sub
3075 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3076 or allow it to be set. Working around it is ugly any way around - DBI should
3077 be fixed. (only affects RDBMS which return uppercase column names)
3079 ut_zip should take an optional country like ut_phone.
3083 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3085 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.