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 non-null unique keys are given a value if empty
904 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
905 foreach ( $self->dbdef_table->unique_singles) {
906 next if $self->getfield($_);
907 next if $self->dbdef_table->column($_)->null eq 'NULL';
911 #and also the primary key, if the database isn't going to
912 my $primary_key = $self->dbdef_table->primary_key;
914 if ( $primary_key ) {
915 my $col = $self->dbdef_table->column($primary_key);
918 uc($col->type) =~ /^(BIG)?SERIAL\d?/
919 || ( driver_name eq 'Pg'
920 && defined($col->default)
921 && $col->quoted_default =~ /^nextval\(/i
923 || ( driver_name eq 'mysql'
924 && defined($col->local)
925 && $col->local =~ /AUTO_INCREMENT/i
927 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
930 my $table = $self->table;
932 # Encrypt before the database
933 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
934 && scalar( eval '@FS::'. $table . '::encrypted_fields')
935 && $conf->exists('encryption')
937 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
938 next if $field eq 'payinfo'
939 && ($self->isa('FS::payinfo_transaction_Mixin')
940 || $self->isa('FS::payinfo_Mixin') )
942 && !grep { $self->payby eq $_ } @encrypt_payby;
943 $saved->{$field} = $self->getfield($field);
944 $self->setfield($field, $self->encrypt($self->getfield($field)));
948 #false laziness w/delete
950 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
953 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
956 my $statement = "INSERT INTO $table ";
957 if ( @real_fields ) {
960 join( ', ', @real_fields ).
962 join( ', ', @values ).
966 $statement .= 'DEFAULT VALUES';
968 warn "[debug]$me $statement\n" if $DEBUG > 1;
969 my $sth = dbh->prepare($statement) or return dbh->errstr;
971 local $SIG{HUP} = 'IGNORE';
972 local $SIG{INT} = 'IGNORE';
973 local $SIG{QUIT} = 'IGNORE';
974 local $SIG{TERM} = 'IGNORE';
975 local $SIG{TSTP} = 'IGNORE';
976 local $SIG{PIPE} = 'IGNORE';
978 $sth->execute or return $sth->errstr;
980 # get inserted id from the database, if applicable & needed
981 if ( $db_seq && ! $self->getfield($primary_key) ) {
982 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
986 if ( driver_name eq 'Pg' ) {
988 #my $oid = $sth->{'pg_oid_status'};
989 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
991 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
992 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
993 dbh->rollback if $FS::UID::AutoCommit;
994 return "can't parse $table.$primary_key default value".
995 " for sequence name: $default";
999 my $i_sql = "SELECT currval('$sequence')";
1000 my $i_sth = dbh->prepare($i_sql) or do {
1001 dbh->rollback if $FS::UID::AutoCommit;
1004 $i_sth->execute() or do { #$i_sth->execute($oid)
1005 dbh->rollback if $FS::UID::AutoCommit;
1006 return $i_sth->errstr;
1008 $insertid = $i_sth->fetchrow_arrayref->[0];
1010 } elsif ( driver_name eq 'mysql' ) {
1012 $insertid = dbh->{'mysql_insertid'};
1013 # work around mysql_insertid being null some of the time, ala RT :/
1014 unless ( $insertid ) {
1015 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1016 "using SELECT LAST_INSERT_ID();";
1017 my $i_sql = "SELECT LAST_INSERT_ID()";
1018 my $i_sth = dbh->prepare($i_sql) or do {
1019 dbh->rollback if $FS::UID::AutoCommit;
1022 $i_sth->execute or do {
1023 dbh->rollback if $FS::UID::AutoCommit;
1024 return $i_sth->errstr;
1026 $insertid = $i_sth->fetchrow_arrayref->[0];
1031 dbh->rollback if $FS::UID::AutoCommit;
1032 return "don't know how to retreive inserted ids from ". driver_name.
1033 ", try using counterfiles (maybe run dbdef-create?)";
1037 $self->setfield($primary_key, $insertid);
1042 if ( defined dbdef->table('h_'. $table) ) {
1043 my $h_statement = $self->_h_statement('insert');
1044 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1045 $h_sth = dbh->prepare($h_statement) or do {
1046 dbh->rollback if $FS::UID::AutoCommit;
1052 $h_sth->execute or return $h_sth->errstr if $h_sth;
1054 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1056 # Now that it has been saved, reset the encrypted fields so that $new
1057 # can still be used.
1058 foreach my $field (keys %{$saved}) {
1059 $self->setfield($field, $saved->{$field});
1067 Depriciated (use insert instead).
1072 cluck "warning: FS::Record::add deprecated!";
1073 insert @_; #call method in this scope
1078 Delete this record from the database. If there is an error, returns the error,
1079 otherwise returns false.
1086 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1088 $self->getfield($_) eq ''
1089 #? "( $_ IS NULL OR $_ = \"\" )"
1090 ? ( driver_name eq 'Pg'
1092 : "( $_ IS NULL OR $_ = \"\" )"
1094 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1095 } ( $self->dbdef_table->primary_key )
1096 ? ( $self->dbdef_table->primary_key)
1097 : real_fields($self->table)
1099 warn "[debug]$me $statement\n" if $DEBUG > 1;
1100 my $sth = dbh->prepare($statement) or return dbh->errstr;
1103 if ( defined dbdef->table('h_'. $self->table) ) {
1104 my $h_statement = $self->_h_statement('delete');
1105 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1106 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1111 my $primary_key = $self->dbdef_table->primary_key;
1113 local $SIG{HUP} = 'IGNORE';
1114 local $SIG{INT} = 'IGNORE';
1115 local $SIG{QUIT} = 'IGNORE';
1116 local $SIG{TERM} = 'IGNORE';
1117 local $SIG{TSTP} = 'IGNORE';
1118 local $SIG{PIPE} = 'IGNORE';
1120 my $rc = $sth->execute or return $sth->errstr;
1121 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1122 $h_sth->execute or return $h_sth->errstr if $h_sth;
1124 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1126 #no need to needlessly destoy the data either (causes problems actually)
1127 #undef $self; #no need to keep object!
1134 Depriciated (use delete instead).
1139 cluck "warning: FS::Record::del deprecated!";
1140 &delete(@_); #call method in this scope
1143 =item replace OLD_RECORD
1145 Replace the OLD_RECORD with this one in the database. If there is an error,
1146 returns the error, otherwise returns false.
1151 my ($new, $old) = (shift, shift);
1153 $old = $new->replace_old unless defined($old);
1155 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1157 if ( $new->can('replace_check') ) {
1158 my $error = $new->replace_check($old);
1159 return $error if $error;
1162 return "Records not in same table!" unless $new->table eq $old->table;
1164 my $primary_key = $old->dbdef_table->primary_key;
1165 return "Can't change primary key $primary_key ".
1166 'from '. $old->getfield($primary_key).
1167 ' to ' . $new->getfield($primary_key)
1169 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1171 my $error = $new->check;
1172 return $error if $error;
1174 # Encrypt for replace
1176 if ( $conf->exists('encryption')
1177 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1178 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1180 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1181 next if $field eq 'payinfo'
1182 && ($new->isa('FS::payinfo_transaction_Mixin')
1183 || $new->isa('FS::payinfo_Mixin') )
1185 && !grep { $new->payby eq $_ } @encrypt_payby;
1186 $saved->{$field} = $new->getfield($field);
1187 $new->setfield($field, $new->encrypt($new->getfield($field)));
1191 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1192 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1193 ? ($_, $new->getfield($_)) : () } $old->fields;
1195 unless (keys(%diff) || $no_update_diff ) {
1196 carp "[warning]$me ". ref($new)."->replace ".
1197 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1198 ": records identical"
1199 unless $nowarn_identical;
1203 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1205 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1206 } real_fields($old->table)
1211 if ( $old->getfield($_) eq '' ) {
1213 #false laziness w/qsearch
1214 if ( driver_name eq 'Pg' ) {
1215 my $type = $old->dbdef_table->column($_)->type;
1216 if ( $type =~ /(int|(big)?serial)/i ) {
1219 qq-( $_ IS NULL OR $_ = '' )-;
1222 qq-( $_ IS NULL OR $_ = "" )-;
1226 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1229 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1232 warn "[debug]$me $statement\n" if $DEBUG > 1;
1233 my $sth = dbh->prepare($statement) or return dbh->errstr;
1236 if ( defined dbdef->table('h_'. $old->table) ) {
1237 my $h_old_statement = $old->_h_statement('replace_old');
1238 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1239 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1245 if ( defined dbdef->table('h_'. $new->table) ) {
1246 my $h_new_statement = $new->_h_statement('replace_new');
1247 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1248 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1253 local $SIG{HUP} = 'IGNORE';
1254 local $SIG{INT} = 'IGNORE';
1255 local $SIG{QUIT} = 'IGNORE';
1256 local $SIG{TERM} = 'IGNORE';
1257 local $SIG{TSTP} = 'IGNORE';
1258 local $SIG{PIPE} = 'IGNORE';
1260 my $rc = $sth->execute or return $sth->errstr;
1261 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1262 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1263 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1265 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1267 # Now that it has been saved, reset the encrypted fields so that $new
1268 # can still be used.
1269 foreach my $field (keys %{$saved}) {
1270 $new->setfield($field, $saved->{$field});
1278 my( $self ) = shift;
1279 warn "[$me] replace called with no arguments; autoloading old record\n"
1282 my $primary_key = $self->dbdef_table->primary_key;
1283 if ( $primary_key ) {
1284 $self->by_key( $self->$primary_key() ) #this is what's returned
1285 or croak "can't find ". $self->table. ".$primary_key ".
1286 $self->$primary_key();
1288 croak $self->table. " has no primary key; pass old record as argument";
1295 Depriciated (use replace instead).
1300 cluck "warning: FS::Record::rep deprecated!";
1301 replace @_; #call method in this scope
1306 Checks custom fields. Subclasses should still provide a check method to validate
1307 non-custom fields, foreign keys, etc., and call this method via $self->SUPER::check.
1313 foreach my $field ($self->virtual_fields) {
1314 my $error = $self->ut_textn($field);
1315 return $error if $error;
1320 =item virtual_fields [ TABLE ]
1322 Returns a list of virtual fields defined for the table. This should not
1323 be exported, and should only be called as an instance or class method.
1327 sub virtual_fields {
1330 $table = $self->table or confess "virtual_fields called on non-table";
1332 confess "Unknown table $table" unless dbdef->table($table);
1334 return () unless dbdef->table('part_virtual_field');
1336 unless ( $virtual_fields_cache{$table} ) {
1337 my $concat = [ "'cf_'", "name" ];
1338 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1339 "WHERE dbtable = '$table'";
1341 my $result = $dbh->selectcol_arrayref($query);
1342 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1344 $virtual_fields_cache{$table} = $result;
1347 @{$virtual_fields_cache{$table}};
1351 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1353 Processes a batch import as a queued JSRPC job
1355 JOB is an FS::queue entry.
1357 OPTIONS_HASHREF can have the following keys:
1363 Table name (required).
1367 Listref of field names for static fields. They will be given values from the
1368 PARAMS hashref and passed as a "params" hashref to batch_import.
1372 Formats hashref. Keys are field names, values are listrefs that define the
1375 Each listref value can be a column name or a code reference. Coderefs are run
1376 with the row object, data and a FS::Conf object as the three parameters.
1377 For example, this coderef does the same thing as using the "columnname" string:
1380 my( $record, $data, $conf ) = @_;
1381 $record->columnname( $data );
1384 Coderefs are run after all "column name" fields are assigned.
1388 Optional format hashref of types. Keys are field names, values are "csv",
1389 "xls" or "fixedlength". Overrides automatic determination of file type
1392 =item format_headers
1394 Optional format hashref of header lines. Keys are field names, values are 0
1395 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1398 =item format_sep_chars
1400 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1401 CSV separation character.
1403 =item format_fixedlenth_formats
1405 Optional format hashref of fixed length format defintiions. Keys are field
1406 names, values Parse::FixedLength listrefs of field definitions.
1410 Set true to default to CSV file type if the filename does not contain a
1411 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1416 PARAMS is a base64-encoded Storable string containing the POSTed data as
1417 a hash ref. It normally contains at least one field, "uploaded files",
1418 generated by /elements/file-upload.html and containing the list of uploaded
1419 files. Currently only supports a single file named "file".
1423 use Storable qw(thaw);
1426 sub process_batch_import {
1427 my($job, $opt) = ( shift, shift );
1429 my $table = $opt->{table};
1430 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1431 my %formats = %{ $opt->{formats} };
1433 my $param = thaw(decode_base64(shift));
1434 warn Dumper($param) if $DEBUG;
1436 my $files = $param->{'uploaded_files'}
1437 or die "No files provided.\n";
1439 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1441 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1442 my $file = $dir. $files{'file'};
1447 formats => \%formats,
1448 format_types => $opt->{format_types},
1449 format_headers => $opt->{format_headers},
1450 format_sep_chars => $opt->{format_sep_chars},
1451 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1452 format_xml_formats => $opt->{format_xml_formats},
1453 format_row_callbacks => $opt->{format_row_callbacks},
1458 format => $param->{format},
1459 params => { map { $_ => $param->{$_} } @pass_params },
1461 default_csv => $opt->{default_csv},
1462 postinsert_callback => $opt->{postinsert_callback},
1465 if ( $opt->{'batch_namecol'} ) {
1466 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1467 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1470 my $error = FS::Record::batch_import( \%iopt );
1474 die "$error\n" if $error;
1477 =item batch_import PARAM_HASHREF
1479 Class method for batch imports. Available params:
1485 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1491 =item format_headers
1493 =item format_sep_chars
1495 =item format_fixedlength_formats
1497 =item format_row_callbacks
1499 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1501 =item preinsert_callback
1503 =item postinsert_callback
1509 FS::queue object, will be updated with progress
1515 csv, xls, fixedlength, xml
1526 warn "$me batch_import call with params: \n". Dumper($param)
1529 my $table = $param->{table};
1531 my $job = $param->{job};
1532 my $file = $param->{file};
1533 my $params = $param->{params} || {};
1535 my( $type, $header, $sep_char, $fixedlength_format,
1536 $xml_format, $row_callback, @fields );
1538 my $postinsert_callback = '';
1539 $postinsert_callback = $param->{'postinsert_callback'}
1540 if $param->{'postinsert_callback'};
1541 my $preinsert_callback = '';
1542 $preinsert_callback = $param->{'preinsert_callback'}
1543 if $param->{'preinsert_callback'};
1545 if ( $param->{'format'} ) {
1547 my $format = $param->{'format'};
1548 my $formats = $param->{formats};
1549 die "unknown format $format" unless exists $formats->{ $format };
1551 $type = $param->{'format_types'}
1552 ? $param->{'format_types'}{ $format }
1553 : $param->{type} || 'csv';
1556 $header = $param->{'format_headers'}
1557 ? $param->{'format_headers'}{ $param->{'format'} }
1560 $sep_char = $param->{'format_sep_chars'}
1561 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1564 $fixedlength_format =
1565 $param->{'format_fixedlength_formats'}
1566 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1570 $param->{'format_xml_formats'}
1571 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1575 $param->{'format_row_callbacks'}
1576 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1579 @fields = @{ $formats->{ $format } };
1581 } elsif ( $param->{'fields'} ) {
1583 $type = ''; #infer from filename
1586 $fixedlength_format = '';
1588 @fields = @{ $param->{'fields'} };
1591 die "neither format nor fields specified";
1594 #my $file = $param->{file};
1597 if ( $file =~ /\.(\w+)$/i ) {
1601 warn "can't parse file type from filename $file; defaulting to CSV";
1605 if $param->{'default_csv'} && $type ne 'xls';
1613 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1615 if ( $type eq 'csv' ) {
1618 $attr{sep_char} = $sep_char if $sep_char;
1619 $parser = new Text::CSV_XS \%attr;
1621 } elsif ( $type eq 'fixedlength' ) {
1623 eval "use Parse::FixedLength;";
1625 $parser = Parse::FixedLength->new($fixedlength_format);
1629 die "Unknown file type $type\n";
1632 @buffer = split(/\r?\n/, slurp($file) );
1633 splice(@buffer, 0, ($header || 0) );
1634 $count = scalar(@buffer);
1636 } elsif ( $type eq 'xls' ) {
1638 eval "use Spreadsheet::ParseExcel;";
1641 eval "use DateTime::Format::Excel;";
1642 #for now, just let the error be thrown if it is used, since only CDR
1643 # formats bill_west and troop use it, not other excel-parsing things
1646 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1648 $parser = $excel->{Worksheet}[0]; #first sheet
1650 $count = $parser->{MaxRow} || $parser->{MinRow};
1653 $row = $header || 0;
1654 } elsif ( $type eq 'xml' ) {
1656 eval "use XML::Simple;";
1658 my $xmlrow = $xml_format->{'xmlrow'};
1659 $parser = $xml_format->{'xmlkeys'};
1660 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1661 my $data = XML::Simple::XMLin(
1663 'SuppressEmpty' => '', #sets empty values to ''
1667 $rows = $rows->{$_} foreach @$xmlrow;
1668 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1669 $count = @buffer = @$rows;
1671 die "Unknown file type $type\n";
1676 local $SIG{HUP} = 'IGNORE';
1677 local $SIG{INT} = 'IGNORE';
1678 local $SIG{QUIT} = 'IGNORE';
1679 local $SIG{TERM} = 'IGNORE';
1680 local $SIG{TSTP} = 'IGNORE';
1681 local $SIG{PIPE} = 'IGNORE';
1683 my $oldAutoCommit = $FS::UID::AutoCommit;
1684 local $FS::UID::AutoCommit = 0;
1687 #my $params = $param->{params} || {};
1688 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1689 my $batch_col = $param->{'batch_keycol'};
1691 my $batch_class = 'FS::'. $param->{'batch_table'};
1692 my $batch = $batch_class->new({
1693 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1695 my $error = $batch->insert;
1697 $dbh->rollback if $oldAutoCommit;
1698 return "can't insert batch record: $error";
1700 #primary key via dbdef? (so the column names don't have to match)
1701 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1703 $params->{ $batch_col } = $batch_value;
1706 #my $job = $param->{job};
1709 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1713 if ( $type eq 'csv' ) {
1715 last unless scalar(@buffer);
1716 $line = shift(@buffer);
1718 next if $line =~ /^\s*$/; #skip empty lines
1720 $line = &{$row_callback}($line) if $row_callback;
1722 next if $line =~ /^\s*$/; #skip empty lines
1724 $parser->parse($line) or do {
1725 $dbh->rollback if $oldAutoCommit;
1726 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
1728 @columns = $parser->fields();
1730 } elsif ( $type eq 'fixedlength' ) {
1732 last unless scalar(@buffer);
1733 $line = shift(@buffer);
1735 @columns = $parser->parse($line);
1737 } elsif ( $type eq 'xls' ) {
1739 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1740 || ! $parser->{Cells}[$row];
1742 my @row = @{ $parser->{Cells}[$row] };
1743 @columns = map $_->{Val}, @row;
1746 #warn $z++. ": $_\n" for @columns;
1748 } elsif ( $type eq 'xml' ) {
1749 # $parser = [ 'Column0Key', 'Column1Key' ... ]
1750 last unless scalar(@buffer);
1751 my $row = shift @buffer;
1752 @columns = @{ $row }{ @$parser };
1754 die "Unknown file type $type\n";
1758 my %hash = %$params;
1760 foreach my $field ( @fields ) {
1762 my $value = shift @columns;
1764 if ( ref($field) eq 'CODE' ) {
1765 #&{$field}(\%hash, $value);
1766 push @later, $field, $value;
1768 #??? $hash{$field} = $value if length($value);
1769 $hash{$field} = $value if defined($value) && length($value);
1774 #my $table = $param->{table};
1775 my $class = "FS::$table";
1777 my $record = $class->new( \%hash );
1780 while ( scalar(@later) ) {
1781 my $sub = shift @later;
1782 my $data = shift @later;
1784 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
1787 $dbh->rollback if $oldAutoCommit;
1788 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
1790 last if exists( $param->{skiprow} );
1792 next if exists( $param->{skiprow} );
1794 if ( $preinsert_callback ) {
1795 my $error = &{$preinsert_callback}($record, $param);
1797 $dbh->rollback if $oldAutoCommit;
1798 return "preinsert_callback error". ( $line ? " for $line" : '' ).
1801 next if exists $param->{skiprow} && $param->{skiprow};
1804 my $error = $record->insert;
1807 $dbh->rollback if $oldAutoCommit;
1808 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1814 if ( $postinsert_callback ) {
1815 my $error = &{$postinsert_callback}($record, $param);
1817 $dbh->rollback if $oldAutoCommit;
1818 return "postinsert_callback error". ( $line ? " for $line" : '' ).
1823 if ( $job && time - $min_sec > $last ) { #progress bar
1824 $job->update_statustext( int(100 * $imported / $count) );
1830 unless ( $imported || $param->{empty_ok} ) {
1831 $dbh->rollback if $oldAutoCommit;
1832 return "Empty file!";
1835 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1842 my( $self, $action, $time ) = @_;
1846 my %nohistory = map { $_=>1 } $self->nohistory_fields;
1849 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
1850 real_fields($self->table);
1853 # If we're encrypting then don't store the payinfo in the history
1854 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
1855 @fields = grep { $_ ne 'payinfo' } @fields;
1858 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1860 "INSERT INTO h_". $self->table. " ( ".
1861 join(', ', qw(history_date history_user history_action), @fields ).
1863 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1870 B<Warning>: External use is B<deprecated>.
1872 Replaces COLUMN in record with a unique number, using counters in the
1873 filesystem. Used by the B<insert> method on single-field unique columns
1874 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1875 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1877 Returns the new value.
1882 my($self,$field) = @_;
1883 my($table)=$self->table;
1885 croak "Unique called on field $field, but it is ",
1886 $self->getfield($field),
1888 if $self->getfield($field);
1890 #warn "table $table is tainted" if is_tainted($table);
1891 #warn "field $field is tainted" if is_tainted($field);
1893 my($counter) = new File::CounterFile "$table.$field",0;
1895 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1897 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1900 my $index = $counter->inc;
1901 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1903 $index =~ /^(\d*)$/;
1906 $self->setfield($field,$index);
1910 =item ut_float COLUMN
1912 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1913 null. If there is an error, returns the error, otherwise returns false.
1918 my($self,$field)=@_ ;
1919 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
1920 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
1921 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
1922 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
1923 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1924 $self->setfield($field,$1);
1927 =item ut_floatn COLUMN
1929 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1930 null. If there is an error, returns the error, otherwise returns false.
1934 #false laziness w/ut_ipn
1936 my( $self, $field ) = @_;
1937 if ( $self->getfield($field) =~ /^()$/ ) {
1938 $self->setfield($field,'');
1941 $self->ut_float($field);
1945 =item ut_sfloat COLUMN
1947 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
1948 May not be null. If there is an error, returns the error, otherwise returns
1954 my($self,$field)=@_ ;
1955 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
1956 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
1957 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
1958 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
1959 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1960 $self->setfield($field,$1);
1963 =item ut_sfloatn COLUMN
1965 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1966 null. If there is an error, returns the error, otherwise returns false.
1971 my( $self, $field ) = @_;
1972 if ( $self->getfield($field) =~ /^()$/ ) {
1973 $self->setfield($field,'');
1976 $self->ut_sfloat($field);
1980 =item ut_snumber COLUMN
1982 Check/untaint signed numeric data (whole numbers). If there is an error,
1983 returns the error, otherwise returns false.
1988 my($self, $field) = @_;
1989 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
1990 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1991 $self->setfield($field, "$1$2");
1995 =item ut_snumbern COLUMN
1997 Check/untaint signed numeric data (whole numbers). If there is an error,
1998 returns the error, otherwise returns false.
2003 my($self, $field) = @_;
2004 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2005 or return "Illegal (numeric) $field: ". $self->getfield($field);
2007 return "Illegal (numeric) $field: ". $self->getfield($field)
2010 $self->setfield($field, "$1$2");
2014 =item ut_number COLUMN
2016 Check/untaint simple numeric data (whole numbers). May not be null. If there
2017 is an error, returns the error, otherwise returns false.
2022 my($self,$field)=@_;
2023 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2024 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2025 $self->setfield($field,$1);
2029 =item ut_numbern COLUMN
2031 Check/untaint simple numeric data (whole numbers). May be null. If there is
2032 an error, returns the error, otherwise returns false.
2037 my($self,$field)=@_;
2038 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2039 or return "Illegal (numeric) $field: ". $self->getfield($field);
2040 $self->setfield($field,$1);
2044 =item ut_money COLUMN
2046 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2047 is an error, returns the error, otherwise returns false.
2052 my($self,$field)=@_;
2053 $self->setfield($field, 0) if $self->getfield($field) eq '';
2054 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
2055 or return "Illegal (money) $field: ". $self->getfield($field);
2056 #$self->setfield($field, "$1$2$3" || 0);
2057 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2061 =item ut_moneyn COLUMN
2063 Check/untaint monetary numbers. May be negative. If there
2064 is an error, returns the error, otherwise returns false.
2069 my($self,$field)=@_;
2070 if ($self->getfield($field) eq '') {
2071 $self->setfield($field, '');
2074 $self->ut_money($field);
2077 =item ut_text COLUMN
2079 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2080 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2081 May not be null. If there is an error, returns the error, otherwise returns
2087 my($self,$field)=@_;
2088 #warn "msgcat ". \&msgcat. "\n";
2089 #warn "notexist ". \¬exist. "\n";
2090 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2091 $self->getfield($field)
2092 =~ /^([\wô \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2093 or return gettext('illegal_or_empty_text'). " $field: ".
2094 $self->getfield($field);
2095 $self->setfield($field,$1);
2099 =item ut_textn COLUMN
2101 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2102 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2103 May be null. If there is an error, returns the error, otherwise returns false.
2108 my($self,$field)=@_;
2109 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2110 $self->ut_text($field);
2113 =item ut_alpha COLUMN
2115 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2116 an error, returns the error, otherwise returns false.
2121 my($self,$field)=@_;
2122 $self->getfield($field) =~ /^(\w+)$/
2123 or return "Illegal or empty (alphanumeric) $field: ".
2124 $self->getfield($field);
2125 $self->setfield($field,$1);
2129 =item ut_alphan COLUMN
2131 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2132 error, returns the error, otherwise returns false.
2137 my($self,$field)=@_;
2138 $self->getfield($field) =~ /^(\w*)$/
2139 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2140 $self->setfield($field,$1);
2144 =item ut_alphasn COLUMN
2146 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2147 an error, returns the error, otherwise returns false.
2152 my($self,$field)=@_;
2153 $self->getfield($field) =~ /^([\w ]*)$/
2154 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2155 $self->setfield($field,$1);
2160 =item ut_alpha_lower COLUMN
2162 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2163 there is an error, returns the error, otherwise returns false.
2167 sub ut_alpha_lower {
2168 my($self,$field)=@_;
2169 $self->getfield($field) =~ /[[:upper:]]/
2170 and return "Uppercase characters are not permitted in $field";
2171 $self->ut_alpha($field);
2174 =item ut_phonen COLUMN [ COUNTRY ]
2176 Check/untaint phone numbers. May be null. If there is an error, returns
2177 the error, otherwise returns false.
2179 Takes an optional two-letter ISO country code; without it or with unsupported
2180 countries, ut_phonen simply calls ut_alphan.
2185 my( $self, $field, $country ) = @_;
2186 return $self->ut_alphan($field) unless defined $country;
2187 my $phonen = $self->getfield($field);
2188 if ( $phonen eq '' ) {
2189 $self->setfield($field,'');
2190 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2192 $phonen = $conf->config('cust_main-default_areacode').$phonen
2193 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2194 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2195 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2196 $phonen = "$1-$2-$3";
2197 $phonen .= " x$4" if $4;
2198 $self->setfield($field,$phonen);
2200 warn "warning: don't know how to check phone numbers for country $country";
2201 return $self->ut_textn($field);
2208 Check/untaint hexadecimal values.
2213 my($self, $field) = @_;
2214 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2215 or return "Illegal (hex) $field: ". $self->getfield($field);
2216 $self->setfield($field, uc($1));
2220 =item ut_hexn COLUMN
2222 Check/untaint hexadecimal values. May be null.
2227 my($self, $field) = @_;
2228 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2229 or return "Illegal (hex) $field: ". $self->getfield($field);
2230 $self->setfield($field, uc($1));
2234 =item ut_mac_addr COLUMN
2236 Check/untaint mac addresses. May be null.
2241 my($self, $field) = @_;
2243 my $mac = $self->get($field);
2246 $self->set($field, $mac);
2248 my $e = $self->ut_hex($field);
2251 return "Illegal (mac address) $field: ". $self->getfield($field)
2252 unless length($self->getfield($field)) == 12;
2258 =item ut_mac_addrn COLUMN
2260 Check/untaint mac addresses. May be null.
2265 my($self, $field) = @_;
2266 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2271 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2277 my( $self, $field ) = @_;
2278 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2279 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2280 or return "Illegal (IP address) $field: ". $self->getfield($field);
2281 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2282 $self->setfield($field, "$1.$2.$3.$4");
2288 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2289 to 127.0.0.1. May be null.
2294 my( $self, $field ) = @_;
2295 if ( $self->getfield($field) =~ /^()$/ ) {
2296 $self->setfield($field,'');
2299 $self->ut_ip($field);
2303 =item ut_ip46 COLUMN
2305 Check/untaint IPv4 or IPv6 address.
2310 my( $self, $field ) = @_;
2311 my $ip = NetAddr::IP->new($self->getfield($field))
2312 or return "Illegal (IP address) $field: ".$self->getfield($field);
2313 $self->setfield($field, lc($ip->addr));
2319 Check/untaint IPv6 or IPv6 address. May be null.
2324 my( $self, $field ) = @_;
2325 if ( $self->getfield($field) =~ /^$/ ) {
2326 $self->setfield($field, '');
2329 $self->ut_ip46($field);
2332 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2334 Check/untaint coordinates.
2335 Accepts the following forms:
2345 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2346 The latter form (that is, the MMM are thousands of minutes) is
2347 assumed if the "MMM" is exactly three digits or two digits > 59.
2349 To be safe, just use the DDD.DDDDD form.
2351 If LOWER or UPPER are specified, then the coordinate is checked
2352 for lower and upper bounds, respectively.
2357 my ($self, $field) = (shift, shift);
2360 if ( $field =~ /latitude/ ) {
2361 $lower = $lat_lower;
2363 } elsif ( $field =~ /longitude/ ) {
2365 $upper = $lon_upper;
2368 my $coord = $self->getfield($field);
2369 my $neg = $coord =~ s/^(-)//;
2371 my ($d, $m, $s) = (0, 0, 0);
2374 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2375 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2376 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2378 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2381 return "Invalid (coordinate with minutes > 59) $field: "
2382 . $self->getfield($field);
2385 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2387 if (defined($lower) and ($coord < $lower)) {
2388 return "Invalid (coordinate < $lower) $field: "
2389 . $self->getfield($field);;
2392 if (defined($upper) and ($coord > $upper)) {
2393 return "Invalid (coordinate > $upper) $field: "
2394 . $self->getfield($field);;
2397 $self->setfield($field, $coord);
2401 return "Invalid (coordinate) $field: " . $self->getfield($field);
2405 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2407 Same as ut_coord, except optionally null.
2413 my ($self, $field) = (shift, shift);
2415 if ($self->getfield($field) =~ /^\s*$/) {
2418 return $self->ut_coord($field, @_);
2424 =item ut_domain COLUMN
2426 Check/untaint host and domain names.
2431 my( $self, $field ) = @_;
2432 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2433 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2434 or return "Illegal (domain) $field: ". $self->getfield($field);
2435 $self->setfield($field,$1);
2439 =item ut_name COLUMN
2441 Check/untaint proper names; allows alphanumerics, spaces and the following
2442 punctuation: , . - '
2449 my( $self, $field ) = @_;
2450 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2451 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2452 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2453 $self->setfield($field,$1);
2459 Check/untaint zip codes.
2463 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2466 my( $self, $field, $country ) = @_;
2468 if ( $country eq 'US' ) {
2470 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2471 or return gettext('illegal_zip'). " $field for country $country: ".
2472 $self->getfield($field);
2473 $self->setfield($field, $1);
2475 } elsif ( $country eq 'CA' ) {
2477 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2478 or return gettext('illegal_zip'). " $field for country $country: ".
2479 $self->getfield($field);
2480 $self->setfield($field, "$1 $2");
2484 if ( $self->getfield($field) =~ /^\s*$/
2485 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2488 $self->setfield($field,'');
2490 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2491 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2492 $self->setfield($field,$1);
2500 =item ut_country COLUMN
2502 Check/untaint country codes. Country names are changed to codes, if possible -
2503 see L<Locale::Country>.
2508 my( $self, $field ) = @_;
2509 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2510 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2511 && country2code($1) ) {
2512 $self->setfield($field,uc(country2code($1)));
2515 $self->getfield($field) =~ /^(\w\w)$/
2516 or return "Illegal (country) $field: ". $self->getfield($field);
2517 $self->setfield($field,uc($1));
2521 =item ut_anything COLUMN
2523 Untaints arbitrary data. Be careful.
2528 my( $self, $field ) = @_;
2529 $self->getfield($field) =~ /^(.*)$/s
2530 or return "Illegal $field: ". $self->getfield($field);
2531 $self->setfield($field,$1);
2535 =item ut_enum COLUMN CHOICES_ARRAYREF
2537 Check/untaint a column, supplying all possible choices, like the "enum" type.
2542 my( $self, $field, $choices ) = @_;
2543 foreach my $choice ( @$choices ) {
2544 if ( $self->getfield($field) eq $choice ) {
2545 $self->setfield($field, $choice);
2549 return "Illegal (enum) field $field: ". $self->getfield($field);
2552 =item ut_enumn COLUMN CHOICES_ARRAYREF
2554 Like ut_enum, except the null value is also allowed.
2559 my( $self, $field, $choices ) = @_;
2560 $self->getfield($field)
2561 ? $self->ut_enum($field, $choices)
2566 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2568 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2569 on the column first.
2573 sub ut_foreign_key {
2574 my( $self, $field, $table, $foreign ) = @_;
2575 return '' if $no_check_foreign;
2576 qsearchs($table, { $foreign => $self->getfield($field) })
2577 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2578 " in $table.$foreign";
2582 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2584 Like ut_foreign_key, except the null value is also allowed.
2588 sub ut_foreign_keyn {
2589 my( $self, $field, $table, $foreign ) = @_;
2590 $self->getfield($field)
2591 ? $self->ut_foreign_key($field, $table, $foreign)
2595 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2597 Checks this column as an agentnum, taking into account the current users's
2598 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2599 right or rights allowing no agentnum.
2603 sub ut_agentnum_acl {
2604 my( $self, $field ) = (shift, shift);
2605 my $null_acl = scalar(@_) ? shift : [];
2606 $null_acl = [ $null_acl ] unless ref($null_acl);
2608 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2609 return "Illegal agentnum: $error" if $error;
2611 my $curuser = $FS::CurrentUser::CurrentUser;
2613 if ( $self->$field() ) {
2615 return "Access denied"
2616 unless $curuser->agentnum($self->$field());
2620 return "Access denied"
2621 unless grep $curuser->access_right($_), @$null_acl;
2629 =item fields [ TABLE ]
2631 This is a wrapper for real_fields. Code that called
2632 fields before should probably continue to call fields.
2637 my $something = shift;
2639 if($something->isa('FS::Record')) {
2640 $table = $something->table;
2642 $table = $something;
2643 $something = "FS::$table";
2645 return (real_fields($table));
2649 =item encrypt($value)
2651 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2653 Returns the encrypted string.
2655 You should generally not have to worry about calling this, as the system handles this for you.
2660 my ($self, $value) = @_;
2663 if ($conf->exists('encryption')) {
2664 if ($self->is_encrypted($value)) {
2665 # Return the original value if it isn't plaintext.
2666 $encrypted = $value;
2669 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2670 # RSA doesn't like the empty string so let's pack it up
2671 # The database doesn't like the RSA data so uuencode it
2672 my $length = length($value)+1;
2673 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2675 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2682 =item is_encrypted($value)
2684 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2690 my ($self, $value) = @_;
2691 # Possible Bug - Some work may be required here....
2693 if ($value =~ /^M/ && length($value) > 80) {
2700 =item decrypt($value)
2702 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2704 You should generally not have to worry about calling this, as the system handles this for you.
2709 my ($self,$value) = @_;
2710 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2711 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2713 if (ref($rsa_decrypt) =~ /::RSA/) {
2714 my $encrypted = unpack ("u*", $value);
2715 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2716 if ($@) {warn "Decryption Failed"};
2724 #Initialize the Module
2725 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2727 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2728 $rsa_module = $conf->config('encryptionmodule');
2732 eval ("require $rsa_module"); # No need to import the namespace
2735 # Initialize Encryption
2736 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2737 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2738 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2741 # Intitalize Decryption
2742 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2743 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2744 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2748 =item h_search ACTION
2750 Given an ACTION, either "insert", or "delete", returns the appropriate history
2751 record corresponding to this record, if any.
2756 my( $self, $action ) = @_;
2758 my $table = $self->table;
2761 my $primary_key = dbdef->table($table)->primary_key;
2764 'table' => "h_$table",
2765 'hashref' => { $primary_key => $self->$primary_key(),
2766 'history_action' => $action,
2774 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2775 appropriate history record corresponding to this record, if any.
2780 my($self, $action) = @_;
2781 my $h = $self->h_search($action);
2782 $h ? $h->history_date : '';
2785 =item scalar_sql SQL [ PLACEHOLDER, ... ]
2787 A class or object method. Executes the sql statement represented by SQL and
2788 returns a scalar representing the result: the first column of the first row.
2790 Dies on bogus SQL. Returns an empty string if no row is returned.
2792 Typically used for statments which return a single value such as "SELECT
2793 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
2798 my($self, $sql) = (shift, shift);
2799 my $sth = dbh->prepare($sql) or die dbh->errstr;
2801 or die "Unexpected error executing statement $sql: ". $sth->errstr;
2802 my $row = $sth->fetchrow_arrayref or return '';
2803 my $scalar = $row->[0];
2804 defined($scalar) ? $scalar : '';
2807 =item count [ WHERE ]
2809 Convenience method for the common case of "SELECT COUNT(*) FROM table",
2810 with optional WHERE. Must be called as method on a class with an
2816 my($self, $where) = (shift, shift);
2817 my $table = $self->table or die 'count called on object of class '.ref($self);
2818 my $sql = "SELECT COUNT(*) FROM $table";
2819 $sql .= " WHERE $where" if $where;
2820 $self->scalar_sql($sql);
2829 =item real_fields [ TABLE ]
2831 Returns a list of the real columns in the specified table. Called only by
2832 fields() and other subroutines elsewhere in FS::Record.
2839 my($table_obj) = dbdef->table($table);
2840 confess "Unknown table $table" unless $table_obj;
2841 $table_obj->columns;
2844 =item pvf FIELD_NAME
2846 Returns the FS::part_virtual_field object corresponding to a field in the
2847 record (specified by FIELD_NAME).
2852 my ($self, $name) = (shift, shift);
2854 if(grep /^$name$/, $self->virtual_fields) {
2856 my $concat = [ "'cf_'", "name" ];
2857 return qsearchs({ table => 'part_virtual_field',
2858 hashref => { dbtable => $self->table,
2861 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
2867 =item _quote VALUE, TABLE, COLUMN
2869 This is an internal function used to construct SQL statements. It returns
2870 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2871 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2876 my($value, $table, $column) = @_;
2877 my $column_obj = dbdef->table($table)->column($column);
2878 my $column_type = $column_obj->type;
2879 my $nullable = $column_obj->null;
2881 warn " $table.$column: $value ($column_type".
2882 ( $nullable ? ' NULL' : ' NOT NULL' ).
2883 ")\n" if $DEBUG > 2;
2885 if ( $value eq '' && $nullable ) {
2887 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2888 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2891 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2892 ! $column_type =~ /(char|binary|text)$/i ) {
2894 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
2895 && driver_name eq 'Pg'
2899 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
2900 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
2901 # single-quote the whole mess, and put an "E" in front.
2902 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
2910 This is deprecated. Don't use it.
2912 It returns a hash-type list with the fields of this record's table set true.
2917 carp "warning: hfields is deprecated";
2920 foreach (fields($table)) {
2929 "$_: ". $self->getfield($_). "|"
2930 } (fields($self->table)) );
2933 sub DESTROY { return; }
2937 # #use Carp qw(cluck);
2938 # #cluck "DESTROYING $self";
2939 # warn "DESTROYING $self";
2943 # return ! eval { join('',@_), kill 0; 1; };
2946 =item str2time_sql [ DRIVER_NAME ]
2948 Returns a function to convert to unix time based on database type, such as
2949 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
2950 the str2time_sql_closing method to return a closing string rather than just
2951 using a closing parenthesis as previously suggested.
2953 You can pass an optional driver name such as "Pg", "mysql" or
2954 $dbh->{Driver}->{Name} to return a function for that database instead of
2955 the current database.
2960 my $driver = shift || driver_name;
2962 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
2963 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
2965 warn "warning: unknown database type $driver; guessing how to convert ".
2966 "dates to UNIX timestamps";
2967 return 'EXTRACT(EPOCH FROM ';
2971 =item str2time_sql_closing [ DRIVER_NAME ]
2973 Returns the closing suffix of a function to convert to unix time based on
2974 database type, such as ")::integer" for Pg or ")" 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.
2982 sub str2time_sql_closing {
2983 my $driver = shift || driver_name;
2985 return ' )::INTEGER ' if $driver =~ /^Pg/i;
2989 =item regexp_sql [ DRIVER_NAME ]
2991 Returns the operator to do a regular expression comparison based on database
2992 type, such as '~' for Pg or 'REGEXP' for mysql.
2994 You can pass an optional driver name such as "Pg", "mysql" or
2995 $dbh->{Driver}->{Name} to return a function for that database instead of
2996 the current database.
3001 my $driver = shift || driver_name;
3003 return '~' if $driver =~ /^Pg/i;
3004 return 'REGEXP' if $driver =~ /^mysql/i;
3006 die "don't know how to use regular expressions in ". driver_name." databases";
3010 =item not_regexp_sql [ DRIVER_NAME ]
3012 Returns the operator to do a regular expression negation based on database
3013 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3015 You can pass an optional driver name such as "Pg", "mysql" or
3016 $dbh->{Driver}->{Name} to return a function for that database instead of
3017 the current database.
3021 sub not_regexp_sql {
3022 my $driver = shift || driver_name;
3024 return '!~' if $driver =~ /^Pg/i;
3025 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3027 die "don't know how to use regular expressions in ". driver_name." databases";
3031 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3033 Returns the items concatendated based on database type, using "CONCAT()" for
3034 mysql and " || " for Pg and other databases.
3036 You can pass an optional driver name such as "Pg", "mysql" or
3037 $dbh->{Driver}->{Name} to return a function for that database instead of
3038 the current database.
3043 my $driver = ref($_[0]) ? driver_name : shift;
3046 if ( $driver =~ /^mysql/i ) {
3047 'CONCAT('. join(',', @$items). ')';
3049 join('||', @$items);
3058 This module should probably be renamed, since much of the functionality is
3059 of general use. It is not completely unlike Adapter::DBI (see below).
3061 Exported qsearch and qsearchs should be deprecated in favor of method calls
3062 (against an FS::Record object like the old search and searchs that qsearch
3063 and qsearchs were on top of.)
3065 The whole fields / hfields mess should be removed.
3067 The various WHERE clauses should be subroutined.
3069 table string should be deprecated in favor of DBIx::DBSchema::Table.
3071 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3072 true maps to the database (and WHERE clauses) would also help.
3074 The ut_ methods should ask the dbdef for a default length.
3076 ut_sqltype (like ut_varchar) should all be defined
3078 A fallback check method should be provided which uses the dbdef.
3080 The ut_money method assumes money has two decimal digits.
3082 The Pg money kludge in the new method only strips `$'.
3084 The ut_phonen method only checks US-style phone numbers.
3086 The _quote function should probably use ut_float instead of a regex.
3088 All the subroutines probably should be methods, here or elsewhere.
3090 Probably should borrow/use some dbdef methods where appropriate (like sub
3093 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3094 or allow it to be set. Working around it is ugly any way around - DBI should
3095 be fixed. (only affects RDBMS which return uppercase column names)
3097 ut_zip should take an optional country like ut_phone.
3101 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3103 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.