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;
413 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
416 my $value = $record->{$field};
417 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
418 $value = $value->{'value'} if ref($value);
419 my $type = dbdef->table($table)->column($field)->type;
421 my $bind_type = _bind_type($type, $value);
425 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
427 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
431 push @bind_type, $bind_type;
435 foreach my $param ( @$extra_param ) {
436 my $bind_type = { TYPE => SQL_VARCHAR };
439 $value = $param->[0];
440 my $type = $param->[1];
441 $bind_type = _bind_type($type, $value);
444 push @bind_type, $bind_type;
448 my $statement = join( ' ) UNION ( ', @statement );
449 $statement = "( $statement )" if scalar(@statement) > 1;
450 $statement .= " $union_options{order_by}" if $union_options{order_by};
452 my $sth = $dbh->prepare($statement)
453 or croak "$dbh->errstr doing $statement";
456 foreach my $value ( @value ) {
457 my $bind_type = shift @bind_type;
458 $sth->bind_param($bind++, $value, $bind_type );
461 # $sth->execute( map $record->{$_},
462 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
463 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
465 my $ok = $sth->execute;
467 my $error = "Error executing \"$statement\"";
468 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
469 $error .= ': '. $sth->errstr;
473 my $table = $stable[0];
475 $table = '' if grep { $_ ne $table } @stable;
476 $pkey = dbdef->table($table)->primary_key if $table;
479 tie %result, "Tie::IxHash";
480 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
481 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
482 %result = map { $_->{$pkey}, $_ } @stuff;
484 @result{@stuff} = @stuff;
490 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
491 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
492 #derivied class didn't override new method, so this optimization is safe
495 new_or_cached( "FS::$table", { %{$_} }, $cache )
499 new( "FS::$table", { %{$_} } )
503 #okay, its been tested
504 # warn "untested code (class FS::$table uses custom new method)";
506 eval 'FS::'. $table. '->new( { %{$_} } )';
510 # Check for encrypted fields and decrypt them.
511 ## only in the local copy, not the cached object
512 if ( $conf_encryption
513 && eval '@FS::'. $table . '::encrypted_fields' ) {
514 foreach my $record (@return) {
515 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
516 next if $field eq 'payinfo'
517 && ($record->isa('FS::payinfo_transaction_Mixin')
518 || $record->isa('FS::payinfo_Mixin') )
520 && !grep { $record->payby eq $_ } @encrypt_payby;
521 # Set it directly... This may cause a problem in the future...
522 $record->setfield($field, $record->decrypt($record->getfield($field)));
527 cluck "warning: FS::$table not loaded; returning FS::Record objects"
528 unless $nowarn_classload;
530 FS::Record->new( $table, { %{$_} } );
538 Construct the SQL statement and parameter-binding list for qsearch. Takes
539 the qsearch parameters.
541 Returns a hash containing:
542 'table': The primary table name (if there is one).
543 'statement': The SQL statement itself.
544 'bind_type': An arrayref of bind types.
545 'value': An arrayref of parameter values.
546 'cache': The cache object, if one was passed.
551 my( @stable, @record, @cache );
552 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
555 my %union_options = ();
556 if ( ref($_[0]) eq 'ARRAY' ) {
559 foreach my $href ( @$optlist ) {
560 push @stable, ( $href->{'table'} or die "table name is required" );
561 push @record, ( $href->{'hashref'} || {} );
562 push @select, ( $href->{'select'} || '*' );
563 push @extra_sql, ( $href->{'extra_sql'} || '' );
564 push @extra_param, ( $href->{'extra_param'} || [] );
565 push @order_by, ( $href->{'order_by'} || '' );
566 push @cache, ( $href->{'cache_obj'} || '' );
567 push @addl_from, ( $href->{'addl_from'} || '' );
568 push @debug, ( $href->{'debug'} || '' );
570 die "at least one hashref is required" unless scalar(@stable);
571 } elsif ( ref($_[0]) eq 'HASH' ) {
573 $stable[0] = $opt->{'table'} or die "table name is required";
574 $record[0] = $opt->{'hashref'} || {};
575 $select[0] = $opt->{'select'} || '*';
576 $extra_sql[0] = $opt->{'extra_sql'} || '';
577 $extra_param[0] = $opt->{'extra_param'} || [];
578 $order_by[0] = $opt->{'order_by'} || '';
579 $cache[0] = $opt->{'cache_obj'} || '';
580 $addl_from[0] = $opt->{'addl_from'} || '';
581 $debug[0] = $opt->{'debug'} || '';
592 my $cache = $cache[0];
598 my $result_table = $stable[0];
599 foreach my $stable ( @stable ) {
600 #stop altering the caller's hashref
601 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
602 my $select = shift @select;
603 my $extra_sql = shift @extra_sql;
604 my $extra_param = shift @extra_param;
605 my $order_by = shift @order_by;
606 my $cache = shift @cache;
607 my $addl_from = shift @addl_from;
608 my $debug = shift @debug;
610 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
612 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
615 $result_table = '' if $result_table ne $stable;
617 my $table = $cache ? $cache->table : $stable;
618 my $dbdef_table = dbdef->table($table)
619 or die "No schema for table $table found - ".
620 "do you need to run freeside-upgrade?";
621 my $pkey = $dbdef_table->primary_key;
623 my @real_fields = grep exists($record->{$_}), real_fields($table);
625 my $statement .= "SELECT $select FROM $stable";
626 $statement .= " $addl_from" if $addl_from;
627 if ( @real_fields ) {
628 $statement .= ' WHERE '. join(' AND ',
629 get_real_fields($table, $record, \@real_fields));
632 $statement .= " $extra_sql" if defined($extra_sql);
633 $statement .= " $order_by" if defined($order_by);
635 push @statement, $statement;
637 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
641 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
644 my $value = $record->{$field};
645 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
646 $value = $value->{'value'} if ref($value);
647 my $type = dbdef->table($table)->column($field)->type;
649 my $bind_type = _bind_type($type, $value);
653 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
655 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
659 push @bind_type, $bind_type;
663 foreach my $param ( @$extra_param ) {
664 my $bind_type = { TYPE => SQL_VARCHAR };
667 $value = $param->[0];
668 my $type = $param->[1];
669 $bind_type = _bind_type($type, $value);
672 push @bind_type, $bind_type;
676 my $statement = join( ' ) UNION ( ', @statement );
677 $statement = "( $statement )" if scalar(@statement) > 1;
678 $statement .= " $union_options{order_by}" if $union_options{order_by};
681 statement => $statement,
682 bind_type => \@bind_type,
684 table => $result_table,
689 # qsearch should eventually use this
691 my ($table, $cache, @hashrefs) = @_;
693 # XXX get rid of these string evals at some point
694 # (when we have time to test it)
695 # my $class = "FS::$table" if $table;
696 # if ( $class and $class->isa('FS::Record') )
697 # if ( $class->can('new') eq \&new )
699 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
700 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
701 #derivied class didn't override new method, so this optimization is safe
704 new_or_cached( "FS::$table", { %{$_} }, $cache )
708 new( "FS::$table", { %{$_} } )
712 #okay, its been tested
713 # warn "untested code (class FS::$table uses custom new method)";
715 eval 'FS::'. $table. '->new( { %{$_} } )';
719 # Check for encrypted fields and decrypt them.
720 ## only in the local copy, not the cached object
721 if ( $conf_encryption
722 && eval '@FS::'. $table . '::encrypted_fields' ) {
723 foreach my $record (@return) {
724 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
725 next if $field eq 'payinfo'
726 && ($record->isa('FS::payinfo_transaction_Mixin')
727 || $record->isa('FS::payinfo_Mixin') )
729 && !grep { $record->payby eq $_ } @encrypt_payby;
730 # Set it directly... This may cause a problem in the future...
731 $record->setfield($field, $record->decrypt($record->getfield($field)));
736 cluck "warning: FS::$table not loaded; returning FS::Record objects"
737 unless $nowarn_classload;
739 FS::Record->new( $table, { %{$_} } );
745 ## makes this easier to read
747 sub get_real_fields {
750 my $real_fields = shift;
752 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
758 my $type = dbdef->table($table)->column($column)->type;
759 my $value = $record->{$column};
760 $value = $value->{'value'} if ref($value);
761 if ( ref($record->{$_}) ) {
762 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
763 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
764 if ( uc($op) eq 'ILIKE' ) {
766 $record->{$_}{'value'} = lc($record->{$_}{'value'});
767 $column = "LOWER($_)";
769 $record->{$_} = $record->{$_}{'value'}
772 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
774 if ( driver_name eq 'Pg' ) {
775 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
776 qq-( $column IS NULL )-;
778 qq-( $column IS NULL OR $column = '' )-;
781 qq-( $column IS NULL OR $column = "" )-;
783 } elsif ( $op eq '!=' ) {
784 if ( driver_name eq 'Pg' ) {
785 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
786 qq-( $column IS NOT NULL )-;
788 qq-( $column IS NOT NULL AND $column != '' )-;
791 qq-( $column IS NOT NULL AND $column != "" )-;
794 if ( driver_name eq 'Pg' ) {
795 qq-( $column $op '' )-;
797 qq-( $column $op "" )-;
800 } elsif ( $op eq '!=' ) {
801 qq-( $column IS NULL OR $column != ? )-;
802 #if this needs to be re-enabled, it needs to use a custom op like
803 #"APPROX=" or something (better name?, not '=', to avoid affecting other
805 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
806 # ( "$column <= ?", "$column >= ?" );
810 } @{ $real_fields } );
813 =item by_key PRIMARY_KEY_VALUE
815 This is a class method that returns the record with the given primary key
816 value. This method is only useful in FS::Record subclasses. For example:
818 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
822 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
827 my ($class, $pkey_value) = @_;
829 my $table = $class->table
830 or croak "No table for $class found";
832 my $dbdef_table = dbdef->table($table)
833 or die "No schema for table $table found - ".
834 "do you need to create it or run dbdef-create?";
835 my $pkey = $dbdef_table->primary_key
836 or die "No primary key for table $table";
838 return qsearchs($table, { $pkey => $pkey_value });
841 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
843 Experimental JOINed search method. Using this method, you can execute a
844 single SELECT spanning multiple tables, and cache the results for subsequent
845 method calls. Interface will almost definately change in an incompatible
853 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
854 my $cache = FS::SearchCache->new( $ptable, $pkey );
857 grep { !$saw{$_->getfield($pkey)}++ }
858 qsearch($table, $record, $select, $extra_sql, $cache )
862 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
864 Same as qsearch, except that if more than one record matches, it B<carp>s but
865 returns the first. If this happens, you either made a logic error in asking
866 for a single item, or your data is corrupted.
870 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
872 my(@result) = qsearch(@_);
873 cluck "warning: Multiple records in scalar search ($table)"
874 if scalar(@result) > 1;
875 #should warn more vehemently if the search was on a primary key?
876 scalar(@result) ? ($result[0]) : ();
887 Returns the table name.
892 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
899 Returns the DBIx::DBSchema::Table object for the table.
905 my($table)=$self->table;
906 dbdef->table($table);
911 Returns the primary key for the table.
917 my $pkey = $self->dbdef_table->primary_key;
920 =item get, getfield COLUMN
922 Returns the value of the column/field/key COLUMN.
927 my($self,$field) = @_;
928 # to avoid "Use of unitialized value" errors
929 if ( defined ( $self->{Hash}->{$field} ) ) {
930 $self->{Hash}->{$field};
940 =item set, setfield COLUMN, VALUE
942 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
947 my($self,$field,$value) = @_;
948 $self->{'modified'} = 1;
949 $self->{'Hash'}->{$field} = $value;
958 Returns true if the column/field/key COLUMN exists.
963 my($self,$field) = @_;
964 exists($self->{Hash}->{$field});
967 =item AUTLOADED METHODS
969 $record->column is a synonym for $record->get('column');
971 $record->column('value') is a synonym for $record->set('column','value');
973 $record->foreign_table_name calls qsearchs and returns a single
974 FS::foreign_table record (for tables referenced by a column of this table) or
975 qsearch and returns an array of FS::foreign_table records (for tables
976 referenced by a column in the foreign table).
983 my($field)=$AUTOLOAD;
986 confess "errant AUTOLOAD $field for $self (arg $value)"
987 unless blessed($self) && $self->can('setfield');
989 #$fk_method_cache{$self->table} ||= fk_methods($self->table);
990 if ( exists($fk_method_cache{$self->table}->{$field}) ) {
992 my $fk_info = $fk_method_cache{$self->table}->{$field};
993 my $method = $fk_info->{method} || 'qsearchs';
994 my $table = $fk_info->{table} || $field;
995 my $column = $fk_info->{column};
996 my $foreign_column = $fk_info->{references} || $column;
998 eval "use FS::$table";
1001 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1003 my $pkey_value = $self->$column();
1004 my %search = ( $foreign_column => $pkey_value );
1006 # FS::Record->$method() ? they're actually just subs :/
1007 if ( $method eq 'qsearchs' ) {
1008 return $pkey_value ? qsearchs( $table, \%search ) : '';
1009 } elsif ( $method eq 'qsearch' ) {
1010 return $pkey_value ? qsearch( $table, \%search ) : ();
1012 die "unknown method $method";
1017 if ( defined($value) ) {
1018 $self->setfield($field,$value);
1020 $self->getfield($field);
1024 # efficient (also, old, doesn't support FK stuff)
1026 # my $field = $AUTOLOAD;
1027 # $field =~ s/.*://;
1028 # if ( defined($_[1]) ) {
1029 # $_[0]->setfield($field, $_[1]);
1031 # $_[0]->getfield($field);
1040 # foreign keys we reference in other tables
1041 foreach my $fk (dbdef->table($table)->foreign_keys) {
1044 if ( scalar( @{$fk->columns} ) == 1 ) {
1045 if ( ! defined($fk->references)
1046 || ! @{$fk->references}
1047 || $fk->columns->[0] eq $fk->references->[0]
1049 $method = $fk->table;
1051 #some sort of hint in the table.pm or schema for methods not named
1052 # after their foreign table (well, not a whole lot different than
1053 # just providing a small subroutine...)
1057 $hash{$method} = { #fk_info
1058 'method' => 'qsearchs',
1059 'column' => $fk->columns->[0],
1060 #'references' => $fk->references->[0],
1068 # foreign keys referenced in other tables to us
1069 # (alas. why we're cached. still, might this loop better be done once at
1070 # schema load time insetad of every time we AUTOLOAD a method on a new
1072 foreach my $f_table ( dbdef->tables ) {
1073 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1075 next unless $fk->table eq $table;
1078 if ( scalar( @{$fk->columns} ) == 1 ) {
1079 if ( ! defined($fk->references)
1080 || ! @{$fk->references}
1081 || $fk->columns->[0] eq $fk->references->[0]
1085 #some sort of hint in the table.pm or schema for methods not named
1086 # after their foreign table (well, not a whole lot different than
1087 # just providing a small subroutine...)
1091 $hash{$method} = { #fk_info
1092 'method' => 'qsearch',
1093 'column' => $fk->columns->[0], #references||column
1094 #'references' => $fk->column->[0],
1109 Returns a list of the column/value pairs, usually for assigning to a new hash.
1111 To make a distinct duplicate of an FS::Record object, you can do:
1113 $new = new FS::Record ( $old->table, { $old->hash } );
1119 confess $self. ' -> hash: Hash attribute is undefined'
1120 unless defined($self->{'Hash'});
1121 %{ $self->{'Hash'} };
1126 Returns a reference to the column/value hash. This may be deprecated in the
1127 future; if there's a reason you can't just use the autoloaded or get/set
1141 +{ ( map { $_=>$self->$_ } $self->fields ),
1146 my( $class, %opt ) = @_;
1147 my $table = $class->table;
1148 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1149 my $error = $self->insert;
1150 return +{ 'error' => $error } if $error;
1151 my $pkey = $self->pkey;
1152 return +{ 'error' => '',
1153 'primary_key' => $pkey,
1154 $pkey => $self->$pkey,
1160 Returns true if any of this object's values have been modified with set (or via
1161 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1168 $self->{'modified'};
1171 =item select_for_update
1173 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1178 sub select_for_update {
1180 my $primary_key = $self->primary_key;
1183 'table' => $self->table,
1184 'hashref' => { $primary_key => $self->$primary_key() },
1185 'extra_sql' => 'FOR UPDATE',
1191 Locks this table with a database-driver specific lock method. This is used
1192 as a mutex in order to do a duplicate search.
1194 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1196 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1198 Errors are fatal; no useful return value.
1200 Note: To use this method for new tables other than svc_acct and svc_phone,
1201 edit freeside-upgrade and add those tables to the duplicate_lock list.
1207 my $table = $self->table;
1209 warn "$me locking $table table\n" if $DEBUG;
1211 if ( driver_name =~ /^Pg/i ) {
1213 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1216 } elsif ( driver_name =~ /^mysql/i ) {
1218 dbh->do("SELECT * FROM duplicate_lock
1219 WHERE lockname = '$table'
1221 ) or die dbh->errstr;
1225 die "unknown database ". driver_name. "; don't know how to lock table";
1229 warn "$me acquired $table table lock\n" if $DEBUG;
1235 Inserts this record to the database. If there is an error, returns the error,
1236 otherwise returns false.
1244 warn "$self -> insert" if $DEBUG;
1246 my $error = $self->check;
1247 return $error if $error;
1249 #single-field non-null unique keys are given a value if empty
1250 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1251 foreach ( $self->dbdef_table->unique_singles) {
1252 next if $self->getfield($_);
1253 next if $self->dbdef_table->column($_)->null eq 'NULL';
1257 #and also the primary key, if the database isn't going to
1258 my $primary_key = $self->dbdef_table->primary_key;
1260 if ( $primary_key ) {
1261 my $col = $self->dbdef_table->column($primary_key);
1264 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1265 || ( driver_name eq 'Pg'
1266 && defined($col->default)
1267 && $col->quoted_default =~ /^nextval\(/i
1269 || ( driver_name eq 'mysql'
1270 && defined($col->local)
1271 && $col->local =~ /AUTO_INCREMENT/i
1273 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1276 my $table = $self->table;
1278 # Encrypt before the database
1279 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
1280 && scalar( eval '@FS::'. $table . '::encrypted_fields')
1281 && $conf->exists('encryption')
1283 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1284 next if $field eq 'payinfo'
1285 && ($self->isa('FS::payinfo_transaction_Mixin')
1286 || $self->isa('FS::payinfo_Mixin') )
1288 && !grep { $self->payby eq $_ } @encrypt_payby;
1289 $saved->{$field} = $self->getfield($field);
1290 $self->setfield($field, $self->encrypt($self->getfield($field)));
1294 #false laziness w/delete
1296 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1299 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1302 my $statement = "INSERT INTO $table ";
1303 if ( @real_fields ) {
1306 join( ', ', @real_fields ).
1308 join( ', ', @values ).
1312 $statement .= 'DEFAULT VALUES';
1314 warn "[debug]$me $statement\n" if $DEBUG > 1;
1315 my $sth = dbh->prepare($statement) or return dbh->errstr;
1317 local $SIG{HUP} = 'IGNORE';
1318 local $SIG{INT} = 'IGNORE';
1319 local $SIG{QUIT} = 'IGNORE';
1320 local $SIG{TERM} = 'IGNORE';
1321 local $SIG{TSTP} = 'IGNORE';
1322 local $SIG{PIPE} = 'IGNORE';
1324 $sth->execute or return $sth->errstr;
1326 # get inserted id from the database, if applicable & needed
1327 if ( $db_seq && ! $self->getfield($primary_key) ) {
1328 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1332 if ( driver_name eq 'Pg' ) {
1334 #my $oid = $sth->{'pg_oid_status'};
1335 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1337 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1338 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1339 dbh->rollback if $FS::UID::AutoCommit;
1340 return "can't parse $table.$primary_key default value".
1341 " for sequence name: $default";
1345 my $i_sql = "SELECT currval('$sequence')";
1346 my $i_sth = dbh->prepare($i_sql) or do {
1347 dbh->rollback if $FS::UID::AutoCommit;
1350 $i_sth->execute() or do { #$i_sth->execute($oid)
1351 dbh->rollback if $FS::UID::AutoCommit;
1352 return $i_sth->errstr;
1354 $insertid = $i_sth->fetchrow_arrayref->[0];
1356 } elsif ( driver_name eq 'mysql' ) {
1358 $insertid = dbh->{'mysql_insertid'};
1359 # work around mysql_insertid being null some of the time, ala RT :/
1360 unless ( $insertid ) {
1361 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1362 "using SELECT LAST_INSERT_ID();";
1363 my $i_sql = "SELECT LAST_INSERT_ID()";
1364 my $i_sth = dbh->prepare($i_sql) or do {
1365 dbh->rollback if $FS::UID::AutoCommit;
1368 $i_sth->execute or do {
1369 dbh->rollback if $FS::UID::AutoCommit;
1370 return $i_sth->errstr;
1372 $insertid = $i_sth->fetchrow_arrayref->[0];
1377 dbh->rollback if $FS::UID::AutoCommit;
1378 return "don't know how to retreive inserted ids from ". driver_name.
1379 ", try using counterfiles (maybe run dbdef-create?)";
1383 $self->setfield($primary_key, $insertid);
1388 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1389 my $h_statement = $self->_h_statement('insert');
1390 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1391 $h_sth = dbh->prepare($h_statement) or do {
1392 dbh->rollback if $FS::UID::AutoCommit;
1398 $h_sth->execute or return $h_sth->errstr if $h_sth;
1400 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1402 # Now that it has been saved, reset the encrypted fields so that $new
1403 # can still be used.
1404 foreach my $field (keys %{$saved}) {
1405 $self->setfield($field, $saved->{$field});
1413 Depriciated (use insert instead).
1418 cluck "warning: FS::Record::add deprecated!";
1419 insert @_; #call method in this scope
1424 Delete this record from the database. If there is an error, returns the error,
1425 otherwise returns false.
1432 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1434 $self->getfield($_) eq ''
1435 #? "( $_ IS NULL OR $_ = \"\" )"
1436 ? ( driver_name eq 'Pg'
1438 : "( $_ IS NULL OR $_ = \"\" )"
1440 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1441 } ( $self->dbdef_table->primary_key )
1442 ? ( $self->dbdef_table->primary_key)
1443 : real_fields($self->table)
1445 warn "[debug]$me $statement\n" if $DEBUG > 1;
1446 my $sth = dbh->prepare($statement) or return dbh->errstr;
1449 if ( defined dbdef->table('h_'. $self->table) ) {
1450 my $h_statement = $self->_h_statement('delete');
1451 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1452 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1457 my $primary_key = $self->dbdef_table->primary_key;
1459 local $SIG{HUP} = 'IGNORE';
1460 local $SIG{INT} = 'IGNORE';
1461 local $SIG{QUIT} = 'IGNORE';
1462 local $SIG{TERM} = 'IGNORE';
1463 local $SIG{TSTP} = 'IGNORE';
1464 local $SIG{PIPE} = 'IGNORE';
1466 my $rc = $sth->execute or return $sth->errstr;
1467 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1468 $h_sth->execute or return $h_sth->errstr if $h_sth;
1470 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1472 #no need to needlessly destoy the data either (causes problems actually)
1473 #undef $self; #no need to keep object!
1480 Depriciated (use delete instead).
1485 cluck "warning: FS::Record::del deprecated!";
1486 &delete(@_); #call method in this scope
1489 =item replace OLD_RECORD
1491 Replace the OLD_RECORD with this one in the database. If there is an error,
1492 returns the error, otherwise returns false.
1497 my ($new, $old) = (shift, shift);
1499 $old = $new->replace_old unless defined($old);
1501 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1503 if ( $new->can('replace_check') ) {
1504 my $error = $new->replace_check($old);
1505 return $error if $error;
1508 return "Records not in same table!" unless $new->table eq $old->table;
1510 my $primary_key = $old->dbdef_table->primary_key;
1511 return "Can't change primary key $primary_key ".
1512 'from '. $old->getfield($primary_key).
1513 ' to ' . $new->getfield($primary_key)
1515 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1517 my $error = $new->check;
1518 return $error if $error;
1520 # Encrypt for replace
1522 if ( $conf->exists('encryption')
1523 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1524 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1526 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1527 next if $field eq 'payinfo'
1528 && ($new->isa('FS::payinfo_transaction_Mixin')
1529 || $new->isa('FS::payinfo_Mixin') )
1531 && !grep { $new->payby eq $_ } @encrypt_payby;
1532 $saved->{$field} = $new->getfield($field);
1533 $new->setfield($field, $new->encrypt($new->getfield($field)));
1537 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1538 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1539 ? ($_, $new->getfield($_)) : () } $old->fields;
1541 unless (keys(%diff) || $no_update_diff ) {
1542 carp "[warning]$me ". ref($new)."->replace ".
1543 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1544 ": records identical"
1545 unless $nowarn_identical;
1549 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1551 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1552 } real_fields($old->table)
1557 if ( $old->getfield($_) eq '' ) {
1559 #false laziness w/qsearch
1560 if ( driver_name eq 'Pg' ) {
1561 my $type = $old->dbdef_table->column($_)->type;
1562 if ( $type =~ /(int|(big)?serial)/i ) {
1565 qq-( $_ IS NULL OR $_ = '' )-;
1568 qq-( $_ IS NULL OR $_ = "" )-;
1572 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1575 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1578 warn "[debug]$me $statement\n" if $DEBUG > 1;
1579 my $sth = dbh->prepare($statement) or return dbh->errstr;
1582 if ( defined dbdef->table('h_'. $old->table) ) {
1583 my $h_old_statement = $old->_h_statement('replace_old');
1584 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1585 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1591 if ( defined dbdef->table('h_'. $new->table) ) {
1592 my $h_new_statement = $new->_h_statement('replace_new');
1593 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1594 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1599 local $SIG{HUP} = 'IGNORE';
1600 local $SIG{INT} = 'IGNORE';
1601 local $SIG{QUIT} = 'IGNORE';
1602 local $SIG{TERM} = 'IGNORE';
1603 local $SIG{TSTP} = 'IGNORE';
1604 local $SIG{PIPE} = 'IGNORE';
1606 my $rc = $sth->execute or return $sth->errstr;
1607 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1608 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1609 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1611 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1613 # Now that it has been saved, reset the encrypted fields so that $new
1614 # can still be used.
1615 foreach my $field (keys %{$saved}) {
1616 $new->setfield($field, $saved->{$field});
1624 my( $self ) = shift;
1625 warn "[$me] replace called with no arguments; autoloading old record\n"
1628 my $primary_key = $self->dbdef_table->primary_key;
1629 if ( $primary_key ) {
1630 $self->by_key( $self->$primary_key() ) #this is what's returned
1631 or croak "can't find ". $self->table. ".$primary_key ".
1632 $self->$primary_key();
1634 croak $self->table. " has no primary key; pass old record as argument";
1641 Depriciated (use replace instead).
1646 cluck "warning: FS::Record::rep deprecated!";
1647 replace @_; #call method in this scope
1652 Checks custom fields. Subclasses should still provide a check method to validate
1653 non-custom fields, etc., and call this method via $self->SUPER::check.
1659 foreach my $field ($self->virtual_fields) {
1660 my $error = $self->ut_textn($field);
1661 return $error if $error;
1666 =item virtual_fields [ TABLE ]
1668 Returns a list of virtual fields defined for the table. This should not
1669 be exported, and should only be called as an instance or class method.
1673 sub virtual_fields {
1676 $table = $self->table or confess "virtual_fields called on non-table";
1678 confess "Unknown table $table" unless dbdef->table($table);
1680 return () unless dbdef->table('part_virtual_field');
1682 unless ( $virtual_fields_cache{$table} ) {
1683 my $concat = [ "'cf_'", "name" ];
1684 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1685 "WHERE dbtable = '$table'";
1687 my $result = $dbh->selectcol_arrayref($query);
1688 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1690 $virtual_fields_cache{$table} = $result;
1693 @{$virtual_fields_cache{$table}};
1697 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1699 Processes a batch import as a queued JSRPC job
1701 JOB is an FS::queue entry.
1703 OPTIONS_HASHREF can have the following keys:
1709 Table name (required).
1713 Listref of field names for static fields. They will be given values from the
1714 PARAMS hashref and passed as a "params" hashref to batch_import.
1718 Formats hashref. Keys are field names, values are listrefs that define the
1721 Each listref value can be a column name or a code reference. Coderefs are run
1722 with the row object, data and a FS::Conf object as the three parameters.
1723 For example, this coderef does the same thing as using the "columnname" string:
1726 my( $record, $data, $conf ) = @_;
1727 $record->columnname( $data );
1730 Coderefs are run after all "column name" fields are assigned.
1734 Optional format hashref of types. Keys are field names, values are "csv",
1735 "xls" or "fixedlength". Overrides automatic determination of file type
1738 =item format_headers
1740 Optional format hashref of header lines. Keys are field names, values are 0
1741 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1744 =item format_sep_chars
1746 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1747 CSV separation character.
1749 =item format_fixedlenth_formats
1751 Optional format hashref of fixed length format defintiions. Keys are field
1752 names, values Parse::FixedLength listrefs of field definitions.
1756 Set true to default to CSV file type if the filename does not contain a
1757 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1762 PARAMS is a base64-encoded Storable string containing the POSTed data as
1763 a hash ref. It normally contains at least one field, "uploaded files",
1764 generated by /elements/file-upload.html and containing the list of uploaded
1765 files. Currently only supports a single file named "file".
1770 sub process_batch_import {
1771 my($job, $opt, $param) = @_;
1773 my $table = $opt->{table};
1774 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1775 my %formats = %{ $opt->{formats} };
1777 warn Dumper($param) if $DEBUG;
1779 my $files = $param->{'uploaded_files'}
1780 or die "No files provided.\n";
1782 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1784 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1785 my $file = $dir. $files{'file'};
1790 formats => \%formats,
1791 format_types => $opt->{format_types},
1792 format_headers => $opt->{format_headers},
1793 format_sep_chars => $opt->{format_sep_chars},
1794 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1795 format_xml_formats => $opt->{format_xml_formats},
1796 format_asn_formats => $opt->{format_asn_formats},
1797 format_row_callbacks => $opt->{format_row_callbacks},
1802 format => $param->{format},
1803 params => { map { $_ => $param->{$_} } @pass_params },
1805 default_csv => $opt->{default_csv},
1806 postinsert_callback => $opt->{postinsert_callback},
1809 if ( $opt->{'batch_namecol'} ) {
1810 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1811 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1814 my $error = FS::Record::batch_import( \%iopt );
1818 die "$error\n" if $error;
1821 =item batch_import PARAM_HASHREF
1823 Class method for batch imports. Available params:
1829 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1835 =item format_headers
1837 =item format_sep_chars
1839 =item format_fixedlength_formats
1841 =item format_row_callbacks
1843 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1845 =item preinsert_callback
1847 =item postinsert_callback
1853 FS::queue object, will be updated with progress
1859 csv, xls, fixedlength, xml
1871 warn "$me batch_import call with params: \n". Dumper($param)
1874 my $table = $param->{table};
1876 my $job = $param->{job};
1877 my $file = $param->{file};
1878 my $params = $param->{params} || {};
1880 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1881 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1883 my( $type, $header, $sep_char,
1884 $fixedlength_format, $xml_format, $asn_format,
1885 $parser_opt, $row_callback, @fields );
1887 my $postinsert_callback = '';
1888 $postinsert_callback = $param->{'postinsert_callback'}
1889 if $param->{'postinsert_callback'};
1890 my $preinsert_callback = '';
1891 $preinsert_callback = $param->{'preinsert_callback'}
1892 if $param->{'preinsert_callback'};
1894 if ( $param->{'format'} ) {
1896 my $format = $param->{'format'};
1897 my $formats = $param->{formats};
1898 die "unknown format $format" unless exists $formats->{ $format };
1900 $type = $param->{'format_types'}
1901 ? $param->{'format_types'}{ $format }
1902 : $param->{type} || 'csv';
1905 $header = $param->{'format_headers'}
1906 ? $param->{'format_headers'}{ $param->{'format'} }
1909 $sep_char = $param->{'format_sep_chars'}
1910 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1913 $fixedlength_format =
1914 $param->{'format_fixedlength_formats'}
1915 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1919 $param->{'format_parser_opts'}
1920 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1924 $param->{'format_xml_formats'}
1925 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1929 $param->{'format_asn_formats'}
1930 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1934 $param->{'format_row_callbacks'}
1935 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1938 @fields = @{ $formats->{ $format } };
1940 } elsif ( $param->{'fields'} ) {
1942 $type = ''; #infer from filename
1945 $fixedlength_format = '';
1947 @fields = @{ $param->{'fields'} };
1950 die "neither format nor fields specified";
1953 #my $file = $param->{file};
1956 if ( $file =~ /\.(\w+)$/i ) {
1960 warn "can't parse file type from filename $file; defaulting to CSV";
1964 if $param->{'default_csv'} && $type ne 'xls';
1972 my $asn_header_buffer;
1973 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1975 if ( $type eq 'csv' ) {
1977 $parser_opt->{'binary'} = 1;
1978 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
1979 $parser = Text::CSV_XS->new($parser_opt);
1981 } elsif ( $type eq 'fixedlength' ) {
1983 eval "use Parse::FixedLength;";
1985 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
1988 die "Unknown file type $type\n";
1991 @buffer = split(/\r?\n/, slurp($file) );
1992 splice(@buffer, 0, ($header || 0) );
1993 $count = scalar(@buffer);
1995 } elsif ( $type eq 'xls' ) {
1997 eval "use Spreadsheet::ParseExcel;";
2000 eval "use DateTime::Format::Excel;";
2001 #for now, just let the error be thrown if it is used, since only CDR
2002 # formats bill_west and troop use it, not other excel-parsing things
2005 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2007 $parser = $excel->{Worksheet}[0]; #first sheet
2009 $count = $parser->{MaxRow} || $parser->{MinRow};
2012 $row = $header || 0;
2014 } elsif ( $type eq 'xml' ) {
2017 eval "use XML::Simple;";
2019 my $xmlrow = $xml_format->{'xmlrow'};
2020 $parser = $xml_format->{'xmlkeys'};
2021 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2022 my $data = XML::Simple::XMLin(
2024 'SuppressEmpty' => '', #sets empty values to ''
2028 $rows = $rows->{$_} foreach @$xmlrow;
2029 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2030 $count = @buffer = @$rows;
2032 } elsif ( $type eq 'asn.1' ) {
2034 eval "use Convert::ASN1";
2037 my $asn = Convert::ASN1->new;
2038 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2040 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2042 my $data = slurp($file);
2043 my $asn_output = $parser->decode( $data )
2044 or return "No ". $asn_format->{'macro'}. " found\n";
2046 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2048 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2049 $count = @buffer = @$rows;
2052 die "Unknown file type $type\n";
2057 local $SIG{HUP} = 'IGNORE';
2058 local $SIG{INT} = 'IGNORE';
2059 local $SIG{QUIT} = 'IGNORE';
2060 local $SIG{TERM} = 'IGNORE';
2061 local $SIG{TSTP} = 'IGNORE';
2062 local $SIG{PIPE} = 'IGNORE';
2064 my $oldAutoCommit = $FS::UID::AutoCommit;
2065 local $FS::UID::AutoCommit = 0;
2068 #my $params = $param->{params} || {};
2069 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2070 my $batch_col = $param->{'batch_keycol'};
2072 my $batch_class = 'FS::'. $param->{'batch_table'};
2073 my $batch = $batch_class->new({
2074 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2076 my $error = $batch->insert;
2078 $dbh->rollback if $oldAutoCommit;
2079 return "can't insert batch record: $error";
2081 #primary key via dbdef? (so the column names don't have to match)
2082 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2084 $params->{ $batch_col } = $batch_value;
2087 #my $job = $param->{job};
2090 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2094 my %hash = %$params;
2095 if ( $type eq 'csv' ) {
2097 last unless scalar(@buffer);
2098 $line = shift(@buffer);
2100 next if $line =~ /^\s*$/; #skip empty lines
2102 $line = &{$row_callback}($line) if $row_callback;
2104 next if $line =~ /^\s*$/; #skip empty lines
2106 $parser->parse($line) or do {
2107 $dbh->rollback if $oldAutoCommit;
2108 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2110 @columns = $parser->fields();
2112 } elsif ( $type eq 'fixedlength' ) {
2114 last unless scalar(@buffer);
2115 $line = shift(@buffer);
2117 @columns = $parser->parse($line);
2119 } elsif ( $type eq 'xls' ) {
2121 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2122 || ! $parser->{Cells}[$row];
2124 my @row = @{ $parser->{Cells}[$row] };
2125 @columns = map $_->{Val}, @row;
2128 #warn $z++. ": $_\n" for @columns;
2130 } elsif ( $type eq 'xml' ) {
2132 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2133 last unless scalar(@buffer);
2134 my $row = shift @buffer;
2135 @columns = @{ $row }{ @$parser };
2137 } elsif ( $type eq 'asn.1' ) {
2139 last unless scalar(@buffer);
2140 my $row = shift @buffer;
2141 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2142 if $asn_format->{row_callback};
2143 foreach my $key ( keys %{ $asn_format->{map} } ) {
2144 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2148 die "Unknown file type $type\n";
2153 foreach my $field ( @fields ) {
2155 my $value = shift @columns;
2157 if ( ref($field) eq 'CODE' ) {
2158 #&{$field}(\%hash, $value);
2159 push @later, $field, $value;
2161 #??? $hash{$field} = $value if length($value);
2162 $hash{$field} = $value if defined($value) && length($value);
2167 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2168 && length($1) == $custnum_length ) {
2169 $hash{custnum} = $2;
2172 #my $table = $param->{table};
2173 my $class = "FS::$table";
2175 my $record = $class->new( \%hash );
2178 while ( scalar(@later) ) {
2179 my $sub = shift @later;
2180 my $data = shift @later;
2182 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2185 $dbh->rollback if $oldAutoCommit;
2186 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2188 last if exists( $param->{skiprow} );
2190 next if exists( $param->{skiprow} );
2192 if ( $preinsert_callback ) {
2193 my $error = &{$preinsert_callback}($record, $param);
2195 $dbh->rollback if $oldAutoCommit;
2196 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2199 next if exists $param->{skiprow} && $param->{skiprow};
2202 my $error = $record->insert;
2205 $dbh->rollback if $oldAutoCommit;
2206 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2212 if ( $postinsert_callback ) {
2213 my $error = &{$postinsert_callback}($record, $param);
2215 $dbh->rollback if $oldAutoCommit;
2216 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2221 if ( $job && time - $min_sec > $last ) { #progress bar
2222 $job->update_statustext( int(100 * $imported / $count) );
2228 unless ( $imported || $param->{empty_ok} ) {
2229 $dbh->rollback if $oldAutoCommit;
2230 return "Empty file!";
2233 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2240 my( $self, $action, $time ) = @_;
2244 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2247 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2248 real_fields($self->table);
2251 # If we're encrypting then don't store the payinfo in the history
2252 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
2253 @fields = grep { $_ ne 'payinfo' } @fields;
2256 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2258 "INSERT INTO h_". $self->table. " ( ".
2259 join(', ', qw(history_date history_usernum history_action), @fields ).
2262 $FS::CurrentUser::CurrentUser->usernum,
2263 dbh->quote($action),
2272 B<Warning>: External use is B<deprecated>.
2274 Replaces COLUMN in record with a unique number, using counters in the
2275 filesystem. Used by the B<insert> method on single-field unique columns
2276 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2277 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2279 Returns the new value.
2284 my($self,$field) = @_;
2285 my($table)=$self->table;
2287 croak "Unique called on field $field, but it is ",
2288 $self->getfield($field),
2290 if $self->getfield($field);
2292 #warn "table $table is tainted" if is_tainted($table);
2293 #warn "field $field is tainted" if is_tainted($field);
2295 my($counter) = new File::CounterFile "$table.$field",0;
2297 my $index = $counter->inc;
2298 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2300 $index =~ /^(\d*)$/;
2303 $self->setfield($field,$index);
2307 =item ut_float COLUMN
2309 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2310 null. If there is an error, returns the error, otherwise returns false.
2315 my($self,$field)=@_ ;
2316 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2317 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2318 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2319 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2320 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2321 $self->setfield($field,$1);
2324 =item ut_floatn COLUMN
2326 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2327 null. If there is an error, returns the error, otherwise returns false.
2331 #false laziness w/ut_ipn
2333 my( $self, $field ) = @_;
2334 if ( $self->getfield($field) =~ /^()$/ ) {
2335 $self->setfield($field,'');
2338 $self->ut_float($field);
2342 =item ut_sfloat COLUMN
2344 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2345 May not be null. If there is an error, returns the error, otherwise returns
2351 my($self,$field)=@_ ;
2352 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2353 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2354 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2355 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2356 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2357 $self->setfield($field,$1);
2360 =item ut_sfloatn COLUMN
2362 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2363 null. If there is an error, returns the error, otherwise returns false.
2368 my( $self, $field ) = @_;
2369 if ( $self->getfield($field) =~ /^()$/ ) {
2370 $self->setfield($field,'');
2373 $self->ut_sfloat($field);
2377 =item ut_snumber COLUMN
2379 Check/untaint signed numeric data (whole numbers). If there is an error,
2380 returns the error, otherwise returns false.
2385 my($self, $field) = @_;
2386 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2387 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2388 $self->setfield($field, "$1$2");
2392 =item ut_snumbern COLUMN
2394 Check/untaint signed numeric data (whole numbers). If there is an error,
2395 returns the error, otherwise returns false.
2400 my($self, $field) = @_;
2401 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2402 or return "Illegal (numeric) $field: ". $self->getfield($field);
2404 return "Illegal (numeric) $field: ". $self->getfield($field)
2407 $self->setfield($field, "$1$2");
2411 =item ut_number COLUMN
2413 Check/untaint simple numeric data (whole numbers). May not be null. If there
2414 is an error, returns the error, otherwise returns false.
2419 my($self,$field)=@_;
2420 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2421 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2422 $self->setfield($field,$1);
2426 =item ut_numbern COLUMN
2428 Check/untaint simple numeric data (whole numbers). May be null. If there is
2429 an error, returns the error, otherwise returns false.
2434 my($self,$field)=@_;
2435 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2436 or return "Illegal (numeric) $field: ". $self->getfield($field);
2437 $self->setfield($field,$1);
2441 =item ut_decimal COLUMN[, DIGITS]
2443 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2444 error, returns the error, otherwise returns false.
2446 =item ut_decimaln COLUMN[, DIGITS]
2448 Check/untaint decimal numbers. May be null. If there is an error, returns
2449 the error, otherwise returns false.
2454 my($self, $field, $digits) = @_;
2456 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2457 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2458 $self->setfield($field, $1);
2463 my($self, $field, $digits) = @_;
2464 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2465 or return "Illegal (decimal) $field: ".$self->getfield($field);
2466 $self->setfield($field, $1);
2470 =item ut_money COLUMN
2472 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2473 is an error, returns the error, otherwise returns false.
2478 my($self,$field)=@_;
2480 if ( $self->getfield($field) eq '' ) {
2481 $self->setfield($field, 0);
2482 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2483 #handle one decimal place without barfing out
2484 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2485 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2486 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2488 return "Illegal (money) $field: ". $self->getfield($field);
2494 =item ut_moneyn COLUMN
2496 Check/untaint monetary numbers. May be negative. If there
2497 is an error, returns the error, otherwise returns false.
2502 my($self,$field)=@_;
2503 if ($self->getfield($field) eq '') {
2504 $self->setfield($field, '');
2507 $self->ut_money($field);
2510 =item ut_currencyn COLUMN
2512 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2513 is an error, returns the error, otherwise returns false.
2518 my($self, $field) = @_;
2519 if ($self->getfield($field) eq '') { #can be null
2520 $self->setfield($field, '');
2523 $self->ut_currency($field);
2526 =item ut_currency COLUMN
2528 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2529 there is an error, returns the error, otherwise returns false.
2534 my($self, $field) = @_;
2535 my $value = uc( $self->getfield($field) );
2536 if ( code2currency($value) ) {
2537 $self->setfield($value);
2539 return "Unknown currency $value";
2545 =item ut_text COLUMN
2547 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2548 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2549 May not be null. If there is an error, returns the error, otherwise returns
2555 my($self,$field)=@_;
2556 #warn "msgcat ". \&msgcat. "\n";
2557 #warn "notexist ". \¬exist. "\n";
2558 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2559 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2560 # see perldoc perluniprops
2561 $self->getfield($field)
2562 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2563 or return gettext('illegal_or_empty_text'). " $field: ".
2564 $self->getfield($field);
2565 $self->setfield($field,$1);
2569 =item ut_textn COLUMN
2571 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2572 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2573 May be null. If there is an error, returns the error, otherwise returns false.
2578 my($self,$field)=@_;
2579 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2580 $self->ut_text($field);
2583 =item ut_alpha COLUMN
2585 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2586 an error, returns the error, otherwise returns false.
2591 my($self,$field)=@_;
2592 $self->getfield($field) =~ /^(\w+)$/
2593 or return "Illegal or empty (alphanumeric) $field: ".
2594 $self->getfield($field);
2595 $self->setfield($field,$1);
2599 =item ut_alphan COLUMN
2601 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2602 error, returns the error, otherwise returns false.
2607 my($self,$field)=@_;
2608 $self->getfield($field) =~ /^(\w*)$/
2609 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2610 $self->setfield($field,$1);
2614 =item ut_alphasn COLUMN
2616 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2617 an error, returns the error, otherwise returns false.
2622 my($self,$field)=@_;
2623 $self->getfield($field) =~ /^([\w ]*)$/
2624 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2625 $self->setfield($field,$1);
2630 =item ut_alpha_lower COLUMN
2632 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2633 there is an error, returns the error, otherwise returns false.
2637 sub ut_alpha_lower {
2638 my($self,$field)=@_;
2639 $self->getfield($field) =~ /[[:upper:]]/
2640 and return "Uppercase characters are not permitted in $field";
2641 $self->ut_alpha($field);
2644 =item ut_phonen COLUMN [ COUNTRY ]
2646 Check/untaint phone numbers. May be null. If there is an error, returns
2647 the error, otherwise returns false.
2649 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2650 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2655 my( $self, $field, $country ) = @_;
2656 return $self->ut_alphan($field) unless defined $country;
2657 my $phonen = $self->getfield($field);
2658 if ( $phonen eq '' ) {
2659 $self->setfield($field,'');
2660 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2662 $phonen = $conf->config('cust_main-default_areacode').$phonen
2663 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2664 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2665 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2666 $phonen = "$1-$2-$3";
2667 $phonen .= " x$4" if $4;
2668 $self->setfield($field,$phonen);
2670 warn "warning: don't know how to check phone numbers for country $country";
2671 return $self->ut_textn($field);
2678 Check/untaint hexadecimal values.
2683 my($self, $field) = @_;
2684 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2685 or return "Illegal (hex) $field: ". $self->getfield($field);
2686 $self->setfield($field, uc($1));
2690 =item ut_hexn COLUMN
2692 Check/untaint hexadecimal values. May be null.
2697 my($self, $field) = @_;
2698 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2699 or return "Illegal (hex) $field: ". $self->getfield($field);
2700 $self->setfield($field, uc($1));
2704 =item ut_mac_addr COLUMN
2706 Check/untaint mac addresses. May be null.
2711 my($self, $field) = @_;
2713 my $mac = $self->get($field);
2716 $self->set($field, $mac);
2718 my $e = $self->ut_hex($field);
2721 return "Illegal (mac address) $field: ". $self->getfield($field)
2722 unless length($self->getfield($field)) == 12;
2728 =item ut_mac_addrn COLUMN
2730 Check/untaint mac addresses. May be null.
2735 my($self, $field) = @_;
2736 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2741 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2747 my( $self, $field ) = @_;
2748 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2749 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2750 or return "Illegal (IP address) $field: ". $self->getfield($field);
2751 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2752 $self->setfield($field, "$1.$2.$3.$4");
2758 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2759 to 127.0.0.1. May be null.
2764 my( $self, $field ) = @_;
2765 if ( $self->getfield($field) =~ /^()$/ ) {
2766 $self->setfield($field,'');
2769 $self->ut_ip($field);
2773 =item ut_ip46 COLUMN
2775 Check/untaint IPv4 or IPv6 address.
2780 my( $self, $field ) = @_;
2781 my $ip = NetAddr::IP->new($self->getfield($field))
2782 or return "Illegal (IP address) $field: ".$self->getfield($field);
2783 $self->setfield($field, lc($ip->addr));
2789 Check/untaint IPv6 or IPv6 address. May be null.
2794 my( $self, $field ) = @_;
2795 if ( $self->getfield($field) =~ /^$/ ) {
2796 $self->setfield($field, '');
2799 $self->ut_ip46($field);
2802 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2804 Check/untaint coordinates.
2805 Accepts the following forms:
2815 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2816 The latter form (that is, the MMM are thousands of minutes) is
2817 assumed if the "MMM" is exactly three digits or two digits > 59.
2819 To be safe, just use the DDD.DDDDD form.
2821 If LOWER or UPPER are specified, then the coordinate is checked
2822 for lower and upper bounds, respectively.
2827 my ($self, $field) = (shift, shift);
2830 if ( $field =~ /latitude/ ) {
2831 $lower = $lat_lower;
2833 } elsif ( $field =~ /longitude/ ) {
2835 $upper = $lon_upper;
2838 my $coord = $self->getfield($field);
2839 my $neg = $coord =~ s/^(-)//;
2841 my ($d, $m, $s) = (0, 0, 0);
2844 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2845 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2846 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2848 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2851 return "Invalid (coordinate with minutes > 59) $field: "
2852 . $self->getfield($field);
2855 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2857 if (defined($lower) and ($coord < $lower)) {
2858 return "Invalid (coordinate < $lower) $field: "
2859 . $self->getfield($field);;
2862 if (defined($upper) and ($coord > $upper)) {
2863 return "Invalid (coordinate > $upper) $field: "
2864 . $self->getfield($field);;
2867 $self->setfield($field, $coord);
2871 return "Invalid (coordinate) $field: " . $self->getfield($field);
2875 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2877 Same as ut_coord, except optionally null.
2883 my ($self, $field) = (shift, shift);
2885 if ($self->getfield($field) =~ /^\s*$/) {
2888 return $self->ut_coord($field, @_);
2893 =item ut_domain COLUMN
2895 Check/untaint host and domain names. May not be null.
2900 my( $self, $field ) = @_;
2901 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2902 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2903 or return "Illegal (hostname) $field: ". $self->getfield($field);
2904 $self->setfield($field,$1);
2908 =item ut_domainn COLUMN
2910 Check/untaint host and domain names. May be null.
2915 my( $self, $field ) = @_;
2916 if ( $self->getfield($field) =~ /^()$/ ) {
2917 $self->setfield($field,'');
2920 $self->ut_domain($field);
2924 =item ut_name COLUMN
2926 Check/untaint proper names; allows alphanumerics, spaces and the following
2927 punctuation: , . - '
2934 my( $self, $field ) = @_;
2935 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2936 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
2937 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2942 $self->setfield($field, $name);
2946 =item ut_namen COLUMN
2948 Check/untaint proper names; allows alphanumerics, spaces and the following
2949 punctuation: , . - '
2956 my( $self, $field ) = @_;
2957 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2958 $self->ut_name($field);
2963 Check/untaint zip codes.
2967 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2970 my( $self, $field, $country ) = @_;
2972 if ( $country eq 'US' ) {
2974 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2975 or return gettext('illegal_zip'). " $field for country $country: ".
2976 $self->getfield($field);
2977 $self->setfield($field, $1);
2979 } elsif ( $country eq 'CA' ) {
2981 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2982 or return gettext('illegal_zip'). " $field for country $country: ".
2983 $self->getfield($field);
2984 $self->setfield($field, "$1 $2");
2988 if ( $self->getfield($field) =~ /^\s*$/
2989 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2992 $self->setfield($field,'');
2994 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2995 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2996 $self->setfield($field,$1);
3004 =item ut_country COLUMN
3006 Check/untaint country codes. Country names are changed to codes, if possible -
3007 see L<Locale::Country>.
3012 my( $self, $field ) = @_;
3013 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3014 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3015 && country2code($1) ) {
3016 $self->setfield($field,uc(country2code($1)));
3019 $self->getfield($field) =~ /^(\w\w)$/
3020 or return "Illegal (country) $field: ". $self->getfield($field);
3021 $self->setfield($field,uc($1));
3025 =item ut_anything COLUMN
3027 Untaints arbitrary data. Be careful.
3032 my( $self, $field ) = @_;
3033 $self->getfield($field) =~ /^(.*)$/s
3034 or return "Illegal $field: ". $self->getfield($field);
3035 $self->setfield($field,$1);
3039 =item ut_enum COLUMN CHOICES_ARRAYREF
3041 Check/untaint a column, supplying all possible choices, like the "enum" type.
3046 my( $self, $field, $choices ) = @_;
3047 foreach my $choice ( @$choices ) {
3048 if ( $self->getfield($field) eq $choice ) {
3049 $self->setfield($field, $choice);
3053 return "Illegal (enum) field $field: ". $self->getfield($field);
3056 =item ut_enumn COLUMN CHOICES_ARRAYREF
3058 Like ut_enum, except the null value is also allowed.
3063 my( $self, $field, $choices ) = @_;
3064 $self->getfield($field)
3065 ? $self->ut_enum($field, $choices)
3069 =item ut_flag COLUMN
3071 Check/untaint a column if it contains either an empty string or 'Y'. This
3072 is the standard form for boolean flags in Freeside.
3077 my( $self, $field ) = @_;
3078 my $value = uc($self->getfield($field));
3079 if ( $value eq '' or $value eq 'Y' ) {
3080 $self->setfield($field, $value);
3083 return "Illegal (flag) field $field: $value";
3086 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3088 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3089 on the column first.
3093 sub ut_foreign_key {
3094 my( $self, $field, $table, $foreign ) = @_;
3095 return '' if $no_check_foreign;
3096 qsearchs($table, { $foreign => $self->getfield($field) })
3097 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3098 " in $table.$foreign";
3102 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3104 Like ut_foreign_key, except the null value is also allowed.
3108 sub ut_foreign_keyn {
3109 my( $self, $field, $table, $foreign ) = @_;
3110 $self->getfield($field)
3111 ? $self->ut_foreign_key($field, $table, $foreign)
3115 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3117 Checks this column as an agentnum, taking into account the current users's
3118 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3119 right or rights allowing no agentnum.
3123 sub ut_agentnum_acl {
3124 my( $self, $field ) = (shift, shift);
3125 my $null_acl = scalar(@_) ? shift : [];
3126 $null_acl = [ $null_acl ] unless ref($null_acl);
3128 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3129 return "Illegal agentnum: $error" if $error;
3131 my $curuser = $FS::CurrentUser::CurrentUser;
3133 if ( $self->$field() ) {
3135 return "Access denied"
3136 unless $curuser->agentnum($self->$field());
3140 return "Access denied"
3141 unless grep $curuser->access_right($_), @$null_acl;
3149 =item fields [ TABLE ]
3151 This is a wrapper for real_fields. Code that called
3152 fields before should probably continue to call fields.
3157 my $something = shift;
3159 if($something->isa('FS::Record')) {
3160 $table = $something->table;
3162 $table = $something;
3163 $something = "FS::$table";
3165 return (real_fields($table));
3169 =item encrypt($value)
3171 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3173 Returns the encrypted string.
3175 You should generally not have to worry about calling this, as the system handles this for you.
3180 my ($self, $value) = @_;
3181 my $encrypted = $value;
3183 if ($conf->exists('encryption')) {
3184 if ($self->is_encrypted($value)) {
3185 # Return the original value if it isn't plaintext.
3186 $encrypted = $value;
3189 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3190 # RSA doesn't like the empty string so let's pack it up
3191 # The database doesn't like the RSA data so uuencode it
3192 my $length = length($value)+1;
3193 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3195 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3202 =item is_encrypted($value)
3204 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3210 my ($self, $value) = @_;
3211 # could be more precise about it, but this will do for now
3212 $value =~ /^M/ && length($value) > 80;
3215 =item decrypt($value)
3217 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3219 You should generally not have to worry about calling this, as the system handles this for you.
3224 my ($self,$value) = @_;
3225 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3226 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
3228 if (ref($rsa_decrypt) =~ /::RSA/) {
3229 my $encrypted = unpack ("u*", $value);
3230 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3231 if ($@) {warn "Decryption Failed"};
3239 #Initialize the Module
3240 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3242 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
3243 $rsa_module = $conf->config('encryptionmodule');
3247 eval ("require $rsa_module"); # No need to import the namespace
3250 # Initialize Encryption
3251 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
3252 my $public_key = join("\n",$conf->config('encryptionpublickey'));
3253 $rsa_encrypt = $rsa_module->new_public_key($public_key);
3256 # Intitalize Decryption
3257 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
3258 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
3259 $rsa_decrypt = $rsa_module->new_private_key($private_key);
3263 =item h_search ACTION
3265 Given an ACTION, either "insert", or "delete", returns the appropriate history
3266 record corresponding to this record, if any.
3271 my( $self, $action ) = @_;
3273 my $table = $self->table;
3276 my $primary_key = dbdef->table($table)->primary_key;
3279 'table' => "h_$table",
3280 'hashref' => { $primary_key => $self->$primary_key(),
3281 'history_action' => $action,
3289 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3290 appropriate history record corresponding to this record, if any.
3295 my($self, $action) = @_;
3296 my $h = $self->h_search($action);
3297 $h ? $h->history_date : '';
3300 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3302 A class or object method. Executes the sql statement represented by SQL and
3303 returns a scalar representing the result: the first column of the first row.
3305 Dies on bogus SQL. Returns an empty string if no row is returned.
3307 Typically used for statments which return a single value such as "SELECT
3308 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3313 my($self, $sql) = (shift, shift);
3314 my $sth = dbh->prepare($sql) or die dbh->errstr;
3316 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3317 my $row = $sth->fetchrow_arrayref or return '';
3318 my $scalar = $row->[0];
3319 defined($scalar) ? $scalar : '';
3322 =item count [ WHERE [, PLACEHOLDER ...] ]
3324 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3325 with optional WHERE. Must be called as method on a class with an
3331 my($self, $where) = (shift, shift);
3332 my $table = $self->table or die 'count called on object of class '.ref($self);
3333 my $sql = "SELECT COUNT(*) FROM $table";
3334 $sql .= " WHERE $where" if $where;
3335 $self->scalar_sql($sql, @_);
3344 =item real_fields [ TABLE ]
3346 Returns a list of the real columns in the specified table. Called only by
3347 fields() and other subroutines elsewhere in FS::Record.
3354 my($table_obj) = dbdef->table($table);
3355 confess "Unknown table $table" unless $table_obj;
3356 $table_obj->columns;
3359 =item pvf FIELD_NAME
3361 Returns the FS::part_virtual_field object corresponding to a field in the
3362 record (specified by FIELD_NAME).
3367 my ($self, $name) = (shift, shift);
3369 if(grep /^$name$/, $self->virtual_fields) {
3371 my $concat = [ "'cf_'", "name" ];
3372 return qsearchs({ table => 'part_virtual_field',
3373 hashref => { dbtable => $self->table,
3376 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3382 =item _quote VALUE, TABLE, COLUMN
3384 This is an internal function used to construct SQL statements. It returns
3385 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3386 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3391 my($value, $table, $column) = @_;
3392 my $column_obj = dbdef->table($table)->column($column);
3393 my $column_type = $column_obj->type;
3394 my $nullable = $column_obj->null;
3396 utf8::upgrade($value);
3398 warn " $table.$column: $value ($column_type".
3399 ( $nullable ? ' NULL' : ' NOT NULL' ).
3400 ")\n" if $DEBUG > 2;
3402 if ( $value eq '' && $nullable ) {
3404 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3405 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3408 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3409 ! $column_type =~ /(char|binary|text)$/i ) {
3411 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3412 && driver_name eq 'Pg'
3416 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3417 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3418 # single-quote the whole mess, and put an "E" in front.
3419 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3427 This is deprecated. Don't use it.
3429 It returns a hash-type list with the fields of this record's table set true.
3434 carp "warning: hfields is deprecated";
3437 foreach (fields($table)) {
3446 "$_: ". $self->getfield($_). "|"
3447 } (fields($self->table)) );
3450 sub DESTROY { return; }
3454 # #use Carp qw(cluck);
3455 # #cluck "DESTROYING $self";
3456 # warn "DESTROYING $self";
3460 # return ! eval { join('',@_), kill 0; 1; };
3463 =item str2time_sql [ DRIVER_NAME ]
3465 Returns a function to convert to unix time based on database type, such as
3466 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3467 the str2time_sql_closing method to return a closing string rather than just
3468 using a closing parenthesis as previously suggested.
3470 You can pass an optional driver name such as "Pg", "mysql" or
3471 $dbh->{Driver}->{Name} to return a function for that database instead of
3472 the current database.
3477 my $driver = shift || driver_name;
3479 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3480 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3482 warn "warning: unknown database type $driver; guessing how to convert ".
3483 "dates to UNIX timestamps";
3484 return 'EXTRACT(EPOCH FROM ';
3488 =item str2time_sql_closing [ DRIVER_NAME ]
3490 Returns the closing suffix of a function to convert to unix time based on
3491 database type, such as ")::integer" for Pg or ")" for mysql.
3493 You can pass an optional driver name such as "Pg", "mysql" or
3494 $dbh->{Driver}->{Name} to return a function for that database instead of
3495 the current database.
3499 sub str2time_sql_closing {
3500 my $driver = shift || driver_name;
3502 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3506 =item regexp_sql [ DRIVER_NAME ]
3508 Returns the operator to do a regular expression comparison based on database
3509 type, such as '~' for Pg or 'REGEXP' for mysql.
3511 You can pass an optional driver name such as "Pg", "mysql" or
3512 $dbh->{Driver}->{Name} to return a function for that database instead of
3513 the current database.
3518 my $driver = shift || driver_name;
3520 return '~' if $driver =~ /^Pg/i;
3521 return 'REGEXP' if $driver =~ /^mysql/i;
3523 die "don't know how to use regular expressions in ". driver_name." databases";
3527 =item not_regexp_sql [ DRIVER_NAME ]
3529 Returns the operator to do a regular expression negation based on database
3530 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3532 You can pass an optional driver name such as "Pg", "mysql" or
3533 $dbh->{Driver}->{Name} to return a function for that database instead of
3534 the current database.
3538 sub not_regexp_sql {
3539 my $driver = shift || driver_name;
3541 return '!~' if $driver =~ /^Pg/i;
3542 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3544 die "don't know how to use regular expressions in ". driver_name." databases";
3548 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3550 Returns the items concatenated based on database type, using "CONCAT()" for
3551 mysql and " || " for Pg and other databases.
3553 You can pass an optional driver name such as "Pg", "mysql" or
3554 $dbh->{Driver}->{Name} to return a function for that database instead of
3555 the current database.
3560 my $driver = ref($_[0]) ? driver_name : shift;
3563 if ( $driver =~ /^mysql/i ) {
3564 'CONCAT('. join(',', @$items). ')';
3566 join('||', @$items);
3571 =item midnight_sql DATE
3573 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3574 on that day in the system timezone, using the default driver name.
3579 my $driver = driver_name;
3581 if ( $driver =~ /^mysql/i ) {
3582 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3585 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3593 This module should probably be renamed, since much of the functionality is
3594 of general use. It is not completely unlike Adapter::DBI (see below).
3596 Exported qsearch and qsearchs should be deprecated in favor of method calls
3597 (against an FS::Record object like the old search and searchs that qsearch
3598 and qsearchs were on top of.)
3600 The whole fields / hfields mess should be removed.
3602 The various WHERE clauses should be subroutined.
3604 table string should be deprecated in favor of DBIx::DBSchema::Table.
3606 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3607 true maps to the database (and WHERE clauses) would also help.
3609 The ut_ methods should ask the dbdef for a default length.
3611 ut_sqltype (like ut_varchar) should all be defined
3613 A fallback check method should be provided which uses the dbdef.
3615 The ut_money method assumes money has two decimal digits.
3617 The Pg money kludge in the new method only strips `$'.
3619 The ut_phonen method only checks US-style phone numbers.
3621 The _quote function should probably use ut_float instead of a regex.
3623 All the subroutines probably should be methods, here or elsewhere.
3625 Probably should borrow/use some dbdef methods where appropriate (like sub
3628 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3629 or allow it to be set. Working around it is ugly any way around - DBI should
3630 be fixed. (only affects RDBMS which return uppercase column names)
3632 ut_zip should take an optional country like ut_phone.
3636 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3638 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.