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
48 $nowarn_identical = 0;
49 $nowarn_classload = 0;
51 $no_check_foreign = 0;
59 $conf_encryption = '';
60 FS::UID->install_callback( sub {
64 $conf = FS::Conf->new;
65 $conf_encryption = $conf->exists('encryption');
66 $money_char = $conf->config('money_char') || '$';
67 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
68 $lat_lower = $nw_coords ? 1 : -90;
69 $lon_upper = $nw_coords ? -1 : 180;
71 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
73 if ( driver_name eq 'Pg' ) {
74 eval "use DBD::Pg ':pg_types'";
77 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
84 FS::Record - Database record objects
89 use FS::Record qw(dbh fields qsearch qsearchs);
91 $record = new FS::Record 'table', \%hash;
92 $record = new FS::Record 'table', { 'column' => 'value', ... };
94 $record = qsearchs FS::Record 'table', \%hash;
95 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
96 @records = qsearch FS::Record 'table', \%hash;
97 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
99 $table = $record->table;
100 $dbdef_table = $record->dbdef_table;
102 $value = $record->get('column');
103 $value = $record->getfield('column');
104 $value = $record->column;
106 $record->set( 'column' => 'value' );
107 $record->setfield( 'column' => 'value' );
108 $record->column('value');
110 %hash = $record->hash;
112 $hashref = $record->hashref;
114 $error = $record->insert;
116 $error = $record->delete;
118 $error = $new_record->replace($old_record);
120 # external use deprecated - handled by the database (at least for Pg, mysql)
121 $value = $record->unique('column');
123 $error = $record->ut_float('column');
124 $error = $record->ut_floatn('column');
125 $error = $record->ut_number('column');
126 $error = $record->ut_numbern('column');
127 $error = $record->ut_snumber('column');
128 $error = $record->ut_snumbern('column');
129 $error = $record->ut_money('column');
130 $error = $record->ut_text('column');
131 $error = $record->ut_textn('column');
132 $error = $record->ut_alpha('column');
133 $error = $record->ut_alphan('column');
134 $error = $record->ut_phonen('column');
135 $error = $record->ut_anything('column');
136 $error = $record->ut_name('column');
138 $quoted_value = _quote($value,'table','field');
141 $fields = hfields('table');
142 if ( $fields->{Field} ) { # etc.
144 @fields = fields 'table'; #as a subroutine
145 @fields = $record->fields; #as a method call
150 (Mostly) object-oriented interface to database records. Records are currently
151 implemented on top of DBI. FS::Record is intended as a base class for
152 table-specific classes to inherit from, i.e. FS::cust_main.
158 =item new [ TABLE, ] HASHREF
160 Creates a new record. It doesn't store it in the database, though. See
161 L<"insert"> for that.
163 Note that the object stores this hash reference, not a distinct copy of the
164 hash it points to. You can ask the object for a copy with the I<hash>
167 TABLE can only be omitted when a dervived class overrides the table method.
173 my $class = ref($proto) || $proto;
175 bless ($self, $class);
177 unless ( defined ( $self->table ) ) {
178 $self->{'Table'} = shift;
179 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
180 unless $nowarn_classload;
183 $self->{'Hash'} = shift;
185 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
186 $self->{'Hash'}{$field}='';
189 $self->_rebless if $self->can('_rebless');
191 $self->{'modified'} = 0;
193 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
200 my $class = ref($proto) || $proto;
202 bless ($self, $class);
204 $self->{'Table'} = shift unless defined ( $self->table );
206 my $hashref = $self->{'Hash'} = shift;
208 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
209 my $obj = $cache->cache->{$hashref->{$cache->key}};
210 $obj->_cache($hashref, $cache) if $obj->can('_cache');
213 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
220 my $class = ref($proto) || $proto;
222 bless ($self, $class);
223 if ( defined $self->table ) {
224 cluck "create constructor is deprecated, use new!";
227 croak "FS::Record::create called (not from a subclass)!";
231 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
233 Searches the database for all records matching (at least) the key/value pairs
234 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
235 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
238 The preferred usage is to pass a hash reference of named parameters:
240 @records = qsearch( {
241 'table' => 'table_name',
242 'hashref' => { 'field' => 'value'
243 'field' => { 'op' => '<',
248 #these are optional...
250 'extra_sql' => 'AND field = ? AND intfield = ?',
251 'extra_param' => [ 'value', [ 5, 'int' ] ],
252 'order_by' => 'ORDER BY something',
253 #'cache_obj' => '', #optional
254 'addl_from' => 'LEFT JOIN othtable USING ( field )',
259 Much code still uses old-style positional parameters, this is also probably
260 fine in the common case where there are only two parameters:
262 my @records = qsearch( 'table', { 'field' => 'value' } );
264 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
265 the individual PARAMS_HASHREF queries
267 ###oops, argh, FS::Record::new only lets us create database fields.
268 #Normal behaviour if SELECT is not specified is `*', as in
269 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
270 #feature where you can specify SELECT - remember, the objects returned,
271 #although blessed into the appropriate `FS::TABLE' package, will only have the
272 #fields you specify. This might have unwanted results if you then go calling
273 #regular FS::TABLE methods
278 my %TYPE = (); #for debugging
281 my($type, $value) = @_;
283 my $bind_type = { TYPE => SQL_VARCHAR };
285 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
287 $bind_type = { TYPE => SQL_INTEGER };
289 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
291 if ( driver_name eq 'Pg' ) {
293 $bind_type = { pg_type => PG_BYTEA };
295 # $bind_type = ? #SQL_VARCHAR could be fine?
298 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
299 #fixed by DBD::Pg 2.11.8
300 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
301 #(make a Tron test first)
302 } elsif ( _is_fs_float( $type, $value ) ) {
304 $bind_type = { TYPE => SQL_DECIMAL };
313 my($type, $value) = @_;
314 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
315 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
323 my( @stable, @record, @cache );
324 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
326 my %union_options = ();
327 if ( ref($_[0]) eq 'ARRAY' ) {
330 foreach my $href ( @$optlist ) {
331 push @stable, ( $href->{'table'} or die "table name is required" );
332 push @record, ( $href->{'hashref'} || {} );
333 push @select, ( $href->{'select'} || '*' );
334 push @extra_sql, ( $href->{'extra_sql'} || '' );
335 push @extra_param, ( $href->{'extra_param'} || [] );
336 push @order_by, ( $href->{'order_by'} || '' );
337 push @cache, ( $href->{'cache_obj'} || '' );
338 push @addl_from, ( $href->{'addl_from'} || '' );
339 push @debug, ( $href->{'debug'} || '' );
341 die "at least one hashref is required" unless scalar(@stable);
342 } elsif ( ref($_[0]) eq 'HASH' ) {
344 $stable[0] = $opt->{'table'} or die "table name is required";
345 $record[0] = $opt->{'hashref'} || {};
346 $select[0] = $opt->{'select'} || '*';
347 $extra_sql[0] = $opt->{'extra_sql'} || '';
348 $extra_param[0] = $opt->{'extra_param'} || [];
349 $order_by[0] = $opt->{'order_by'} || '';
350 $cache[0] = $opt->{'cache_obj'} || '';
351 $addl_from[0] = $opt->{'addl_from'} || '';
352 $debug[0] = $opt->{'debug'} || '';
363 my $cache = $cache[0];
369 foreach my $stable ( @stable ) {
370 #stop altering the caller's hashref
371 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
372 my $select = shift @select;
373 my $extra_sql = shift @extra_sql;
374 my $extra_param = shift @extra_param;
375 my $order_by = shift @order_by;
376 my $cache = shift @cache;
377 my $addl_from = shift @addl_from;
378 my $debug = shift @debug;
380 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
382 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
385 my $table = $cache ? $cache->table : $stable;
386 my $dbdef_table = dbdef->table($table)
387 or die "No schema for table $table found - ".
388 "do you need to run freeside-upgrade?";
389 my $pkey = $dbdef_table->primary_key;
391 my @real_fields = grep exists($record->{$_}), real_fields($table);
393 my $statement .= "SELECT $select FROM $stable";
394 $statement .= " $addl_from" if $addl_from;
395 if ( @real_fields ) {
396 $statement .= ' WHERE '. join(' AND ',
397 get_real_fields($table, $record, \@real_fields));
400 $statement .= " $extra_sql" if defined($extra_sql);
401 $statement .= " $order_by" if defined($order_by);
403 push @statement, $statement;
405 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
409 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
412 my $value = $record->{$field};
413 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
414 $value = $value->{'value'} if ref($value);
415 my $type = dbdef->table($table)->column($field)->type;
417 my $bind_type = _bind_type($type, $value);
421 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
423 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
427 push @bind_type, $bind_type;
431 foreach my $param ( @$extra_param ) {
432 my $bind_type = { TYPE => SQL_VARCHAR };
435 $value = $param->[0];
436 my $type = $param->[1];
437 $bind_type = _bind_type($type, $value);
440 push @bind_type, $bind_type;
444 my $statement = join( ' ) UNION ( ', @statement );
445 $statement = "( $statement )" if scalar(@statement) > 1;
446 $statement .= " $union_options{order_by}" if $union_options{order_by};
448 my $sth = $dbh->prepare($statement)
449 or croak "$dbh->errstr doing $statement";
452 foreach my $value ( @value ) {
453 my $bind_type = shift @bind_type;
454 $sth->bind_param($bind++, $value, $bind_type );
457 # $sth->execute( map $record->{$_},
458 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
459 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
461 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
463 my $table = $stable[0];
465 $table = '' if grep { $_ ne $table } @stable;
466 $pkey = dbdef->table($table)->primary_key if $table;
469 tie %result, "Tie::IxHash";
470 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
471 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
472 %result = map { $_->{$pkey}, $_ } @stuff;
474 @result{@stuff} = @stuff;
480 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
481 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
482 #derivied class didn't override new method, so this optimization is safe
485 new_or_cached( "FS::$table", { %{$_} }, $cache )
489 new( "FS::$table", { %{$_} } )
493 #okay, its been tested
494 # warn "untested code (class FS::$table uses custom new method)";
496 eval 'FS::'. $table. '->new( { %{$_} } )';
500 # Check for encrypted fields and decrypt them.
501 ## only in the local copy, not the cached object
502 if ( $conf_encryption
503 && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
504 foreach my $record (@return) {
505 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
506 next if $field eq 'payinfo'
507 && ($record->isa('FS::payinfo_transaction_Mixin')
508 || $record->isa('FS::payinfo_Mixin') )
510 && !grep { $record->payby eq $_ } @encrypt_payby;
511 # Set it directly... This may cause a problem in the future...
512 $record->setfield($field, $record->decrypt($record->getfield($field)));
517 cluck "warning: FS::$table not loaded; returning FS::Record objects"
518 unless $nowarn_classload;
520 FS::Record->new( $table, { %{$_} } );
526 ## makes this easier to read
528 sub get_real_fields {
531 my $real_fields = shift;
533 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
539 my $type = dbdef->table($table)->column($column)->type;
540 my $value = $record->{$column};
541 $value = $value->{'value'} if ref($value);
542 if ( ref($record->{$_}) ) {
543 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
544 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
545 if ( uc($op) eq 'ILIKE' ) {
547 $record->{$_}{'value'} = lc($record->{$_}{'value'});
548 $column = "LOWER($_)";
550 $record->{$_} = $record->{$_}{'value'}
553 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
555 if ( driver_name eq 'Pg' ) {
556 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
557 qq-( $column IS NULL )-;
559 qq-( $column IS NULL OR $column = '' )-;
562 qq-( $column IS NULL OR $column = "" )-;
564 } elsif ( $op eq '!=' ) {
565 if ( driver_name eq 'Pg' ) {
566 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
567 qq-( $column IS NOT NULL )-;
569 qq-( $column IS NOT NULL AND $column != '' )-;
572 qq-( $column IS NOT NULL AND $column != "" )-;
575 if ( driver_name eq 'Pg' ) {
576 qq-( $column $op '' )-;
578 qq-( $column $op "" )-;
581 } elsif ( $op eq '!=' ) {
582 qq-( $column IS NULL OR $column != ? )-;
583 #if this needs to be re-enabled, it needs to use a custom op like
584 #"APPROX=" or something (better name?, not '=', to avoid affecting other
586 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
587 # ( "$column <= ?", "$column >= ?" );
591 } @{ $real_fields } );
594 =item by_key PRIMARY_KEY_VALUE
596 This is a class method that returns the record with the given primary key
597 value. This method is only useful in FS::Record subclasses. For example:
599 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
603 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
608 my ($class, $pkey_value) = @_;
610 my $table = $class->table
611 or croak "No table for $class found";
613 my $dbdef_table = dbdef->table($table)
614 or die "No schema for table $table found - ".
615 "do you need to create it or run dbdef-create?";
616 my $pkey = $dbdef_table->primary_key
617 or die "No primary key for table $table";
619 return qsearchs($table, { $pkey => $pkey_value });
622 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
624 Experimental JOINed search method. Using this method, you can execute a
625 single SELECT spanning multiple tables, and cache the results for subsequent
626 method calls. Interface will almost definately change in an incompatible
634 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
635 my $cache = FS::SearchCache->new( $ptable, $pkey );
638 grep { !$saw{$_->getfield($pkey)}++ }
639 qsearch($table, $record, $select, $extra_sql, $cache )
643 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
645 Same as qsearch, except that if more than one record matches, it B<carp>s but
646 returns the first. If this happens, you either made a logic error in asking
647 for a single item, or your data is corrupted.
651 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
653 my(@result) = qsearch(@_);
654 cluck "warning: Multiple records in scalar search ($table)"
655 if scalar(@result) > 1;
656 #should warn more vehemently if the search was on a primary key?
657 scalar(@result) ? ($result[0]) : ();
668 Returns the table name.
673 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
680 Returns the DBIx::DBSchema::Table object for the table.
686 my($table)=$self->table;
687 dbdef->table($table);
692 Returns the primary key for the table.
698 my $pkey = $self->dbdef_table->primary_key;
701 =item get, getfield COLUMN
703 Returns the value of the column/field/key COLUMN.
708 my($self,$field) = @_;
709 # to avoid "Use of unitialized value" errors
710 if ( defined ( $self->{Hash}->{$field} ) ) {
711 $self->{Hash}->{$field};
721 =item set, setfield COLUMN, VALUE
723 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
728 my($self,$field,$value) = @_;
729 $self->{'modified'} = 1;
730 $self->{'Hash'}->{$field} = $value;
739 Returns true if the column/field/key COLUMN exists.
744 my($self,$field) = @_;
745 exists($self->{Hash}->{$field});
748 =item AUTLOADED METHODS
750 $record->column is a synonym for $record->get('column');
752 $record->column('value') is a synonym for $record->set('column','value');
759 my($field)=$AUTOLOAD;
761 if ( defined($value) ) {
762 confess "errant AUTOLOAD $field for $self (arg $value)"
763 unless blessed($self) && $self->can('setfield');
764 $self->setfield($field,$value);
766 confess "errant AUTOLOAD $field for $self (no args)"
767 unless blessed($self) && $self->can('getfield');
768 $self->getfield($field);
774 # my $field = $AUTOLOAD;
776 # if ( defined($_[1]) ) {
777 # $_[0]->setfield($field, $_[1]);
779 # $_[0]->getfield($field);
785 Returns a list of the column/value pairs, usually for assigning to a new hash.
787 To make a distinct duplicate of an FS::Record object, you can do:
789 $new = new FS::Record ( $old->table, { $old->hash } );
795 confess $self. ' -> hash: Hash attribute is undefined'
796 unless defined($self->{'Hash'});
797 %{ $self->{'Hash'} };
802 Returns a reference to the column/value hash. This may be deprecated in the
803 future; if there's a reason you can't just use the autoloaded or get/set
815 Returns true if any of this object's values have been modified with set (or via
816 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
826 =item select_for_update
828 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
833 sub select_for_update {
835 my $primary_key = $self->primary_key;
838 'table' => $self->table,
839 'hashref' => { $primary_key => $self->$primary_key() },
840 'extra_sql' => 'FOR UPDATE',
846 Locks this table with a database-driver specific lock method. This is used
847 as a mutex in order to do a duplicate search.
849 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
851 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
853 Errors are fatal; no useful return value.
855 Note: To use this method for new tables other than svc_acct and svc_phone,
856 edit freeside-upgrade and add those tables to the duplicate_lock list.
862 my $table = $self->table;
864 warn "$me locking $table table\n" if $DEBUG;
866 if ( driver_name =~ /^Pg/i ) {
868 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
871 } elsif ( driver_name =~ /^mysql/i ) {
873 dbh->do("SELECT * FROM duplicate_lock
874 WHERE lockname = '$table'
876 ) or die dbh->errstr;
880 die "unknown database ". driver_name. "; don't know how to lock table";
884 warn "$me acquired $table table lock\n" if $DEBUG;
890 Inserts this record to the database. If there is an error, returns the error,
891 otherwise returns false.
899 warn "$self -> insert" if $DEBUG;
901 my $error = $self->check;
902 return $error if $error;
904 #single-field non-null unique keys are given a value if empty
905 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
906 foreach ( $self->dbdef_table->unique_singles) {
907 next if $self->getfield($_);
908 next if $self->dbdef_table->column($_)->null eq 'NULL';
912 #and also the primary key, if the database isn't going to
913 my $primary_key = $self->dbdef_table->primary_key;
915 if ( $primary_key ) {
916 my $col = $self->dbdef_table->column($primary_key);
919 uc($col->type) =~ /^(BIG)?SERIAL\d?/
920 || ( driver_name eq 'Pg'
921 && defined($col->default)
922 && $col->quoted_default =~ /^nextval\(/i
924 || ( driver_name eq 'mysql'
925 && defined($col->local)
926 && $col->local =~ /AUTO_INCREMENT/i
928 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
931 my $table = $self->table;
933 # Encrypt before the database
934 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
935 && scalar( eval '@FS::'. $table . '::encrypted_fields')
936 && $conf->exists('encryption')
938 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
939 next if $field eq 'payinfo'
940 && ($self->isa('FS::payinfo_transaction_Mixin')
941 || $self->isa('FS::payinfo_Mixin') )
943 && !grep { $self->payby eq $_ } @encrypt_payby;
944 $saved->{$field} = $self->getfield($field);
945 $self->setfield($field, $self->encrypt($self->getfield($field)));
949 #false laziness w/delete
951 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
954 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
957 my $statement = "INSERT INTO $table ";
958 if ( @real_fields ) {
961 join( ', ', @real_fields ).
963 join( ', ', @values ).
967 $statement .= 'DEFAULT VALUES';
969 warn "[debug]$me $statement\n" if $DEBUG > 1;
970 my $sth = dbh->prepare($statement) or return dbh->errstr;
972 local $SIG{HUP} = 'IGNORE';
973 local $SIG{INT} = 'IGNORE';
974 local $SIG{QUIT} = 'IGNORE';
975 local $SIG{TERM} = 'IGNORE';
976 local $SIG{TSTP} = 'IGNORE';
977 local $SIG{PIPE} = 'IGNORE';
979 $sth->execute or return $sth->errstr;
981 # get inserted id from the database, if applicable & needed
982 if ( $db_seq && ! $self->getfield($primary_key) ) {
983 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
987 if ( driver_name eq 'Pg' ) {
989 #my $oid = $sth->{'pg_oid_status'};
990 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
992 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
993 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
994 dbh->rollback if $FS::UID::AutoCommit;
995 return "can't parse $table.$primary_key default value".
996 " for sequence name: $default";
1000 my $i_sql = "SELECT currval('$sequence')";
1001 my $i_sth = dbh->prepare($i_sql) or do {
1002 dbh->rollback if $FS::UID::AutoCommit;
1005 $i_sth->execute() or do { #$i_sth->execute($oid)
1006 dbh->rollback if $FS::UID::AutoCommit;
1007 return $i_sth->errstr;
1009 $insertid = $i_sth->fetchrow_arrayref->[0];
1011 } elsif ( driver_name eq 'mysql' ) {
1013 $insertid = dbh->{'mysql_insertid'};
1014 # work around mysql_insertid being null some of the time, ala RT :/
1015 unless ( $insertid ) {
1016 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1017 "using SELECT LAST_INSERT_ID();";
1018 my $i_sql = "SELECT LAST_INSERT_ID()";
1019 my $i_sth = dbh->prepare($i_sql) or do {
1020 dbh->rollback if $FS::UID::AutoCommit;
1023 $i_sth->execute or do {
1024 dbh->rollback if $FS::UID::AutoCommit;
1025 return $i_sth->errstr;
1027 $insertid = $i_sth->fetchrow_arrayref->[0];
1032 dbh->rollback if $FS::UID::AutoCommit;
1033 return "don't know how to retreive inserted ids from ". driver_name.
1034 ", try using counterfiles (maybe run dbdef-create?)";
1038 $self->setfield($primary_key, $insertid);
1043 if ( defined dbdef->table('h_'. $table) ) {
1044 my $h_statement = $self->_h_statement('insert');
1045 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1046 $h_sth = dbh->prepare($h_statement) or do {
1047 dbh->rollback if $FS::UID::AutoCommit;
1053 $h_sth->execute or return $h_sth->errstr if $h_sth;
1055 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1057 # Now that it has been saved, reset the encrypted fields so that $new
1058 # can still be used.
1059 foreach my $field (keys %{$saved}) {
1060 $self->setfield($field, $saved->{$field});
1068 Depriciated (use insert instead).
1073 cluck "warning: FS::Record::add deprecated!";
1074 insert @_; #call method in this scope
1079 Delete this record from the database. If there is an error, returns the error,
1080 otherwise returns false.
1087 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1089 $self->getfield($_) eq ''
1090 #? "( $_ IS NULL OR $_ = \"\" )"
1091 ? ( driver_name eq 'Pg'
1093 : "( $_ IS NULL OR $_ = \"\" )"
1095 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1096 } ( $self->dbdef_table->primary_key )
1097 ? ( $self->dbdef_table->primary_key)
1098 : real_fields($self->table)
1100 warn "[debug]$me $statement\n" if $DEBUG > 1;
1101 my $sth = dbh->prepare($statement) or return dbh->errstr;
1104 if ( defined dbdef->table('h_'. $self->table) ) {
1105 my $h_statement = $self->_h_statement('delete');
1106 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1107 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1112 my $primary_key = $self->dbdef_table->primary_key;
1114 local $SIG{HUP} = 'IGNORE';
1115 local $SIG{INT} = 'IGNORE';
1116 local $SIG{QUIT} = 'IGNORE';
1117 local $SIG{TERM} = 'IGNORE';
1118 local $SIG{TSTP} = 'IGNORE';
1119 local $SIG{PIPE} = 'IGNORE';
1121 my $rc = $sth->execute or return $sth->errstr;
1122 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1123 $h_sth->execute or return $h_sth->errstr if $h_sth;
1125 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1127 #no need to needlessly destoy the data either (causes problems actually)
1128 #undef $self; #no need to keep object!
1135 Depriciated (use delete instead).
1140 cluck "warning: FS::Record::del deprecated!";
1141 &delete(@_); #call method in this scope
1144 =item replace OLD_RECORD
1146 Replace the OLD_RECORD with this one in the database. If there is an error,
1147 returns the error, otherwise returns false.
1152 my ($new, $old) = (shift, shift);
1154 $old = $new->replace_old unless defined($old);
1156 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1158 if ( $new->can('replace_check') ) {
1159 my $error = $new->replace_check($old);
1160 return $error if $error;
1163 return "Records not in same table!" unless $new->table eq $old->table;
1165 my $primary_key = $old->dbdef_table->primary_key;
1166 return "Can't change primary key $primary_key ".
1167 'from '. $old->getfield($primary_key).
1168 ' to ' . $new->getfield($primary_key)
1170 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1172 my $error = $new->check;
1173 return $error if $error;
1175 # Encrypt for replace
1177 if ( $conf->exists('encryption')
1178 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1179 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1181 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1182 next if $field eq 'payinfo'
1183 && ($new->isa('FS::payinfo_transaction_Mixin')
1184 || $new->isa('FS::payinfo_Mixin') )
1186 && !grep { $new->payby eq $_ } @encrypt_payby;
1187 $saved->{$field} = $new->getfield($field);
1188 $new->setfield($field, $new->encrypt($new->getfield($field)));
1192 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1193 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1194 ? ($_, $new->getfield($_)) : () } $old->fields;
1196 unless (keys(%diff) || $no_update_diff ) {
1197 carp "[warning]$me ". ref($new)."->replace ".
1198 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1199 ": records identical"
1200 unless $nowarn_identical;
1204 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1206 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1207 } real_fields($old->table)
1212 if ( $old->getfield($_) eq '' ) {
1214 #false laziness w/qsearch
1215 if ( driver_name eq 'Pg' ) {
1216 my $type = $old->dbdef_table->column($_)->type;
1217 if ( $type =~ /(int|(big)?serial)/i ) {
1220 qq-( $_ IS NULL OR $_ = '' )-;
1223 qq-( $_ IS NULL OR $_ = "" )-;
1227 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1230 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1233 warn "[debug]$me $statement\n" if $DEBUG > 1;
1234 my $sth = dbh->prepare($statement) or return dbh->errstr;
1237 if ( defined dbdef->table('h_'. $old->table) ) {
1238 my $h_old_statement = $old->_h_statement('replace_old');
1239 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1240 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1246 if ( defined dbdef->table('h_'. $new->table) ) {
1247 my $h_new_statement = $new->_h_statement('replace_new');
1248 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1249 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1254 local $SIG{HUP} = 'IGNORE';
1255 local $SIG{INT} = 'IGNORE';
1256 local $SIG{QUIT} = 'IGNORE';
1257 local $SIG{TERM} = 'IGNORE';
1258 local $SIG{TSTP} = 'IGNORE';
1259 local $SIG{PIPE} = 'IGNORE';
1261 my $rc = $sth->execute or return $sth->errstr;
1262 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1263 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1264 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1266 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1268 # Now that it has been saved, reset the encrypted fields so that $new
1269 # can still be used.
1270 foreach my $field (keys %{$saved}) {
1271 $new->setfield($field, $saved->{$field});
1279 my( $self ) = shift;
1280 warn "[$me] replace called with no arguments; autoloading old record\n"
1283 my $primary_key = $self->dbdef_table->primary_key;
1284 if ( $primary_key ) {
1285 $self->by_key( $self->$primary_key() ) #this is what's returned
1286 or croak "can't find ". $self->table. ".$primary_key ".
1287 $self->$primary_key();
1289 croak $self->table. " has no primary key; pass old record as argument";
1296 Depriciated (use replace instead).
1301 cluck "warning: FS::Record::rep deprecated!";
1302 replace @_; #call method in this scope
1307 Checks custom fields. Subclasses should still provide a check method to validate
1308 non-custom fields, foreign keys, etc., and call this method via $self->SUPER::check.
1314 foreach my $field ($self->virtual_fields) {
1315 my $error = $self->ut_textn($field);
1316 return $error if $error;
1321 =item virtual_fields [ TABLE ]
1323 Returns a list of virtual fields defined for the table. This should not
1324 be exported, and should only be called as an instance or class method.
1328 sub virtual_fields {
1331 $table = $self->table or confess "virtual_fields called on non-table";
1333 confess "Unknown table $table" unless dbdef->table($table);
1335 return () unless dbdef->table('part_virtual_field');
1337 unless ( $virtual_fields_cache{$table} ) {
1338 my $concat = [ "'cf_'", "name" ];
1339 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1340 "WHERE dbtable = '$table'";
1342 my $result = $dbh->selectcol_arrayref($query);
1343 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1345 $virtual_fields_cache{$table} = $result;
1348 @{$virtual_fields_cache{$table}};
1352 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1354 Processes a batch import as a queued JSRPC job
1356 JOB is an FS::queue entry.
1358 OPTIONS_HASHREF can have the following keys:
1364 Table name (required).
1368 Listref of field names for static fields. They will be given values from the
1369 PARAMS hashref and passed as a "params" hashref to batch_import.
1373 Formats hashref. Keys are field names, values are listrefs that define the
1376 Each listref value can be a column name or a code reference. Coderefs are run
1377 with the row object, data and a FS::Conf object as the three parameters.
1378 For example, this coderef does the same thing as using the "columnname" string:
1381 my( $record, $data, $conf ) = @_;
1382 $record->columnname( $data );
1385 Coderefs are run after all "column name" fields are assigned.
1389 Optional format hashref of types. Keys are field names, values are "csv",
1390 "xls" or "fixedlength". Overrides automatic determination of file type
1393 =item format_headers
1395 Optional format hashref of header lines. Keys are field names, values are 0
1396 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1399 =item format_sep_chars
1401 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1402 CSV separation character.
1404 =item format_fixedlenth_formats
1406 Optional format hashref of fixed length format defintiions. Keys are field
1407 names, values Parse::FixedLength listrefs of field definitions.
1411 Set true to default to CSV file type if the filename does not contain a
1412 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1417 PARAMS is a base64-encoded Storable string containing the POSTed data as
1418 a hash ref. It normally contains at least one field, "uploaded files",
1419 generated by /elements/file-upload.html and containing the list of uploaded
1420 files. Currently only supports a single file named "file".
1424 use Storable qw(thaw);
1427 sub process_batch_import {
1428 my($job, $opt) = ( shift, shift );
1430 my $table = $opt->{table};
1431 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1432 my %formats = %{ $opt->{formats} };
1434 my $param = thaw(decode_base64(shift));
1435 warn Dumper($param) if $DEBUG;
1437 my $files = $param->{'uploaded_files'}
1438 or die "No files provided.\n";
1440 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1442 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1443 my $file = $dir. $files{'file'};
1448 formats => \%formats,
1449 format_types => $opt->{format_types},
1450 format_headers => $opt->{format_headers},
1451 format_sep_chars => $opt->{format_sep_chars},
1452 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1453 format_xml_formats => $opt->{format_xml_formats},
1454 format_row_callbacks => $opt->{format_row_callbacks},
1459 format => $param->{format},
1460 params => { map { $_ => $param->{$_} } @pass_params },
1462 default_csv => $opt->{default_csv},
1463 postinsert_callback => $opt->{postinsert_callback},
1466 if ( $opt->{'batch_namecol'} ) {
1467 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1468 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1471 my $error = FS::Record::batch_import( \%iopt );
1475 die "$error\n" if $error;
1478 =item batch_import PARAM_HASHREF
1480 Class method for batch imports. Available params:
1486 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1492 =item format_headers
1494 =item format_sep_chars
1496 =item format_fixedlength_formats
1498 =item format_row_callbacks
1500 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1502 =item preinsert_callback
1504 =item postinsert_callback
1510 FS::queue object, will be updated with progress
1516 csv, xls, fixedlength, xml
1527 warn "$me batch_import call with params: \n". Dumper($param)
1530 my $table = $param->{table};
1532 my $job = $param->{job};
1533 my $file = $param->{file};
1534 my $params = $param->{params} || {};
1536 my( $type, $header, $sep_char, $fixedlength_format,
1537 $xml_format, $row_callback, @fields );
1539 my $postinsert_callback = '';
1540 $postinsert_callback = $param->{'postinsert_callback'}
1541 if $param->{'postinsert_callback'};
1542 my $preinsert_callback = '';
1543 $preinsert_callback = $param->{'preinsert_callback'}
1544 if $param->{'preinsert_callback'};
1546 if ( $param->{'format'} ) {
1548 my $format = $param->{'format'};
1549 my $formats = $param->{formats};
1550 die "unknown format $format" unless exists $formats->{ $format };
1552 $type = $param->{'format_types'}
1553 ? $param->{'format_types'}{ $format }
1554 : $param->{type} || 'csv';
1557 $header = $param->{'format_headers'}
1558 ? $param->{'format_headers'}{ $param->{'format'} }
1561 $sep_char = $param->{'format_sep_chars'}
1562 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1565 $fixedlength_format =
1566 $param->{'format_fixedlength_formats'}
1567 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1571 $param->{'format_xml_formats'}
1572 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1576 $param->{'format_row_callbacks'}
1577 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1580 @fields = @{ $formats->{ $format } };
1582 } elsif ( $param->{'fields'} ) {
1584 $type = ''; #infer from filename
1587 $fixedlength_format = '';
1589 @fields = @{ $param->{'fields'} };
1592 die "neither format nor fields specified";
1595 #my $file = $param->{file};
1598 if ( $file =~ /\.(\w+)$/i ) {
1602 warn "can't parse file type from filename $file; defaulting to CSV";
1606 if $param->{'default_csv'} && $type ne 'xls';
1614 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1616 if ( $type eq 'csv' ) {
1619 $attr{sep_char} = $sep_char if $sep_char;
1620 $parser = new Text::CSV_XS \%attr;
1622 } elsif ( $type eq 'fixedlength' ) {
1624 eval "use Parse::FixedLength;";
1626 $parser = Parse::FixedLength->new($fixedlength_format);
1630 die "Unknown file type $type\n";
1633 @buffer = split(/\r?\n/, slurp($file) );
1634 splice(@buffer, 0, ($header || 0) );
1635 $count = scalar(@buffer);
1637 } elsif ( $type eq 'xls' ) {
1639 eval "use Spreadsheet::ParseExcel;";
1642 eval "use DateTime::Format::Excel;";
1643 #for now, just let the error be thrown if it is used, since only CDR
1644 # formats bill_west and troop use it, not other excel-parsing things
1647 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1649 $parser = $excel->{Worksheet}[0]; #first sheet
1651 $count = $parser->{MaxRow} || $parser->{MinRow};
1654 $row = $header || 0;
1655 } elsif ( $type eq 'xml' ) {
1657 eval "use XML::Simple;";
1659 my $xmlrow = $xml_format->{'xmlrow'};
1660 $parser = $xml_format->{'xmlkeys'};
1661 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1662 my $data = XML::Simple::XMLin(
1664 'SuppressEmpty' => '', #sets empty values to ''
1668 $rows = $rows->{$_} foreach @$xmlrow;
1669 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1670 $count = @buffer = @$rows;
1672 die "Unknown file type $type\n";
1677 local $SIG{HUP} = 'IGNORE';
1678 local $SIG{INT} = 'IGNORE';
1679 local $SIG{QUIT} = 'IGNORE';
1680 local $SIG{TERM} = 'IGNORE';
1681 local $SIG{TSTP} = 'IGNORE';
1682 local $SIG{PIPE} = 'IGNORE';
1684 my $oldAutoCommit = $FS::UID::AutoCommit;
1685 local $FS::UID::AutoCommit = 0;
1688 #my $params = $param->{params} || {};
1689 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1690 my $batch_col = $param->{'batch_keycol'};
1692 my $batch_class = 'FS::'. $param->{'batch_table'};
1693 my $batch = $batch_class->new({
1694 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1696 my $error = $batch->insert;
1698 $dbh->rollback if $oldAutoCommit;
1699 return "can't insert batch record: $error";
1701 #primary key via dbdef? (so the column names don't have to match)
1702 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1704 $params->{ $batch_col } = $batch_value;
1707 #my $job = $param->{job};
1710 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1714 if ( $type eq 'csv' ) {
1716 last unless scalar(@buffer);
1717 $line = shift(@buffer);
1719 next if $line =~ /^\s*$/; #skip empty lines
1721 $line = &{$row_callback}($line) if $row_callback;
1723 next if $line =~ /^\s*$/; #skip empty lines
1725 $parser->parse($line) or do {
1726 $dbh->rollback if $oldAutoCommit;
1727 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
1729 @columns = $parser->fields();
1731 } elsif ( $type eq 'fixedlength' ) {
1733 last unless scalar(@buffer);
1734 $line = shift(@buffer);
1736 @columns = $parser->parse($line);
1738 } elsif ( $type eq 'xls' ) {
1740 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1741 || ! $parser->{Cells}[$row];
1743 my @row = @{ $parser->{Cells}[$row] };
1744 @columns = map $_->{Val}, @row;
1747 #warn $z++. ": $_\n" for @columns;
1749 } elsif ( $type eq 'xml' ) {
1750 # $parser = [ 'Column0Key', 'Column1Key' ... ]
1751 last unless scalar(@buffer);
1752 my $row = shift @buffer;
1753 @columns = @{ $row }{ @$parser };
1755 die "Unknown file type $type\n";
1759 my %hash = %$params;
1761 foreach my $field ( @fields ) {
1763 my $value = shift @columns;
1765 if ( ref($field) eq 'CODE' ) {
1766 #&{$field}(\%hash, $value);
1767 push @later, $field, $value;
1769 #??? $hash{$field} = $value if length($value);
1770 $hash{$field} = $value if defined($value) && length($value);
1775 #my $table = $param->{table};
1776 my $class = "FS::$table";
1778 my $record = $class->new( \%hash );
1781 while ( scalar(@later) ) {
1782 my $sub = shift @later;
1783 my $data = shift @later;
1785 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
1788 $dbh->rollback if $oldAutoCommit;
1789 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
1791 last if exists( $param->{skiprow} );
1793 next if exists( $param->{skiprow} );
1795 if ( $preinsert_callback ) {
1796 my $error = &{$preinsert_callback}($record, $param);
1798 $dbh->rollback if $oldAutoCommit;
1799 return "preinsert_callback error". ( $line ? " for $line" : '' ).
1802 next if exists $param->{skiprow} && $param->{skiprow};
1805 my $error = $record->insert;
1808 $dbh->rollback if $oldAutoCommit;
1809 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1815 if ( $postinsert_callback ) {
1816 my $error = &{$postinsert_callback}($record, $param);
1818 $dbh->rollback if $oldAutoCommit;
1819 return "postinsert_callback error". ( $line ? " for $line" : '' ).
1824 if ( $job && time - $min_sec > $last ) { #progress bar
1825 $job->update_statustext( int(100 * $imported / $count) );
1831 unless ( $imported || $param->{empty_ok} ) {
1832 $dbh->rollback if $oldAutoCommit;
1833 return "Empty file!";
1836 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1843 my( $self, $action, $time ) = @_;
1847 my %nohistory = map { $_=>1 } $self->nohistory_fields;
1850 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
1851 real_fields($self->table);
1854 # If we're encrypting then don't store the payinfo in the history
1855 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
1856 @fields = grep { $_ ne 'payinfo' } @fields;
1859 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1861 "INSERT INTO h_". $self->table. " ( ".
1862 join(', ', qw(history_date history_user history_action), @fields ).
1864 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1871 B<Warning>: External use is B<deprecated>.
1873 Replaces COLUMN in record with a unique number, using counters in the
1874 filesystem. Used by the B<insert> method on single-field unique columns
1875 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1876 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1878 Returns the new value.
1883 my($self,$field) = @_;
1884 my($table)=$self->table;
1886 croak "Unique called on field $field, but it is ",
1887 $self->getfield($field),
1889 if $self->getfield($field);
1891 #warn "table $table is tainted" if is_tainted($table);
1892 #warn "field $field is tainted" if is_tainted($field);
1894 my($counter) = new File::CounterFile "$table.$field",0;
1896 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1898 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1901 my $index = $counter->inc;
1902 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1904 $index =~ /^(\d*)$/;
1907 $self->setfield($field,$index);
1911 =item ut_float COLUMN
1913 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1914 null. If there is an error, returns the error, otherwise returns false.
1919 my($self,$field)=@_ ;
1920 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
1921 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
1922 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
1923 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
1924 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1925 $self->setfield($field,$1);
1928 =item ut_floatn COLUMN
1930 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1931 null. If there is an error, returns the error, otherwise returns false.
1935 #false laziness w/ut_ipn
1937 my( $self, $field ) = @_;
1938 if ( $self->getfield($field) =~ /^()$/ ) {
1939 $self->setfield($field,'');
1942 $self->ut_float($field);
1946 =item ut_sfloat COLUMN
1948 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
1949 May not be null. If there is an error, returns the error, otherwise returns
1955 my($self,$field)=@_ ;
1956 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
1957 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
1958 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
1959 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
1960 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1961 $self->setfield($field,$1);
1964 =item ut_sfloatn COLUMN
1966 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1967 null. If there is an error, returns the error, otherwise returns false.
1972 my( $self, $field ) = @_;
1973 if ( $self->getfield($field) =~ /^()$/ ) {
1974 $self->setfield($field,'');
1977 $self->ut_sfloat($field);
1981 =item ut_snumber COLUMN
1983 Check/untaint signed numeric data (whole numbers). If there is an error,
1984 returns the error, otherwise returns false.
1989 my($self, $field) = @_;
1990 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
1991 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1992 $self->setfield($field, "$1$2");
1996 =item ut_snumbern COLUMN
1998 Check/untaint signed numeric data (whole numbers). If there is an error,
1999 returns the error, otherwise returns false.
2004 my($self, $field) = @_;
2005 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2006 or return "Illegal (numeric) $field: ". $self->getfield($field);
2008 return "Illegal (numeric) $field: ". $self->getfield($field)
2011 $self->setfield($field, "$1$2");
2015 =item ut_number COLUMN
2017 Check/untaint simple numeric data (whole numbers). May not be null. If there
2018 is an error, returns the error, otherwise returns false.
2023 my($self,$field)=@_;
2024 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2025 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2026 $self->setfield($field,$1);
2030 =item ut_numbern COLUMN
2032 Check/untaint simple numeric data (whole numbers). May be null. If there is
2033 an error, returns the error, otherwise returns false.
2038 my($self,$field)=@_;
2039 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2040 or return "Illegal (numeric) $field: ". $self->getfield($field);
2041 $self->setfield($field,$1);
2045 =item ut_money COLUMN
2047 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2048 is an error, returns the error, otherwise returns false.
2053 my($self,$field)=@_;
2054 $self->setfield($field, 0) if $self->getfield($field) eq '';
2055 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
2056 or return "Illegal (money) $field: ". $self->getfield($field);
2057 #$self->setfield($field, "$1$2$3" || 0);
2058 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2062 =item ut_moneyn COLUMN
2064 Check/untaint monetary numbers. May be negative. If there
2065 is an error, returns the error, otherwise returns false.
2070 my($self,$field)=@_;
2071 if ($self->getfield($field) eq '') {
2072 $self->setfield($field, '');
2075 $self->ut_money($field);
2078 =item ut_text COLUMN
2080 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2081 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2082 May not be null. If there is an error, returns the error, otherwise returns
2088 my($self,$field)=@_;
2089 #warn "msgcat ". \&msgcat. "\n";
2090 #warn "notexist ". \¬exist. "\n";
2091 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2092 $self->getfield($field)
2093 =~ /^([\wô \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2094 or return gettext('illegal_or_empty_text'). " $field: ".
2095 $self->getfield($field);
2096 $self->setfield($field,$1);
2100 =item ut_textn COLUMN
2102 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2103 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2104 May be null. If there is an error, returns the error, otherwise returns false.
2109 my($self,$field)=@_;
2110 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2111 $self->ut_text($field);
2114 =item ut_alpha COLUMN
2116 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2117 an error, returns the error, otherwise returns false.
2122 my($self,$field)=@_;
2123 $self->getfield($field) =~ /^(\w+)$/
2124 or return "Illegal or empty (alphanumeric) $field: ".
2125 $self->getfield($field);
2126 $self->setfield($field,$1);
2130 =item ut_alphan COLUMN
2132 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2133 error, returns the error, otherwise returns false.
2138 my($self,$field)=@_;
2139 $self->getfield($field) =~ /^(\w*)$/
2140 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2141 $self->setfield($field,$1);
2145 =item ut_alphasn COLUMN
2147 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2148 an error, returns the error, otherwise returns false.
2153 my($self,$field)=@_;
2154 $self->getfield($field) =~ /^([\w ]*)$/
2155 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2156 $self->setfield($field,$1);
2161 =item ut_alpha_lower COLUMN
2163 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2164 there is an error, returns the error, otherwise returns false.
2168 sub ut_alpha_lower {
2169 my($self,$field)=@_;
2170 $self->getfield($field) =~ /[[:upper:]]/
2171 and return "Uppercase characters are not permitted in $field";
2172 $self->ut_alpha($field);
2175 =item ut_phonen COLUMN [ COUNTRY ]
2177 Check/untaint phone numbers. May be null. If there is an error, returns
2178 the error, otherwise returns false.
2180 Takes an optional two-letter ISO country code; without it or with unsupported
2181 countries, ut_phonen simply calls ut_alphan.
2186 my( $self, $field, $country ) = @_;
2187 return $self->ut_alphan($field) unless defined $country;
2188 my $phonen = $self->getfield($field);
2189 if ( $phonen eq '' ) {
2190 $self->setfield($field,'');
2191 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2193 $phonen = $conf->config('cust_main-default_areacode').$phonen
2194 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2195 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2196 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2197 $phonen = "$1-$2-$3";
2198 $phonen .= " x$4" if $4;
2199 $self->setfield($field,$phonen);
2201 warn "warning: don't know how to check phone numbers for country $country";
2202 return $self->ut_textn($field);
2209 Check/untaint hexadecimal values.
2214 my($self, $field) = @_;
2215 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2216 or return "Illegal (hex) $field: ". $self->getfield($field);
2217 $self->setfield($field, uc($1));
2221 =item ut_hexn COLUMN
2223 Check/untaint hexadecimal values. May be null.
2228 my($self, $field) = @_;
2229 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2230 or return "Illegal (hex) $field: ". $self->getfield($field);
2231 $self->setfield($field, uc($1));
2235 =item ut_mac_addr COLUMN
2237 Check/untaint mac addresses. May be null.
2242 my($self, $field) = @_;
2244 my $mac = $self->get($field);
2247 $self->set($field, $mac);
2249 my $e = $self->ut_hex($field);
2252 return "Illegal (mac address) $field: ". $self->getfield($field)
2253 unless length($self->getfield($field)) == 12;
2259 =item ut_mac_addrn COLUMN
2261 Check/untaint mac addresses. May be null.
2266 my($self, $field) = @_;
2267 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2272 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2278 my( $self, $field ) = @_;
2279 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2280 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2281 or return "Illegal (IP address) $field: ". $self->getfield($field);
2282 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2283 $self->setfield($field, "$1.$2.$3.$4");
2289 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2290 to 127.0.0.1. May be null.
2295 my( $self, $field ) = @_;
2296 if ( $self->getfield($field) =~ /^()$/ ) {
2297 $self->setfield($field,'');
2300 $self->ut_ip($field);
2304 =item ut_ip46 COLUMN
2306 Check/untaint IPv4 or IPv6 address.
2311 my( $self, $field ) = @_;
2312 my $ip = NetAddr::IP->new($self->getfield($field))
2313 or return "Illegal (IP address) $field: ".$self->getfield($field);
2314 $self->setfield($field, lc($ip->addr));
2320 Check/untaint IPv6 or IPv6 address. May be null.
2325 my( $self, $field ) = @_;
2326 if ( $self->getfield($field) =~ /^$/ ) {
2327 $self->setfield($field, '');
2330 $self->ut_ip46($field);
2333 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2335 Check/untaint coordinates.
2336 Accepts the following forms:
2346 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2347 The latter form (that is, the MMM are thousands of minutes) is
2348 assumed if the "MMM" is exactly three digits or two digits > 59.
2350 To be safe, just use the DDD.DDDDD form.
2352 If LOWER or UPPER are specified, then the coordinate is checked
2353 for lower and upper bounds, respectively.
2358 my ($self, $field) = (shift, shift);
2361 if ( $field =~ /latitude/ ) {
2362 $lower = $lat_lower;
2364 } elsif ( $field =~ /longitude/ ) {
2366 $upper = $lon_upper;
2369 my $coord = $self->getfield($field);
2370 my $neg = $coord =~ s/^(-)//;
2372 my ($d, $m, $s) = (0, 0, 0);
2375 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2376 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2377 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2379 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2382 return "Invalid (coordinate with minutes > 59) $field: "
2383 . $self->getfield($field);
2386 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2388 if (defined($lower) and ($coord < $lower)) {
2389 return "Invalid (coordinate < $lower) $field: "
2390 . $self->getfield($field);;
2393 if (defined($upper) and ($coord > $upper)) {
2394 return "Invalid (coordinate > $upper) $field: "
2395 . $self->getfield($field);;
2398 $self->setfield($field, $coord);
2402 return "Invalid (coordinate) $field: " . $self->getfield($field);
2406 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2408 Same as ut_coord, except optionally null.
2414 my ($self, $field) = (shift, shift);
2416 if ($self->getfield($field) =~ /^\s*$/) {
2419 return $self->ut_coord($field, @_);
2425 =item ut_domain COLUMN
2427 Check/untaint host and domain names.
2432 my( $self, $field ) = @_;
2433 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2434 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2435 or return "Illegal (domain) $field: ". $self->getfield($field);
2436 $self->setfield($field,$1);
2440 =item ut_name COLUMN
2442 Check/untaint proper names; allows alphanumerics, spaces and the following
2443 punctuation: , . - '
2450 my( $self, $field ) = @_;
2451 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2452 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2453 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2454 $self->setfield($field,$1);
2460 Check/untaint zip codes.
2464 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2467 my( $self, $field, $country ) = @_;
2469 if ( $country eq 'US' ) {
2471 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2472 or return gettext('illegal_zip'). " $field for country $country: ".
2473 $self->getfield($field);
2474 $self->setfield($field, $1);
2476 } elsif ( $country eq 'CA' ) {
2478 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2479 or return gettext('illegal_zip'). " $field for country $country: ".
2480 $self->getfield($field);
2481 $self->setfield($field, "$1 $2");
2485 if ( $self->getfield($field) =~ /^\s*$/
2486 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2489 $self->setfield($field,'');
2491 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2492 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2493 $self->setfield($field,$1);
2501 =item ut_country COLUMN
2503 Check/untaint country codes. Country names are changed to codes, if possible -
2504 see L<Locale::Country>.
2509 my( $self, $field ) = @_;
2510 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2511 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2512 && country2code($1) ) {
2513 $self->setfield($field,uc(country2code($1)));
2516 $self->getfield($field) =~ /^(\w\w)$/
2517 or return "Illegal (country) $field: ". $self->getfield($field);
2518 $self->setfield($field,uc($1));
2522 =item ut_anything COLUMN
2524 Untaints arbitrary data. Be careful.
2529 my( $self, $field ) = @_;
2530 $self->getfield($field) =~ /^(.*)$/s
2531 or return "Illegal $field: ". $self->getfield($field);
2532 $self->setfield($field,$1);
2536 =item ut_enum COLUMN CHOICES_ARRAYREF
2538 Check/untaint a column, supplying all possible choices, like the "enum" type.
2543 my( $self, $field, $choices ) = @_;
2544 foreach my $choice ( @$choices ) {
2545 if ( $self->getfield($field) eq $choice ) {
2546 $self->setfield($field, $choice);
2550 return "Illegal (enum) field $field: ". $self->getfield($field);
2553 =item ut_enumn COLUMN CHOICES_ARRAYREF
2555 Like ut_enum, except the null value is also allowed.
2560 my( $self, $field, $choices ) = @_;
2561 $self->getfield($field)
2562 ? $self->ut_enum($field, $choices)
2566 =item ut_flag COLUMN
2568 Check/untaint a column if it contains either an empty string or 'Y'. This
2569 is the standard form for boolean flags in Freeside.
2574 my( $self, $field ) = @_;
2575 my $value = uc($self->getfield($field));
2576 if ( $value eq '' or $value eq 'Y' ) {
2577 $self->setfield($field, $value);
2580 return "Illegal (flag) field $field: $value";
2583 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2585 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2586 on the column first.
2590 sub ut_foreign_key {
2591 my( $self, $field, $table, $foreign ) = @_;
2592 return '' if $no_check_foreign;
2593 qsearchs($table, { $foreign => $self->getfield($field) })
2594 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2595 " in $table.$foreign";
2599 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2601 Like ut_foreign_key, except the null value is also allowed.
2605 sub ut_foreign_keyn {
2606 my( $self, $field, $table, $foreign ) = @_;
2607 $self->getfield($field)
2608 ? $self->ut_foreign_key($field, $table, $foreign)
2612 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2614 Checks this column as an agentnum, taking into account the current users's
2615 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2616 right or rights allowing no agentnum.
2620 sub ut_agentnum_acl {
2621 my( $self, $field ) = (shift, shift);
2622 my $null_acl = scalar(@_) ? shift : [];
2623 $null_acl = [ $null_acl ] unless ref($null_acl);
2625 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2626 return "Illegal agentnum: $error" if $error;
2628 my $curuser = $FS::CurrentUser::CurrentUser;
2630 if ( $self->$field() ) {
2632 return "Access denied"
2633 unless $curuser->agentnum($self->$field());
2637 return "Access denied"
2638 unless grep $curuser->access_right($_), @$null_acl;
2646 =item fields [ TABLE ]
2648 This is a wrapper for real_fields. Code that called
2649 fields before should probably continue to call fields.
2654 my $something = shift;
2656 if($something->isa('FS::Record')) {
2657 $table = $something->table;
2659 $table = $something;
2660 $something = "FS::$table";
2662 return (real_fields($table));
2666 =item encrypt($value)
2668 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2670 Returns the encrypted string.
2672 You should generally not have to worry about calling this, as the system handles this for you.
2677 my ($self, $value) = @_;
2680 if ($conf->exists('encryption')) {
2681 if ($self->is_encrypted($value)) {
2682 # Return the original value if it isn't plaintext.
2683 $encrypted = $value;
2686 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2687 # RSA doesn't like the empty string so let's pack it up
2688 # The database doesn't like the RSA data so uuencode it
2689 my $length = length($value)+1;
2690 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2692 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2699 =item is_encrypted($value)
2701 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2707 my ($self, $value) = @_;
2708 # Possible Bug - Some work may be required here....
2710 if ($value =~ /^M/ && length($value) > 80) {
2717 =item decrypt($value)
2719 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2721 You should generally not have to worry about calling this, as the system handles this for you.
2726 my ($self,$value) = @_;
2727 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2728 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2730 if (ref($rsa_decrypt) =~ /::RSA/) {
2731 my $encrypted = unpack ("u*", $value);
2732 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2733 if ($@) {warn "Decryption Failed"};
2741 #Initialize the Module
2742 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2744 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2745 $rsa_module = $conf->config('encryptionmodule');
2749 eval ("require $rsa_module"); # No need to import the namespace
2752 # Initialize Encryption
2753 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2754 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2755 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2758 # Intitalize Decryption
2759 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2760 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2761 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2765 =item h_search ACTION
2767 Given an ACTION, either "insert", or "delete", returns the appropriate history
2768 record corresponding to this record, if any.
2773 my( $self, $action ) = @_;
2775 my $table = $self->table;
2778 my $primary_key = dbdef->table($table)->primary_key;
2781 'table' => "h_$table",
2782 'hashref' => { $primary_key => $self->$primary_key(),
2783 'history_action' => $action,
2791 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2792 appropriate history record corresponding to this record, if any.
2797 my($self, $action) = @_;
2798 my $h = $self->h_search($action);
2799 $h ? $h->history_date : '';
2802 =item scalar_sql SQL [ PLACEHOLDER, ... ]
2804 A class or object method. Executes the sql statement represented by SQL and
2805 returns a scalar representing the result: the first column of the first row.
2807 Dies on bogus SQL. Returns an empty string if no row is returned.
2809 Typically used for statments which return a single value such as "SELECT
2810 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
2815 my($self, $sql) = (shift, shift);
2816 my $sth = dbh->prepare($sql) or die dbh->errstr;
2818 or die "Unexpected error executing statement $sql: ". $sth->errstr;
2819 my $row = $sth->fetchrow_arrayref or return '';
2820 my $scalar = $row->[0];
2821 defined($scalar) ? $scalar : '';
2824 =item count [ WHERE ]
2826 Convenience method for the common case of "SELECT COUNT(*) FROM table",
2827 with optional WHERE. Must be called as method on a class with an
2833 my($self, $where) = (shift, shift);
2834 my $table = $self->table or die 'count called on object of class '.ref($self);
2835 my $sql = "SELECT COUNT(*) FROM $table";
2836 $sql .= " WHERE $where" if $where;
2837 $self->scalar_sql($sql);
2846 =item real_fields [ TABLE ]
2848 Returns a list of the real columns in the specified table. Called only by
2849 fields() and other subroutines elsewhere in FS::Record.
2856 my($table_obj) = dbdef->table($table);
2857 confess "Unknown table $table" unless $table_obj;
2858 $table_obj->columns;
2861 =item pvf FIELD_NAME
2863 Returns the FS::part_virtual_field object corresponding to a field in the
2864 record (specified by FIELD_NAME).
2869 my ($self, $name) = (shift, shift);
2871 if(grep /^$name$/, $self->virtual_fields) {
2873 my $concat = [ "'cf_'", "name" ];
2874 return qsearchs({ table => 'part_virtual_field',
2875 hashref => { dbtable => $self->table,
2878 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
2884 =item _quote VALUE, TABLE, COLUMN
2886 This is an internal function used to construct SQL statements. It returns
2887 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2888 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2893 my($value, $table, $column) = @_;
2894 my $column_obj = dbdef->table($table)->column($column);
2895 my $column_type = $column_obj->type;
2896 my $nullable = $column_obj->null;
2898 warn " $table.$column: $value ($column_type".
2899 ( $nullable ? ' NULL' : ' NOT NULL' ).
2900 ")\n" if $DEBUG > 2;
2902 if ( $value eq '' && $nullable ) {
2904 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2905 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2908 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2909 ! $column_type =~ /(char|binary|text)$/i ) {
2911 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
2912 && driver_name eq 'Pg'
2916 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
2917 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
2918 # single-quote the whole mess, and put an "E" in front.
2919 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
2927 This is deprecated. Don't use it.
2929 It returns a hash-type list with the fields of this record's table set true.
2934 carp "warning: hfields is deprecated";
2937 foreach (fields($table)) {
2946 "$_: ". $self->getfield($_). "|"
2947 } (fields($self->table)) );
2950 sub DESTROY { return; }
2954 # #use Carp qw(cluck);
2955 # #cluck "DESTROYING $self";
2956 # warn "DESTROYING $self";
2960 # return ! eval { join('',@_), kill 0; 1; };
2963 =item str2time_sql [ DRIVER_NAME ]
2965 Returns a function to convert to unix time based on database type, such as
2966 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
2967 the str2time_sql_closing method to return a closing string rather than just
2968 using a closing parenthesis as previously suggested.
2970 You can pass an optional driver name such as "Pg", "mysql" or
2971 $dbh->{Driver}->{Name} to return a function for that database instead of
2972 the current database.
2977 my $driver = shift || driver_name;
2979 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
2980 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
2982 warn "warning: unknown database type $driver; guessing how to convert ".
2983 "dates to UNIX timestamps";
2984 return 'EXTRACT(EPOCH FROM ';
2988 =item str2time_sql_closing [ DRIVER_NAME ]
2990 Returns the closing suffix of a function to convert to unix time based on
2991 database type, such as ")::integer" for Pg or ")" for mysql.
2993 You can pass an optional driver name such as "Pg", "mysql" or
2994 $dbh->{Driver}->{Name} to return a function for that database instead of
2995 the current database.
2999 sub str2time_sql_closing {
3000 my $driver = shift || driver_name;
3002 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3006 =item regexp_sql [ DRIVER_NAME ]
3008 Returns the operator to do a regular expression comparison based on database
3009 type, such as '~' for Pg or 'REGEXP' for mysql.
3011 You can pass an optional driver name such as "Pg", "mysql" or
3012 $dbh->{Driver}->{Name} to return a function for that database instead of
3013 the current database.
3018 my $driver = shift || driver_name;
3020 return '~' if $driver =~ /^Pg/i;
3021 return 'REGEXP' if $driver =~ /^mysql/i;
3023 die "don't know how to use regular expressions in ". driver_name." databases";
3027 =item not_regexp_sql [ DRIVER_NAME ]
3029 Returns the operator to do a regular expression negation based on database
3030 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3032 You can pass an optional driver name such as "Pg", "mysql" or
3033 $dbh->{Driver}->{Name} to return a function for that database instead of
3034 the current database.
3038 sub not_regexp_sql {
3039 my $driver = shift || driver_name;
3041 return '!~' if $driver =~ /^Pg/i;
3042 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3044 die "don't know how to use regular expressions in ". driver_name." databases";
3048 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3050 Returns the items concatenated based on database type, using "CONCAT()" for
3051 mysql and " || " for Pg and other databases.
3053 You can pass an optional driver name such as "Pg", "mysql" or
3054 $dbh->{Driver}->{Name} to return a function for that database instead of
3055 the current database.
3060 my $driver = ref($_[0]) ? driver_name : shift;
3063 if ( $driver =~ /^mysql/i ) {
3064 'CONCAT('. join(',', @$items). ')';
3066 join('||', @$items);
3071 =item midnight_sql DATE
3073 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3074 on that day in the system timezone, using the default driver name.
3079 my $driver = driver_name;
3081 if ( $driver =~ /^mysql/i ) {
3082 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3085 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3093 This module should probably be renamed, since much of the functionality is
3094 of general use. It is not completely unlike Adapter::DBI (see below).
3096 Exported qsearch and qsearchs should be deprecated in favor of method calls
3097 (against an FS::Record object like the old search and searchs that qsearch
3098 and qsearchs were on top of.)
3100 The whole fields / hfields mess should be removed.
3102 The various WHERE clauses should be subroutined.
3104 table string should be deprecated in favor of DBIx::DBSchema::Table.
3106 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3107 true maps to the database (and WHERE clauses) would also help.
3109 The ut_ methods should ask the dbdef for a default length.
3111 ut_sqltype (like ut_varchar) should all be defined
3113 A fallback check method should be provided which uses the dbdef.
3115 The ut_money method assumes money has two decimal digits.
3117 The Pg money kludge in the new method only strips `$'.
3119 The ut_phonen method only checks US-style phone numbers.
3121 The _quote function should probably use ut_float instead of a regex.
3123 All the subroutines probably should be methods, here or elsewhere.
3125 Probably should borrow/use some dbdef methods where appropriate (like sub
3128 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3129 or allow it to be set. Working around it is ugly any way around - DBI should
3130 be fixed. (only affects RDBMS which return uppercase column names)
3132 ut_zip should take an optional country like ut_phone.
3136 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3138 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.