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 ) {
370 #stop altering the caller's hashref
371 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
372 my $select = shift @select;
373 my $extra_sql = shift @extra_sql;
374 my $extra_param = shift @extra_param;
375 my $order_by = shift @order_by;
376 my $cache = shift @cache;
377 my $addl_from = shift @addl_from;
378 my $debug = shift @debug;
380 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
382 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
385 my $table = $cache ? $cache->table : $stable;
386 my $dbdef_table = dbdef->table($table)
387 or die "No schema for table $table found - ".
388 "do you need to run freeside-upgrade?";
389 my $pkey = $dbdef_table->primary_key;
391 my @real_fields = grep exists($record->{$_}), real_fields($table);
393 my $statement .= "SELECT $select FROM $stable";
394 $statement .= " $addl_from" if $addl_from;
395 if ( @real_fields ) {
396 $statement .= ' WHERE '. join(' AND ',
397 get_real_fields($table, $record, \@real_fields));
400 $statement .= " $extra_sql" if defined($extra_sql);
401 $statement .= " $order_by" if defined($order_by);
403 push @statement, $statement;
405 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
409 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
412 my $value = $record->{$field};
413 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
414 $value = $value->{'value'} if ref($value);
415 my $type = dbdef->table($table)->column($field)->type;
417 my $bind_type = _bind_type($type, $value);
421 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
423 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
427 push @bind_type, $bind_type;
431 foreach my $param ( @$extra_param ) {
432 my $bind_type = { TYPE => SQL_VARCHAR };
435 $value = $param->[0];
436 my $type = $param->[1];
437 $bind_type = _bind_type($type, $value);
440 push @bind_type, $bind_type;
444 my $statement = join( ' ) UNION ( ', @statement );
445 $statement = "( $statement )" if scalar(@statement) > 1;
446 $statement .= " $union_options{order_by}" if $union_options{order_by};
448 my $sth = $dbh->prepare($statement)
449 or croak "$dbh->errstr doing $statement";
452 foreach my $value ( @value ) {
453 my $bind_type = shift @bind_type;
454 $sth->bind_param($bind++, $value, $bind_type );
457 # $sth->execute( map $record->{$_},
458 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
459 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
461 my $ok = $sth->execute;
463 my $error = "Error executing \"$statement\"";
464 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
465 $error .= ': '. $sth->errstr;
469 my $table = $stable[0];
471 $table = '' if grep { $_ ne $table } @stable;
472 $pkey = dbdef->table($table)->primary_key if $table;
475 tie %result, "Tie::IxHash";
476 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
477 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
478 %result = map { $_->{$pkey}, $_ } @stuff;
480 @result{@stuff} = @stuff;
486 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
487 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
488 #derivied class didn't override new method, so this optimization is safe
491 new_or_cached( "FS::$table", { %{$_} }, $cache )
495 new( "FS::$table", { %{$_} } )
499 #okay, its been tested
500 # warn "untested code (class FS::$table uses custom new method)";
502 eval 'FS::'. $table. '->new( { %{$_} } )';
506 # Check for encrypted fields and decrypt them.
507 ## only in the local copy, not the cached object
508 if ( $conf_encryption
509 && eval '@FS::'. $table . '::encrypted_fields' ) {
510 foreach my $record (@return) {
511 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
512 next if $field eq 'payinfo'
513 && ($record->isa('FS::payinfo_transaction_Mixin')
514 || $record->isa('FS::payinfo_Mixin') )
516 && !grep { $record->payby eq $_ } @encrypt_payby;
517 # Set it directly... This may cause a problem in the future...
518 $record->setfield($field, $record->decrypt($record->getfield($field)));
523 cluck "warning: FS::$table not loaded; returning FS::Record objects"
524 unless $nowarn_classload;
526 FS::Record->new( $table, { %{$_} } );
534 Construct the SQL statement and parameter-binding list for qsearch. Takes
535 the qsearch parameters.
537 Returns a hash containing:
538 'table': The primary table name (if there is one).
539 'statement': The SQL statement itself.
540 'bind_type': An arrayref of bind types.
541 'value': An arrayref of parameter values.
542 'cache': The cache object, if one was passed.
547 my( @stable, @record, @cache );
548 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
551 my %union_options = ();
552 if ( ref($_[0]) eq 'ARRAY' ) {
555 foreach my $href ( @$optlist ) {
556 push @stable, ( $href->{'table'} or die "table name is required" );
557 push @record, ( $href->{'hashref'} || {} );
558 push @select, ( $href->{'select'} || '*' );
559 push @extra_sql, ( $href->{'extra_sql'} || '' );
560 push @extra_param, ( $href->{'extra_param'} || [] );
561 push @order_by, ( $href->{'order_by'} || '' );
562 push @cache, ( $href->{'cache_obj'} || '' );
563 push @addl_from, ( $href->{'addl_from'} || '' );
564 push @debug, ( $href->{'debug'} || '' );
566 die "at least one hashref is required" unless scalar(@stable);
567 } elsif ( ref($_[0]) eq 'HASH' ) {
569 $stable[0] = $opt->{'table'} or die "table name is required";
570 $record[0] = $opt->{'hashref'} || {};
571 $select[0] = $opt->{'select'} || '*';
572 $extra_sql[0] = $opt->{'extra_sql'} || '';
573 $extra_param[0] = $opt->{'extra_param'} || [];
574 $order_by[0] = $opt->{'order_by'} || '';
575 $cache[0] = $opt->{'cache_obj'} || '';
576 $addl_from[0] = $opt->{'addl_from'} || '';
577 $debug[0] = $opt->{'debug'} || '';
588 my $cache = $cache[0];
594 my $result_table = $stable[0];
595 foreach my $stable ( @stable ) {
596 #stop altering the caller's hashref
597 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
598 my $select = shift @select;
599 my $extra_sql = shift @extra_sql;
600 my $extra_param = shift @extra_param;
601 my $order_by = shift @order_by;
602 my $cache = shift @cache;
603 my $addl_from = shift @addl_from;
604 my $debug = shift @debug;
606 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
608 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
611 $result_table = '' if $result_table ne $stable;
613 my $table = $cache ? $cache->table : $stable;
614 my $dbdef_table = dbdef->table($table)
615 or die "No schema for table $table found - ".
616 "do you need to run freeside-upgrade?";
617 my $pkey = $dbdef_table->primary_key;
619 my @real_fields = grep exists($record->{$_}), real_fields($table);
621 my $statement .= "SELECT $select FROM $stable";
622 $statement .= " $addl_from" if $addl_from;
623 if ( @real_fields ) {
624 $statement .= ' WHERE '. join(' AND ',
625 get_real_fields($table, $record, \@real_fields));
628 $statement .= " $extra_sql" if defined($extra_sql);
629 $statement .= " $order_by" if defined($order_by);
631 push @statement, $statement;
633 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
637 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
640 my $value = $record->{$field};
641 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
642 $value = $value->{'value'} if ref($value);
643 my $type = dbdef->table($table)->column($field)->type;
645 my $bind_type = _bind_type($type, $value);
649 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
651 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
655 push @bind_type, $bind_type;
659 foreach my $param ( @$extra_param ) {
660 my $bind_type = { TYPE => SQL_VARCHAR };
663 $value = $param->[0];
664 my $type = $param->[1];
665 $bind_type = _bind_type($type, $value);
668 push @bind_type, $bind_type;
672 my $statement = join( ' ) UNION ( ', @statement );
673 $statement = "( $statement )" if scalar(@statement) > 1;
674 $statement .= " $union_options{order_by}" if $union_options{order_by};
677 statement => $statement,
678 bind_type => \@bind_type,
680 table => $result_table,
685 # qsearch should eventually use this
687 my ($table, $cache, @hashrefs) = @_;
689 # XXX get rid of these string evals at some point
690 # (when we have time to test it)
691 # my $class = "FS::$table" if $table;
692 # if ( $class and $class->isa('FS::Record') )
693 # if ( $class->can('new') eq \&new )
695 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
696 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
697 #derivied class didn't override new method, so this optimization is safe
700 new_or_cached( "FS::$table", { %{$_} }, $cache )
704 new( "FS::$table", { %{$_} } )
708 #okay, its been tested
709 # warn "untested code (class FS::$table uses custom new method)";
711 eval 'FS::'. $table. '->new( { %{$_} } )';
715 # Check for encrypted fields and decrypt them.
716 ## only in the local copy, not the cached object
717 if ( $conf_encryption
718 && eval '@FS::'. $table . '::encrypted_fields' ) {
719 foreach my $record (@return) {
720 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
721 next if $field eq 'payinfo'
722 && ($record->isa('FS::payinfo_transaction_Mixin')
723 || $record->isa('FS::payinfo_Mixin') )
725 && !grep { $record->payby eq $_ } @encrypt_payby;
726 # Set it directly... This may cause a problem in the future...
727 $record->setfield($field, $record->decrypt($record->getfield($field)));
732 cluck "warning: FS::$table not loaded; returning FS::Record objects"
733 unless $nowarn_classload;
735 FS::Record->new( $table, { %{$_} } );
741 ## makes this easier to read
743 sub get_real_fields {
746 my $real_fields = shift;
748 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
754 my $type = dbdef->table($table)->column($column)->type;
755 my $value = $record->{$column};
756 $value = $value->{'value'} if ref($value);
757 if ( ref($record->{$_}) ) {
758 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
759 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
760 if ( uc($op) eq 'ILIKE' ) {
762 $record->{$_}{'value'} = lc($record->{$_}{'value'});
763 $column = "LOWER($_)";
765 $record->{$_} = $record->{$_}{'value'}
768 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
770 if ( driver_name eq 'Pg' ) {
771 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
772 qq-( $column IS NULL )-;
774 qq-( $column IS NULL OR $column = '' )-;
777 qq-( $column IS NULL OR $column = "" )-;
779 } elsif ( $op eq '!=' ) {
780 if ( driver_name eq 'Pg' ) {
781 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
782 qq-( $column IS NOT NULL )-;
784 qq-( $column IS NOT NULL AND $column != '' )-;
787 qq-( $column IS NOT NULL AND $column != "" )-;
790 if ( driver_name eq 'Pg' ) {
791 qq-( $column $op '' )-;
793 qq-( $column $op "" )-;
796 } elsif ( $op eq '!=' ) {
797 qq-( $column IS NULL OR $column != ? )-;
798 #if this needs to be re-enabled, it needs to use a custom op like
799 #"APPROX=" or something (better name?, not '=', to avoid affecting other
801 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
802 # ( "$column <= ?", "$column >= ?" );
806 } @{ $real_fields } );
809 =item by_key PRIMARY_KEY_VALUE
811 This is a class method that returns the record with the given primary key
812 value. This method is only useful in FS::Record subclasses. For example:
814 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
818 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
823 my ($class, $pkey_value) = @_;
825 my $table = $class->table
826 or croak "No table for $class found";
828 my $dbdef_table = dbdef->table($table)
829 or die "No schema for table $table found - ".
830 "do you need to create it or run dbdef-create?";
831 my $pkey = $dbdef_table->primary_key
832 or die "No primary key for table $table";
834 return qsearchs($table, { $pkey => $pkey_value });
837 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
839 Experimental JOINed search method. Using this method, you can execute a
840 single SELECT spanning multiple tables, and cache the results for subsequent
841 method calls. Interface will almost definately change in an incompatible
849 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
850 my $cache = FS::SearchCache->new( $ptable, $pkey );
853 grep { !$saw{$_->getfield($pkey)}++ }
854 qsearch($table, $record, $select, $extra_sql, $cache )
858 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
860 Same as qsearch, except that if more than one record matches, it B<carp>s but
861 returns the first. If this happens, you either made a logic error in asking
862 for a single item, or your data is corrupted.
866 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
868 my(@result) = qsearch(@_);
869 cluck "warning: Multiple records in scalar search ($table)"
870 if scalar(@result) > 1;
871 #should warn more vehemently if the search was on a primary key?
872 scalar(@result) ? ($result[0]) : ();
883 Returns the table name.
888 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
895 Returns the DBIx::DBSchema::Table object for the table.
901 my($table)=$self->table;
902 dbdef->table($table);
907 Returns the primary key for the table.
913 my $pkey = $self->dbdef_table->primary_key;
916 =item get, getfield COLUMN
918 Returns the value of the column/field/key COLUMN.
923 my($self,$field) = @_;
924 # to avoid "Use of unitialized value" errors
925 if ( defined ( $self->{Hash}->{$field} ) ) {
926 $self->{Hash}->{$field};
936 =item set, setfield COLUMN, VALUE
938 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
943 my($self,$field,$value) = @_;
944 $self->{'modified'} = 1;
945 $self->{'Hash'}->{$field} = $value;
954 Returns true if the column/field/key COLUMN exists.
959 my($self,$field) = @_;
960 exists($self->{Hash}->{$field});
963 =item AUTLOADED METHODS
965 $record->column is a synonym for $record->get('column');
967 $record->column('value') is a synonym for $record->set('column','value');
969 $record->foreign_table_name calls qsearchs and returns a single
970 FS::foreign_table record (for tables referenced by a column of this table) or
971 qsearch and returns an array of FS::foreign_table records (for tables
972 referenced by a column in the foreign table).
979 my($field)=$AUTOLOAD;
982 confess "errant AUTOLOAD $field for $self (arg $value)"
983 unless blessed($self) && $self->can('setfield');
985 #$fk_method_cache{$self->table} ||= fk_methods($self->table);
986 if ( exists($fk_method_cache{$self->table}->{$field}) ) {
988 my $fk_info = $fk_method_cache{$self->table}->{$field};
989 my $method = $fk_info->{method} || 'qsearchs';
990 my $table = $fk_info->{table} || $field;
991 my $column = $fk_info->{column};
992 my $foreign_column = $fk_info->{references} || $column;
994 eval "use FS::$table";
997 my $pkey_value = $self->$column();
998 my %search = ( $foreign_column => $pkey_value );
1000 # FS::Record->$method() ? they're actually just subs :/
1001 if ( $method eq 'qsearchs' ) {
1002 return $pkey_value ? qsearchs( $table, \%search ) : '';
1003 } elsif ( $method eq 'qsearch' ) {
1004 return $pkey_value ? qsearch( $table, \%search ) : ();
1006 die "unknown method $method";
1011 if ( defined($value) ) {
1012 $self->setfield($field,$value);
1014 $self->getfield($field);
1018 # efficient (also, old, doesn't support FK stuff)
1020 # my $field = $AUTOLOAD;
1021 # $field =~ s/.*://;
1022 # if ( defined($_[1]) ) {
1023 # $_[0]->setfield($field, $_[1]);
1025 # $_[0]->getfield($field);
1034 # foreign keys we reference in other tables
1035 foreach my $fk (dbdef->table($table)->foreign_keys) {
1038 if ( scalar( @{$fk->columns} ) == 1 ) {
1039 if ( ! @{$fk->references} || $fk->columns->[0] eq $fk->references->[0] ){
1040 $method = $fk->table;
1042 #some sort of hint in the table.pm or schema for methods not named
1043 # after their foreign table (well, not a whole lot different than
1044 # just providing a small subroutine...)
1048 $hash{$method} = { #fk_info
1049 'method' => 'qsearchs',
1050 'column' => $fk->columns->[0],
1051 #'references' => $fk->references->[0],
1059 # foreign keys referenced in other tables to us
1060 # (alas. why we're cached. still, might this loop better be done once at
1061 # schema load time insetad of every time we AUTOLOAD a method on a new
1063 foreach my $f_table ( dbdef->tables ) {
1064 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1066 next unless $fk->table eq $table;
1069 if ( scalar( @{$fk->columns} ) == 1 ) {
1070 if ( ! @{$fk->references} || $fk->columns->[0] eq $fk->references->[0] ){
1073 #some sort of hint in the table.pm or schema for methods not named
1074 # after their foreign table (well, not a whole lot different than
1075 # just providing a small subroutine...)
1079 $hash{$method} = { #fk_info
1080 'method' => 'qsearch',
1081 'column' => $fk->columns->[0], #references||column
1082 #'references' => $fk->column->[0],
1097 Returns a list of the column/value pairs, usually for assigning to a new hash.
1099 To make a distinct duplicate of an FS::Record object, you can do:
1101 $new = new FS::Record ( $old->table, { $old->hash } );
1107 confess $self. ' -> hash: Hash attribute is undefined'
1108 unless defined($self->{'Hash'});
1109 %{ $self->{'Hash'} };
1114 Returns a reference to the column/value hash. This may be deprecated in the
1115 future; if there's a reason you can't just use the autoloaded or get/set
1127 Returns true if any of this object's values have been modified with set (or via
1128 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1135 $self->{'modified'};
1138 =item select_for_update
1140 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1145 sub select_for_update {
1147 my $primary_key = $self->primary_key;
1150 'table' => $self->table,
1151 'hashref' => { $primary_key => $self->$primary_key() },
1152 'extra_sql' => 'FOR UPDATE',
1158 Locks this table with a database-driver specific lock method. This is used
1159 as a mutex in order to do a duplicate search.
1161 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1163 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1165 Errors are fatal; no useful return value.
1167 Note: To use this method for new tables other than svc_acct and svc_phone,
1168 edit freeside-upgrade and add those tables to the duplicate_lock list.
1174 my $table = $self->table;
1176 warn "$me locking $table table\n" if $DEBUG;
1178 if ( driver_name =~ /^Pg/i ) {
1180 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1183 } elsif ( driver_name =~ /^mysql/i ) {
1185 dbh->do("SELECT * FROM duplicate_lock
1186 WHERE lockname = '$table'
1188 ) or die dbh->errstr;
1192 die "unknown database ". driver_name. "; don't know how to lock table";
1196 warn "$me acquired $table table lock\n" if $DEBUG;
1202 Inserts this record to the database. If there is an error, returns the error,
1203 otherwise returns false.
1211 warn "$self -> insert" if $DEBUG;
1213 my $error = $self->check;
1214 return $error if $error;
1216 #single-field non-null unique keys are given a value if empty
1217 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1218 foreach ( $self->dbdef_table->unique_singles) {
1219 next if $self->getfield($_);
1220 next if $self->dbdef_table->column($_)->null eq 'NULL';
1224 #and also the primary key, if the database isn't going to
1225 my $primary_key = $self->dbdef_table->primary_key;
1227 if ( $primary_key ) {
1228 my $col = $self->dbdef_table->column($primary_key);
1231 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1232 || ( driver_name eq 'Pg'
1233 && defined($col->default)
1234 && $col->quoted_default =~ /^nextval\(/i
1236 || ( driver_name eq 'mysql'
1237 && defined($col->local)
1238 && $col->local =~ /AUTO_INCREMENT/i
1240 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1243 my $table = $self->table;
1245 # Encrypt before the database
1246 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
1247 && scalar( eval '@FS::'. $table . '::encrypted_fields')
1248 && $conf->exists('encryption')
1250 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1251 next if $field eq 'payinfo'
1252 && ($self->isa('FS::payinfo_transaction_Mixin')
1253 || $self->isa('FS::payinfo_Mixin') )
1255 && !grep { $self->payby eq $_ } @encrypt_payby;
1256 $saved->{$field} = $self->getfield($field);
1257 $self->setfield($field, $self->encrypt($self->getfield($field)));
1261 #false laziness w/delete
1263 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1266 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1269 my $statement = "INSERT INTO $table ";
1270 if ( @real_fields ) {
1273 join( ', ', @real_fields ).
1275 join( ', ', @values ).
1279 $statement .= 'DEFAULT VALUES';
1281 warn "[debug]$me $statement\n" if $DEBUG > 1;
1282 my $sth = dbh->prepare($statement) or return dbh->errstr;
1284 local $SIG{HUP} = 'IGNORE';
1285 local $SIG{INT} = 'IGNORE';
1286 local $SIG{QUIT} = 'IGNORE';
1287 local $SIG{TERM} = 'IGNORE';
1288 local $SIG{TSTP} = 'IGNORE';
1289 local $SIG{PIPE} = 'IGNORE';
1291 $sth->execute or return $sth->errstr;
1293 # get inserted id from the database, if applicable & needed
1294 if ( $db_seq && ! $self->getfield($primary_key) ) {
1295 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1299 if ( driver_name eq 'Pg' ) {
1301 #my $oid = $sth->{'pg_oid_status'};
1302 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1304 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1305 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1306 dbh->rollback if $FS::UID::AutoCommit;
1307 return "can't parse $table.$primary_key default value".
1308 " for sequence name: $default";
1312 my $i_sql = "SELECT currval('$sequence')";
1313 my $i_sth = dbh->prepare($i_sql) or do {
1314 dbh->rollback if $FS::UID::AutoCommit;
1317 $i_sth->execute() or do { #$i_sth->execute($oid)
1318 dbh->rollback if $FS::UID::AutoCommit;
1319 return $i_sth->errstr;
1321 $insertid = $i_sth->fetchrow_arrayref->[0];
1323 } elsif ( driver_name eq 'mysql' ) {
1325 $insertid = dbh->{'mysql_insertid'};
1326 # work around mysql_insertid being null some of the time, ala RT :/
1327 unless ( $insertid ) {
1328 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1329 "using SELECT LAST_INSERT_ID();";
1330 my $i_sql = "SELECT LAST_INSERT_ID()";
1331 my $i_sth = dbh->prepare($i_sql) or do {
1332 dbh->rollback if $FS::UID::AutoCommit;
1335 $i_sth->execute or do {
1336 dbh->rollback if $FS::UID::AutoCommit;
1337 return $i_sth->errstr;
1339 $insertid = $i_sth->fetchrow_arrayref->[0];
1344 dbh->rollback if $FS::UID::AutoCommit;
1345 return "don't know how to retreive inserted ids from ". driver_name.
1346 ", try using counterfiles (maybe run dbdef-create?)";
1350 $self->setfield($primary_key, $insertid);
1355 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1356 my $h_statement = $self->_h_statement('insert');
1357 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1358 $h_sth = dbh->prepare($h_statement) or do {
1359 dbh->rollback if $FS::UID::AutoCommit;
1365 $h_sth->execute or return $h_sth->errstr if $h_sth;
1367 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1369 # Now that it has been saved, reset the encrypted fields so that $new
1370 # can still be used.
1371 foreach my $field (keys %{$saved}) {
1372 $self->setfield($field, $saved->{$field});
1380 Depriciated (use insert instead).
1385 cluck "warning: FS::Record::add deprecated!";
1386 insert @_; #call method in this scope
1391 Delete this record from the database. If there is an error, returns the error,
1392 otherwise returns false.
1399 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1401 $self->getfield($_) eq ''
1402 #? "( $_ IS NULL OR $_ = \"\" )"
1403 ? ( driver_name eq 'Pg'
1405 : "( $_ IS NULL OR $_ = \"\" )"
1407 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1408 } ( $self->dbdef_table->primary_key )
1409 ? ( $self->dbdef_table->primary_key)
1410 : real_fields($self->table)
1412 warn "[debug]$me $statement\n" if $DEBUG > 1;
1413 my $sth = dbh->prepare($statement) or return dbh->errstr;
1416 if ( defined dbdef->table('h_'. $self->table) ) {
1417 my $h_statement = $self->_h_statement('delete');
1418 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1419 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1424 my $primary_key = $self->dbdef_table->primary_key;
1426 local $SIG{HUP} = 'IGNORE';
1427 local $SIG{INT} = 'IGNORE';
1428 local $SIG{QUIT} = 'IGNORE';
1429 local $SIG{TERM} = 'IGNORE';
1430 local $SIG{TSTP} = 'IGNORE';
1431 local $SIG{PIPE} = 'IGNORE';
1433 my $rc = $sth->execute or return $sth->errstr;
1434 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1435 $h_sth->execute or return $h_sth->errstr if $h_sth;
1437 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1439 #no need to needlessly destoy the data either (causes problems actually)
1440 #undef $self; #no need to keep object!
1447 Depriciated (use delete instead).
1452 cluck "warning: FS::Record::del deprecated!";
1453 &delete(@_); #call method in this scope
1456 =item replace OLD_RECORD
1458 Replace the OLD_RECORD with this one in the database. If there is an error,
1459 returns the error, otherwise returns false.
1464 my ($new, $old) = (shift, shift);
1466 $old = $new->replace_old unless defined($old);
1468 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1470 if ( $new->can('replace_check') ) {
1471 my $error = $new->replace_check($old);
1472 return $error if $error;
1475 return "Records not in same table!" unless $new->table eq $old->table;
1477 my $primary_key = $old->dbdef_table->primary_key;
1478 return "Can't change primary key $primary_key ".
1479 'from '. $old->getfield($primary_key).
1480 ' to ' . $new->getfield($primary_key)
1482 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1484 my $error = $new->check;
1485 return $error if $error;
1487 # Encrypt for replace
1489 if ( $conf->exists('encryption')
1490 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1491 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1493 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1494 next if $field eq 'payinfo'
1495 && ($new->isa('FS::payinfo_transaction_Mixin')
1496 || $new->isa('FS::payinfo_Mixin') )
1498 && !grep { $new->payby eq $_ } @encrypt_payby;
1499 $saved->{$field} = $new->getfield($field);
1500 $new->setfield($field, $new->encrypt($new->getfield($field)));
1504 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1505 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1506 ? ($_, $new->getfield($_)) : () } $old->fields;
1508 unless (keys(%diff) || $no_update_diff ) {
1509 carp "[warning]$me ". ref($new)."->replace ".
1510 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1511 ": records identical"
1512 unless $nowarn_identical;
1516 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1518 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1519 } real_fields($old->table)
1524 if ( $old->getfield($_) eq '' ) {
1526 #false laziness w/qsearch
1527 if ( driver_name eq 'Pg' ) {
1528 my $type = $old->dbdef_table->column($_)->type;
1529 if ( $type =~ /(int|(big)?serial)/i ) {
1532 qq-( $_ IS NULL OR $_ = '' )-;
1535 qq-( $_ IS NULL OR $_ = "" )-;
1539 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1542 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1545 warn "[debug]$me $statement\n" if $DEBUG > 1;
1546 my $sth = dbh->prepare($statement) or return dbh->errstr;
1549 if ( defined dbdef->table('h_'. $old->table) ) {
1550 my $h_old_statement = $old->_h_statement('replace_old');
1551 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1552 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1558 if ( defined dbdef->table('h_'. $new->table) ) {
1559 my $h_new_statement = $new->_h_statement('replace_new');
1560 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1561 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1566 local $SIG{HUP} = 'IGNORE';
1567 local $SIG{INT} = 'IGNORE';
1568 local $SIG{QUIT} = 'IGNORE';
1569 local $SIG{TERM} = 'IGNORE';
1570 local $SIG{TSTP} = 'IGNORE';
1571 local $SIG{PIPE} = 'IGNORE';
1573 my $rc = $sth->execute or return $sth->errstr;
1574 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1575 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1576 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1578 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1580 # Now that it has been saved, reset the encrypted fields so that $new
1581 # can still be used.
1582 foreach my $field (keys %{$saved}) {
1583 $new->setfield($field, $saved->{$field});
1591 my( $self ) = shift;
1592 warn "[$me] replace called with no arguments; autoloading old record\n"
1595 my $primary_key = $self->dbdef_table->primary_key;
1596 if ( $primary_key ) {
1597 $self->by_key( $self->$primary_key() ) #this is what's returned
1598 or croak "can't find ". $self->table. ".$primary_key ".
1599 $self->$primary_key();
1601 croak $self->table. " has no primary key; pass old record as argument";
1608 Depriciated (use replace instead).
1613 cluck "warning: FS::Record::rep deprecated!";
1614 replace @_; #call method in this scope
1619 Checks custom fields. Subclasses should still provide a check method to validate
1620 non-custom fields, etc., and call this method via $self->SUPER::check.
1626 foreach my $field ($self->virtual_fields) {
1627 my $error = $self->ut_textn($field);
1628 return $error if $error;
1633 =item virtual_fields [ TABLE ]
1635 Returns a list of virtual fields defined for the table. This should not
1636 be exported, and should only be called as an instance or class method.
1640 sub virtual_fields {
1643 $table = $self->table or confess "virtual_fields called on non-table";
1645 confess "Unknown table $table" unless dbdef->table($table);
1647 return () unless dbdef->table('part_virtual_field');
1649 unless ( $virtual_fields_cache{$table} ) {
1650 my $concat = [ "'cf_'", "name" ];
1651 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1652 "WHERE dbtable = '$table'";
1654 my $result = $dbh->selectcol_arrayref($query);
1655 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1657 $virtual_fields_cache{$table} = $result;
1660 @{$virtual_fields_cache{$table}};
1664 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1666 Processes a batch import as a queued JSRPC job
1668 JOB is an FS::queue entry.
1670 OPTIONS_HASHREF can have the following keys:
1676 Table name (required).
1680 Listref of field names for static fields. They will be given values from the
1681 PARAMS hashref and passed as a "params" hashref to batch_import.
1685 Formats hashref. Keys are field names, values are listrefs that define the
1688 Each listref value can be a column name or a code reference. Coderefs are run
1689 with the row object, data and a FS::Conf object as the three parameters.
1690 For example, this coderef does the same thing as using the "columnname" string:
1693 my( $record, $data, $conf ) = @_;
1694 $record->columnname( $data );
1697 Coderefs are run after all "column name" fields are assigned.
1701 Optional format hashref of types. Keys are field names, values are "csv",
1702 "xls" or "fixedlength". Overrides automatic determination of file type
1705 =item format_headers
1707 Optional format hashref of header lines. Keys are field names, values are 0
1708 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1711 =item format_sep_chars
1713 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1714 CSV separation character.
1716 =item format_fixedlenth_formats
1718 Optional format hashref of fixed length format defintiions. Keys are field
1719 names, values Parse::FixedLength listrefs of field definitions.
1723 Set true to default to CSV file type if the filename does not contain a
1724 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1729 PARAMS is a base64-encoded Storable string containing the POSTed data as
1730 a hash ref. It normally contains at least one field, "uploaded files",
1731 generated by /elements/file-upload.html and containing the list of uploaded
1732 files. Currently only supports a single file named "file".
1736 use Storable qw(thaw);
1739 sub process_batch_import {
1740 my($job, $opt) = ( shift, shift );
1742 my $table = $opt->{table};
1743 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1744 my %formats = %{ $opt->{formats} };
1746 my $param = thaw(decode_base64(shift));
1747 warn Dumper($param) if $DEBUG;
1749 my $files = $param->{'uploaded_files'}
1750 or die "No files provided.\n";
1752 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1754 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1755 my $file = $dir. $files{'file'};
1760 formats => \%formats,
1761 format_types => $opt->{format_types},
1762 format_headers => $opt->{format_headers},
1763 format_sep_chars => $opt->{format_sep_chars},
1764 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1765 format_xml_formats => $opt->{format_xml_formats},
1766 format_asn_formats => $opt->{format_asn_formats},
1767 format_row_callbacks => $opt->{format_row_callbacks},
1772 format => $param->{format},
1773 params => { map { $_ => $param->{$_} } @pass_params },
1775 default_csv => $opt->{default_csv},
1776 postinsert_callback => $opt->{postinsert_callback},
1779 if ( $opt->{'batch_namecol'} ) {
1780 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1781 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1784 my $error = FS::Record::batch_import( \%iopt );
1788 die "$error\n" if $error;
1791 =item batch_import PARAM_HASHREF
1793 Class method for batch imports. Available params:
1799 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1805 =item format_headers
1807 =item format_sep_chars
1809 =item format_fixedlength_formats
1811 =item format_row_callbacks
1813 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1815 =item preinsert_callback
1817 =item postinsert_callback
1823 FS::queue object, will be updated with progress
1829 csv, xls, fixedlength, xml
1841 warn "$me batch_import call with params: \n". Dumper($param)
1844 my $table = $param->{table};
1846 my $job = $param->{job};
1847 my $file = $param->{file};
1848 my $params = $param->{params} || {};
1850 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1851 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1853 my( $type, $header, $sep_char,
1854 $fixedlength_format, $xml_format, $asn_format,
1855 $parser_opt, $row_callback, @fields );
1857 my $postinsert_callback = '';
1858 $postinsert_callback = $param->{'postinsert_callback'}
1859 if $param->{'postinsert_callback'};
1860 my $preinsert_callback = '';
1861 $preinsert_callback = $param->{'preinsert_callback'}
1862 if $param->{'preinsert_callback'};
1864 if ( $param->{'format'} ) {
1866 my $format = $param->{'format'};
1867 my $formats = $param->{formats};
1868 die "unknown format $format" unless exists $formats->{ $format };
1870 $type = $param->{'format_types'}
1871 ? $param->{'format_types'}{ $format }
1872 : $param->{type} || 'csv';
1875 $header = $param->{'format_headers'}
1876 ? $param->{'format_headers'}{ $param->{'format'} }
1879 $sep_char = $param->{'format_sep_chars'}
1880 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1883 $fixedlength_format =
1884 $param->{'format_fixedlength_formats'}
1885 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1889 $param->{'format_parser_opts'}
1890 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1894 $param->{'format_xml_formats'}
1895 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1899 $param->{'format_asn_formats'}
1900 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1904 $param->{'format_row_callbacks'}
1905 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1908 @fields = @{ $formats->{ $format } };
1910 } elsif ( $param->{'fields'} ) {
1912 $type = ''; #infer from filename
1915 $fixedlength_format = '';
1917 @fields = @{ $param->{'fields'} };
1920 die "neither format nor fields specified";
1923 #my $file = $param->{file};
1926 if ( $file =~ /\.(\w+)$/i ) {
1930 warn "can't parse file type from filename $file; defaulting to CSV";
1934 if $param->{'default_csv'} && $type ne 'xls';
1942 my $asn_header_buffer;
1943 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1945 if ( $type eq 'csv' ) {
1947 $parser_opt->{'binary'} = 1;
1948 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
1949 $parser = Text::CSV_XS->new($parser_opt);
1951 } elsif ( $type eq 'fixedlength' ) {
1953 eval "use Parse::FixedLength;";
1955 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
1958 die "Unknown file type $type\n";
1961 @buffer = split(/\r?\n/, slurp($file) );
1962 splice(@buffer, 0, ($header || 0) );
1963 $count = scalar(@buffer);
1965 } elsif ( $type eq 'xls' ) {
1967 eval "use Spreadsheet::ParseExcel;";
1970 eval "use DateTime::Format::Excel;";
1971 #for now, just let the error be thrown if it is used, since only CDR
1972 # formats bill_west and troop use it, not other excel-parsing things
1975 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1977 $parser = $excel->{Worksheet}[0]; #first sheet
1979 $count = $parser->{MaxRow} || $parser->{MinRow};
1982 $row = $header || 0;
1984 } elsif ( $type eq 'xml' ) {
1987 eval "use XML::Simple;";
1989 my $xmlrow = $xml_format->{'xmlrow'};
1990 $parser = $xml_format->{'xmlkeys'};
1991 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1992 my $data = XML::Simple::XMLin(
1994 'SuppressEmpty' => '', #sets empty values to ''
1998 $rows = $rows->{$_} foreach @$xmlrow;
1999 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2000 $count = @buffer = @$rows;
2002 } elsif ( $type eq 'asn.1' ) {
2004 eval "use Convert::ASN1";
2007 my $asn = Convert::ASN1->new;
2008 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2010 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2012 my $data = slurp($file);
2013 my $asn_output = $parser->decode( $data )
2014 or return "No ". $asn_format->{'macro'}. " found\n";
2016 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2018 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2019 $count = @buffer = @$rows;
2022 die "Unknown file type $type\n";
2027 local $SIG{HUP} = 'IGNORE';
2028 local $SIG{INT} = 'IGNORE';
2029 local $SIG{QUIT} = 'IGNORE';
2030 local $SIG{TERM} = 'IGNORE';
2031 local $SIG{TSTP} = 'IGNORE';
2032 local $SIG{PIPE} = 'IGNORE';
2034 my $oldAutoCommit = $FS::UID::AutoCommit;
2035 local $FS::UID::AutoCommit = 0;
2038 #my $params = $param->{params} || {};
2039 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2040 my $batch_col = $param->{'batch_keycol'};
2042 my $batch_class = 'FS::'. $param->{'batch_table'};
2043 my $batch = $batch_class->new({
2044 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2046 my $error = $batch->insert;
2048 $dbh->rollback if $oldAutoCommit;
2049 return "can't insert batch record: $error";
2051 #primary key via dbdef? (so the column names don't have to match)
2052 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2054 $params->{ $batch_col } = $batch_value;
2057 #my $job = $param->{job};
2060 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2064 my %hash = %$params;
2065 if ( $type eq 'csv' ) {
2067 last unless scalar(@buffer);
2068 $line = shift(@buffer);
2070 next if $line =~ /^\s*$/; #skip empty lines
2072 $line = &{$row_callback}($line) if $row_callback;
2074 next if $line =~ /^\s*$/; #skip empty lines
2076 $parser->parse($line) or do {
2077 $dbh->rollback if $oldAutoCommit;
2078 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2080 @columns = $parser->fields();
2082 } elsif ( $type eq 'fixedlength' ) {
2084 last unless scalar(@buffer);
2085 $line = shift(@buffer);
2087 @columns = $parser->parse($line);
2089 } elsif ( $type eq 'xls' ) {
2091 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2092 || ! $parser->{Cells}[$row];
2094 my @row = @{ $parser->{Cells}[$row] };
2095 @columns = map $_->{Val}, @row;
2098 #warn $z++. ": $_\n" for @columns;
2100 } elsif ( $type eq 'xml' ) {
2102 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2103 last unless scalar(@buffer);
2104 my $row = shift @buffer;
2105 @columns = @{ $row }{ @$parser };
2107 } elsif ( $type eq 'asn.1' ) {
2109 last unless scalar(@buffer);
2110 my $row = shift @buffer;
2111 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2112 if $asn_format->{row_callback};
2113 foreach my $key ( keys %{ $asn_format->{map} } ) {
2114 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2118 die "Unknown file type $type\n";
2123 foreach my $field ( @fields ) {
2125 my $value = shift @columns;
2127 if ( ref($field) eq 'CODE' ) {
2128 #&{$field}(\%hash, $value);
2129 push @later, $field, $value;
2131 #??? $hash{$field} = $value if length($value);
2132 $hash{$field} = $value if defined($value) && length($value);
2137 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2138 && length($1) == $custnum_length ) {
2139 $hash{custnum} = $2;
2142 #my $table = $param->{table};
2143 my $class = "FS::$table";
2145 my $record = $class->new( \%hash );
2148 while ( scalar(@later) ) {
2149 my $sub = shift @later;
2150 my $data = shift @later;
2152 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2155 $dbh->rollback if $oldAutoCommit;
2156 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2158 last if exists( $param->{skiprow} );
2160 next if exists( $param->{skiprow} );
2162 if ( $preinsert_callback ) {
2163 my $error = &{$preinsert_callback}($record, $param);
2165 $dbh->rollback if $oldAutoCommit;
2166 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2169 next if exists $param->{skiprow} && $param->{skiprow};
2172 my $error = $record->insert;
2175 $dbh->rollback if $oldAutoCommit;
2176 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2182 if ( $postinsert_callback ) {
2183 my $error = &{$postinsert_callback}($record, $param);
2185 $dbh->rollback if $oldAutoCommit;
2186 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2191 if ( $job && time - $min_sec > $last ) { #progress bar
2192 $job->update_statustext( int(100 * $imported / $count) );
2198 unless ( $imported || $param->{empty_ok} ) {
2199 $dbh->rollback if $oldAutoCommit;
2200 return "Empty file!";
2203 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2210 my( $self, $action, $time ) = @_;
2214 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2217 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2218 real_fields($self->table);
2221 # If we're encrypting then don't store the payinfo in the history
2222 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
2223 @fields = grep { $_ ne 'payinfo' } @fields;
2226 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2228 "INSERT INTO h_". $self->table. " ( ".
2229 join(', ', qw(history_date history_usernum history_action), @fields ).
2232 $FS::CurrentUser::CurrentUser->usernum,
2233 dbh->quote($action),
2242 B<Warning>: External use is B<deprecated>.
2244 Replaces COLUMN in record with a unique number, using counters in the
2245 filesystem. Used by the B<insert> method on single-field unique columns
2246 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2247 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2249 Returns the new value.
2254 my($self,$field) = @_;
2255 my($table)=$self->table;
2257 croak "Unique called on field $field, but it is ",
2258 $self->getfield($field),
2260 if $self->getfield($field);
2262 #warn "table $table is tainted" if is_tainted($table);
2263 #warn "field $field is tainted" if is_tainted($field);
2265 my($counter) = new File::CounterFile "$table.$field",0;
2267 my $index = $counter->inc;
2268 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2270 $index =~ /^(\d*)$/;
2273 $self->setfield($field,$index);
2277 =item ut_float COLUMN
2279 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2280 null. If there is an error, returns the error, otherwise returns false.
2285 my($self,$field)=@_ ;
2286 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2287 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2288 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2289 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2290 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2291 $self->setfield($field,$1);
2294 =item ut_floatn COLUMN
2296 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2297 null. If there is an error, returns the error, otherwise returns false.
2301 #false laziness w/ut_ipn
2303 my( $self, $field ) = @_;
2304 if ( $self->getfield($field) =~ /^()$/ ) {
2305 $self->setfield($field,'');
2308 $self->ut_float($field);
2312 =item ut_sfloat COLUMN
2314 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2315 May not be null. If there is an error, returns the error, otherwise returns
2321 my($self,$field)=@_ ;
2322 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2323 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2324 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2325 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2326 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2327 $self->setfield($field,$1);
2330 =item ut_sfloatn COLUMN
2332 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2333 null. If there is an error, returns the error, otherwise returns false.
2338 my( $self, $field ) = @_;
2339 if ( $self->getfield($field) =~ /^()$/ ) {
2340 $self->setfield($field,'');
2343 $self->ut_sfloat($field);
2347 =item ut_snumber COLUMN
2349 Check/untaint signed numeric data (whole numbers). If there is an error,
2350 returns the error, otherwise returns false.
2355 my($self, $field) = @_;
2356 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2357 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2358 $self->setfield($field, "$1$2");
2362 =item ut_snumbern COLUMN
2364 Check/untaint signed numeric data (whole numbers). If there is an error,
2365 returns the error, otherwise returns false.
2370 my($self, $field) = @_;
2371 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2372 or return "Illegal (numeric) $field: ". $self->getfield($field);
2374 return "Illegal (numeric) $field: ". $self->getfield($field)
2377 $self->setfield($field, "$1$2");
2381 =item ut_number COLUMN
2383 Check/untaint simple numeric data (whole numbers). May not be null. If there
2384 is an error, returns the error, otherwise returns false.
2389 my($self,$field)=@_;
2390 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2391 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2392 $self->setfield($field,$1);
2396 =item ut_numbern COLUMN
2398 Check/untaint simple numeric data (whole numbers). May be null. If there is
2399 an error, returns the error, otherwise returns false.
2404 my($self,$field)=@_;
2405 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2406 or return "Illegal (numeric) $field: ". $self->getfield($field);
2407 $self->setfield($field,$1);
2411 =item ut_money COLUMN
2413 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2414 is an error, returns the error, otherwise returns false.
2419 my($self,$field)=@_;
2421 if ( $self->getfield($field) eq '' ) {
2422 $self->setfield($field, 0);
2423 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2424 #handle one decimal place without barfing out
2425 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2426 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2427 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2429 return "Illegal (money) $field: ". $self->getfield($field);
2435 =item ut_moneyn COLUMN
2437 Check/untaint monetary numbers. May be negative. If there
2438 is an error, returns the error, otherwise returns false.
2443 my($self,$field)=@_;
2444 if ($self->getfield($field) eq '') {
2445 $self->setfield($field, '');
2448 $self->ut_money($field);
2451 =item ut_currencyn COLUMN
2453 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2454 is an error, returns the error, otherwise returns false.
2459 my($self, $field) = @_;
2460 if ($self->getfield($field) eq '') { #can be null
2461 $self->setfield($field, '');
2464 $self->ut_currency($field);
2467 =item ut_currency COLUMN
2469 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2470 there is an error, returns the error, otherwise returns false.
2475 my($self, $field) = @_;
2476 my $value = uc( $self->getfield($field) );
2477 if ( code2currency($value) ) {
2478 $self->setfield($value);
2480 return "Unknown currency $value";
2486 =item ut_text COLUMN
2488 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2489 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2490 May not be null. If there is an error, returns the error, otherwise returns
2496 my($self,$field)=@_;
2497 #warn "msgcat ". \&msgcat. "\n";
2498 #warn "notexist ". \¬exist. "\n";
2499 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2500 $self->getfield($field)
2501 =~ /^([\wô \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2502 or return gettext('illegal_or_empty_text'). " $field: ".
2503 $self->getfield($field);
2504 $self->setfield($field,$1);
2508 =item ut_textn COLUMN
2510 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2511 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2512 May be null. If there is an error, returns the error, otherwise returns false.
2517 my($self,$field)=@_;
2518 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2519 $self->ut_text($field);
2522 =item ut_alpha COLUMN
2524 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2525 an error, returns the error, otherwise returns false.
2530 my($self,$field)=@_;
2531 $self->getfield($field) =~ /^(\w+)$/
2532 or return "Illegal or empty (alphanumeric) $field: ".
2533 $self->getfield($field);
2534 $self->setfield($field,$1);
2538 =item ut_alphan COLUMN
2540 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2541 error, returns the error, otherwise returns false.
2546 my($self,$field)=@_;
2547 $self->getfield($field) =~ /^(\w*)$/
2548 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2549 $self->setfield($field,$1);
2553 =item ut_alphasn COLUMN
2555 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2556 an error, returns the error, otherwise returns false.
2561 my($self,$field)=@_;
2562 $self->getfield($field) =~ /^([\w ]*)$/
2563 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2564 $self->setfield($field,$1);
2569 =item ut_alpha_lower COLUMN
2571 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2572 there is an error, returns the error, otherwise returns false.
2576 sub ut_alpha_lower {
2577 my($self,$field)=@_;
2578 $self->getfield($field) =~ /[[:upper:]]/
2579 and return "Uppercase characters are not permitted in $field";
2580 $self->ut_alpha($field);
2583 =item ut_phonen COLUMN [ COUNTRY ]
2585 Check/untaint phone numbers. May be null. If there is an error, returns
2586 the error, otherwise returns false.
2588 Takes an optional two-letter ISO country code; without it or with unsupported
2589 countries, ut_phonen simply calls ut_alphan.
2594 my( $self, $field, $country ) = @_;
2595 return $self->ut_alphan($field) unless defined $country;
2596 my $phonen = $self->getfield($field);
2597 if ( $phonen eq '' ) {
2598 $self->setfield($field,'');
2599 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2601 $phonen = $conf->config('cust_main-default_areacode').$phonen
2602 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2603 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2604 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2605 $phonen = "$1-$2-$3";
2606 $phonen .= " x$4" if $4;
2607 $self->setfield($field,$phonen);
2609 warn "warning: don't know how to check phone numbers for country $country";
2610 return $self->ut_textn($field);
2617 Check/untaint hexadecimal values.
2622 my($self, $field) = @_;
2623 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2624 or return "Illegal (hex) $field: ". $self->getfield($field);
2625 $self->setfield($field, uc($1));
2629 =item ut_hexn COLUMN
2631 Check/untaint hexadecimal values. May be null.
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_mac_addr COLUMN
2645 Check/untaint mac addresses. May be null.
2650 my($self, $field) = @_;
2652 my $mac = $self->get($field);
2655 $self->set($field, $mac);
2657 my $e = $self->ut_hex($field);
2660 return "Illegal (mac address) $field: ". $self->getfield($field)
2661 unless length($self->getfield($field)) == 12;
2667 =item ut_mac_addrn COLUMN
2669 Check/untaint mac addresses. May be null.
2674 my($self, $field) = @_;
2675 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2680 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2686 my( $self, $field ) = @_;
2687 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2688 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2689 or return "Illegal (IP address) $field: ". $self->getfield($field);
2690 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2691 $self->setfield($field, "$1.$2.$3.$4");
2697 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2698 to 127.0.0.1. May be null.
2703 my( $self, $field ) = @_;
2704 if ( $self->getfield($field) =~ /^()$/ ) {
2705 $self->setfield($field,'');
2708 $self->ut_ip($field);
2712 =item ut_ip46 COLUMN
2714 Check/untaint IPv4 or IPv6 address.
2719 my( $self, $field ) = @_;
2720 my $ip = NetAddr::IP->new($self->getfield($field))
2721 or return "Illegal (IP address) $field: ".$self->getfield($field);
2722 $self->setfield($field, lc($ip->addr));
2728 Check/untaint IPv6 or IPv6 address. May be null.
2733 my( $self, $field ) = @_;
2734 if ( $self->getfield($field) =~ /^$/ ) {
2735 $self->setfield($field, '');
2738 $self->ut_ip46($field);
2741 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2743 Check/untaint coordinates.
2744 Accepts the following forms:
2754 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2755 The latter form (that is, the MMM are thousands of minutes) is
2756 assumed if the "MMM" is exactly three digits or two digits > 59.
2758 To be safe, just use the DDD.DDDDD form.
2760 If LOWER or UPPER are specified, then the coordinate is checked
2761 for lower and upper bounds, respectively.
2766 my ($self, $field) = (shift, shift);
2769 if ( $field =~ /latitude/ ) {
2770 $lower = $lat_lower;
2772 } elsif ( $field =~ /longitude/ ) {
2774 $upper = $lon_upper;
2777 my $coord = $self->getfield($field);
2778 my $neg = $coord =~ s/^(-)//;
2780 my ($d, $m, $s) = (0, 0, 0);
2783 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2784 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2785 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2787 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2790 return "Invalid (coordinate with minutes > 59) $field: "
2791 . $self->getfield($field);
2794 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2796 if (defined($lower) and ($coord < $lower)) {
2797 return "Invalid (coordinate < $lower) $field: "
2798 . $self->getfield($field);;
2801 if (defined($upper) and ($coord > $upper)) {
2802 return "Invalid (coordinate > $upper) $field: "
2803 . $self->getfield($field);;
2806 $self->setfield($field, $coord);
2810 return "Invalid (coordinate) $field: " . $self->getfield($field);
2814 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2816 Same as ut_coord, except optionally null.
2822 my ($self, $field) = (shift, shift);
2824 if ($self->getfield($field) =~ /^\s*$/) {
2827 return $self->ut_coord($field, @_);
2832 =item ut_domain COLUMN
2834 Check/untaint host and domain names. May not be null.
2839 my( $self, $field ) = @_;
2840 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2841 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2842 or return "Illegal (hostname) $field: ". $self->getfield($field);
2843 $self->setfield($field,$1);
2847 =item ut_domainn COLUMN
2849 Check/untaint host and domain names. May be null.
2854 my( $self, $field ) = @_;
2855 if ( $self->getfield($field) =~ /^()$/ ) {
2856 $self->setfield($field,'');
2859 $self->ut_domain($field);
2863 =item ut_name COLUMN
2865 Check/untaint proper names; allows alphanumerics, spaces and the following
2866 punctuation: , . - '
2873 my( $self, $field ) = @_;
2874 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2875 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2876 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2881 $self->setfield($field, $name);
2885 =item ut_namen COLUMN
2887 Check/untaint proper names; allows alphanumerics, spaces and the following
2888 punctuation: , . - '
2895 my( $self, $field ) = @_;
2896 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2897 $self->ut_name($field);
2902 Check/untaint zip codes.
2906 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2909 my( $self, $field, $country ) = @_;
2911 if ( $country eq 'US' ) {
2913 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2914 or return gettext('illegal_zip'). " $field for country $country: ".
2915 $self->getfield($field);
2916 $self->setfield($field, $1);
2918 } elsif ( $country eq 'CA' ) {
2920 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2921 or return gettext('illegal_zip'). " $field for country $country: ".
2922 $self->getfield($field);
2923 $self->setfield($field, "$1 $2");
2927 if ( $self->getfield($field) =~ /^\s*$/
2928 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2931 $self->setfield($field,'');
2933 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2934 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2935 $self->setfield($field,$1);
2943 =item ut_country COLUMN
2945 Check/untaint country codes. Country names are changed to codes, if possible -
2946 see L<Locale::Country>.
2951 my( $self, $field ) = @_;
2952 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2953 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2954 && country2code($1) ) {
2955 $self->setfield($field,uc(country2code($1)));
2958 $self->getfield($field) =~ /^(\w\w)$/
2959 or return "Illegal (country) $field: ". $self->getfield($field);
2960 $self->setfield($field,uc($1));
2964 =item ut_anything COLUMN
2966 Untaints arbitrary data. Be careful.
2971 my( $self, $field ) = @_;
2972 $self->getfield($field) =~ /^(.*)$/s
2973 or return "Illegal $field: ". $self->getfield($field);
2974 $self->setfield($field,$1);
2978 =item ut_enum COLUMN CHOICES_ARRAYREF
2980 Check/untaint a column, supplying all possible choices, like the "enum" type.
2985 my( $self, $field, $choices ) = @_;
2986 foreach my $choice ( @$choices ) {
2987 if ( $self->getfield($field) eq $choice ) {
2988 $self->setfield($field, $choice);
2992 return "Illegal (enum) field $field: ". $self->getfield($field);
2995 =item ut_enumn COLUMN CHOICES_ARRAYREF
2997 Like ut_enum, except the null value is also allowed.
3002 my( $self, $field, $choices ) = @_;
3003 $self->getfield($field)
3004 ? $self->ut_enum($field, $choices)
3008 =item ut_flag COLUMN
3010 Check/untaint a column if it contains either an empty string or 'Y'. This
3011 is the standard form for boolean flags in Freeside.
3016 my( $self, $field ) = @_;
3017 my $value = uc($self->getfield($field));
3018 if ( $value eq '' or $value eq 'Y' ) {
3019 $self->setfield($field, $value);
3022 return "Illegal (flag) field $field: $value";
3025 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3027 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3028 on the column first.
3032 sub ut_foreign_key {
3033 my( $self, $field, $table, $foreign ) = @_;
3034 return '' if $no_check_foreign;
3035 qsearchs($table, { $foreign => $self->getfield($field) })
3036 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3037 " in $table.$foreign";
3041 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3043 Like ut_foreign_key, except the null value is also allowed.
3047 sub ut_foreign_keyn {
3048 my( $self, $field, $table, $foreign ) = @_;
3049 $self->getfield($field)
3050 ? $self->ut_foreign_key($field, $table, $foreign)
3054 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3056 Checks this column as an agentnum, taking into account the current users's
3057 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3058 right or rights allowing no agentnum.
3062 sub ut_agentnum_acl {
3063 my( $self, $field ) = (shift, shift);
3064 my $null_acl = scalar(@_) ? shift : [];
3065 $null_acl = [ $null_acl ] unless ref($null_acl);
3067 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3068 return "Illegal agentnum: $error" if $error;
3070 my $curuser = $FS::CurrentUser::CurrentUser;
3072 if ( $self->$field() ) {
3074 return "Access denied"
3075 unless $curuser->agentnum($self->$field());
3079 return "Access denied"
3080 unless grep $curuser->access_right($_), @$null_acl;
3088 =item fields [ TABLE ]
3090 This is a wrapper for real_fields. Code that called
3091 fields before should probably continue to call fields.
3096 my $something = shift;
3098 if($something->isa('FS::Record')) {
3099 $table = $something->table;
3101 $table = $something;
3102 $something = "FS::$table";
3104 return (real_fields($table));
3108 =item encrypt($value)
3110 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3112 Returns the encrypted string.
3114 You should generally not have to worry about calling this, as the system handles this for you.
3119 my ($self, $value) = @_;
3120 my $encrypted = $value;
3122 if ($conf->exists('encryption')) {
3123 if ($self->is_encrypted($value)) {
3124 # Return the original value if it isn't plaintext.
3125 $encrypted = $value;
3128 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3129 # RSA doesn't like the empty string so let's pack it up
3130 # The database doesn't like the RSA data so uuencode it
3131 my $length = length($value)+1;
3132 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3134 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3141 =item is_encrypted($value)
3143 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3149 my ($self, $value) = @_;
3150 # could be more precise about it, but this will do for now
3151 $value =~ /^M/ && length($value) > 80;
3154 =item decrypt($value)
3156 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3158 You should generally not have to worry about calling this, as the system handles this for you.
3163 my ($self,$value) = @_;
3164 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3165 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
3167 if (ref($rsa_decrypt) =~ /::RSA/) {
3168 my $encrypted = unpack ("u*", $value);
3169 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3170 if ($@) {warn "Decryption Failed"};
3178 #Initialize the Module
3179 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3181 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
3182 $rsa_module = $conf->config('encryptionmodule');
3186 eval ("require $rsa_module"); # No need to import the namespace
3189 # Initialize Encryption
3190 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
3191 my $public_key = join("\n",$conf->config('encryptionpublickey'));
3192 $rsa_encrypt = $rsa_module->new_public_key($public_key);
3195 # Intitalize Decryption
3196 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
3197 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
3198 $rsa_decrypt = $rsa_module->new_private_key($private_key);
3202 =item h_search ACTION
3204 Given an ACTION, either "insert", or "delete", returns the appropriate history
3205 record corresponding to this record, if any.
3210 my( $self, $action ) = @_;
3212 my $table = $self->table;
3215 my $primary_key = dbdef->table($table)->primary_key;
3218 'table' => "h_$table",
3219 'hashref' => { $primary_key => $self->$primary_key(),
3220 'history_action' => $action,
3228 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3229 appropriate history record corresponding to this record, if any.
3234 my($self, $action) = @_;
3235 my $h = $self->h_search($action);
3236 $h ? $h->history_date : '';
3239 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3241 A class or object method. Executes the sql statement represented by SQL and
3242 returns a scalar representing the result: the first column of the first row.
3244 Dies on bogus SQL. Returns an empty string if no row is returned.
3246 Typically used for statments which return a single value such as "SELECT
3247 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3252 my($self, $sql) = (shift, shift);
3253 my $sth = dbh->prepare($sql) or die dbh->errstr;
3255 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3256 my $row = $sth->fetchrow_arrayref or return '';
3257 my $scalar = $row->[0];
3258 defined($scalar) ? $scalar : '';
3261 =item count [ WHERE ]
3263 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3264 with optional WHERE. Must be called as method on a class with an
3270 my($self, $where) = (shift, shift);
3271 my $table = $self->table or die 'count called on object of class '.ref($self);
3272 my $sql = "SELECT COUNT(*) FROM $table";
3273 $sql .= " WHERE $where" if $where;
3274 $self->scalar_sql($sql);
3283 =item real_fields [ TABLE ]
3285 Returns a list of the real columns in the specified table. Called only by
3286 fields() and other subroutines elsewhere in FS::Record.
3293 my($table_obj) = dbdef->table($table);
3294 confess "Unknown table $table" unless $table_obj;
3295 $table_obj->columns;
3298 =item pvf FIELD_NAME
3300 Returns the FS::part_virtual_field object corresponding to a field in the
3301 record (specified by FIELD_NAME).
3306 my ($self, $name) = (shift, shift);
3308 if(grep /^$name$/, $self->virtual_fields) {
3310 my $concat = [ "'cf_'", "name" ];
3311 return qsearchs({ table => 'part_virtual_field',
3312 hashref => { dbtable => $self->table,
3315 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3321 =item _quote VALUE, TABLE, COLUMN
3323 This is an internal function used to construct SQL statements. It returns
3324 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3325 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3330 my($value, $table, $column) = @_;
3331 my $column_obj = dbdef->table($table)->column($column);
3332 my $column_type = $column_obj->type;
3333 my $nullable = $column_obj->null;
3335 warn " $table.$column: $value ($column_type".
3336 ( $nullable ? ' NULL' : ' NOT NULL' ).
3337 ")\n" if $DEBUG > 2;
3339 if ( $value eq '' && $nullable ) {
3341 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3342 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3345 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3346 ! $column_type =~ /(char|binary|text)$/i ) {
3348 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3349 && driver_name eq 'Pg'
3353 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3354 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3355 # single-quote the whole mess, and put an "E" in front.
3356 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3364 This is deprecated. Don't use it.
3366 It returns a hash-type list with the fields of this record's table set true.
3371 carp "warning: hfields is deprecated";
3374 foreach (fields($table)) {
3383 "$_: ". $self->getfield($_). "|"
3384 } (fields($self->table)) );
3387 sub DESTROY { return; }
3391 # #use Carp qw(cluck);
3392 # #cluck "DESTROYING $self";
3393 # warn "DESTROYING $self";
3397 # return ! eval { join('',@_), kill 0; 1; };
3400 =item str2time_sql [ DRIVER_NAME ]
3402 Returns a function to convert to unix time based on database type, such as
3403 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3404 the str2time_sql_closing method to return a closing string rather than just
3405 using a closing parenthesis as previously suggested.
3407 You can pass an optional driver name such as "Pg", "mysql" or
3408 $dbh->{Driver}->{Name} to return a function for that database instead of
3409 the current database.
3414 my $driver = shift || driver_name;
3416 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3417 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3419 warn "warning: unknown database type $driver; guessing how to convert ".
3420 "dates to UNIX timestamps";
3421 return 'EXTRACT(EPOCH FROM ';
3425 =item str2time_sql_closing [ DRIVER_NAME ]
3427 Returns the closing suffix of a function to convert to unix time based on
3428 database type, such as ")::integer" for Pg or ")" for mysql.
3430 You can pass an optional driver name such as "Pg", "mysql" or
3431 $dbh->{Driver}->{Name} to return a function for that database instead of
3432 the current database.
3436 sub str2time_sql_closing {
3437 my $driver = shift || driver_name;
3439 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3443 =item regexp_sql [ DRIVER_NAME ]
3445 Returns the operator to do a regular expression comparison based on database
3446 type, such as '~' for Pg or 'REGEXP' for mysql.
3448 You can pass an optional driver name such as "Pg", "mysql" or
3449 $dbh->{Driver}->{Name} to return a function for that database instead of
3450 the current database.
3455 my $driver = shift || driver_name;
3457 return '~' if $driver =~ /^Pg/i;
3458 return 'REGEXP' if $driver =~ /^mysql/i;
3460 die "don't know how to use regular expressions in ". driver_name." databases";
3464 =item not_regexp_sql [ DRIVER_NAME ]
3466 Returns the operator to do a regular expression negation based on database
3467 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3469 You can pass an optional driver name such as "Pg", "mysql" or
3470 $dbh->{Driver}->{Name} to return a function for that database instead of
3471 the current database.
3475 sub not_regexp_sql {
3476 my $driver = shift || driver_name;
3478 return '!~' if $driver =~ /^Pg/i;
3479 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3481 die "don't know how to use regular expressions in ". driver_name." databases";
3485 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3487 Returns the items concatenated based on database type, using "CONCAT()" for
3488 mysql and " || " for Pg and other databases.
3490 You can pass an optional driver name such as "Pg", "mysql" or
3491 $dbh->{Driver}->{Name} to return a function for that database instead of
3492 the current database.
3497 my $driver = ref($_[0]) ? driver_name : shift;
3500 if ( $driver =~ /^mysql/i ) {
3501 'CONCAT('. join(',', @$items). ')';
3503 join('||', @$items);
3508 =item midnight_sql DATE
3510 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3511 on that day in the system timezone, using the default driver name.
3516 my $driver = driver_name;
3518 if ( $driver =~ /^mysql/i ) {
3519 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3522 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3530 This module should probably be renamed, since much of the functionality is
3531 of general use. It is not completely unlike Adapter::DBI (see below).
3533 Exported qsearch and qsearchs should be deprecated in favor of method calls
3534 (against an FS::Record object like the old search and searchs that qsearch
3535 and qsearchs were on top of.)
3537 The whole fields / hfields mess should be removed.
3539 The various WHERE clauses should be subroutined.
3541 table string should be deprecated in favor of DBIx::DBSchema::Table.
3543 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3544 true maps to the database (and WHERE clauses) would also help.
3546 The ut_ methods should ask the dbdef for a default length.
3548 ut_sqltype (like ut_varchar) should all be defined
3550 A fallback check method should be provided which uses the dbdef.
3552 The ut_money method assumes money has two decimal digits.
3554 The Pg money kludge in the new method only strips `$'.
3556 The ut_phonen method only checks US-style phone numbers.
3558 The _quote function should probably use ut_float instead of a regex.
3560 All the subroutines probably should be methods, here or elsewhere.
3562 Probably should borrow/use some dbdef methods where appropriate (like sub
3565 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3566 or allow it to be set. Working around it is ugly any way around - DBI should
3567 be fixed. (only affects RDBMS which return uppercase column names)
3569 ut_zip should take an optional country like ut_phone.
3573 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3575 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.