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
36 concat_sql group_concat_sql
41 our $me = '[FS::Record]';
43 our $nowarn_identical = 0;
44 our $nowarn_classload = 0;
45 our $no_update_diff = 0;
48 our $no_check_foreign = 1; #well, not inefficiently in perl by default anymore
56 our $conf_encryption = '';
57 FS::UID->install_callback( sub {
61 $conf = FS::Conf->new;
62 $conf_encryption = $conf->exists('encryption');
63 $money_char = $conf->config('money_char') || '$';
64 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
65 $lat_lower = $nw_coords ? 1 : -90;
66 $lon_upper = $nw_coords ? -1 : 180;
68 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
70 if ( driver_name eq 'Pg' ) {
71 eval "use DBD::Pg ':pg_types'";
74 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
77 foreach my $table ( dbdef->tables ) {
78 $fk_method_cache{$table} = fk_methods($table);
85 FS::Record - Database record objects
90 use FS::Record qw(dbh fields qsearch qsearchs);
92 $record = new FS::Record 'table', \%hash;
93 $record = new FS::Record 'table', { 'column' => 'value', ... };
95 $record = qsearchs FS::Record 'table', \%hash;
96 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
97 @records = qsearch FS::Record 'table', \%hash;
98 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
100 $table = $record->table;
101 $dbdef_table = $record->dbdef_table;
103 $value = $record->get('column');
104 $value = $record->getfield('column');
105 $value = $record->column;
107 $record->set( 'column' => 'value' );
108 $record->setfield( 'column' => 'value' );
109 $record->column('value');
111 %hash = $record->hash;
113 $hashref = $record->hashref;
115 $error = $record->insert;
117 $error = $record->delete;
119 $error = $new_record->replace($old_record);
121 # external use deprecated - handled by the database (at least for Pg, mysql)
122 $value = $record->unique('column');
124 $error = $record->ut_float('column');
125 $error = $record->ut_floatn('column');
126 $error = $record->ut_number('column');
127 $error = $record->ut_numbern('column');
128 $error = $record->ut_decimal('column');
129 $error = $record->ut_decimaln('column');
130 $error = $record->ut_snumber('column');
131 $error = $record->ut_snumbern('column');
132 $error = $record->ut_money('column');
133 $error = $record->ut_text('column');
134 $error = $record->ut_textn('column');
135 $error = $record->ut_alpha('column');
136 $error = $record->ut_alphan('column');
137 $error = $record->ut_phonen('column');
138 $error = $record->ut_anything('column');
139 $error = $record->ut_name('column');
141 $quoted_value = _quote($value,'table','field');
144 $fields = hfields('table');
145 if ( $fields->{Field} ) { # etc.
147 @fields = fields 'table'; #as a subroutine
148 @fields = $record->fields; #as a method call
153 (Mostly) object-oriented interface to database records. Records are currently
154 implemented on top of DBI. FS::Record is intended as a base class for
155 table-specific classes to inherit from, i.e. FS::cust_main.
161 =item new [ TABLE, ] HASHREF
163 Creates a new record. It doesn't store it in the database, though. See
164 L<"insert"> for that.
166 Note that the object stores this hash reference, not a distinct copy of the
167 hash it points to. You can ask the object for a copy with the I<hash>
170 TABLE can only be omitted when a dervived class overrides the table method.
176 my $class = ref($proto) || $proto;
178 bless ($self, $class);
180 unless ( defined ( $self->table ) ) {
181 $self->{'Table'} = shift;
182 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
183 unless $nowarn_classload;
186 $self->{'Hash'} = shift;
188 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
189 $self->{'Hash'}{$field}='';
192 $self->_rebless if $self->can('_rebless');
194 $self->{'modified'} = 0;
196 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
203 my $class = ref($proto) || $proto;
205 bless ($self, $class);
207 $self->{'Table'} = shift unless defined ( $self->table );
209 my $hashref = $self->{'Hash'} = shift;
211 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
212 my $obj = $cache->cache->{$hashref->{$cache->key}};
213 $obj->_cache($hashref, $cache) if $obj->can('_cache');
216 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
223 my $class = ref($proto) || $proto;
225 bless ($self, $class);
226 if ( defined $self->table ) {
227 cluck "create constructor is deprecated, use new!";
230 croak "FS::Record::create called (not from a subclass)!";
234 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
236 Searches the database for all records matching (at least) the key/value pairs
237 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
238 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
241 The preferred usage is to pass a hash reference of named parameters:
243 @records = qsearch( {
244 'table' => 'table_name',
245 'hashref' => { 'field' => 'value'
246 'field' => { 'op' => '<',
251 #these are optional...
253 'extra_sql' => 'AND field = ? AND intfield = ?',
254 'extra_param' => [ 'value', [ 5, 'int' ] ],
255 'order_by' => 'ORDER BY something',
256 #'cache_obj' => '', #optional
257 'addl_from' => 'LEFT JOIN othtable USING ( field )',
262 Much code still uses old-style positional parameters, this is also probably
263 fine in the common case where there are only two parameters:
265 my @records = qsearch( 'table', { 'field' => 'value' } );
267 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
268 the individual PARAMS_HASHREF queries
270 ###oops, argh, FS::Record::new only lets us create database fields.
271 #Normal behaviour if SELECT is not specified is `*', as in
272 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
273 #feature where you can specify SELECT - remember, the objects returned,
274 #although blessed into the appropriate `FS::TABLE' package, will only have the
275 #fields you specify. This might have unwanted results if you then go calling
276 #regular FS::TABLE methods
281 my %TYPE = (); #for debugging
284 my($type, $value) = @_;
286 my $bind_type = { TYPE => SQL_VARCHAR };
288 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
290 $bind_type = { TYPE => SQL_INTEGER };
292 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
294 if ( driver_name eq 'Pg' ) {
296 $bind_type = { pg_type => PG_BYTEA };
298 # $bind_type = ? #SQL_VARCHAR could be fine?
301 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
302 #fixed by DBD::Pg 2.11.8
303 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
304 #(make a Tron test first)
305 } elsif ( _is_fs_float( $type, $value ) ) {
307 $bind_type = { TYPE => SQL_DECIMAL };
316 my($type, $value) = @_;
317 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
318 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
326 my( @stable, @record, @cache );
327 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
329 my %union_options = ();
330 if ( ref($_[0]) eq 'ARRAY' ) {
333 foreach my $href ( @$optlist ) {
334 push @stable, ( $href->{'table'} or die "table name is required" );
335 push @record, ( $href->{'hashref'} || {} );
336 push @select, ( $href->{'select'} || '*' );
337 push @extra_sql, ( $href->{'extra_sql'} || '' );
338 push @extra_param, ( $href->{'extra_param'} || [] );
339 push @order_by, ( $href->{'order_by'} || '' );
340 push @cache, ( $href->{'cache_obj'} || '' );
341 push @addl_from, ( $href->{'addl_from'} || '' );
342 push @debug, ( $href->{'debug'} || '' );
344 die "at least one hashref is required" unless scalar(@stable);
345 } elsif ( ref($_[0]) eq 'HASH' ) {
347 $stable[0] = $opt->{'table'} or die "table name is required";
348 $record[0] = $opt->{'hashref'} || {};
349 $select[0] = $opt->{'select'} || '*';
350 $extra_sql[0] = $opt->{'extra_sql'} || '';
351 $extra_param[0] = $opt->{'extra_param'} || [];
352 $order_by[0] = $opt->{'order_by'} || '';
353 $cache[0] = $opt->{'cache_obj'} || '';
354 $addl_from[0] = $opt->{'addl_from'} || '';
355 $debug[0] = $opt->{'debug'} || '';
366 my $cache = $cache[0];
372 foreach my $stable ( @stable ) {
374 carp '->qsearch on cust_main called' if $stable eq 'cust_main' && $DEBUG;
376 #stop altering the caller's hashref
377 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
378 my $select = shift @select;
379 my $extra_sql = shift @extra_sql;
380 my $extra_param = shift @extra_param;
381 my $order_by = shift @order_by;
382 my $cache = shift @cache;
383 my $addl_from = shift @addl_from;
384 my $debug = shift @debug;
386 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
388 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
391 my $table = $cache ? $cache->table : $stable;
392 my $dbdef_table = dbdef->table($table)
393 or die "No schema for table $table found - ".
394 "do you need to run freeside-upgrade?";
395 my $pkey = $dbdef_table->primary_key;
397 my @real_fields = grep exists($record->{$_}), real_fields($table);
399 my $statement .= "SELECT $select FROM $stable";
400 $statement .= " $addl_from" if $addl_from;
401 if ( @real_fields ) {
402 $statement .= ' WHERE '. join(' AND ',
403 get_real_fields($table, $record, \@real_fields));
406 $statement .= " $extra_sql" if defined($extra_sql);
407 $statement .= " $order_by" if defined($order_by);
409 push @statement, $statement;
411 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
414 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
417 my $value = $record->{$field};
418 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
419 $value = $value->{'value'} if ref($value);
420 my $type = dbdef->table($table)->column($field)->type;
422 my $bind_type = _bind_type($type, $value);
426 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
428 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
432 push @bind_type, $bind_type;
436 foreach my $param ( @$extra_param ) {
437 my $bind_type = { TYPE => SQL_VARCHAR };
440 $value = $param->[0];
441 my $type = $param->[1];
442 $bind_type = _bind_type($type, $value);
445 push @bind_type, $bind_type;
449 my $statement = join( ' ) UNION ( ', @statement );
450 $statement = "( $statement )" if scalar(@statement) > 1;
451 $statement .= " $union_options{order_by}" if $union_options{order_by};
453 my $sth = $dbh->prepare($statement)
454 or croak "$dbh->errstr doing $statement";
457 foreach my $value ( @value ) {
458 my $bind_type = shift @bind_type;
459 $sth->bind_param($bind++, $value, $bind_type );
462 # $sth->execute( map $record->{$_},
463 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
464 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
466 my $ok = $sth->execute;
468 my $error = "Error executing \"$statement\"";
469 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
470 $error .= ': '. $sth->errstr;
474 my $table = $stable[0];
476 $table = '' if grep { $_ ne $table } @stable;
477 $pkey = dbdef->table($table)->primary_key if $table;
480 tie %result, "Tie::IxHash";
481 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
482 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
483 %result = map { $_->{$pkey}, $_ } @stuff;
485 @result{@stuff} = @stuff;
491 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
492 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
493 #derivied class didn't override new method, so this optimization is safe
496 new_or_cached( "FS::$table", { %{$_} }, $cache )
500 new( "FS::$table", { %{$_} } )
504 #okay, its been tested
505 # warn "untested code (class FS::$table uses custom new method)";
507 eval 'FS::'. $table. '->new( { %{$_} } )';
511 # Check for encrypted fields and decrypt them.
512 ## only in the local copy, not the cached object
513 if ( $conf_encryption
514 && eval '@FS::'. $table . '::encrypted_fields' ) {
515 foreach my $record (@return) {
516 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
517 next if $field eq 'payinfo'
518 && ($record->isa('FS::payinfo_transaction_Mixin')
519 || $record->isa('FS::payinfo_Mixin') )
521 && !grep { $record->payby eq $_ } @encrypt_payby;
522 # Set it directly... This may cause a problem in the future...
523 $record->setfield($field, $record->decrypt($record->getfield($field)));
528 cluck "warning: FS::$table not loaded; returning FS::Record objects"
529 unless $nowarn_classload;
531 FS::Record->new( $table, { %{$_} } );
539 Construct the SQL statement and parameter-binding list for qsearch. Takes
540 the qsearch parameters.
542 Returns a hash containing:
543 'table': The primary table name (if there is one).
544 'statement': The SQL statement itself.
545 'bind_type': An arrayref of bind types.
546 'value': An arrayref of parameter values.
547 'cache': The cache object, if one was passed.
552 my( @stable, @record, @cache );
553 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
556 my %union_options = ();
557 if ( ref($_[0]) eq 'ARRAY' ) {
560 foreach my $href ( @$optlist ) {
561 push @stable, ( $href->{'table'} or die "table name is required" );
562 push @record, ( $href->{'hashref'} || {} );
563 push @select, ( $href->{'select'} || '*' );
564 push @extra_sql, ( $href->{'extra_sql'} || '' );
565 push @extra_param, ( $href->{'extra_param'} || [] );
566 push @order_by, ( $href->{'order_by'} || '' );
567 push @cache, ( $href->{'cache_obj'} || '' );
568 push @addl_from, ( $href->{'addl_from'} || '' );
569 push @debug, ( $href->{'debug'} || '' );
571 die "at least one hashref is required" unless scalar(@stable);
572 } elsif ( ref($_[0]) eq 'HASH' ) {
574 $stable[0] = $opt->{'table'} or die "table name is required";
575 $record[0] = $opt->{'hashref'} || {};
576 $select[0] = $opt->{'select'} || '*';
577 $extra_sql[0] = $opt->{'extra_sql'} || '';
578 $extra_param[0] = $opt->{'extra_param'} || [];
579 $order_by[0] = $opt->{'order_by'} || '';
580 $cache[0] = $opt->{'cache_obj'} || '';
581 $addl_from[0] = $opt->{'addl_from'} || '';
582 $debug[0] = $opt->{'debug'} || '';
593 my $cache = $cache[0];
599 my $result_table = $stable[0];
600 foreach my $stable ( @stable ) {
601 #stop altering the caller's hashref
602 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
603 my $select = shift @select;
604 my $extra_sql = shift @extra_sql;
605 my $extra_param = shift @extra_param;
606 my $order_by = shift @order_by;
607 my $cache = shift @cache;
608 my $addl_from = shift @addl_from;
609 my $debug = shift @debug;
611 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
613 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
616 $result_table = '' if $result_table ne $stable;
618 my $table = $cache ? $cache->table : $stable;
619 my $dbdef_table = dbdef->table($table)
620 or die "No schema for table $table found - ".
621 "do you need to run freeside-upgrade?";
622 my $pkey = $dbdef_table->primary_key;
624 my @real_fields = grep exists($record->{$_}), real_fields($table);
626 my $statement .= "SELECT $select FROM $stable";
627 $statement .= " $addl_from" if $addl_from;
628 if ( @real_fields ) {
629 $statement .= ' WHERE '. join(' AND ',
630 get_real_fields($table, $record, \@real_fields));
633 $statement .= " $extra_sql" if defined($extra_sql);
634 $statement .= " $order_by" if defined($order_by);
636 push @statement, $statement;
638 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
642 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
645 my $value = $record->{$field};
646 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
647 $value = $value->{'value'} if ref($value);
648 my $type = dbdef->table($table)->column($field)->type;
650 my $bind_type = _bind_type($type, $value);
654 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
656 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
660 push @bind_type, $bind_type;
664 foreach my $param ( @$extra_param ) {
665 my $bind_type = { TYPE => SQL_VARCHAR };
668 $value = $param->[0];
669 my $type = $param->[1];
670 $bind_type = _bind_type($type, $value);
673 push @bind_type, $bind_type;
677 my $statement = join( ' ) UNION ( ', @statement );
678 $statement = "( $statement )" if scalar(@statement) > 1;
679 $statement .= " $union_options{order_by}" if $union_options{order_by};
682 statement => $statement,
683 bind_type => \@bind_type,
685 table => $result_table,
690 # qsearch should eventually use this
692 my ($table, $cache, @hashrefs) = @_;
694 # XXX get rid of these string evals at some point
695 # (when we have time to test it)
696 # my $class = "FS::$table" if $table;
697 # if ( $class and $class->isa('FS::Record') )
698 # if ( $class->can('new') eq \&new )
700 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
701 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
702 #derivied class didn't override new method, so this optimization is safe
705 new_or_cached( "FS::$table", { %{$_} }, $cache )
709 new( "FS::$table", { %{$_} } )
713 #okay, its been tested
714 # warn "untested code (class FS::$table uses custom new method)";
716 eval 'FS::'. $table. '->new( { %{$_} } )';
720 # Check for encrypted fields and decrypt them.
721 ## only in the local copy, not the cached object
722 if ( $conf_encryption
723 && eval '@FS::'. $table . '::encrypted_fields' ) {
724 foreach my $record (@return) {
725 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
726 next if $field eq 'payinfo'
727 && ($record->isa('FS::payinfo_transaction_Mixin')
728 || $record->isa('FS::payinfo_Mixin') )
730 && !grep { $record->payby eq $_ } @encrypt_payby;
731 # Set it directly... This may cause a problem in the future...
732 $record->setfield($field, $record->decrypt($record->getfield($field)));
737 cluck "warning: FS::$table not loaded; returning FS::Record objects"
738 unless $nowarn_classload;
740 FS::Record->new( $table, { %{$_} } );
746 ## makes this easier to read
748 sub get_real_fields {
751 my $real_fields = shift;
753 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
759 my $type = dbdef->table($table)->column($column)->type;
760 my $value = $record->{$column};
761 $value = $value->{'value'} if ref($value);
762 if ( ref($record->{$_}) ) {
763 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
764 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
765 if ( uc($op) eq 'ILIKE' ) {
767 $record->{$_}{'value'} = lc($record->{$_}{'value'});
768 $column = "LOWER($_)";
770 $record->{$_} = $record->{$_}{'value'}
773 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
775 if ( driver_name eq 'Pg' ) {
776 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
777 qq-( $column IS NULL )-;
779 qq-( $column IS NULL OR $column = '' )-;
782 qq-( $column IS NULL OR $column = "" )-;
784 } elsif ( $op eq '!=' ) {
785 if ( driver_name eq 'Pg' ) {
786 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
787 qq-( $column IS NOT NULL )-;
789 qq-( $column IS NOT NULL AND $column != '' )-;
792 qq-( $column IS NOT NULL AND $column != "" )-;
795 if ( driver_name eq 'Pg' ) {
796 qq-( $column $op '' )-;
798 qq-( $column $op "" )-;
801 } elsif ( $op eq '!=' ) {
802 qq-( $column IS NULL OR $column != ? )-;
803 #if this needs to be re-enabled, it needs to use a custom op like
804 #"APPROX=" or something (better name?, not '=', to avoid affecting other
806 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
807 # ( "$column <= ?", "$column >= ?" );
811 } @{ $real_fields } );
814 =item by_key PRIMARY_KEY_VALUE
816 This is a class method that returns the record with the given primary key
817 value. This method is only useful in FS::Record subclasses. For example:
819 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
823 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
828 my ($class, $pkey_value) = @_;
830 my $table = $class->table
831 or croak "No table for $class found";
833 my $dbdef_table = dbdef->table($table)
834 or die "No schema for table $table found - ".
835 "do you need to create it or run dbdef-create?";
836 my $pkey = $dbdef_table->primary_key
837 or die "No primary key for table $table";
839 return qsearchs($table, { $pkey => $pkey_value });
842 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
844 Experimental JOINed search method. Using this method, you can execute a
845 single SELECT spanning multiple tables, and cache the results for subsequent
846 method calls. Interface will almost definately change in an incompatible
854 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
855 my $cache = FS::SearchCache->new( $ptable, $pkey );
858 grep { !$saw{$_->getfield($pkey)}++ }
859 qsearch($table, $record, $select, $extra_sql, $cache )
863 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
865 Same as qsearch, except that if more than one record matches, it B<carp>s but
866 returns the first. If this happens, you either made a logic error in asking
867 for a single item, or your data is corrupted.
871 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
873 my(@result) = qsearch(@_);
874 cluck "warning: Multiple records in scalar search ($table)"
875 if scalar(@result) > 1;
876 #should warn more vehemently if the search was on a primary key?
877 scalar(@result) ? ($result[0]) : ();
888 Returns the table name.
893 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
900 Returns the DBIx::DBSchema::Table object for the table.
906 my($table)=$self->table;
907 dbdef->table($table);
912 Returns the primary key for the table.
918 my $pkey = $self->dbdef_table->primary_key;
921 =item get, getfield COLUMN
923 Returns the value of the column/field/key COLUMN.
928 my($self,$field) = @_;
929 # to avoid "Use of unitialized value" errors
930 if ( defined ( $self->{Hash}->{$field} ) ) {
931 $self->{Hash}->{$field};
941 =item set, setfield COLUMN, VALUE
943 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
948 my($self,$field,$value) = @_;
949 $self->{'modified'} = 1;
950 $self->{'Hash'}->{$field} = $value;
959 Returns true if the column/field/key COLUMN exists.
964 my($self,$field) = @_;
965 exists($self->{Hash}->{$field});
968 =item AUTLOADED METHODS
970 $record->column is a synonym for $record->get('column');
972 $record->column('value') is a synonym for $record->set('column','value');
974 $record->foreign_table_name calls qsearchs and returns a single
975 FS::foreign_table record (for tables referenced by a column of this table) or
976 qsearch and returns an array of FS::foreign_table records (for tables
977 referenced by a column in the foreign table).
984 my($field)=$AUTOLOAD;
987 confess "errant AUTOLOAD $field for $self (arg $value)"
988 unless blessed($self) && $self->can('setfield');
990 #$fk_method_cache{$self->table} ||= fk_methods($self->table);
991 if ( exists($fk_method_cache{$self->table}->{$field}) ) {
993 my $fk_info = $fk_method_cache{$self->table}->{$field};
994 my $method = $fk_info->{method} || 'qsearchs';
995 my $table = $fk_info->{table} || $field;
996 my $column = $fk_info->{column};
997 my $foreign_column = $fk_info->{references} || $column;
999 eval "use FS::$table";
1002 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1004 my $pkey_value = $self->$column();
1005 my %search = ( $foreign_column => $pkey_value );
1007 # FS::Record->$method() ? they're actually just subs :/
1008 if ( $method eq 'qsearchs' ) {
1009 return $pkey_value ? qsearchs( $table, \%search ) : '';
1010 } elsif ( $method eq 'qsearch' ) {
1011 return $pkey_value ? qsearch( $table, \%search ) : ();
1013 die "unknown method $method";
1018 if ( defined($value) ) {
1019 $self->setfield($field,$value);
1021 $self->getfield($field);
1025 # efficient (also, old, doesn't support FK stuff)
1027 # my $field = $AUTOLOAD;
1028 # $field =~ s/.*://;
1029 # if ( defined($_[1]) ) {
1030 # $_[0]->setfield($field, $_[1]);
1032 # $_[0]->getfield($field);
1041 # foreign keys we reference in other tables
1042 foreach my $fk (dbdef->table($table)->foreign_keys) {
1045 if ( scalar( @{$fk->columns} ) == 1 ) {
1046 if ( ! defined($fk->references)
1047 || ! @{$fk->references}
1048 || $fk->columns->[0] eq $fk->references->[0]
1050 $method = $fk->table;
1052 #some sort of hint in the table.pm or schema for methods not named
1053 # after their foreign table (well, not a whole lot different than
1054 # just providing a small subroutine...)
1058 $hash{$method} = { #fk_info
1059 'method' => 'qsearchs',
1060 'column' => $fk->columns->[0],
1061 #'references' => $fk->references->[0],
1069 # foreign keys referenced in other tables to us
1070 # (alas. why we're cached. still, might this loop better be done once at
1071 # schema load time insetad of every time we AUTOLOAD a method on a new
1073 foreach my $f_table ( dbdef->tables ) {
1074 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1076 next unless $fk->table eq $table;
1079 if ( scalar( @{$fk->columns} ) == 1 ) {
1080 if ( ! defined($fk->references)
1081 || ! @{$fk->references}
1082 || $fk->columns->[0] eq $fk->references->[0]
1086 #some sort of hint in the table.pm or schema for methods not named
1087 # after their foreign table (well, not a whole lot different than
1088 # just providing a small subroutine...)
1092 $hash{$method} = { #fk_info
1093 'method' => 'qsearch',
1094 'column' => $fk->columns->[0], #references||column
1095 #'references' => $fk->column->[0],
1110 Returns a list of the column/value pairs, usually for assigning to a new hash.
1112 To make a distinct duplicate of an FS::Record object, you can do:
1114 $new = new FS::Record ( $old->table, { $old->hash } );
1120 confess $self. ' -> hash: Hash attribute is undefined'
1121 unless defined($self->{'Hash'});
1122 %{ $self->{'Hash'} };
1127 Returns a reference to the column/value hash. This may be deprecated in the
1128 future; if there's a reason you can't just use the autoloaded or get/set
1142 +{ ( map { $_=>$self->$_ } $self->fields ),
1147 my( $class, %opt ) = @_;
1148 my $table = $class->table;
1149 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1150 my $error = $self->insert;
1151 return +{ 'error' => $error } if $error;
1152 my $pkey = $self->pkey;
1153 return +{ 'error' => '',
1154 'primary_key' => $pkey,
1155 $pkey => $self->$pkey,
1161 Returns true if any of this object's values have been modified with set (or via
1162 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1169 $self->{'modified'};
1172 =item select_for_update
1174 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1179 sub select_for_update {
1181 my $primary_key = $self->primary_key;
1184 'table' => $self->table,
1185 'hashref' => { $primary_key => $self->$primary_key() },
1186 'extra_sql' => 'FOR UPDATE',
1192 Locks this table with a database-driver specific lock method. This is used
1193 as a mutex in order to do a duplicate search.
1195 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1197 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1199 Errors are fatal; no useful return value.
1201 Note: To use this method for new tables other than svc_acct and svc_phone,
1202 edit freeside-upgrade and add those tables to the duplicate_lock list.
1208 my $table = $self->table;
1210 warn "$me locking $table table\n" if $DEBUG;
1212 if ( driver_name =~ /^Pg/i ) {
1214 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1217 } elsif ( driver_name =~ /^mysql/i ) {
1219 dbh->do("SELECT * FROM duplicate_lock
1220 WHERE lockname = '$table'
1222 ) or die dbh->errstr;
1226 die "unknown database ". driver_name. "; don't know how to lock table";
1230 warn "$me acquired $table table lock\n" if $DEBUG;
1236 Inserts this record to the database. If there is an error, returns the error,
1237 otherwise returns false.
1245 warn "$self -> insert" if $DEBUG;
1247 my $error = $self->check;
1248 return $error if $error;
1250 #single-field non-null unique keys are given a value if empty
1251 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1252 foreach ( $self->dbdef_table->unique_singles) {
1253 next if $self->getfield($_);
1254 next if $self->dbdef_table->column($_)->null eq 'NULL';
1258 #and also the primary key, if the database isn't going to
1259 my $primary_key = $self->dbdef_table->primary_key;
1261 if ( $primary_key ) {
1262 my $col = $self->dbdef_table->column($primary_key);
1265 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1266 || ( driver_name eq 'Pg'
1267 && defined($col->default)
1268 && $col->quoted_default =~ /^nextval\(/i
1270 || ( driver_name eq 'mysql'
1271 && defined($col->local)
1272 && $col->local =~ /AUTO_INCREMENT/i
1274 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1277 my $table = $self->table;
1279 # Encrypt before the database
1280 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
1281 && scalar( eval '@FS::'. $table . '::encrypted_fields')
1282 && $conf->exists('encryption')
1284 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1285 next if $field eq 'payinfo'
1286 && ($self->isa('FS::payinfo_transaction_Mixin')
1287 || $self->isa('FS::payinfo_Mixin') )
1289 && !grep { $self->payby eq $_ } @encrypt_payby;
1290 $saved->{$field} = $self->getfield($field);
1291 $self->setfield($field, $self->encrypt($self->getfield($field)));
1295 #false laziness w/delete
1297 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1300 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1303 my $statement = "INSERT INTO $table ";
1304 if ( @real_fields ) {
1307 join( ', ', @real_fields ).
1309 join( ', ', @values ).
1313 $statement .= 'DEFAULT VALUES';
1315 warn "[debug]$me $statement\n" if $DEBUG > 1;
1316 my $sth = dbh->prepare($statement) or return dbh->errstr;
1318 local $SIG{HUP} = 'IGNORE';
1319 local $SIG{INT} = 'IGNORE';
1320 local $SIG{QUIT} = 'IGNORE';
1321 local $SIG{TERM} = 'IGNORE';
1322 local $SIG{TSTP} = 'IGNORE';
1323 local $SIG{PIPE} = 'IGNORE';
1325 $sth->execute or return $sth->errstr;
1327 # get inserted id from the database, if applicable & needed
1328 if ( $db_seq && ! $self->getfield($primary_key) ) {
1329 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1333 if ( driver_name eq 'Pg' ) {
1335 #my $oid = $sth->{'pg_oid_status'};
1336 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1338 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1339 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1340 dbh->rollback if $FS::UID::AutoCommit;
1341 return "can't parse $table.$primary_key default value".
1342 " for sequence name: $default";
1346 my $i_sql = "SELECT currval('$sequence')";
1347 my $i_sth = dbh->prepare($i_sql) or do {
1348 dbh->rollback if $FS::UID::AutoCommit;
1351 $i_sth->execute() or do { #$i_sth->execute($oid)
1352 dbh->rollback if $FS::UID::AutoCommit;
1353 return $i_sth->errstr;
1355 $insertid = $i_sth->fetchrow_arrayref->[0];
1357 } elsif ( driver_name eq 'mysql' ) {
1359 $insertid = dbh->{'mysql_insertid'};
1360 # work around mysql_insertid being null some of the time, ala RT :/
1361 unless ( $insertid ) {
1362 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1363 "using SELECT LAST_INSERT_ID();";
1364 my $i_sql = "SELECT LAST_INSERT_ID()";
1365 my $i_sth = dbh->prepare($i_sql) or do {
1366 dbh->rollback if $FS::UID::AutoCommit;
1369 $i_sth->execute or do {
1370 dbh->rollback if $FS::UID::AutoCommit;
1371 return $i_sth->errstr;
1373 $insertid = $i_sth->fetchrow_arrayref->[0];
1378 dbh->rollback if $FS::UID::AutoCommit;
1379 return "don't know how to retreive inserted ids from ". driver_name.
1380 ", try using counterfiles (maybe run dbdef-create?)";
1384 $self->setfield($primary_key, $insertid);
1389 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1390 my $h_statement = $self->_h_statement('insert');
1391 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1392 $h_sth = dbh->prepare($h_statement) or do {
1393 dbh->rollback if $FS::UID::AutoCommit;
1399 $h_sth->execute or return $h_sth->errstr if $h_sth;
1401 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1403 # Now that it has been saved, reset the encrypted fields so that $new
1404 # can still be used.
1405 foreach my $field (keys %{$saved}) {
1406 $self->setfield($field, $saved->{$field});
1414 Depriciated (use insert instead).
1419 cluck "warning: FS::Record::add deprecated!";
1420 insert @_; #call method in this scope
1425 Delete this record from the database. If there is an error, returns the error,
1426 otherwise returns false.
1433 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1435 $self->getfield($_) eq ''
1436 #? "( $_ IS NULL OR $_ = \"\" )"
1437 ? ( driver_name eq 'Pg'
1439 : "( $_ IS NULL OR $_ = \"\" )"
1441 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1442 } ( $self->dbdef_table->primary_key )
1443 ? ( $self->dbdef_table->primary_key)
1444 : real_fields($self->table)
1446 warn "[debug]$me $statement\n" if $DEBUG > 1;
1447 my $sth = dbh->prepare($statement) or return dbh->errstr;
1450 if ( defined dbdef->table('h_'. $self->table) ) {
1451 my $h_statement = $self->_h_statement('delete');
1452 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1453 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1458 my $primary_key = $self->dbdef_table->primary_key;
1460 local $SIG{HUP} = 'IGNORE';
1461 local $SIG{INT} = 'IGNORE';
1462 local $SIG{QUIT} = 'IGNORE';
1463 local $SIG{TERM} = 'IGNORE';
1464 local $SIG{TSTP} = 'IGNORE';
1465 local $SIG{PIPE} = 'IGNORE';
1467 my $rc = $sth->execute or return $sth->errstr;
1468 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1469 $h_sth->execute or return $h_sth->errstr if $h_sth;
1471 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1473 #no need to needlessly destoy the data either (causes problems actually)
1474 #undef $self; #no need to keep object!
1481 Depriciated (use delete instead).
1486 cluck "warning: FS::Record::del deprecated!";
1487 &delete(@_); #call method in this scope
1490 =item replace OLD_RECORD
1492 Replace the OLD_RECORD with this one in the database. If there is an error,
1493 returns the error, otherwise returns false.
1498 my ($new, $old) = (shift, shift);
1500 $old = $new->replace_old unless defined($old);
1502 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1504 if ( $new->can('replace_check') ) {
1505 my $error = $new->replace_check($old);
1506 return $error if $error;
1509 return "Records not in same table!" unless $new->table eq $old->table;
1511 my $primary_key = $old->dbdef_table->primary_key;
1512 return "Can't change primary key $primary_key ".
1513 'from '. $old->getfield($primary_key).
1514 ' to ' . $new->getfield($primary_key)
1516 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1518 my $error = $new->check;
1519 return $error if $error;
1521 # Encrypt for replace
1523 if ( $conf->exists('encryption')
1524 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1525 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1527 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1528 next if $field eq 'payinfo'
1529 && ($new->isa('FS::payinfo_transaction_Mixin')
1530 || $new->isa('FS::payinfo_Mixin') )
1532 && !grep { $new->payby eq $_ } @encrypt_payby;
1533 $saved->{$field} = $new->getfield($field);
1534 $new->setfield($field, $new->encrypt($new->getfield($field)));
1538 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1539 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1540 ? ($_, $new->getfield($_)) : () } $old->fields;
1542 unless (keys(%diff) || $no_update_diff ) {
1543 carp "[warning]$me ". ref($new)."->replace ".
1544 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1545 ": records identical"
1546 unless $nowarn_identical;
1550 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1552 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1553 } real_fields($old->table)
1558 if ( $old->getfield($_) eq '' ) {
1560 #false laziness w/qsearch
1561 if ( driver_name eq 'Pg' ) {
1562 my $type = $old->dbdef_table->column($_)->type;
1563 if ( $type =~ /(int|(big)?serial)/i ) {
1566 qq-( $_ IS NULL OR $_ = '' )-;
1569 qq-( $_ IS NULL OR $_ = "" )-;
1573 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1576 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1579 warn "[debug]$me $statement\n" if $DEBUG > 1;
1580 my $sth = dbh->prepare($statement) or return dbh->errstr;
1583 if ( defined dbdef->table('h_'. $old->table) ) {
1584 my $h_old_statement = $old->_h_statement('replace_old');
1585 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1586 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1592 if ( defined dbdef->table('h_'. $new->table) ) {
1593 my $h_new_statement = $new->_h_statement('replace_new');
1594 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1595 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1600 local $SIG{HUP} = 'IGNORE';
1601 local $SIG{INT} = 'IGNORE';
1602 local $SIG{QUIT} = 'IGNORE';
1603 local $SIG{TERM} = 'IGNORE';
1604 local $SIG{TSTP} = 'IGNORE';
1605 local $SIG{PIPE} = 'IGNORE';
1607 my $rc = $sth->execute or return $sth->errstr;
1608 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1609 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1610 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1612 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1614 # Now that it has been saved, reset the encrypted fields so that $new
1615 # can still be used.
1616 foreach my $field (keys %{$saved}) {
1617 $new->setfield($field, $saved->{$field});
1625 my( $self ) = shift;
1626 warn "[$me] replace called with no arguments; autoloading old record\n"
1629 my $primary_key = $self->dbdef_table->primary_key;
1630 if ( $primary_key ) {
1631 $self->by_key( $self->$primary_key() ) #this is what's returned
1632 or croak "can't find ". $self->table. ".$primary_key ".
1633 $self->$primary_key();
1635 croak $self->table. " has no primary key; pass old record as argument";
1642 Depriciated (use replace instead).
1647 cluck "warning: FS::Record::rep deprecated!";
1648 replace @_; #call method in this scope
1653 Checks custom fields. Subclasses should still provide a check method to validate
1654 non-custom fields, etc., and call this method via $self->SUPER::check.
1660 foreach my $field ($self->virtual_fields) {
1661 my $error = $self->ut_textn($field);
1662 return $error if $error;
1667 =item virtual_fields [ TABLE ]
1669 Returns a list of virtual fields defined for the table. This should not
1670 be exported, and should only be called as an instance or class method.
1674 sub virtual_fields {
1677 $table = $self->table or confess "virtual_fields called on non-table";
1679 confess "Unknown table $table" unless dbdef->table($table);
1681 return () unless dbdef->table('part_virtual_field');
1683 unless ( $virtual_fields_cache{$table} ) {
1684 my $concat = [ "'cf_'", "name" ];
1685 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1686 "WHERE dbtable = '$table'";
1688 my $result = $dbh->selectcol_arrayref($query);
1689 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1691 $virtual_fields_cache{$table} = $result;
1694 @{$virtual_fields_cache{$table}};
1698 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1700 Processes a batch import as a queued JSRPC job
1702 JOB is an FS::queue entry.
1704 OPTIONS_HASHREF can have the following keys:
1710 Table name (required).
1714 Arrayref of field names for static fields. They will be given values from the
1715 PARAMS hashref and passed as a "params" hashref to batch_import.
1719 Formats hashref. Keys are field names, values are listrefs that define the
1722 Each listref value can be a column name or a code reference. Coderefs are run
1723 with the row object, data and a FS::Conf object as the three parameters.
1724 For example, this coderef does the same thing as using the "columnname" string:
1727 my( $record, $data, $conf ) = @_;
1728 $record->columnname( $data );
1731 Coderefs are run after all "column name" fields are assigned.
1735 Optional format hashref of types. Keys are field names, values are "csv",
1736 "xls" or "fixedlength". Overrides automatic determination of file type
1739 =item format_headers
1741 Optional format hashref of header lines. Keys are field names, values are 0
1742 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1745 =item format_sep_chars
1747 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1748 CSV separation character.
1750 =item format_fixedlenth_formats
1752 Optional format hashref of fixed length format defintiions. Keys are field
1753 names, values Parse::FixedLength listrefs of field definitions.
1757 Set true to default to CSV file type if the filename does not contain a
1758 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1763 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1764 POSTed data. It must contain the field "uploaded files", generated by
1765 /elements/file-upload.html and containing the list of uploaded files.
1766 Currently only supports a single file named "file".
1771 sub process_batch_import {
1772 my($job, $opt, $param) = @_;
1774 my $table = $opt->{table};
1775 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1776 my %formats = %{ $opt->{formats} };
1778 warn Dumper($param) if $DEBUG;
1780 my $files = $param->{'uploaded_files'}
1781 or die "No files provided.\n";
1783 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1785 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1786 my $file = $dir. $files{'file'};
1791 formats => \%formats,
1792 format_types => $opt->{format_types},
1793 format_headers => $opt->{format_headers},
1794 format_sep_chars => $opt->{format_sep_chars},
1795 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1796 format_xml_formats => $opt->{format_xml_formats},
1797 format_asn_formats => $opt->{format_asn_formats},
1798 format_row_callbacks => $opt->{format_row_callbacks},
1803 format => $param->{format},
1804 params => { map { $_ => $param->{$_} } @pass_params },
1806 default_csv => $opt->{default_csv},
1807 postinsert_callback => $opt->{postinsert_callback},
1810 if ( $opt->{'batch_namecol'} ) {
1811 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1812 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1815 my $error = FS::Record::batch_import( \%iopt );
1819 die "$error\n" if $error;
1822 =item batch_import PARAM_HASHREF
1824 Class method for batch imports. Available params:
1830 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1836 =item format_headers
1838 =item format_sep_chars
1840 =item format_fixedlength_formats
1842 =item format_row_callbacks
1844 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1846 =item preinsert_callback
1848 =item postinsert_callback
1854 FS::queue object, will be updated with progress
1860 csv, xls, fixedlength, xml
1872 warn "$me batch_import call with params: \n". Dumper($param)
1875 my $table = $param->{table};
1877 my $job = $param->{job};
1878 my $file = $param->{file};
1879 my $params = $param->{params} || {};
1881 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1882 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1884 my( $type, $header, $sep_char,
1885 $fixedlength_format, $xml_format, $asn_format,
1886 $parser_opt, $row_callback, @fields );
1888 my $postinsert_callback = '';
1889 $postinsert_callback = $param->{'postinsert_callback'}
1890 if $param->{'postinsert_callback'};
1891 my $preinsert_callback = '';
1892 $preinsert_callback = $param->{'preinsert_callback'}
1893 if $param->{'preinsert_callback'};
1895 if ( $param->{'format'} ) {
1897 my $format = $param->{'format'};
1898 my $formats = $param->{formats};
1899 die "unknown format $format" unless exists $formats->{ $format };
1901 $type = $param->{'format_types'}
1902 ? $param->{'format_types'}{ $format }
1903 : $param->{type} || 'csv';
1906 $header = $param->{'format_headers'}
1907 ? $param->{'format_headers'}{ $param->{'format'} }
1910 $sep_char = $param->{'format_sep_chars'}
1911 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1914 $fixedlength_format =
1915 $param->{'format_fixedlength_formats'}
1916 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1920 $param->{'format_parser_opts'}
1921 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1925 $param->{'format_xml_formats'}
1926 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1930 $param->{'format_asn_formats'}
1931 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1935 $param->{'format_row_callbacks'}
1936 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1939 @fields = @{ $formats->{ $format } };
1941 } elsif ( $param->{'fields'} ) {
1943 $type = ''; #infer from filename
1946 $fixedlength_format = '';
1948 @fields = @{ $param->{'fields'} };
1951 die "neither format nor fields specified";
1954 #my $file = $param->{file};
1957 if ( $file =~ /\.(\w+)$/i ) {
1961 warn "can't parse file type from filename $file; defaulting to CSV";
1965 if $param->{'default_csv'} && $type ne 'xls';
1973 my $asn_header_buffer;
1974 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1976 if ( $type eq 'csv' ) {
1978 $parser_opt->{'binary'} = 1;
1979 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
1980 $parser = Text::CSV_XS->new($parser_opt);
1982 } elsif ( $type eq 'fixedlength' ) {
1984 eval "use Parse::FixedLength;";
1986 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
1989 die "Unknown file type $type\n";
1992 @buffer = split(/\r?\n/, slurp($file) );
1993 splice(@buffer, 0, ($header || 0) );
1994 $count = scalar(@buffer);
1996 } elsif ( $type eq 'xls' ) {
1998 eval "use Spreadsheet::ParseExcel;";
2001 eval "use DateTime::Format::Excel;";
2002 #for now, just let the error be thrown if it is used, since only CDR
2003 # formats bill_west and troop use it, not other excel-parsing things
2006 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2008 $parser = $excel->{Worksheet}[0]; #first sheet
2010 $count = $parser->{MaxRow} || $parser->{MinRow};
2013 $row = $header || 0;
2015 } elsif ( $type eq 'xml' ) {
2018 eval "use XML::Simple;";
2020 my $xmlrow = $xml_format->{'xmlrow'};
2021 $parser = $xml_format->{'xmlkeys'};
2022 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2023 my $data = XML::Simple::XMLin(
2025 'SuppressEmpty' => '', #sets empty values to ''
2029 $rows = $rows->{$_} foreach @$xmlrow;
2030 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2031 $count = @buffer = @$rows;
2033 } elsif ( $type eq 'asn.1' ) {
2035 eval "use Convert::ASN1";
2038 my $asn = Convert::ASN1->new;
2039 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2041 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2043 my $data = slurp($file);
2044 my $asn_output = $parser->decode( $data )
2045 or return "No ". $asn_format->{'macro'}. " found\n";
2047 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2049 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2050 $count = @buffer = @$rows;
2053 die "Unknown file type $type\n";
2058 local $SIG{HUP} = 'IGNORE';
2059 local $SIG{INT} = 'IGNORE';
2060 local $SIG{QUIT} = 'IGNORE';
2061 local $SIG{TERM} = 'IGNORE';
2062 local $SIG{TSTP} = 'IGNORE';
2063 local $SIG{PIPE} = 'IGNORE';
2065 my $oldAutoCommit = $FS::UID::AutoCommit;
2066 local $FS::UID::AutoCommit = 0;
2069 #my $params = $param->{params} || {};
2070 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2071 my $batch_col = $param->{'batch_keycol'};
2073 my $batch_class = 'FS::'. $param->{'batch_table'};
2074 my $batch = $batch_class->new({
2075 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2077 my $error = $batch->insert;
2079 $dbh->rollback if $oldAutoCommit;
2080 return "can't insert batch record: $error";
2082 #primary key via dbdef? (so the column names don't have to match)
2083 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2085 $params->{ $batch_col } = $batch_value;
2088 #my $job = $param->{job};
2091 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2095 my %hash = %$params;
2096 if ( $type eq 'csv' ) {
2098 last unless scalar(@buffer);
2099 $line = shift(@buffer);
2101 next if $line =~ /^\s*$/; #skip empty lines
2103 $line = &{$row_callback}($line) if $row_callback;
2105 next if $line =~ /^\s*$/; #skip empty lines
2107 $parser->parse($line) or do {
2108 $dbh->rollback if $oldAutoCommit;
2109 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2111 @columns = $parser->fields();
2113 } elsif ( $type eq 'fixedlength' ) {
2115 last unless scalar(@buffer);
2116 $line = shift(@buffer);
2118 @columns = $parser->parse($line);
2120 } elsif ( $type eq 'xls' ) {
2122 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2123 || ! $parser->{Cells}[$row];
2125 my @row = @{ $parser->{Cells}[$row] };
2126 @columns = map $_->{Val}, @row;
2129 #warn $z++. ": $_\n" for @columns;
2131 } elsif ( $type eq 'xml' ) {
2133 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2134 last unless scalar(@buffer);
2135 my $row = shift @buffer;
2136 @columns = @{ $row }{ @$parser };
2138 } elsif ( $type eq 'asn.1' ) {
2140 last unless scalar(@buffer);
2141 my $row = shift @buffer;
2142 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2143 if $asn_format->{row_callback};
2144 foreach my $key ( keys %{ $asn_format->{map} } ) {
2145 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2149 die "Unknown file type $type\n";
2154 foreach my $field ( @fields ) {
2156 my $value = shift @columns;
2158 if ( ref($field) eq 'CODE' ) {
2159 #&{$field}(\%hash, $value);
2160 push @later, $field, $value;
2162 #??? $hash{$field} = $value if length($value);
2163 $hash{$field} = $value if defined($value) && length($value);
2168 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2169 && length($1) == $custnum_length ) {
2170 $hash{custnum} = $2;
2173 #my $table = $param->{table};
2174 my $class = "FS::$table";
2176 my $record = $class->new( \%hash );
2179 while ( scalar(@later) ) {
2180 my $sub = shift @later;
2181 my $data = shift @later;
2183 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2186 $dbh->rollback if $oldAutoCommit;
2187 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2189 last if exists( $param->{skiprow} );
2191 next if exists( $param->{skiprow} );
2193 if ( $preinsert_callback ) {
2194 my $error = &{$preinsert_callback}($record, $param);
2196 $dbh->rollback if $oldAutoCommit;
2197 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2200 next if exists $param->{skiprow} && $param->{skiprow};
2203 my $error = $record->insert;
2206 $dbh->rollback if $oldAutoCommit;
2207 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2213 if ( $postinsert_callback ) {
2214 my $error = &{$postinsert_callback}($record, $param);
2216 $dbh->rollback if $oldAutoCommit;
2217 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2222 if ( $job && time - $min_sec > $last ) { #progress bar
2223 $job->update_statustext( int(100 * $imported / $count) );
2229 unless ( $imported || $param->{empty_ok} ) {
2230 $dbh->rollback if $oldAutoCommit;
2231 return "Empty file!";
2234 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2241 my( $self, $action, $time ) = @_;
2245 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2248 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2249 real_fields($self->table);
2252 # If we're encrypting then don't store the payinfo in the history
2253 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
2254 @fields = grep { $_ ne 'payinfo' } @fields;
2257 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2259 "INSERT INTO h_". $self->table. " ( ".
2260 join(', ', qw(history_date history_usernum history_action), @fields ).
2263 $FS::CurrentUser::CurrentUser->usernum,
2264 dbh->quote($action),
2273 B<Warning>: External use is B<deprecated>.
2275 Replaces COLUMN in record with a unique number, using counters in the
2276 filesystem. Used by the B<insert> method on single-field unique columns
2277 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2278 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2280 Returns the new value.
2285 my($self,$field) = @_;
2286 my($table)=$self->table;
2288 croak "Unique called on field $field, but it is ",
2289 $self->getfield($field),
2291 if $self->getfield($field);
2293 #warn "table $table is tainted" if is_tainted($table);
2294 #warn "field $field is tainted" if is_tainted($field);
2296 my($counter) = new File::CounterFile "$table.$field",0;
2298 my $index = $counter->inc;
2299 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2301 $index =~ /^(\d*)$/;
2304 $self->setfield($field,$index);
2308 =item ut_float COLUMN
2310 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2311 null. If there is an error, returns the error, otherwise returns false.
2316 my($self,$field)=@_ ;
2317 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2318 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2319 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2320 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2321 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2322 $self->setfield($field,$1);
2325 =item ut_floatn COLUMN
2327 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2328 null. If there is an error, returns the error, otherwise returns false.
2332 #false laziness w/ut_ipn
2334 my( $self, $field ) = @_;
2335 if ( $self->getfield($field) =~ /^()$/ ) {
2336 $self->setfield($field,'');
2339 $self->ut_float($field);
2343 =item ut_sfloat COLUMN
2345 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2346 May not be null. If there is an error, returns the error, otherwise returns
2352 my($self,$field)=@_ ;
2353 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2354 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2355 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2356 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2357 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2358 $self->setfield($field,$1);
2361 =item ut_sfloatn COLUMN
2363 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2364 null. If there is an error, returns the error, otherwise returns false.
2369 my( $self, $field ) = @_;
2370 if ( $self->getfield($field) =~ /^()$/ ) {
2371 $self->setfield($field,'');
2374 $self->ut_sfloat($field);
2378 =item ut_snumber COLUMN
2380 Check/untaint signed numeric data (whole numbers). If there is an error,
2381 returns the error, otherwise returns false.
2386 my($self, $field) = @_;
2387 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2388 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2389 $self->setfield($field, "$1$2");
2393 =item ut_snumbern COLUMN
2395 Check/untaint signed numeric data (whole numbers). If there is an error,
2396 returns the error, otherwise returns false.
2401 my($self, $field) = @_;
2402 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2403 or return "Illegal (numeric) $field: ". $self->getfield($field);
2405 return "Illegal (numeric) $field: ". $self->getfield($field)
2408 $self->setfield($field, "$1$2");
2412 =item ut_number COLUMN
2414 Check/untaint simple numeric data (whole numbers). May not be null. If there
2415 is an error, returns the error, otherwise returns false.
2420 my($self,$field)=@_;
2421 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2422 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2423 $self->setfield($field,$1);
2427 =item ut_numbern COLUMN
2429 Check/untaint simple numeric data (whole numbers). May be null. If there is
2430 an error, returns the error, otherwise returns false.
2435 my($self,$field)=@_;
2436 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2437 or return "Illegal (numeric) $field: ". $self->getfield($field);
2438 $self->setfield($field,$1);
2442 =item ut_decimal COLUMN[, DIGITS]
2444 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2445 error, returns the error, otherwise returns false.
2447 =item ut_decimaln COLUMN[, DIGITS]
2449 Check/untaint decimal numbers. May be null. If there is an error, returns
2450 the error, otherwise returns false.
2455 my($self, $field, $digits) = @_;
2457 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2458 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2459 $self->setfield($field, $1);
2464 my($self, $field, $digits) = @_;
2465 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2466 or return "Illegal (decimal) $field: ".$self->getfield($field);
2467 $self->setfield($field, $1);
2471 =item ut_money COLUMN
2473 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2474 is an error, returns the error, otherwise returns false.
2479 my($self,$field)=@_;
2481 if ( $self->getfield($field) eq '' ) {
2482 $self->setfield($field, 0);
2483 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2484 #handle one decimal place without barfing out
2485 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2486 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2487 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2489 return "Illegal (money) $field: ". $self->getfield($field);
2495 =item ut_moneyn COLUMN
2497 Check/untaint monetary numbers. May be negative. If there
2498 is an error, returns the error, otherwise returns false.
2503 my($self,$field)=@_;
2504 if ($self->getfield($field) eq '') {
2505 $self->setfield($field, '');
2508 $self->ut_money($field);
2511 =item ut_currencyn COLUMN
2513 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2514 is an error, returns the error, otherwise returns false.
2519 my($self, $field) = @_;
2520 if ($self->getfield($field) eq '') { #can be null
2521 $self->setfield($field, '');
2524 $self->ut_currency($field);
2527 =item ut_currency COLUMN
2529 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2530 there is an error, returns the error, otherwise returns false.
2535 my($self, $field) = @_;
2536 my $value = uc( $self->getfield($field) );
2537 if ( code2currency($value) ) {
2538 $self->setfield($value);
2540 return "Unknown currency $value";
2546 =item ut_text COLUMN
2548 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2549 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2550 May not be null. If there is an error, returns the error, otherwise returns
2556 my($self,$field)=@_;
2557 #warn "msgcat ". \&msgcat. "\n";
2558 #warn "notexist ". \¬exist. "\n";
2559 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2560 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2561 # see perldoc perluniprops
2562 $self->getfield($field)
2563 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2564 or return gettext('illegal_or_empty_text'). " $field: ".
2565 $self->getfield($field);
2566 $self->setfield($field,$1);
2570 =item ut_textn COLUMN
2572 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2573 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2574 May be null. If there is an error, returns the error, otherwise returns false.
2579 my($self,$field)=@_;
2580 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2581 $self->ut_text($field);
2584 =item ut_alpha COLUMN
2586 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2587 an error, returns the error, otherwise returns false.
2592 my($self,$field)=@_;
2593 $self->getfield($field) =~ /^(\w+)$/
2594 or return "Illegal or empty (alphanumeric) $field: ".
2595 $self->getfield($field);
2596 $self->setfield($field,$1);
2600 =item ut_alphan COLUMN
2602 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2603 error, returns the error, otherwise returns false.
2608 my($self,$field)=@_;
2609 $self->getfield($field) =~ /^(\w*)$/
2610 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2611 $self->setfield($field,$1);
2615 =item ut_alphasn COLUMN
2617 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2618 an error, returns the error, otherwise returns false.
2623 my($self,$field)=@_;
2624 $self->getfield($field) =~ /^([\w ]*)$/
2625 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2626 $self->setfield($field,$1);
2631 =item ut_alpha_lower COLUMN
2633 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2634 there is an error, returns the error, otherwise returns false.
2638 sub ut_alpha_lower {
2639 my($self,$field)=@_;
2640 $self->getfield($field) =~ /[[:upper:]]/
2641 and return "Uppercase characters are not permitted in $field";
2642 $self->ut_alpha($field);
2645 =item ut_phonen COLUMN [ COUNTRY ]
2647 Check/untaint phone numbers. May be null. If there is an error, returns
2648 the error, otherwise returns false.
2650 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2651 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2656 my( $self, $field, $country ) = @_;
2657 return $self->ut_alphan($field) unless defined $country;
2658 my $phonen = $self->getfield($field);
2659 if ( $phonen eq '' ) {
2660 $self->setfield($field,'');
2661 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2663 $phonen = $conf->config('cust_main-default_areacode').$phonen
2664 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2665 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2666 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2667 $phonen = "$1-$2-$3";
2668 $phonen .= " x$4" if $4;
2669 $self->setfield($field,$phonen);
2671 warn "warning: don't know how to check phone numbers for country $country";
2672 return $self->ut_textn($field);
2679 Check/untaint hexadecimal values.
2684 my($self, $field) = @_;
2685 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2686 or return "Illegal (hex) $field: ". $self->getfield($field);
2687 $self->setfield($field, uc($1));
2691 =item ut_hexn COLUMN
2693 Check/untaint hexadecimal values. May be null.
2698 my($self, $field) = @_;
2699 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2700 or return "Illegal (hex) $field: ". $self->getfield($field);
2701 $self->setfield($field, uc($1));
2705 =item ut_mac_addr COLUMN
2707 Check/untaint mac addresses. May be null.
2712 my($self, $field) = @_;
2714 my $mac = $self->get($field);
2717 $self->set($field, $mac);
2719 my $e = $self->ut_hex($field);
2722 return "Illegal (mac address) $field: ". $self->getfield($field)
2723 unless length($self->getfield($field)) == 12;
2729 =item ut_mac_addrn COLUMN
2731 Check/untaint mac addresses. May be null.
2736 my($self, $field) = @_;
2737 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2742 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2748 my( $self, $field ) = @_;
2749 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2750 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2751 or return "Illegal (IP address) $field: ". $self->getfield($field);
2752 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2753 $self->setfield($field, "$1.$2.$3.$4");
2759 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2760 to 127.0.0.1. May be null.
2765 my( $self, $field ) = @_;
2766 if ( $self->getfield($field) =~ /^()$/ ) {
2767 $self->setfield($field,'');
2770 $self->ut_ip($field);
2774 =item ut_ip46 COLUMN
2776 Check/untaint IPv4 or IPv6 address.
2781 my( $self, $field ) = @_;
2782 my $ip = NetAddr::IP->new($self->getfield($field))
2783 or return "Illegal (IP address) $field: ".$self->getfield($field);
2784 $self->setfield($field, lc($ip->addr));
2790 Check/untaint IPv6 or IPv6 address. May be null.
2795 my( $self, $field ) = @_;
2796 if ( $self->getfield($field) =~ /^$/ ) {
2797 $self->setfield($field, '');
2800 $self->ut_ip46($field);
2803 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2805 Check/untaint coordinates.
2806 Accepts the following forms:
2816 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2817 The latter form (that is, the MMM are thousands of minutes) is
2818 assumed if the "MMM" is exactly three digits or two digits > 59.
2820 To be safe, just use the DDD.DDDDD form.
2822 If LOWER or UPPER are specified, then the coordinate is checked
2823 for lower and upper bounds, respectively.
2828 my ($self, $field) = (shift, shift);
2831 if ( $field =~ /latitude/ ) {
2832 $lower = $lat_lower;
2834 } elsif ( $field =~ /longitude/ ) {
2836 $upper = $lon_upper;
2839 my $coord = $self->getfield($field);
2840 my $neg = $coord =~ s/^(-)//;
2842 my ($d, $m, $s) = (0, 0, 0);
2845 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2846 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2847 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2849 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2852 return "Invalid (coordinate with minutes > 59) $field: "
2853 . $self->getfield($field);
2856 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2858 if (defined($lower) and ($coord < $lower)) {
2859 return "Invalid (coordinate < $lower) $field: "
2860 . $self->getfield($field);;
2863 if (defined($upper) and ($coord > $upper)) {
2864 return "Invalid (coordinate > $upper) $field: "
2865 . $self->getfield($field);;
2868 $self->setfield($field, $coord);
2872 return "Invalid (coordinate) $field: " . $self->getfield($field);
2876 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2878 Same as ut_coord, except optionally null.
2884 my ($self, $field) = (shift, shift);
2886 if ($self->getfield($field) =~ /^\s*$/) {
2889 return $self->ut_coord($field, @_);
2894 =item ut_domain COLUMN
2896 Check/untaint host and domain names. May not be null.
2901 my( $self, $field ) = @_;
2902 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2903 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2904 or return "Illegal (hostname) $field: ". $self->getfield($field);
2905 $self->setfield($field,$1);
2909 =item ut_domainn COLUMN
2911 Check/untaint host and domain names. May be null.
2916 my( $self, $field ) = @_;
2917 if ( $self->getfield($field) =~ /^()$/ ) {
2918 $self->setfield($field,'');
2921 $self->ut_domain($field);
2925 =item ut_name COLUMN
2927 Check/untaint proper names; allows alphanumerics, spaces and the following
2928 punctuation: , . - '
2935 my( $self, $field ) = @_;
2936 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2937 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
2938 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2943 $self->setfield($field, $name);
2947 =item ut_namen COLUMN
2949 Check/untaint proper names; allows alphanumerics, spaces and the following
2950 punctuation: , . - '
2957 my( $self, $field ) = @_;
2958 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2959 $self->ut_name($field);
2964 Check/untaint zip codes.
2968 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2971 my( $self, $field, $country ) = @_;
2973 if ( $country eq 'US' ) {
2975 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2976 or return gettext('illegal_zip'). " $field for country $country: ".
2977 $self->getfield($field);
2978 $self->setfield($field, $1);
2980 } elsif ( $country eq 'CA' ) {
2982 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2983 or return gettext('illegal_zip'). " $field for country $country: ".
2984 $self->getfield($field);
2985 $self->setfield($field, "$1 $2");
2989 if ( $self->getfield($field) =~ /^\s*$/
2990 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2993 $self->setfield($field,'');
2995 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2996 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2997 $self->setfield($field,$1);
3005 =item ut_country COLUMN
3007 Check/untaint country codes. Country names are changed to codes, if possible -
3008 see L<Locale::Country>.
3013 my( $self, $field ) = @_;
3014 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3015 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3016 && country2code($1) ) {
3017 $self->setfield($field,uc(country2code($1)));
3020 $self->getfield($field) =~ /^(\w\w)$/
3021 or return "Illegal (country) $field: ". $self->getfield($field);
3022 $self->setfield($field,uc($1));
3026 =item ut_anything COLUMN
3028 Untaints arbitrary data. Be careful.
3033 my( $self, $field ) = @_;
3034 $self->getfield($field) =~ /^(.*)$/s
3035 or return "Illegal $field: ". $self->getfield($field);
3036 $self->setfield($field,$1);
3040 =item ut_enum COLUMN CHOICES_ARRAYREF
3042 Check/untaint a column, supplying all possible choices, like the "enum" type.
3047 my( $self, $field, $choices ) = @_;
3048 foreach my $choice ( @$choices ) {
3049 if ( $self->getfield($field) eq $choice ) {
3050 $self->setfield($field, $choice);
3054 return "Illegal (enum) field $field: ". $self->getfield($field);
3057 =item ut_enumn COLUMN CHOICES_ARRAYREF
3059 Like ut_enum, except the null value is also allowed.
3064 my( $self, $field, $choices ) = @_;
3065 $self->getfield($field)
3066 ? $self->ut_enum($field, $choices)
3070 =item ut_flag COLUMN
3072 Check/untaint a column if it contains either an empty string or 'Y'. This
3073 is the standard form for boolean flags in Freeside.
3078 my( $self, $field ) = @_;
3079 my $value = uc($self->getfield($field));
3080 if ( $value eq '' or $value eq 'Y' ) {
3081 $self->setfield($field, $value);
3084 return "Illegal (flag) field $field: $value";
3087 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3089 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3090 on the column first.
3094 sub ut_foreign_key {
3095 my( $self, $field, $table, $foreign ) = @_;
3096 return '' if $no_check_foreign;
3097 qsearchs($table, { $foreign => $self->getfield($field) })
3098 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3099 " in $table.$foreign";
3103 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3105 Like ut_foreign_key, except the null value is also allowed.
3109 sub ut_foreign_keyn {
3110 my( $self, $field, $table, $foreign ) = @_;
3111 $self->getfield($field)
3112 ? $self->ut_foreign_key($field, $table, $foreign)
3116 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3118 Checks this column as an agentnum, taking into account the current users's
3119 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3120 right or rights allowing no agentnum.
3124 sub ut_agentnum_acl {
3125 my( $self, $field ) = (shift, shift);
3126 my $null_acl = scalar(@_) ? shift : [];
3127 $null_acl = [ $null_acl ] unless ref($null_acl);
3129 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3130 return "Illegal agentnum: $error" if $error;
3132 my $curuser = $FS::CurrentUser::CurrentUser;
3134 if ( $self->$field() ) {
3136 return 'Access denied to agent '. $self->$field()
3137 unless $curuser->agentnum($self->$field());
3141 return 'Access denied to global'
3142 unless grep $curuser->access_right($_), @$null_acl;
3150 =item fields [ TABLE ]
3152 This is a wrapper for real_fields. Code that called
3153 fields before should probably continue to call fields.
3158 my $something = shift;
3160 if($something->isa('FS::Record')) {
3161 $table = $something->table;
3163 $table = $something;
3164 #$something = "FS::$table";
3166 return (real_fields($table));
3170 =item encrypt($value)
3172 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3174 Returns the encrypted string.
3176 You should generally not have to worry about calling this, as the system handles this for you.
3181 my ($self, $value) = @_;
3182 my $encrypted = $value;
3184 if ($conf->exists('encryption')) {
3185 if ($self->is_encrypted($value)) {
3186 # Return the original value if it isn't plaintext.
3187 $encrypted = $value;
3190 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3191 # RSA doesn't like the empty string so let's pack it up
3192 # The database doesn't like the RSA data so uuencode it
3193 my $length = length($value)+1;
3194 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3196 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3203 =item is_encrypted($value)
3205 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3211 my ($self, $value) = @_;
3212 # could be more precise about it, but this will do for now
3213 $value =~ /^M/ && length($value) > 80;
3216 =item decrypt($value)
3218 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3220 You should generally not have to worry about calling this, as the system handles this for you.
3225 my ($self,$value) = @_;
3226 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3227 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
3229 if (ref($rsa_decrypt) =~ /::RSA/) {
3230 my $encrypted = unpack ("u*", $value);
3231 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3232 if ($@) {warn "Decryption Failed"};
3240 #Initialize the Module
3241 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3243 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
3244 $rsa_module = $conf->config('encryptionmodule');
3248 eval ("require $rsa_module"); # No need to import the namespace
3251 # Initialize Encryption
3252 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
3253 my $public_key = join("\n",$conf->config('encryptionpublickey'));
3254 $rsa_encrypt = $rsa_module->new_public_key($public_key);
3257 # Intitalize Decryption
3258 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
3259 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
3260 $rsa_decrypt = $rsa_module->new_private_key($private_key);
3264 =item h_search ACTION
3266 Given an ACTION, either "insert", or "delete", returns the appropriate history
3267 record corresponding to this record, if any.
3272 my( $self, $action ) = @_;
3274 my $table = $self->table;
3277 my $primary_key = dbdef->table($table)->primary_key;
3280 'table' => "h_$table",
3281 'hashref' => { $primary_key => $self->$primary_key(),
3282 'history_action' => $action,
3290 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3291 appropriate history record corresponding to this record, if any.
3296 my($self, $action) = @_;
3297 my $h = $self->h_search($action);
3298 $h ? $h->history_date : '';
3301 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3303 A class or object method. Executes the sql statement represented by SQL and
3304 returns a scalar representing the result: the first column of the first row.
3306 Dies on bogus SQL. Returns an empty string if no row is returned.
3308 Typically used for statments which return a single value such as "SELECT
3309 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3314 my($self, $sql) = (shift, shift);
3315 my $sth = dbh->prepare($sql) or die dbh->errstr;
3317 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3318 my $row = $sth->fetchrow_arrayref or return '';
3319 my $scalar = $row->[0];
3320 defined($scalar) ? $scalar : '';
3323 =item count [ WHERE [, PLACEHOLDER ...] ]
3325 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3326 with optional WHERE. Must be called as method on a class with an
3332 my($self, $where) = (shift, shift);
3333 my $table = $self->table or die 'count called on object of class '.ref($self);
3334 my $sql = "SELECT COUNT(*) FROM $table";
3335 $sql .= " WHERE $where" if $where;
3336 $self->scalar_sql($sql, @_);
3345 =item real_fields [ TABLE ]
3347 Returns a list of the real columns in the specified table. Called only by
3348 fields() and other subroutines elsewhere in FS::Record.
3355 my($table_obj) = dbdef->table($table);
3356 confess "Unknown table $table" unless $table_obj;
3357 $table_obj->columns;
3360 =item pvf FIELD_NAME
3362 Returns the FS::part_virtual_field object corresponding to a field in the
3363 record (specified by FIELD_NAME).
3368 my ($self, $name) = (shift, shift);
3370 if(grep /^$name$/, $self->virtual_fields) {
3372 my $concat = [ "'cf_'", "name" ];
3373 return qsearchs({ table => 'part_virtual_field',
3374 hashref => { dbtable => $self->table,
3377 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3383 =item _quote VALUE, TABLE, COLUMN
3385 This is an internal function used to construct SQL statements. It returns
3386 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3387 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3392 my($value, $table, $column) = @_;
3393 my $column_obj = dbdef->table($table)->column($column);
3394 my $column_type = $column_obj->type;
3395 my $nullable = $column_obj->null;
3397 utf8::upgrade($value);
3399 warn " $table.$column: $value ($column_type".
3400 ( $nullable ? ' NULL' : ' NOT NULL' ).
3401 ")\n" if $DEBUG > 2;
3403 if ( $value eq '' && $nullable ) {
3405 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3406 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3409 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3410 ! $column_type =~ /(char|binary|text)$/i ) {
3412 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3413 && driver_name eq 'Pg'
3417 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3418 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3419 # single-quote the whole mess, and put an "E" in front.
3420 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3428 This is deprecated. Don't use it.
3430 It returns a hash-type list with the fields of this record's table set true.
3435 carp "warning: hfields is deprecated";
3438 foreach (fields($table)) {
3447 "$_: ". $self->getfield($_). "|"
3448 } (fields($self->table)) );
3451 sub DESTROY { return; }
3455 # #use Carp qw(cluck);
3456 # #cluck "DESTROYING $self";
3457 # warn "DESTROYING $self";
3461 # return ! eval { join('',@_), kill 0; 1; };
3464 =item str2time_sql [ DRIVER_NAME ]
3466 Returns a function to convert to unix time based on database type, such as
3467 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3468 the str2time_sql_closing method to return a closing string rather than just
3469 using a closing parenthesis as previously suggested.
3471 You can pass an optional driver name such as "Pg", "mysql" or
3472 $dbh->{Driver}->{Name} to return a function for that database instead of
3473 the current database.
3478 my $driver = shift || driver_name;
3480 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3481 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3483 warn "warning: unknown database type $driver; guessing how to convert ".
3484 "dates to UNIX timestamps";
3485 return 'EXTRACT(EPOCH FROM ';
3489 =item str2time_sql_closing [ DRIVER_NAME ]
3491 Returns the closing suffix of a function to convert to unix time based on
3492 database type, such as ")::integer" for Pg or ")" for mysql.
3494 You can pass an optional driver name such as "Pg", "mysql" or
3495 $dbh->{Driver}->{Name} to return a function for that database instead of
3496 the current database.
3500 sub str2time_sql_closing {
3501 my $driver = shift || driver_name;
3503 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3507 =item regexp_sql [ DRIVER_NAME ]
3509 Returns the operator to do a regular expression comparison based on database
3510 type, such as '~' for Pg or 'REGEXP' for mysql.
3512 You can pass an optional driver name such as "Pg", "mysql" or
3513 $dbh->{Driver}->{Name} to return a function for that database instead of
3514 the current database.
3519 my $driver = shift || driver_name;
3521 return '~' if $driver =~ /^Pg/i;
3522 return 'REGEXP' if $driver =~ /^mysql/i;
3524 die "don't know how to use regular expressions in ". driver_name." databases";
3528 =item not_regexp_sql [ DRIVER_NAME ]
3530 Returns the operator to do a regular expression negation based on database
3531 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3533 You can pass an optional driver name such as "Pg", "mysql" or
3534 $dbh->{Driver}->{Name} to return a function for that database instead of
3535 the current database.
3539 sub not_regexp_sql {
3540 my $driver = shift || driver_name;
3542 return '!~' if $driver =~ /^Pg/i;
3543 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3545 die "don't know how to use regular expressions in ". driver_name." databases";
3549 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3551 Returns the items concatenated based on database type, using "CONCAT()" for
3552 mysql and " || " for Pg and other databases.
3554 You can pass an optional driver name such as "Pg", "mysql" or
3555 $dbh->{Driver}->{Name} to return a function for that database instead of
3556 the current database.
3561 my $driver = ref($_[0]) ? driver_name : shift;
3564 if ( $driver =~ /^mysql/i ) {
3565 'CONCAT('. join(',', @$items). ')';
3567 join('||', @$items);
3572 =item group_concat_sql COLUMN, DELIMITER
3574 Returns an SQL expression to concatenate an aggregate column, using
3575 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3579 sub group_concat_sql {
3580 my ($col, $delim) = @_;
3581 $delim = dbh->quote($delim);
3582 if ( driver_name() =~ /^mysql/i ) {
3583 # DISTINCT(foo) is valid as $col
3584 return "GROUP_CONCAT($col SEPARATOR $delim)";
3586 return "array_to_string(array_agg($col), $delim)";
3590 =item midnight_sql DATE
3592 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3593 on that day in the system timezone, using the default driver name.
3598 my $driver = driver_name;
3600 if ( $driver =~ /^mysql/i ) {
3601 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3604 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3612 This module should probably be renamed, since much of the functionality is
3613 of general use. It is not completely unlike Adapter::DBI (see below).
3615 Exported qsearch and qsearchs should be deprecated in favor of method calls
3616 (against an FS::Record object like the old search and searchs that qsearch
3617 and qsearchs were on top of.)
3619 The whole fields / hfields mess should be removed.
3621 The various WHERE clauses should be subroutined.
3623 table string should be deprecated in favor of DBIx::DBSchema::Table.
3625 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3626 true maps to the database (and WHERE clauses) would also help.
3628 The ut_ methods should ask the dbdef for a default length.
3630 ut_sqltype (like ut_varchar) should all be defined
3632 A fallback check method should be provided which uses the dbdef.
3634 The ut_money method assumes money has two decimal digits.
3636 The Pg money kludge in the new method only strips `$'.
3638 The ut_phonen method only checks US-style phone numbers.
3640 The _quote function should probably use ut_float instead of a regex.
3642 All the subroutines probably should be methods, here or elsewhere.
3644 Probably should borrow/use some dbdef methods where appropriate (like sub
3647 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3648 or allow it to be set. Working around it is ugly any way around - DBI should
3649 be fixed. (only affects RDBMS which return uppercase column names)
3651 ut_zip should take an optional country like ut_phone.
3655 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3657 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.