2 use base qw( Exporter );
6 %virtual_fields_cache %fk_method_cache
7 $money_char $lat_lower $lon_upper
9 use Carp qw(carp cluck croak confess);
10 use Scalar::Util qw( blessed );
11 use File::Slurp qw( slurp );
12 use File::CounterFile;
14 use DBI qw(:sql_types);
15 use DBIx::DBSchema 0.43; #0.43 for foreign keys
18 use NetAddr::IP; # for validation
19 use FS::UID qw(dbh datasrc driver_name);
21 use FS::Schema qw(dbdef);
23 use FS::Msgcat qw(gettext);
24 #use FS::Conf; #dependency loop bs, in install_callback below instead
26 use FS::part_virtual_field;
30 our @encrypt_payby = qw( CARD DCRD CHEK DCHK );
32 #export dbdef for now... everything else expects to find it here
34 dbh fields hfields qsearch qsearchs dbdef jsearch
35 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql
36 concat_sql group_concat_sql
41 our $me = '[FS::Record]';
43 our $nowarn_identical = 0;
44 our $nowarn_classload = 0;
45 our $no_update_diff = 0;
48 our $qsearch_qualify_columns = 1;
50 our $no_check_foreign = 1; #well, not inefficiently in perl by default anymore
58 our $conf_encryption = '';
59 our $conf_encryptionmodule = '';
60 our $conf_encryptionpublickey = '';
61 our $conf_encryptionprivatekey = '';
62 FS::UID->install_callback( sub {
66 $conf = FS::Conf->new;
67 $conf_encryption = $conf->exists('encryption');
68 $conf_encryptionmodule = $conf->config('encryptionmodule');
69 $conf_encryptionpublickey = join("\n",$conf->config('encryptionpublickey'));
70 $conf_encryptionprivatekey = join("\n",$conf->config('encryptionprivatekey'));
71 $money_char = $conf->config('money_char') || '$';
72 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
73 $lat_lower = $nw_coords ? 1 : -90;
74 $lon_upper = $nw_coords ? -1 : 180;
76 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
78 if ( driver_name eq 'Pg' ) {
79 eval "use DBD::Pg ':pg_types'";
82 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
85 foreach my $table ( dbdef->tables ) {
86 $fk_method_cache{$table} = fk_methods($table);
93 FS::Record - Database record objects
98 use FS::Record qw(dbh fields qsearch qsearchs);
100 $record = new FS::Record 'table', \%hash;
101 $record = new FS::Record 'table', { 'column' => 'value', ... };
103 $record = qsearchs FS::Record 'table', \%hash;
104 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
105 @records = qsearch FS::Record 'table', \%hash;
106 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
108 $table = $record->table;
109 $dbdef_table = $record->dbdef_table;
111 $value = $record->get('column');
112 $value = $record->getfield('column');
113 $value = $record->column;
115 $record->set( 'column' => 'value' );
116 $record->setfield( 'column' => 'value' );
117 $record->column('value');
119 %hash = $record->hash;
121 $hashref = $record->hashref;
123 $error = $record->insert;
125 $error = $record->delete;
127 $error = $new_record->replace($old_record);
129 # external use deprecated - handled by the database (at least for Pg, mysql)
130 $value = $record->unique('column');
132 $error = $record->ut_float('column');
133 $error = $record->ut_floatn('column');
134 $error = $record->ut_number('column');
135 $error = $record->ut_numbern('column');
136 $error = $record->ut_decimal('column');
137 $error = $record->ut_decimaln('column');
138 $error = $record->ut_snumber('column');
139 $error = $record->ut_snumbern('column');
140 $error = $record->ut_money('column');
141 $error = $record->ut_text('column');
142 $error = $record->ut_textn('column');
143 $error = $record->ut_alpha('column');
144 $error = $record->ut_alphan('column');
145 $error = $record->ut_phonen('column');
146 $error = $record->ut_anything('column');
147 $error = $record->ut_name('column');
149 $quoted_value = _quote($value,'table','field');
152 $fields = hfields('table');
153 if ( $fields->{Field} ) { # etc.
155 @fields = fields 'table'; #as a subroutine
156 @fields = $record->fields; #as a method call
161 (Mostly) object-oriented interface to database records. Records are currently
162 implemented on top of DBI. FS::Record is intended as a base class for
163 table-specific classes to inherit from, i.e. FS::cust_main.
169 =item new [ TABLE, ] HASHREF
171 Creates a new record. It doesn't store it in the database, though. See
172 L<"insert"> for that.
174 Note that the object stores this hash reference, not a distinct copy of the
175 hash it points to. You can ask the object for a copy with the I<hash>
178 TABLE can only be omitted when a dervived class overrides the table method.
184 my $class = ref($proto) || $proto;
186 bless ($self, $class);
188 unless ( defined ( $self->table ) ) {
189 $self->{'Table'} = shift;
190 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
191 unless $nowarn_classload;
194 $self->{'Hash'} = shift;
196 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
197 $self->{'Hash'}{$field}='';
200 $self->_rebless if $self->can('_rebless');
202 $self->{'modified'} = 0;
204 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
211 my $class = ref($proto) || $proto;
213 bless ($self, $class);
215 $self->{'Table'} = shift unless defined ( $self->table );
217 my $hashref = $self->{'Hash'} = shift;
219 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
220 my $obj = $cache->cache->{$hashref->{$cache->key}};
221 $obj->_cache($hashref, $cache) if $obj->can('_cache');
224 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
231 my $class = ref($proto) || $proto;
233 bless ($self, $class);
234 if ( defined $self->table ) {
235 cluck "create constructor is deprecated, use new!";
238 croak "FS::Record::create called (not from a subclass)!";
242 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
244 Searches the database for all records matching (at least) the key/value pairs
245 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
246 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
249 The preferred usage is to pass a hash reference of named parameters:
251 @records = qsearch( {
252 'table' => 'table_name',
253 'hashref' => { 'field' => 'value'
254 'field' => { 'op' => '<',
259 #these are optional...
261 'extra_sql' => 'AND field = ? AND intfield = ?',
262 'extra_param' => [ 'value', [ 5, 'int' ] ],
263 'order_by' => 'ORDER BY something',
264 #'cache_obj' => '', #optional
265 'addl_from' => 'LEFT JOIN othtable USING ( field )',
270 Much code still uses old-style positional parameters, this is also probably
271 fine in the common case where there are only two parameters:
273 my @records = qsearch( 'table', { 'field' => 'value' } );
275 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
276 the individual PARAMS_HASHREF queries
278 ###oops, argh, FS::Record::new only lets us create database fields.
279 #Normal behaviour if SELECT is not specified is `*', as in
280 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
281 #feature where you can specify SELECT - remember, the objects returned,
282 #although blessed into the appropriate `FS::TABLE' package, will only have the
283 #fields you specify. This might have unwanted results if you then go calling
284 #regular FS::TABLE methods
289 my %TYPE = (); #for debugging
292 my($type, $value) = @_;
294 my $bind_type = { TYPE => SQL_VARCHAR };
296 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
298 $bind_type = { TYPE => SQL_INTEGER };
300 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
302 if ( driver_name eq 'Pg' ) {
304 $bind_type = { pg_type => PG_BYTEA };
306 # $bind_type = ? #SQL_VARCHAR could be fine?
309 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
310 #fixed by DBD::Pg 2.11.8
311 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
312 #(make a Tron test first)
313 } elsif ( _is_fs_float( $type, $value ) ) {
315 $bind_type = { TYPE => SQL_DECIMAL };
324 my($type, $value) = @_;
325 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
326 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
334 my( @stable, @record, @cache );
335 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
337 my %union_options = ();
338 if ( ref($_[0]) eq 'ARRAY' ) {
341 foreach my $href ( @$optlist ) {
342 push @stable, ( $href->{'table'} or die "table name is required" );
343 push @record, ( $href->{'hashref'} || {} );
344 push @select, ( $href->{'select'} || '*' );
345 push @extra_sql, ( $href->{'extra_sql'} || '' );
346 push @extra_param, ( $href->{'extra_param'} || [] );
347 push @order_by, ( $href->{'order_by'} || '' );
348 push @cache, ( $href->{'cache_obj'} || '' );
349 push @addl_from, ( $href->{'addl_from'} || '' );
350 push @debug, ( $href->{'debug'} || '' );
352 die "at least one hashref is required" unless scalar(@stable);
353 } elsif ( ref($_[0]) eq 'HASH' ) {
355 $stable[0] = $opt->{'table'} or die "table name is required";
356 $record[0] = $opt->{'hashref'} || {};
357 $select[0] = $opt->{'select'} || '*';
358 $extra_sql[0] = $opt->{'extra_sql'} || '';
359 $extra_param[0] = $opt->{'extra_param'} || [];
360 $order_by[0] = $opt->{'order_by'} || '';
361 $cache[0] = $opt->{'cache_obj'} || '';
362 $addl_from[0] = $opt->{'addl_from'} || '';
363 $debug[0] = $opt->{'debug'} || '';
374 my $cache = $cache[0];
380 foreach my $stable ( @stable ) {
382 carp '->qsearch on cust_main called' if $stable eq 'cust_main' && $DEBUG;
384 #stop altering the caller's hashref
385 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
386 my $select = shift @select;
387 my $extra_sql = shift @extra_sql;
388 my $extra_param = shift @extra_param;
389 my $order_by = shift @order_by;
390 my $cache = shift @cache;
391 my $addl_from = shift @addl_from;
392 my $debug = shift @debug;
394 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
396 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
399 my $table = $cache ? $cache->table : $stable;
400 my $dbdef_table = dbdef->table($table)
401 or die "No schema for table $table found - ".
402 "do you need to run freeside-upgrade?";
403 my $pkey = $dbdef_table->primary_key;
405 my @real_fields = grep exists($record->{$_}), real_fields($table);
407 my $statement .= "SELECT $select FROM $stable";
410 $statement .= " $addl_from";
411 # detect aliasing of the main table
412 if ( $addl_from =~ /^\s*AS\s+(\w+)/i ) {
416 if ( @real_fields ) {
417 $statement .= ' WHERE '. join(' AND ',
418 get_real_fields($table, $record, \@real_fields, $alias_main));
421 $statement .= " $extra_sql" if defined($extra_sql);
422 $statement .= " $order_by" if defined($order_by);
424 push @statement, $statement;
426 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
429 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
432 my $value = $record->{$field};
433 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
434 $value = $value->{'value'} if ref($value);
435 my $type = dbdef->table($table)->column($field)->type;
437 my $bind_type = _bind_type($type, $value);
441 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
443 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
447 push @bind_type, $bind_type;
451 foreach my $param ( @$extra_param ) {
452 my $bind_type = { TYPE => SQL_VARCHAR };
455 $value = $param->[0];
456 my $type = $param->[1];
457 $bind_type = _bind_type($type, $value);
460 push @bind_type, $bind_type;
464 my $statement = join( ' ) UNION ( ', @statement );
465 $statement = "( $statement )" if scalar(@statement) > 1;
466 $statement .= " $union_options{order_by}" if $union_options{order_by};
468 my $sth = $dbh->prepare($statement)
469 or croak "$dbh->errstr doing $statement";
472 foreach my $value ( @value ) {
473 my $bind_type = shift @bind_type;
474 $sth->bind_param($bind++, $value, $bind_type );
477 # $sth->execute( map $record->{$_},
478 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
479 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
481 my $ok = $sth->execute;
483 my $error = "Error executing \"$statement\"";
484 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
485 $error .= ': '. $sth->errstr;
489 my $table = $stable[0];
491 $table = '' if grep { $_ ne $table } @stable;
492 $pkey = dbdef->table($table)->primary_key if $table;
495 tie %result, "Tie::IxHash";
496 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
497 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
498 %result = map { $_->{$pkey}, $_ } @stuff;
500 @result{@stuff} = @stuff;
505 #below was refactored out to _from_hashref, this should use it at some point
508 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
509 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
510 #derivied class didn't override new method, so this optimization is safe
513 new_or_cached( "FS::$table", { %{$_} }, $cache )
517 new( "FS::$table", { %{$_} } )
521 #okay, its been tested
522 # warn "untested code (class FS::$table uses custom new method)";
524 eval 'FS::'. $table. '->new( { %{$_} } )';
528 # Check for encrypted fields and decrypt them.
529 ## only in the local copy, not the cached object
530 no warnings 'deprecated'; # XXX silence the warning for now
531 if ( $conf_encryption
532 && eval '@FS::'. $table . '::encrypted_fields' ) {
533 foreach my $record (@return) {
534 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
535 next if $field eq 'payinfo'
536 && ($record->isa('FS::payinfo_transaction_Mixin')
537 || $record->isa('FS::payinfo_Mixin') )
539 && !grep { $record->payby eq $_ } @encrypt_payby;
540 # Set it directly... This may cause a problem in the future...
541 $record->setfield($field, $record->decrypt($record->getfield($field)));
546 cluck "warning: FS::$table not loaded; returning FS::Record objects"
547 unless $nowarn_classload;
549 FS::Record->new( $table, { %{$_} } );
557 Construct the SQL statement and parameter-binding list for qsearch. Takes
558 the qsearch parameters.
560 Returns a hash containing:
561 'table': The primary table name (if there is one).
562 'statement': The SQL statement itself.
563 'bind_type': An arrayref of bind types.
564 'value': An arrayref of parameter values.
565 'cache': The cache object, if one was passed.
570 my( @stable, @record, @cache );
571 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
574 my %union_options = ();
575 if ( ref($_[0]) eq 'ARRAY' ) {
578 foreach my $href ( @$optlist ) {
579 push @stable, ( $href->{'table'} or die "table name is required" );
580 push @record, ( $href->{'hashref'} || {} );
581 push @select, ( $href->{'select'} || '*' );
582 push @extra_sql, ( $href->{'extra_sql'} || '' );
583 push @extra_param, ( $href->{'extra_param'} || [] );
584 push @order_by, ( $href->{'order_by'} || '' );
585 push @cache, ( $href->{'cache_obj'} || '' );
586 push @addl_from, ( $href->{'addl_from'} || '' );
587 push @debug, ( $href->{'debug'} || '' );
589 die "at least one hashref is required" unless scalar(@stable);
590 } elsif ( ref($_[0]) eq 'HASH' ) {
592 $stable[0] = $opt->{'table'} or die "table name is required";
593 $record[0] = $opt->{'hashref'} || {};
594 $select[0] = $opt->{'select'} || '*';
595 $extra_sql[0] = $opt->{'extra_sql'} || '';
596 $extra_param[0] = $opt->{'extra_param'} || [];
597 $order_by[0] = $opt->{'order_by'} || '';
598 $cache[0] = $opt->{'cache_obj'} || '';
599 $addl_from[0] = $opt->{'addl_from'} || '';
600 $debug[0] = $opt->{'debug'} || '';
611 my $cache = $cache[0];
617 my $result_table = $stable[0];
618 foreach my $stable ( @stable ) {
619 #stop altering the caller's hashref
620 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
621 my $select = shift @select;
622 my $extra_sql = shift @extra_sql;
623 my $extra_param = shift @extra_param;
624 my $order_by = shift @order_by;
625 my $cache = shift @cache;
626 my $addl_from = shift @addl_from;
627 my $debug = shift @debug;
629 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
631 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
634 $result_table = '' if $result_table ne $stable;
636 my $table = $cache ? $cache->table : $stable;
637 my $dbdef_table = dbdef->table($table)
638 or die "No schema for table $table found - ".
639 "do you need to run freeside-upgrade?";
640 my $pkey = $dbdef_table->primary_key;
642 my @real_fields = grep exists($record->{$_}), real_fields($table);
644 my $statement .= "SELECT $select FROM $stable";
645 $statement .= " $addl_from" if $addl_from;
646 if ( @real_fields ) {
647 $statement .= ' WHERE '. join(' AND ',
648 get_real_fields($table, $record, \@real_fields));
651 $statement .= " $extra_sql" if defined($extra_sql);
652 $statement .= " $order_by" if defined($order_by);
654 push @statement, $statement;
656 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
660 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
663 my $value = $record->{$field};
664 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
665 $value = $value->{'value'} if ref($value);
666 my $type = dbdef->table($table)->column($field)->type;
668 my $bind_type = _bind_type($type, $value);
672 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
674 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
678 push @bind_type, $bind_type;
682 foreach my $param ( @$extra_param ) {
683 my $bind_type = { TYPE => SQL_VARCHAR };
686 $value = $param->[0];
687 my $type = $param->[1];
688 $bind_type = _bind_type($type, $value);
691 push @bind_type, $bind_type;
695 my $statement = join( ' ) UNION ( ', @statement );
696 $statement = "( $statement )" if scalar(@statement) > 1;
697 $statement .= " $union_options{order_by}" if $union_options{order_by};
700 statement => $statement,
701 bind_type => \@bind_type,
703 table => $result_table,
708 # qsearch should eventually use this
710 my ($table, $cache, @hashrefs) = @_;
712 # XXX get rid of these string evals at some point
713 # (when we have time to test it)
714 # my $class = "FS::$table" if $table;
715 # if ( $class and $class->isa('FS::Record') )
716 # if ( $class->can('new') eq \&new )
718 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
719 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
720 #derivied class didn't override new method, so this optimization is safe
723 new_or_cached( "FS::$table", { %{$_} }, $cache )
727 new( "FS::$table", { %{$_} } )
731 #okay, its been tested
732 # warn "untested code (class FS::$table uses custom new method)";
734 eval 'FS::'. $table. '->new( { %{$_} } )';
738 # Check for encrypted fields and decrypt them.
739 ## only in the local copy, not the cached object
740 if ( $conf_encryption
741 && eval '@FS::'. $table . '::encrypted_fields' ) {
742 foreach my $record (@return) {
743 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
744 next if $field eq 'payinfo'
745 && ($record->isa('FS::payinfo_transaction_Mixin')
746 || $record->isa('FS::payinfo_Mixin') )
748 && !grep { $record->payby eq $_ } @encrypt_payby;
749 # Set it directly... This may cause a problem in the future...
750 $record->setfield($field, $record->decrypt($record->getfield($field)));
755 cluck "warning: FS::$table not loaded; returning FS::Record objects"
756 unless $nowarn_classload;
758 FS::Record->new( $table, { %{$_} } );
764 sub get_real_fields {
767 my $real_fields = shift;
768 my $alias_main = shift; # defaults to undef
769 $alias_main ||= $table;
771 ## could be optimized more for readability
777 my $table_column = $qsearch_qualify_columns ? "$alias_main.$column" : $column;
778 my $type = dbdef->table($table)->column($column)->type;
779 my $value = $record->{$column};
780 $value = $value->{'value'} if ref($value);
782 if ( ref($record->{$column}) ) {
783 $op = $record->{$column}{'op'} if $record->{$column}{'op'};
784 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
785 if ( uc($op) eq 'ILIKE' ) {
787 $record->{$column}{'value'} = lc($record->{$column}{'value'});
788 $table_column = "LOWER($table_column)";
790 $record->{$column} = $record->{$column}{'value'}
793 if ( ! defined( $record->{$column} ) || $record->{$column} eq '' ) {
795 if ( driver_name eq 'Pg' ) {
796 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
797 qq-( $table_column IS NULL )-;
799 qq-( $table_column IS NULL OR $table_column = '' )-;
802 qq-( $table_column IS NULL OR $table_column = "" )-;
804 } elsif ( $op eq '!=' ) {
805 if ( driver_name eq 'Pg' ) {
806 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
807 qq-( $table_column IS NOT NULL )-;
809 qq-( $table_column IS NOT NULL AND $table_column != '' )-;
812 qq-( $table_column IS NOT NULL AND $table_column != "" )-;
815 if ( driver_name eq 'Pg' ) {
816 qq-( $table_column $op '' )-;
818 qq-( $table_column $op "" )-;
821 } elsif ( $op eq '!=' ) {
822 qq-( $table_column IS NULL OR $table_column != ? )-;
823 #if this needs to be re-enabled, it needs to use a custom op like
824 #"APPROX=" or something (better name?, not '=', to avoid affecting other
826 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
827 # ( "$table_column <= ?", "$table_column >= ?" );
829 "$table_column $op ?";
836 =item by_key PRIMARY_KEY_VALUE
838 This is a class method that returns the record with the given primary key
839 value. This method is only useful in FS::Record subclasses. For example:
841 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
845 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
850 my ($class, $pkey_value) = @_;
852 my $table = $class->table
853 or croak "No table for $class found";
855 my $dbdef_table = dbdef->table($table)
856 or die "No schema for table $table found - ".
857 "do you need to create it or run dbdef-create?";
858 my $pkey = $dbdef_table->primary_key
859 or die "No primary key for table $table";
861 return qsearchs($table, { $pkey => $pkey_value });
864 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
866 Experimental JOINed search method. Using this method, you can execute a
867 single SELECT spanning multiple tables, and cache the results for subsequent
868 method calls. Interface will almost definately change in an incompatible
876 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
877 my $cache = FS::SearchCache->new( $ptable, $pkey );
880 grep { !$saw{$_->getfield($pkey)}++ }
881 qsearch($table, $record, $select, $extra_sql, $cache )
885 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
887 Same as qsearch, except that if more than one record matches, it B<carp>s but
888 returns the first. If this happens, you either made a logic error in asking
889 for a single item, or your data is corrupted.
893 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
895 my(@result) = qsearch(@_);
896 cluck "warning: Multiple records in scalar search ($table)"
897 #.join(' / ', map "$_=>".$_[1]->{$_}, keys %{ $_[1] } )
898 if scalar(@result) > 1;
899 #should warn more vehemently if the search was on a primary key?
900 scalar(@result) ? ($result[0]) : ();
911 Returns the table name.
916 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
923 Returns the DBIx::DBSchema::Table object for the table.
929 my($table)=$self->table;
930 dbdef->table($table);
935 Returns the primary key for the table.
941 my $pkey = $self->dbdef_table->primary_key;
944 =item get, getfield COLUMN
946 Returns the value of the column/field/key COLUMN.
951 my($self,$field) = @_;
952 # to avoid "Use of unitialized value" errors
953 if ( defined ( $self->{Hash}->{$field} ) ) {
954 $self->{Hash}->{$field};
964 =item set, setfield COLUMN, VALUE
966 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
971 my($self,$field,$value) = @_;
972 $self->{'modified'} = 1;
973 $self->{'Hash'}->{$field} = $value;
982 Returns true if the column/field/key COLUMN exists.
987 my($self,$field) = @_;
988 exists($self->{Hash}->{$field});
991 =item AUTLOADED METHODS
993 $record->column is a synonym for $record->get('column');
995 $record->column('value') is a synonym for $record->set('column','value');
997 $record->foreign_table_name calls qsearchs and returns a single
998 FS::foreign_table record (for tables referenced by a column of this table) or
999 qsearch and returns an array of FS::foreign_table records (for tables
1000 referenced by a column in the foreign table).
1006 my($self,$value)=@_;
1007 my($field)=$AUTOLOAD;
1010 confess "errant AUTOLOAD $field for $self (arg $value)"
1011 unless blessed($self) && $self->can('setfield');
1013 #$fk_method_cache{$self->table} ||= fk_methods($self->table);
1014 if ( exists($fk_method_cache{$self->table}->{$field}) ) {
1016 my $fk_info = $fk_method_cache{$self->table}->{$field};
1017 my $method = $fk_info->{method} || 'qsearchs';
1018 my $table = $fk_info->{table} || $field;
1019 my $column = $fk_info->{column};
1020 my $foreign_column = $fk_info->{references} || $column;
1022 eval "use FS::$table";
1025 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1027 my $pkey_value = $self->$column();
1028 my %search = ( $foreign_column => $pkey_value );
1030 # FS::Record->$method() ? they're actually just subs :/
1031 if ( $method eq 'qsearchs' ) {
1032 return $pkey_value ? qsearchs( $table, \%search ) : '';
1033 } elsif ( $method eq 'qsearch' ) {
1034 return $pkey_value ? qsearch( $table, \%search ) : ();
1036 die "unknown method $method";
1041 if ( defined($value) ) {
1042 $self->setfield($field,$value);
1044 $self->getfield($field);
1048 # efficient (also, old, doesn't support FK stuff)
1050 # my $field = $AUTOLOAD;
1051 # $field =~ s/.*://;
1052 # if ( defined($_[1]) ) {
1053 # $_[0]->setfield($field, $_[1]);
1055 # $_[0]->getfield($field);
1064 # foreign keys we reference in other tables
1065 foreach my $fk (dbdef->table($table)->foreign_keys) {
1068 if ( scalar( @{$fk->columns} ) == 1 ) {
1069 if ( ! defined($fk->references)
1070 || ! @{$fk->references}
1071 || $fk->columns->[0] eq $fk->references->[0]
1073 $method = $fk->table;
1075 #some sort of hint in the table.pm or schema for methods not named
1076 # after their foreign table (well, not a whole lot different than
1077 # just providing a small subroutine...)
1081 $hash{$method} = { #fk_info
1082 'method' => 'qsearchs',
1083 'column' => $fk->columns->[0],
1084 #'references' => $fk->references->[0],
1092 # foreign keys referenced in other tables to us
1093 # (alas. why we're cached. still, might this loop better be done once at
1094 # schema load time insetad of every time we AUTOLOAD a method on a new
1096 foreach my $f_table ( dbdef->tables ) {
1097 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1099 next unless $fk->table eq $table;
1102 if ( scalar( @{$fk->columns} ) == 1 ) {
1103 if ( ! defined($fk->references)
1104 || ! @{$fk->references}
1105 || $fk->columns->[0] eq $fk->references->[0]
1109 #some sort of hint in the table.pm or schema for methods not named
1110 # after their foreign table (well, not a whole lot different than
1111 # just providing a small subroutine...)
1115 $hash{$method} = { #fk_info
1116 'method' => 'qsearch',
1117 'column' => $fk->columns->[0], #references||column
1118 #'references' => $fk->column->[0],
1133 Returns a list of the column/value pairs, usually for assigning to a new hash.
1135 To make a distinct duplicate of an FS::Record object, you can do:
1137 $new = new FS::Record ( $old->table, { $old->hash } );
1143 confess $self. ' -> hash: Hash attribute is undefined'
1144 unless defined($self->{'Hash'});
1145 %{ $self->{'Hash'} };
1150 Returns a reference to the column/value hash. This may be deprecated in the
1151 future; if there's a reason you can't just use the autoloaded or get/set
1165 +{ ( map { $_=>$self->$_ } $self->fields ),
1170 my( $class, %opt ) = @_;
1171 my $table = $class->table;
1172 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1173 my $error = $self->insert;
1174 return +{ 'error' => $error } if $error;
1175 my $pkey = $self->pkey;
1176 return +{ 'error' => '',
1177 'primary_key' => $pkey,
1178 $pkey => $self->$pkey,
1184 Returns true if any of this object's values have been modified with set (or via
1185 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1192 $self->{'modified'};
1195 =item select_for_update
1197 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1202 sub select_for_update {
1204 my $primary_key = $self->primary_key;
1207 'table' => $self->table,
1208 'hashref' => { $primary_key => $self->$primary_key() },
1209 'extra_sql' => 'FOR UPDATE',
1215 Locks this table with a database-driver specific lock method. This is used
1216 as a mutex in order to do a duplicate search.
1218 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1220 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1222 Errors are fatal; no useful return value.
1224 Note: To use this method for new tables other than svc_acct and svc_phone,
1225 edit freeside-upgrade and add those tables to the duplicate_lock list.
1231 my $table = $self->table;
1233 warn "$me locking $table table\n" if $DEBUG;
1235 if ( driver_name =~ /^Pg/i ) {
1237 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1240 } elsif ( driver_name =~ /^mysql/i ) {
1242 dbh->do("SELECT * FROM duplicate_lock
1243 WHERE lockname = '$table'
1245 ) or die dbh->errstr;
1249 die "unknown database ". driver_name. "; don't know how to lock table";
1253 warn "$me acquired $table table lock\n" if $DEBUG;
1259 Inserts this record to the database. If there is an error, returns the error,
1260 otherwise returns false.
1268 warn "$self -> insert" if $DEBUG;
1270 my $error = $self->check;
1271 return $error if $error;
1273 #single-field non-null unique keys are given a value if empty
1274 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1275 foreach ( $self->dbdef_table->unique_singles) {
1276 next if $self->getfield($_);
1277 next if $self->dbdef_table->column($_)->null eq 'NULL';
1281 #and also the primary key, if the database isn't going to
1282 my $primary_key = $self->dbdef_table->primary_key;
1284 if ( $primary_key ) {
1285 my $col = $self->dbdef_table->column($primary_key);
1288 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1289 || ( driver_name eq 'Pg'
1290 && defined($col->default)
1291 && $col->quoted_default =~ /^nextval\(/i
1293 || ( driver_name eq 'mysql'
1294 && defined($col->local)
1295 && $col->local =~ /AUTO_INCREMENT/i
1297 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1300 my $table = $self->table;
1302 # Encrypt before the database
1303 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1306 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1307 next if $field eq 'payinfo'
1308 && ($self->isa('FS::payinfo_transaction_Mixin')
1309 || $self->isa('FS::payinfo_Mixin') )
1311 && !grep { $self->payby eq $_ } @encrypt_payby;
1312 $saved->{$field} = $self->getfield($field);
1313 $self->setfield($field, $self->encrypt($self->getfield($field)));
1317 #false laziness w/delete
1319 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1322 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1325 my $statement = "INSERT INTO $table ";
1326 if ( @real_fields ) {
1329 join( ', ', @real_fields ).
1331 join( ', ', @values ).
1335 $statement .= 'DEFAULT VALUES';
1337 warn "[debug]$me $statement\n" if $DEBUG > 1;
1338 my $sth = dbh->prepare($statement) or return dbh->errstr;
1340 local $SIG{HUP} = 'IGNORE';
1341 local $SIG{INT} = 'IGNORE';
1342 local $SIG{QUIT} = 'IGNORE';
1343 local $SIG{TERM} = 'IGNORE';
1344 local $SIG{TSTP} = 'IGNORE';
1345 local $SIG{PIPE} = 'IGNORE';
1347 $sth->execute or return $sth->errstr;
1349 # get inserted id from the database, if applicable & needed
1350 if ( $db_seq && ! $self->getfield($primary_key) ) {
1351 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1355 if ( driver_name eq 'Pg' ) {
1357 #my $oid = $sth->{'pg_oid_status'};
1358 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1360 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1361 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1362 dbh->rollback if $FS::UID::AutoCommit;
1363 return "can't parse $table.$primary_key default value".
1364 " for sequence name: $default";
1368 my $i_sql = "SELECT currval('$sequence')";
1369 my $i_sth = dbh->prepare($i_sql) or do {
1370 dbh->rollback if $FS::UID::AutoCommit;
1373 $i_sth->execute() or do { #$i_sth->execute($oid)
1374 dbh->rollback if $FS::UID::AutoCommit;
1375 return $i_sth->errstr;
1377 $insertid = $i_sth->fetchrow_arrayref->[0];
1379 } elsif ( driver_name eq 'mysql' ) {
1381 $insertid = dbh->{'mysql_insertid'};
1382 # work around mysql_insertid being null some of the time, ala RT :/
1383 unless ( $insertid ) {
1384 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1385 "using SELECT LAST_INSERT_ID();";
1386 my $i_sql = "SELECT LAST_INSERT_ID()";
1387 my $i_sth = dbh->prepare($i_sql) or do {
1388 dbh->rollback if $FS::UID::AutoCommit;
1391 $i_sth->execute or do {
1392 dbh->rollback if $FS::UID::AutoCommit;
1393 return $i_sth->errstr;
1395 $insertid = $i_sth->fetchrow_arrayref->[0];
1400 dbh->rollback if $FS::UID::AutoCommit;
1401 return "don't know how to retreive inserted ids from ". driver_name.
1402 ", try using counterfiles (maybe run dbdef-create?)";
1406 $self->setfield($primary_key, $insertid);
1411 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1412 my $h_statement = $self->_h_statement('insert');
1413 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1414 $h_sth = dbh->prepare($h_statement) or do {
1415 dbh->rollback if $FS::UID::AutoCommit;
1421 $h_sth->execute or return $h_sth->errstr if $h_sth;
1423 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1425 # Now that it has been saved, reset the encrypted fields so that $new
1426 # can still be used.
1427 foreach my $field (keys %{$saved}) {
1428 $self->setfield($field, $saved->{$field});
1436 Depriciated (use insert instead).
1441 cluck "warning: FS::Record::add deprecated!";
1442 insert @_; #call method in this scope
1447 Delete this record from the database. If there is an error, returns the error,
1448 otherwise returns false.
1455 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1457 $self->getfield($_) eq ''
1458 #? "( $_ IS NULL OR $_ = \"\" )"
1459 ? ( driver_name eq 'Pg'
1461 : "( $_ IS NULL OR $_ = \"\" )"
1463 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1464 } ( $self->dbdef_table->primary_key )
1465 ? ( $self->dbdef_table->primary_key)
1466 : real_fields($self->table)
1468 warn "[debug]$me $statement\n" if $DEBUG > 1;
1469 my $sth = dbh->prepare($statement) or return dbh->errstr;
1472 if ( defined dbdef->table('h_'. $self->table) ) {
1473 my $h_statement = $self->_h_statement('delete');
1474 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1475 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1480 my $primary_key = $self->dbdef_table->primary_key;
1482 local $SIG{HUP} = 'IGNORE';
1483 local $SIG{INT} = 'IGNORE';
1484 local $SIG{QUIT} = 'IGNORE';
1485 local $SIG{TERM} = 'IGNORE';
1486 local $SIG{TSTP} = 'IGNORE';
1487 local $SIG{PIPE} = 'IGNORE';
1489 my $rc = $sth->execute or return $sth->errstr;
1490 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1491 $h_sth->execute or return $h_sth->errstr if $h_sth;
1493 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1495 #no need to needlessly destoy the data either (causes problems actually)
1496 #undef $self; #no need to keep object!
1503 Depriciated (use delete instead).
1508 cluck "warning: FS::Record::del deprecated!";
1509 &delete(@_); #call method in this scope
1512 =item replace OLD_RECORD
1514 Replace the OLD_RECORD with this one in the database. If there is an error,
1515 returns the error, otherwise returns false.
1520 my ($new, $old) = (shift, shift);
1522 $old = $new->replace_old unless defined($old);
1524 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1526 if ( $new->can('replace_check') ) {
1527 my $error = $new->replace_check($old);
1528 return $error if $error;
1531 return "Records not in same table!" unless $new->table eq $old->table;
1533 my $primary_key = $old->dbdef_table->primary_key;
1534 return "Can't change primary key $primary_key ".
1535 'from '. $old->getfield($primary_key).
1536 ' to ' . $new->getfield($primary_key)
1538 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1540 my $error = $new->check;
1541 return $error if $error;
1543 # Encrypt for replace
1545 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1548 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1549 next if $field eq 'payinfo'
1550 && ($new->isa('FS::payinfo_transaction_Mixin')
1551 || $new->isa('FS::payinfo_Mixin') )
1553 && !grep { $new->payby eq $_ } @encrypt_payby;
1554 $saved->{$field} = $new->getfield($field);
1555 $new->setfield($field, $new->encrypt($new->getfield($field)));
1559 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1560 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1561 ? ($_, $new->getfield($_)) : () } $old->fields;
1563 unless (keys(%diff) || $no_update_diff ) {
1564 carp "[warning]$me ". ref($new)."->replace ".
1565 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1566 ": records identical"
1567 unless $nowarn_identical;
1571 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1573 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1574 } real_fields($old->table)
1579 if ( $old->getfield($_) eq '' ) {
1581 #false laziness w/qsearch
1582 if ( driver_name eq 'Pg' ) {
1583 my $type = $old->dbdef_table->column($_)->type;
1584 if ( $type =~ /(int|(big)?serial)/i ) {
1587 qq-( $_ IS NULL OR $_ = '' )-;
1590 qq-( $_ IS NULL OR $_ = "" )-;
1594 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1597 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1600 warn "[debug]$me $statement\n" if $DEBUG > 1;
1601 my $sth = dbh->prepare($statement) or return dbh->errstr;
1604 if ( defined dbdef->table('h_'. $old->table) ) {
1605 my $h_old_statement = $old->_h_statement('replace_old');
1606 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1607 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1613 if ( defined dbdef->table('h_'. $new->table) ) {
1614 my $h_new_statement = $new->_h_statement('replace_new');
1615 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1616 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1621 local $SIG{HUP} = 'IGNORE';
1622 local $SIG{INT} = 'IGNORE';
1623 local $SIG{QUIT} = 'IGNORE';
1624 local $SIG{TERM} = 'IGNORE';
1625 local $SIG{TSTP} = 'IGNORE';
1626 local $SIG{PIPE} = 'IGNORE';
1628 my $rc = $sth->execute or return $sth->errstr;
1629 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1630 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1631 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1633 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1635 # Now that it has been saved, reset the encrypted fields so that $new
1636 # can still be used.
1637 foreach my $field (keys %{$saved}) {
1638 $new->setfield($field, $saved->{$field});
1646 my( $self ) = shift;
1647 warn "[$me] replace called with no arguments; autoloading old record\n"
1650 my $primary_key = $self->dbdef_table->primary_key;
1651 if ( $primary_key ) {
1652 $self->by_key( $self->$primary_key() ) #this is what's returned
1653 or croak "can't find ". $self->table. ".$primary_key ".
1654 $self->$primary_key();
1656 croak $self->table. " has no primary key; pass old record as argument";
1663 Depriciated (use replace instead).
1668 cluck "warning: FS::Record::rep deprecated!";
1669 replace @_; #call method in this scope
1674 Checks custom fields. Subclasses should still provide a check method to validate
1675 non-custom fields, etc., and call this method via $self->SUPER::check.
1681 foreach my $field ($self->virtual_fields) {
1682 my $error = $self->ut_textn($field);
1683 return $error if $error;
1688 =item virtual_fields [ TABLE ]
1690 Returns a list of virtual fields defined for the table. This should not
1691 be exported, and should only be called as an instance or class method.
1695 sub virtual_fields {
1698 $table = $self->table or confess "virtual_fields called on non-table";
1700 confess "Unknown table $table" unless dbdef->table($table);
1702 return () unless dbdef->table('part_virtual_field');
1704 unless ( $virtual_fields_cache{$table} ) {
1705 my $concat = [ "'cf_'", "name" ];
1706 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1707 "WHERE dbtable = '$table'";
1709 my $result = $dbh->selectcol_arrayref($query);
1710 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1712 $virtual_fields_cache{$table} = $result;
1715 @{$virtual_fields_cache{$table}};
1719 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1721 Processes a batch import as a queued JSRPC job
1723 JOB is an FS::queue entry.
1725 OPTIONS_HASHREF can have the following keys:
1731 Table name (required).
1735 Arrayref of field names for static fields. They will be given values from the
1736 PARAMS hashref and passed as a "params" hashref to batch_import.
1740 Formats hashref. Keys are field names, values are listrefs that define the
1743 Each listref value can be a column name or a code reference. Coderefs are run
1744 with the row object, data and a FS::Conf object as the three parameters.
1745 For example, this coderef does the same thing as using the "columnname" string:
1748 my( $record, $data, $conf ) = @_;
1749 $record->columnname( $data );
1752 Coderefs are run after all "column name" fields are assigned.
1756 Optional format hashref of types. Keys are field names, values are "csv",
1757 "xls" or "fixedlength". Overrides automatic determination of file type
1760 =item format_headers
1762 Optional format hashref of header lines. Keys are field names, values are 0
1763 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1766 =item format_sep_chars
1768 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1769 CSV separation character.
1771 =item format_fixedlenth_formats
1773 Optional format hashref of fixed length format defintiions. Keys are field
1774 names, values Parse::FixedLength listrefs of field definitions.
1778 Set true to default to CSV file type if the filename does not contain a
1779 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1784 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1785 POSTed data. It must contain the field "uploaded files", generated by
1786 /elements/file-upload.html and containing the list of uploaded files.
1787 Currently only supports a single file named "file".
1792 sub process_batch_import {
1793 my($job, $opt, $param) = @_;
1795 my $table = $opt->{table};
1796 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1797 my %formats = %{ $opt->{formats} };
1799 warn Dumper($param) if $DEBUG;
1801 my $files = $param->{'uploaded_files'}
1802 or die "No files provided.\n";
1804 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1806 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1807 my $file = $dir. $files{'file'};
1812 formats => \%formats,
1813 format_types => $opt->{format_types},
1814 format_headers => $opt->{format_headers},
1815 format_sep_chars => $opt->{format_sep_chars},
1816 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1817 format_xml_formats => $opt->{format_xml_formats},
1818 format_asn_formats => $opt->{format_asn_formats},
1819 format_row_callbacks => $opt->{format_row_callbacks},
1820 format_hash_callbacks => $opt->{format_hash_callbacks},
1825 format => $param->{format},
1826 params => { map { $_ => $param->{$_} } @pass_params },
1828 default_csv => $opt->{default_csv},
1829 preinsert_callback => $opt->{preinsert_callback},
1830 postinsert_callback => $opt->{postinsert_callback},
1831 insert_args_callback => $opt->{insert_args_callback},
1834 if ( $opt->{'batch_namecol'} ) {
1835 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1836 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1839 my $error = FS::Record::batch_import( \%iopt );
1843 die "$error\n" if $error;
1846 =item batch_import PARAM_HASHREF
1848 Class method for batch imports. Available params:
1854 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1860 =item format_headers
1862 =item format_sep_chars
1864 =item format_fixedlength_formats
1866 =item format_row_callbacks
1868 =item format_hash_callbacks - After parsing, before object creation
1870 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1872 =item preinsert_callback
1874 =item postinsert_callback
1880 FS::queue object, will be updated with progress
1886 csv, xls, fixedlength, xml
1898 warn "$me batch_import call with params: \n". Dumper($param)
1901 my $table = $param->{table};
1903 my $job = $param->{job};
1904 my $file = $param->{file};
1905 my $params = $param->{params} || {};
1907 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1908 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1910 my( $type, $header, $sep_char,
1911 $fixedlength_format, $xml_format, $asn_format,
1912 $parser_opt, $row_callback, $hash_callback, @fields );
1914 my $postinsert_callback = '';
1915 $postinsert_callback = $param->{'postinsert_callback'}
1916 if $param->{'postinsert_callback'};
1917 my $preinsert_callback = '';
1918 $preinsert_callback = $param->{'preinsert_callback'}
1919 if $param->{'preinsert_callback'};
1920 my $insert_args_callback = '';
1921 $insert_args_callback = $param->{'insert_args_callback'}
1922 if $param->{'insert_args_callback'};
1924 if ( $param->{'format'} ) {
1926 my $format = $param->{'format'};
1927 my $formats = $param->{formats};
1928 die "unknown format $format" unless exists $formats->{ $format };
1930 $type = $param->{'format_types'}
1931 ? $param->{'format_types'}{ $format }
1932 : $param->{type} || 'csv';
1935 $header = $param->{'format_headers'}
1936 ? $param->{'format_headers'}{ $param->{'format'} }
1939 $sep_char = $param->{'format_sep_chars'}
1940 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1943 $fixedlength_format =
1944 $param->{'format_fixedlength_formats'}
1945 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1949 $param->{'format_parser_opts'}
1950 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1954 $param->{'format_xml_formats'}
1955 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1959 $param->{'format_asn_formats'}
1960 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1964 $param->{'format_row_callbacks'}
1965 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1969 $param->{'format_hash_callbacks'}
1970 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
1973 @fields = @{ $formats->{ $format } };
1975 } elsif ( $param->{'fields'} ) {
1977 $type = ''; #infer from filename
1980 $fixedlength_format = '';
1982 $hash_callback = '';
1983 @fields = @{ $param->{'fields'} };
1986 die "neither format nor fields specified";
1989 #my $file = $param->{file};
1992 if ( $file =~ /\.(\w+)$/i ) {
1996 warn "can't parse file type from filename $file; defaulting to CSV";
2000 if $param->{'default_csv'} && $type ne 'xls';
2008 my $asn_header_buffer;
2009 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2011 if ( $type eq 'csv' ) {
2013 $parser_opt->{'binary'} = 1;
2014 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2015 $parser = Text::CSV_XS->new($parser_opt);
2017 } elsif ( $type eq 'fixedlength' ) {
2019 eval "use Parse::FixedLength;";
2021 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2024 die "Unknown file type $type\n";
2027 @buffer = split(/\r?\n/, slurp($file) );
2028 splice(@buffer, 0, ($header || 0) );
2029 $count = scalar(@buffer);
2031 } elsif ( $type eq 'xls' ) {
2033 eval "use Spreadsheet::ParseExcel;";
2036 eval "use DateTime::Format::Excel;";
2037 #for now, just let the error be thrown if it is used, since only CDR
2038 # formats bill_west and troop use it, not other excel-parsing things
2041 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2043 $parser = $excel->{Worksheet}[0]; #first sheet
2045 $count = $parser->{MaxRow} || $parser->{MinRow};
2048 $row = $header || 0;
2050 } elsif ( $type eq 'xml' ) {
2053 eval "use XML::Simple;";
2055 my $xmlrow = $xml_format->{'xmlrow'};
2056 $parser = $xml_format->{'xmlkeys'};
2057 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2058 my $data = XML::Simple::XMLin(
2060 'SuppressEmpty' => '', #sets empty values to ''
2064 $rows = $rows->{$_} foreach @$xmlrow;
2065 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2066 $count = @buffer = @$rows;
2068 } elsif ( $type eq 'asn.1' ) {
2070 eval "use Convert::ASN1";
2073 my $asn = Convert::ASN1->new;
2074 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2076 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2078 my $data = slurp($file);
2079 my $asn_output = $parser->decode( $data )
2080 or return "No ". $asn_format->{'macro'}. " found\n";
2082 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2084 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2085 $count = @buffer = @$rows;
2088 die "Unknown file type $type\n";
2093 local $SIG{HUP} = 'IGNORE';
2094 local $SIG{INT} = 'IGNORE';
2095 local $SIG{QUIT} = 'IGNORE';
2096 local $SIG{TERM} = 'IGNORE';
2097 local $SIG{TSTP} = 'IGNORE';
2098 local $SIG{PIPE} = 'IGNORE';
2100 my $oldAutoCommit = $FS::UID::AutoCommit;
2101 local $FS::UID::AutoCommit = 0;
2104 #my $params = $param->{params} || {};
2105 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2106 my $batch_col = $param->{'batch_keycol'};
2108 my $batch_class = 'FS::'. $param->{'batch_table'};
2109 my $batch = $batch_class->new({
2110 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2112 my $error = $batch->insert;
2114 $dbh->rollback if $oldAutoCommit;
2115 return "can't insert batch record: $error";
2117 #primary key via dbdef? (so the column names don't have to match)
2118 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2120 $params->{ $batch_col } = $batch_value;
2123 #my $job = $param->{job};
2126 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2130 my %hash = %$params;
2131 if ( $type eq 'csv' ) {
2133 last unless scalar(@buffer);
2134 $line = shift(@buffer);
2136 next if $line =~ /^\s*$/; #skip empty lines
2138 $line = &{$row_callback}($line) if $row_callback;
2140 next if $line =~ /^\s*$/; #skip empty lines
2142 $parser->parse($line) or do {
2143 $dbh->rollback if $oldAutoCommit;
2144 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2146 @columns = $parser->fields();
2148 } elsif ( $type eq 'fixedlength' ) {
2150 last unless scalar(@buffer);
2151 $line = shift(@buffer);
2153 @columns = $parser->parse($line);
2155 } elsif ( $type eq 'xls' ) {
2157 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2158 || ! $parser->{Cells}[$row];
2160 my @row = @{ $parser->{Cells}[$row] };
2161 @columns = map $_->{Val}, @row;
2164 #warn $z++. ": $_\n" for @columns;
2166 } elsif ( $type eq 'xml' ) {
2168 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2169 last unless scalar(@buffer);
2170 my $row = shift @buffer;
2171 @columns = @{ $row }{ @$parser };
2173 } elsif ( $type eq 'asn.1' ) {
2175 last unless scalar(@buffer);
2176 my $row = shift @buffer;
2177 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2178 if $asn_format->{row_callback};
2179 foreach my $key ( keys %{ $asn_format->{map} } ) {
2180 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2184 die "Unknown file type $type\n";
2189 foreach my $field ( @fields ) {
2191 my $value = shift @columns;
2193 if ( ref($field) eq 'CODE' ) {
2194 #&{$field}(\%hash, $value);
2195 push @later, $field, $value;
2197 #??? $hash{$field} = $value if length($value);
2198 $hash{$field} = $value if defined($value) && length($value);
2203 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2204 && length($1) == $custnum_length ) {
2205 $hash{custnum} = $2;
2208 %hash = &{$hash_callback}(%hash) if $hash_callback;
2210 #my $table = $param->{table};
2211 my $class = "FS::$table";
2213 my $record = $class->new( \%hash );
2216 while ( scalar(@later) ) {
2217 my $sub = shift @later;
2218 my $data = shift @later;
2220 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2223 $dbh->rollback if $oldAutoCommit;
2224 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2226 last if exists( $param->{skiprow} );
2228 next if exists( $param->{skiprow} );
2230 if ( $preinsert_callback ) {
2231 my $error = &{$preinsert_callback}($record, $param);
2233 $dbh->rollback if $oldAutoCommit;
2234 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2237 next if exists $param->{skiprow} && $param->{skiprow};
2240 my @insert_args = ();
2241 if ( $insert_args_callback ) {
2242 @insert_args = &{$insert_args_callback}($record, $param);
2245 my $error = $record->insert(@insert_args);
2248 $dbh->rollback if $oldAutoCommit;
2249 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2255 if ( $postinsert_callback ) {
2256 my $error = &{$postinsert_callback}($record, $param);
2258 $dbh->rollback if $oldAutoCommit;
2259 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2264 if ( $job && time - $min_sec > $last ) { #progress bar
2265 $job->update_statustext( int(100 * $imported / $count) );
2271 unless ( $imported || $param->{empty_ok} ) {
2272 $dbh->rollback if $oldAutoCommit;
2273 return "Empty file!";
2276 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2283 my( $self, $action, $time ) = @_;
2287 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2290 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2291 real_fields($self->table);
2294 # If we're encrypting then don't store the payinfo in the history
2295 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2296 @fields = grep { $_ ne 'payinfo' } @fields;
2299 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2301 "INSERT INTO h_". $self->table. " ( ".
2302 join(', ', qw(history_date history_usernum history_action), @fields ).
2305 $FS::CurrentUser::CurrentUser->usernum,
2306 dbh->quote($action),
2315 B<Warning>: External use is B<deprecated>.
2317 Replaces COLUMN in record with a unique number, using counters in the
2318 filesystem. Used by the B<insert> method on single-field unique columns
2319 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2320 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2322 Returns the new value.
2327 my($self,$field) = @_;
2328 my($table)=$self->table;
2330 croak "Unique called on field $field, but it is ",
2331 $self->getfield($field),
2333 if $self->getfield($field);
2335 #warn "table $table is tainted" if is_tainted($table);
2336 #warn "field $field is tainted" if is_tainted($field);
2338 my($counter) = new File::CounterFile "$table.$field",0;
2340 my $index = $counter->inc;
2341 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2343 $index =~ /^(\d*)$/;
2346 $self->setfield($field,$index);
2350 =item ut_float COLUMN
2352 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2353 null. If there is an error, returns the error, otherwise returns false.
2358 my($self,$field)=@_ ;
2359 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2360 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2361 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2362 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2363 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2364 $self->setfield($field,$1);
2367 =item ut_floatn COLUMN
2369 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2370 null. If there is an error, returns the error, otherwise returns false.
2374 #false laziness w/ut_ipn
2376 my( $self, $field ) = @_;
2377 if ( $self->getfield($field) =~ /^()$/ ) {
2378 $self->setfield($field,'');
2381 $self->ut_float($field);
2385 =item ut_sfloat COLUMN
2387 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2388 May not be null. If there is an error, returns the error, otherwise returns
2394 my($self,$field)=@_ ;
2395 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2396 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2397 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2398 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2399 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2400 $self->setfield($field,$1);
2403 =item ut_sfloatn COLUMN
2405 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2406 null. If there is an error, returns the error, otherwise returns false.
2411 my( $self, $field ) = @_;
2412 if ( $self->getfield($field) =~ /^()$/ ) {
2413 $self->setfield($field,'');
2416 $self->ut_sfloat($field);
2420 =item ut_snumber COLUMN
2422 Check/untaint signed numeric data (whole numbers). If there is an error,
2423 returns the error, otherwise returns false.
2428 my($self, $field) = @_;
2429 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2430 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2431 $self->setfield($field, "$1$2");
2435 =item ut_snumbern COLUMN
2437 Check/untaint signed numeric data (whole numbers). If there is an error,
2438 returns the error, otherwise returns false.
2443 my($self, $field) = @_;
2444 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2445 or return "Illegal (numeric) $field: ". $self->getfield($field);
2447 return "Illegal (numeric) $field: ". $self->getfield($field)
2450 $self->setfield($field, "$1$2");
2454 =item ut_number COLUMN
2456 Check/untaint simple numeric data (whole numbers). May not be null. If there
2457 is an error, returns the error, otherwise returns false.
2462 my($self,$field)=@_;
2463 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2464 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2465 $self->setfield($field,$1);
2469 =item ut_numbern COLUMN
2471 Check/untaint simple numeric data (whole numbers). May be null. If there is
2472 an error, returns the error, otherwise returns false.
2477 my($self,$field)=@_;
2478 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2479 or return "Illegal (numeric) $field: ". $self->getfield($field);
2480 $self->setfield($field,$1);
2484 =item ut_decimal COLUMN[, DIGITS]
2486 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2487 error, returns the error, otherwise returns false.
2489 =item ut_decimaln COLUMN[, DIGITS]
2491 Check/untaint decimal numbers. May be null. If there is an error, returns
2492 the error, otherwise returns false.
2497 my($self, $field, $digits) = @_;
2499 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2500 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2501 $self->setfield($field, $1);
2506 my($self, $field, $digits) = @_;
2507 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2508 or return "Illegal (decimal) $field: ".$self->getfield($field);
2509 $self->setfield($field, $1);
2513 =item ut_money COLUMN
2515 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2516 is an error, returns the error, otherwise returns false.
2521 my($self,$field)=@_;
2523 if ( $self->getfield($field) eq '' ) {
2524 $self->setfield($field, 0);
2525 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2526 #handle one decimal place without barfing out
2527 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2528 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2529 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2531 return "Illegal (money) $field: ". $self->getfield($field);
2537 =item ut_moneyn COLUMN
2539 Check/untaint monetary numbers. May be negative. If there
2540 is an error, returns the error, otherwise returns false.
2545 my($self,$field)=@_;
2546 if ($self->getfield($field) eq '') {
2547 $self->setfield($field, '');
2550 $self->ut_money($field);
2553 =item ut_currencyn COLUMN
2555 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2556 is an error, returns the error, otherwise returns false.
2561 my($self, $field) = @_;
2562 if ($self->getfield($field) eq '') { #can be null
2563 $self->setfield($field, '');
2566 $self->ut_currency($field);
2569 =item ut_currency COLUMN
2571 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2572 there is an error, returns the error, otherwise returns false.
2577 my($self, $field) = @_;
2578 my $value = uc( $self->getfield($field) );
2579 if ( code2currency($value) ) {
2580 $self->setfield($value);
2582 return "Unknown currency $value";
2588 =item ut_text COLUMN
2590 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2591 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2592 May not be null. If there is an error, returns the error, otherwise returns
2598 my($self,$field)=@_;
2599 #warn "msgcat ". \&msgcat. "\n";
2600 #warn "notexist ". \¬exist. "\n";
2601 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2602 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2603 # see perldoc perluniprops
2604 $self->getfield($field)
2605 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2606 or return gettext('illegal_or_empty_text'). " $field: ".
2607 $self->getfield($field);
2608 $self->setfield($field,$1);
2612 =item ut_textn COLUMN
2614 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2615 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2616 May be null. If there is an error, returns the error, otherwise returns false.
2621 my($self,$field)=@_;
2622 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2623 $self->ut_text($field);
2626 =item ut_alpha COLUMN
2628 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2629 an error, returns the error, otherwise returns false.
2634 my($self,$field)=@_;
2635 $self->getfield($field) =~ /^(\w+)$/
2636 or return "Illegal or empty (alphanumeric) $field: ".
2637 $self->getfield($field);
2638 $self->setfield($field,$1);
2642 =item ut_alphan COLUMN
2644 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2645 error, returns the error, otherwise returns false.
2650 my($self,$field)=@_;
2651 $self->getfield($field) =~ /^(\w*)$/
2652 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2653 $self->setfield($field,$1);
2657 =item ut_alphasn COLUMN
2659 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2660 an error, returns the error, otherwise returns false.
2665 my($self,$field)=@_;
2666 $self->getfield($field) =~ /^([\w ]*)$/
2667 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2668 $self->setfield($field,$1);
2673 =item ut_alpha_lower COLUMN
2675 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2676 there is an error, returns the error, otherwise returns false.
2680 sub ut_alpha_lower {
2681 my($self,$field)=@_;
2682 $self->getfield($field) =~ /[[:upper:]]/
2683 and return "Uppercase characters are not permitted in $field";
2684 $self->ut_alpha($field);
2687 =item ut_phonen COLUMN [ COUNTRY ]
2689 Check/untaint phone numbers. May be null. If there is an error, returns
2690 the error, otherwise returns false.
2692 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2693 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2698 my( $self, $field, $country ) = @_;
2699 return $self->ut_alphan($field) unless defined $country;
2700 my $phonen = $self->getfield($field);
2701 if ( $phonen eq '' ) {
2702 $self->setfield($field,'');
2703 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2705 $phonen = $conf->config('cust_main-default_areacode').$phonen
2706 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2707 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2708 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2709 $phonen = "$1-$2-$3";
2710 $phonen .= " x$4" if $4;
2711 $self->setfield($field,$phonen);
2713 warn "warning: don't know how to check phone numbers for country $country";
2714 return $self->ut_textn($field);
2721 Check/untaint hexadecimal values.
2726 my($self, $field) = @_;
2727 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2728 or return "Illegal (hex) $field: ". $self->getfield($field);
2729 $self->setfield($field, uc($1));
2733 =item ut_hexn COLUMN
2735 Check/untaint hexadecimal values. May be null.
2740 my($self, $field) = @_;
2741 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2742 or return "Illegal (hex) $field: ". $self->getfield($field);
2743 $self->setfield($field, uc($1));
2747 =item ut_mac_addr COLUMN
2749 Check/untaint mac addresses. May be null.
2754 my($self, $field) = @_;
2756 my $mac = $self->get($field);
2759 $self->set($field, $mac);
2761 my $e = $self->ut_hex($field);
2764 return "Illegal (mac address) $field: ". $self->getfield($field)
2765 unless length($self->getfield($field)) == 12;
2771 =item ut_mac_addrn COLUMN
2773 Check/untaint mac addresses. May be null.
2778 my($self, $field) = @_;
2779 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2784 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2790 my( $self, $field ) = @_;
2791 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2792 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2793 or return "Illegal (IP address) $field: ". $self->getfield($field);
2794 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2795 $self->setfield($field, "$1.$2.$3.$4");
2801 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2802 to 127.0.0.1. May be null.
2807 my( $self, $field ) = @_;
2808 if ( $self->getfield($field) =~ /^()$/ ) {
2809 $self->setfield($field,'');
2812 $self->ut_ip($field);
2816 =item ut_ip46 COLUMN
2818 Check/untaint IPv4 or IPv6 address.
2823 my( $self, $field ) = @_;
2824 my $ip = NetAddr::IP->new($self->getfield($field))
2825 or return "Illegal (IP address) $field: ".$self->getfield($field);
2826 $self->setfield($field, lc($ip->addr));
2832 Check/untaint IPv6 or IPv6 address. May be null.
2837 my( $self, $field ) = @_;
2838 if ( $self->getfield($field) =~ /^$/ ) {
2839 $self->setfield($field, '');
2842 $self->ut_ip46($field);
2845 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2847 Check/untaint coordinates.
2848 Accepts the following forms:
2858 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2859 The latter form (that is, the MMM are thousands of minutes) is
2860 assumed if the "MMM" is exactly three digits or two digits > 59.
2862 To be safe, just use the DDD.DDDDD form.
2864 If LOWER or UPPER are specified, then the coordinate is checked
2865 for lower and upper bounds, respectively.
2870 my ($self, $field) = (shift, shift);
2873 if ( $field =~ /latitude/ ) {
2874 $lower = $lat_lower;
2876 } elsif ( $field =~ /longitude/ ) {
2878 $upper = $lon_upper;
2881 my $coord = $self->getfield($field);
2882 my $neg = $coord =~ s/^(-)//;
2884 my ($d, $m, $s) = (0, 0, 0);
2887 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2888 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2889 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2891 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2894 return "Invalid (coordinate with minutes > 59) $field: "
2895 . $self->getfield($field);
2898 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2900 if (defined($lower) and ($coord < $lower)) {
2901 return "Invalid (coordinate < $lower) $field: "
2902 . $self->getfield($field);;
2905 if (defined($upper) and ($coord > $upper)) {
2906 return "Invalid (coordinate > $upper) $field: "
2907 . $self->getfield($field);;
2910 $self->setfield($field, $coord);
2914 return "Invalid (coordinate) $field: " . $self->getfield($field);
2918 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2920 Same as ut_coord, except optionally null.
2926 my ($self, $field) = (shift, shift);
2928 if ($self->getfield($field) =~ /^\s*$/) {
2931 return $self->ut_coord($field, @_);
2936 =item ut_domain COLUMN
2938 Check/untaint host and domain names. May not be null.
2943 my( $self, $field ) = @_;
2944 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2945 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2946 or return "Illegal (hostname) $field: ". $self->getfield($field);
2947 $self->setfield($field,$1);
2951 =item ut_domainn COLUMN
2953 Check/untaint host and domain names. May be null.
2958 my( $self, $field ) = @_;
2959 if ( $self->getfield($field) =~ /^()$/ ) {
2960 $self->setfield($field,'');
2963 $self->ut_domain($field);
2967 =item ut_name COLUMN
2969 Check/untaint proper names; allows alphanumerics, spaces and the following
2970 punctuation: , . - '
2977 my( $self, $field ) = @_;
2978 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2979 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
2980 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2985 $self->setfield($field, $name);
2989 =item ut_namen COLUMN
2991 Check/untaint proper names; allows alphanumerics, spaces and the following
2992 punctuation: , . - '
2999 my( $self, $field ) = @_;
3000 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3001 $self->ut_name($field);
3006 Check/untaint zip codes.
3010 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3013 my( $self, $field, $country ) = @_;
3015 if ( $country eq 'US' ) {
3017 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3018 or return gettext('illegal_zip'). " $field for country $country: ".
3019 $self->getfield($field);
3020 $self->setfield($field, $1);
3022 } elsif ( $country eq 'CA' ) {
3024 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3025 or return gettext('illegal_zip'). " $field for country $country: ".
3026 $self->getfield($field);
3027 $self->setfield($field, "$1 $2");
3031 if ( $self->getfield($field) =~ /^\s*$/
3032 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3035 $self->setfield($field,'');
3037 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3038 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3039 $self->setfield($field,$1);
3047 =item ut_country COLUMN
3049 Check/untaint country codes. Country names are changed to codes, if possible -
3050 see L<Locale::Country>.
3055 my( $self, $field ) = @_;
3056 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3057 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3058 && country2code($1) ) {
3059 $self->setfield($field,uc(country2code($1)));
3062 $self->getfield($field) =~ /^(\w\w)$/
3063 or return "Illegal (country) $field: ". $self->getfield($field);
3064 $self->setfield($field,uc($1));
3068 =item ut_anything COLUMN
3070 Untaints arbitrary data. Be careful.
3075 my( $self, $field ) = @_;
3076 $self->getfield($field) =~ /^(.*)$/s
3077 or return "Illegal $field: ". $self->getfield($field);
3078 $self->setfield($field,$1);
3082 =item ut_enum COLUMN CHOICES_ARRAYREF
3084 Check/untaint a column, supplying all possible choices, like the "enum" type.
3089 my( $self, $field, $choices ) = @_;
3090 foreach my $choice ( @$choices ) {
3091 if ( $self->getfield($field) eq $choice ) {
3092 $self->setfield($field, $choice);
3096 return "Illegal (enum) field $field: ". $self->getfield($field);
3099 =item ut_enumn COLUMN CHOICES_ARRAYREF
3101 Like ut_enum, except the null value is also allowed.
3106 my( $self, $field, $choices ) = @_;
3107 $self->getfield($field)
3108 ? $self->ut_enum($field, $choices)
3112 =item ut_flag COLUMN
3114 Check/untaint a column if it contains either an empty string or 'Y'. This
3115 is the standard form for boolean flags in Freeside.
3120 my( $self, $field ) = @_;
3121 my $value = uc($self->getfield($field));
3122 if ( $value eq '' or $value eq 'Y' ) {
3123 $self->setfield($field, $value);
3126 return "Illegal (flag) field $field: $value";
3129 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3131 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3132 on the column first.
3136 sub ut_foreign_key {
3137 my( $self, $field, $table, $foreign ) = @_;
3138 return $self->ut_number($field) if $no_check_foreign;
3139 qsearchs($table, { $foreign => $self->getfield($field) })
3140 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3141 " in $table.$foreign";
3145 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3147 Like ut_foreign_key, except the null value is also allowed.
3151 sub ut_foreign_keyn {
3152 my( $self, $field, $table, $foreign ) = @_;
3153 $self->getfield($field)
3154 ? $self->ut_foreign_key($field, $table, $foreign)
3158 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3160 Checks this column as an agentnum, taking into account the current users's
3161 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3162 right or rights allowing no agentnum.
3166 sub ut_agentnum_acl {
3167 my( $self, $field ) = (shift, shift);
3168 my $null_acl = scalar(@_) ? shift : [];
3169 $null_acl = [ $null_acl ] unless ref($null_acl);
3171 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3172 return "Illegal agentnum: $error" if $error;
3174 my $curuser = $FS::CurrentUser::CurrentUser;
3176 if ( $self->$field() ) {
3178 return 'Access denied to agent '. $self->$field()
3179 unless $curuser->agentnum($self->$field());
3183 return 'Access denied to global'
3184 unless grep $curuser->access_right($_), @$null_acl;
3192 =item fields [ TABLE ]
3194 This is a wrapper for real_fields. Code that called
3195 fields before should probably continue to call fields.
3200 my $something = shift;
3202 if($something->isa('FS::Record')) {
3203 $table = $something->table;
3205 $table = $something;
3206 #$something = "FS::$table";
3208 return (real_fields($table));
3212 =item encrypt($value)
3214 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3216 Returns the encrypted string.
3218 You should generally not have to worry about calling this, as the system handles this for you.
3223 my ($self, $value) = @_;
3224 my $encrypted = $value;
3226 if ($conf_encryption) {
3227 if ($self->is_encrypted($value)) {
3228 # Return the original value if it isn't plaintext.
3229 $encrypted = $value;
3232 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3233 # RSA doesn't like the empty string so let's pack it up
3234 # The database doesn't like the RSA data so uuencode it
3235 my $length = length($value)+1;
3236 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3238 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3245 =item is_encrypted($value)
3247 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3253 my ($self, $value) = @_;
3254 # could be more precise about it, but this will do for now
3255 $value =~ /^M/ && length($value) > 80;
3258 =item decrypt($value)
3260 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3262 You should generally not have to worry about calling this, as the system handles this for you.
3267 my ($self,$value) = @_;
3268 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3269 if ($conf_encryption && $self->is_encrypted($value)) {
3271 if (ref($rsa_decrypt) =~ /::RSA/) {
3272 my $encrypted = unpack ("u*", $value);
3273 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3274 if ($@) {warn "Decryption Failed"};
3282 #Initialize the Module
3283 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3285 if ($conf_encryptionmodule && $conf_encryptionmodule ne '') {
3286 $rsa_module = $conf_encryptionmodule;
3290 eval ("require $rsa_module"); # No need to import the namespace
3293 # Initialize Encryption
3294 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3295 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3298 # Intitalize Decryption
3299 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3300 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3304 =item h_search ACTION
3306 Given an ACTION, either "insert", or "delete", returns the appropriate history
3307 record corresponding to this record, if any.
3312 my( $self, $action ) = @_;
3314 my $table = $self->table;
3317 my $primary_key = dbdef->table($table)->primary_key;
3320 'table' => "h_$table",
3321 'hashref' => { $primary_key => $self->$primary_key(),
3322 'history_action' => $action,
3330 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3331 appropriate history record corresponding to this record, if any.
3336 my($self, $action) = @_;
3337 my $h = $self->h_search($action);
3338 $h ? $h->history_date : '';
3341 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3343 A class or object method. Executes the sql statement represented by SQL and
3344 returns a scalar representing the result: the first column of the first row.
3346 Dies on bogus SQL. Returns an empty string if no row is returned.
3348 Typically used for statments which return a single value such as "SELECT
3349 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3354 my($self, $sql) = (shift, shift);
3355 my $sth = dbh->prepare($sql) or die dbh->errstr;
3357 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3358 my $row = $sth->fetchrow_arrayref or return '';
3359 my $scalar = $row->[0];
3360 defined($scalar) ? $scalar : '';
3363 =item count [ WHERE [, PLACEHOLDER ...] ]
3365 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3366 with optional WHERE. Must be called as method on a class with an
3372 my($self, $where) = (shift, shift);
3373 my $table = $self->table or die 'count called on object of class '.ref($self);
3374 my $sql = "SELECT COUNT(*) FROM $table";
3375 $sql .= " WHERE $where" if $where;
3376 $self->scalar_sql($sql, @_);
3379 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3381 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3382 with optional (but almost always needed) WHERE.
3387 my($self, $where) = (shift, shift);
3388 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3389 my $sql = "SELECT 1 FROM $table";
3390 $sql .= " WHERE $where" if $where;
3392 $self->scalar_sql($sql, @_);
3401 =item real_fields [ TABLE ]
3403 Returns a list of the real columns in the specified table. Called only by
3404 fields() and other subroutines elsewhere in FS::Record.
3411 my($table_obj) = dbdef->table($table);
3412 confess "Unknown table $table" unless $table_obj;
3413 $table_obj->columns;
3416 =item pvf FIELD_NAME
3418 Returns the FS::part_virtual_field object corresponding to a field in the
3419 record (specified by FIELD_NAME).
3424 my ($self, $name) = (shift, shift);
3426 if(grep /^$name$/, $self->virtual_fields) {
3428 my $concat = [ "'cf_'", "name" ];
3429 return qsearchs({ table => 'part_virtual_field',
3430 hashref => { dbtable => $self->table,
3433 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3439 =item _quote VALUE, TABLE, COLUMN
3441 This is an internal function used to construct SQL statements. It returns
3442 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3443 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3448 my($value, $table, $column) = @_;
3449 my $column_obj = dbdef->table($table)->column($column);
3450 my $column_type = $column_obj->type;
3451 my $nullable = $column_obj->null;
3453 utf8::upgrade($value);
3455 warn " $table.$column: $value ($column_type".
3456 ( $nullable ? ' NULL' : ' NOT NULL' ).
3457 ")\n" if $DEBUG > 2;
3459 if ( $value eq '' && $nullable ) {
3461 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3462 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3465 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3466 ! $column_type =~ /(char|binary|text)$/i ) {
3468 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3469 && driver_name eq 'Pg'
3473 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3474 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3475 # single-quote the whole mess, and put an "E" in front.
3476 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3484 This is deprecated. Don't use it.
3486 It returns a hash-type list with the fields of this record's table set true.
3491 carp "warning: hfields is deprecated";
3494 foreach (fields($table)) {
3503 "$_: ". $self->getfield($_). "|"
3504 } (fields($self->table)) );
3507 sub DESTROY { return; }
3511 # #use Carp qw(cluck);
3512 # #cluck "DESTROYING $self";
3513 # warn "DESTROYING $self";
3517 # return ! eval { join('',@_), kill 0; 1; };
3520 =item str2time_sql [ DRIVER_NAME ]
3522 Returns a function to convert to unix time based on database type, such as
3523 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3524 the str2time_sql_closing method to return a closing string rather than just
3525 using a closing parenthesis as previously suggested.
3527 You can pass an optional driver name such as "Pg", "mysql" or
3528 $dbh->{Driver}->{Name} to return a function for that database instead of
3529 the current database.
3534 my $driver = shift || driver_name;
3536 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3537 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3539 warn "warning: unknown database type $driver; guessing how to convert ".
3540 "dates to UNIX timestamps";
3541 return 'EXTRACT(EPOCH FROM ';
3545 =item str2time_sql_closing [ DRIVER_NAME ]
3547 Returns the closing suffix of a function to convert to unix time based on
3548 database type, such as ")::integer" for Pg or ")" for mysql.
3550 You can pass an optional driver name such as "Pg", "mysql" or
3551 $dbh->{Driver}->{Name} to return a function for that database instead of
3552 the current database.
3556 sub str2time_sql_closing {
3557 my $driver = shift || driver_name;
3559 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3563 =item regexp_sql [ DRIVER_NAME ]
3565 Returns the operator to do a regular expression comparison based on database
3566 type, such as '~' for Pg or 'REGEXP' for mysql.
3568 You can pass an optional driver name such as "Pg", "mysql" or
3569 $dbh->{Driver}->{Name} to return a function for that database instead of
3570 the current database.
3575 my $driver = shift || driver_name;
3577 return '~' if $driver =~ /^Pg/i;
3578 return 'REGEXP' if $driver =~ /^mysql/i;
3580 die "don't know how to use regular expressions in ". driver_name." databases";
3584 =item not_regexp_sql [ DRIVER_NAME ]
3586 Returns the operator to do a regular expression negation based on database
3587 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3589 You can pass an optional driver name such as "Pg", "mysql" or
3590 $dbh->{Driver}->{Name} to return a function for that database instead of
3591 the current database.
3595 sub not_regexp_sql {
3596 my $driver = shift || driver_name;
3598 return '!~' if $driver =~ /^Pg/i;
3599 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3601 die "don't know how to use regular expressions in ". driver_name." databases";
3605 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3607 Returns the items concatenated based on database type, using "CONCAT()" for
3608 mysql and " || " for Pg and other databases.
3610 You can pass an optional driver name such as "Pg", "mysql" or
3611 $dbh->{Driver}->{Name} to return a function for that database instead of
3612 the current database.
3617 my $driver = ref($_[0]) ? driver_name : shift;
3620 if ( $driver =~ /^mysql/i ) {
3621 'CONCAT('. join(',', @$items). ')';
3623 join('||', @$items);
3628 =item group_concat_sql COLUMN, DELIMITER
3630 Returns an SQL expression to concatenate an aggregate column, using
3631 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3635 sub group_concat_sql {
3636 my ($col, $delim) = @_;
3637 $delim = dbh->quote($delim);
3638 if ( driver_name() =~ /^mysql/i ) {
3639 # DISTINCT(foo) is valid as $col
3640 return "GROUP_CONCAT($col SEPARATOR $delim)";
3642 return "array_to_string(array_agg($col), $delim)";
3646 =item midnight_sql DATE
3648 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3649 on that day in the system timezone, using the default driver name.
3654 my $driver = driver_name;
3656 if ( $driver =~ /^mysql/i ) {
3657 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3660 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3668 This module should probably be renamed, since much of the functionality is
3669 of general use. It is not completely unlike Adapter::DBI (see below).
3671 Exported qsearch and qsearchs should be deprecated in favor of method calls
3672 (against an FS::Record object like the old search and searchs that qsearch
3673 and qsearchs were on top of.)
3675 The whole fields / hfields mess should be removed.
3677 The various WHERE clauses should be subroutined.
3679 table string should be deprecated in favor of DBIx::DBSchema::Table.
3681 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3682 true maps to the database (and WHERE clauses) would also help.
3684 The ut_ methods should ask the dbdef for a default length.
3686 ut_sqltype (like ut_varchar) should all be defined
3688 A fallback check method should be provided which uses the dbdef.
3690 The ut_money method assumes money has two decimal digits.
3692 The Pg money kludge in the new method only strips `$'.
3694 The ut_phonen method only checks US-style phone numbers.
3696 The _quote function should probably use ut_float instead of a regex.
3698 All the subroutines probably should be methods, here or elsewhere.
3700 Probably should borrow/use some dbdef methods where appropriate (like sub
3703 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3704 or allow it to be set. Working around it is ugly any way around - DBI should
3705 be fixed. (only affects RDBMS which return uppercase column names)
3707 ut_zip should take an optional country like ut_phone.
3711 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3713 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.