5 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
7 $money_char $lat_lower $lon_upper
9 $nowarn_identical $nowarn_classload
10 $no_update_diff $no_history $qsearch_qualify_columns
15 use Carp qw(carp cluck croak confess);
16 use Scalar::Util qw( blessed );
17 use File::CounterFile;
20 use File::Slurp qw( slurp );
21 use DBI qw(:sql_types);
22 use DBIx::DBSchema 0.38;
23 use FS::UID qw(dbh getotaker datasrc driver_name);
25 use FS::Schema qw(dbdef);
27 use FS::Msgcat qw(gettext);
28 use NetAddr::IP; # for validation
30 #use FS::Conf; #dependency loop bs, in install_callback below instead
32 use FS::part_virtual_field;
38 @encrypt_payby = qw( CARD DCRD CHEK DCHK );
40 #export dbdef for now... everything else expects to find it here
42 dbh fields hfields qsearch qsearchs dbdef jsearch
43 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql
44 concat_sql group_concat_sql
51 $nowarn_identical = 0;
52 $nowarn_classload = 0;
56 $qsearch_qualify_columns = 0;
58 $no_check_foreign = 0;
66 our $conf_encryption = '';
67 our $conf_encryptionmodule = '';
68 our $conf_encryptionpublickey = '';
69 our $conf_encryptionprivatekey = '';
70 FS::UID->install_callback( sub {
74 $conf = FS::Conf->new;
75 $conf_encryption = $conf->exists('encryption');
76 $conf_encryptionmodule = $conf->config('encryptionmodule');
77 $conf_encryptionpublickey = join("\n",$conf->config('encryptionpublickey'));
78 $conf_encryptionprivatekey = join("\n",$conf->config('encryptionprivatekey'));
79 $money_char = $conf->config('money_char') || '$';
80 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
81 $lat_lower = $nw_coords ? 1 : -90;
82 $lon_upper = $nw_coords ? -1 : 180;
84 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
86 if ( driver_name eq 'Pg' ) {
87 eval "use DBD::Pg ':pg_types'";
90 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
97 FS::Record - Database record objects
102 use FS::Record qw(dbh fields qsearch qsearchs);
104 $record = new FS::Record 'table', \%hash;
105 $record = new FS::Record 'table', { 'column' => 'value', ... };
107 $record = qsearchs FS::Record 'table', \%hash;
108 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
109 @records = qsearch FS::Record 'table', \%hash;
110 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
112 $table = $record->table;
113 $dbdef_table = $record->dbdef_table;
115 $value = $record->get('column');
116 $value = $record->getfield('column');
117 $value = $record->column;
119 $record->set( 'column' => 'value' );
120 $record->setfield( 'column' => 'value' );
121 $record->column('value');
123 %hash = $record->hash;
125 $hashref = $record->hashref;
127 $error = $record->insert;
129 $error = $record->delete;
131 $error = $new_record->replace($old_record);
133 # external use deprecated - handled by the database (at least for Pg, mysql)
134 $value = $record->unique('column');
136 $error = $record->ut_float('column');
137 $error = $record->ut_floatn('column');
138 $error = $record->ut_number('column');
139 $error = $record->ut_numbern('column');
140 $error = $record->ut_decimal('column');
141 $error = $record->ut_decimaln('column');
142 $error = $record->ut_snumber('column');
143 $error = $record->ut_snumbern('column');
144 $error = $record->ut_money('column');
145 $error = $record->ut_text('column');
146 $error = $record->ut_textn('column');
147 $error = $record->ut_alpha('column');
148 $error = $record->ut_alphan('column');
149 $error = $record->ut_phonen('column');
150 $error = $record->ut_anything('column');
151 $error = $record->ut_name('column');
153 $quoted_value = _quote($value,'table','field');
156 $fields = hfields('table');
157 if ( $fields->{Field} ) { # etc.
159 @fields = fields 'table'; #as a subroutine
160 @fields = $record->fields; #as a method call
165 (Mostly) object-oriented interface to database records. Records are currently
166 implemented on top of DBI. FS::Record is intended as a base class for
167 table-specific classes to inherit from, i.e. FS::cust_main.
173 =item new [ TABLE, ] HASHREF
175 Creates a new record. It doesn't store it in the database, though. See
176 L<"insert"> for that.
178 Note that the object stores this hash reference, not a distinct copy of the
179 hash it points to. You can ask the object for a copy with the I<hash>
182 TABLE can only be omitted when a dervived class overrides the table method.
188 my $class = ref($proto) || $proto;
190 bless ($self, $class);
192 unless ( defined ( $self->table ) ) {
193 $self->{'Table'} = shift;
194 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
195 unless $nowarn_classload;
198 $self->{'Hash'} = shift;
200 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
201 $self->{'Hash'}{$field}='';
204 $self->_rebless if $self->can('_rebless');
206 $self->{'modified'} = 0;
208 $self->_simplecache($self->{'Hash'}) if $self->can('_simplecache');
209 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
216 my $class = ref($proto) || $proto;
218 bless ($self, $class);
220 $self->{'Table'} = shift unless defined ( $self->table );
222 my $hashref = $self->{'Hash'} = shift;
224 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
225 my $obj = $cache->cache->{$hashref->{$cache->key}};
226 $obj->_cache($hashref, $cache) if $obj->can('_cache');
229 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
236 my $class = ref($proto) || $proto;
238 bless ($self, $class);
239 if ( defined $self->table ) {
240 cluck "create constructor is deprecated, use new!";
243 croak "FS::Record::create called (not from a subclass)!";
247 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
249 Searches the database for all records matching (at least) the key/value pairs
250 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
251 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
254 The preferred usage is to pass a hash reference of named parameters:
256 @records = qsearch( {
257 'table' => 'table_name',
258 'hashref' => { 'field' => 'value'
259 'field' => { 'op' => '<',
264 #these are optional...
266 'extra_sql' => 'AND field = ? AND intfield = ?',
267 'extra_param' => [ 'value', [ 5, 'int' ] ],
268 'order_by' => 'ORDER BY something',
269 #'cache_obj' => '', #optional
270 'addl_from' => 'LEFT JOIN othtable USING ( field )',
275 Much code still uses old-style positional parameters, this is also probably
276 fine in the common case where there are only two parameters:
278 my @records = qsearch( 'table', { 'field' => 'value' } );
280 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
281 the individual PARAMS_HASHREF queries
283 ###oops, argh, FS::Record::new only lets us create database fields.
284 #Normal behaviour if SELECT is not specified is `*', as in
285 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
286 #feature where you can specify SELECT - remember, the objects returned,
287 #although blessed into the appropriate `FS::TABLE' package, will only have the
288 #fields you specify. This might have unwanted results if you then go calling
289 #regular FS::TABLE methods
294 my %TYPE = (); #for debugging
297 my($type, $value) = @_;
299 my $bind_type = { TYPE => SQL_VARCHAR };
301 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
303 $bind_type = { TYPE => SQL_INTEGER };
305 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
307 if ( driver_name eq 'Pg' ) {
309 $bind_type = { pg_type => PG_BYTEA };
311 # $bind_type = ? #SQL_VARCHAR could be fine?
314 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
315 #fixed by DBD::Pg 2.11.8
316 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
317 #(make a Tron test first)
318 } elsif ( _is_fs_float( $type, $value ) ) {
320 $bind_type = { TYPE => SQL_DECIMAL };
329 my($type, $value) = @_;
330 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
331 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
339 my( @stable, @record, @cache );
340 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
342 my %union_options = ();
343 if ( ref($_[0]) eq 'ARRAY' ) {
346 foreach my $href ( @$optlist ) {
347 push @stable, ( $href->{'table'} or die "table name is required" );
348 push @record, ( $href->{'hashref'} || {} );
349 push @select, ( $href->{'select'} || '*' );
350 push @extra_sql, ( $href->{'extra_sql'} || '' );
351 push @extra_param, ( $href->{'extra_param'} || [] );
352 push @order_by, ( $href->{'order_by'} || '' );
353 push @cache, ( $href->{'cache_obj'} || '' );
354 push @addl_from, ( $href->{'addl_from'} || '' );
355 push @debug, ( $href->{'debug'} || '' );
357 die "at least one hashref is required" unless scalar(@stable);
358 } elsif ( ref($_[0]) eq 'HASH' ) {
360 $stable[0] = $opt->{'table'} or die "table name is required";
361 $record[0] = $opt->{'hashref'} || {};
362 $select[0] = $opt->{'select'} || '*';
363 $extra_sql[0] = $opt->{'extra_sql'} || '';
364 $extra_param[0] = $opt->{'extra_param'} || [];
365 $order_by[0] = $opt->{'order_by'} || '';
366 $cache[0] = $opt->{'cache_obj'} || '';
367 $addl_from[0] = $opt->{'addl_from'} || '';
368 $debug[0] = $opt->{'debug'} || '';
379 my $cache = $cache[0];
385 foreach my $stable ( @stable ) {
386 #stop altering the caller's hashref
387 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
388 my $select = shift @select;
389 my $extra_sql = shift @extra_sql;
390 my $extra_param = shift @extra_param;
391 my $order_by = shift @order_by;
392 my $cache = shift @cache;
393 my $addl_from = shift @addl_from;
394 my $debug = shift @debug;
396 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
398 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
401 my $table = $cache ? $cache->table : $stable;
402 my $dbdef_table = dbdef->table($table)
403 or die "No schema for table $table found - ".
404 "do you need to run freeside-upgrade?";
405 my $pkey = $dbdef_table->primary_key;
407 my @real_fields = grep exists($record->{$_}), real_fields($table);
409 my $statement .= "SELECT $select FROM $stable";
410 $statement .= " $addl_from" if $addl_from;
411 if ( @real_fields ) {
412 $statement .= ' WHERE '. join(' AND ',
413 get_real_fields($table, $record, \@real_fields));
416 $statement .= " $extra_sql" if defined($extra_sql);
417 $statement .= " $order_by" if defined($order_by);
419 push @statement, $statement;
421 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
425 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
428 my $value = $record->{$field};
429 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
430 $value = $value->{'value'} if ref($value);
431 my $type = dbdef->table($table)->column($field)->type;
433 my $bind_type = _bind_type($type, $value);
437 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
439 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
443 push @bind_type, $bind_type;
447 foreach my $param ( @$extra_param ) {
448 my $bind_type = { TYPE => SQL_VARCHAR };
451 $value = $param->[0];
452 my $type = $param->[1];
453 $bind_type = _bind_type($type, $value);
456 push @bind_type, $bind_type;
460 my $statement = join( ' ) UNION ( ', @statement );
461 $statement = "( $statement )" if scalar(@statement) > 1;
462 $statement .= " $union_options{order_by}" if $union_options{order_by};
464 my $sth = $dbh->prepare($statement)
465 or croak "$dbh->errstr doing $statement";
468 foreach my $value ( @value ) {
469 my $bind_type = shift @bind_type;
470 $sth->bind_param($bind++, $value, $bind_type );
473 # $sth->execute( map $record->{$_},
474 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
475 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
477 my $ok = $sth->execute;
479 my $error = "Error executing \"$statement\"";
480 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
481 $error .= ': '. $sth->errstr;
486 # Determine how to format rows returned form a union query:
488 # * When all queries involved in the union are from the same table:
489 # Return an array of FS::$table_name objects
491 # * When union query is performed on multiple tables,
492 # Return an array of FS::Record objects
493 # ! Note: As far as I can tell, this functionality was broken, and
494 # ! actually results in a crash. Behavior is left intact
495 # ! as-is, in case the results are in use somewhere
497 # * Union query is performed on multiple table,
498 # and $union_options{classname_from_column} = 1
499 # Return an array of FS::$classname objects, where $classname is
500 # derived for each row from a static field inserted each returned
502 # e.g.: SELECT custnum,first,last,'cust_main' AS `__classname`'.
505 my $table = $stable[0];
507 $table = '' if grep { $_ ne $table } @stable;
508 $pkey = dbdef->table($table)->primary_key if $table;
511 tie %result, "Tie::IxHash";
512 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
513 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
514 %result = map { $_->{$pkey}, $_ } @stuff;
516 @result{@stuff} = @stuff;
522 if ($union_options{classname_from_column}) {
525 # I'm not implementing the cache for this use case, at least not yet
528 for my $row (@stuff) {
529 my $table_class = $row->{__classname}
530 or die "`__classname` column must be set when ".
531 "using \$union_options{classname_from_column}";
532 push @return, new("FS::$table_class",$row);
536 elsif ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
537 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
538 #derivied class didn't override new method, so this optimization is safe
541 new_or_cached( "FS::$table", { %{$_} }, $cache )
545 new( "FS::$table", { %{$_} } )
549 #okay, its been tested
550 # warn "untested code (class FS::$table uses custom new method)";
552 eval 'FS::'. $table. '->new( { %{$_} } )';
556 # Check for encrypted fields and decrypt them.
557 ## only in the local copy, not the cached object
558 no warnings 'deprecated'; # XXX silence the warning for now
559 if ( $conf_encryption
560 && eval '@FS::'. $table . '::encrypted_fields' ) {
561 foreach my $record (@return) {
562 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
563 next if $field eq 'payinfo'
564 && ($record->isa('FS::payinfo_transaction_Mixin')
565 || $record->isa('FS::payinfo_Mixin') )
567 && !grep { $record->payby eq $_ } @encrypt_payby;
568 # Set it directly... This may cause a problem in the future...
569 $record->setfield($field, $record->decrypt($record->getfield($field)));
574 cluck "warning: FS::$table not loaded; returning FS::Record objects"
575 unless $nowarn_classload;
577 FS::Record->new( $table, { %{$_} } );
585 Construct the SQL statement and parameter-binding list for qsearch. Takes
586 the qsearch parameters.
588 Returns a hash containing:
589 'table': The primary table name (if there is one).
590 'statement': The SQL statement itself.
591 'bind_type': An arrayref of bind types.
592 'value': An arrayref of parameter values.
593 'cache': The cache object, if one was passed.
598 my( @stable, @record, @cache );
599 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
602 my %union_options = ();
603 if ( ref($_[0]) eq 'ARRAY' ) {
606 foreach my $href ( @$optlist ) {
607 push @stable, ( $href->{'table'} or die "table name is required" );
608 push @record, ( $href->{'hashref'} || {} );
609 push @select, ( $href->{'select'} || '*' );
610 push @extra_sql, ( $href->{'extra_sql'} || '' );
611 push @extra_param, ( $href->{'extra_param'} || [] );
612 push @order_by, ( $href->{'order_by'} || '' );
613 push @cache, ( $href->{'cache_obj'} || '' );
614 push @addl_from, ( $href->{'addl_from'} || '' );
615 push @debug, ( $href->{'debug'} || '' );
617 die "at least one hashref is required" unless scalar(@stable);
618 } elsif ( ref($_[0]) eq 'HASH' ) {
620 $stable[0] = $opt->{'table'} or die "table name is required";
621 $record[0] = $opt->{'hashref'} || {};
622 $select[0] = $opt->{'select'} || '*';
623 $extra_sql[0] = $opt->{'extra_sql'} || '';
624 $extra_param[0] = $opt->{'extra_param'} || [];
625 $order_by[0] = $opt->{'order_by'} || '';
626 $cache[0] = $opt->{'cache_obj'} || '';
627 $addl_from[0] = $opt->{'addl_from'} || '';
628 $debug[0] = $opt->{'debug'} || '';
639 my $cache = $cache[0];
645 my $result_table = $stable[0];
646 foreach my $stable ( @stable ) {
647 #stop altering the caller's hashref
648 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
649 my $select = shift @select;
650 my $extra_sql = shift @extra_sql;
651 my $extra_param = shift @extra_param;
652 my $order_by = shift @order_by;
653 my $cache = shift @cache;
654 my $addl_from = shift @addl_from;
655 my $debug = shift @debug;
657 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
659 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
662 $result_table = '' if $result_table ne $stable;
664 my $table = $cache ? $cache->table : $stable;
665 my $dbdef_table = dbdef->table($table)
666 or die "No schema for table $table found - ".
667 "do you need to run freeside-upgrade?";
668 my $pkey = $dbdef_table->primary_key;
670 my @real_fields = grep exists($record->{$_}), real_fields($table);
672 my $statement .= "SELECT $select FROM $stable";
673 $statement .= " $addl_from" if $addl_from;
674 if ( @real_fields ) {
675 $statement .= ' WHERE '. join(' AND ',
676 get_real_fields($table, $record, \@real_fields));
679 $statement .= " $extra_sql" if defined($extra_sql);
680 $statement .= " $order_by" if defined($order_by);
682 push @statement, $statement;
684 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
688 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
691 my $value = $record->{$field};
692 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
693 $value = $value->{'value'} if ref($value);
694 my $type = dbdef->table($table)->column($field)->type;
696 my $bind_type = _bind_type($type, $value);
700 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
702 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
706 push @bind_type, $bind_type;
710 foreach my $param ( @$extra_param ) {
711 my $bind_type = { TYPE => SQL_VARCHAR };
714 $value = $param->[0];
715 my $type = $param->[1];
716 $bind_type = _bind_type($type, $value);
719 push @bind_type, $bind_type;
723 my $statement = join( ' ) UNION ( ', @statement );
724 $statement = "( $statement )" if scalar(@statement) > 1;
725 $statement .= " $union_options{order_by}" if $union_options{order_by};
728 statement => $statement,
729 bind_type => \@bind_type,
731 table => $result_table,
736 # qsearch should eventually use this
738 my ($table, $cache, @hashrefs) = @_;
740 # XXX get rid of these string evals at some point
741 # (when we have time to test it)
742 # my $class = "FS::$table" if $table;
743 # if ( $class and $class->isa('FS::Record') )
744 # if ( $class->can('new') eq \&new )
746 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
747 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
748 #derivied class didn't override new method, so this optimization is safe
751 new_or_cached( "FS::$table", { %{$_} }, $cache )
755 new( "FS::$table", { %{$_} } )
759 #okay, its been tested
760 # warn "untested code (class FS::$table uses custom new method)";
762 eval 'FS::'. $table. '->new( { %{$_} } )';
766 # Check for encrypted fields and decrypt them.
767 ## only in the local copy, not the cached object
768 if ( $conf_encryption
769 && eval '@FS::'. $table . '::encrypted_fields' ) {
770 foreach my $record (@return) {
771 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
772 next if $field eq 'payinfo'
773 && ($record->isa('FS::payinfo_transaction_Mixin')
774 || $record->isa('FS::payinfo_Mixin') )
776 && !grep { $record->payby eq $_ } @encrypt_payby;
777 # Set it directly... This may cause a problem in the future...
778 $record->setfield($field, $record->decrypt($record->getfield($field)));
783 cluck "warning: FS::$table not loaded; returning FS::Record objects"
784 unless $nowarn_classload;
786 FS::Record->new( $table, { %{$_} } );
792 sub get_real_fields {
795 my $real_fields = shift;
797 ## could be optimized more for readability
803 my $table_column = $qsearch_qualify_columns ? "$table.$column" : $column;
804 my $type = dbdef->table($table)->column($column)->type;
805 my $value = $record->{$column};
806 $value = $value->{'value'} if ref($value);
808 if ( ref($record->{$column}) ) {
809 $op = $record->{$column}{'op'} if $record->{$column}{'op'};
810 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
811 if ( uc($op) eq 'ILIKE' ) {
813 $record->{$column}{'value'} = lc($record->{$column}{'value'});
814 $table_column = "LOWER($table_column)";
816 $record->{$column} = $record->{$column}{'value'}
819 if ( ! defined( $record->{$column} ) || $record->{$column} eq '' ) {
821 if ( driver_name eq 'Pg' ) {
822 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
823 qq-( $table_column IS NULL )-;
825 qq-( $table_column IS NULL OR $table_column = '' )-;
828 qq-( $table_column IS NULL OR $table_column = "" )-;
830 } elsif ( $op eq '!=' ) {
831 if ( driver_name eq 'Pg' ) {
832 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
833 qq-( $table_column IS NOT NULL )-;
835 qq-( $table_column IS NOT NULL AND $table_column != '' )-;
838 qq-( $table_column IS NOT NULL AND $table_column != "" )-;
841 if ( driver_name eq 'Pg' ) {
842 qq-( $table_column $op '' )-;
844 qq-( $table_column $op "" )-;
847 } elsif ( $op eq '!=' ) {
848 qq-( $table_column IS NULL OR $table_column != ? )-;
849 #if this needs to be re-enabled, it needs to use a custom op like
850 #"APPROX=" or something (better name?, not '=', to avoid affecting other
852 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
853 # ( "$table_column <= ?", "$table_column >= ?" );
855 "$table_column $op ?";
862 =item by_key PRIMARY_KEY_VALUE
864 This is a class method that returns the record with the given primary key
865 value. This method is only useful in FS::Record subclasses. For example:
867 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
871 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
876 my ($class, $pkey_value) = @_;
878 my $table = $class->table
879 or croak "No table for $class found";
881 my $dbdef_table = dbdef->table($table)
882 or die "No schema for table $table found - ".
883 "do you need to create it or run dbdef-create?";
884 my $pkey = $dbdef_table->primary_key
885 or die "No primary key for table $table";
887 return qsearchs($table, { $pkey => $pkey_value });
890 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
892 Experimental JOINed search method. Using this method, you can execute a
893 single SELECT spanning multiple tables, and cache the results for subsequent
894 method calls. Interface will almost definately change in an incompatible
902 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
903 my $cache = FS::SearchCache->new( $ptable, $pkey );
906 grep { !$saw{$_->getfield($pkey)}++ }
907 qsearch($table, $record, $select, $extra_sql, $cache )
911 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
913 Same as qsearch, except that if more than one record matches, it B<carp>s but
914 returns the first. If this happens, you either made a logic error in asking
915 for a single item, or your data is corrupted.
919 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
921 my(@result) = qsearch(@_);
922 cluck "warning: Multiple records in scalar search ($table)"
923 if scalar(@result) > 1;
924 #should warn more vehemently if the search was on a primary key?
925 scalar(@result) ? ($result[0]) : ();
936 Returns the table name.
941 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
948 Returns the DBIx::DBSchema::Table object for the table.
954 my($table)=$self->table;
955 dbdef->table($table);
960 Returns the primary key for the table.
966 my $pkey = $self->dbdef_table->primary_key;
969 =item get, getfield COLUMN
971 Returns the value of the column/field/key COLUMN.
976 my($self,$field) = @_;
977 # to avoid "Use of unitialized value" errors
978 if ( defined ( $self->{Hash}->{$field} ) ) {
979 $self->{Hash}->{$field};
989 =item set, setfield COLUMN, VALUE
991 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
996 my($self,$field,$value) = @_;
997 $self->{'modified'} = 1;
998 $self->{'Hash'}->{$field} = $value;
1007 Returns true if the column/field/key COLUMN exists.
1012 my($self,$field) = @_;
1013 exists($self->{Hash}->{$field});
1016 =item AUTLOADED METHODS
1018 $record->column is a synonym for $record->get('column');
1020 $record->column('value') is a synonym for $record->set('column','value');
1026 my($self,$value)=@_;
1027 my($field)=$AUTOLOAD;
1029 if ( defined($value) ) {
1030 confess "errant AUTOLOAD $field for $self (arg $value)"
1031 unless blessed($self) && $self->can('setfield');
1032 $self->setfield($field,$value);
1034 confess "errant AUTOLOAD $field for $self (no args)"
1035 unless blessed($self) && $self->can('getfield');
1036 $self->getfield($field);
1042 # my $field = $AUTOLOAD;
1043 # $field =~ s/.*://;
1044 # if ( defined($_[1]) ) {
1045 # $_[0]->setfield($field, $_[1]);
1047 # $_[0]->getfield($field);
1053 Returns a list of the column/value pairs, usually for assigning to a new hash.
1055 To make a distinct duplicate of an FS::Record object, you can do:
1057 $new = new FS::Record ( $old->table, { $old->hash } );
1063 confess $self. ' -> hash: Hash attribute is undefined'
1064 unless defined($self->{'Hash'});
1065 %{ $self->{'Hash'} };
1070 Returns a reference to the column/value hash. This may be deprecated in the
1071 future; if there's a reason you can't just use the autoloaded or get/set
1083 Returns true if any of this object's values have been modified with set (or via
1084 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1091 $self->{'modified'};
1094 =item select_for_update
1096 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1101 sub select_for_update {
1103 my $primary_key = $self->primary_key;
1106 'table' => $self->table,
1107 'hashref' => { $primary_key => $self->$primary_key() },
1108 'extra_sql' => 'FOR UPDATE',
1114 Locks this table with a database-driver specific lock method. This is used
1115 as a mutex in order to do a duplicate search.
1117 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1119 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1121 Errors are fatal; no useful return value.
1123 Note: To use this method for new tables other than svc_acct and svc_phone,
1124 edit freeside-upgrade and add those tables to the duplicate_lock list.
1130 my $table = $self->table;
1132 warn "$me locking $table table\n" if $DEBUG;
1134 if ( driver_name =~ /^Pg/i ) {
1136 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1139 } elsif ( driver_name =~ /^mysql/i ) {
1141 dbh->do("SELECT * FROM duplicate_lock
1142 WHERE lockname = '$table'
1144 ) or die dbh->errstr;
1148 die "unknown database ". driver_name. "; don't know how to lock table";
1152 warn "$me acquired $table table lock\n" if $DEBUG;
1158 Inserts this record to the database. If there is an error, returns the error,
1159 otherwise returns false.
1167 warn "$self -> insert" if $DEBUG;
1169 my $error = $self->check;
1170 return $error if $error;
1172 #single-field non-null unique keys are given a value if empty
1173 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1174 foreach ( $self->dbdef_table->unique_singles) {
1175 next if $self->getfield($_);
1176 next if $self->dbdef_table->column($_)->null eq 'NULL';
1180 #and also the primary key, if the database isn't going to
1181 my $primary_key = $self->dbdef_table->primary_key;
1183 if ( $primary_key ) {
1184 my $col = $self->dbdef_table->column($primary_key);
1187 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1188 || ( driver_name eq 'Pg'
1189 && defined($col->default)
1190 && $col->quoted_default =~ /^nextval\(/i
1192 || ( driver_name eq 'mysql'
1193 && defined($col->local)
1194 && $col->local =~ /AUTO_INCREMENT/i
1196 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1199 my $table = $self->table;
1201 # Encrypt before the database
1202 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1205 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1206 next if $field eq 'payinfo'
1207 && ($self->isa('FS::payinfo_transaction_Mixin')
1208 || $self->isa('FS::payinfo_Mixin') )
1210 && !grep { $self->payby eq $_ } @encrypt_payby;
1211 $saved->{$field} = $self->getfield($field);
1212 $self->setfield($field, $self->encrypt($self->getfield($field)));
1216 #false laziness w/delete
1218 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1221 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1224 my $statement = "INSERT INTO $table ";
1225 if ( @real_fields ) {
1228 join( ', ', @real_fields ).
1230 join( ', ', @values ).
1234 $statement .= 'DEFAULT VALUES';
1236 warn "[debug]$me $statement\n" if $DEBUG > 1;
1237 my $sth = dbh->prepare($statement) or return dbh->errstr;
1239 local $SIG{HUP} = 'IGNORE';
1240 local $SIG{INT} = 'IGNORE';
1241 local $SIG{QUIT} = 'IGNORE';
1242 local $SIG{TERM} = 'IGNORE';
1243 local $SIG{TSTP} = 'IGNORE';
1244 local $SIG{PIPE} = 'IGNORE';
1246 $sth->execute or return $sth->errstr;
1248 # get inserted id from the database, if applicable & needed
1249 if ( $db_seq && ! $self->getfield($primary_key) ) {
1250 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1254 if ( driver_name eq 'Pg' ) {
1256 #my $oid = $sth->{'pg_oid_status'};
1257 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1259 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1260 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1261 dbh->rollback if $FS::UID::AutoCommit;
1262 return "can't parse $table.$primary_key default value".
1263 " for sequence name: $default";
1267 my $i_sql = "SELECT currval('$sequence')";
1268 my $i_sth = dbh->prepare($i_sql) or do {
1269 dbh->rollback if $FS::UID::AutoCommit;
1272 $i_sth->execute() or do { #$i_sth->execute($oid)
1273 dbh->rollback if $FS::UID::AutoCommit;
1274 return $i_sth->errstr;
1276 $insertid = $i_sth->fetchrow_arrayref->[0];
1278 } elsif ( driver_name eq 'mysql' ) {
1280 $insertid = dbh->{'mysql_insertid'};
1281 # work around mysql_insertid being null some of the time, ala RT :/
1282 unless ( $insertid ) {
1283 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1284 "using SELECT LAST_INSERT_ID();";
1285 my $i_sql = "SELECT LAST_INSERT_ID()";
1286 my $i_sth = dbh->prepare($i_sql) or do {
1287 dbh->rollback if $FS::UID::AutoCommit;
1290 $i_sth->execute or do {
1291 dbh->rollback if $FS::UID::AutoCommit;
1292 return $i_sth->errstr;
1294 $insertid = $i_sth->fetchrow_arrayref->[0];
1299 dbh->rollback if $FS::UID::AutoCommit;
1300 return "don't know how to retreive inserted ids from ". driver_name.
1301 ", try using counterfiles (maybe run dbdef-create?)";
1305 $self->setfield($primary_key, $insertid);
1310 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1311 my $h_statement = $self->_h_statement('insert');
1312 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1313 $h_sth = dbh->prepare($h_statement) or do {
1314 dbh->rollback if $FS::UID::AutoCommit;
1320 $h_sth->execute or return $h_sth->errstr if $h_sth;
1322 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1324 # Now that it has been saved, reset the encrypted fields so that $new
1325 # can still be used.
1326 foreach my $field (keys %{$saved}) {
1327 $self->setfield($field, $saved->{$field});
1335 Depriciated (use insert instead).
1340 cluck "warning: FS::Record::add deprecated!";
1341 insert @_; #call method in this scope
1346 Delete this record from the database. If there is an error, returns the error,
1347 otherwise returns false.
1354 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1356 $self->getfield($_) eq ''
1357 #? "( $_ IS NULL OR $_ = \"\" )"
1358 ? ( driver_name eq 'Pg'
1360 : "( $_ IS NULL OR $_ = \"\" )"
1362 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1363 } ( $self->dbdef_table->primary_key )
1364 ? ( $self->dbdef_table->primary_key)
1365 : real_fields($self->table)
1367 warn "[debug]$me $statement\n" if $DEBUG > 1;
1368 my $sth = dbh->prepare($statement) or return dbh->errstr;
1371 if ( defined dbdef->table('h_'. $self->table) ) {
1372 my $h_statement = $self->_h_statement('delete');
1373 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1374 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1379 my $primary_key = $self->dbdef_table->primary_key;
1381 local $SIG{HUP} = 'IGNORE';
1382 local $SIG{INT} = 'IGNORE';
1383 local $SIG{QUIT} = 'IGNORE';
1384 local $SIG{TERM} = 'IGNORE';
1385 local $SIG{TSTP} = 'IGNORE';
1386 local $SIG{PIPE} = 'IGNORE';
1388 my $rc = $sth->execute or return $sth->errstr;
1389 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1390 $h_sth->execute or return $h_sth->errstr if $h_sth;
1392 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1394 #no need to needlessly destoy the data either (causes problems actually)
1395 #undef $self; #no need to keep object!
1402 Depriciated (use delete instead).
1407 cluck "warning: FS::Record::del deprecated!";
1408 &delete(@_); #call method in this scope
1411 =item replace OLD_RECORD
1413 Replace the OLD_RECORD with this one in the database. If there is an error,
1414 returns the error, otherwise returns false.
1419 my ($new, $old) = (shift, shift);
1421 $old = $new->replace_old unless defined($old);
1423 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1425 if ( $new->can('replace_check') ) {
1426 my $error = $new->replace_check($old);
1427 return $error if $error;
1430 return "Records not in same table!" unless $new->table eq $old->table;
1432 my $primary_key = $old->dbdef_table->primary_key;
1433 return "Can't change primary key $primary_key ".
1434 'from '. $old->getfield($primary_key).
1435 ' to ' . $new->getfield($primary_key)
1437 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1439 my $error = $new->check;
1440 return $error if $error;
1442 # Encrypt for replace
1444 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1447 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1448 next if $field eq 'payinfo'
1449 && ($new->isa('FS::payinfo_transaction_Mixin')
1450 || $new->isa('FS::payinfo_Mixin') )
1452 && !grep { $new->payby eq $_ } @encrypt_payby;
1453 $saved->{$field} = $new->getfield($field);
1454 $new->setfield($field, $new->encrypt($new->getfield($field)));
1458 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1459 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1460 ? ($_, $new->getfield($_)) : () } $old->fields;
1462 unless (keys(%diff) || $no_update_diff ) {
1463 carp "[warning]$me ". ref($new)."->replace ".
1464 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1465 ": records identical"
1466 unless $nowarn_identical;
1470 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1472 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1473 } real_fields($old->table)
1478 if ( $old->getfield($_) eq '' ) {
1480 #false laziness w/qsearch
1481 if ( driver_name eq 'Pg' ) {
1482 my $type = $old->dbdef_table->column($_)->type;
1483 if ( $type =~ /(int|(big)?serial)/i ) {
1486 qq-( $_ IS NULL OR $_ = '' )-;
1489 qq-( $_ IS NULL OR $_ = "" )-;
1493 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1496 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1499 warn "[debug]$me $statement\n" if $DEBUG > 1;
1500 my $sth = dbh->prepare($statement) or return dbh->errstr;
1503 if ( defined dbdef->table('h_'. $old->table) ) {
1504 my $h_old_statement = $old->_h_statement('replace_old');
1505 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1506 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1512 if ( defined dbdef->table('h_'. $new->table) ) {
1513 my $h_new_statement = $new->_h_statement('replace_new');
1514 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1515 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1520 local $SIG{HUP} = 'IGNORE';
1521 local $SIG{INT} = 'IGNORE';
1522 local $SIG{QUIT} = 'IGNORE';
1523 local $SIG{TERM} = 'IGNORE';
1524 local $SIG{TSTP} = 'IGNORE';
1525 local $SIG{PIPE} = 'IGNORE';
1527 my $rc = $sth->execute or return $sth->errstr;
1528 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1529 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1530 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1532 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1534 # Now that it has been saved, reset the encrypted fields so that $new
1535 # can still be used.
1536 foreach my $field (keys %{$saved}) {
1537 $new->setfield($field, $saved->{$field});
1545 my( $self ) = shift;
1546 warn "[$me] replace called with no arguments; autoloading old record\n"
1549 my $primary_key = $self->dbdef_table->primary_key;
1550 if ( $primary_key ) {
1551 $self->by_key( $self->$primary_key() ) #this is what's returned
1552 or croak "can't find ". $self->table. ".$primary_key ".
1553 $self->$primary_key();
1555 croak $self->table. " has no primary key; pass old record as argument";
1562 Depriciated (use replace instead).
1567 cluck "warning: FS::Record::rep deprecated!";
1568 replace @_; #call method in this scope
1573 Checks custom fields. Subclasses should still provide a check method to validate
1574 non-custom fields, foreign keys, etc., and call this method via $self->SUPER::check.
1580 foreach my $field ($self->virtual_fields) {
1581 my $error = $self->ut_textn($field);
1582 return $error if $error;
1587 =item virtual_fields [ TABLE ]
1589 Returns a list of virtual fields defined for the table. This should not
1590 be exported, and should only be called as an instance or class method.
1594 sub virtual_fields {
1597 $table = $self->table or confess "virtual_fields called on non-table";
1599 confess "Unknown table $table" unless dbdef->table($table);
1601 return () unless dbdef->table('part_virtual_field');
1603 unless ( $virtual_fields_cache{$table} ) {
1604 my $concat = [ "'cf_'", "name" ];
1605 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1606 "WHERE dbtable = '$table'";
1608 my $result = $dbh->selectcol_arrayref($query);
1609 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1611 $virtual_fields_cache{$table} = $result;
1614 @{$virtual_fields_cache{$table}};
1618 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1620 Processes a batch import as a queued JSRPC job
1622 JOB is an FS::queue entry.
1624 OPTIONS_HASHREF can have the following keys:
1630 Table name (required).
1634 Arrayref of field names for static fields. They will be given values from the
1635 PARAMS hashref and passed as a "params" hashref to batch_import.
1639 Formats hashref. Keys are field names, values are listrefs that define the
1642 Each listref value can be a column name or a code reference. Coderefs are run
1643 with the row object, data and a FS::Conf object as the three parameters.
1644 For example, this coderef does the same thing as using the "columnname" string:
1647 my( $record, $data, $conf ) = @_;
1648 $record->columnname( $data );
1651 Coderefs are run after all "column name" fields are assigned.
1655 Optional format hashref of types. Keys are field names, values are "csv",
1656 "xls" or "fixedlength". Overrides automatic determination of file type
1659 =item format_headers
1661 Optional format hashref of header lines. Keys are field names, values are 0
1662 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1665 =item format_sep_chars
1667 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1668 CSV separation character.
1670 =item format_fixedlenth_formats
1672 Optional format hashref of fixed length format defintiions. Keys are field
1673 names, values Parse::FixedLength listrefs of field definitions.
1677 Set true to default to CSV file type if the filename does not contain a
1678 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1683 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1684 POSTed data. It must contain the field "uploaded files", generated by
1685 /elements/file-upload.html and containing the list of uploaded files.
1686 Currently only supports a single file named "file".
1690 # uploaded_files is kind of bizarre; fix that some time
1692 use Storable qw(thaw);
1695 sub process_batch_import {
1696 my($job, $opt) = ( shift, shift );
1698 my $table = $opt->{table};
1699 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1700 my %formats = %{ $opt->{formats} };
1703 # because some job-spawning code (JSRPC) pre-freezes the arguments,
1704 # and then the 'frozen' attribute doesn't get set, and thus $job->args
1705 # doesn't know to thaw them, we have to do this everywhere.
1707 $param = thaw(decode_base64($param));
1709 warn Dumper($param) if $DEBUG;
1711 my $files = $param->{'uploaded_files'}
1712 or die "No files provided.\n";
1714 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1716 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1717 my $file = $dir. $files{'file'};
1722 formats => \%formats,
1723 format_types => $opt->{format_types},
1724 format_headers => $opt->{format_headers},
1725 format_sep_chars => $opt->{format_sep_chars},
1726 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1727 format_xml_formats => $opt->{format_xml_formats},
1728 format_asn_formats => $opt->{format_asn_formats},
1729 format_row_callbacks => $opt->{format_row_callbacks},
1730 format_hash_callbacks => $opt->{format_hash_callbacks},
1735 format => $param->{format},
1736 params => { map { $_ => $param->{$_} } @pass_params },
1738 default_csv => $opt->{default_csv},
1739 preinsert_callback => $opt->{preinsert_callback},
1740 postinsert_callback => $opt->{postinsert_callback},
1741 insert_args_callback => $opt->{insert_args_callback},
1744 if ( $opt->{'batch_namecol'} ) {
1745 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1746 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1749 my $error = FS::Record::batch_import( \%iopt );
1753 die "$error\n" if $error;
1756 =item batch_import PARAM_HASHREF
1758 Class method for batch imports. Available params:
1764 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1770 =item format_headers
1772 =item format_sep_chars
1774 =item format_fixedlength_formats
1776 =item format_row_callbacks
1778 =item format_hash_callbacks - After parsing, before object creation
1780 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1782 =item preinsert_callback
1784 =item postinsert_callback
1790 FS::queue object, will be updated with progress
1796 csv, xls, fixedlength, xml
1807 warn "$me batch_import call with params: \n". Dumper($param)
1810 my $table = $param->{table};
1812 my $job = $param->{job};
1813 my $file = $param->{file};
1814 my $params = $param->{params} || {};
1816 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1817 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1819 my( $type, $header, $sep_char,
1820 $fixedlength_format, $xml_format, $asn_format,
1821 $parser_opt, $row_callback, $hash_callback, @fields );
1823 my $postinsert_callback = '';
1824 $postinsert_callback = $param->{'postinsert_callback'}
1825 if $param->{'postinsert_callback'};
1826 my $preinsert_callback = '';
1827 $preinsert_callback = $param->{'preinsert_callback'}
1828 if $param->{'preinsert_callback'};
1829 my $insert_args_callback = '';
1830 $insert_args_callback = $param->{'insert_args_callback'}
1831 if $param->{'insert_args_callback'};
1833 if ( $param->{'format'} ) {
1835 my $format = $param->{'format'};
1836 my $formats = $param->{formats};
1837 die "unknown format $format" unless exists $formats->{ $format };
1839 $type = $param->{'format_types'}
1840 ? $param->{'format_types'}{ $format }
1841 : $param->{type} || 'csv';
1844 $header = $param->{'format_headers'}
1845 ? $param->{'format_headers'}{ $param->{'format'} }
1848 $sep_char = $param->{'format_sep_chars'}
1849 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1852 $fixedlength_format =
1853 $param->{'format_fixedlength_formats'}
1854 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1858 $param->{'format_parser_opts'}
1859 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1863 $param->{'format_xml_formats'}
1864 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1868 $param->{'format_asn_formats'}
1869 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1873 $param->{'format_row_callbacks'}
1874 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1878 $param->{'format_hash_callbacks'}
1879 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
1882 @fields = @{ $formats->{ $format } };
1884 } elsif ( $param->{'fields'} ) {
1886 $type = ''; #infer from filename
1889 $fixedlength_format = '';
1891 $hash_callback = '';
1892 @fields = @{ $param->{'fields'} };
1895 die "neither format nor fields specified";
1898 #my $file = $param->{file};
1901 if ( $file =~ /\.(\w+)$/i ) {
1905 warn "can't parse file type from filename $file; defaulting to CSV";
1909 if $param->{'default_csv'} && $type ne 'xls';
1917 my $asn_header_buffer;
1918 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1920 if ( $type eq 'csv' ) {
1922 $parser_opt->{'binary'} = 1;
1923 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
1924 $parser = Text::CSV_XS->new($parser_opt);
1926 } elsif ( $type eq 'fixedlength' ) {
1928 eval "use Parse::FixedLength;";
1930 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
1933 die "Unknown file type $type\n";
1936 @buffer = split(/\r?\n/, slurp($file) );
1937 splice(@buffer, 0, ($header || 0) );
1938 $count = scalar(@buffer);
1940 } elsif ( $type eq 'xls' ) {
1942 eval "use Spreadsheet::ParseExcel;";
1945 eval "use DateTime::Format::Excel;";
1946 #for now, just let the error be thrown if it is used, since only CDR
1947 # formats bill_west and troop use it, not other excel-parsing things
1950 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1952 $parser = $excel->{Worksheet}[0]; #first sheet
1954 $count = $parser->{MaxRow} || $parser->{MinRow};
1957 $row = $header || 0;
1959 } elsif ( $type eq 'xml' ) {
1962 eval "use XML::Simple;";
1964 my $xmlrow = $xml_format->{'xmlrow'};
1965 $parser = $xml_format->{'xmlkeys'};
1966 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1967 my $data = XML::Simple::XMLin(
1969 'SuppressEmpty' => '', #sets empty values to ''
1973 $rows = $rows->{$_} foreach @$xmlrow;
1974 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1975 $count = @buffer = @$rows;
1977 } elsif ( $type eq 'asn.1' ) {
1979 eval "use Convert::ASN1";
1982 my $asn = Convert::ASN1->new;
1983 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
1985 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
1987 my $data = slurp($file);
1988 my $asn_output = $parser->decode( $data )
1989 or return "No ". $asn_format->{'macro'}. " found\n";
1991 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
1993 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
1994 $count = @buffer = @$rows;
1997 die "Unknown file type $type\n";
2002 local $SIG{HUP} = 'IGNORE';
2003 local $SIG{INT} = 'IGNORE';
2004 local $SIG{QUIT} = 'IGNORE';
2005 local $SIG{TERM} = 'IGNORE';
2006 local $SIG{TSTP} = 'IGNORE';
2007 local $SIG{PIPE} = 'IGNORE';
2009 my $oldAutoCommit = $FS::UID::AutoCommit;
2010 local $FS::UID::AutoCommit = 0;
2013 #my $params = $param->{params} || {};
2014 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2015 my $batch_col = $param->{'batch_keycol'};
2017 my $batch_class = 'FS::'. $param->{'batch_table'};
2018 my $batch = $batch_class->new({
2019 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2021 my $error = $batch->insert;
2023 $dbh->rollback if $oldAutoCommit;
2024 return "can't insert batch record: $error";
2026 #primary key via dbdef? (so the column names don't have to match)
2027 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2029 $params->{ $batch_col } = $batch_value;
2032 #my $job = $param->{job};
2035 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2039 my %hash = %$params;
2040 if ( $type eq 'csv' ) {
2042 last unless scalar(@buffer);
2043 $line = shift(@buffer);
2045 next if $line =~ /^\s*$/; #skip empty lines
2047 $line = &{$row_callback}($line) if $row_callback;
2049 next if $line =~ /^\s*$/; #skip empty lines
2051 $parser->parse($line) or do {
2052 $dbh->rollback if $oldAutoCommit;
2053 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2055 @columns = $parser->fields();
2057 } elsif ( $type eq 'fixedlength' ) {
2059 last unless scalar(@buffer);
2060 $line = shift(@buffer);
2062 @columns = $parser->parse($line);
2064 } elsif ( $type eq 'xls' ) {
2066 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2067 || ! $parser->{Cells}[$row];
2069 my @row = @{ $parser->{Cells}[$row] };
2070 @columns = map $_->{Val}, @row;
2073 #warn $z++. ": $_\n" for @columns;
2075 } elsif ( $type eq 'xml' ) {
2077 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2078 last unless scalar(@buffer);
2079 my $row = shift @buffer;
2080 @columns = @{ $row }{ @$parser };
2082 } elsif ( $type eq 'asn.1' ) {
2084 last unless scalar(@buffer);
2085 my $row = shift @buffer;
2086 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2087 if $asn_format->{row_callback};
2088 foreach my $key ( keys %{ $asn_format->{map} } ) {
2089 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2093 die "Unknown file type $type\n";
2098 foreach my $field ( @fields ) {
2100 my $value = shift @columns;
2102 if ( ref($field) eq 'CODE' ) {
2103 #&{$field}(\%hash, $value);
2104 push @later, $field, $value;
2106 #??? $hash{$field} = $value if length($value);
2107 $hash{$field} = $value if defined($value) && length($value);
2112 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2113 && length($1) == $custnum_length ) {
2114 $hash{custnum} = $2;
2117 %hash = &{$hash_callback}(%hash) if $hash_callback;
2119 #my $table = $param->{table};
2120 my $class = "FS::$table";
2122 my $record = $class->new( \%hash );
2125 while ( scalar(@later) ) {
2126 my $sub = shift @later;
2127 my $data = shift @later;
2129 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2132 $dbh->rollback if $oldAutoCommit;
2133 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2135 last if exists( $param->{skiprow} );
2137 next if exists( $param->{skiprow} );
2139 if ( $preinsert_callback ) {
2140 my $error = &{$preinsert_callback}($record, $param);
2142 $dbh->rollback if $oldAutoCommit;
2143 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2146 next if exists $param->{skiprow} && $param->{skiprow};
2149 my @insert_args = ();
2150 if ( $insert_args_callback ) {
2151 @insert_args = &{$insert_args_callback}($record, $param);
2154 my $error = $record->insert(@insert_args);
2157 $dbh->rollback if $oldAutoCommit;
2158 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2164 if ( $postinsert_callback ) {
2165 my $error = &{$postinsert_callback}($record, $param);
2167 $dbh->rollback if $oldAutoCommit;
2168 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2173 if ( $job && time - $min_sec > $last ) { #progress bar
2174 $job->update_statustext( int(100 * $imported / $count) );
2180 unless ( $imported || $param->{empty_ok} ) {
2181 $dbh->rollback if $oldAutoCommit;
2182 return "Empty file!";
2185 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2192 my( $self, $action, $time ) = @_;
2196 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2199 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2200 real_fields($self->table);
2203 # If we're encrypting then don't store the payinfo in the history
2204 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2205 @fields = grep { $_ ne 'payinfo' } @fields;
2208 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2210 "INSERT INTO h_". $self->table. " ( ".
2211 join(', ', qw(history_date history_user history_action), @fields ).
2213 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
2220 B<Warning>: External use is B<deprecated>.
2222 Replaces COLUMN in record with a unique number, using counters in the
2223 filesystem. Used by the B<insert> method on single-field unique columns
2224 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2225 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2227 Returns the new value.
2232 my($self,$field) = @_;
2233 my($table)=$self->table;
2235 croak "Unique called on field $field, but it is ",
2236 $self->getfield($field),
2238 if $self->getfield($field);
2240 #warn "table $table is tainted" if is_tainted($table);
2241 #warn "field $field is tainted" if is_tainted($field);
2243 my($counter) = new File::CounterFile "$table.$field",0;
2245 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
2247 # my($counter) = new File::CounterFile "$user/$table.$field",0;
2250 my $index = $counter->inc;
2251 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2253 $index =~ /^(\d*)$/;
2256 $self->setfield($field,$index);
2260 =item ut_float COLUMN
2262 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2263 null. If there is an error, returns the error, otherwise returns false.
2268 my($self,$field)=@_ ;
2269 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2270 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2271 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2272 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2273 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2274 $self->setfield($field,$1);
2277 =item ut_floatn COLUMN
2279 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2280 null. If there is an error, returns the error, otherwise returns false.
2284 #false laziness w/ut_ipn
2286 my( $self, $field ) = @_;
2287 if ( $self->getfield($field) =~ /^()$/ ) {
2288 $self->setfield($field,'');
2291 $self->ut_float($field);
2295 =item ut_sfloat COLUMN
2297 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2298 May not be null. If there is an error, returns the error, otherwise returns
2304 my($self,$field)=@_ ;
2305 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2306 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2307 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2308 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2309 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2310 $self->setfield($field,$1);
2313 =item ut_sfloatn COLUMN
2315 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2316 null. If there is an error, returns the error, otherwise returns false.
2321 my( $self, $field ) = @_;
2322 if ( $self->getfield($field) =~ /^()$/ ) {
2323 $self->setfield($field,'');
2326 $self->ut_sfloat($field);
2330 =item ut_snumber COLUMN
2332 Check/untaint signed numeric data (whole numbers). If there is an error,
2333 returns the error, otherwise returns false.
2338 my($self, $field) = @_;
2339 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2340 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2341 $self->setfield($field, "$1$2");
2345 =item ut_snumbern COLUMN
2347 Check/untaint signed numeric data (whole numbers). If there is an error,
2348 returns the error, otherwise returns false.
2353 my($self, $field) = @_;
2354 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2355 or return "Illegal (numeric) $field: ". $self->getfield($field);
2357 return "Illegal (numeric) $field: ". $self->getfield($field)
2360 $self->setfield($field, "$1$2");
2364 =item ut_number COLUMN
2366 Check/untaint simple numeric data (whole numbers). May not be null. If there
2367 is an error, returns the error, otherwise returns false.
2372 my($self,$field)=@_;
2373 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2374 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2375 $self->setfield($field,$1);
2379 =item ut_numbern COLUMN
2381 Check/untaint simple numeric data (whole numbers). May be null. If there is
2382 an error, returns the error, otherwise returns false.
2387 my($self,$field)=@_;
2388 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2389 or return "Illegal (numeric) $field: ". $self->getfield($field);
2390 $self->setfield($field,$1);
2394 =item ut_decimal COLUMN[, DIGITS]
2396 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2397 error, returns the error, otherwise returns false.
2399 =item ut_decimaln COLUMN[, DIGITS]
2401 Check/untaint decimal numbers. May be null. If there is an error, returns
2402 the error, otherwise returns false.
2407 my($self, $field, $digits) = @_;
2409 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2410 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2411 $self->setfield($field, $1);
2416 my($self, $field, $digits) = @_;
2417 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2418 or return "Illegal (decimal) $field: ".$self->getfield($field);
2419 $self->setfield($field, $1);
2423 =item ut_money COLUMN
2425 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2426 is an error, returns the error, otherwise returns false.
2431 my($self,$field)=@_;
2433 if ( $self->getfield($field) eq '' ) {
2434 $self->setfield($field, 0);
2435 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2436 #handle one decimal place without barfing out
2437 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2438 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2439 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2441 return "Illegal (money) $field: ". $self->getfield($field);
2447 =item ut_moneyn COLUMN
2449 Check/untaint monetary numbers. May be negative. If there
2450 is an error, returns the error, otherwise returns false.
2455 my($self,$field)=@_;
2456 if ($self->getfield($field) eq '') {
2457 $self->setfield($field, '');
2460 $self->ut_money($field);
2463 =item ut_text COLUMN
2465 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2466 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < > ~
2467 May not be null. If there is an error, returns the error, otherwise returns
2473 my($self,$field)=@_;
2474 #warn "msgcat ". \&msgcat. "\n";
2475 #warn "notexist ". \¬exist. "\n";
2476 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2477 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2478 # see perldoc perluniprops
2479 $self->getfield($field)
2480 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>\~$money_char]+)$/
2481 or return gettext('illegal_or_empty_text'). " $field: ".
2482 $self->getfield($field);
2483 $self->setfield($field,$1);
2487 =item ut_textn COLUMN
2489 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2490 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2491 May be null. If there is an error, returns the error, otherwise returns false.
2496 my($self,$field)=@_;
2497 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2498 $self->ut_text($field);
2501 =item ut_alpha COLUMN
2503 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2504 an error, returns the error, otherwise returns false.
2509 my($self,$field)=@_;
2510 $self->getfield($field) =~ /^(\w+)$/
2511 or return "Illegal or empty (alphanumeric) $field: ".
2512 $self->getfield($field);
2513 $self->setfield($field,$1);
2517 =item ut_alphan COLUMN
2519 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2520 error, returns the error, otherwise returns false.
2525 my($self,$field)=@_;
2526 $self->getfield($field) =~ /^(\w*)$/
2527 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2528 $self->setfield($field,$1);
2532 =item ut_alphasn COLUMN
2534 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2535 an error, returns the error, otherwise returns false.
2540 my($self,$field)=@_;
2541 $self->getfield($field) =~ /^([\w ]*)$/
2542 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2543 $self->setfield($field,$1);
2548 =item ut_alpha_lower COLUMN
2550 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2551 there is an error, returns the error, otherwise returns false.
2555 sub ut_alpha_lower {
2556 my($self,$field)=@_;
2557 $self->getfield($field) =~ /[[:upper:]]/
2558 and return "Uppercase characters are not permitted in $field";
2559 $self->ut_alpha($field);
2562 =item ut_phonen COLUMN [ COUNTRY ]
2564 Check/untaint phone numbers. May be null. If there is an error, returns
2565 the error, otherwise returns false.
2567 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2568 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2573 my( $self, $field, $country ) = @_;
2574 return $self->ut_alphan($field) unless defined $country;
2575 my $phonen = $self->getfield($field);
2576 if ( $phonen eq '' ) {
2577 $self->setfield($field,'');
2578 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2580 $phonen = $conf->config('cust_main-default_areacode').$phonen
2581 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2582 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2583 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2584 $phonen = "$1-$2-$3";
2585 $phonen .= " x$4" if $4;
2586 $self->setfield($field,$phonen);
2588 warn "warning: don't know how to check phone numbers for country $country";
2589 return $self->ut_textn($field);
2596 Check/untaint hexadecimal values.
2601 my($self, $field) = @_;
2602 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2603 or return "Illegal (hex) $field: ". $self->getfield($field);
2604 $self->setfield($field, uc($1));
2608 =item ut_hexn COLUMN
2610 Check/untaint hexadecimal values. May be null.
2615 my($self, $field) = @_;
2616 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2617 or return "Illegal (hex) $field: ". $self->getfield($field);
2618 $self->setfield($field, uc($1));
2622 =item ut_mac_addr COLUMN
2624 Check/untaint mac addresses. May be null.
2629 my($self, $field) = @_;
2631 my $mac = $self->get($field);
2634 $self->set($field, $mac);
2636 my $e = $self->ut_hex($field);
2639 return "Illegal (mac address) $field: ". $self->getfield($field)
2640 unless length($self->getfield($field)) == 12;
2646 =item ut_mac_addrn COLUMN
2648 Check/untaint mac addresses. May be null.
2653 my($self, $field) = @_;
2654 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2659 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2665 my( $self, $field ) = @_;
2666 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2667 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2668 or return "Illegal (IP address) $field: ". $self->getfield($field);
2669 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2670 $self->setfield($field, "$1.$2.$3.$4");
2676 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2677 to 127.0.0.1. May be null.
2682 my( $self, $field ) = @_;
2683 if ( $self->getfield($field) =~ /^()$/ ) {
2684 $self->setfield($field,'');
2687 $self->ut_ip($field);
2691 =item ut_ip46 COLUMN
2693 Check/untaint IPv4 or IPv6 address.
2698 my( $self, $field ) = @_;
2699 my $ip = NetAddr::IP->new($self->getfield($field))
2700 or return "Illegal (IP address) $field: ".$self->getfield($field);
2701 $self->setfield($field, lc($ip->addr));
2707 Check/untaint IPv6 or IPv6 address. May be null.
2712 my( $self, $field ) = @_;
2713 if ( $self->getfield($field) =~ /^$/ ) {
2714 $self->setfield($field, '');
2717 $self->ut_ip46($field);
2720 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2722 Check/untaint coordinates.
2723 Accepts the following forms:
2733 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2734 The latter form (that is, the MMM are thousands of minutes) is
2735 assumed if the "MMM" is exactly three digits or two digits > 59.
2737 To be safe, just use the DDD.DDDDD form.
2739 If LOWER or UPPER are specified, then the coordinate is checked
2740 for lower and upper bounds, respectively.
2745 my ($self, $field) = (shift, shift);
2748 if ( $field =~ /latitude/ ) {
2749 $lower = $lat_lower;
2751 } elsif ( $field =~ /longitude/ ) {
2753 $upper = $lon_upper;
2756 my $coord = $self->getfield($field);
2757 my $neg = $coord =~ s/^(-)//;
2759 # ignore degree symbol at the end,
2760 # but not otherwise supporting degree/minutes/seconds symbols
2761 $coord =~ s/\N{DEGREE SIGN}\s*$//;
2763 my ($d, $m, $s) = (0, 0, 0);
2766 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2767 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2768 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2770 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2773 return "Invalid (coordinate with minutes > 59) $field: "
2774 . $self->getfield($field);
2777 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2779 if (defined($lower) and ($coord < $lower)) {
2780 return "Invalid (coordinate < $lower) $field: "
2781 . $self->getfield($field);;
2784 if (defined($upper) and ($coord > $upper)) {
2785 return "Invalid (coordinate > $upper) $field: "
2786 . $self->getfield($field);;
2789 $self->setfield($field, $coord);
2793 return "Invalid (coordinate) $field: " . $self->getfield($field);
2797 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2799 Same as ut_coord, except optionally null.
2805 my ($self, $field) = (shift, shift);
2807 if ($self->getfield($field) =~ /^\s*$/) {
2810 return $self->ut_coord($field, @_);
2815 =item ut_domain COLUMN
2817 Check/untaint host and domain names. May not be null.
2822 my( $self, $field ) = @_;
2823 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2824 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2825 or return "Illegal (hostname) $field: ". $self->getfield($field);
2826 $self->setfield($field,$1);
2830 =item ut_domainn COLUMN
2832 Check/untaint host and domain names. May be null.
2837 my( $self, $field ) = @_;
2838 if ( $self->getfield($field) =~ /^()$/ ) {
2839 $self->setfield($field,'');
2842 $self->ut_domain($field);
2846 =item ut_name COLUMN
2848 Check/untaint proper names; allows alphanumerics, spaces and the following
2849 punctuation: , . - '
2856 my( $self, $field ) = @_;
2857 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2858 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
2859 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2864 $self->setfield($field, $name);
2868 =item ut_namen COLUMN
2870 Check/untaint proper names; allows alphanumerics, spaces and the following
2871 punctuation: , . - '
2878 my( $self, $field ) = @_;
2879 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2880 $self->ut_name($field);
2885 Check/untaint zip codes.
2889 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2892 my( $self, $field, $country ) = @_;
2894 if ( $country eq 'US' ) {
2896 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2897 or return gettext('illegal_zip'). " $field for country $country: ".
2898 $self->getfield($field);
2899 $self->setfield($field, $1);
2901 } elsif ( $country eq 'CA' ) {
2903 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2904 or return gettext('illegal_zip'). " $field for country $country: ".
2905 $self->getfield($field);
2906 $self->setfield($field, "$1 $2");
2908 } elsif ( $country eq 'AU' ) {
2910 $self->getfield($field) =~ /^\s*(\d{4})\s*$/
2911 or return gettext('illegal_zip'). " $field for country $country: ".
2912 $self->getfield($field);
2913 $self->setfield($field, $1);
2917 if ( $self->getfield($field) =~ /^\s*$/
2918 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2921 $self->setfield($field,'');
2923 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2924 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2925 $self->setfield($field,$1);
2933 =item ut_country COLUMN
2935 Check/untaint country codes. Country names are changed to codes, if possible -
2936 see L<Locale::Country>.
2941 my( $self, $field ) = @_;
2942 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2943 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2944 && country2code($1) ) {
2945 $self->setfield($field,uc(country2code($1)));
2948 $self->getfield($field) =~ /^(\w\w)$/
2949 or return "Illegal (country) $field: ". $self->getfield($field);
2950 $self->setfield($field,uc($1));
2954 =item ut_anything COLUMN
2956 Untaints arbitrary data. Be careful.
2961 my( $self, $field ) = @_;
2962 $self->getfield($field) =~ /^(.*)$/s
2963 or return "Illegal $field: ". $self->getfield($field);
2964 $self->setfield($field,$1);
2968 =item ut_enum COLUMN CHOICES_ARRAYREF
2970 Check/untaint a column, supplying all possible choices, like the "enum" type.
2975 my( $self, $field, $choices ) = @_;
2976 foreach my $choice ( @$choices ) {
2977 if ( $self->getfield($field) eq $choice ) {
2978 $self->setfield($field, $choice);
2982 return "Illegal (enum) field $field: ". $self->getfield($field);
2985 =item ut_enumn COLUMN CHOICES_ARRAYREF
2987 Like ut_enum, except the null value is also allowed.
2992 my( $self, $field, $choices ) = @_;
2993 $self->getfield($field)
2994 ? $self->ut_enum($field, $choices)
2998 =item ut_flag COLUMN
3000 Check/untaint a column if it contains either an empty string or 'Y'. This
3001 is the standard form for boolean flags in Freeside.
3006 my( $self, $field ) = @_;
3007 my $value = uc($self->getfield($field));
3008 if ( $value eq '' or $value eq 'Y' ) {
3009 $self->setfield($field, $value);
3012 return "Illegal (flag) field $field: $value";
3015 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3017 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3018 on the column first.
3022 sub ut_foreign_key {
3023 my( $self, $field, $table, $foreign ) = @_;
3024 return '' if $no_check_foreign;
3025 qsearchs($table, { $foreign => $self->getfield($field) })
3026 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3027 " in $table.$foreign";
3031 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3033 Like ut_foreign_key, except the null value is also allowed.
3037 sub ut_foreign_keyn {
3038 my( $self, $field, $table, $foreign ) = @_;
3039 $self->getfield($field)
3040 ? $self->ut_foreign_key($field, $table, $foreign)
3044 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3046 Checks this column as an agentnum, taking into account the current users's
3047 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3048 right or rights allowing no agentnum.
3052 sub ut_agentnum_acl {
3053 my( $self, $field ) = (shift, shift);
3054 my $null_acl = scalar(@_) ? shift : [];
3055 $null_acl = [ $null_acl ] unless ref($null_acl);
3057 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3058 return "Illegal agentnum: $error" if $error;
3060 my $curuser = $FS::CurrentUser::CurrentUser;
3062 if ( $self->$field() ) {
3064 return "Access denied"
3065 unless $curuser->agentnum($self->$field());
3069 return "Access denied"
3070 unless grep $curuser->access_right($_), @$null_acl;
3078 =item trim_whitespace FIELD[, FIELD ... ]
3080 Strip leading and trailing spaces from the value in the named FIELD(s).
3084 sub trim_whitespace {
3086 foreach my $field (@_) {
3087 my $value = $self->get($field);
3090 $self->set($field, $value);
3094 =item fields [ TABLE ]
3096 This is a wrapper for real_fields. Code that called
3097 fields before should probably continue to call fields.
3102 my $something = shift;
3104 if($something->isa('FS::Record')) {
3105 $table = $something->table;
3107 $table = $something;
3108 $something = "FS::$table";
3110 return (real_fields($table));
3114 =item encrypt($value)
3116 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3118 Returns the encrypted string.
3120 You should generally not have to worry about calling this, as the system handles this for you.
3125 my ($self, $value) = @_;
3126 my $encrypted = $value;
3128 if ($conf_encryption) {
3129 if ($self->is_encrypted($value)) {
3130 # Return the original value if it isn't plaintext.
3131 $encrypted = $value;
3134 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3135 # RSA doesn't like the empty string so let's pack it up
3136 # The database doesn't like the RSA data so uuencode it
3137 my $length = length($value)+1;
3138 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3140 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3147 =item is_encrypted($value)
3149 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3155 my ($self, $value) = @_;
3156 # Possible Bug - Some work may be required here....
3158 if ($value =~ /^M/ && length($value) > 80) {
3165 =item decrypt($value)
3167 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3169 You should generally not have to worry about calling this, as the system handles this for you.
3174 my ($self,$value) = @_;
3175 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3176 if ($conf_encryption && $self->is_encrypted($value)) {
3178 if (ref($rsa_decrypt) =~ /::RSA/) {
3179 my $encrypted = unpack ("u*", $value);
3180 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3181 if ($@) {warn "Decryption Failed"};
3189 #Initialize the Module
3190 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3192 if ($conf_encryptionmodule && $conf_encryptionmodule ne '') {
3193 $rsa_module = $conf_encryptionmodule;
3197 eval ("require $rsa_module"); # No need to import the namespace
3200 # Initialize Encryption
3201 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3202 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3205 # Intitalize Decryption
3206 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3207 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3211 =item h_search ACTION
3213 Given an ACTION, either "insert", or "delete", returns the appropriate history
3214 record corresponding to this record, if any.
3219 my( $self, $action ) = @_;
3221 my $table = $self->table;
3224 my $primary_key = dbdef->table($table)->primary_key;
3227 'table' => "h_$table",
3228 'hashref' => { $primary_key => $self->$primary_key(),
3229 'history_action' => $action,
3237 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3238 appropriate history record corresponding to this record, if any.
3243 my($self, $action) = @_;
3244 my $h = $self->h_search($action);
3245 $h ? $h->history_date : '';
3248 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3250 A class or object method. Executes the sql statement represented by SQL and
3251 returns a scalar representing the result: the first column of the first row.
3253 Dies on bogus SQL. Returns an empty string if no row is returned.
3255 Typically used for statments which return a single value such as "SELECT
3256 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3261 my($self, $sql) = (shift, shift);
3262 my $sth = dbh->prepare($sql) or die dbh->errstr;
3264 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3265 my $row = $sth->fetchrow_arrayref or return '';
3266 my $scalar = $row->[0];
3267 defined($scalar) ? $scalar : '';
3270 =item count [ WHERE [, PLACEHOLDER ...] ]
3272 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3273 with optional WHERE. Must be called as method on a class with an
3279 my($self, $where) = (shift, shift);
3280 my $table = $self->table or die 'count called on object of class '.ref($self);
3281 my $sql = "SELECT COUNT(*) FROM $table";
3282 $sql .= " WHERE $where" if $where;
3283 $self->scalar_sql($sql, @_);
3286 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3288 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3289 with optional (but almost always needed) WHERE.
3294 my($self, $where) = (shift, shift);
3295 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3296 my $sql = "SELECT 1 FROM $table";
3297 $sql .= " WHERE $where" if $where;
3299 $self->scalar_sql($sql, @_);
3308 =item real_fields [ TABLE ]
3310 Returns a list of the real columns in the specified table. Called only by
3311 fields() and other subroutines elsewhere in FS::Record.
3318 my($table_obj) = dbdef->table($table);
3319 confess "Unknown table $table" unless $table_obj;
3320 $table_obj->columns;
3323 =item pvf FIELD_NAME
3325 Returns the FS::part_virtual_field object corresponding to a field in the
3326 record (specified by FIELD_NAME).
3331 my ($self, $name) = (shift, shift);
3333 if(grep /^$name$/, $self->virtual_fields) {
3335 my $concat = [ "'cf_'", "name" ];
3336 return qsearchs({ table => 'part_virtual_field',
3337 hashref => { dbtable => $self->table,
3340 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3346 =item _quote VALUE, TABLE, COLUMN
3348 This is an internal function used to construct SQL statements. It returns
3349 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3350 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3355 my($value, $table, $column) = @_;
3356 my $column_obj = dbdef->table($table)->column($column);
3357 my $column_type = $column_obj->type;
3358 my $nullable = $column_obj->null;
3360 utf8::upgrade($value);
3362 warn " $table.$column: $value ($column_type".
3363 ( $nullable ? ' NULL' : ' NOT NULL' ).
3364 ")\n" if $DEBUG > 2;
3366 if ( $value eq '' && $nullable ) {
3368 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3369 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3372 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3373 ! $column_type =~ /(char|binary|text)$/i ) {
3375 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3376 && driver_name eq 'Pg'
3379 dbh->quote($value, { pg_type => PG_BYTEA() });
3387 This is deprecated. Don't use it.
3389 It returns a hash-type list with the fields of this record's table set true.
3394 carp "warning: hfields is deprecated";
3397 foreach (fields($table)) {
3406 "$_: ". $self->getfield($_). "|"
3407 } (fields($self->table)) );
3410 sub DESTROY { return; }
3414 # #use Carp qw(cluck);
3415 # #cluck "DESTROYING $self";
3416 # warn "DESTROYING $self";
3420 # return ! eval { join('',@_), kill 0; 1; };
3423 =item str2time_sql [ DRIVER_NAME ]
3425 Returns a function to convert to unix time based on database type, such as
3426 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3427 the str2time_sql_closing method to return a closing string rather than just
3428 using a closing parenthesis as previously suggested.
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.
3437 my $driver = shift || driver_name;
3439 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3440 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3442 warn "warning: unknown database type $driver; guessing how to convert ".
3443 "dates to UNIX timestamps";
3444 return 'EXTRACT(EPOCH FROM ';
3448 =item str2time_sql_closing [ DRIVER_NAME ]
3450 Returns the closing suffix of a function to convert to unix time based on
3451 database type, such as ")::integer" for Pg or ")" for mysql.
3453 You can pass an optional driver name such as "Pg", "mysql" or
3454 $dbh->{Driver}->{Name} to return a function for that database instead of
3455 the current database.
3459 sub str2time_sql_closing {
3460 my $driver = shift || driver_name;
3462 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3466 =item regexp_sql [ DRIVER_NAME ]
3468 Returns the operator to do a regular expression comparison based on database
3469 type, such as '~' for Pg or 'REGEXP' for mysql.
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 '~' if $driver =~ /^Pg/i;
3481 return 'REGEXP' if $driver =~ /^mysql/i;
3483 die "don't know how to use regular expressions in ". driver_name." databases";
3487 =item not_regexp_sql [ DRIVER_NAME ]
3489 Returns the operator to do a regular expression negation based on database
3490 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3492 You can pass an optional driver name such as "Pg", "mysql" or
3493 $dbh->{Driver}->{Name} to return a function for that database instead of
3494 the current database.
3498 sub not_regexp_sql {
3499 my $driver = shift || driver_name;
3501 return '!~' if $driver =~ /^Pg/i;
3502 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3504 die "don't know how to use regular expressions in ". driver_name." databases";
3508 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3510 Returns the items concatenated based on database type, using "CONCAT()" for
3511 mysql and " || " for Pg and other databases.
3513 You can pass an optional driver name such as "Pg", "mysql" or
3514 $dbh->{Driver}->{Name} to return a function for that database instead of
3515 the current database.
3520 my $driver = ref($_[0]) ? driver_name : shift;
3523 if ( $driver =~ /^mysql/i ) {
3524 'CONCAT('. join(',', @$items). ')';
3526 join('||', @$items);
3531 =item group_concat_sql COLUMN, DELIMITER
3533 Returns an SQL expression to concatenate an aggregate column, using
3534 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3538 sub group_concat_sql {
3539 my ($col, $delim) = @_;
3540 $delim = dbh->quote($delim);
3541 if ( driver_name() =~ /^mysql/i ) {
3542 # DISTINCT(foo) is valid as $col
3543 return "GROUP_CONCAT($col SEPARATOR $delim)";
3545 return "array_to_string(array_agg($col), $delim)";
3549 =item midnight_sql DATE
3551 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3552 on that day in the system timezone, using the default driver name.
3557 my $driver = driver_name;
3559 if ( $driver =~ /^mysql/i ) {
3560 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3563 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3571 This module should probably be renamed, since much of the functionality is
3572 of general use. It is not completely unlike Adapter::DBI (see below).
3574 Exported qsearch and qsearchs should be deprecated in favor of method calls
3575 (against an FS::Record object like the old search and searchs that qsearch
3576 and qsearchs were on top of.)
3578 The whole fields / hfields mess should be removed.
3580 The various WHERE clauses should be subroutined.
3582 table string should be deprecated in favor of DBIx::DBSchema::Table.
3584 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3585 true maps to the database (and WHERE clauses) would also help.
3587 The ut_ methods should ask the dbdef for a default length.
3589 ut_sqltype (like ut_varchar) should all be defined
3591 A fallback check method should be provided which uses the dbdef.
3593 The ut_money method assumes money has two decimal digits.
3595 The Pg money kludge in the new method only strips `$'.
3597 The ut_phonen method only checks US-style phone numbers.
3599 The _quote function should probably use ut_float instead of a regex.
3601 All the subroutines probably should be methods, here or elsewhere.
3603 Probably should borrow/use some dbdef methods where appropriate (like sub
3606 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3607 or allow it to be set. Working around it is ugly any way around - DBI should
3608 be fixed. (only affects RDBMS which return uppercase column names)
3610 ut_zip should take an optional country like ut_phone.
3614 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3616 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.