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_snumber('column');
128 $error = $record->ut_snumbern('column');
129 $error = $record->ut_money('column');
130 $error = $record->ut_text('column');
131 $error = $record->ut_textn('column');
132 $error = $record->ut_alpha('column');
133 $error = $record->ut_alphan('column');
134 $error = $record->ut_phonen('column');
135 $error = $record->ut_anything('column');
136 $error = $record->ut_name('column');
138 $quoted_value = _quote($value,'table','field');
141 $fields = hfields('table');
142 if ( $fields->{Field} ) { # etc.
144 @fields = fields 'table'; #as a subroutine
145 @fields = $record->fields; #as a method call
150 (Mostly) object-oriented interface to database records. Records are currently
151 implemented on top of DBI. FS::Record is intended as a base class for
152 table-specific classes to inherit from, i.e. FS::cust_main.
158 =item new [ TABLE, ] HASHREF
160 Creates a new record. It doesn't store it in the database, though. See
161 L<"insert"> for that.
163 Note that the object stores this hash reference, not a distinct copy of the
164 hash it points to. You can ask the object for a copy with the I<hash>
167 TABLE can only be omitted when a dervived class overrides the table method.
173 my $class = ref($proto) || $proto;
175 bless ($self, $class);
177 unless ( defined ( $self->table ) ) {
178 $self->{'Table'} = shift;
179 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
180 unless $nowarn_classload;
183 $self->{'Hash'} = shift;
185 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
186 $self->{'Hash'}{$field}='';
189 $self->_rebless if $self->can('_rebless');
191 $self->{'modified'} = 0;
193 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
200 my $class = ref($proto) || $proto;
202 bless ($self, $class);
204 $self->{'Table'} = shift unless defined ( $self->table );
206 my $hashref = $self->{'Hash'} = shift;
208 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
209 my $obj = $cache->cache->{$hashref->{$cache->key}};
210 $obj->_cache($hashref, $cache) if $obj->can('_cache');
213 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
220 my $class = ref($proto) || $proto;
222 bless ($self, $class);
223 if ( defined $self->table ) {
224 cluck "create constructor is deprecated, use new!";
227 croak "FS::Record::create called (not from a subclass)!";
231 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
233 Searches the database for all records matching (at least) the key/value pairs
234 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
235 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
238 The preferred usage is to pass a hash reference of named parameters:
240 @records = qsearch( {
241 'table' => 'table_name',
242 'hashref' => { 'field' => 'value'
243 'field' => { 'op' => '<',
248 #these are optional...
250 'extra_sql' => 'AND field = ? AND intfield = ?',
251 'extra_param' => [ 'value', [ 5, 'int' ] ],
252 'order_by' => 'ORDER BY something',
253 #'cache_obj' => '', #optional
254 'addl_from' => 'LEFT JOIN othtable USING ( field )',
259 Much code still uses old-style positional parameters, this is also probably
260 fine in the common case where there are only two parameters:
262 my @records = qsearch( 'table', { 'field' => 'value' } );
264 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
265 the individual PARAMS_HASHREF queries
267 ###oops, argh, FS::Record::new only lets us create database fields.
268 #Normal behaviour if SELECT is not specified is `*', as in
269 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
270 #feature where you can specify SELECT - remember, the objects returned,
271 #although blessed into the appropriate `FS::TABLE' package, will only have the
272 #fields you specify. This might have unwanted results if you then go calling
273 #regular FS::TABLE methods
278 my %TYPE = (); #for debugging
281 my($type, $value) = @_;
283 my $bind_type = { TYPE => SQL_VARCHAR };
285 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
287 $bind_type = { TYPE => SQL_INTEGER };
289 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
291 if ( driver_name eq 'Pg' ) {
293 $bind_type = { pg_type => PG_BYTEA };
295 # $bind_type = ? #SQL_VARCHAR could be fine?
298 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
299 #fixed by DBD::Pg 2.11.8
300 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
301 #(make a Tron test first)
302 } elsif ( _is_fs_float( $type, $value ) ) {
304 $bind_type = { TYPE => SQL_DECIMAL };
313 my($type, $value) = @_;
314 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
315 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
323 my( @stable, @record, @cache );
324 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
326 my %union_options = ();
327 if ( ref($_[0]) eq 'ARRAY' ) {
330 foreach my $href ( @$optlist ) {
331 push @stable, ( $href->{'table'} or die "table name is required" );
332 push @record, ( $href->{'hashref'} || {} );
333 push @select, ( $href->{'select'} || '*' );
334 push @extra_sql, ( $href->{'extra_sql'} || '' );
335 push @extra_param, ( $href->{'extra_param'} || [] );
336 push @order_by, ( $href->{'order_by'} || '' );
337 push @cache, ( $href->{'cache_obj'} || '' );
338 push @addl_from, ( $href->{'addl_from'} || '' );
339 push @debug, ( $href->{'debug'} || '' );
341 die "at least one hashref is required" unless scalar(@stable);
342 } elsif ( ref($_[0]) eq 'HASH' ) {
344 $stable[0] = $opt->{'table'} or die "table name is required";
345 $record[0] = $opt->{'hashref'} || {};
346 $select[0] = $opt->{'select'} || '*';
347 $extra_sql[0] = $opt->{'extra_sql'} || '';
348 $extra_param[0] = $opt->{'extra_param'} || [];
349 $order_by[0] = $opt->{'order_by'} || '';
350 $cache[0] = $opt->{'cache_obj'} || '';
351 $addl_from[0] = $opt->{'addl_from'} || '';
352 $debug[0] = $opt->{'debug'} || '';
363 my $cache = $cache[0];
369 foreach my $stable ( @stable ) {
371 carp '->qsearch on cust_main called' if $stable eq 'cust_main' && $DEBUG;
373 #stop altering the caller's hashref
374 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
375 my $select = shift @select;
376 my $extra_sql = shift @extra_sql;
377 my $extra_param = shift @extra_param;
378 my $order_by = shift @order_by;
379 my $cache = shift @cache;
380 my $addl_from = shift @addl_from;
381 my $debug = shift @debug;
383 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
385 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
388 my $table = $cache ? $cache->table : $stable;
389 my $dbdef_table = dbdef->table($table)
390 or die "No schema for table $table found - ".
391 "do you need to run freeside-upgrade?";
392 my $pkey = $dbdef_table->primary_key;
394 my @real_fields = grep exists($record->{$_}), real_fields($table);
396 my $statement .= "SELECT $select FROM $stable";
397 $statement .= " $addl_from" if $addl_from;
398 if ( @real_fields ) {
399 $statement .= ' WHERE '. join(' AND ',
400 get_real_fields($table, $record, \@real_fields));
403 $statement .= " $extra_sql" if defined($extra_sql);
404 $statement .= " $order_by" if defined($order_by);
406 push @statement, $statement;
408 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
412 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
415 my $value = $record->{$field};
416 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
417 $value = $value->{'value'} if ref($value);
418 my $type = dbdef->table($table)->column($field)->type;
420 my $bind_type = _bind_type($type, $value);
424 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
426 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
430 push @bind_type, $bind_type;
434 foreach my $param ( @$extra_param ) {
435 my $bind_type = { TYPE => SQL_VARCHAR };
438 $value = $param->[0];
439 my $type = $param->[1];
440 $bind_type = _bind_type($type, $value);
443 push @bind_type, $bind_type;
447 my $statement = join( ' ) UNION ( ', @statement );
448 $statement = "( $statement )" if scalar(@statement) > 1;
449 $statement .= " $union_options{order_by}" if $union_options{order_by};
451 my $sth = $dbh->prepare($statement)
452 or croak "$dbh->errstr doing $statement";
455 foreach my $value ( @value ) {
456 my $bind_type = shift @bind_type;
457 $sth->bind_param($bind++, $value, $bind_type );
460 # $sth->execute( map $record->{$_},
461 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
462 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
464 my $ok = $sth->execute;
466 my $error = "Error executing \"$statement\"";
467 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
468 $error .= ': '. $sth->errstr;
472 my $table = $stable[0];
474 $table = '' if grep { $_ ne $table } @stable;
475 $pkey = dbdef->table($table)->primary_key if $table;
478 tie %result, "Tie::IxHash";
479 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
480 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
481 %result = map { $_->{$pkey}, $_ } @stuff;
483 @result{@stuff} = @stuff;
489 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
490 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
491 #derivied class didn't override new method, so this optimization is safe
494 new_or_cached( "FS::$table", { %{$_} }, $cache )
498 new( "FS::$table", { %{$_} } )
502 #okay, its been tested
503 # warn "untested code (class FS::$table uses custom new method)";
505 eval 'FS::'. $table. '->new( { %{$_} } )';
509 # Check for encrypted fields and decrypt them.
510 ## only in the local copy, not the cached object
511 if ( $conf_encryption
512 && eval '@FS::'. $table . '::encrypted_fields' ) {
513 foreach my $record (@return) {
514 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
515 next if $field eq 'payinfo'
516 && ($record->isa('FS::payinfo_transaction_Mixin')
517 || $record->isa('FS::payinfo_Mixin') )
519 && !grep { $record->payby eq $_ } @encrypt_payby;
520 # Set it directly... This may cause a problem in the future...
521 $record->setfield($field, $record->decrypt($record->getfield($field)));
526 cluck "warning: FS::$table not loaded; returning FS::Record objects"
527 unless $nowarn_classload;
529 FS::Record->new( $table, { %{$_} } );
537 Construct the SQL statement and parameter-binding list for qsearch. Takes
538 the qsearch parameters.
540 Returns a hash containing:
541 'table': The primary table name (if there is one).
542 'statement': The SQL statement itself.
543 'bind_type': An arrayref of bind types.
544 'value': An arrayref of parameter values.
545 'cache': The cache object, if one was passed.
550 my( @stable, @record, @cache );
551 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
554 my %union_options = ();
555 if ( ref($_[0]) eq 'ARRAY' ) {
558 foreach my $href ( @$optlist ) {
559 push @stable, ( $href->{'table'} or die "table name is required" );
560 push @record, ( $href->{'hashref'} || {} );
561 push @select, ( $href->{'select'} || '*' );
562 push @extra_sql, ( $href->{'extra_sql'} || '' );
563 push @extra_param, ( $href->{'extra_param'} || [] );
564 push @order_by, ( $href->{'order_by'} || '' );
565 push @cache, ( $href->{'cache_obj'} || '' );
566 push @addl_from, ( $href->{'addl_from'} || '' );
567 push @debug, ( $href->{'debug'} || '' );
569 die "at least one hashref is required" unless scalar(@stable);
570 } elsif ( ref($_[0]) eq 'HASH' ) {
572 $stable[0] = $opt->{'table'} or die "table name is required";
573 $record[0] = $opt->{'hashref'} || {};
574 $select[0] = $opt->{'select'} || '*';
575 $extra_sql[0] = $opt->{'extra_sql'} || '';
576 $extra_param[0] = $opt->{'extra_param'} || [];
577 $order_by[0] = $opt->{'order_by'} || '';
578 $cache[0] = $opt->{'cache_obj'} || '';
579 $addl_from[0] = $opt->{'addl_from'} || '';
580 $debug[0] = $opt->{'debug'} || '';
591 my $cache = $cache[0];
597 my $result_table = $stable[0];
598 foreach my $stable ( @stable ) {
599 #stop altering the caller's hashref
600 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
601 my $select = shift @select;
602 my $extra_sql = shift @extra_sql;
603 my $extra_param = shift @extra_param;
604 my $order_by = shift @order_by;
605 my $cache = shift @cache;
606 my $addl_from = shift @addl_from;
607 my $debug = shift @debug;
609 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
611 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
614 $result_table = '' if $result_table ne $stable;
616 my $table = $cache ? $cache->table : $stable;
617 my $dbdef_table = dbdef->table($table)
618 or die "No schema for table $table found - ".
619 "do you need to run freeside-upgrade?";
620 my $pkey = $dbdef_table->primary_key;
622 my @real_fields = grep exists($record->{$_}), real_fields($table);
624 my $statement .= "SELECT $select FROM $stable";
625 $statement .= " $addl_from" if $addl_from;
626 if ( @real_fields ) {
627 $statement .= ' WHERE '. join(' AND ',
628 get_real_fields($table, $record, \@real_fields));
631 $statement .= " $extra_sql" if defined($extra_sql);
632 $statement .= " $order_by" if defined($order_by);
634 push @statement, $statement;
636 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
640 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
643 my $value = $record->{$field};
644 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
645 $value = $value->{'value'} if ref($value);
646 my $type = dbdef->table($table)->column($field)->type;
648 my $bind_type = _bind_type($type, $value);
652 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
654 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
658 push @bind_type, $bind_type;
662 foreach my $param ( @$extra_param ) {
663 my $bind_type = { TYPE => SQL_VARCHAR };
666 $value = $param->[0];
667 my $type = $param->[1];
668 $bind_type = _bind_type($type, $value);
671 push @bind_type, $bind_type;
675 my $statement = join( ' ) UNION ( ', @statement );
676 $statement = "( $statement )" if scalar(@statement) > 1;
677 $statement .= " $union_options{order_by}" if $union_options{order_by};
680 statement => $statement,
681 bind_type => \@bind_type,
683 table => $result_table,
688 # qsearch should eventually use this
690 my ($table, $cache, @hashrefs) = @_;
692 # XXX get rid of these string evals at some point
693 # (when we have time to test it)
694 # my $class = "FS::$table" if $table;
695 # if ( $class and $class->isa('FS::Record') )
696 # if ( $class->can('new') eq \&new )
698 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
699 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
700 #derivied class didn't override new method, so this optimization is safe
703 new_or_cached( "FS::$table", { %{$_} }, $cache )
707 new( "FS::$table", { %{$_} } )
711 #okay, its been tested
712 # warn "untested code (class FS::$table uses custom new method)";
714 eval 'FS::'. $table. '->new( { %{$_} } )';
718 # Check for encrypted fields and decrypt them.
719 ## only in the local copy, not the cached object
720 if ( $conf_encryption
721 && eval '@FS::'. $table . '::encrypted_fields' ) {
722 foreach my $record (@return) {
723 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
724 next if $field eq 'payinfo'
725 && ($record->isa('FS::payinfo_transaction_Mixin')
726 || $record->isa('FS::payinfo_Mixin') )
728 && !grep { $record->payby eq $_ } @encrypt_payby;
729 # Set it directly... This may cause a problem in the future...
730 $record->setfield($field, $record->decrypt($record->getfield($field)));
735 cluck "warning: FS::$table not loaded; returning FS::Record objects"
736 unless $nowarn_classload;
738 FS::Record->new( $table, { %{$_} } );
744 ## makes this easier to read
746 sub get_real_fields {
749 my $real_fields = shift;
751 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
757 my $type = dbdef->table($table)->column($column)->type;
758 my $value = $record->{$column};
759 $value = $value->{'value'} if ref($value);
760 if ( ref($record->{$_}) ) {
761 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
762 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
763 if ( uc($op) eq 'ILIKE' ) {
765 $record->{$_}{'value'} = lc($record->{$_}{'value'});
766 $column = "LOWER($_)";
768 $record->{$_} = $record->{$_}{'value'}
771 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
773 if ( driver_name eq 'Pg' ) {
774 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
775 qq-( $column IS NULL )-;
777 qq-( $column IS NULL OR $column = '' )-;
780 qq-( $column IS NULL OR $column = "" )-;
782 } elsif ( $op eq '!=' ) {
783 if ( driver_name eq 'Pg' ) {
784 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
785 qq-( $column IS NOT NULL )-;
787 qq-( $column IS NOT NULL AND $column != '' )-;
790 qq-( $column IS NOT NULL AND $column != "" )-;
793 if ( driver_name eq 'Pg' ) {
794 qq-( $column $op '' )-;
796 qq-( $column $op "" )-;
799 } elsif ( $op eq '!=' ) {
800 qq-( $column IS NULL OR $column != ? )-;
801 #if this needs to be re-enabled, it needs to use a custom op like
802 #"APPROX=" or something (better name?, not '=', to avoid affecting other
804 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
805 # ( "$column <= ?", "$column >= ?" );
809 } @{ $real_fields } );
812 =item by_key PRIMARY_KEY_VALUE
814 This is a class method that returns the record with the given primary key
815 value. This method is only useful in FS::Record subclasses. For example:
817 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
821 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
826 my ($class, $pkey_value) = @_;
828 my $table = $class->table
829 or croak "No table for $class found";
831 my $dbdef_table = dbdef->table($table)
832 or die "No schema for table $table found - ".
833 "do you need to create it or run dbdef-create?";
834 my $pkey = $dbdef_table->primary_key
835 or die "No primary key for table $table";
837 return qsearchs($table, { $pkey => $pkey_value });
840 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
842 Experimental JOINed search method. Using this method, you can execute a
843 single SELECT spanning multiple tables, and cache the results for subsequent
844 method calls. Interface will almost definately change in an incompatible
852 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
853 my $cache = FS::SearchCache->new( $ptable, $pkey );
856 grep { !$saw{$_->getfield($pkey)}++ }
857 qsearch($table, $record, $select, $extra_sql, $cache )
861 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
863 Same as qsearch, except that if more than one record matches, it B<carp>s but
864 returns the first. If this happens, you either made a logic error in asking
865 for a single item, or your data is corrupted.
869 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
871 my(@result) = qsearch(@_);
872 cluck "warning: Multiple records in scalar search ($table)"
873 if scalar(@result) > 1;
874 #should warn more vehemently if the search was on a primary key?
875 scalar(@result) ? ($result[0]) : ();
886 Returns the table name.
891 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
898 Returns the DBIx::DBSchema::Table object for the table.
904 my($table)=$self->table;
905 dbdef->table($table);
910 Returns the primary key for the table.
916 my $pkey = $self->dbdef_table->primary_key;
919 =item get, getfield COLUMN
921 Returns the value of the column/field/key COLUMN.
926 my($self,$field) = @_;
927 # to avoid "Use of unitialized value" errors
928 if ( defined ( $self->{Hash}->{$field} ) ) {
929 $self->{Hash}->{$field};
939 =item set, setfield COLUMN, VALUE
941 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
946 my($self,$field,$value) = @_;
947 $self->{'modified'} = 1;
948 $self->{'Hash'}->{$field} = $value;
957 Returns true if the column/field/key COLUMN exists.
962 my($self,$field) = @_;
963 exists($self->{Hash}->{$field});
966 =item AUTLOADED METHODS
968 $record->column is a synonym for $record->get('column');
970 $record->column('value') is a synonym for $record->set('column','value');
972 $record->foreign_table_name calls qsearchs and returns a single
973 FS::foreign_table record (for tables referenced by a column of this table) or
974 qsearch and returns an array of FS::foreign_table records (for tables
975 referenced by a column in the foreign table).
982 my($field)=$AUTOLOAD;
985 confess "errant AUTOLOAD $field for $self (arg $value)"
986 unless blessed($self) && $self->can('setfield');
988 #$fk_method_cache{$self->table} ||= fk_methods($self->table);
989 if ( exists($fk_method_cache{$self->table}->{$field}) ) {
991 my $fk_info = $fk_method_cache{$self->table}->{$field};
992 my $method = $fk_info->{method} || 'qsearchs';
993 my $table = $fk_info->{table} || $field;
994 my $column = $fk_info->{column};
995 my $foreign_column = $fk_info->{references} || $column;
997 eval "use FS::$table";
1000 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1002 my $pkey_value = $self->$column();
1003 my %search = ( $foreign_column => $pkey_value );
1005 # FS::Record->$method() ? they're actually just subs :/
1006 if ( $method eq 'qsearchs' ) {
1007 return $pkey_value ? qsearchs( $table, \%search ) : '';
1008 } elsif ( $method eq 'qsearch' ) {
1009 return $pkey_value ? qsearch( $table, \%search ) : ();
1011 die "unknown method $method";
1016 if ( defined($value) ) {
1017 $self->setfield($field,$value);
1019 $self->getfield($field);
1023 # efficient (also, old, doesn't support FK stuff)
1025 # my $field = $AUTOLOAD;
1026 # $field =~ s/.*://;
1027 # if ( defined($_[1]) ) {
1028 # $_[0]->setfield($field, $_[1]);
1030 # $_[0]->getfield($field);
1039 # foreign keys we reference in other tables
1040 foreach my $fk (dbdef->table($table)->foreign_keys) {
1043 if ( scalar( @{$fk->columns} ) == 1 ) {
1044 if ( ! @{$fk->references} || $fk->columns->[0] eq $fk->references->[0] ){
1045 $method = $fk->table;
1047 #some sort of hint in the table.pm or schema for methods not named
1048 # after their foreign table (well, not a whole lot different than
1049 # just providing a small subroutine...)
1053 $hash{$method} = { #fk_info
1054 'method' => 'qsearchs',
1055 'column' => $fk->columns->[0],
1056 #'references' => $fk->references->[0],
1064 # foreign keys referenced in other tables to us
1065 # (alas. why we're cached. still, might this loop better be done once at
1066 # schema load time insetad of every time we AUTOLOAD a method on a new
1068 foreach my $f_table ( dbdef->tables ) {
1069 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1071 next unless $fk->table eq $table;
1074 if ( scalar( @{$fk->columns} ) == 1 ) {
1075 if ( ! @{$fk->references} || $fk->columns->[0] eq $fk->references->[0] ){
1078 #some sort of hint in the table.pm or schema for methods not named
1079 # after their foreign table (well, not a whole lot different than
1080 # just providing a small subroutine...)
1084 $hash{$method} = { #fk_info
1085 'method' => 'qsearch',
1086 'column' => $fk->columns->[0], #references||column
1087 #'references' => $fk->column->[0],
1102 Returns a list of the column/value pairs, usually for assigning to a new hash.
1104 To make a distinct duplicate of an FS::Record object, you can do:
1106 $new = new FS::Record ( $old->table, { $old->hash } );
1112 confess $self. ' -> hash: Hash attribute is undefined'
1113 unless defined($self->{'Hash'});
1114 %{ $self->{'Hash'} };
1119 Returns a reference to the column/value hash. This may be deprecated in the
1120 future; if there's a reason you can't just use the autoloaded or get/set
1133 +{ ( map { $_=>$self->$_ } $self->fields ),
1139 Returns true if any of this object's values have been modified with set (or via
1140 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1147 $self->{'modified'};
1150 =item select_for_update
1152 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1157 sub select_for_update {
1159 my $primary_key = $self->primary_key;
1162 'table' => $self->table,
1163 'hashref' => { $primary_key => $self->$primary_key() },
1164 'extra_sql' => 'FOR UPDATE',
1170 Locks this table with a database-driver specific lock method. This is used
1171 as a mutex in order to do a duplicate search.
1173 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1175 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1177 Errors are fatal; no useful return value.
1179 Note: To use this method for new tables other than svc_acct and svc_phone,
1180 edit freeside-upgrade and add those tables to the duplicate_lock list.
1186 my $table = $self->table;
1188 warn "$me locking $table table\n" if $DEBUG;
1190 if ( driver_name =~ /^Pg/i ) {
1192 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1195 } elsif ( driver_name =~ /^mysql/i ) {
1197 dbh->do("SELECT * FROM duplicate_lock
1198 WHERE lockname = '$table'
1200 ) or die dbh->errstr;
1204 die "unknown database ". driver_name. "; don't know how to lock table";
1208 warn "$me acquired $table table lock\n" if $DEBUG;
1214 Inserts this record to the database. If there is an error, returns the error,
1215 otherwise returns false.
1223 warn "$self -> insert" if $DEBUG;
1225 my $error = $self->check;
1226 return $error if $error;
1228 #single-field non-null unique keys are given a value if empty
1229 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1230 foreach ( $self->dbdef_table->unique_singles) {
1231 next if $self->getfield($_);
1232 next if $self->dbdef_table->column($_)->null eq 'NULL';
1236 #and also the primary key, if the database isn't going to
1237 my $primary_key = $self->dbdef_table->primary_key;
1239 if ( $primary_key ) {
1240 my $col = $self->dbdef_table->column($primary_key);
1243 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1244 || ( driver_name eq 'Pg'
1245 && defined($col->default)
1246 && $col->quoted_default =~ /^nextval\(/i
1248 || ( driver_name eq 'mysql'
1249 && defined($col->local)
1250 && $col->local =~ /AUTO_INCREMENT/i
1252 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1255 my $table = $self->table;
1257 # Encrypt before the database
1258 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
1259 && scalar( eval '@FS::'. $table . '::encrypted_fields')
1260 && $conf->exists('encryption')
1262 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1263 next if $field eq 'payinfo'
1264 && ($self->isa('FS::payinfo_transaction_Mixin')
1265 || $self->isa('FS::payinfo_Mixin') )
1267 && !grep { $self->payby eq $_ } @encrypt_payby;
1268 $saved->{$field} = $self->getfield($field);
1269 $self->setfield($field, $self->encrypt($self->getfield($field)));
1273 #false laziness w/delete
1275 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1278 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1281 my $statement = "INSERT INTO $table ";
1282 if ( @real_fields ) {
1285 join( ', ', @real_fields ).
1287 join( ', ', @values ).
1291 $statement .= 'DEFAULT VALUES';
1293 warn "[debug]$me $statement\n" if $DEBUG > 1;
1294 my $sth = dbh->prepare($statement) or return dbh->errstr;
1296 local $SIG{HUP} = 'IGNORE';
1297 local $SIG{INT} = 'IGNORE';
1298 local $SIG{QUIT} = 'IGNORE';
1299 local $SIG{TERM} = 'IGNORE';
1300 local $SIG{TSTP} = 'IGNORE';
1301 local $SIG{PIPE} = 'IGNORE';
1303 $sth->execute or return $sth->errstr;
1305 # get inserted id from the database, if applicable & needed
1306 if ( $db_seq && ! $self->getfield($primary_key) ) {
1307 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1311 if ( driver_name eq 'Pg' ) {
1313 #my $oid = $sth->{'pg_oid_status'};
1314 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1316 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1317 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1318 dbh->rollback if $FS::UID::AutoCommit;
1319 return "can't parse $table.$primary_key default value".
1320 " for sequence name: $default";
1324 my $i_sql = "SELECT currval('$sequence')";
1325 my $i_sth = dbh->prepare($i_sql) or do {
1326 dbh->rollback if $FS::UID::AutoCommit;
1329 $i_sth->execute() or do { #$i_sth->execute($oid)
1330 dbh->rollback if $FS::UID::AutoCommit;
1331 return $i_sth->errstr;
1333 $insertid = $i_sth->fetchrow_arrayref->[0];
1335 } elsif ( driver_name eq 'mysql' ) {
1337 $insertid = dbh->{'mysql_insertid'};
1338 # work around mysql_insertid being null some of the time, ala RT :/
1339 unless ( $insertid ) {
1340 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1341 "using SELECT LAST_INSERT_ID();";
1342 my $i_sql = "SELECT LAST_INSERT_ID()";
1343 my $i_sth = dbh->prepare($i_sql) or do {
1344 dbh->rollback if $FS::UID::AutoCommit;
1347 $i_sth->execute or do {
1348 dbh->rollback if $FS::UID::AutoCommit;
1349 return $i_sth->errstr;
1351 $insertid = $i_sth->fetchrow_arrayref->[0];
1356 dbh->rollback if $FS::UID::AutoCommit;
1357 return "don't know how to retreive inserted ids from ". driver_name.
1358 ", try using counterfiles (maybe run dbdef-create?)";
1362 $self->setfield($primary_key, $insertid);
1367 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1368 my $h_statement = $self->_h_statement('insert');
1369 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1370 $h_sth = dbh->prepare($h_statement) or do {
1371 dbh->rollback if $FS::UID::AutoCommit;
1377 $h_sth->execute or return $h_sth->errstr if $h_sth;
1379 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1381 # Now that it has been saved, reset the encrypted fields so that $new
1382 # can still be used.
1383 foreach my $field (keys %{$saved}) {
1384 $self->setfield($field, $saved->{$field});
1392 Depriciated (use insert instead).
1397 cluck "warning: FS::Record::add deprecated!";
1398 insert @_; #call method in this scope
1403 Delete this record from the database. If there is an error, returns the error,
1404 otherwise returns false.
1411 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1413 $self->getfield($_) eq ''
1414 #? "( $_ IS NULL OR $_ = \"\" )"
1415 ? ( driver_name eq 'Pg'
1417 : "( $_ IS NULL OR $_ = \"\" )"
1419 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1420 } ( $self->dbdef_table->primary_key )
1421 ? ( $self->dbdef_table->primary_key)
1422 : real_fields($self->table)
1424 warn "[debug]$me $statement\n" if $DEBUG > 1;
1425 my $sth = dbh->prepare($statement) or return dbh->errstr;
1428 if ( defined dbdef->table('h_'. $self->table) ) {
1429 my $h_statement = $self->_h_statement('delete');
1430 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1431 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1436 my $primary_key = $self->dbdef_table->primary_key;
1438 local $SIG{HUP} = 'IGNORE';
1439 local $SIG{INT} = 'IGNORE';
1440 local $SIG{QUIT} = 'IGNORE';
1441 local $SIG{TERM} = 'IGNORE';
1442 local $SIG{TSTP} = 'IGNORE';
1443 local $SIG{PIPE} = 'IGNORE';
1445 my $rc = $sth->execute or return $sth->errstr;
1446 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1447 $h_sth->execute or return $h_sth->errstr if $h_sth;
1449 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1451 #no need to needlessly destoy the data either (causes problems actually)
1452 #undef $self; #no need to keep object!
1459 Depriciated (use delete instead).
1464 cluck "warning: FS::Record::del deprecated!";
1465 &delete(@_); #call method in this scope
1468 =item replace OLD_RECORD
1470 Replace the OLD_RECORD with this one in the database. If there is an error,
1471 returns the error, otherwise returns false.
1476 my ($new, $old) = (shift, shift);
1478 $old = $new->replace_old unless defined($old);
1480 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1482 if ( $new->can('replace_check') ) {
1483 my $error = $new->replace_check($old);
1484 return $error if $error;
1487 return "Records not in same table!" unless $new->table eq $old->table;
1489 my $primary_key = $old->dbdef_table->primary_key;
1490 return "Can't change primary key $primary_key ".
1491 'from '. $old->getfield($primary_key).
1492 ' to ' . $new->getfield($primary_key)
1494 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1496 my $error = $new->check;
1497 return $error if $error;
1499 # Encrypt for replace
1501 if ( $conf->exists('encryption')
1502 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1503 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1505 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1506 next if $field eq 'payinfo'
1507 && ($new->isa('FS::payinfo_transaction_Mixin')
1508 || $new->isa('FS::payinfo_Mixin') )
1510 && !grep { $new->payby eq $_ } @encrypt_payby;
1511 $saved->{$field} = $new->getfield($field);
1512 $new->setfield($field, $new->encrypt($new->getfield($field)));
1516 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1517 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1518 ? ($_, $new->getfield($_)) : () } $old->fields;
1520 unless (keys(%diff) || $no_update_diff ) {
1521 carp "[warning]$me ". ref($new)."->replace ".
1522 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1523 ": records identical"
1524 unless $nowarn_identical;
1528 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1530 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1531 } real_fields($old->table)
1536 if ( $old->getfield($_) eq '' ) {
1538 #false laziness w/qsearch
1539 if ( driver_name eq 'Pg' ) {
1540 my $type = $old->dbdef_table->column($_)->type;
1541 if ( $type =~ /(int|(big)?serial)/i ) {
1544 qq-( $_ IS NULL OR $_ = '' )-;
1547 qq-( $_ IS NULL OR $_ = "" )-;
1551 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1554 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1557 warn "[debug]$me $statement\n" if $DEBUG > 1;
1558 my $sth = dbh->prepare($statement) or return dbh->errstr;
1561 if ( defined dbdef->table('h_'. $old->table) ) {
1562 my $h_old_statement = $old->_h_statement('replace_old');
1563 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1564 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1570 if ( defined dbdef->table('h_'. $new->table) ) {
1571 my $h_new_statement = $new->_h_statement('replace_new');
1572 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1573 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1578 local $SIG{HUP} = 'IGNORE';
1579 local $SIG{INT} = 'IGNORE';
1580 local $SIG{QUIT} = 'IGNORE';
1581 local $SIG{TERM} = 'IGNORE';
1582 local $SIG{TSTP} = 'IGNORE';
1583 local $SIG{PIPE} = 'IGNORE';
1585 my $rc = $sth->execute or return $sth->errstr;
1586 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1587 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1588 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1590 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1592 # Now that it has been saved, reset the encrypted fields so that $new
1593 # can still be used.
1594 foreach my $field (keys %{$saved}) {
1595 $new->setfield($field, $saved->{$field});
1603 my( $self ) = shift;
1604 warn "[$me] replace called with no arguments; autoloading old record\n"
1607 my $primary_key = $self->dbdef_table->primary_key;
1608 if ( $primary_key ) {
1609 $self->by_key( $self->$primary_key() ) #this is what's returned
1610 or croak "can't find ". $self->table. ".$primary_key ".
1611 $self->$primary_key();
1613 croak $self->table. " has no primary key; pass old record as argument";
1620 Depriciated (use replace instead).
1625 cluck "warning: FS::Record::rep deprecated!";
1626 replace @_; #call method in this scope
1631 Checks custom fields. Subclasses should still provide a check method to validate
1632 non-custom fields, etc., and call this method via $self->SUPER::check.
1638 foreach my $field ($self->virtual_fields) {
1639 my $error = $self->ut_textn($field);
1640 return $error if $error;
1645 =item virtual_fields [ TABLE ]
1647 Returns a list of virtual fields defined for the table. This should not
1648 be exported, and should only be called as an instance or class method.
1652 sub virtual_fields {
1655 $table = $self->table or confess "virtual_fields called on non-table";
1657 confess "Unknown table $table" unless dbdef->table($table);
1659 return () unless dbdef->table('part_virtual_field');
1661 unless ( $virtual_fields_cache{$table} ) {
1662 my $concat = [ "'cf_'", "name" ];
1663 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1664 "WHERE dbtable = '$table'";
1666 my $result = $dbh->selectcol_arrayref($query);
1667 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1669 $virtual_fields_cache{$table} = $result;
1672 @{$virtual_fields_cache{$table}};
1676 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1678 Processes a batch import as a queued JSRPC job
1680 JOB is an FS::queue entry.
1682 OPTIONS_HASHREF can have the following keys:
1688 Table name (required).
1692 Listref of field names for static fields. They will be given values from the
1693 PARAMS hashref and passed as a "params" hashref to batch_import.
1697 Formats hashref. Keys are field names, values are listrefs that define the
1700 Each listref value can be a column name or a code reference. Coderefs are run
1701 with the row object, data and a FS::Conf object as the three parameters.
1702 For example, this coderef does the same thing as using the "columnname" string:
1705 my( $record, $data, $conf ) = @_;
1706 $record->columnname( $data );
1709 Coderefs are run after all "column name" fields are assigned.
1713 Optional format hashref of types. Keys are field names, values are "csv",
1714 "xls" or "fixedlength". Overrides automatic determination of file type
1717 =item format_headers
1719 Optional format hashref of header lines. Keys are field names, values are 0
1720 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1723 =item format_sep_chars
1725 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1726 CSV separation character.
1728 =item format_fixedlenth_formats
1730 Optional format hashref of fixed length format defintiions. Keys are field
1731 names, values Parse::FixedLength listrefs of field definitions.
1735 Set true to default to CSV file type if the filename does not contain a
1736 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1741 PARAMS is a base64-encoded Storable string containing the POSTed data as
1742 a hash ref. It normally contains at least one field, "uploaded files",
1743 generated by /elements/file-upload.html and containing the list of uploaded
1744 files. Currently only supports a single file named "file".
1748 use Storable qw(thaw);
1751 sub process_batch_import {
1752 my($job, $opt) = ( shift, shift );
1754 my $table = $opt->{table};
1755 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1756 my %formats = %{ $opt->{formats} };
1758 my $param = thaw(decode_base64(shift));
1759 warn Dumper($param) if $DEBUG;
1761 my $files = $param->{'uploaded_files'}
1762 or die "No files provided.\n";
1764 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1766 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1767 my $file = $dir. $files{'file'};
1772 formats => \%formats,
1773 format_types => $opt->{format_types},
1774 format_headers => $opt->{format_headers},
1775 format_sep_chars => $opt->{format_sep_chars},
1776 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1777 format_xml_formats => $opt->{format_xml_formats},
1778 format_asn_formats => $opt->{format_asn_formats},
1779 format_row_callbacks => $opt->{format_row_callbacks},
1784 format => $param->{format},
1785 params => { map { $_ => $param->{$_} } @pass_params },
1787 default_csv => $opt->{default_csv},
1788 postinsert_callback => $opt->{postinsert_callback},
1791 if ( $opt->{'batch_namecol'} ) {
1792 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1793 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1796 my $error = FS::Record::batch_import( \%iopt );
1800 die "$error\n" if $error;
1803 =item batch_import PARAM_HASHREF
1805 Class method for batch imports. Available params:
1811 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1817 =item format_headers
1819 =item format_sep_chars
1821 =item format_fixedlength_formats
1823 =item format_row_callbacks
1825 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1827 =item preinsert_callback
1829 =item postinsert_callback
1835 FS::queue object, will be updated with progress
1841 csv, xls, fixedlength, xml
1853 warn "$me batch_import call with params: \n". Dumper($param)
1856 my $table = $param->{table};
1858 my $job = $param->{job};
1859 my $file = $param->{file};
1860 my $params = $param->{params} || {};
1862 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1863 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1865 my( $type, $header, $sep_char,
1866 $fixedlength_format, $xml_format, $asn_format,
1867 $parser_opt, $row_callback, @fields );
1869 my $postinsert_callback = '';
1870 $postinsert_callback = $param->{'postinsert_callback'}
1871 if $param->{'postinsert_callback'};
1872 my $preinsert_callback = '';
1873 $preinsert_callback = $param->{'preinsert_callback'}
1874 if $param->{'preinsert_callback'};
1876 if ( $param->{'format'} ) {
1878 my $format = $param->{'format'};
1879 my $formats = $param->{formats};
1880 die "unknown format $format" unless exists $formats->{ $format };
1882 $type = $param->{'format_types'}
1883 ? $param->{'format_types'}{ $format }
1884 : $param->{type} || 'csv';
1887 $header = $param->{'format_headers'}
1888 ? $param->{'format_headers'}{ $param->{'format'} }
1891 $sep_char = $param->{'format_sep_chars'}
1892 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1895 $fixedlength_format =
1896 $param->{'format_fixedlength_formats'}
1897 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1901 $param->{'format_parser_opts'}
1902 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1906 $param->{'format_xml_formats'}
1907 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1911 $param->{'format_asn_formats'}
1912 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1916 $param->{'format_row_callbacks'}
1917 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1920 @fields = @{ $formats->{ $format } };
1922 } elsif ( $param->{'fields'} ) {
1924 $type = ''; #infer from filename
1927 $fixedlength_format = '';
1929 @fields = @{ $param->{'fields'} };
1932 die "neither format nor fields specified";
1935 #my $file = $param->{file};
1938 if ( $file =~ /\.(\w+)$/i ) {
1942 warn "can't parse file type from filename $file; defaulting to CSV";
1946 if $param->{'default_csv'} && $type ne 'xls';
1954 my $asn_header_buffer;
1955 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1957 if ( $type eq 'csv' ) {
1959 $parser_opt->{'binary'} = 1;
1960 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
1961 $parser = Text::CSV_XS->new($parser_opt);
1963 } elsif ( $type eq 'fixedlength' ) {
1965 eval "use Parse::FixedLength;";
1967 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
1970 die "Unknown file type $type\n";
1973 @buffer = split(/\r?\n/, slurp($file) );
1974 splice(@buffer, 0, ($header || 0) );
1975 $count = scalar(@buffer);
1977 } elsif ( $type eq 'xls' ) {
1979 eval "use Spreadsheet::ParseExcel;";
1982 eval "use DateTime::Format::Excel;";
1983 #for now, just let the error be thrown if it is used, since only CDR
1984 # formats bill_west and troop use it, not other excel-parsing things
1987 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1989 $parser = $excel->{Worksheet}[0]; #first sheet
1991 $count = $parser->{MaxRow} || $parser->{MinRow};
1994 $row = $header || 0;
1996 } elsif ( $type eq 'xml' ) {
1999 eval "use XML::Simple;";
2001 my $xmlrow = $xml_format->{'xmlrow'};
2002 $parser = $xml_format->{'xmlkeys'};
2003 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2004 my $data = XML::Simple::XMLin(
2006 'SuppressEmpty' => '', #sets empty values to ''
2010 $rows = $rows->{$_} foreach @$xmlrow;
2011 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2012 $count = @buffer = @$rows;
2014 } elsif ( $type eq 'asn.1' ) {
2016 eval "use Convert::ASN1";
2019 my $asn = Convert::ASN1->new;
2020 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2022 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2024 my $data = slurp($file);
2025 my $asn_output = $parser->decode( $data )
2026 or return "No ". $asn_format->{'macro'}. " found\n";
2028 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2030 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2031 $count = @buffer = @$rows;
2034 die "Unknown file type $type\n";
2039 local $SIG{HUP} = 'IGNORE';
2040 local $SIG{INT} = 'IGNORE';
2041 local $SIG{QUIT} = 'IGNORE';
2042 local $SIG{TERM} = 'IGNORE';
2043 local $SIG{TSTP} = 'IGNORE';
2044 local $SIG{PIPE} = 'IGNORE';
2046 my $oldAutoCommit = $FS::UID::AutoCommit;
2047 local $FS::UID::AutoCommit = 0;
2050 #my $params = $param->{params} || {};
2051 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2052 my $batch_col = $param->{'batch_keycol'};
2054 my $batch_class = 'FS::'. $param->{'batch_table'};
2055 my $batch = $batch_class->new({
2056 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2058 my $error = $batch->insert;
2060 $dbh->rollback if $oldAutoCommit;
2061 return "can't insert batch record: $error";
2063 #primary key via dbdef? (so the column names don't have to match)
2064 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2066 $params->{ $batch_col } = $batch_value;
2069 #my $job = $param->{job};
2072 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2076 my %hash = %$params;
2077 if ( $type eq 'csv' ) {
2079 last unless scalar(@buffer);
2080 $line = shift(@buffer);
2082 next if $line =~ /^\s*$/; #skip empty lines
2084 $line = &{$row_callback}($line) if $row_callback;
2086 next if $line =~ /^\s*$/; #skip empty lines
2088 $parser->parse($line) or do {
2089 $dbh->rollback if $oldAutoCommit;
2090 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2092 @columns = $parser->fields();
2094 } elsif ( $type eq 'fixedlength' ) {
2096 last unless scalar(@buffer);
2097 $line = shift(@buffer);
2099 @columns = $parser->parse($line);
2101 } elsif ( $type eq 'xls' ) {
2103 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2104 || ! $parser->{Cells}[$row];
2106 my @row = @{ $parser->{Cells}[$row] };
2107 @columns = map $_->{Val}, @row;
2110 #warn $z++. ": $_\n" for @columns;
2112 } elsif ( $type eq 'xml' ) {
2114 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2115 last unless scalar(@buffer);
2116 my $row = shift @buffer;
2117 @columns = @{ $row }{ @$parser };
2119 } elsif ( $type eq 'asn.1' ) {
2121 last unless scalar(@buffer);
2122 my $row = shift @buffer;
2123 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2124 if $asn_format->{row_callback};
2125 foreach my $key ( keys %{ $asn_format->{map} } ) {
2126 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2130 die "Unknown file type $type\n";
2135 foreach my $field ( @fields ) {
2137 my $value = shift @columns;
2139 if ( ref($field) eq 'CODE' ) {
2140 #&{$field}(\%hash, $value);
2141 push @later, $field, $value;
2143 #??? $hash{$field} = $value if length($value);
2144 $hash{$field} = $value if defined($value) && length($value);
2149 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2150 && length($1) == $custnum_length ) {
2151 $hash{custnum} = $2;
2154 #my $table = $param->{table};
2155 my $class = "FS::$table";
2157 my $record = $class->new( \%hash );
2160 while ( scalar(@later) ) {
2161 my $sub = shift @later;
2162 my $data = shift @later;
2164 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2167 $dbh->rollback if $oldAutoCommit;
2168 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2170 last if exists( $param->{skiprow} );
2172 next if exists( $param->{skiprow} );
2174 if ( $preinsert_callback ) {
2175 my $error = &{$preinsert_callback}($record, $param);
2177 $dbh->rollback if $oldAutoCommit;
2178 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2181 next if exists $param->{skiprow} && $param->{skiprow};
2184 my $error = $record->insert;
2187 $dbh->rollback if $oldAutoCommit;
2188 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2194 if ( $postinsert_callback ) {
2195 my $error = &{$postinsert_callback}($record, $param);
2197 $dbh->rollback if $oldAutoCommit;
2198 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2203 if ( $job && time - $min_sec > $last ) { #progress bar
2204 $job->update_statustext( int(100 * $imported / $count) );
2210 unless ( $imported || $param->{empty_ok} ) {
2211 $dbh->rollback if $oldAutoCommit;
2212 return "Empty file!";
2215 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2222 my( $self, $action, $time ) = @_;
2226 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2229 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2230 real_fields($self->table);
2233 # If we're encrypting then don't store the payinfo in the history
2234 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
2235 @fields = grep { $_ ne 'payinfo' } @fields;
2238 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2240 "INSERT INTO h_". $self->table. " ( ".
2241 join(', ', qw(history_date history_usernum history_action), @fields ).
2244 $FS::CurrentUser::CurrentUser->usernum,
2245 dbh->quote($action),
2254 B<Warning>: External use is B<deprecated>.
2256 Replaces COLUMN in record with a unique number, using counters in the
2257 filesystem. Used by the B<insert> method on single-field unique columns
2258 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2259 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2261 Returns the new value.
2266 my($self,$field) = @_;
2267 my($table)=$self->table;
2269 croak "Unique called on field $field, but it is ",
2270 $self->getfield($field),
2272 if $self->getfield($field);
2274 #warn "table $table is tainted" if is_tainted($table);
2275 #warn "field $field is tainted" if is_tainted($field);
2277 my($counter) = new File::CounterFile "$table.$field",0;
2279 my $index = $counter->inc;
2280 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2282 $index =~ /^(\d*)$/;
2285 $self->setfield($field,$index);
2289 =item ut_float COLUMN
2291 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2292 null. If there is an error, returns the error, otherwise returns false.
2297 my($self,$field)=@_ ;
2298 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2299 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2300 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2301 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2302 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2303 $self->setfield($field,$1);
2306 =item ut_floatn COLUMN
2308 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2309 null. If there is an error, returns the error, otherwise returns false.
2313 #false laziness w/ut_ipn
2315 my( $self, $field ) = @_;
2316 if ( $self->getfield($field) =~ /^()$/ ) {
2317 $self->setfield($field,'');
2320 $self->ut_float($field);
2324 =item ut_sfloat COLUMN
2326 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2327 May not be null. If there is an error, returns the error, otherwise returns
2333 my($self,$field)=@_ ;
2334 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2335 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2336 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2337 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2338 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2339 $self->setfield($field,$1);
2342 =item ut_sfloatn COLUMN
2344 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2345 null. If there is an error, returns the error, otherwise returns false.
2350 my( $self, $field ) = @_;
2351 if ( $self->getfield($field) =~ /^()$/ ) {
2352 $self->setfield($field,'');
2355 $self->ut_sfloat($field);
2359 =item ut_snumber COLUMN
2361 Check/untaint signed numeric data (whole numbers). If there is an error,
2362 returns the error, otherwise returns false.
2367 my($self, $field) = @_;
2368 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2369 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2370 $self->setfield($field, "$1$2");
2374 =item ut_snumbern COLUMN
2376 Check/untaint signed numeric data (whole numbers). If there is an error,
2377 returns the error, otherwise returns false.
2382 my($self, $field) = @_;
2383 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2384 or return "Illegal (numeric) $field: ". $self->getfield($field);
2386 return "Illegal (numeric) $field: ". $self->getfield($field)
2389 $self->setfield($field, "$1$2");
2393 =item ut_number COLUMN
2395 Check/untaint simple numeric data (whole numbers). May not be null. If there
2396 is an error, returns the error, otherwise returns false.
2401 my($self,$field)=@_;
2402 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2403 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2404 $self->setfield($field,$1);
2408 =item ut_numbern COLUMN
2410 Check/untaint simple numeric data (whole numbers). May be null. If there is
2411 an error, returns the error, otherwise returns false.
2416 my($self,$field)=@_;
2417 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2418 or return "Illegal (numeric) $field: ". $self->getfield($field);
2419 $self->setfield($field,$1);
2423 =item ut_money COLUMN
2425 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2426 is an error, returns the error, otherwise returns false.
2431 my($self,$field)=@_;
2433 if ( $self->getfield($field) eq '' ) {
2434 $self->setfield($field, 0);
2435 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2436 #handle one decimal place without barfing out
2437 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2438 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2439 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2441 return "Illegal (money) $field: ". $self->getfield($field);
2447 =item ut_moneyn COLUMN
2449 Check/untaint monetary numbers. May be negative. If there
2450 is an error, returns the error, otherwise returns false.
2455 my($self,$field)=@_;
2456 if ($self->getfield($field) eq '') {
2457 $self->setfield($field, '');
2460 $self->ut_money($field);
2463 =item ut_currencyn COLUMN
2465 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2466 is an error, returns the error, otherwise returns false.
2471 my($self, $field) = @_;
2472 if ($self->getfield($field) eq '') { #can be null
2473 $self->setfield($field, '');
2476 $self->ut_currency($field);
2479 =item ut_currency COLUMN
2481 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2482 there is an error, returns the error, otherwise returns false.
2487 my($self, $field) = @_;
2488 my $value = uc( $self->getfield($field) );
2489 if ( code2currency($value) ) {
2490 $self->setfield($value);
2492 return "Unknown currency $value";
2498 =item ut_text COLUMN
2500 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2501 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2502 May not be null. If there is an error, returns the error, otherwise returns
2508 my($self,$field)=@_;
2509 #warn "msgcat ". \&msgcat. "\n";
2510 #warn "notexist ". \¬exist. "\n";
2511 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2512 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2513 # see perldoc perluniprops
2514 $self->getfield($field)
2515 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2516 or return gettext('illegal_or_empty_text'). " $field: ".
2517 $self->getfield($field);
2518 $self->setfield($field,$1);
2522 =item ut_textn COLUMN
2524 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2525 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2526 May be null. If there is an error, returns the error, otherwise returns false.
2531 my($self,$field)=@_;
2532 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2533 $self->ut_text($field);
2536 =item ut_alpha COLUMN
2538 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2539 an error, returns the error, otherwise returns false.
2544 my($self,$field)=@_;
2545 $self->getfield($field) =~ /^(\w+)$/
2546 or return "Illegal or empty (alphanumeric) $field: ".
2547 $self->getfield($field);
2548 $self->setfield($field,$1);
2552 =item ut_alphan COLUMN
2554 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2555 error, returns the error, otherwise returns false.
2560 my($self,$field)=@_;
2561 $self->getfield($field) =~ /^(\w*)$/
2562 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2563 $self->setfield($field,$1);
2567 =item ut_alphasn COLUMN
2569 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2570 an error, returns the error, otherwise returns false.
2575 my($self,$field)=@_;
2576 $self->getfield($field) =~ /^([\w ]*)$/
2577 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2578 $self->setfield($field,$1);
2583 =item ut_alpha_lower COLUMN
2585 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2586 there is an error, returns the error, otherwise returns false.
2590 sub ut_alpha_lower {
2591 my($self,$field)=@_;
2592 $self->getfield($field) =~ /[[:upper:]]/
2593 and return "Uppercase characters are not permitted in $field";
2594 $self->ut_alpha($field);
2597 =item ut_phonen COLUMN [ COUNTRY ]
2599 Check/untaint phone numbers. May be null. If there is an error, returns
2600 the error, otherwise returns false.
2602 Takes an optional two-letter ISO country code; without it or with unsupported
2603 countries, ut_phonen simply calls ut_alphan.
2608 my( $self, $field, $country ) = @_;
2609 return $self->ut_alphan($field) unless defined $country;
2610 my $phonen = $self->getfield($field);
2611 if ( $phonen eq '' ) {
2612 $self->setfield($field,'');
2613 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2615 $phonen = $conf->config('cust_main-default_areacode').$phonen
2616 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2617 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2618 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2619 $phonen = "$1-$2-$3";
2620 $phonen .= " x$4" if $4;
2621 $self->setfield($field,$phonen);
2623 warn "warning: don't know how to check phone numbers for country $country";
2624 return $self->ut_textn($field);
2631 Check/untaint hexadecimal values.
2636 my($self, $field) = @_;
2637 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2638 or return "Illegal (hex) $field: ". $self->getfield($field);
2639 $self->setfield($field, uc($1));
2643 =item ut_hexn COLUMN
2645 Check/untaint hexadecimal values. May be null.
2650 my($self, $field) = @_;
2651 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2652 or return "Illegal (hex) $field: ". $self->getfield($field);
2653 $self->setfield($field, uc($1));
2657 =item ut_mac_addr COLUMN
2659 Check/untaint mac addresses. May be null.
2664 my($self, $field) = @_;
2666 my $mac = $self->get($field);
2669 $self->set($field, $mac);
2671 my $e = $self->ut_hex($field);
2674 return "Illegal (mac address) $field: ". $self->getfield($field)
2675 unless length($self->getfield($field)) == 12;
2681 =item ut_mac_addrn COLUMN
2683 Check/untaint mac addresses. May be null.
2688 my($self, $field) = @_;
2689 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2694 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2700 my( $self, $field ) = @_;
2701 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2702 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2703 or return "Illegal (IP address) $field: ". $self->getfield($field);
2704 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2705 $self->setfield($field, "$1.$2.$3.$4");
2711 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2712 to 127.0.0.1. May be null.
2717 my( $self, $field ) = @_;
2718 if ( $self->getfield($field) =~ /^()$/ ) {
2719 $self->setfield($field,'');
2722 $self->ut_ip($field);
2726 =item ut_ip46 COLUMN
2728 Check/untaint IPv4 or IPv6 address.
2733 my( $self, $field ) = @_;
2734 my $ip = NetAddr::IP->new($self->getfield($field))
2735 or return "Illegal (IP address) $field: ".$self->getfield($field);
2736 $self->setfield($field, lc($ip->addr));
2742 Check/untaint IPv6 or IPv6 address. May be null.
2747 my( $self, $field ) = @_;
2748 if ( $self->getfield($field) =~ /^$/ ) {
2749 $self->setfield($field, '');
2752 $self->ut_ip46($field);
2755 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2757 Check/untaint coordinates.
2758 Accepts the following forms:
2768 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2769 The latter form (that is, the MMM are thousands of minutes) is
2770 assumed if the "MMM" is exactly three digits or two digits > 59.
2772 To be safe, just use the DDD.DDDDD form.
2774 If LOWER or UPPER are specified, then the coordinate is checked
2775 for lower and upper bounds, respectively.
2780 my ($self, $field) = (shift, shift);
2783 if ( $field =~ /latitude/ ) {
2784 $lower = $lat_lower;
2786 } elsif ( $field =~ /longitude/ ) {
2788 $upper = $lon_upper;
2791 my $coord = $self->getfield($field);
2792 my $neg = $coord =~ s/^(-)//;
2794 my ($d, $m, $s) = (0, 0, 0);
2797 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2798 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2799 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2801 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2804 return "Invalid (coordinate with minutes > 59) $field: "
2805 . $self->getfield($field);
2808 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2810 if (defined($lower) and ($coord < $lower)) {
2811 return "Invalid (coordinate < $lower) $field: "
2812 . $self->getfield($field);;
2815 if (defined($upper) and ($coord > $upper)) {
2816 return "Invalid (coordinate > $upper) $field: "
2817 . $self->getfield($field);;
2820 $self->setfield($field, $coord);
2824 return "Invalid (coordinate) $field: " . $self->getfield($field);
2828 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2830 Same as ut_coord, except optionally null.
2836 my ($self, $field) = (shift, shift);
2838 if ($self->getfield($field) =~ /^\s*$/) {
2841 return $self->ut_coord($field, @_);
2846 =item ut_domain COLUMN
2848 Check/untaint host and domain names. May not be null.
2853 my( $self, $field ) = @_;
2854 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2855 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2856 or return "Illegal (hostname) $field: ". $self->getfield($field);
2857 $self->setfield($field,$1);
2861 =item ut_domainn COLUMN
2863 Check/untaint host and domain names. May be null.
2868 my( $self, $field ) = @_;
2869 if ( $self->getfield($field) =~ /^()$/ ) {
2870 $self->setfield($field,'');
2873 $self->ut_domain($field);
2877 =item ut_name COLUMN
2879 Check/untaint proper names; allows alphanumerics, spaces and the following
2880 punctuation: , . - '
2887 my( $self, $field ) = @_;
2888 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2889 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
2890 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2895 $self->setfield($field, $name);
2899 =item ut_namen COLUMN
2901 Check/untaint proper names; allows alphanumerics, spaces and the following
2902 punctuation: , . - '
2909 my( $self, $field ) = @_;
2910 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2911 $self->ut_name($field);
2916 Check/untaint zip codes.
2920 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2923 my( $self, $field, $country ) = @_;
2925 if ( $country eq 'US' ) {
2927 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2928 or return gettext('illegal_zip'). " $field for country $country: ".
2929 $self->getfield($field);
2930 $self->setfield($field, $1);
2932 } elsif ( $country eq 'CA' ) {
2934 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2935 or return gettext('illegal_zip'). " $field for country $country: ".
2936 $self->getfield($field);
2937 $self->setfield($field, "$1 $2");
2941 if ( $self->getfield($field) =~ /^\s*$/
2942 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2945 $self->setfield($field,'');
2947 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2948 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2949 $self->setfield($field,$1);
2957 =item ut_country COLUMN
2959 Check/untaint country codes. Country names are changed to codes, if possible -
2960 see L<Locale::Country>.
2965 my( $self, $field ) = @_;
2966 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2967 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2968 && country2code($1) ) {
2969 $self->setfield($field,uc(country2code($1)));
2972 $self->getfield($field) =~ /^(\w\w)$/
2973 or return "Illegal (country) $field: ". $self->getfield($field);
2974 $self->setfield($field,uc($1));
2978 =item ut_anything COLUMN
2980 Untaints arbitrary data. Be careful.
2985 my( $self, $field ) = @_;
2986 $self->getfield($field) =~ /^(.*)$/s
2987 or return "Illegal $field: ". $self->getfield($field);
2988 $self->setfield($field,$1);
2992 =item ut_enum COLUMN CHOICES_ARRAYREF
2994 Check/untaint a column, supplying all possible choices, like the "enum" type.
2999 my( $self, $field, $choices ) = @_;
3000 foreach my $choice ( @$choices ) {
3001 if ( $self->getfield($field) eq $choice ) {
3002 $self->setfield($field, $choice);
3006 return "Illegal (enum) field $field: ". $self->getfield($field);
3009 =item ut_enumn COLUMN CHOICES_ARRAYREF
3011 Like ut_enum, except the null value is also allowed.
3016 my( $self, $field, $choices ) = @_;
3017 $self->getfield($field)
3018 ? $self->ut_enum($field, $choices)
3022 =item ut_flag COLUMN
3024 Check/untaint a column if it contains either an empty string or 'Y'. This
3025 is the standard form for boolean flags in Freeside.
3030 my( $self, $field ) = @_;
3031 my $value = uc($self->getfield($field));
3032 if ( $value eq '' or $value eq 'Y' ) {
3033 $self->setfield($field, $value);
3036 return "Illegal (flag) field $field: $value";
3039 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3041 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3042 on the column first.
3046 sub ut_foreign_key {
3047 my( $self, $field, $table, $foreign ) = @_;
3048 return '' if $no_check_foreign;
3049 qsearchs($table, { $foreign => $self->getfield($field) })
3050 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3051 " in $table.$foreign";
3055 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3057 Like ut_foreign_key, except the null value is also allowed.
3061 sub ut_foreign_keyn {
3062 my( $self, $field, $table, $foreign ) = @_;
3063 $self->getfield($field)
3064 ? $self->ut_foreign_key($field, $table, $foreign)
3068 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3070 Checks this column as an agentnum, taking into account the current users's
3071 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3072 right or rights allowing no agentnum.
3076 sub ut_agentnum_acl {
3077 my( $self, $field ) = (shift, shift);
3078 my $null_acl = scalar(@_) ? shift : [];
3079 $null_acl = [ $null_acl ] unless ref($null_acl);
3081 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3082 return "Illegal agentnum: $error" if $error;
3084 my $curuser = $FS::CurrentUser::CurrentUser;
3086 if ( $self->$field() ) {
3088 return "Access denied"
3089 unless $curuser->agentnum($self->$field());
3093 return "Access denied"
3094 unless grep $curuser->access_right($_), @$null_acl;
3102 =item fields [ TABLE ]
3104 This is a wrapper for real_fields. Code that called
3105 fields before should probably continue to call fields.
3110 my $something = shift;
3112 if($something->isa('FS::Record')) {
3113 $table = $something->table;
3115 $table = $something;
3116 $something = "FS::$table";
3118 return (real_fields($table));
3122 =item encrypt($value)
3124 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3126 Returns the encrypted string.
3128 You should generally not have to worry about calling this, as the system handles this for you.
3133 my ($self, $value) = @_;
3134 my $encrypted = $value;
3136 if ($conf->exists('encryption')) {
3137 if ($self->is_encrypted($value)) {
3138 # Return the original value if it isn't plaintext.
3139 $encrypted = $value;
3142 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3143 # RSA doesn't like the empty string so let's pack it up
3144 # The database doesn't like the RSA data so uuencode it
3145 my $length = length($value)+1;
3146 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3148 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3155 =item is_encrypted($value)
3157 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3163 my ($self, $value) = @_;
3164 # could be more precise about it, but this will do for now
3165 $value =~ /^M/ && length($value) > 80;
3168 =item decrypt($value)
3170 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3172 You should generally not have to worry about calling this, as the system handles this for you.
3177 my ($self,$value) = @_;
3178 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3179 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
3181 if (ref($rsa_decrypt) =~ /::RSA/) {
3182 my $encrypted = unpack ("u*", $value);
3183 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3184 if ($@) {warn "Decryption Failed"};
3192 #Initialize the Module
3193 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3195 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
3196 $rsa_module = $conf->config('encryptionmodule');
3200 eval ("require $rsa_module"); # No need to import the namespace
3203 # Initialize Encryption
3204 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
3205 my $public_key = join("\n",$conf->config('encryptionpublickey'));
3206 $rsa_encrypt = $rsa_module->new_public_key($public_key);
3209 # Intitalize Decryption
3210 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
3211 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
3212 $rsa_decrypt = $rsa_module->new_private_key($private_key);
3216 =item h_search ACTION
3218 Given an ACTION, either "insert", or "delete", returns the appropriate history
3219 record corresponding to this record, if any.
3224 my( $self, $action ) = @_;
3226 my $table = $self->table;
3229 my $primary_key = dbdef->table($table)->primary_key;
3232 'table' => "h_$table",
3233 'hashref' => { $primary_key => $self->$primary_key(),
3234 'history_action' => $action,
3242 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3243 appropriate history record corresponding to this record, if any.
3248 my($self, $action) = @_;
3249 my $h = $self->h_search($action);
3250 $h ? $h->history_date : '';
3253 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3255 A class or object method. Executes the sql statement represented by SQL and
3256 returns a scalar representing the result: the first column of the first row.
3258 Dies on bogus SQL. Returns an empty string if no row is returned.
3260 Typically used for statments which return a single value such as "SELECT
3261 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3266 my($self, $sql) = (shift, shift);
3267 my $sth = dbh->prepare($sql) or die dbh->errstr;
3269 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3270 my $row = $sth->fetchrow_arrayref or return '';
3271 my $scalar = $row->[0];
3272 defined($scalar) ? $scalar : '';
3275 =item count [ WHERE ]
3277 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3278 with optional WHERE. Must be called as method on a class with an
3284 my($self, $where) = (shift, shift);
3285 my $table = $self->table or die 'count called on object of class '.ref($self);
3286 my $sql = "SELECT COUNT(*) FROM $table";
3287 $sql .= " WHERE $where" if $where;
3288 $self->scalar_sql($sql);
3297 =item real_fields [ TABLE ]
3299 Returns a list of the real columns in the specified table. Called only by
3300 fields() and other subroutines elsewhere in FS::Record.
3307 my($table_obj) = dbdef->table($table);
3308 confess "Unknown table $table" unless $table_obj;
3309 $table_obj->columns;
3312 =item pvf FIELD_NAME
3314 Returns the FS::part_virtual_field object corresponding to a field in the
3315 record (specified by FIELD_NAME).
3320 my ($self, $name) = (shift, shift);
3322 if(grep /^$name$/, $self->virtual_fields) {
3324 my $concat = [ "'cf_'", "name" ];
3325 return qsearchs({ table => 'part_virtual_field',
3326 hashref => { dbtable => $self->table,
3329 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3335 =item _quote VALUE, TABLE, COLUMN
3337 This is an internal function used to construct SQL statements. It returns
3338 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3339 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3344 my($value, $table, $column) = @_;
3345 my $column_obj = dbdef->table($table)->column($column);
3346 my $column_type = $column_obj->type;
3347 my $nullable = $column_obj->null;
3349 utf8::upgrade($value);
3351 warn " $table.$column: $value ($column_type".
3352 ( $nullable ? ' NULL' : ' NOT NULL' ).
3353 ")\n" if $DEBUG > 2;
3355 if ( $value eq '' && $nullable ) {
3357 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3358 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3361 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3362 ! $column_type =~ /(char|binary|text)$/i ) {
3364 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3365 && driver_name eq 'Pg'
3369 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3370 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3371 # single-quote the whole mess, and put an "E" in front.
3372 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3380 This is deprecated. Don't use it.
3382 It returns a hash-type list with the fields of this record's table set true.
3387 carp "warning: hfields is deprecated";
3390 foreach (fields($table)) {
3399 "$_: ". $self->getfield($_). "|"
3400 } (fields($self->table)) );
3403 sub DESTROY { return; }
3407 # #use Carp qw(cluck);
3408 # #cluck "DESTROYING $self";
3409 # warn "DESTROYING $self";
3413 # return ! eval { join('',@_), kill 0; 1; };
3416 =item str2time_sql [ DRIVER_NAME ]
3418 Returns a function to convert to unix time based on database type, such as
3419 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3420 the str2time_sql_closing method to return a closing string rather than just
3421 using a closing parenthesis as previously suggested.
3423 You can pass an optional driver name such as "Pg", "mysql" or
3424 $dbh->{Driver}->{Name} to return a function for that database instead of
3425 the current database.
3430 my $driver = shift || driver_name;
3432 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3433 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3435 warn "warning: unknown database type $driver; guessing how to convert ".
3436 "dates to UNIX timestamps";
3437 return 'EXTRACT(EPOCH FROM ';
3441 =item str2time_sql_closing [ DRIVER_NAME ]
3443 Returns the closing suffix of a function to convert to unix time based on
3444 database type, such as ")::integer" for Pg or ")" for mysql.
3446 You can pass an optional driver name such as "Pg", "mysql" or
3447 $dbh->{Driver}->{Name} to return a function for that database instead of
3448 the current database.
3452 sub str2time_sql_closing {
3453 my $driver = shift || driver_name;
3455 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3459 =item regexp_sql [ DRIVER_NAME ]
3461 Returns the operator to do a regular expression comparison based on database
3462 type, such as '~' for Pg or 'REGEXP' for mysql.
3464 You can pass an optional driver name such as "Pg", "mysql" or
3465 $dbh->{Driver}->{Name} to return a function for that database instead of
3466 the current database.
3471 my $driver = shift || driver_name;
3473 return '~' if $driver =~ /^Pg/i;
3474 return 'REGEXP' if $driver =~ /^mysql/i;
3476 die "don't know how to use regular expressions in ". driver_name." databases";
3480 =item not_regexp_sql [ DRIVER_NAME ]
3482 Returns the operator to do a regular expression negation based on database
3483 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3485 You can pass an optional driver name such as "Pg", "mysql" or
3486 $dbh->{Driver}->{Name} to return a function for that database instead of
3487 the current database.
3491 sub not_regexp_sql {
3492 my $driver = shift || driver_name;
3494 return '!~' if $driver =~ /^Pg/i;
3495 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3497 die "don't know how to use regular expressions in ". driver_name." databases";
3501 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3503 Returns the items concatenated based on database type, using "CONCAT()" for
3504 mysql and " || " for Pg and other databases.
3506 You can pass an optional driver name such as "Pg", "mysql" or
3507 $dbh->{Driver}->{Name} to return a function for that database instead of
3508 the current database.
3513 my $driver = ref($_[0]) ? driver_name : shift;
3516 if ( $driver =~ /^mysql/i ) {
3517 'CONCAT('. join(',', @$items). ')';
3519 join('||', @$items);
3524 =item midnight_sql DATE
3526 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3527 on that day in the system timezone, using the default driver name.
3532 my $driver = driver_name;
3534 if ( $driver =~ /^mysql/i ) {
3535 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3538 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3546 This module should probably be renamed, since much of the functionality is
3547 of general use. It is not completely unlike Adapter::DBI (see below).
3549 Exported qsearch and qsearchs should be deprecated in favor of method calls
3550 (against an FS::Record object like the old search and searchs that qsearch
3551 and qsearchs were on top of.)
3553 The whole fields / hfields mess should be removed.
3555 The various WHERE clauses should be subroutined.
3557 table string should be deprecated in favor of DBIx::DBSchema::Table.
3559 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3560 true maps to the database (and WHERE clauses) would also help.
3562 The ut_ methods should ask the dbdef for a default length.
3564 ut_sqltype (like ut_varchar) should all be defined
3566 A fallback check method should be provided which uses the dbdef.
3568 The ut_money method assumes money has two decimal digits.
3570 The Pg money kludge in the new method only strips `$'.
3572 The ut_phonen method only checks US-style phone numbers.
3574 The _quote function should probably use ut_float instead of a regex.
3576 All the subroutines probably should be methods, here or elsewhere.
3578 Probably should borrow/use some dbdef methods where appropriate (like sub
3581 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3582 or allow it to be set. Working around it is ugly any way around - DBI should
3583 be fixed. (only affects RDBMS which return uppercase column names)
3585 ut_zip should take an optional country like ut_phone.
3589 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3591 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.