2 use base qw( Exporter );
6 %virtual_fields_cache %fk_method_cache
7 $money_char $lat_lower $lon_upper
9 use Carp qw(carp cluck croak confess);
10 use Scalar::Util qw( blessed );
11 use File::Slurp qw( slurp );
12 use File::CounterFile;
14 use DBI qw(:sql_types);
15 use DBIx::DBSchema 0.43; #0.43 for foreign keys
18 use NetAddr::IP; # for validation
19 use FS::UID qw(dbh datasrc driver_name);
21 use FS::Schema qw(dbdef);
23 use FS::Msgcat qw(gettext);
24 #use FS::Conf; #dependency loop bs, in install_callback below instead
26 use FS::part_virtual_field;
30 our @encrypt_payby = qw( CARD DCRD CHEK DCHK );
32 #export dbdef for now... everything else expects to find it here
34 dbh fields hfields qsearch qsearchs dbdef jsearch
35 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql concat_sql
40 our $me = '[FS::Record]';
42 our $nowarn_identical = 0;
43 our $nowarn_classload = 0;
44 our $no_update_diff = 0;
47 our $no_check_foreign = 1; #well, not inefficiently in perl by default anymore
55 our $conf_encryption = '';
56 FS::UID->install_callback( sub {
60 $conf = FS::Conf->new;
61 $conf_encryption = $conf->exists('encryption');
62 $money_char = $conf->config('money_char') || '$';
63 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
64 $lat_lower = $nw_coords ? 1 : -90;
65 $lon_upper = $nw_coords ? -1 : 180;
67 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
69 if ( driver_name eq 'Pg' ) {
70 eval "use DBD::Pg ':pg_types'";
73 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
76 foreach my $table ( dbdef->tables ) {
77 $fk_method_cache{$table} = fk_methods($table);
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_decimal('column');
128 $error = $record->ut_decimaln('column');
129 $error = $record->ut_snumber('column');
130 $error = $record->ut_snumbern('column');
131 $error = $record->ut_money('column');
132 $error = $record->ut_text('column');
133 $error = $record->ut_textn('column');
134 $error = $record->ut_alpha('column');
135 $error = $record->ut_alphan('column');
136 $error = $record->ut_phonen('column');
137 $error = $record->ut_anything('column');
138 $error = $record->ut_name('column');
140 $quoted_value = _quote($value,'table','field');
143 $fields = hfields('table');
144 if ( $fields->{Field} ) { # etc.
146 @fields = fields 'table'; #as a subroutine
147 @fields = $record->fields; #as a method call
152 (Mostly) object-oriented interface to database records. Records are currently
153 implemented on top of DBI. FS::Record is intended as a base class for
154 table-specific classes to inherit from, i.e. FS::cust_main.
160 =item new [ TABLE, ] HASHREF
162 Creates a new record. It doesn't store it in the database, though. See
163 L<"insert"> for that.
165 Note that the object stores this hash reference, not a distinct copy of the
166 hash it points to. You can ask the object for a copy with the I<hash>
169 TABLE can only be omitted when a dervived class overrides the table method.
175 my $class = ref($proto) || $proto;
177 bless ($self, $class);
179 unless ( defined ( $self->table ) ) {
180 $self->{'Table'} = shift;
181 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
182 unless $nowarn_classload;
185 $self->{'Hash'} = shift;
187 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
188 $self->{'Hash'}{$field}='';
191 $self->_rebless if $self->can('_rebless');
193 $self->{'modified'} = 0;
195 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
202 my $class = ref($proto) || $proto;
204 bless ($self, $class);
206 $self->{'Table'} = shift unless defined ( $self->table );
208 my $hashref = $self->{'Hash'} = shift;
210 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
211 my $obj = $cache->cache->{$hashref->{$cache->key}};
212 $obj->_cache($hashref, $cache) if $obj->can('_cache');
215 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
222 my $class = ref($proto) || $proto;
224 bless ($self, $class);
225 if ( defined $self->table ) {
226 cluck "create constructor is deprecated, use new!";
229 croak "FS::Record::create called (not from a subclass)!";
233 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
235 Searches the database for all records matching (at least) the key/value pairs
236 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
237 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
240 The preferred usage is to pass a hash reference of named parameters:
242 @records = qsearch( {
243 'table' => 'table_name',
244 'hashref' => { 'field' => 'value'
245 'field' => { 'op' => '<',
250 #these are optional...
252 'extra_sql' => 'AND field = ? AND intfield = ?',
253 'extra_param' => [ 'value', [ 5, 'int' ] ],
254 'order_by' => 'ORDER BY something',
255 #'cache_obj' => '', #optional
256 'addl_from' => 'LEFT JOIN othtable USING ( field )',
261 Much code still uses old-style positional parameters, this is also probably
262 fine in the common case where there are only two parameters:
264 my @records = qsearch( 'table', { 'field' => 'value' } );
266 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
267 the individual PARAMS_HASHREF queries
269 ###oops, argh, FS::Record::new only lets us create database fields.
270 #Normal behaviour if SELECT is not specified is `*', as in
271 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
272 #feature where you can specify SELECT - remember, the objects returned,
273 #although blessed into the appropriate `FS::TABLE' package, will only have the
274 #fields you specify. This might have unwanted results if you then go calling
275 #regular FS::TABLE methods
280 my %TYPE = (); #for debugging
283 my($type, $value) = @_;
285 my $bind_type = { TYPE => SQL_VARCHAR };
287 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
289 $bind_type = { TYPE => SQL_INTEGER };
291 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
293 if ( driver_name eq 'Pg' ) {
295 $bind_type = { pg_type => PG_BYTEA };
297 # $bind_type = ? #SQL_VARCHAR could be fine?
300 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
301 #fixed by DBD::Pg 2.11.8
302 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
303 #(make a Tron test first)
304 } elsif ( _is_fs_float( $type, $value ) ) {
306 $bind_type = { TYPE => SQL_DECIMAL };
315 my($type, $value) = @_;
316 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
317 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
325 my( @stable, @record, @cache );
326 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
328 my %union_options = ();
329 if ( ref($_[0]) eq 'ARRAY' ) {
332 foreach my $href ( @$optlist ) {
333 push @stable, ( $href->{'table'} or die "table name is required" );
334 push @record, ( $href->{'hashref'} || {} );
335 push @select, ( $href->{'select'} || '*' );
336 push @extra_sql, ( $href->{'extra_sql'} || '' );
337 push @extra_param, ( $href->{'extra_param'} || [] );
338 push @order_by, ( $href->{'order_by'} || '' );
339 push @cache, ( $href->{'cache_obj'} || '' );
340 push @addl_from, ( $href->{'addl_from'} || '' );
341 push @debug, ( $href->{'debug'} || '' );
343 die "at least one hashref is required" unless scalar(@stable);
344 } elsif ( ref($_[0]) eq 'HASH' ) {
346 $stable[0] = $opt->{'table'} or die "table name is required";
347 $record[0] = $opt->{'hashref'} || {};
348 $select[0] = $opt->{'select'} || '*';
349 $extra_sql[0] = $opt->{'extra_sql'} || '';
350 $extra_param[0] = $opt->{'extra_param'} || [];
351 $order_by[0] = $opt->{'order_by'} || '';
352 $cache[0] = $opt->{'cache_obj'} || '';
353 $addl_from[0] = $opt->{'addl_from'} || '';
354 $debug[0] = $opt->{'debug'} || '';
365 my $cache = $cache[0];
371 foreach my $stable ( @stable ) {
373 carp '->qsearch on cust_main called' if $stable eq 'cust_main' && $DEBUG;
375 #stop altering the caller's hashref
376 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
377 my $select = shift @select;
378 my $extra_sql = shift @extra_sql;
379 my $extra_param = shift @extra_param;
380 my $order_by = shift @order_by;
381 my $cache = shift @cache;
382 my $addl_from = shift @addl_from;
383 my $debug = shift @debug;
385 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
387 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
390 my $table = $cache ? $cache->table : $stable;
391 my $dbdef_table = dbdef->table($table)
392 or die "No schema for table $table found - ".
393 "do you need to run freeside-upgrade?";
394 my $pkey = $dbdef_table->primary_key;
396 my @real_fields = grep exists($record->{$_}), real_fields($table);
398 my $statement .= "SELECT $select FROM $stable";
399 $statement .= " $addl_from" if $addl_from;
400 if ( @real_fields ) {
401 $statement .= ' WHERE '. join(' AND ',
402 get_real_fields($table, $record, \@real_fields));
405 $statement .= " $extra_sql" if defined($extra_sql);
406 $statement .= " $order_by" if defined($order_by);
408 push @statement, $statement;
410 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
414 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
417 my $value = $record->{$field};
418 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
419 $value = $value->{'value'} if ref($value);
420 my $type = dbdef->table($table)->column($field)->type;
422 my $bind_type = _bind_type($type, $value);
426 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
428 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
432 push @bind_type, $bind_type;
436 foreach my $param ( @$extra_param ) {
437 my $bind_type = { TYPE => SQL_VARCHAR };
440 $value = $param->[0];
441 my $type = $param->[1];
442 $bind_type = _bind_type($type, $value);
445 push @bind_type, $bind_type;
449 my $statement = join( ' ) UNION ( ', @statement );
450 $statement = "( $statement )" if scalar(@statement) > 1;
451 $statement .= " $union_options{order_by}" if $union_options{order_by};
453 my $sth = $dbh->prepare($statement)
454 or croak "$dbh->errstr doing $statement";
457 foreach my $value ( @value ) {
458 my $bind_type = shift @bind_type;
459 $sth->bind_param($bind++, $value, $bind_type );
462 # $sth->execute( map $record->{$_},
463 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
464 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
466 my $ok = $sth->execute;
468 my $error = "Error executing \"$statement\"";
469 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
470 $error .= ': '. $sth->errstr;
474 my $table = $stable[0];
476 $table = '' if grep { $_ ne $table } @stable;
477 $pkey = dbdef->table($table)->primary_key if $table;
480 tie %result, "Tie::IxHash";
481 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
482 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
483 %result = map { $_->{$pkey}, $_ } @stuff;
485 @result{@stuff} = @stuff;
491 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
492 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
493 #derivied class didn't override new method, so this optimization is safe
496 new_or_cached( "FS::$table", { %{$_} }, $cache )
500 new( "FS::$table", { %{$_} } )
504 #okay, its been tested
505 # warn "untested code (class FS::$table uses custom new method)";
507 eval 'FS::'. $table. '->new( { %{$_} } )';
511 # Check for encrypted fields and decrypt them.
512 ## only in the local copy, not the cached object
513 if ( $conf_encryption
514 && eval '@FS::'. $table . '::encrypted_fields' ) {
515 foreach my $record (@return) {
516 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
517 next if $field eq 'payinfo'
518 && ($record->isa('FS::payinfo_transaction_Mixin')
519 || $record->isa('FS::payinfo_Mixin') )
521 && !grep { $record->payby eq $_ } @encrypt_payby;
522 # Set it directly... This may cause a problem in the future...
523 $record->setfield($field, $record->decrypt($record->getfield($field)));
528 cluck "warning: FS::$table not loaded; returning FS::Record objects"
529 unless $nowarn_classload;
531 FS::Record->new( $table, { %{$_} } );
539 Construct the SQL statement and parameter-binding list for qsearch. Takes
540 the qsearch parameters.
542 Returns a hash containing:
543 'table': The primary table name (if there is one).
544 'statement': The SQL statement itself.
545 'bind_type': An arrayref of bind types.
546 'value': An arrayref of parameter values.
547 'cache': The cache object, if one was passed.
552 my( @stable, @record, @cache );
553 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
556 my %union_options = ();
557 if ( ref($_[0]) eq 'ARRAY' ) {
560 foreach my $href ( @$optlist ) {
561 push @stable, ( $href->{'table'} or die "table name is required" );
562 push @record, ( $href->{'hashref'} || {} );
563 push @select, ( $href->{'select'} || '*' );
564 push @extra_sql, ( $href->{'extra_sql'} || '' );
565 push @extra_param, ( $href->{'extra_param'} || [] );
566 push @order_by, ( $href->{'order_by'} || '' );
567 push @cache, ( $href->{'cache_obj'} || '' );
568 push @addl_from, ( $href->{'addl_from'} || '' );
569 push @debug, ( $href->{'debug'} || '' );
571 die "at least one hashref is required" unless scalar(@stable);
572 } elsif ( ref($_[0]) eq 'HASH' ) {
574 $stable[0] = $opt->{'table'} or die "table name is required";
575 $record[0] = $opt->{'hashref'} || {};
576 $select[0] = $opt->{'select'} || '*';
577 $extra_sql[0] = $opt->{'extra_sql'} || '';
578 $extra_param[0] = $opt->{'extra_param'} || [];
579 $order_by[0] = $opt->{'order_by'} || '';
580 $cache[0] = $opt->{'cache_obj'} || '';
581 $addl_from[0] = $opt->{'addl_from'} || '';
582 $debug[0] = $opt->{'debug'} || '';
593 my $cache = $cache[0];
599 my $result_table = $stable[0];
600 foreach my $stable ( @stable ) {
601 #stop altering the caller's hashref
602 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
603 my $select = shift @select;
604 my $extra_sql = shift @extra_sql;
605 my $extra_param = shift @extra_param;
606 my $order_by = shift @order_by;
607 my $cache = shift @cache;
608 my $addl_from = shift @addl_from;
609 my $debug = shift @debug;
611 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
613 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
616 $result_table = '' if $result_table ne $stable;
618 my $table = $cache ? $cache->table : $stable;
619 my $dbdef_table = dbdef->table($table)
620 or die "No schema for table $table found - ".
621 "do you need to run freeside-upgrade?";
622 my $pkey = $dbdef_table->primary_key;
624 my @real_fields = grep exists($record->{$_}), real_fields($table);
626 my $statement .= "SELECT $select FROM $stable";
627 $statement .= " $addl_from" if $addl_from;
628 if ( @real_fields ) {
629 $statement .= ' WHERE '. join(' AND ',
630 get_real_fields($table, $record, \@real_fields));
633 $statement .= " $extra_sql" if defined($extra_sql);
634 $statement .= " $order_by" if defined($order_by);
636 push @statement, $statement;
638 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
642 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
645 my $value = $record->{$field};
646 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
647 $value = $value->{'value'} if ref($value);
648 my $type = dbdef->table($table)->column($field)->type;
650 my $bind_type = _bind_type($type, $value);
654 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
656 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
660 push @bind_type, $bind_type;
664 foreach my $param ( @$extra_param ) {
665 my $bind_type = { TYPE => SQL_VARCHAR };
668 $value = $param->[0];
669 my $type = $param->[1];
670 $bind_type = _bind_type($type, $value);
673 push @bind_type, $bind_type;
677 my $statement = join( ' ) UNION ( ', @statement );
678 $statement = "( $statement )" if scalar(@statement) > 1;
679 $statement .= " $union_options{order_by}" if $union_options{order_by};
682 statement => $statement,
683 bind_type => \@bind_type,
685 table => $result_table,
690 # qsearch should eventually use this
692 my ($table, $cache, @hashrefs) = @_;
694 # XXX get rid of these string evals at some point
695 # (when we have time to test it)
696 # my $class = "FS::$table" if $table;
697 # if ( $class and $class->isa('FS::Record') )
698 # if ( $class->can('new') eq \&new )
700 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
701 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
702 #derivied class didn't override new method, so this optimization is safe
705 new_or_cached( "FS::$table", { %{$_} }, $cache )
709 new( "FS::$table", { %{$_} } )
713 #okay, its been tested
714 # warn "untested code (class FS::$table uses custom new method)";
716 eval 'FS::'. $table. '->new( { %{$_} } )';
720 # Check for encrypted fields and decrypt them.
721 ## only in the local copy, not the cached object
722 if ( $conf_encryption
723 && eval '@FS::'. $table . '::encrypted_fields' ) {
724 foreach my $record (@return) {
725 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
726 next if $field eq 'payinfo'
727 && ($record->isa('FS::payinfo_transaction_Mixin')
728 || $record->isa('FS::payinfo_Mixin') )
730 && !grep { $record->payby eq $_ } @encrypt_payby;
731 # Set it directly... This may cause a problem in the future...
732 $record->setfield($field, $record->decrypt($record->getfield($field)));
737 cluck "warning: FS::$table not loaded; returning FS::Record objects"
738 unless $nowarn_classload;
740 FS::Record->new( $table, { %{$_} } );
746 ## makes this easier to read
748 sub get_real_fields {
751 my $real_fields = shift;
753 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
759 my $type = dbdef->table($table)->column($column)->type;
760 my $value = $record->{$column};
761 $value = $value->{'value'} if ref($value);
762 if ( ref($record->{$_}) ) {
763 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
764 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
765 if ( uc($op) eq 'ILIKE' ) {
767 $record->{$_}{'value'} = lc($record->{$_}{'value'});
768 $column = "LOWER($_)";
770 $record->{$_} = $record->{$_}{'value'}
773 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
775 if ( driver_name eq 'Pg' ) {
776 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
777 qq-( $column IS NULL )-;
779 qq-( $column IS NULL OR $column = '' )-;
782 qq-( $column IS NULL OR $column = "" )-;
784 } elsif ( $op eq '!=' ) {
785 if ( driver_name eq 'Pg' ) {
786 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
787 qq-( $column IS NOT NULL )-;
789 qq-( $column IS NOT NULL AND $column != '' )-;
792 qq-( $column IS NOT NULL AND $column != "" )-;
795 if ( driver_name eq 'Pg' ) {
796 qq-( $column $op '' )-;
798 qq-( $column $op "" )-;
801 } elsif ( $op eq '!=' ) {
802 qq-( $column IS NULL OR $column != ? )-;
803 #if this needs to be re-enabled, it needs to use a custom op like
804 #"APPROX=" or something (better name?, not '=', to avoid affecting other
806 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
807 # ( "$column <= ?", "$column >= ?" );
811 } @{ $real_fields } );
814 =item by_key PRIMARY_KEY_VALUE
816 This is a class method that returns the record with the given primary key
817 value. This method is only useful in FS::Record subclasses. For example:
819 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
823 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
828 my ($class, $pkey_value) = @_;
830 my $table = $class->table
831 or croak "No table for $class found";
833 my $dbdef_table = dbdef->table($table)
834 or die "No schema for table $table found - ".
835 "do you need to create it or run dbdef-create?";
836 my $pkey = $dbdef_table->primary_key
837 or die "No primary key for table $table";
839 return qsearchs($table, { $pkey => $pkey_value });
842 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
844 Experimental JOINed search method. Using this method, you can execute a
845 single SELECT spanning multiple tables, and cache the results for subsequent
846 method calls. Interface will almost definately change in an incompatible
854 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
855 my $cache = FS::SearchCache->new( $ptable, $pkey );
858 grep { !$saw{$_->getfield($pkey)}++ }
859 qsearch($table, $record, $select, $extra_sql, $cache )
863 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
865 Same as qsearch, except that if more than one record matches, it B<carp>s but
866 returns the first. If this happens, you either made a logic error in asking
867 for a single item, or your data is corrupted.
871 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
873 my(@result) = qsearch(@_);
874 cluck "warning: Multiple records in scalar search ($table)"
875 if scalar(@result) > 1;
876 #should warn more vehemently if the search was on a primary key?
877 scalar(@result) ? ($result[0]) : ();
888 Returns the table name.
893 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
900 Returns the DBIx::DBSchema::Table object for the table.
906 my($table)=$self->table;
907 dbdef->table($table);
912 Returns the primary key for the table.
918 my $pkey = $self->dbdef_table->primary_key;
921 =item get, getfield COLUMN
923 Returns the value of the column/field/key COLUMN.
928 my($self,$field) = @_;
929 # to avoid "Use of unitialized value" errors
930 if ( defined ( $self->{Hash}->{$field} ) ) {
931 $self->{Hash}->{$field};
941 =item set, setfield COLUMN, VALUE
943 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
948 my($self,$field,$value) = @_;
949 $self->{'modified'} = 1;
950 $self->{'Hash'}->{$field} = $value;
959 Returns true if the column/field/key COLUMN exists.
964 my($self,$field) = @_;
965 exists($self->{Hash}->{$field});
968 =item AUTLOADED METHODS
970 $record->column is a synonym for $record->get('column');
972 $record->column('value') is a synonym for $record->set('column','value');
974 $record->foreign_table_name calls qsearchs and returns a single
975 FS::foreign_table record (for tables referenced by a column of this table) or
976 qsearch and returns an array of FS::foreign_table records (for tables
977 referenced by a column in the foreign table).
984 my($field)=$AUTOLOAD;
987 confess "errant AUTOLOAD $field for $self (arg $value)"
988 unless blessed($self) && $self->can('setfield');
990 #$fk_method_cache{$self->table} ||= fk_methods($self->table);
991 if ( exists($fk_method_cache{$self->table}->{$field}) ) {
993 my $fk_info = $fk_method_cache{$self->table}->{$field};
994 my $method = $fk_info->{method} || 'qsearchs';
995 my $table = $fk_info->{table} || $field;
996 my $column = $fk_info->{column};
997 my $foreign_column = $fk_info->{references} || $column;
999 eval "use FS::$table";
1002 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1004 my $pkey_value = $self->$column();
1005 my %search = ( $foreign_column => $pkey_value );
1007 # FS::Record->$method() ? they're actually just subs :/
1008 if ( $method eq 'qsearchs' ) {
1009 return $pkey_value ? qsearchs( $table, \%search ) : '';
1010 } elsif ( $method eq 'qsearch' ) {
1011 return $pkey_value ? qsearch( $table, \%search ) : ();
1013 die "unknown method $method";
1018 if ( defined($value) ) {
1019 $self->setfield($field,$value);
1021 $self->getfield($field);
1025 # efficient (also, old, doesn't support FK stuff)
1027 # my $field = $AUTOLOAD;
1028 # $field =~ s/.*://;
1029 # if ( defined($_[1]) ) {
1030 # $_[0]->setfield($field, $_[1]);
1032 # $_[0]->getfield($field);
1041 # foreign keys we reference in other tables
1042 foreach my $fk (dbdef->table($table)->foreign_keys) {
1045 if ( scalar( @{$fk->columns} ) == 1 ) {
1046 if ( ! @{$fk->references} || $fk->columns->[0] eq $fk->references->[0] ){
1047 $method = $fk->table;
1049 #some sort of hint in the table.pm or schema for methods not named
1050 # after their foreign table (well, not a whole lot different than
1051 # just providing a small subroutine...)
1055 $hash{$method} = { #fk_info
1056 'method' => 'qsearchs',
1057 'column' => $fk->columns->[0],
1058 #'references' => $fk->references->[0],
1066 # foreign keys referenced in other tables to us
1067 # (alas. why we're cached. still, might this loop better be done once at
1068 # schema load time insetad of every time we AUTOLOAD a method on a new
1070 foreach my $f_table ( dbdef->tables ) {
1071 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1073 next unless $fk->table eq $table;
1076 if ( scalar( @{$fk->columns} ) == 1 ) {
1077 if ( ! @{$fk->references} || $fk->columns->[0] eq $fk->references->[0] ){
1080 #some sort of hint in the table.pm or schema for methods not named
1081 # after their foreign table (well, not a whole lot different than
1082 # just providing a small subroutine...)
1086 $hash{$method} = { #fk_info
1087 'method' => 'qsearch',
1088 'column' => $fk->columns->[0], #references||column
1089 #'references' => $fk->column->[0],
1104 Returns a list of the column/value pairs, usually for assigning to a new hash.
1106 To make a distinct duplicate of an FS::Record object, you can do:
1108 $new = new FS::Record ( $old->table, { $old->hash } );
1114 confess $self. ' -> hash: Hash attribute is undefined'
1115 unless defined($self->{'Hash'});
1116 %{ $self->{'Hash'} };
1121 Returns a reference to the column/value hash. This may be deprecated in the
1122 future; if there's a reason you can't just use the autoloaded or get/set
1136 +{ ( map { $_=>$self->$_ } $self->fields ),
1141 my( $class, %opt ) = @_;
1142 my $table = $class->table;
1143 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1144 my $error = $self->insert;
1145 return +{ 'error' => $error } if $error;
1146 my $pkey = $self->pkey;
1147 return +{ 'error' => '',
1148 'primary_key' => $pkey,
1149 $pkey => $self->$pkey,
1155 Returns true if any of this object's values have been modified with set (or via
1156 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1163 $self->{'modified'};
1166 =item select_for_update
1168 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1173 sub select_for_update {
1175 my $primary_key = $self->primary_key;
1178 'table' => $self->table,
1179 'hashref' => { $primary_key => $self->$primary_key() },
1180 'extra_sql' => 'FOR UPDATE',
1186 Locks this table with a database-driver specific lock method. This is used
1187 as a mutex in order to do a duplicate search.
1189 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1191 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1193 Errors are fatal; no useful return value.
1195 Note: To use this method for new tables other than svc_acct and svc_phone,
1196 edit freeside-upgrade and add those tables to the duplicate_lock list.
1202 my $table = $self->table;
1204 warn "$me locking $table table\n" if $DEBUG;
1206 if ( driver_name =~ /^Pg/i ) {
1208 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1211 } elsif ( driver_name =~ /^mysql/i ) {
1213 dbh->do("SELECT * FROM duplicate_lock
1214 WHERE lockname = '$table'
1216 ) or die dbh->errstr;
1220 die "unknown database ". driver_name. "; don't know how to lock table";
1224 warn "$me acquired $table table lock\n" if $DEBUG;
1230 Inserts this record to the database. If there is an error, returns the error,
1231 otherwise returns false.
1239 warn "$self -> insert" if $DEBUG;
1241 my $error = $self->check;
1242 return $error if $error;
1244 #single-field non-null unique keys are given a value if empty
1245 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1246 foreach ( $self->dbdef_table->unique_singles) {
1247 next if $self->getfield($_);
1248 next if $self->dbdef_table->column($_)->null eq 'NULL';
1252 #and also the primary key, if the database isn't going to
1253 my $primary_key = $self->dbdef_table->primary_key;
1255 if ( $primary_key ) {
1256 my $col = $self->dbdef_table->column($primary_key);
1259 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1260 || ( driver_name eq 'Pg'
1261 && defined($col->default)
1262 && $col->quoted_default =~ /^nextval\(/i
1264 || ( driver_name eq 'mysql'
1265 && defined($col->local)
1266 && $col->local =~ /AUTO_INCREMENT/i
1268 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1271 my $table = $self->table;
1273 # Encrypt before the database
1274 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
1275 && scalar( eval '@FS::'. $table . '::encrypted_fields')
1276 && $conf->exists('encryption')
1278 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1279 next if $field eq 'payinfo'
1280 && ($self->isa('FS::payinfo_transaction_Mixin')
1281 || $self->isa('FS::payinfo_Mixin') )
1283 && !grep { $self->payby eq $_ } @encrypt_payby;
1284 $saved->{$field} = $self->getfield($field);
1285 $self->setfield($field, $self->encrypt($self->getfield($field)));
1289 #false laziness w/delete
1291 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1294 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1297 my $statement = "INSERT INTO $table ";
1298 if ( @real_fields ) {
1301 join( ', ', @real_fields ).
1303 join( ', ', @values ).
1307 $statement .= 'DEFAULT VALUES';
1309 warn "[debug]$me $statement\n" if $DEBUG > 1;
1310 my $sth = dbh->prepare($statement) or return dbh->errstr;
1312 local $SIG{HUP} = 'IGNORE';
1313 local $SIG{INT} = 'IGNORE';
1314 local $SIG{QUIT} = 'IGNORE';
1315 local $SIG{TERM} = 'IGNORE';
1316 local $SIG{TSTP} = 'IGNORE';
1317 local $SIG{PIPE} = 'IGNORE';
1319 $sth->execute or return $sth->errstr;
1321 # get inserted id from the database, if applicable & needed
1322 if ( $db_seq && ! $self->getfield($primary_key) ) {
1323 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1327 if ( driver_name eq 'Pg' ) {
1329 #my $oid = $sth->{'pg_oid_status'};
1330 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1332 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1333 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1334 dbh->rollback if $FS::UID::AutoCommit;
1335 return "can't parse $table.$primary_key default value".
1336 " for sequence name: $default";
1340 my $i_sql = "SELECT currval('$sequence')";
1341 my $i_sth = dbh->prepare($i_sql) or do {
1342 dbh->rollback if $FS::UID::AutoCommit;
1345 $i_sth->execute() or do { #$i_sth->execute($oid)
1346 dbh->rollback if $FS::UID::AutoCommit;
1347 return $i_sth->errstr;
1349 $insertid = $i_sth->fetchrow_arrayref->[0];
1351 } elsif ( driver_name eq 'mysql' ) {
1353 $insertid = dbh->{'mysql_insertid'};
1354 # work around mysql_insertid being null some of the time, ala RT :/
1355 unless ( $insertid ) {
1356 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1357 "using SELECT LAST_INSERT_ID();";
1358 my $i_sql = "SELECT LAST_INSERT_ID()";
1359 my $i_sth = dbh->prepare($i_sql) or do {
1360 dbh->rollback if $FS::UID::AutoCommit;
1363 $i_sth->execute or do {
1364 dbh->rollback if $FS::UID::AutoCommit;
1365 return $i_sth->errstr;
1367 $insertid = $i_sth->fetchrow_arrayref->[0];
1372 dbh->rollback if $FS::UID::AutoCommit;
1373 return "don't know how to retreive inserted ids from ". driver_name.
1374 ", try using counterfiles (maybe run dbdef-create?)";
1378 $self->setfield($primary_key, $insertid);
1383 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1384 my $h_statement = $self->_h_statement('insert');
1385 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1386 $h_sth = dbh->prepare($h_statement) or do {
1387 dbh->rollback if $FS::UID::AutoCommit;
1393 $h_sth->execute or return $h_sth->errstr if $h_sth;
1395 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1397 # Now that it has been saved, reset the encrypted fields so that $new
1398 # can still be used.
1399 foreach my $field (keys %{$saved}) {
1400 $self->setfield($field, $saved->{$field});
1408 Depriciated (use insert instead).
1413 cluck "warning: FS::Record::add deprecated!";
1414 insert @_; #call method in this scope
1419 Delete this record from the database. If there is an error, returns the error,
1420 otherwise returns false.
1427 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1429 $self->getfield($_) eq ''
1430 #? "( $_ IS NULL OR $_ = \"\" )"
1431 ? ( driver_name eq 'Pg'
1433 : "( $_ IS NULL OR $_ = \"\" )"
1435 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1436 } ( $self->dbdef_table->primary_key )
1437 ? ( $self->dbdef_table->primary_key)
1438 : real_fields($self->table)
1440 warn "[debug]$me $statement\n" if $DEBUG > 1;
1441 my $sth = dbh->prepare($statement) or return dbh->errstr;
1444 if ( defined dbdef->table('h_'. $self->table) ) {
1445 my $h_statement = $self->_h_statement('delete');
1446 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1447 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1452 my $primary_key = $self->dbdef_table->primary_key;
1454 local $SIG{HUP} = 'IGNORE';
1455 local $SIG{INT} = 'IGNORE';
1456 local $SIG{QUIT} = 'IGNORE';
1457 local $SIG{TERM} = 'IGNORE';
1458 local $SIG{TSTP} = 'IGNORE';
1459 local $SIG{PIPE} = 'IGNORE';
1461 my $rc = $sth->execute or return $sth->errstr;
1462 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1463 $h_sth->execute or return $h_sth->errstr if $h_sth;
1465 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1467 #no need to needlessly destoy the data either (causes problems actually)
1468 #undef $self; #no need to keep object!
1475 Depriciated (use delete instead).
1480 cluck "warning: FS::Record::del deprecated!";
1481 &delete(@_); #call method in this scope
1484 =item replace OLD_RECORD
1486 Replace the OLD_RECORD with this one in the database. If there is an error,
1487 returns the error, otherwise returns false.
1492 my ($new, $old) = (shift, shift);
1494 $old = $new->replace_old unless defined($old);
1496 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1498 if ( $new->can('replace_check') ) {
1499 my $error = $new->replace_check($old);
1500 return $error if $error;
1503 return "Records not in same table!" unless $new->table eq $old->table;
1505 my $primary_key = $old->dbdef_table->primary_key;
1506 return "Can't change primary key $primary_key ".
1507 'from '. $old->getfield($primary_key).
1508 ' to ' . $new->getfield($primary_key)
1510 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1512 my $error = $new->check;
1513 return $error if $error;
1515 # Encrypt for replace
1517 if ( $conf->exists('encryption')
1518 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1519 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1521 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1522 next if $field eq 'payinfo'
1523 && ($new->isa('FS::payinfo_transaction_Mixin')
1524 || $new->isa('FS::payinfo_Mixin') )
1526 && !grep { $new->payby eq $_ } @encrypt_payby;
1527 $saved->{$field} = $new->getfield($field);
1528 $new->setfield($field, $new->encrypt($new->getfield($field)));
1532 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1533 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1534 ? ($_, $new->getfield($_)) : () } $old->fields;
1536 unless (keys(%diff) || $no_update_diff ) {
1537 carp "[warning]$me ". ref($new)."->replace ".
1538 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1539 ": records identical"
1540 unless $nowarn_identical;
1544 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1546 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1547 } real_fields($old->table)
1552 if ( $old->getfield($_) eq '' ) {
1554 #false laziness w/qsearch
1555 if ( driver_name eq 'Pg' ) {
1556 my $type = $old->dbdef_table->column($_)->type;
1557 if ( $type =~ /(int|(big)?serial)/i ) {
1560 qq-( $_ IS NULL OR $_ = '' )-;
1563 qq-( $_ IS NULL OR $_ = "" )-;
1567 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1570 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1573 warn "[debug]$me $statement\n" if $DEBUG > 1;
1574 my $sth = dbh->prepare($statement) or return dbh->errstr;
1577 if ( defined dbdef->table('h_'. $old->table) ) {
1578 my $h_old_statement = $old->_h_statement('replace_old');
1579 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1580 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1586 if ( defined dbdef->table('h_'. $new->table) ) {
1587 my $h_new_statement = $new->_h_statement('replace_new');
1588 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1589 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1594 local $SIG{HUP} = 'IGNORE';
1595 local $SIG{INT} = 'IGNORE';
1596 local $SIG{QUIT} = 'IGNORE';
1597 local $SIG{TERM} = 'IGNORE';
1598 local $SIG{TSTP} = 'IGNORE';
1599 local $SIG{PIPE} = 'IGNORE';
1601 my $rc = $sth->execute or return $sth->errstr;
1602 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1603 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1604 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1606 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1608 # Now that it has been saved, reset the encrypted fields so that $new
1609 # can still be used.
1610 foreach my $field (keys %{$saved}) {
1611 $new->setfield($field, $saved->{$field});
1619 my( $self ) = shift;
1620 warn "[$me] replace called with no arguments; autoloading old record\n"
1623 my $primary_key = $self->dbdef_table->primary_key;
1624 if ( $primary_key ) {
1625 $self->by_key( $self->$primary_key() ) #this is what's returned
1626 or croak "can't find ". $self->table. ".$primary_key ".
1627 $self->$primary_key();
1629 croak $self->table. " has no primary key; pass old record as argument";
1636 Depriciated (use replace instead).
1641 cluck "warning: FS::Record::rep deprecated!";
1642 replace @_; #call method in this scope
1647 Checks custom fields. Subclasses should still provide a check method to validate
1648 non-custom fields, etc., and call this method via $self->SUPER::check.
1654 foreach my $field ($self->virtual_fields) {
1655 my $error = $self->ut_textn($field);
1656 return $error if $error;
1661 =item virtual_fields [ TABLE ]
1663 Returns a list of virtual fields defined for the table. This should not
1664 be exported, and should only be called as an instance or class method.
1668 sub virtual_fields {
1671 $table = $self->table or confess "virtual_fields called on non-table";
1673 confess "Unknown table $table" unless dbdef->table($table);
1675 return () unless dbdef->table('part_virtual_field');
1677 unless ( $virtual_fields_cache{$table} ) {
1678 my $concat = [ "'cf_'", "name" ];
1679 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1680 "WHERE dbtable = '$table'";
1682 my $result = $dbh->selectcol_arrayref($query);
1683 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1685 $virtual_fields_cache{$table} = $result;
1688 @{$virtual_fields_cache{$table}};
1692 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1694 Processes a batch import as a queued JSRPC job
1696 JOB is an FS::queue entry.
1698 OPTIONS_HASHREF can have the following keys:
1704 Table name (required).
1708 Listref of field names for static fields. They will be given values from the
1709 PARAMS hashref and passed as a "params" hashref to batch_import.
1713 Formats hashref. Keys are field names, values are listrefs that define the
1716 Each listref value can be a column name or a code reference. Coderefs are run
1717 with the row object, data and a FS::Conf object as the three parameters.
1718 For example, this coderef does the same thing as using the "columnname" string:
1721 my( $record, $data, $conf ) = @_;
1722 $record->columnname( $data );
1725 Coderefs are run after all "column name" fields are assigned.
1729 Optional format hashref of types. Keys are field names, values are "csv",
1730 "xls" or "fixedlength". Overrides automatic determination of file type
1733 =item format_headers
1735 Optional format hashref of header lines. Keys are field names, values are 0
1736 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1739 =item format_sep_chars
1741 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1742 CSV separation character.
1744 =item format_fixedlenth_formats
1746 Optional format hashref of fixed length format defintiions. Keys are field
1747 names, values Parse::FixedLength listrefs of field definitions.
1751 Set true to default to CSV file type if the filename does not contain a
1752 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1757 PARAMS is a base64-encoded Storable string containing the POSTed data as
1758 a hash ref. It normally contains at least one field, "uploaded files",
1759 generated by /elements/file-upload.html and containing the list of uploaded
1760 files. Currently only supports a single file named "file".
1764 use Storable qw(thaw);
1767 sub process_batch_import {
1768 my($job, $opt) = ( shift, shift );
1770 my $table = $opt->{table};
1771 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1772 my %formats = %{ $opt->{formats} };
1774 my $param = thaw(decode_base64(shift));
1775 warn Dumper($param) if $DEBUG;
1777 my $files = $param->{'uploaded_files'}
1778 or die "No files provided.\n";
1780 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1782 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1783 my $file = $dir. $files{'file'};
1788 formats => \%formats,
1789 format_types => $opt->{format_types},
1790 format_headers => $opt->{format_headers},
1791 format_sep_chars => $opt->{format_sep_chars},
1792 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1793 format_xml_formats => $opt->{format_xml_formats},
1794 format_asn_formats => $opt->{format_asn_formats},
1795 format_row_callbacks => $opt->{format_row_callbacks},
1800 format => $param->{format},
1801 params => { map { $_ => $param->{$_} } @pass_params },
1803 default_csv => $opt->{default_csv},
1804 postinsert_callback => $opt->{postinsert_callback},
1807 if ( $opt->{'batch_namecol'} ) {
1808 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1809 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1812 my $error = FS::Record::batch_import( \%iopt );
1816 die "$error\n" if $error;
1819 =item batch_import PARAM_HASHREF
1821 Class method for batch imports. Available params:
1827 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1833 =item format_headers
1835 =item format_sep_chars
1837 =item format_fixedlength_formats
1839 =item format_row_callbacks
1841 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1843 =item preinsert_callback
1845 =item postinsert_callback
1851 FS::queue object, will be updated with progress
1857 csv, xls, fixedlength, xml
1869 warn "$me batch_import call with params: \n". Dumper($param)
1872 my $table = $param->{table};
1874 my $job = $param->{job};
1875 my $file = $param->{file};
1876 my $params = $param->{params} || {};
1878 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1879 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1881 my( $type, $header, $sep_char,
1882 $fixedlength_format, $xml_format, $asn_format,
1883 $parser_opt, $row_callback, @fields );
1885 my $postinsert_callback = '';
1886 $postinsert_callback = $param->{'postinsert_callback'}
1887 if $param->{'postinsert_callback'};
1888 my $preinsert_callback = '';
1889 $preinsert_callback = $param->{'preinsert_callback'}
1890 if $param->{'preinsert_callback'};
1892 if ( $param->{'format'} ) {
1894 my $format = $param->{'format'};
1895 my $formats = $param->{formats};
1896 die "unknown format $format" unless exists $formats->{ $format };
1898 $type = $param->{'format_types'}
1899 ? $param->{'format_types'}{ $format }
1900 : $param->{type} || 'csv';
1903 $header = $param->{'format_headers'}
1904 ? $param->{'format_headers'}{ $param->{'format'} }
1907 $sep_char = $param->{'format_sep_chars'}
1908 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1911 $fixedlength_format =
1912 $param->{'format_fixedlength_formats'}
1913 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1917 $param->{'format_parser_opts'}
1918 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1922 $param->{'format_xml_formats'}
1923 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1927 $param->{'format_asn_formats'}
1928 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1932 $param->{'format_row_callbacks'}
1933 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1936 @fields = @{ $formats->{ $format } };
1938 } elsif ( $param->{'fields'} ) {
1940 $type = ''; #infer from filename
1943 $fixedlength_format = '';
1945 @fields = @{ $param->{'fields'} };
1948 die "neither format nor fields specified";
1951 #my $file = $param->{file};
1954 if ( $file =~ /\.(\w+)$/i ) {
1958 warn "can't parse file type from filename $file; defaulting to CSV";
1962 if $param->{'default_csv'} && $type ne 'xls';
1970 my $asn_header_buffer;
1971 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1973 if ( $type eq 'csv' ) {
1975 $parser_opt->{'binary'} = 1;
1976 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
1977 $parser = Text::CSV_XS->new($parser_opt);
1979 } elsif ( $type eq 'fixedlength' ) {
1981 eval "use Parse::FixedLength;";
1983 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
1986 die "Unknown file type $type\n";
1989 @buffer = split(/\r?\n/, slurp($file) );
1990 splice(@buffer, 0, ($header || 0) );
1991 $count = scalar(@buffer);
1993 } elsif ( $type eq 'xls' ) {
1995 eval "use Spreadsheet::ParseExcel;";
1998 eval "use DateTime::Format::Excel;";
1999 #for now, just let the error be thrown if it is used, since only CDR
2000 # formats bill_west and troop use it, not other excel-parsing things
2003 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2005 $parser = $excel->{Worksheet}[0]; #first sheet
2007 $count = $parser->{MaxRow} || $parser->{MinRow};
2010 $row = $header || 0;
2012 } elsif ( $type eq 'xml' ) {
2015 eval "use XML::Simple;";
2017 my $xmlrow = $xml_format->{'xmlrow'};
2018 $parser = $xml_format->{'xmlkeys'};
2019 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2020 my $data = XML::Simple::XMLin(
2022 'SuppressEmpty' => '', #sets empty values to ''
2026 $rows = $rows->{$_} foreach @$xmlrow;
2027 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2028 $count = @buffer = @$rows;
2030 } elsif ( $type eq 'asn.1' ) {
2032 eval "use Convert::ASN1";
2035 my $asn = Convert::ASN1->new;
2036 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2038 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2040 my $data = slurp($file);
2041 my $asn_output = $parser->decode( $data )
2042 or return "No ". $asn_format->{'macro'}. " found\n";
2044 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2046 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2047 $count = @buffer = @$rows;
2050 die "Unknown file type $type\n";
2055 local $SIG{HUP} = 'IGNORE';
2056 local $SIG{INT} = 'IGNORE';
2057 local $SIG{QUIT} = 'IGNORE';
2058 local $SIG{TERM} = 'IGNORE';
2059 local $SIG{TSTP} = 'IGNORE';
2060 local $SIG{PIPE} = 'IGNORE';
2062 my $oldAutoCommit = $FS::UID::AutoCommit;
2063 local $FS::UID::AutoCommit = 0;
2066 #my $params = $param->{params} || {};
2067 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2068 my $batch_col = $param->{'batch_keycol'};
2070 my $batch_class = 'FS::'. $param->{'batch_table'};
2071 my $batch = $batch_class->new({
2072 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2074 my $error = $batch->insert;
2076 $dbh->rollback if $oldAutoCommit;
2077 return "can't insert batch record: $error";
2079 #primary key via dbdef? (so the column names don't have to match)
2080 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2082 $params->{ $batch_col } = $batch_value;
2085 #my $job = $param->{job};
2088 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2092 my %hash = %$params;
2093 if ( $type eq 'csv' ) {
2095 last unless scalar(@buffer);
2096 $line = shift(@buffer);
2098 next if $line =~ /^\s*$/; #skip empty lines
2100 $line = &{$row_callback}($line) if $row_callback;
2102 next if $line =~ /^\s*$/; #skip empty lines
2104 $parser->parse($line) or do {
2105 $dbh->rollback if $oldAutoCommit;
2106 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2108 @columns = $parser->fields();
2110 } elsif ( $type eq 'fixedlength' ) {
2112 last unless scalar(@buffer);
2113 $line = shift(@buffer);
2115 @columns = $parser->parse($line);
2117 } elsif ( $type eq 'xls' ) {
2119 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2120 || ! $parser->{Cells}[$row];
2122 my @row = @{ $parser->{Cells}[$row] };
2123 @columns = map $_->{Val}, @row;
2126 #warn $z++. ": $_\n" for @columns;
2128 } elsif ( $type eq 'xml' ) {
2130 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2131 last unless scalar(@buffer);
2132 my $row = shift @buffer;
2133 @columns = @{ $row }{ @$parser };
2135 } elsif ( $type eq 'asn.1' ) {
2137 last unless scalar(@buffer);
2138 my $row = shift @buffer;
2139 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2140 if $asn_format->{row_callback};
2141 foreach my $key ( keys %{ $asn_format->{map} } ) {
2142 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2146 die "Unknown file type $type\n";
2151 foreach my $field ( @fields ) {
2153 my $value = shift @columns;
2155 if ( ref($field) eq 'CODE' ) {
2156 #&{$field}(\%hash, $value);
2157 push @later, $field, $value;
2159 #??? $hash{$field} = $value if length($value);
2160 $hash{$field} = $value if defined($value) && length($value);
2165 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2166 && length($1) == $custnum_length ) {
2167 $hash{custnum} = $2;
2170 #my $table = $param->{table};
2171 my $class = "FS::$table";
2173 my $record = $class->new( \%hash );
2176 while ( scalar(@later) ) {
2177 my $sub = shift @later;
2178 my $data = shift @later;
2180 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2183 $dbh->rollback if $oldAutoCommit;
2184 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2186 last if exists( $param->{skiprow} );
2188 next if exists( $param->{skiprow} );
2190 if ( $preinsert_callback ) {
2191 my $error = &{$preinsert_callback}($record, $param);
2193 $dbh->rollback if $oldAutoCommit;
2194 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2197 next if exists $param->{skiprow} && $param->{skiprow};
2200 my $error = $record->insert;
2203 $dbh->rollback if $oldAutoCommit;
2204 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2210 if ( $postinsert_callback ) {
2211 my $error = &{$postinsert_callback}($record, $param);
2213 $dbh->rollback if $oldAutoCommit;
2214 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2219 if ( $job && time - $min_sec > $last ) { #progress bar
2220 $job->update_statustext( int(100 * $imported / $count) );
2226 unless ( $imported || $param->{empty_ok} ) {
2227 $dbh->rollback if $oldAutoCommit;
2228 return "Empty file!";
2231 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2238 my( $self, $action, $time ) = @_;
2242 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2245 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2246 real_fields($self->table);
2249 # If we're encrypting then don't store the payinfo in the history
2250 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
2251 @fields = grep { $_ ne 'payinfo' } @fields;
2254 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2256 "INSERT INTO h_". $self->table. " ( ".
2257 join(', ', qw(history_date history_usernum history_action), @fields ).
2260 $FS::CurrentUser::CurrentUser->usernum,
2261 dbh->quote($action),
2270 B<Warning>: External use is B<deprecated>.
2272 Replaces COLUMN in record with a unique number, using counters in the
2273 filesystem. Used by the B<insert> method on single-field unique columns
2274 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2275 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2277 Returns the new value.
2282 my($self,$field) = @_;
2283 my($table)=$self->table;
2285 croak "Unique called on field $field, but it is ",
2286 $self->getfield($field),
2288 if $self->getfield($field);
2290 #warn "table $table is tainted" if is_tainted($table);
2291 #warn "field $field is tainted" if is_tainted($field);
2293 my($counter) = new File::CounterFile "$table.$field",0;
2295 my $index = $counter->inc;
2296 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2298 $index =~ /^(\d*)$/;
2301 $self->setfield($field,$index);
2305 =item ut_float COLUMN
2307 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2308 null. If there is an error, returns the error, otherwise returns false.
2313 my($self,$field)=@_ ;
2314 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2315 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2316 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2317 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2318 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2319 $self->setfield($field,$1);
2322 =item ut_floatn COLUMN
2324 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2325 null. If there is an error, returns the error, otherwise returns false.
2329 #false laziness w/ut_ipn
2331 my( $self, $field ) = @_;
2332 if ( $self->getfield($field) =~ /^()$/ ) {
2333 $self->setfield($field,'');
2336 $self->ut_float($field);
2340 =item ut_sfloat COLUMN
2342 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2343 May not be null. If there is an error, returns the error, otherwise returns
2349 my($self,$field)=@_ ;
2350 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2351 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2352 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2353 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2354 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2355 $self->setfield($field,$1);
2358 =item ut_sfloatn COLUMN
2360 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2361 null. If there is an error, returns the error, otherwise returns false.
2366 my( $self, $field ) = @_;
2367 if ( $self->getfield($field) =~ /^()$/ ) {
2368 $self->setfield($field,'');
2371 $self->ut_sfloat($field);
2375 =item ut_snumber COLUMN
2377 Check/untaint signed numeric data (whole numbers). If there is an error,
2378 returns the error, otherwise returns false.
2383 my($self, $field) = @_;
2384 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2385 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2386 $self->setfield($field, "$1$2");
2390 =item ut_snumbern COLUMN
2392 Check/untaint signed numeric data (whole numbers). If there is an error,
2393 returns the error, otherwise returns false.
2398 my($self, $field) = @_;
2399 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2400 or return "Illegal (numeric) $field: ". $self->getfield($field);
2402 return "Illegal (numeric) $field: ". $self->getfield($field)
2405 $self->setfield($field, "$1$2");
2409 =item ut_number COLUMN
2411 Check/untaint simple numeric data (whole numbers). May not be null. If there
2412 is an error, returns the error, otherwise returns false.
2417 my($self,$field)=@_;
2418 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2419 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2420 $self->setfield($field,$1);
2424 =item ut_numbern COLUMN
2426 Check/untaint simple numeric data (whole numbers). May be null. If there is
2427 an error, returns the error, otherwise returns false.
2432 my($self,$field)=@_;
2433 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2434 or return "Illegal (numeric) $field: ". $self->getfield($field);
2435 $self->setfield($field,$1);
2439 =item ut_decimal COLUMN[, DIGITS]
2441 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2442 error, returns the error, otherwise returns false.
2444 =item ut_decimaln COLUMN[, DIGITS]
2446 Check/untaint decimal numbers. May be null. If there is an error, returns
2447 the error, otherwise returns false.
2452 my($self, $field, $digits) = @_;
2454 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2455 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2456 $self->setfield($field, $1);
2461 my($self, $field, $digits) = @_;
2462 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2463 or return "Illegal (decimal) $field: ".$self->getfield($field);
2464 $self->setfield($field, $1);
2468 =item ut_money COLUMN
2470 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2471 is an error, returns the error, otherwise returns false.
2476 my($self,$field)=@_;
2478 if ( $self->getfield($field) eq '' ) {
2479 $self->setfield($field, 0);
2480 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2481 #handle one decimal place without barfing out
2482 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2483 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2484 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2486 return "Illegal (money) $field: ". $self->getfield($field);
2492 =item ut_moneyn COLUMN
2494 Check/untaint monetary numbers. May be negative. If there
2495 is an error, returns the error, otherwise returns false.
2500 my($self,$field)=@_;
2501 if ($self->getfield($field) eq '') {
2502 $self->setfield($field, '');
2505 $self->ut_money($field);
2508 =item ut_currencyn COLUMN
2510 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2511 is an error, returns the error, otherwise returns false.
2516 my($self, $field) = @_;
2517 if ($self->getfield($field) eq '') { #can be null
2518 $self->setfield($field, '');
2521 $self->ut_currency($field);
2524 =item ut_currency COLUMN
2526 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2527 there is an error, returns the error, otherwise returns false.
2532 my($self, $field) = @_;
2533 my $value = uc( $self->getfield($field) );
2534 if ( code2currency($value) ) {
2535 $self->setfield($value);
2537 return "Unknown currency $value";
2543 =item ut_text COLUMN
2545 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2546 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2547 May not be null. If there is an error, returns the error, otherwise returns
2553 my($self,$field)=@_;
2554 #warn "msgcat ". \&msgcat. "\n";
2555 #warn "notexist ". \¬exist. "\n";
2556 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2557 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2558 # see perldoc perluniprops
2559 $self->getfield($field)
2560 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2561 or return gettext('illegal_or_empty_text'). " $field: ".
2562 $self->getfield($field);
2563 $self->setfield($field,$1);
2567 =item ut_textn COLUMN
2569 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2570 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2571 May be null. If there is an error, returns the error, otherwise returns false.
2576 my($self,$field)=@_;
2577 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2578 $self->ut_text($field);
2581 =item ut_alpha COLUMN
2583 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2584 an error, returns the error, otherwise returns false.
2589 my($self,$field)=@_;
2590 $self->getfield($field) =~ /^(\w+)$/
2591 or return "Illegal or empty (alphanumeric) $field: ".
2592 $self->getfield($field);
2593 $self->setfield($field,$1);
2597 =item ut_alphan COLUMN
2599 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2600 error, returns the error, otherwise returns false.
2605 my($self,$field)=@_;
2606 $self->getfield($field) =~ /^(\w*)$/
2607 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2608 $self->setfield($field,$1);
2612 =item ut_alphasn COLUMN
2614 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2615 an error, returns the error, otherwise returns false.
2620 my($self,$field)=@_;
2621 $self->getfield($field) =~ /^([\w ]*)$/
2622 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2623 $self->setfield($field,$1);
2628 =item ut_alpha_lower COLUMN
2630 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2631 there is an error, returns the error, otherwise returns false.
2635 sub ut_alpha_lower {
2636 my($self,$field)=@_;
2637 $self->getfield($field) =~ /[[:upper:]]/
2638 and return "Uppercase characters are not permitted in $field";
2639 $self->ut_alpha($field);
2642 =item ut_phonen COLUMN [ COUNTRY ]
2644 Check/untaint phone numbers. May be null. If there is an error, returns
2645 the error, otherwise returns false.
2647 Takes an optional two-letter ISO country code; without it or with unsupported
2648 countries, ut_phonen simply calls ut_alphan.
2653 my( $self, $field, $country ) = @_;
2654 return $self->ut_alphan($field) unless defined $country;
2655 my $phonen = $self->getfield($field);
2656 if ( $phonen eq '' ) {
2657 $self->setfield($field,'');
2658 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2660 $phonen = $conf->config('cust_main-default_areacode').$phonen
2661 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2662 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2663 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2664 $phonen = "$1-$2-$3";
2665 $phonen .= " x$4" if $4;
2666 $self->setfield($field,$phonen);
2668 warn "warning: don't know how to check phone numbers for country $country";
2669 return $self->ut_textn($field);
2676 Check/untaint hexadecimal values.
2681 my($self, $field) = @_;
2682 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2683 or return "Illegal (hex) $field: ". $self->getfield($field);
2684 $self->setfield($field, uc($1));
2688 =item ut_hexn COLUMN
2690 Check/untaint hexadecimal values. May be null.
2695 my($self, $field) = @_;
2696 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2697 or return "Illegal (hex) $field: ". $self->getfield($field);
2698 $self->setfield($field, uc($1));
2702 =item ut_mac_addr COLUMN
2704 Check/untaint mac addresses. May be null.
2709 my($self, $field) = @_;
2711 my $mac = $self->get($field);
2714 $self->set($field, $mac);
2716 my $e = $self->ut_hex($field);
2719 return "Illegal (mac address) $field: ". $self->getfield($field)
2720 unless length($self->getfield($field)) == 12;
2726 =item ut_mac_addrn COLUMN
2728 Check/untaint mac addresses. May be null.
2733 my($self, $field) = @_;
2734 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2739 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2745 my( $self, $field ) = @_;
2746 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2747 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2748 or return "Illegal (IP address) $field: ". $self->getfield($field);
2749 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2750 $self->setfield($field, "$1.$2.$3.$4");
2756 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2757 to 127.0.0.1. May be null.
2762 my( $self, $field ) = @_;
2763 if ( $self->getfield($field) =~ /^()$/ ) {
2764 $self->setfield($field,'');
2767 $self->ut_ip($field);
2771 =item ut_ip46 COLUMN
2773 Check/untaint IPv4 or IPv6 address.
2778 my( $self, $field ) = @_;
2779 my $ip = NetAddr::IP->new($self->getfield($field))
2780 or return "Illegal (IP address) $field: ".$self->getfield($field);
2781 $self->setfield($field, lc($ip->addr));
2787 Check/untaint IPv6 or IPv6 address. May be null.
2792 my( $self, $field ) = @_;
2793 if ( $self->getfield($field) =~ /^$/ ) {
2794 $self->setfield($field, '');
2797 $self->ut_ip46($field);
2800 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2802 Check/untaint coordinates.
2803 Accepts the following forms:
2813 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2814 The latter form (that is, the MMM are thousands of minutes) is
2815 assumed if the "MMM" is exactly three digits or two digits > 59.
2817 To be safe, just use the DDD.DDDDD form.
2819 If LOWER or UPPER are specified, then the coordinate is checked
2820 for lower and upper bounds, respectively.
2825 my ($self, $field) = (shift, shift);
2828 if ( $field =~ /latitude/ ) {
2829 $lower = $lat_lower;
2831 } elsif ( $field =~ /longitude/ ) {
2833 $upper = $lon_upper;
2836 my $coord = $self->getfield($field);
2837 my $neg = $coord =~ s/^(-)//;
2839 my ($d, $m, $s) = (0, 0, 0);
2842 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2843 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2844 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2846 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2849 return "Invalid (coordinate with minutes > 59) $field: "
2850 . $self->getfield($field);
2853 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2855 if (defined($lower) and ($coord < $lower)) {
2856 return "Invalid (coordinate < $lower) $field: "
2857 . $self->getfield($field);;
2860 if (defined($upper) and ($coord > $upper)) {
2861 return "Invalid (coordinate > $upper) $field: "
2862 . $self->getfield($field);;
2865 $self->setfield($field, $coord);
2869 return "Invalid (coordinate) $field: " . $self->getfield($field);
2873 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2875 Same as ut_coord, except optionally null.
2881 my ($self, $field) = (shift, shift);
2883 if ($self->getfield($field) =~ /^\s*$/) {
2886 return $self->ut_coord($field, @_);
2891 =item ut_domain COLUMN
2893 Check/untaint host and domain names. May not be null.
2898 my( $self, $field ) = @_;
2899 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2900 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2901 or return "Illegal (hostname) $field: ". $self->getfield($field);
2902 $self->setfield($field,$1);
2906 =item ut_domainn COLUMN
2908 Check/untaint host and domain names. May be null.
2913 my( $self, $field ) = @_;
2914 if ( $self->getfield($field) =~ /^()$/ ) {
2915 $self->setfield($field,'');
2918 $self->ut_domain($field);
2922 =item ut_name COLUMN
2924 Check/untaint proper names; allows alphanumerics, spaces and the following
2925 punctuation: , . - '
2932 my( $self, $field ) = @_;
2933 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2934 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
2935 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2940 $self->setfield($field, $name);
2944 =item ut_namen COLUMN
2946 Check/untaint proper names; allows alphanumerics, spaces and the following
2947 punctuation: , . - '
2954 my( $self, $field ) = @_;
2955 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2956 $self->ut_name($field);
2961 Check/untaint zip codes.
2965 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2968 my( $self, $field, $country ) = @_;
2970 if ( $country eq 'US' ) {
2972 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2973 or return gettext('illegal_zip'). " $field for country $country: ".
2974 $self->getfield($field);
2975 $self->setfield($field, $1);
2977 } elsif ( $country eq 'CA' ) {
2979 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2980 or return gettext('illegal_zip'). " $field for country $country: ".
2981 $self->getfield($field);
2982 $self->setfield($field, "$1 $2");
2986 if ( $self->getfield($field) =~ /^\s*$/
2987 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2990 $self->setfield($field,'');
2992 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2993 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2994 $self->setfield($field,$1);
3002 =item ut_country COLUMN
3004 Check/untaint country codes. Country names are changed to codes, if possible -
3005 see L<Locale::Country>.
3010 my( $self, $field ) = @_;
3011 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3012 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3013 && country2code($1) ) {
3014 $self->setfield($field,uc(country2code($1)));
3017 $self->getfield($field) =~ /^(\w\w)$/
3018 or return "Illegal (country) $field: ". $self->getfield($field);
3019 $self->setfield($field,uc($1));
3023 =item ut_anything COLUMN
3025 Untaints arbitrary data. Be careful.
3030 my( $self, $field ) = @_;
3031 $self->getfield($field) =~ /^(.*)$/s
3032 or return "Illegal $field: ". $self->getfield($field);
3033 $self->setfield($field,$1);
3037 =item ut_enum COLUMN CHOICES_ARRAYREF
3039 Check/untaint a column, supplying all possible choices, like the "enum" type.
3044 my( $self, $field, $choices ) = @_;
3045 foreach my $choice ( @$choices ) {
3046 if ( $self->getfield($field) eq $choice ) {
3047 $self->setfield($field, $choice);
3051 return "Illegal (enum) field $field: ". $self->getfield($field);
3054 =item ut_enumn COLUMN CHOICES_ARRAYREF
3056 Like ut_enum, except the null value is also allowed.
3061 my( $self, $field, $choices ) = @_;
3062 $self->getfield($field)
3063 ? $self->ut_enum($field, $choices)
3067 =item ut_flag COLUMN
3069 Check/untaint a column if it contains either an empty string or 'Y'. This
3070 is the standard form for boolean flags in Freeside.
3075 my( $self, $field ) = @_;
3076 my $value = uc($self->getfield($field));
3077 if ( $value eq '' or $value eq 'Y' ) {
3078 $self->setfield($field, $value);
3081 return "Illegal (flag) field $field: $value";
3084 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3086 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3087 on the column first.
3091 sub ut_foreign_key {
3092 my( $self, $field, $table, $foreign ) = @_;
3093 return '' if $no_check_foreign;
3094 qsearchs($table, { $foreign => $self->getfield($field) })
3095 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3096 " in $table.$foreign";
3100 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3102 Like ut_foreign_key, except the null value is also allowed.
3106 sub ut_foreign_keyn {
3107 my( $self, $field, $table, $foreign ) = @_;
3108 $self->getfield($field)
3109 ? $self->ut_foreign_key($field, $table, $foreign)
3113 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3115 Checks this column as an agentnum, taking into account the current users's
3116 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3117 right or rights allowing no agentnum.
3121 sub ut_agentnum_acl {
3122 my( $self, $field ) = (shift, shift);
3123 my $null_acl = scalar(@_) ? shift : [];
3124 $null_acl = [ $null_acl ] unless ref($null_acl);
3126 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3127 return "Illegal agentnum: $error" if $error;
3129 my $curuser = $FS::CurrentUser::CurrentUser;
3131 if ( $self->$field() ) {
3133 return "Access denied"
3134 unless $curuser->agentnum($self->$field());
3138 return "Access denied"
3139 unless grep $curuser->access_right($_), @$null_acl;
3147 =item fields [ TABLE ]
3149 This is a wrapper for real_fields. Code that called
3150 fields before should probably continue to call fields.
3155 my $something = shift;
3157 if($something->isa('FS::Record')) {
3158 $table = $something->table;
3160 $table = $something;
3161 $something = "FS::$table";
3163 return (real_fields($table));
3167 =item encrypt($value)
3169 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3171 Returns the encrypted string.
3173 You should generally not have to worry about calling this, as the system handles this for you.
3178 my ($self, $value) = @_;
3179 my $encrypted = $value;
3181 if ($conf->exists('encryption')) {
3182 if ($self->is_encrypted($value)) {
3183 # Return the original value if it isn't plaintext.
3184 $encrypted = $value;
3187 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3188 # RSA doesn't like the empty string so let's pack it up
3189 # The database doesn't like the RSA data so uuencode it
3190 my $length = length($value)+1;
3191 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3193 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3200 =item is_encrypted($value)
3202 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3208 my ($self, $value) = @_;
3209 # could be more precise about it, but this will do for now
3210 $value =~ /^M/ && length($value) > 80;
3213 =item decrypt($value)
3215 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3217 You should generally not have to worry about calling this, as the system handles this for you.
3222 my ($self,$value) = @_;
3223 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3224 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
3226 if (ref($rsa_decrypt) =~ /::RSA/) {
3227 my $encrypted = unpack ("u*", $value);
3228 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3229 if ($@) {warn "Decryption Failed"};
3237 #Initialize the Module
3238 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3240 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
3241 $rsa_module = $conf->config('encryptionmodule');
3245 eval ("require $rsa_module"); # No need to import the namespace
3248 # Initialize Encryption
3249 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
3250 my $public_key = join("\n",$conf->config('encryptionpublickey'));
3251 $rsa_encrypt = $rsa_module->new_public_key($public_key);
3254 # Intitalize Decryption
3255 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
3256 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
3257 $rsa_decrypt = $rsa_module->new_private_key($private_key);
3261 =item h_search ACTION
3263 Given an ACTION, either "insert", or "delete", returns the appropriate history
3264 record corresponding to this record, if any.
3269 my( $self, $action ) = @_;
3271 my $table = $self->table;
3274 my $primary_key = dbdef->table($table)->primary_key;
3277 'table' => "h_$table",
3278 'hashref' => { $primary_key => $self->$primary_key(),
3279 'history_action' => $action,
3287 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3288 appropriate history record corresponding to this record, if any.
3293 my($self, $action) = @_;
3294 my $h = $self->h_search($action);
3295 $h ? $h->history_date : '';
3298 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3300 A class or object method. Executes the sql statement represented by SQL and
3301 returns a scalar representing the result: the first column of the first row.
3303 Dies on bogus SQL. Returns an empty string if no row is returned.
3305 Typically used for statments which return a single value such as "SELECT
3306 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3311 my($self, $sql) = (shift, shift);
3312 my $sth = dbh->prepare($sql) or die dbh->errstr;
3314 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3315 my $row = $sth->fetchrow_arrayref or return '';
3316 my $scalar = $row->[0];
3317 defined($scalar) ? $scalar : '';
3320 =item count [ WHERE ]
3322 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3323 with optional WHERE. Must be called as method on a class with an
3329 my($self, $where) = (shift, shift);
3330 my $table = $self->table or die 'count called on object of class '.ref($self);
3331 my $sql = "SELECT COUNT(*) FROM $table";
3332 $sql .= " WHERE $where" if $where;
3333 $self->scalar_sql($sql);
3342 =item real_fields [ TABLE ]
3344 Returns a list of the real columns in the specified table. Called only by
3345 fields() and other subroutines elsewhere in FS::Record.
3352 my($table_obj) = dbdef->table($table);
3353 confess "Unknown table $table" unless $table_obj;
3354 $table_obj->columns;
3357 =item pvf FIELD_NAME
3359 Returns the FS::part_virtual_field object corresponding to a field in the
3360 record (specified by FIELD_NAME).
3365 my ($self, $name) = (shift, shift);
3367 if(grep /^$name$/, $self->virtual_fields) {
3369 my $concat = [ "'cf_'", "name" ];
3370 return qsearchs({ table => 'part_virtual_field',
3371 hashref => { dbtable => $self->table,
3374 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3380 =item _quote VALUE, TABLE, COLUMN
3382 This is an internal function used to construct SQL statements. It returns
3383 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3384 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3389 my($value, $table, $column) = @_;
3390 my $column_obj = dbdef->table($table)->column($column);
3391 my $column_type = $column_obj->type;
3392 my $nullable = $column_obj->null;
3394 utf8::upgrade($value);
3396 warn " $table.$column: $value ($column_type".
3397 ( $nullable ? ' NULL' : ' NOT NULL' ).
3398 ")\n" if $DEBUG > 2;
3400 if ( $value eq '' && $nullable ) {
3402 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3403 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3406 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3407 ! $column_type =~ /(char|binary|text)$/i ) {
3409 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3410 && driver_name eq 'Pg'
3414 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3415 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3416 # single-quote the whole mess, and put an "E" in front.
3417 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3425 This is deprecated. Don't use it.
3427 It returns a hash-type list with the fields of this record's table set true.
3432 carp "warning: hfields is deprecated";
3435 foreach (fields($table)) {
3444 "$_: ". $self->getfield($_). "|"
3445 } (fields($self->table)) );
3448 sub DESTROY { return; }
3452 # #use Carp qw(cluck);
3453 # #cluck "DESTROYING $self";
3454 # warn "DESTROYING $self";
3458 # return ! eval { join('',@_), kill 0; 1; };
3461 =item str2time_sql [ DRIVER_NAME ]
3463 Returns a function to convert to unix time based on database type, such as
3464 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3465 the str2time_sql_closing method to return a closing string rather than just
3466 using a closing parenthesis as previously suggested.
3468 You can pass an optional driver name such as "Pg", "mysql" or
3469 $dbh->{Driver}->{Name} to return a function for that database instead of
3470 the current database.
3475 my $driver = shift || driver_name;
3477 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3478 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3480 warn "warning: unknown database type $driver; guessing how to convert ".
3481 "dates to UNIX timestamps";
3482 return 'EXTRACT(EPOCH FROM ';
3486 =item str2time_sql_closing [ DRIVER_NAME ]
3488 Returns the closing suffix of a function to convert to unix time based on
3489 database type, such as ")::integer" for Pg or ")" for mysql.
3491 You can pass an optional driver name such as "Pg", "mysql" or
3492 $dbh->{Driver}->{Name} to return a function for that database instead of
3493 the current database.
3497 sub str2time_sql_closing {
3498 my $driver = shift || driver_name;
3500 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3504 =item regexp_sql [ DRIVER_NAME ]
3506 Returns the operator to do a regular expression comparison based on database
3507 type, such as '~' for Pg or 'REGEXP' for mysql.
3509 You can pass an optional driver name such as "Pg", "mysql" or
3510 $dbh->{Driver}->{Name} to return a function for that database instead of
3511 the current database.
3516 my $driver = shift || driver_name;
3518 return '~' if $driver =~ /^Pg/i;
3519 return 'REGEXP' if $driver =~ /^mysql/i;
3521 die "don't know how to use regular expressions in ". driver_name." databases";
3525 =item not_regexp_sql [ DRIVER_NAME ]
3527 Returns the operator to do a regular expression negation based on database
3528 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3530 You can pass an optional driver name such as "Pg", "mysql" or
3531 $dbh->{Driver}->{Name} to return a function for that database instead of
3532 the current database.
3536 sub not_regexp_sql {
3537 my $driver = shift || driver_name;
3539 return '!~' if $driver =~ /^Pg/i;
3540 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3542 die "don't know how to use regular expressions in ". driver_name." databases";
3546 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3548 Returns the items concatenated based on database type, using "CONCAT()" for
3549 mysql and " || " for Pg and other databases.
3551 You can pass an optional driver name such as "Pg", "mysql" or
3552 $dbh->{Driver}->{Name} to return a function for that database instead of
3553 the current database.
3558 my $driver = ref($_[0]) ? driver_name : shift;
3561 if ( $driver =~ /^mysql/i ) {
3562 'CONCAT('. join(',', @$items). ')';
3564 join('||', @$items);
3569 =item midnight_sql DATE
3571 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3572 on that day in the system timezone, using the default driver name.
3577 my $driver = driver_name;
3579 if ( $driver =~ /^mysql/i ) {
3580 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3583 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3591 This module should probably be renamed, since much of the functionality is
3592 of general use. It is not completely unlike Adapter::DBI (see below).
3594 Exported qsearch and qsearchs should be deprecated in favor of method calls
3595 (against an FS::Record object like the old search and searchs that qsearch
3596 and qsearchs were on top of.)
3598 The whole fields / hfields mess should be removed.
3600 The various WHERE clauses should be subroutined.
3602 table string should be deprecated in favor of DBIx::DBSchema::Table.
3604 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3605 true maps to the database (and WHERE clauses) would also help.
3607 The ut_ methods should ask the dbdef for a default length.
3609 ut_sqltype (like ut_varchar) should all be defined
3611 A fallback check method should be provided which uses the dbdef.
3613 The ut_money method assumes money has two decimal digits.
3615 The Pg money kludge in the new method only strips `$'.
3617 The ut_phonen method only checks US-style phone numbers.
3619 The _quote function should probably use ut_float instead of a regex.
3621 All the subroutines probably should be methods, here or elsewhere.
3623 Probably should borrow/use some dbdef methods where appropriate (like sub
3626 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3627 or allow it to be set. Working around it is ugly any way around - DBI should
3628 be fixed. (only affects RDBMS which return uppercase column names)
3630 ut_zip should take an optional country like ut_phone.
3634 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3636 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.