4 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
6 $conf $conf_encryption $money_char $lat_lower $lon_upper
8 $nowarn_identical $nowarn_classload
9 $no_update_diff $no_history $no_check_foreign
13 use Carp qw(carp cluck croak confess);
14 use Scalar::Util qw( blessed );
15 use File::CounterFile;
18 use File::Slurp qw( slurp );
19 use DBI qw(:sql_types);
20 use DBIx::DBSchema 0.38;
21 use FS::UID qw(dbh getotaker datasrc driver_name);
23 use FS::Schema qw(dbdef);
25 use FS::Msgcat qw(gettext);
26 use NetAddr::IP; # for validation
28 #use FS::Conf; #dependency loop bs, in install_callback below instead
30 use FS::part_virtual_field;
36 @encrypt_payby = qw( CARD DCRD CHEK DCHK );
38 #export dbdef for now... everything else expects to find it here
40 dbh fields hfields qsearch qsearchs dbdef jsearch
41 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql concat_sql
48 $nowarn_identical = 0;
49 $nowarn_classload = 0;
52 $no_check_foreign = 0;
60 $conf_encryption = '';
61 FS::UID->install_callback( sub {
65 $conf = FS::Conf->new;
66 $conf_encryption = $conf->exists('encryption');
67 $money_char = $conf->config('money_char') || '$';
68 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
69 $lat_lower = $nw_coords ? 1 : -90;
70 $lon_upper = $nw_coords ? -1 : 180;
72 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
74 if ( driver_name eq 'Pg' ) {
75 eval "use DBD::Pg ':pg_types'";
78 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
85 FS::Record - Database record objects
90 use FS::Record qw(dbh fields qsearch qsearchs);
92 $record = new FS::Record 'table', \%hash;
93 $record = new FS::Record 'table', { 'column' => 'value', ... };
95 $record = qsearchs FS::Record 'table', \%hash;
96 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
97 @records = qsearch FS::Record 'table', \%hash;
98 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
100 $table = $record->table;
101 $dbdef_table = $record->dbdef_table;
103 $value = $record->get('column');
104 $value = $record->getfield('column');
105 $value = $record->column;
107 $record->set( 'column' => 'value' );
108 $record->setfield( 'column' => 'value' );
109 $record->column('value');
111 %hash = $record->hash;
113 $hashref = $record->hashref;
115 $error = $record->insert;
117 $error = $record->delete;
119 $error = $new_record->replace($old_record);
121 # external use deprecated - handled by the database (at least for Pg, mysql)
122 $value = $record->unique('column');
124 $error = $record->ut_float('column');
125 $error = $record->ut_floatn('column');
126 $error = $record->ut_number('column');
127 $error = $record->ut_numbern('column');
128 $error = $record->ut_decimal('column');
129 $error = $record->ut_decimaln('column');
130 $error = $record->ut_snumber('column');
131 $error = $record->ut_snumbern('column');
132 $error = $record->ut_money('column');
133 $error = $record->ut_text('column');
134 $error = $record->ut_textn('column');
135 $error = $record->ut_alpha('column');
136 $error = $record->ut_alphan('column');
137 $error = $record->ut_phonen('column');
138 $error = $record->ut_anything('column');
139 $error = $record->ut_name('column');
141 $quoted_value = _quote($value,'table','field');
144 $fields = hfields('table');
145 if ( $fields->{Field} ) { # etc.
147 @fields = fields 'table'; #as a subroutine
148 @fields = $record->fields; #as a method call
153 (Mostly) object-oriented interface to database records. Records are currently
154 implemented on top of DBI. FS::Record is intended as a base class for
155 table-specific classes to inherit from, i.e. FS::cust_main.
161 =item new [ TABLE, ] HASHREF
163 Creates a new record. It doesn't store it in the database, though. See
164 L<"insert"> for that.
166 Note that the object stores this hash reference, not a distinct copy of the
167 hash it points to. You can ask the object for a copy with the I<hash>
170 TABLE can only be omitted when a dervived class overrides the table method.
176 my $class = ref($proto) || $proto;
178 bless ($self, $class);
180 unless ( defined ( $self->table ) ) {
181 $self->{'Table'} = shift;
182 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
183 unless $nowarn_classload;
186 $self->{'Hash'} = shift;
188 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
189 $self->{'Hash'}{$field}='';
192 $self->_rebless if $self->can('_rebless');
194 $self->{'modified'} = 0;
196 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
203 my $class = ref($proto) || $proto;
205 bless ($self, $class);
207 $self->{'Table'} = shift unless defined ( $self->table );
209 my $hashref = $self->{'Hash'} = shift;
211 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
212 my $obj = $cache->cache->{$hashref->{$cache->key}};
213 $obj->_cache($hashref, $cache) if $obj->can('_cache');
216 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
223 my $class = ref($proto) || $proto;
225 bless ($self, $class);
226 if ( defined $self->table ) {
227 cluck "create constructor is deprecated, use new!";
230 croak "FS::Record::create called (not from a subclass)!";
234 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
236 Searches the database for all records matching (at least) the key/value pairs
237 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
238 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
241 The preferred usage is to pass a hash reference of named parameters:
243 @records = qsearch( {
244 'table' => 'table_name',
245 'hashref' => { 'field' => 'value'
246 'field' => { 'op' => '<',
251 #these are optional...
253 'extra_sql' => 'AND field = ? AND intfield = ?',
254 'extra_param' => [ 'value', [ 5, 'int' ] ],
255 'order_by' => 'ORDER BY something',
256 #'cache_obj' => '', #optional
257 'addl_from' => 'LEFT JOIN othtable USING ( field )',
262 Much code still uses old-style positional parameters, this is also probably
263 fine in the common case where there are only two parameters:
265 my @records = qsearch( 'table', { 'field' => 'value' } );
267 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
268 the individual PARAMS_HASHREF queries
270 ###oops, argh, FS::Record::new only lets us create database fields.
271 #Normal behaviour if SELECT is not specified is `*', as in
272 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
273 #feature where you can specify SELECT - remember, the objects returned,
274 #although blessed into the appropriate `FS::TABLE' package, will only have the
275 #fields you specify. This might have unwanted results if you then go calling
276 #regular FS::TABLE methods
281 my %TYPE = (); #for debugging
284 my($type, $value) = @_;
286 my $bind_type = { TYPE => SQL_VARCHAR };
288 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
290 $bind_type = { TYPE => SQL_INTEGER };
292 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
294 if ( driver_name eq 'Pg' ) {
296 $bind_type = { pg_type => PG_BYTEA };
298 # $bind_type = ? #SQL_VARCHAR could be fine?
301 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
302 #fixed by DBD::Pg 2.11.8
303 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
304 #(make a Tron test first)
305 } elsif ( _is_fs_float( $type, $value ) ) {
307 $bind_type = { TYPE => SQL_DECIMAL };
316 my($type, $value) = @_;
317 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
318 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
326 my( @stable, @record, @cache );
327 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
329 my %union_options = ();
330 if ( ref($_[0]) eq 'ARRAY' ) {
333 foreach my $href ( @$optlist ) {
334 push @stable, ( $href->{'table'} or die "table name is required" );
335 push @record, ( $href->{'hashref'} || {} );
336 push @select, ( $href->{'select'} || '*' );
337 push @extra_sql, ( $href->{'extra_sql'} || '' );
338 push @extra_param, ( $href->{'extra_param'} || [] );
339 push @order_by, ( $href->{'order_by'} || '' );
340 push @cache, ( $href->{'cache_obj'} || '' );
341 push @addl_from, ( $href->{'addl_from'} || '' );
342 push @debug, ( $href->{'debug'} || '' );
344 die "at least one hashref is required" unless scalar(@stable);
345 } elsif ( ref($_[0]) eq 'HASH' ) {
347 $stable[0] = $opt->{'table'} or die "table name is required";
348 $record[0] = $opt->{'hashref'} || {};
349 $select[0] = $opt->{'select'} || '*';
350 $extra_sql[0] = $opt->{'extra_sql'} || '';
351 $extra_param[0] = $opt->{'extra_param'} || [];
352 $order_by[0] = $opt->{'order_by'} || '';
353 $cache[0] = $opt->{'cache_obj'} || '';
354 $addl_from[0] = $opt->{'addl_from'} || '';
355 $debug[0] = $opt->{'debug'} || '';
366 my $cache = $cache[0];
372 foreach my $stable ( @stable ) {
373 #stop altering the caller's hashref
374 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
375 my $select = shift @select;
376 my $extra_sql = shift @extra_sql;
377 my $extra_param = shift @extra_param;
378 my $order_by = shift @order_by;
379 my $cache = shift @cache;
380 my $addl_from = shift @addl_from;
381 my $debug = shift @debug;
383 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
385 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
388 my $table = $cache ? $cache->table : $stable;
389 my $dbdef_table = dbdef->table($table)
390 or die "No schema for table $table found - ".
391 "do you need to run freeside-upgrade?";
392 my $pkey = $dbdef_table->primary_key;
394 my @real_fields = grep exists($record->{$_}), real_fields($table);
396 my $statement .= "SELECT $select FROM $stable";
397 $statement .= " $addl_from" if $addl_from;
398 if ( @real_fields ) {
399 $statement .= ' WHERE '. join(' AND ',
400 get_real_fields($table, $record, \@real_fields));
403 $statement .= " $extra_sql" if defined($extra_sql);
404 $statement .= " $order_by" if defined($order_by);
406 push @statement, $statement;
408 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
412 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
415 my $value = $record->{$field};
416 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
417 $value = $value->{'value'} if ref($value);
418 my $type = dbdef->table($table)->column($field)->type;
420 my $bind_type = _bind_type($type, $value);
424 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
426 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
430 push @bind_type, $bind_type;
434 foreach my $param ( @$extra_param ) {
435 my $bind_type = { TYPE => SQL_VARCHAR };
438 $value = $param->[0];
439 my $type = $param->[1];
440 $bind_type = _bind_type($type, $value);
443 push @bind_type, $bind_type;
447 my $statement = join( ' ) UNION ( ', @statement );
448 $statement = "( $statement )" if scalar(@statement) > 1;
449 $statement .= " $union_options{order_by}" if $union_options{order_by};
451 my $sth = $dbh->prepare($statement)
452 or croak "$dbh->errstr doing $statement";
455 foreach my $value ( @value ) {
456 my $bind_type = shift @bind_type;
457 $sth->bind_param($bind++, $value, $bind_type );
460 # $sth->execute( map $record->{$_},
461 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
462 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
464 my $ok = $sth->execute;
466 my $error = "Error executing \"$statement\"";
467 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
468 $error .= ': '. $sth->errstr;
472 my $table = $stable[0];
474 $table = '' if grep { $_ ne $table } @stable;
475 $pkey = dbdef->table($table)->primary_key if $table;
478 tie %result, "Tie::IxHash";
479 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
480 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
481 %result = map { $_->{$pkey}, $_ } @stuff;
483 @result{@stuff} = @stuff;
489 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
490 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
491 #derivied class didn't override new method, so this optimization is safe
494 new_or_cached( "FS::$table", { %{$_} }, $cache )
498 new( "FS::$table", { %{$_} } )
502 #okay, its been tested
503 # warn "untested code (class FS::$table uses custom new method)";
505 eval 'FS::'. $table. '->new( { %{$_} } )';
509 # Check for encrypted fields and decrypt them.
510 ## only in the local copy, not the cached object
511 if ( $conf_encryption
512 && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
513 foreach my $record (@return) {
514 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
515 next if $field eq 'payinfo'
516 && ($record->isa('FS::payinfo_transaction_Mixin')
517 || $record->isa('FS::payinfo_Mixin') )
519 && !grep { $record->payby eq $_ } @encrypt_payby;
520 # Set it directly... This may cause a problem in the future...
521 $record->setfield($field, $record->decrypt($record->getfield($field)));
526 cluck "warning: FS::$table not loaded; returning FS::Record objects"
527 unless $nowarn_classload;
529 FS::Record->new( $table, { %{$_} } );
537 Construct the SQL statement and parameter-binding list for qsearch. Takes
538 the qsearch parameters.
540 Returns a hash containing:
541 'table': The primary table name (if there is one).
542 'statement': The SQL statement itself.
543 'bind_type': An arrayref of bind types.
544 'value': An arrayref of parameter values.
545 'cache': The cache object, if one was passed.
550 my( @stable, @record, @cache );
551 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
554 my %union_options = ();
555 if ( ref($_[0]) eq 'ARRAY' ) {
558 foreach my $href ( @$optlist ) {
559 push @stable, ( $href->{'table'} or die "table name is required" );
560 push @record, ( $href->{'hashref'} || {} );
561 push @select, ( $href->{'select'} || '*' );
562 push @extra_sql, ( $href->{'extra_sql'} || '' );
563 push @extra_param, ( $href->{'extra_param'} || [] );
564 push @order_by, ( $href->{'order_by'} || '' );
565 push @cache, ( $href->{'cache_obj'} || '' );
566 push @addl_from, ( $href->{'addl_from'} || '' );
567 push @debug, ( $href->{'debug'} || '' );
569 die "at least one hashref is required" unless scalar(@stable);
570 } elsif ( ref($_[0]) eq 'HASH' ) {
572 $stable[0] = $opt->{'table'} or die "table name is required";
573 $record[0] = $opt->{'hashref'} || {};
574 $select[0] = $opt->{'select'} || '*';
575 $extra_sql[0] = $opt->{'extra_sql'} || '';
576 $extra_param[0] = $opt->{'extra_param'} || [];
577 $order_by[0] = $opt->{'order_by'} || '';
578 $cache[0] = $opt->{'cache_obj'} || '';
579 $addl_from[0] = $opt->{'addl_from'} || '';
580 $debug[0] = $opt->{'debug'} || '';
591 my $cache = $cache[0];
597 my $result_table = $stable[0];
598 foreach my $stable ( @stable ) {
599 #stop altering the caller's hashref
600 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
601 my $select = shift @select;
602 my $extra_sql = shift @extra_sql;
603 my $extra_param = shift @extra_param;
604 my $order_by = shift @order_by;
605 my $cache = shift @cache;
606 my $addl_from = shift @addl_from;
607 my $debug = shift @debug;
609 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
611 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
614 $result_table = '' if $result_table ne $stable;
616 my $table = $cache ? $cache->table : $stable;
617 my $dbdef_table = dbdef->table($table)
618 or die "No schema for table $table found - ".
619 "do you need to run freeside-upgrade?";
620 my $pkey = $dbdef_table->primary_key;
622 my @real_fields = grep exists($record->{$_}), real_fields($table);
624 my $statement .= "SELECT $select FROM $stable";
625 $statement .= " $addl_from" if $addl_from;
626 if ( @real_fields ) {
627 $statement .= ' WHERE '. join(' AND ',
628 get_real_fields($table, $record, \@real_fields));
631 $statement .= " $extra_sql" if defined($extra_sql);
632 $statement .= " $order_by" if defined($order_by);
634 push @statement, $statement;
636 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
640 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
643 my $value = $record->{$field};
644 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
645 $value = $value->{'value'} if ref($value);
646 my $type = dbdef->table($table)->column($field)->type;
648 my $bind_type = _bind_type($type, $value);
652 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
654 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
658 push @bind_type, $bind_type;
662 foreach my $param ( @$extra_param ) {
663 my $bind_type = { TYPE => SQL_VARCHAR };
666 $value = $param->[0];
667 my $type = $param->[1];
668 $bind_type = _bind_type($type, $value);
671 push @bind_type, $bind_type;
675 my $statement = join( ' ) UNION ( ', @statement );
676 $statement = "( $statement )" if scalar(@statement) > 1;
677 $statement .= " $union_options{order_by}" if $union_options{order_by};
680 statement => $statement,
681 bind_type => \@bind_type,
683 table => $result_table,
688 # qsearch should eventually use this
690 my ($table, $cache, @hashrefs) = @_;
692 # XXX get rid of these string evals at some point
693 # (when we have time to test it)
694 # my $class = "FS::$table" if $table;
695 # if ( $class and $class->isa('FS::Record') )
696 # if ( $class->can('new') eq \&new )
698 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
699 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
700 #derivied class didn't override new method, so this optimization is safe
703 new_or_cached( "FS::$table", { %{$_} }, $cache )
707 new( "FS::$table", { %{$_} } )
711 #okay, its been tested
712 # warn "untested code (class FS::$table uses custom new method)";
714 eval 'FS::'. $table. '->new( { %{$_} } )';
718 # Check for encrypted fields and decrypt them.
719 ## only in the local copy, not the cached object
720 if ( $conf_encryption
721 && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
722 foreach my $record (@return) {
723 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
724 next if $field eq 'payinfo'
725 && ($record->isa('FS::payinfo_transaction_Mixin')
726 || $record->isa('FS::payinfo_Mixin') )
728 && !grep { $record->payby eq $_ } @encrypt_payby;
729 # Set it directly... This may cause a problem in the future...
730 $record->setfield($field, $record->decrypt($record->getfield($field)));
735 cluck "warning: FS::$table not loaded; returning FS::Record objects"
736 unless $nowarn_classload;
738 FS::Record->new( $table, { %{$_} } );
744 ## makes this easier to read
746 sub get_real_fields {
749 my $real_fields = shift;
751 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
757 my $type = dbdef->table($table)->column($column)->type;
758 my $value = $record->{$column};
759 $value = $value->{'value'} if ref($value);
760 if ( ref($record->{$_}) ) {
761 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
762 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
763 if ( uc($op) eq 'ILIKE' ) {
765 $record->{$_}{'value'} = lc($record->{$_}{'value'});
766 $column = "LOWER($_)";
768 $record->{$_} = $record->{$_}{'value'}
771 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
773 if ( driver_name eq 'Pg' ) {
774 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
775 qq-( $column IS NULL )-;
777 qq-( $column IS NULL OR $column = '' )-;
780 qq-( $column IS NULL OR $column = "" )-;
782 } elsif ( $op eq '!=' ) {
783 if ( driver_name eq 'Pg' ) {
784 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
785 qq-( $column IS NOT NULL )-;
787 qq-( $column IS NOT NULL AND $column != '' )-;
790 qq-( $column IS NOT NULL AND $column != "" )-;
793 if ( driver_name eq 'Pg' ) {
794 qq-( $column $op '' )-;
796 qq-( $column $op "" )-;
799 } elsif ( $op eq '!=' ) {
800 qq-( $column IS NULL OR $column != ? )-;
801 #if this needs to be re-enabled, it needs to use a custom op like
802 #"APPROX=" or something (better name?, not '=', to avoid affecting other
804 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
805 # ( "$column <= ?", "$column >= ?" );
809 } @{ $real_fields } );
812 =item by_key PRIMARY_KEY_VALUE
814 This is a class method that returns the record with the given primary key
815 value. This method is only useful in FS::Record subclasses. For example:
817 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
821 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
826 my ($class, $pkey_value) = @_;
828 my $table = $class->table
829 or croak "No table for $class found";
831 my $dbdef_table = dbdef->table($table)
832 or die "No schema for table $table found - ".
833 "do you need to create it or run dbdef-create?";
834 my $pkey = $dbdef_table->primary_key
835 or die "No primary key for table $table";
837 return qsearchs($table, { $pkey => $pkey_value });
840 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
842 Experimental JOINed search method. Using this method, you can execute a
843 single SELECT spanning multiple tables, and cache the results for subsequent
844 method calls. Interface will almost definately change in an incompatible
852 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
853 my $cache = FS::SearchCache->new( $ptable, $pkey );
856 grep { !$saw{$_->getfield($pkey)}++ }
857 qsearch($table, $record, $select, $extra_sql, $cache )
861 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
863 Same as qsearch, except that if more than one record matches, it B<carp>s but
864 returns the first. If this happens, you either made a logic error in asking
865 for a single item, or your data is corrupted.
869 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
871 my(@result) = qsearch(@_);
872 cluck "warning: Multiple records in scalar search ($table)"
873 if scalar(@result) > 1;
874 #should warn more vehemently if the search was on a primary key?
875 scalar(@result) ? ($result[0]) : ();
886 Returns the table name.
891 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
898 Returns the DBIx::DBSchema::Table object for the table.
904 my($table)=$self->table;
905 dbdef->table($table);
910 Returns the primary key for the table.
916 my $pkey = $self->dbdef_table->primary_key;
919 =item get, getfield COLUMN
921 Returns the value of the column/field/key COLUMN.
926 my($self,$field) = @_;
927 # to avoid "Use of unitialized value" errors
928 if ( defined ( $self->{Hash}->{$field} ) ) {
929 $self->{Hash}->{$field};
939 =item set, setfield COLUMN, VALUE
941 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
946 my($self,$field,$value) = @_;
947 $self->{'modified'} = 1;
948 $self->{'Hash'}->{$field} = $value;
957 Returns true if the column/field/key COLUMN exists.
962 my($self,$field) = @_;
963 exists($self->{Hash}->{$field});
966 =item AUTLOADED METHODS
968 $record->column is a synonym for $record->get('column');
970 $record->column('value') is a synonym for $record->set('column','value');
977 my($field)=$AUTOLOAD;
979 if ( defined($value) ) {
980 confess "errant AUTOLOAD $field for $self (arg $value)"
981 unless blessed($self) && $self->can('setfield');
982 $self->setfield($field,$value);
984 confess "errant AUTOLOAD $field for $self (no args)"
985 unless blessed($self) && $self->can('getfield');
986 $self->getfield($field);
992 # my $field = $AUTOLOAD;
994 # if ( defined($_[1]) ) {
995 # $_[0]->setfield($field, $_[1]);
997 # $_[0]->getfield($field);
1003 Returns a list of the column/value pairs, usually for assigning to a new hash.
1005 To make a distinct duplicate of an FS::Record object, you can do:
1007 $new = new FS::Record ( $old->table, { $old->hash } );
1013 confess $self. ' -> hash: Hash attribute is undefined'
1014 unless defined($self->{'Hash'});
1015 %{ $self->{'Hash'} };
1020 Returns a reference to the column/value hash. This may be deprecated in the
1021 future; if there's a reason you can't just use the autoloaded or get/set
1033 Returns true if any of this object's values have been modified with set (or via
1034 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1041 $self->{'modified'};
1044 =item select_for_update
1046 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1051 sub select_for_update {
1053 my $primary_key = $self->primary_key;
1056 'table' => $self->table,
1057 'hashref' => { $primary_key => $self->$primary_key() },
1058 'extra_sql' => 'FOR UPDATE',
1064 Locks this table with a database-driver specific lock method. This is used
1065 as a mutex in order to do a duplicate search.
1067 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1069 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1071 Errors are fatal; no useful return value.
1073 Note: To use this method for new tables other than svc_acct and svc_phone,
1074 edit freeside-upgrade and add those tables to the duplicate_lock list.
1080 my $table = $self->table;
1082 warn "$me locking $table table\n" if $DEBUG;
1084 if ( driver_name =~ /^Pg/i ) {
1086 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1089 } elsif ( driver_name =~ /^mysql/i ) {
1091 dbh->do("SELECT * FROM duplicate_lock
1092 WHERE lockname = '$table'
1094 ) or die dbh->errstr;
1098 die "unknown database ". driver_name. "; don't know how to lock table";
1102 warn "$me acquired $table table lock\n" if $DEBUG;
1108 Inserts this record to the database. If there is an error, returns the error,
1109 otherwise returns false.
1117 warn "$self -> insert" if $DEBUG;
1119 my $error = $self->check;
1120 return $error if $error;
1122 #single-field non-null unique keys are given a value if empty
1123 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1124 foreach ( $self->dbdef_table->unique_singles) {
1125 next if $self->getfield($_);
1126 next if $self->dbdef_table->column($_)->null eq 'NULL';
1130 #and also the primary key, if the database isn't going to
1131 my $primary_key = $self->dbdef_table->primary_key;
1133 if ( $primary_key ) {
1134 my $col = $self->dbdef_table->column($primary_key);
1137 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1138 || ( driver_name eq 'Pg'
1139 && defined($col->default)
1140 && $col->quoted_default =~ /^nextval\(/i
1142 || ( driver_name eq 'mysql'
1143 && defined($col->local)
1144 && $col->local =~ /AUTO_INCREMENT/i
1146 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1149 my $table = $self->table;
1151 # Encrypt before the database
1152 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
1153 && scalar( eval '@FS::'. $table . '::encrypted_fields')
1154 && $conf->exists('encryption')
1156 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1157 next if $field eq 'payinfo'
1158 && ($self->isa('FS::payinfo_transaction_Mixin')
1159 || $self->isa('FS::payinfo_Mixin') )
1161 && !grep { $self->payby eq $_ } @encrypt_payby;
1162 $saved->{$field} = $self->getfield($field);
1163 $self->setfield($field, $self->encrypt($self->getfield($field)));
1167 #false laziness w/delete
1169 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1172 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1175 my $statement = "INSERT INTO $table ";
1176 if ( @real_fields ) {
1179 join( ', ', @real_fields ).
1181 join( ', ', @values ).
1185 $statement .= 'DEFAULT VALUES';
1187 warn "[debug]$me $statement\n" if $DEBUG > 1;
1188 my $sth = dbh->prepare($statement) or return dbh->errstr;
1190 local $SIG{HUP} = 'IGNORE';
1191 local $SIG{INT} = 'IGNORE';
1192 local $SIG{QUIT} = 'IGNORE';
1193 local $SIG{TERM} = 'IGNORE';
1194 local $SIG{TSTP} = 'IGNORE';
1195 local $SIG{PIPE} = 'IGNORE';
1197 $sth->execute or return $sth->errstr;
1199 # get inserted id from the database, if applicable & needed
1200 if ( $db_seq && ! $self->getfield($primary_key) ) {
1201 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1205 if ( driver_name eq 'Pg' ) {
1207 #my $oid = $sth->{'pg_oid_status'};
1208 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1210 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1211 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1212 dbh->rollback if $FS::UID::AutoCommit;
1213 return "can't parse $table.$primary_key default value".
1214 " for sequence name: $default";
1218 my $i_sql = "SELECT currval('$sequence')";
1219 my $i_sth = dbh->prepare($i_sql) or do {
1220 dbh->rollback if $FS::UID::AutoCommit;
1223 $i_sth->execute() or do { #$i_sth->execute($oid)
1224 dbh->rollback if $FS::UID::AutoCommit;
1225 return $i_sth->errstr;
1227 $insertid = $i_sth->fetchrow_arrayref->[0];
1229 } elsif ( driver_name eq 'mysql' ) {
1231 $insertid = dbh->{'mysql_insertid'};
1232 # work around mysql_insertid being null some of the time, ala RT :/
1233 unless ( $insertid ) {
1234 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1235 "using SELECT LAST_INSERT_ID();";
1236 my $i_sql = "SELECT LAST_INSERT_ID()";
1237 my $i_sth = dbh->prepare($i_sql) or do {
1238 dbh->rollback if $FS::UID::AutoCommit;
1241 $i_sth->execute or do {
1242 dbh->rollback if $FS::UID::AutoCommit;
1243 return $i_sth->errstr;
1245 $insertid = $i_sth->fetchrow_arrayref->[0];
1250 dbh->rollback if $FS::UID::AutoCommit;
1251 return "don't know how to retreive inserted ids from ". driver_name.
1252 ", try using counterfiles (maybe run dbdef-create?)";
1256 $self->setfield($primary_key, $insertid);
1261 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1262 my $h_statement = $self->_h_statement('insert');
1263 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1264 $h_sth = dbh->prepare($h_statement) or do {
1265 dbh->rollback if $FS::UID::AutoCommit;
1271 $h_sth->execute or return $h_sth->errstr if $h_sth;
1273 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1275 # Now that it has been saved, reset the encrypted fields so that $new
1276 # can still be used.
1277 foreach my $field (keys %{$saved}) {
1278 $self->setfield($field, $saved->{$field});
1286 Depriciated (use insert instead).
1291 cluck "warning: FS::Record::add deprecated!";
1292 insert @_; #call method in this scope
1297 Delete this record from the database. If there is an error, returns the error,
1298 otherwise returns false.
1305 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1307 $self->getfield($_) eq ''
1308 #? "( $_ IS NULL OR $_ = \"\" )"
1309 ? ( driver_name eq 'Pg'
1311 : "( $_ IS NULL OR $_ = \"\" )"
1313 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1314 } ( $self->dbdef_table->primary_key )
1315 ? ( $self->dbdef_table->primary_key)
1316 : real_fields($self->table)
1318 warn "[debug]$me $statement\n" if $DEBUG > 1;
1319 my $sth = dbh->prepare($statement) or return dbh->errstr;
1322 if ( defined dbdef->table('h_'. $self->table) ) {
1323 my $h_statement = $self->_h_statement('delete');
1324 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1325 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1330 my $primary_key = $self->dbdef_table->primary_key;
1332 local $SIG{HUP} = 'IGNORE';
1333 local $SIG{INT} = 'IGNORE';
1334 local $SIG{QUIT} = 'IGNORE';
1335 local $SIG{TERM} = 'IGNORE';
1336 local $SIG{TSTP} = 'IGNORE';
1337 local $SIG{PIPE} = 'IGNORE';
1339 my $rc = $sth->execute or return $sth->errstr;
1340 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1341 $h_sth->execute or return $h_sth->errstr if $h_sth;
1343 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1345 #no need to needlessly destoy the data either (causes problems actually)
1346 #undef $self; #no need to keep object!
1353 Depriciated (use delete instead).
1358 cluck "warning: FS::Record::del deprecated!";
1359 &delete(@_); #call method in this scope
1362 =item replace OLD_RECORD
1364 Replace the OLD_RECORD with this one in the database. If there is an error,
1365 returns the error, otherwise returns false.
1370 my ($new, $old) = (shift, shift);
1372 $old = $new->replace_old unless defined($old);
1374 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1376 if ( $new->can('replace_check') ) {
1377 my $error = $new->replace_check($old);
1378 return $error if $error;
1381 return "Records not in same table!" unless $new->table eq $old->table;
1383 my $primary_key = $old->dbdef_table->primary_key;
1384 return "Can't change primary key $primary_key ".
1385 'from '. $old->getfield($primary_key).
1386 ' to ' . $new->getfield($primary_key)
1388 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1390 my $error = $new->check;
1391 return $error if $error;
1393 # Encrypt for replace
1395 if ( $conf->exists('encryption')
1396 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1397 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1399 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1400 next if $field eq 'payinfo'
1401 && ($new->isa('FS::payinfo_transaction_Mixin')
1402 || $new->isa('FS::payinfo_Mixin') )
1404 && !grep { $new->payby eq $_ } @encrypt_payby;
1405 $saved->{$field} = $new->getfield($field);
1406 $new->setfield($field, $new->encrypt($new->getfield($field)));
1410 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1411 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1412 ? ($_, $new->getfield($_)) : () } $old->fields;
1414 unless (keys(%diff) || $no_update_diff ) {
1415 carp "[warning]$me ". ref($new)."->replace ".
1416 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1417 ": records identical"
1418 unless $nowarn_identical;
1422 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1424 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1425 } real_fields($old->table)
1430 if ( $old->getfield($_) eq '' ) {
1432 #false laziness w/qsearch
1433 if ( driver_name eq 'Pg' ) {
1434 my $type = $old->dbdef_table->column($_)->type;
1435 if ( $type =~ /(int|(big)?serial)/i ) {
1438 qq-( $_ IS NULL OR $_ = '' )-;
1441 qq-( $_ IS NULL OR $_ = "" )-;
1445 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1448 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1451 warn "[debug]$me $statement\n" if $DEBUG > 1;
1452 my $sth = dbh->prepare($statement) or return dbh->errstr;
1455 if ( defined dbdef->table('h_'. $old->table) ) {
1456 my $h_old_statement = $old->_h_statement('replace_old');
1457 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1458 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1464 if ( defined dbdef->table('h_'. $new->table) ) {
1465 my $h_new_statement = $new->_h_statement('replace_new');
1466 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1467 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1472 local $SIG{HUP} = 'IGNORE';
1473 local $SIG{INT} = 'IGNORE';
1474 local $SIG{QUIT} = 'IGNORE';
1475 local $SIG{TERM} = 'IGNORE';
1476 local $SIG{TSTP} = 'IGNORE';
1477 local $SIG{PIPE} = 'IGNORE';
1479 my $rc = $sth->execute or return $sth->errstr;
1480 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1481 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1482 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1484 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1486 # Now that it has been saved, reset the encrypted fields so that $new
1487 # can still be used.
1488 foreach my $field (keys %{$saved}) {
1489 $new->setfield($field, $saved->{$field});
1497 my( $self ) = shift;
1498 warn "[$me] replace called with no arguments; autoloading old record\n"
1501 my $primary_key = $self->dbdef_table->primary_key;
1502 if ( $primary_key ) {
1503 $self->by_key( $self->$primary_key() ) #this is what's returned
1504 or croak "can't find ". $self->table. ".$primary_key ".
1505 $self->$primary_key();
1507 croak $self->table. " has no primary key; pass old record as argument";
1514 Depriciated (use replace instead).
1519 cluck "warning: FS::Record::rep deprecated!";
1520 replace @_; #call method in this scope
1525 Checks custom fields. Subclasses should still provide a check method to validate
1526 non-custom fields, foreign keys, etc., and call this method via $self->SUPER::check.
1532 foreach my $field ($self->virtual_fields) {
1533 my $error = $self->ut_textn($field);
1534 return $error if $error;
1539 =item virtual_fields [ TABLE ]
1541 Returns a list of virtual fields defined for the table. This should not
1542 be exported, and should only be called as an instance or class method.
1546 sub virtual_fields {
1549 $table = $self->table or confess "virtual_fields called on non-table";
1551 confess "Unknown table $table" unless dbdef->table($table);
1553 return () unless dbdef->table('part_virtual_field');
1555 unless ( $virtual_fields_cache{$table} ) {
1556 my $concat = [ "'cf_'", "name" ];
1557 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1558 "WHERE dbtable = '$table'";
1560 my $result = $dbh->selectcol_arrayref($query);
1561 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1563 $virtual_fields_cache{$table} = $result;
1566 @{$virtual_fields_cache{$table}};
1570 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1572 Processes a batch import as a queued JSRPC job
1574 JOB is an FS::queue entry.
1576 OPTIONS_HASHREF can have the following keys:
1582 Table name (required).
1586 Listref of field names for static fields. They will be given values from the
1587 PARAMS hashref and passed as a "params" hashref to batch_import.
1591 Formats hashref. Keys are field names, values are listrefs that define the
1594 Each listref value can be a column name or a code reference. Coderefs are run
1595 with the row object, data and a FS::Conf object as the three parameters.
1596 For example, this coderef does the same thing as using the "columnname" string:
1599 my( $record, $data, $conf ) = @_;
1600 $record->columnname( $data );
1603 Coderefs are run after all "column name" fields are assigned.
1607 Optional format hashref of types. Keys are field names, values are "csv",
1608 "xls" or "fixedlength". Overrides automatic determination of file type
1611 =item format_headers
1613 Optional format hashref of header lines. Keys are field names, values are 0
1614 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1617 =item format_sep_chars
1619 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1620 CSV separation character.
1622 =item format_fixedlenth_formats
1624 Optional format hashref of fixed length format defintiions. Keys are field
1625 names, values Parse::FixedLength listrefs of field definitions.
1629 Set true to default to CSV file type if the filename does not contain a
1630 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1635 PARAMS is a base64-encoded Storable string containing the POSTed data as
1636 a hash ref. It normally contains at least one field, "uploaded files",
1637 generated by /elements/file-upload.html and containing the list of uploaded
1638 files. Currently only supports a single file named "file".
1642 use Storable qw(thaw);
1645 sub process_batch_import {
1646 my($job, $opt) = ( shift, shift );
1648 my $table = $opt->{table};
1649 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1650 my %formats = %{ $opt->{formats} };
1652 my $param = thaw(decode_base64(shift));
1653 warn Dumper($param) if $DEBUG;
1655 my $files = $param->{'uploaded_files'}
1656 or die "No files provided.\n";
1658 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1660 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1661 my $file = $dir. $files{'file'};
1666 formats => \%formats,
1667 format_types => $opt->{format_types},
1668 format_headers => $opt->{format_headers},
1669 format_sep_chars => $opt->{format_sep_chars},
1670 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1671 format_xml_formats => $opt->{format_xml_formats},
1672 format_asn_formats => $opt->{format_asn_formats},
1673 format_row_callbacks => $opt->{format_row_callbacks},
1678 format => $param->{format},
1679 params => { map { $_ => $param->{$_} } @pass_params },
1681 default_csv => $opt->{default_csv},
1682 postinsert_callback => $opt->{postinsert_callback},
1685 if ( $opt->{'batch_namecol'} ) {
1686 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1687 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1690 my $error = FS::Record::batch_import( \%iopt );
1694 die "$error\n" if $error;
1697 =item batch_import PARAM_HASHREF
1699 Class method for batch imports. Available params:
1705 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1711 =item format_headers
1713 =item format_sep_chars
1715 =item format_fixedlength_formats
1717 =item format_row_callbacks
1719 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1721 =item preinsert_callback
1723 =item postinsert_callback
1729 FS::queue object, will be updated with progress
1735 csv, xls, fixedlength, xml
1746 warn "$me batch_import call with params: \n". Dumper($param)
1749 my $table = $param->{table};
1751 my $job = $param->{job};
1752 my $file = $param->{file};
1753 my $params = $param->{params} || {};
1755 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1756 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1758 my( $type, $header, $sep_char,
1759 $fixedlength_format, $xml_format, $asn_format,
1760 $parser_opt, $row_callback, @fields );
1762 my $postinsert_callback = '';
1763 $postinsert_callback = $param->{'postinsert_callback'}
1764 if $param->{'postinsert_callback'};
1765 my $preinsert_callback = '';
1766 $preinsert_callback = $param->{'preinsert_callback'}
1767 if $param->{'preinsert_callback'};
1769 if ( $param->{'format'} ) {
1771 my $format = $param->{'format'};
1772 my $formats = $param->{formats};
1773 die "unknown format $format" unless exists $formats->{ $format };
1775 $type = $param->{'format_types'}
1776 ? $param->{'format_types'}{ $format }
1777 : $param->{type} || 'csv';
1780 $header = $param->{'format_headers'}
1781 ? $param->{'format_headers'}{ $param->{'format'} }
1784 $sep_char = $param->{'format_sep_chars'}
1785 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1788 $fixedlength_format =
1789 $param->{'format_fixedlength_formats'}
1790 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1794 $param->{'format_parser_opts'}
1795 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1799 $param->{'format_xml_formats'}
1800 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1804 $param->{'format_asn_formats'}
1805 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1809 $param->{'format_row_callbacks'}
1810 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1813 @fields = @{ $formats->{ $format } };
1815 } elsif ( $param->{'fields'} ) {
1817 $type = ''; #infer from filename
1820 $fixedlength_format = '';
1822 @fields = @{ $param->{'fields'} };
1825 die "neither format nor fields specified";
1828 #my $file = $param->{file};
1831 if ( $file =~ /\.(\w+)$/i ) {
1835 warn "can't parse file type from filename $file; defaulting to CSV";
1839 if $param->{'default_csv'} && $type ne 'xls';
1847 my $asn_header_buffer;
1848 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1850 if ( $type eq 'csv' ) {
1852 $parser_opt->{'binary'} = 1;
1853 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
1854 $parser = Text::CSV_XS->new($parser_opt);
1856 } elsif ( $type eq 'fixedlength' ) {
1858 eval "use Parse::FixedLength;";
1860 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
1863 die "Unknown file type $type\n";
1866 @buffer = split(/\r?\n/, slurp($file) );
1867 splice(@buffer, 0, ($header || 0) );
1868 $count = scalar(@buffer);
1870 } elsif ( $type eq 'xls' ) {
1872 eval "use Spreadsheet::ParseExcel;";
1875 eval "use DateTime::Format::Excel;";
1876 #for now, just let the error be thrown if it is used, since only CDR
1877 # formats bill_west and troop use it, not other excel-parsing things
1880 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1882 $parser = $excel->{Worksheet}[0]; #first sheet
1884 $count = $parser->{MaxRow} || $parser->{MinRow};
1887 $row = $header || 0;
1889 } elsif ( $type eq 'xml' ) {
1892 eval "use XML::Simple;";
1894 my $xmlrow = $xml_format->{'xmlrow'};
1895 $parser = $xml_format->{'xmlkeys'};
1896 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1897 my $data = XML::Simple::XMLin(
1899 'SuppressEmpty' => '', #sets empty values to ''
1903 $rows = $rows->{$_} foreach @$xmlrow;
1904 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1905 $count = @buffer = @$rows;
1907 } elsif ( $type eq 'asn.1' ) {
1909 eval "use Convert::ASN1";
1912 my $asn = Convert::ASN1->new;
1913 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
1915 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
1917 my $data = slurp($file);
1918 my $asn_output = $parser->decode( $data )
1919 or return "No ". $asn_format->{'macro'}. " found\n";
1921 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
1923 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
1924 $count = @buffer = @$rows;
1927 die "Unknown file type $type\n";
1932 local $SIG{HUP} = 'IGNORE';
1933 local $SIG{INT} = 'IGNORE';
1934 local $SIG{QUIT} = 'IGNORE';
1935 local $SIG{TERM} = 'IGNORE';
1936 local $SIG{TSTP} = 'IGNORE';
1937 local $SIG{PIPE} = 'IGNORE';
1939 my $oldAutoCommit = $FS::UID::AutoCommit;
1940 local $FS::UID::AutoCommit = 0;
1943 #my $params = $param->{params} || {};
1944 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1945 my $batch_col = $param->{'batch_keycol'};
1947 my $batch_class = 'FS::'. $param->{'batch_table'};
1948 my $batch = $batch_class->new({
1949 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1951 my $error = $batch->insert;
1953 $dbh->rollback if $oldAutoCommit;
1954 return "can't insert batch record: $error";
1956 #primary key via dbdef? (so the column names don't have to match)
1957 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1959 $params->{ $batch_col } = $batch_value;
1962 #my $job = $param->{job};
1965 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1969 my %hash = %$params;
1970 if ( $type eq 'csv' ) {
1972 last unless scalar(@buffer);
1973 $line = shift(@buffer);
1975 next if $line =~ /^\s*$/; #skip empty lines
1977 $line = &{$row_callback}($line) if $row_callback;
1979 next if $line =~ /^\s*$/; #skip empty lines
1981 $parser->parse($line) or do {
1982 $dbh->rollback if $oldAutoCommit;
1983 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
1985 @columns = $parser->fields();
1987 } elsif ( $type eq 'fixedlength' ) {
1989 last unless scalar(@buffer);
1990 $line = shift(@buffer);
1992 @columns = $parser->parse($line);
1994 } elsif ( $type eq 'xls' ) {
1996 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1997 || ! $parser->{Cells}[$row];
1999 my @row = @{ $parser->{Cells}[$row] };
2000 @columns = map $_->{Val}, @row;
2003 #warn $z++. ": $_\n" for @columns;
2005 } elsif ( $type eq 'xml' ) {
2007 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2008 last unless scalar(@buffer);
2009 my $row = shift @buffer;
2010 @columns = @{ $row }{ @$parser };
2012 } elsif ( $type eq 'asn.1' ) {
2014 last unless scalar(@buffer);
2015 my $row = shift @buffer;
2016 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2017 if $asn_format->{row_callback};
2018 foreach my $key ( keys %{ $asn_format->{map} } ) {
2019 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2023 die "Unknown file type $type\n";
2028 foreach my $field ( @fields ) {
2030 my $value = shift @columns;
2032 if ( ref($field) eq 'CODE' ) {
2033 #&{$field}(\%hash, $value);
2034 push @later, $field, $value;
2036 #??? $hash{$field} = $value if length($value);
2037 $hash{$field} = $value if defined($value) && length($value);
2042 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2043 && length($1) == $custnum_length ) {
2044 $hash{custnum} = $2;
2047 #my $table = $param->{table};
2048 my $class = "FS::$table";
2050 my $record = $class->new( \%hash );
2053 while ( scalar(@later) ) {
2054 my $sub = shift @later;
2055 my $data = shift @later;
2057 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2060 $dbh->rollback if $oldAutoCommit;
2061 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2063 last if exists( $param->{skiprow} );
2065 next if exists( $param->{skiprow} );
2067 if ( $preinsert_callback ) {
2068 my $error = &{$preinsert_callback}($record, $param);
2070 $dbh->rollback if $oldAutoCommit;
2071 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2074 next if exists $param->{skiprow} && $param->{skiprow};
2077 my $error = $record->insert;
2080 $dbh->rollback if $oldAutoCommit;
2081 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2087 if ( $postinsert_callback ) {
2088 my $error = &{$postinsert_callback}($record, $param);
2090 $dbh->rollback if $oldAutoCommit;
2091 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2096 if ( $job && time - $min_sec > $last ) { #progress bar
2097 $job->update_statustext( int(100 * $imported / $count) );
2103 unless ( $imported || $param->{empty_ok} ) {
2104 $dbh->rollback if $oldAutoCommit;
2105 return "Empty file!";
2108 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2115 my( $self, $action, $time ) = @_;
2119 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2122 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2123 real_fields($self->table);
2126 # If we're encrypting then don't store the payinfo in the history
2127 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
2128 @fields = grep { $_ ne 'payinfo' } @fields;
2131 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2133 "INSERT INTO h_". $self->table. " ( ".
2134 join(', ', qw(history_date history_user history_action), @fields ).
2136 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
2143 B<Warning>: External use is B<deprecated>.
2145 Replaces COLUMN in record with a unique number, using counters in the
2146 filesystem. Used by the B<insert> method on single-field unique columns
2147 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2148 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2150 Returns the new value.
2155 my($self,$field) = @_;
2156 my($table)=$self->table;
2158 croak "Unique called on field $field, but it is ",
2159 $self->getfield($field),
2161 if $self->getfield($field);
2163 #warn "table $table is tainted" if is_tainted($table);
2164 #warn "field $field is tainted" if is_tainted($field);
2166 my($counter) = new File::CounterFile "$table.$field",0;
2168 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
2170 # my($counter) = new File::CounterFile "$user/$table.$field",0;
2173 my $index = $counter->inc;
2174 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2176 $index =~ /^(\d*)$/;
2179 $self->setfield($field,$index);
2183 =item ut_float COLUMN
2185 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2186 null. If there is an error, returns the error, otherwise returns false.
2191 my($self,$field)=@_ ;
2192 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2193 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2194 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2195 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2196 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2197 $self->setfield($field,$1);
2200 =item ut_floatn COLUMN
2202 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2203 null. If there is an error, returns the error, otherwise returns false.
2207 #false laziness w/ut_ipn
2209 my( $self, $field ) = @_;
2210 if ( $self->getfield($field) =~ /^()$/ ) {
2211 $self->setfield($field,'');
2214 $self->ut_float($field);
2218 =item ut_sfloat COLUMN
2220 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2221 May not be null. If there is an error, returns the error, otherwise returns
2227 my($self,$field)=@_ ;
2228 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2229 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2230 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2231 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2232 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2233 $self->setfield($field,$1);
2236 =item ut_sfloatn COLUMN
2238 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2239 null. If there is an error, returns the error, otherwise returns false.
2244 my( $self, $field ) = @_;
2245 if ( $self->getfield($field) =~ /^()$/ ) {
2246 $self->setfield($field,'');
2249 $self->ut_sfloat($field);
2253 =item ut_snumber COLUMN
2255 Check/untaint signed numeric data (whole numbers). If there is an error,
2256 returns the error, otherwise returns false.
2261 my($self, $field) = @_;
2262 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2263 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2264 $self->setfield($field, "$1$2");
2268 =item ut_snumbern COLUMN
2270 Check/untaint signed numeric data (whole numbers). If there is an error,
2271 returns the error, otherwise returns false.
2276 my($self, $field) = @_;
2277 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2278 or return "Illegal (numeric) $field: ". $self->getfield($field);
2280 return "Illegal (numeric) $field: ". $self->getfield($field)
2283 $self->setfield($field, "$1$2");
2287 =item ut_number COLUMN
2289 Check/untaint simple numeric data (whole numbers). May not be null. If there
2290 is an error, returns the error, otherwise returns false.
2295 my($self,$field)=@_;
2296 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2297 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2298 $self->setfield($field,$1);
2302 =item ut_numbern COLUMN
2304 Check/untaint simple numeric data (whole numbers). May be null. If there is
2305 an error, returns the error, otherwise returns false.
2310 my($self,$field)=@_;
2311 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2312 or return "Illegal (numeric) $field: ". $self->getfield($field);
2313 $self->setfield($field,$1);
2317 =item ut_decimal COLUMN[, DIGITS]
2319 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2320 error, returns the error, otherwise returns false.
2322 =item ut_decimaln COLUMN[, DIGITS]
2324 Check/untaint decimal numbers. May be null. If there is an error, returns
2325 the error, otherwise returns false.
2330 my($self, $field, $digits) = @_;
2332 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2333 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2334 $self->setfield($field, $1);
2339 my($self, $field, $digits) = @_;
2340 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2341 or return "Illegal (decimal) $field: ".$self->getfield($field);
2342 $self->setfield($field, $1);
2346 =item ut_money COLUMN
2348 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2349 is an error, returns the error, otherwise returns false.
2354 my($self,$field)=@_;
2356 if ( $self->getfield($field) eq '' ) {
2357 $self->setfield($field, 0);
2358 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2359 #handle one decimal place without barfing out
2360 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2361 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2362 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2364 return "Illegal (money) $field: ". $self->getfield($field);
2370 =item ut_moneyn COLUMN
2372 Check/untaint monetary numbers. May be negative. If there
2373 is an error, returns the error, otherwise returns false.
2378 my($self,$field)=@_;
2379 if ($self->getfield($field) eq '') {
2380 $self->setfield($field, '');
2383 $self->ut_money($field);
2386 =item ut_text COLUMN
2388 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2389 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2390 May not be null. If there is an error, returns the error, otherwise returns
2396 my($self,$field)=@_;
2397 #warn "msgcat ". \&msgcat. "\n";
2398 #warn "notexist ". \¬exist. "\n";
2399 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2400 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2401 # see perldoc perluniprops
2402 $self->getfield($field)
2403 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2404 or return gettext('illegal_or_empty_text'). " $field: ".
2405 $self->getfield($field);
2406 $self->setfield($field,$1);
2410 =item ut_textn COLUMN
2412 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2413 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2414 May be null. If there is an error, returns the error, otherwise returns false.
2419 my($self,$field)=@_;
2420 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2421 $self->ut_text($field);
2424 =item ut_alpha COLUMN
2426 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2427 an error, returns the error, otherwise returns false.
2432 my($self,$field)=@_;
2433 $self->getfield($field) =~ /^(\w+)$/
2434 or return "Illegal or empty (alphanumeric) $field: ".
2435 $self->getfield($field);
2436 $self->setfield($field,$1);
2440 =item ut_alphan COLUMN
2442 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2443 error, returns the error, otherwise returns false.
2448 my($self,$field)=@_;
2449 $self->getfield($field) =~ /^(\w*)$/
2450 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2451 $self->setfield($field,$1);
2455 =item ut_alphasn COLUMN
2457 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2458 an error, returns the error, otherwise returns false.
2463 my($self,$field)=@_;
2464 $self->getfield($field) =~ /^([\w ]*)$/
2465 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2466 $self->setfield($field,$1);
2471 =item ut_alpha_lower COLUMN
2473 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2474 there is an error, returns the error, otherwise returns false.
2478 sub ut_alpha_lower {
2479 my($self,$field)=@_;
2480 $self->getfield($field) =~ /[[:upper:]]/
2481 and return "Uppercase characters are not permitted in $field";
2482 $self->ut_alpha($field);
2485 =item ut_phonen COLUMN [ COUNTRY ]
2487 Check/untaint phone numbers. May be null. If there is an error, returns
2488 the error, otherwise returns false.
2490 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2491 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2496 my( $self, $field, $country ) = @_;
2497 return $self->ut_alphan($field) unless defined $country;
2498 my $phonen = $self->getfield($field);
2499 if ( $phonen eq '' ) {
2500 $self->setfield($field,'');
2501 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2503 $phonen = $conf->config('cust_main-default_areacode').$phonen
2504 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2505 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2506 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2507 $phonen = "$1-$2-$3";
2508 $phonen .= " x$4" if $4;
2509 $self->setfield($field,$phonen);
2511 warn "warning: don't know how to check phone numbers for country $country";
2512 return $self->ut_textn($field);
2519 Check/untaint hexadecimal values.
2524 my($self, $field) = @_;
2525 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2526 or return "Illegal (hex) $field: ". $self->getfield($field);
2527 $self->setfield($field, uc($1));
2531 =item ut_hexn COLUMN
2533 Check/untaint hexadecimal values. May be null.
2538 my($self, $field) = @_;
2539 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2540 or return "Illegal (hex) $field: ". $self->getfield($field);
2541 $self->setfield($field, uc($1));
2545 =item ut_mac_addr COLUMN
2547 Check/untaint mac addresses. May be null.
2552 my($self, $field) = @_;
2554 my $mac = $self->get($field);
2557 $self->set($field, $mac);
2559 my $e = $self->ut_hex($field);
2562 return "Illegal (mac address) $field: ". $self->getfield($field)
2563 unless length($self->getfield($field)) == 12;
2569 =item ut_mac_addrn COLUMN
2571 Check/untaint mac addresses. May be null.
2576 my($self, $field) = @_;
2577 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2582 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2588 my( $self, $field ) = @_;
2589 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2590 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2591 or return "Illegal (IP address) $field: ". $self->getfield($field);
2592 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2593 $self->setfield($field, "$1.$2.$3.$4");
2599 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2600 to 127.0.0.1. May be null.
2605 my( $self, $field ) = @_;
2606 if ( $self->getfield($field) =~ /^()$/ ) {
2607 $self->setfield($field,'');
2610 $self->ut_ip($field);
2614 =item ut_ip46 COLUMN
2616 Check/untaint IPv4 or IPv6 address.
2621 my( $self, $field ) = @_;
2622 my $ip = NetAddr::IP->new($self->getfield($field))
2623 or return "Illegal (IP address) $field: ".$self->getfield($field);
2624 $self->setfield($field, lc($ip->addr));
2630 Check/untaint IPv6 or IPv6 address. May be null.
2635 my( $self, $field ) = @_;
2636 if ( $self->getfield($field) =~ /^$/ ) {
2637 $self->setfield($field, '');
2640 $self->ut_ip46($field);
2643 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2645 Check/untaint coordinates.
2646 Accepts the following forms:
2656 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2657 The latter form (that is, the MMM are thousands of minutes) is
2658 assumed if the "MMM" is exactly three digits or two digits > 59.
2660 To be safe, just use the DDD.DDDDD form.
2662 If LOWER or UPPER are specified, then the coordinate is checked
2663 for lower and upper bounds, respectively.
2668 my ($self, $field) = (shift, shift);
2671 if ( $field =~ /latitude/ ) {
2672 $lower = $lat_lower;
2674 } elsif ( $field =~ /longitude/ ) {
2676 $upper = $lon_upper;
2679 my $coord = $self->getfield($field);
2680 my $neg = $coord =~ s/^(-)//;
2682 my ($d, $m, $s) = (0, 0, 0);
2685 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2686 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2687 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2689 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2692 return "Invalid (coordinate with minutes > 59) $field: "
2693 . $self->getfield($field);
2696 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2698 if (defined($lower) and ($coord < $lower)) {
2699 return "Invalid (coordinate < $lower) $field: "
2700 . $self->getfield($field);;
2703 if (defined($upper) and ($coord > $upper)) {
2704 return "Invalid (coordinate > $upper) $field: "
2705 . $self->getfield($field);;
2708 $self->setfield($field, $coord);
2712 return "Invalid (coordinate) $field: " . $self->getfield($field);
2716 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2718 Same as ut_coord, except optionally null.
2724 my ($self, $field) = (shift, shift);
2726 if ($self->getfield($field) =~ /^\s*$/) {
2729 return $self->ut_coord($field, @_);
2734 =item ut_domain COLUMN
2736 Check/untaint host and domain names. May not be null.
2741 my( $self, $field ) = @_;
2742 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2743 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2744 or return "Illegal (hostname) $field: ". $self->getfield($field);
2745 $self->setfield($field,$1);
2749 =item ut_domainn COLUMN
2751 Check/untaint host and domain names. May be null.
2756 my( $self, $field ) = @_;
2757 if ( $self->getfield($field) =~ /^()$/ ) {
2758 $self->setfield($field,'');
2761 $self->ut_domain($field);
2765 =item ut_name COLUMN
2767 Check/untaint proper names; allows alphanumerics, spaces and the following
2768 punctuation: , . - '
2775 my( $self, $field ) = @_;
2776 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2777 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
2778 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2783 $self->setfield($field, $name);
2787 =item ut_namen COLUMN
2789 Check/untaint proper names; allows alphanumerics, spaces and the following
2790 punctuation: , . - '
2797 my( $self, $field ) = @_;
2798 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2799 $self->ut_name($field);
2804 Check/untaint zip codes.
2808 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2811 my( $self, $field, $country ) = @_;
2813 if ( $country eq 'US' ) {
2815 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2816 or return gettext('illegal_zip'). " $field for country $country: ".
2817 $self->getfield($field);
2818 $self->setfield($field, $1);
2820 } elsif ( $country eq 'CA' ) {
2822 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2823 or return gettext('illegal_zip'). " $field for country $country: ".
2824 $self->getfield($field);
2825 $self->setfield($field, "$1 $2");
2829 if ( $self->getfield($field) =~ /^\s*$/
2830 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2833 $self->setfield($field,'');
2835 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2836 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2837 $self->setfield($field,$1);
2845 =item ut_country COLUMN
2847 Check/untaint country codes. Country names are changed to codes, if possible -
2848 see L<Locale::Country>.
2853 my( $self, $field ) = @_;
2854 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2855 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2856 && country2code($1) ) {
2857 $self->setfield($field,uc(country2code($1)));
2860 $self->getfield($field) =~ /^(\w\w)$/
2861 or return "Illegal (country) $field: ". $self->getfield($field);
2862 $self->setfield($field,uc($1));
2866 =item ut_anything COLUMN
2868 Untaints arbitrary data. Be careful.
2873 my( $self, $field ) = @_;
2874 $self->getfield($field) =~ /^(.*)$/s
2875 or return "Illegal $field: ". $self->getfield($field);
2876 $self->setfield($field,$1);
2880 =item ut_enum COLUMN CHOICES_ARRAYREF
2882 Check/untaint a column, supplying all possible choices, like the "enum" type.
2887 my( $self, $field, $choices ) = @_;
2888 foreach my $choice ( @$choices ) {
2889 if ( $self->getfield($field) eq $choice ) {
2890 $self->setfield($field, $choice);
2894 return "Illegal (enum) field $field: ". $self->getfield($field);
2897 =item ut_enumn COLUMN CHOICES_ARRAYREF
2899 Like ut_enum, except the null value is also allowed.
2904 my( $self, $field, $choices ) = @_;
2905 $self->getfield($field)
2906 ? $self->ut_enum($field, $choices)
2910 =item ut_flag COLUMN
2912 Check/untaint a column if it contains either an empty string or 'Y'. This
2913 is the standard form for boolean flags in Freeside.
2918 my( $self, $field ) = @_;
2919 my $value = uc($self->getfield($field));
2920 if ( $value eq '' or $value eq 'Y' ) {
2921 $self->setfield($field, $value);
2924 return "Illegal (flag) field $field: $value";
2927 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2929 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2930 on the column first.
2934 sub ut_foreign_key {
2935 my( $self, $field, $table, $foreign ) = @_;
2936 return '' if $no_check_foreign;
2937 qsearchs($table, { $foreign => $self->getfield($field) })
2938 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2939 " in $table.$foreign";
2943 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2945 Like ut_foreign_key, except the null value is also allowed.
2949 sub ut_foreign_keyn {
2950 my( $self, $field, $table, $foreign ) = @_;
2951 $self->getfield($field)
2952 ? $self->ut_foreign_key($field, $table, $foreign)
2956 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2958 Checks this column as an agentnum, taking into account the current users's
2959 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2960 right or rights allowing no agentnum.
2964 sub ut_agentnum_acl {
2965 my( $self, $field ) = (shift, shift);
2966 my $null_acl = scalar(@_) ? shift : [];
2967 $null_acl = [ $null_acl ] unless ref($null_acl);
2969 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2970 return "Illegal agentnum: $error" if $error;
2972 my $curuser = $FS::CurrentUser::CurrentUser;
2974 if ( $self->$field() ) {
2976 return "Access denied"
2977 unless $curuser->agentnum($self->$field());
2981 return "Access denied"
2982 unless grep $curuser->access_right($_), @$null_acl;
2990 =item fields [ TABLE ]
2992 This is a wrapper for real_fields. Code that called
2993 fields before should probably continue to call fields.
2998 my $something = shift;
3000 if($something->isa('FS::Record')) {
3001 $table = $something->table;
3003 $table = $something;
3004 $something = "FS::$table";
3006 return (real_fields($table));
3010 =item encrypt($value)
3012 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3014 Returns the encrypted string.
3016 You should generally not have to worry about calling this, as the system handles this for you.
3021 my ($self, $value) = @_;
3022 my $encrypted = $value;
3024 if ($conf->exists('encryption')) {
3025 if ($self->is_encrypted($value)) {
3026 # Return the original value if it isn't plaintext.
3027 $encrypted = $value;
3030 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3031 # RSA doesn't like the empty string so let's pack it up
3032 # The database doesn't like the RSA data so uuencode it
3033 my $length = length($value)+1;
3034 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3036 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3043 =item is_encrypted($value)
3045 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3051 my ($self, $value) = @_;
3052 # Possible Bug - Some work may be required here....
3054 if ($value =~ /^M/ && length($value) > 80) {
3061 =item decrypt($value)
3063 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3065 You should generally not have to worry about calling this, as the system handles this for you.
3070 my ($self,$value) = @_;
3071 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3072 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
3074 if (ref($rsa_decrypt) =~ /::RSA/) {
3075 my $encrypted = unpack ("u*", $value);
3076 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3077 if ($@) {warn "Decryption Failed"};
3085 #Initialize the Module
3086 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3088 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
3089 $rsa_module = $conf->config('encryptionmodule');
3093 eval ("require $rsa_module"); # No need to import the namespace
3096 # Initialize Encryption
3097 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
3098 my $public_key = join("\n",$conf->config('encryptionpublickey'));
3099 $rsa_encrypt = $rsa_module->new_public_key($public_key);
3102 # Intitalize Decryption
3103 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
3104 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
3105 $rsa_decrypt = $rsa_module->new_private_key($private_key);
3109 =item h_search ACTION
3111 Given an ACTION, either "insert", or "delete", returns the appropriate history
3112 record corresponding to this record, if any.
3117 my( $self, $action ) = @_;
3119 my $table = $self->table;
3122 my $primary_key = dbdef->table($table)->primary_key;
3125 'table' => "h_$table",
3126 'hashref' => { $primary_key => $self->$primary_key(),
3127 'history_action' => $action,
3135 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3136 appropriate history record corresponding to this record, if any.
3141 my($self, $action) = @_;
3142 my $h = $self->h_search($action);
3143 $h ? $h->history_date : '';
3146 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3148 A class or object method. Executes the sql statement represented by SQL and
3149 returns a scalar representing the result: the first column of the first row.
3151 Dies on bogus SQL. Returns an empty string if no row is returned.
3153 Typically used for statments which return a single value such as "SELECT
3154 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3159 my($self, $sql) = (shift, shift);
3160 my $sth = dbh->prepare($sql) or die dbh->errstr;
3162 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3163 my $row = $sth->fetchrow_arrayref or return '';
3164 my $scalar = $row->[0];
3165 defined($scalar) ? $scalar : '';
3168 =item count [ WHERE [, PLACEHOLDER ...] ]
3170 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3171 with optional WHERE. Must be called as method on a class with an
3177 my($self, $where) = (shift, shift);
3178 my $table = $self->table or die 'count called on object of class '.ref($self);
3179 my $sql = "SELECT COUNT(*) FROM $table";
3180 $sql .= " WHERE $where" if $where;
3181 $self->scalar_sql($sql, @_);
3190 =item real_fields [ TABLE ]
3192 Returns a list of the real columns in the specified table. Called only by
3193 fields() and other subroutines elsewhere in FS::Record.
3200 my($table_obj) = dbdef->table($table);
3201 confess "Unknown table $table" unless $table_obj;
3202 $table_obj->columns;
3205 =item pvf FIELD_NAME
3207 Returns the FS::part_virtual_field object corresponding to a field in the
3208 record (specified by FIELD_NAME).
3213 my ($self, $name) = (shift, shift);
3215 if(grep /^$name$/, $self->virtual_fields) {
3217 my $concat = [ "'cf_'", "name" ];
3218 return qsearchs({ table => 'part_virtual_field',
3219 hashref => { dbtable => $self->table,
3222 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3228 =item _quote VALUE, TABLE, COLUMN
3230 This is an internal function used to construct SQL statements. It returns
3231 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3232 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3237 my($value, $table, $column) = @_;
3238 my $column_obj = dbdef->table($table)->column($column);
3239 my $column_type = $column_obj->type;
3240 my $nullable = $column_obj->null;
3242 utf8::upgrade($value);
3244 warn " $table.$column: $value ($column_type".
3245 ( $nullable ? ' NULL' : ' NOT NULL' ).
3246 ")\n" if $DEBUG > 2;
3248 if ( $value eq '' && $nullable ) {
3250 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3251 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3254 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3255 ! $column_type =~ /(char|binary|text)$/i ) {
3257 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3258 && driver_name eq 'Pg'
3262 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3263 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3264 # single-quote the whole mess, and put an "E" in front.
3265 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3273 This is deprecated. Don't use it.
3275 It returns a hash-type list with the fields of this record's table set true.
3280 carp "warning: hfields is deprecated";
3283 foreach (fields($table)) {
3292 "$_: ". $self->getfield($_). "|"
3293 } (fields($self->table)) );
3296 sub DESTROY { return; }
3300 # #use Carp qw(cluck);
3301 # #cluck "DESTROYING $self";
3302 # warn "DESTROYING $self";
3306 # return ! eval { join('',@_), kill 0; 1; };
3309 =item str2time_sql [ DRIVER_NAME ]
3311 Returns a function to convert to unix time based on database type, such as
3312 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3313 the str2time_sql_closing method to return a closing string rather than just
3314 using a closing parenthesis as previously suggested.
3316 You can pass an optional driver name such as "Pg", "mysql" or
3317 $dbh->{Driver}->{Name} to return a function for that database instead of
3318 the current database.
3323 my $driver = shift || driver_name;
3325 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3326 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3328 warn "warning: unknown database type $driver; guessing how to convert ".
3329 "dates to UNIX timestamps";
3330 return 'EXTRACT(EPOCH FROM ';
3334 =item str2time_sql_closing [ DRIVER_NAME ]
3336 Returns the closing suffix of a function to convert to unix time based on
3337 database type, such as ")::integer" for Pg or ")" for mysql.
3339 You can pass an optional driver name such as "Pg", "mysql" or
3340 $dbh->{Driver}->{Name} to return a function for that database instead of
3341 the current database.
3345 sub str2time_sql_closing {
3346 my $driver = shift || driver_name;
3348 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3352 =item regexp_sql [ DRIVER_NAME ]
3354 Returns the operator to do a regular expression comparison based on database
3355 type, such as '~' for Pg or 'REGEXP' for mysql.
3357 You can pass an optional driver name such as "Pg", "mysql" or
3358 $dbh->{Driver}->{Name} to return a function for that database instead of
3359 the current database.
3364 my $driver = shift || driver_name;
3366 return '~' if $driver =~ /^Pg/i;
3367 return 'REGEXP' if $driver =~ /^mysql/i;
3369 die "don't know how to use regular expressions in ". driver_name." databases";
3373 =item not_regexp_sql [ DRIVER_NAME ]
3375 Returns the operator to do a regular expression negation based on database
3376 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3378 You can pass an optional driver name such as "Pg", "mysql" or
3379 $dbh->{Driver}->{Name} to return a function for that database instead of
3380 the current database.
3384 sub not_regexp_sql {
3385 my $driver = shift || driver_name;
3387 return '!~' if $driver =~ /^Pg/i;
3388 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3390 die "don't know how to use regular expressions in ". driver_name." databases";
3394 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3396 Returns the items concatenated based on database type, using "CONCAT()" for
3397 mysql and " || " for Pg and other databases.
3399 You can pass an optional driver name such as "Pg", "mysql" or
3400 $dbh->{Driver}->{Name} to return a function for that database instead of
3401 the current database.
3406 my $driver = ref($_[0]) ? driver_name : shift;
3409 if ( $driver =~ /^mysql/i ) {
3410 'CONCAT('. join(',', @$items). ')';
3412 join('||', @$items);
3417 =item midnight_sql DATE
3419 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3420 on that day in the system timezone, using the default driver name.
3425 my $driver = driver_name;
3427 if ( $driver =~ /^mysql/i ) {
3428 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3431 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3439 This module should probably be renamed, since much of the functionality is
3440 of general use. It is not completely unlike Adapter::DBI (see below).
3442 Exported qsearch and qsearchs should be deprecated in favor of method calls
3443 (against an FS::Record object like the old search and searchs that qsearch
3444 and qsearchs were on top of.)
3446 The whole fields / hfields mess should be removed.
3448 The various WHERE clauses should be subroutined.
3450 table string should be deprecated in favor of DBIx::DBSchema::Table.
3452 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3453 true maps to the database (and WHERE clauses) would also help.
3455 The ut_ methods should ask the dbdef for a default length.
3457 ut_sqltype (like ut_varchar) should all be defined
3459 A fallback check method should be provided which uses the dbdef.
3461 The ut_money method assumes money has two decimal digits.
3463 The Pg money kludge in the new method only strips `$'.
3465 The ut_phonen method only checks US-style phone numbers.
3467 The _quote function should probably use ut_float instead of a regex.
3469 All the subroutines probably should be methods, here or elsewhere.
3471 Probably should borrow/use some dbdef methods where appropriate (like sub
3474 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3475 or allow it to be set. Working around it is ugly any way around - DBI should
3476 be fixed. (only affects RDBMS which return uppercase column names)
3478 ut_zip should take an optional country like ut_phone.
3482 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3484 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.