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 ( defined(eval '@FS::'. $table . '::encrypted_fields')
1304 && scalar( eval '@FS::'. $table . '::encrypted_fields')
1307 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1308 next if $field eq 'payinfo'
1309 && ($self->isa('FS::payinfo_transaction_Mixin')
1310 || $self->isa('FS::payinfo_Mixin') )
1312 && !grep { $self->payby eq $_ } @encrypt_payby;
1313 $saved->{$field} = $self->getfield($field);
1314 $self->setfield($field, $self->encrypt($self->getfield($field)));
1318 #false laziness w/delete
1320 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1323 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1326 my $statement = "INSERT INTO $table ";
1327 if ( @real_fields ) {
1330 join( ', ', @real_fields ).
1332 join( ', ', @values ).
1336 $statement .= 'DEFAULT VALUES';
1338 warn "[debug]$me $statement\n" if $DEBUG > 1;
1339 my $sth = dbh->prepare($statement) or return dbh->errstr;
1341 local $SIG{HUP} = 'IGNORE';
1342 local $SIG{INT} = 'IGNORE';
1343 local $SIG{QUIT} = 'IGNORE';
1344 local $SIG{TERM} = 'IGNORE';
1345 local $SIG{TSTP} = 'IGNORE';
1346 local $SIG{PIPE} = 'IGNORE';
1348 $sth->execute or return $sth->errstr;
1350 # get inserted id from the database, if applicable & needed
1351 if ( $db_seq && ! $self->getfield($primary_key) ) {
1352 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1356 if ( driver_name eq 'Pg' ) {
1358 #my $oid = $sth->{'pg_oid_status'};
1359 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1361 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1362 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1363 dbh->rollback if $FS::UID::AutoCommit;
1364 return "can't parse $table.$primary_key default value".
1365 " for sequence name: $default";
1369 my $i_sql = "SELECT currval('$sequence')";
1370 my $i_sth = dbh->prepare($i_sql) or do {
1371 dbh->rollback if $FS::UID::AutoCommit;
1374 $i_sth->execute() or do { #$i_sth->execute($oid)
1375 dbh->rollback if $FS::UID::AutoCommit;
1376 return $i_sth->errstr;
1378 $insertid = $i_sth->fetchrow_arrayref->[0];
1380 } elsif ( driver_name eq 'mysql' ) {
1382 $insertid = dbh->{'mysql_insertid'};
1383 # work around mysql_insertid being null some of the time, ala RT :/
1384 unless ( $insertid ) {
1385 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1386 "using SELECT LAST_INSERT_ID();";
1387 my $i_sql = "SELECT LAST_INSERT_ID()";
1388 my $i_sth = dbh->prepare($i_sql) or do {
1389 dbh->rollback if $FS::UID::AutoCommit;
1392 $i_sth->execute or do {
1393 dbh->rollback if $FS::UID::AutoCommit;
1394 return $i_sth->errstr;
1396 $insertid = $i_sth->fetchrow_arrayref->[0];
1401 dbh->rollback if $FS::UID::AutoCommit;
1402 return "don't know how to retreive inserted ids from ". driver_name.
1403 ", try using counterfiles (maybe run dbdef-create?)";
1407 $self->setfield($primary_key, $insertid);
1412 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1413 my $h_statement = $self->_h_statement('insert');
1414 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1415 $h_sth = dbh->prepare($h_statement) or do {
1416 dbh->rollback if $FS::UID::AutoCommit;
1422 $h_sth->execute or return $h_sth->errstr if $h_sth;
1424 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1426 # Now that it has been saved, reset the encrypted fields so that $new
1427 # can still be used.
1428 foreach my $field (keys %{$saved}) {
1429 $self->setfield($field, $saved->{$field});
1437 Depriciated (use insert instead).
1442 cluck "warning: FS::Record::add deprecated!";
1443 insert @_; #call method in this scope
1448 Delete this record from the database. If there is an error, returns the error,
1449 otherwise returns false.
1456 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1458 $self->getfield($_) eq ''
1459 #? "( $_ IS NULL OR $_ = \"\" )"
1460 ? ( driver_name eq 'Pg'
1462 : "( $_ IS NULL OR $_ = \"\" )"
1464 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1465 } ( $self->dbdef_table->primary_key )
1466 ? ( $self->dbdef_table->primary_key)
1467 : real_fields($self->table)
1469 warn "[debug]$me $statement\n" if $DEBUG > 1;
1470 my $sth = dbh->prepare($statement) or return dbh->errstr;
1473 if ( defined dbdef->table('h_'. $self->table) ) {
1474 my $h_statement = $self->_h_statement('delete');
1475 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1476 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1481 my $primary_key = $self->dbdef_table->primary_key;
1483 local $SIG{HUP} = 'IGNORE';
1484 local $SIG{INT} = 'IGNORE';
1485 local $SIG{QUIT} = 'IGNORE';
1486 local $SIG{TERM} = 'IGNORE';
1487 local $SIG{TSTP} = 'IGNORE';
1488 local $SIG{PIPE} = 'IGNORE';
1490 my $rc = $sth->execute or return $sth->errstr;
1491 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1492 $h_sth->execute or return $h_sth->errstr if $h_sth;
1494 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1496 #no need to needlessly destoy the data either (causes problems actually)
1497 #undef $self; #no need to keep object!
1504 Depriciated (use delete instead).
1509 cluck "warning: FS::Record::del deprecated!";
1510 &delete(@_); #call method in this scope
1513 =item replace OLD_RECORD
1515 Replace the OLD_RECORD with this one in the database. If there is an error,
1516 returns the error, otherwise returns false.
1521 my ($new, $old) = (shift, shift);
1523 $old = $new->replace_old unless defined($old);
1525 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1527 if ( $new->can('replace_check') ) {
1528 my $error = $new->replace_check($old);
1529 return $error if $error;
1532 return "Records not in same table!" unless $new->table eq $old->table;
1534 my $primary_key = $old->dbdef_table->primary_key;
1535 return "Can't change primary key $primary_key ".
1536 'from '. $old->getfield($primary_key).
1537 ' to ' . $new->getfield($primary_key)
1539 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1541 my $error = $new->check;
1542 return $error if $error;
1544 # Encrypt for replace
1546 if ( $conf_encryption
1547 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1548 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1550 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1551 next if $field eq 'payinfo'
1552 && ($new->isa('FS::payinfo_transaction_Mixin')
1553 || $new->isa('FS::payinfo_Mixin') )
1555 && !grep { $new->payby eq $_ } @encrypt_payby;
1556 $saved->{$field} = $new->getfield($field);
1557 $new->setfield($field, $new->encrypt($new->getfield($field)));
1561 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1562 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1563 ? ($_, $new->getfield($_)) : () } $old->fields;
1565 unless (keys(%diff) || $no_update_diff ) {
1566 carp "[warning]$me ". ref($new)."->replace ".
1567 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1568 ": records identical"
1569 unless $nowarn_identical;
1573 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1575 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1576 } real_fields($old->table)
1581 if ( $old->getfield($_) eq '' ) {
1583 #false laziness w/qsearch
1584 if ( driver_name eq 'Pg' ) {
1585 my $type = $old->dbdef_table->column($_)->type;
1586 if ( $type =~ /(int|(big)?serial)/i ) {
1589 qq-( $_ IS NULL OR $_ = '' )-;
1592 qq-( $_ IS NULL OR $_ = "" )-;
1596 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1599 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1602 warn "[debug]$me $statement\n" if $DEBUG > 1;
1603 my $sth = dbh->prepare($statement) or return dbh->errstr;
1606 if ( defined dbdef->table('h_'. $old->table) ) {
1607 my $h_old_statement = $old->_h_statement('replace_old');
1608 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1609 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1615 if ( defined dbdef->table('h_'. $new->table) ) {
1616 my $h_new_statement = $new->_h_statement('replace_new');
1617 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1618 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1623 local $SIG{HUP} = 'IGNORE';
1624 local $SIG{INT} = 'IGNORE';
1625 local $SIG{QUIT} = 'IGNORE';
1626 local $SIG{TERM} = 'IGNORE';
1627 local $SIG{TSTP} = 'IGNORE';
1628 local $SIG{PIPE} = 'IGNORE';
1630 my $rc = $sth->execute or return $sth->errstr;
1631 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1632 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1633 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1635 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1637 # Now that it has been saved, reset the encrypted fields so that $new
1638 # can still be used.
1639 foreach my $field (keys %{$saved}) {
1640 $new->setfield($field, $saved->{$field});
1648 my( $self ) = shift;
1649 warn "[$me] replace called with no arguments; autoloading old record\n"
1652 my $primary_key = $self->dbdef_table->primary_key;
1653 if ( $primary_key ) {
1654 $self->by_key( $self->$primary_key() ) #this is what's returned
1655 or croak "can't find ". $self->table. ".$primary_key ".
1656 $self->$primary_key();
1658 croak $self->table. " has no primary key; pass old record as argument";
1665 Depriciated (use replace instead).
1670 cluck "warning: FS::Record::rep deprecated!";
1671 replace @_; #call method in this scope
1676 Checks custom fields. Subclasses should still provide a check method to validate
1677 non-custom fields, etc., and call this method via $self->SUPER::check.
1683 foreach my $field ($self->virtual_fields) {
1684 my $error = $self->ut_textn($field);
1685 return $error if $error;
1690 =item virtual_fields [ TABLE ]
1692 Returns a list of virtual fields defined for the table. This should not
1693 be exported, and should only be called as an instance or class method.
1697 sub virtual_fields {
1700 $table = $self->table or confess "virtual_fields called on non-table";
1702 confess "Unknown table $table" unless dbdef->table($table);
1704 return () unless dbdef->table('part_virtual_field');
1706 unless ( $virtual_fields_cache{$table} ) {
1707 my $concat = [ "'cf_'", "name" ];
1708 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1709 "WHERE dbtable = '$table'";
1711 my $result = $dbh->selectcol_arrayref($query);
1712 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1714 $virtual_fields_cache{$table} = $result;
1717 @{$virtual_fields_cache{$table}};
1721 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1723 Processes a batch import as a queued JSRPC job
1725 JOB is an FS::queue entry.
1727 OPTIONS_HASHREF can have the following keys:
1733 Table name (required).
1737 Arrayref of field names for static fields. They will be given values from the
1738 PARAMS hashref and passed as a "params" hashref to batch_import.
1742 Formats hashref. Keys are field names, values are listrefs that define the
1745 Each listref value can be a column name or a code reference. Coderefs are run
1746 with the row object, data and a FS::Conf object as the three parameters.
1747 For example, this coderef does the same thing as using the "columnname" string:
1750 my( $record, $data, $conf ) = @_;
1751 $record->columnname( $data );
1754 Coderefs are run after all "column name" fields are assigned.
1758 Optional format hashref of types. Keys are field names, values are "csv",
1759 "xls" or "fixedlength". Overrides automatic determination of file type
1762 =item format_headers
1764 Optional format hashref of header lines. Keys are field names, values are 0
1765 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1768 =item format_sep_chars
1770 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1771 CSV separation character.
1773 =item format_fixedlenth_formats
1775 Optional format hashref of fixed length format defintiions. Keys are field
1776 names, values Parse::FixedLength listrefs of field definitions.
1780 Set true to default to CSV file type if the filename does not contain a
1781 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1786 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1787 POSTed data. It must contain the field "uploaded files", generated by
1788 /elements/file-upload.html and containing the list of uploaded files.
1789 Currently only supports a single file named "file".
1794 sub process_batch_import {
1795 my($job, $opt, $param) = @_;
1797 my $table = $opt->{table};
1798 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1799 my %formats = %{ $opt->{formats} };
1801 warn Dumper($param) if $DEBUG;
1803 my $files = $param->{'uploaded_files'}
1804 or die "No files provided.\n";
1806 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1808 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1809 my $file = $dir. $files{'file'};
1814 formats => \%formats,
1815 format_types => $opt->{format_types},
1816 format_headers => $opt->{format_headers},
1817 format_sep_chars => $opt->{format_sep_chars},
1818 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1819 format_xml_formats => $opt->{format_xml_formats},
1820 format_asn_formats => $opt->{format_asn_formats},
1821 format_row_callbacks => $opt->{format_row_callbacks},
1822 format_hash_callbacks => $opt->{format_hash_callbacks},
1827 format => $param->{format},
1828 params => { map { $_ => $param->{$_} } @pass_params },
1830 default_csv => $opt->{default_csv},
1831 preinsert_callback => $opt->{preinsert_callback},
1832 postinsert_callback => $opt->{postinsert_callback},
1833 insert_args_callback => $opt->{insert_args_callback},
1836 if ( $opt->{'batch_namecol'} ) {
1837 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1838 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1841 my $error = FS::Record::batch_import( \%iopt );
1845 die "$error\n" if $error;
1848 =item batch_import PARAM_HASHREF
1850 Class method for batch imports. Available params:
1856 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1862 =item format_headers
1864 =item format_sep_chars
1866 =item format_fixedlength_formats
1868 =item format_row_callbacks
1870 =item format_hash_callbacks - After parsing, before object creation
1872 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1874 =item preinsert_callback
1876 =item postinsert_callback
1882 FS::queue object, will be updated with progress
1888 csv, xls, fixedlength, xml
1900 warn "$me batch_import call with params: \n". Dumper($param)
1903 my $table = $param->{table};
1905 my $job = $param->{job};
1906 my $file = $param->{file};
1907 my $params = $param->{params} || {};
1909 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1910 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1912 my( $type, $header, $sep_char,
1913 $fixedlength_format, $xml_format, $asn_format,
1914 $parser_opt, $row_callback, $hash_callback, @fields );
1916 my $postinsert_callback = '';
1917 $postinsert_callback = $param->{'postinsert_callback'}
1918 if $param->{'postinsert_callback'};
1919 my $preinsert_callback = '';
1920 $preinsert_callback = $param->{'preinsert_callback'}
1921 if $param->{'preinsert_callback'};
1922 my $insert_args_callback = '';
1923 $insert_args_callback = $param->{'insert_args_callback'}
1924 if $param->{'insert_args_callback'};
1926 if ( $param->{'format'} ) {
1928 my $format = $param->{'format'};
1929 my $formats = $param->{formats};
1930 die "unknown format $format" unless exists $formats->{ $format };
1932 $type = $param->{'format_types'}
1933 ? $param->{'format_types'}{ $format }
1934 : $param->{type} || 'csv';
1937 $header = $param->{'format_headers'}
1938 ? $param->{'format_headers'}{ $param->{'format'} }
1941 $sep_char = $param->{'format_sep_chars'}
1942 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1945 $fixedlength_format =
1946 $param->{'format_fixedlength_formats'}
1947 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1951 $param->{'format_parser_opts'}
1952 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1956 $param->{'format_xml_formats'}
1957 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1961 $param->{'format_asn_formats'}
1962 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1966 $param->{'format_row_callbacks'}
1967 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1971 $param->{'format_hash_callbacks'}
1972 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
1975 @fields = @{ $formats->{ $format } };
1977 } elsif ( $param->{'fields'} ) {
1979 $type = ''; #infer from filename
1982 $fixedlength_format = '';
1984 $hash_callback = '';
1985 @fields = @{ $param->{'fields'} };
1988 die "neither format nor fields specified";
1991 #my $file = $param->{file};
1994 if ( $file =~ /\.(\w+)$/i ) {
1998 warn "can't parse file type from filename $file; defaulting to CSV";
2002 if $param->{'default_csv'} && $type ne 'xls';
2010 my $asn_header_buffer;
2011 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2013 if ( $type eq 'csv' ) {
2015 $parser_opt->{'binary'} = 1;
2016 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2017 $parser = Text::CSV_XS->new($parser_opt);
2019 } elsif ( $type eq 'fixedlength' ) {
2021 eval "use Parse::FixedLength;";
2023 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2026 die "Unknown file type $type\n";
2029 @buffer = split(/\r?\n/, slurp($file) );
2030 splice(@buffer, 0, ($header || 0) );
2031 $count = scalar(@buffer);
2033 } elsif ( $type eq 'xls' ) {
2035 eval "use Spreadsheet::ParseExcel;";
2038 eval "use DateTime::Format::Excel;";
2039 #for now, just let the error be thrown if it is used, since only CDR
2040 # formats bill_west and troop use it, not other excel-parsing things
2043 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2045 $parser = $excel->{Worksheet}[0]; #first sheet
2047 $count = $parser->{MaxRow} || $parser->{MinRow};
2050 $row = $header || 0;
2052 } elsif ( $type eq 'xml' ) {
2055 eval "use XML::Simple;";
2057 my $xmlrow = $xml_format->{'xmlrow'};
2058 $parser = $xml_format->{'xmlkeys'};
2059 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2060 my $data = XML::Simple::XMLin(
2062 'SuppressEmpty' => '', #sets empty values to ''
2066 $rows = $rows->{$_} foreach @$xmlrow;
2067 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2068 $count = @buffer = @$rows;
2070 } elsif ( $type eq 'asn.1' ) {
2072 eval "use Convert::ASN1";
2075 my $asn = Convert::ASN1->new;
2076 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2078 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2080 my $data = slurp($file);
2081 my $asn_output = $parser->decode( $data )
2082 or return "No ". $asn_format->{'macro'}. " found\n";
2084 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2086 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2087 $count = @buffer = @$rows;
2090 die "Unknown file type $type\n";
2095 local $SIG{HUP} = 'IGNORE';
2096 local $SIG{INT} = 'IGNORE';
2097 local $SIG{QUIT} = 'IGNORE';
2098 local $SIG{TERM} = 'IGNORE';
2099 local $SIG{TSTP} = 'IGNORE';
2100 local $SIG{PIPE} = 'IGNORE';
2102 my $oldAutoCommit = $FS::UID::AutoCommit;
2103 local $FS::UID::AutoCommit = 0;
2106 #my $params = $param->{params} || {};
2107 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2108 my $batch_col = $param->{'batch_keycol'};
2110 my $batch_class = 'FS::'. $param->{'batch_table'};
2111 my $batch = $batch_class->new({
2112 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2114 my $error = $batch->insert;
2116 $dbh->rollback if $oldAutoCommit;
2117 return "can't insert batch record: $error";
2119 #primary key via dbdef? (so the column names don't have to match)
2120 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2122 $params->{ $batch_col } = $batch_value;
2125 #my $job = $param->{job};
2128 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2132 my %hash = %$params;
2133 if ( $type eq 'csv' ) {
2135 last unless scalar(@buffer);
2136 $line = shift(@buffer);
2138 next if $line =~ /^\s*$/; #skip empty lines
2140 $line = &{$row_callback}($line) if $row_callback;
2142 next if $line =~ /^\s*$/; #skip empty lines
2144 $parser->parse($line) or do {
2145 $dbh->rollback if $oldAutoCommit;
2146 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2148 @columns = $parser->fields();
2150 } elsif ( $type eq 'fixedlength' ) {
2152 last unless scalar(@buffer);
2153 $line = shift(@buffer);
2155 @columns = $parser->parse($line);
2157 } elsif ( $type eq 'xls' ) {
2159 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2160 || ! $parser->{Cells}[$row];
2162 my @row = @{ $parser->{Cells}[$row] };
2163 @columns = map $_->{Val}, @row;
2166 #warn $z++. ": $_\n" for @columns;
2168 } elsif ( $type eq 'xml' ) {
2170 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2171 last unless scalar(@buffer);
2172 my $row = shift @buffer;
2173 @columns = @{ $row }{ @$parser };
2175 } elsif ( $type eq 'asn.1' ) {
2177 last unless scalar(@buffer);
2178 my $row = shift @buffer;
2179 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2180 if $asn_format->{row_callback};
2181 foreach my $key ( keys %{ $asn_format->{map} } ) {
2182 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2186 die "Unknown file type $type\n";
2191 foreach my $field ( @fields ) {
2193 my $value = shift @columns;
2195 if ( ref($field) eq 'CODE' ) {
2196 #&{$field}(\%hash, $value);
2197 push @later, $field, $value;
2199 #??? $hash{$field} = $value if length($value);
2200 $hash{$field} = $value if defined($value) && length($value);
2205 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2206 && length($1) == $custnum_length ) {
2207 $hash{custnum} = $2;
2210 %hash = &{$hash_callback}(%hash) if $hash_callback;
2212 #my $table = $param->{table};
2213 my $class = "FS::$table";
2215 my $record = $class->new( \%hash );
2218 while ( scalar(@later) ) {
2219 my $sub = shift @later;
2220 my $data = shift @later;
2222 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2225 $dbh->rollback if $oldAutoCommit;
2226 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2228 last if exists( $param->{skiprow} );
2230 next if exists( $param->{skiprow} );
2232 if ( $preinsert_callback ) {
2233 my $error = &{$preinsert_callback}($record, $param);
2235 $dbh->rollback if $oldAutoCommit;
2236 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2239 next if exists $param->{skiprow} && $param->{skiprow};
2242 my @insert_args = ();
2243 if ( $insert_args_callback ) {
2244 @insert_args = &{$insert_args_callback}($record, $param);
2247 my $error = $record->insert(@insert_args);
2250 $dbh->rollback if $oldAutoCommit;
2251 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2257 if ( $postinsert_callback ) {
2258 my $error = &{$postinsert_callback}($record, $param);
2260 $dbh->rollback if $oldAutoCommit;
2261 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2266 if ( $job && time - $min_sec > $last ) { #progress bar
2267 $job->update_statustext( int(100 * $imported / $count) );
2273 unless ( $imported || $param->{empty_ok} ) {
2274 $dbh->rollback if $oldAutoCommit;
2275 return "Empty file!";
2278 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2285 my( $self, $action, $time ) = @_;
2289 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2292 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2293 real_fields($self->table);
2296 # If we're encrypting then don't store the payinfo in the history
2297 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2298 @fields = grep { $_ ne 'payinfo' } @fields;
2301 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2303 "INSERT INTO h_". $self->table. " ( ".
2304 join(', ', qw(history_date history_usernum history_action), @fields ).
2307 $FS::CurrentUser::CurrentUser->usernum,
2308 dbh->quote($action),
2317 B<Warning>: External use is B<deprecated>.
2319 Replaces COLUMN in record with a unique number, using counters in the
2320 filesystem. Used by the B<insert> method on single-field unique columns
2321 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2322 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2324 Returns the new value.
2329 my($self,$field) = @_;
2330 my($table)=$self->table;
2332 croak "Unique called on field $field, but it is ",
2333 $self->getfield($field),
2335 if $self->getfield($field);
2337 #warn "table $table is tainted" if is_tainted($table);
2338 #warn "field $field is tainted" if is_tainted($field);
2340 my($counter) = new File::CounterFile "$table.$field",0;
2342 my $index = $counter->inc;
2343 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2345 $index =~ /^(\d*)$/;
2348 $self->setfield($field,$index);
2352 =item ut_float COLUMN
2354 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2355 null. If there is an error, returns the error, otherwise returns false.
2360 my($self,$field)=@_ ;
2361 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2362 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2363 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2364 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2365 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2366 $self->setfield($field,$1);
2369 =item ut_floatn COLUMN
2371 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2372 null. If there is an error, returns the error, otherwise returns false.
2376 #false laziness w/ut_ipn
2378 my( $self, $field ) = @_;
2379 if ( $self->getfield($field) =~ /^()$/ ) {
2380 $self->setfield($field,'');
2383 $self->ut_float($field);
2387 =item ut_sfloat COLUMN
2389 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2390 May not be null. If there is an error, returns the error, otherwise returns
2396 my($self,$field)=@_ ;
2397 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2398 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2399 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2400 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2401 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2402 $self->setfield($field,$1);
2405 =item ut_sfloatn COLUMN
2407 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2408 null. If there is an error, returns the error, otherwise returns false.
2413 my( $self, $field ) = @_;
2414 if ( $self->getfield($field) =~ /^()$/ ) {
2415 $self->setfield($field,'');
2418 $self->ut_sfloat($field);
2422 =item ut_snumber COLUMN
2424 Check/untaint signed numeric data (whole numbers). If there is an error,
2425 returns the error, otherwise returns false.
2430 my($self, $field) = @_;
2431 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2432 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2433 $self->setfield($field, "$1$2");
2437 =item ut_snumbern COLUMN
2439 Check/untaint signed numeric data (whole numbers). If there is an error,
2440 returns the error, otherwise returns false.
2445 my($self, $field) = @_;
2446 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2447 or return "Illegal (numeric) $field: ". $self->getfield($field);
2449 return "Illegal (numeric) $field: ". $self->getfield($field)
2452 $self->setfield($field, "$1$2");
2456 =item ut_number COLUMN
2458 Check/untaint simple numeric data (whole numbers). May not be null. If there
2459 is an error, returns the error, otherwise returns false.
2464 my($self,$field)=@_;
2465 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2466 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2467 $self->setfield($field,$1);
2471 =item ut_numbern COLUMN
2473 Check/untaint simple numeric data (whole numbers). May be null. If there is
2474 an error, returns the error, otherwise returns false.
2479 my($self,$field)=@_;
2480 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2481 or return "Illegal (numeric) $field: ". $self->getfield($field);
2482 $self->setfield($field,$1);
2486 =item ut_decimal COLUMN[, DIGITS]
2488 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2489 error, returns the error, otherwise returns false.
2491 =item ut_decimaln COLUMN[, DIGITS]
2493 Check/untaint decimal numbers. May be null. If there is an error, returns
2494 the error, otherwise returns false.
2499 my($self, $field, $digits) = @_;
2501 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2502 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2503 $self->setfield($field, $1);
2508 my($self, $field, $digits) = @_;
2509 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2510 or return "Illegal (decimal) $field: ".$self->getfield($field);
2511 $self->setfield($field, $1);
2515 =item ut_money COLUMN
2517 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2518 is an error, returns the error, otherwise returns false.
2523 my($self,$field)=@_;
2525 if ( $self->getfield($field) eq '' ) {
2526 $self->setfield($field, 0);
2527 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2528 #handle one decimal place without barfing out
2529 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2530 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2531 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2533 return "Illegal (money) $field: ". $self->getfield($field);
2539 =item ut_moneyn COLUMN
2541 Check/untaint monetary numbers. May be negative. If there
2542 is an error, returns the error, otherwise returns false.
2547 my($self,$field)=@_;
2548 if ($self->getfield($field) eq '') {
2549 $self->setfield($field, '');
2552 $self->ut_money($field);
2555 =item ut_currencyn COLUMN
2557 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2558 is an error, returns the error, otherwise returns false.
2563 my($self, $field) = @_;
2564 if ($self->getfield($field) eq '') { #can be null
2565 $self->setfield($field, '');
2568 $self->ut_currency($field);
2571 =item ut_currency COLUMN
2573 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2574 there is an error, returns the error, otherwise returns false.
2579 my($self, $field) = @_;
2580 my $value = uc( $self->getfield($field) );
2581 if ( code2currency($value) ) {
2582 $self->setfield($value);
2584 return "Unknown currency $value";
2590 =item ut_text COLUMN
2592 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2593 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2594 May not be null. If there is an error, returns the error, otherwise returns
2600 my($self,$field)=@_;
2601 #warn "msgcat ". \&msgcat. "\n";
2602 #warn "notexist ". \¬exist. "\n";
2603 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2604 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2605 # see perldoc perluniprops
2606 $self->getfield($field)
2607 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2608 or return gettext('illegal_or_empty_text'). " $field: ".
2609 $self->getfield($field);
2610 $self->setfield($field,$1);
2614 =item ut_textn COLUMN
2616 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2617 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2618 May be null. If there is an error, returns the error, otherwise returns false.
2623 my($self,$field)=@_;
2624 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2625 $self->ut_text($field);
2628 =item ut_alpha COLUMN
2630 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2631 an error, returns the error, otherwise returns false.
2636 my($self,$field)=@_;
2637 $self->getfield($field) =~ /^(\w+)$/
2638 or return "Illegal or empty (alphanumeric) $field: ".
2639 $self->getfield($field);
2640 $self->setfield($field,$1);
2644 =item ut_alphan COLUMN
2646 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2647 error, returns the error, otherwise returns false.
2652 my($self,$field)=@_;
2653 $self->getfield($field) =~ /^(\w*)$/
2654 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2655 $self->setfield($field,$1);
2659 =item ut_alphasn COLUMN
2661 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2662 an error, returns the error, otherwise returns false.
2667 my($self,$field)=@_;
2668 $self->getfield($field) =~ /^([\w ]*)$/
2669 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2670 $self->setfield($field,$1);
2675 =item ut_alpha_lower COLUMN
2677 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2678 there is an error, returns the error, otherwise returns false.
2682 sub ut_alpha_lower {
2683 my($self,$field)=@_;
2684 $self->getfield($field) =~ /[[:upper:]]/
2685 and return "Uppercase characters are not permitted in $field";
2686 $self->ut_alpha($field);
2689 =item ut_phonen COLUMN [ COUNTRY ]
2691 Check/untaint phone numbers. May be null. If there is an error, returns
2692 the error, otherwise returns false.
2694 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2695 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2700 my( $self, $field, $country ) = @_;
2701 return $self->ut_alphan($field) unless defined $country;
2702 my $phonen = $self->getfield($field);
2703 if ( $phonen eq '' ) {
2704 $self->setfield($field,'');
2705 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2707 $phonen = $conf->config('cust_main-default_areacode').$phonen
2708 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2709 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2710 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2711 $phonen = "$1-$2-$3";
2712 $phonen .= " x$4" if $4;
2713 $self->setfield($field,$phonen);
2715 warn "warning: don't know how to check phone numbers for country $country";
2716 return $self->ut_textn($field);
2723 Check/untaint hexadecimal values.
2728 my($self, $field) = @_;
2729 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2730 or return "Illegal (hex) $field: ". $self->getfield($field);
2731 $self->setfield($field, uc($1));
2735 =item ut_hexn COLUMN
2737 Check/untaint hexadecimal values. May be null.
2742 my($self, $field) = @_;
2743 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2744 or return "Illegal (hex) $field: ". $self->getfield($field);
2745 $self->setfield($field, uc($1));
2749 =item ut_mac_addr COLUMN
2751 Check/untaint mac addresses. May be null.
2756 my($self, $field) = @_;
2758 my $mac = $self->get($field);
2761 $self->set($field, $mac);
2763 my $e = $self->ut_hex($field);
2766 return "Illegal (mac address) $field: ". $self->getfield($field)
2767 unless length($self->getfield($field)) == 12;
2773 =item ut_mac_addrn COLUMN
2775 Check/untaint mac addresses. May be null.
2780 my($self, $field) = @_;
2781 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2786 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2792 my( $self, $field ) = @_;
2793 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2794 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2795 or return "Illegal (IP address) $field: ". $self->getfield($field);
2796 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2797 $self->setfield($field, "$1.$2.$3.$4");
2803 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2804 to 127.0.0.1. May be null.
2809 my( $self, $field ) = @_;
2810 if ( $self->getfield($field) =~ /^()$/ ) {
2811 $self->setfield($field,'');
2814 $self->ut_ip($field);
2818 =item ut_ip46 COLUMN
2820 Check/untaint IPv4 or IPv6 address.
2825 my( $self, $field ) = @_;
2826 my $ip = NetAddr::IP->new($self->getfield($field))
2827 or return "Illegal (IP address) $field: ".$self->getfield($field);
2828 $self->setfield($field, lc($ip->addr));
2834 Check/untaint IPv6 or IPv6 address. May be null.
2839 my( $self, $field ) = @_;
2840 if ( $self->getfield($field) =~ /^$/ ) {
2841 $self->setfield($field, '');
2844 $self->ut_ip46($field);
2847 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2849 Check/untaint coordinates.
2850 Accepts the following forms:
2860 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2861 The latter form (that is, the MMM are thousands of minutes) is
2862 assumed if the "MMM" is exactly three digits or two digits > 59.
2864 To be safe, just use the DDD.DDDDD form.
2866 If LOWER or UPPER are specified, then the coordinate is checked
2867 for lower and upper bounds, respectively.
2872 my ($self, $field) = (shift, shift);
2875 if ( $field =~ /latitude/ ) {
2876 $lower = $lat_lower;
2878 } elsif ( $field =~ /longitude/ ) {
2880 $upper = $lon_upper;
2883 my $coord = $self->getfield($field);
2884 my $neg = $coord =~ s/^(-)//;
2886 my ($d, $m, $s) = (0, 0, 0);
2889 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2890 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2891 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2893 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2896 return "Invalid (coordinate with minutes > 59) $field: "
2897 . $self->getfield($field);
2900 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2902 if (defined($lower) and ($coord < $lower)) {
2903 return "Invalid (coordinate < $lower) $field: "
2904 . $self->getfield($field);;
2907 if (defined($upper) and ($coord > $upper)) {
2908 return "Invalid (coordinate > $upper) $field: "
2909 . $self->getfield($field);;
2912 $self->setfield($field, $coord);
2916 return "Invalid (coordinate) $field: " . $self->getfield($field);
2920 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2922 Same as ut_coord, except optionally null.
2928 my ($self, $field) = (shift, shift);
2930 if ($self->getfield($field) =~ /^\s*$/) {
2933 return $self->ut_coord($field, @_);
2938 =item ut_domain COLUMN
2940 Check/untaint host and domain names. May not be null.
2945 my( $self, $field ) = @_;
2946 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2947 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2948 or return "Illegal (hostname) $field: ". $self->getfield($field);
2949 $self->setfield($field,$1);
2953 =item ut_domainn COLUMN
2955 Check/untaint host and domain names. May be null.
2960 my( $self, $field ) = @_;
2961 if ( $self->getfield($field) =~ /^()$/ ) {
2962 $self->setfield($field,'');
2965 $self->ut_domain($field);
2969 =item ut_name COLUMN
2971 Check/untaint proper names; allows alphanumerics, spaces and the following
2972 punctuation: , . - '
2979 my( $self, $field ) = @_;
2980 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2981 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
2982 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2987 $self->setfield($field, $name);
2991 =item ut_namen COLUMN
2993 Check/untaint proper names; allows alphanumerics, spaces and the following
2994 punctuation: , . - '
3001 my( $self, $field ) = @_;
3002 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3003 $self->ut_name($field);
3008 Check/untaint zip codes.
3012 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3015 my( $self, $field, $country ) = @_;
3017 if ( $country eq 'US' ) {
3019 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3020 or return gettext('illegal_zip'). " $field for country $country: ".
3021 $self->getfield($field);
3022 $self->setfield($field, $1);
3024 } elsif ( $country eq 'CA' ) {
3026 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3027 or return gettext('illegal_zip'). " $field for country $country: ".
3028 $self->getfield($field);
3029 $self->setfield($field, "$1 $2");
3033 if ( $self->getfield($field) =~ /^\s*$/
3034 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3037 $self->setfield($field,'');
3039 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3040 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3041 $self->setfield($field,$1);
3049 =item ut_country COLUMN
3051 Check/untaint country codes. Country names are changed to codes, if possible -
3052 see L<Locale::Country>.
3057 my( $self, $field ) = @_;
3058 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3059 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3060 && country2code($1) ) {
3061 $self->setfield($field,uc(country2code($1)));
3064 $self->getfield($field) =~ /^(\w\w)$/
3065 or return "Illegal (country) $field: ". $self->getfield($field);
3066 $self->setfield($field,uc($1));
3070 =item ut_anything COLUMN
3072 Untaints arbitrary data. Be careful.
3077 my( $self, $field ) = @_;
3078 $self->getfield($field) =~ /^(.*)$/s
3079 or return "Illegal $field: ". $self->getfield($field);
3080 $self->setfield($field,$1);
3084 =item ut_enum COLUMN CHOICES_ARRAYREF
3086 Check/untaint a column, supplying all possible choices, like the "enum" type.
3091 my( $self, $field, $choices ) = @_;
3092 foreach my $choice ( @$choices ) {
3093 if ( $self->getfield($field) eq $choice ) {
3094 $self->setfield($field, $choice);
3098 return "Illegal (enum) field $field: ". $self->getfield($field);
3101 =item ut_enumn COLUMN CHOICES_ARRAYREF
3103 Like ut_enum, except the null value is also allowed.
3108 my( $self, $field, $choices ) = @_;
3109 $self->getfield($field)
3110 ? $self->ut_enum($field, $choices)
3114 =item ut_flag COLUMN
3116 Check/untaint a column if it contains either an empty string or 'Y'. This
3117 is the standard form for boolean flags in Freeside.
3122 my( $self, $field ) = @_;
3123 my $value = uc($self->getfield($field));
3124 if ( $value eq '' or $value eq 'Y' ) {
3125 $self->setfield($field, $value);
3128 return "Illegal (flag) field $field: $value";
3131 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3133 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3134 on the column first.
3138 sub ut_foreign_key {
3139 my( $self, $field, $table, $foreign ) = @_;
3140 return $self->ut_number($field) if $no_check_foreign;
3141 qsearchs($table, { $foreign => $self->getfield($field) })
3142 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3143 " in $table.$foreign";
3147 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3149 Like ut_foreign_key, except the null value is also allowed.
3153 sub ut_foreign_keyn {
3154 my( $self, $field, $table, $foreign ) = @_;
3155 $self->getfield($field)
3156 ? $self->ut_foreign_key($field, $table, $foreign)
3160 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3162 Checks this column as an agentnum, taking into account the current users's
3163 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3164 right or rights allowing no agentnum.
3168 sub ut_agentnum_acl {
3169 my( $self, $field ) = (shift, shift);
3170 my $null_acl = scalar(@_) ? shift : [];
3171 $null_acl = [ $null_acl ] unless ref($null_acl);
3173 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3174 return "Illegal agentnum: $error" if $error;
3176 my $curuser = $FS::CurrentUser::CurrentUser;
3178 if ( $self->$field() ) {
3180 return 'Access denied to agent '. $self->$field()
3181 unless $curuser->agentnum($self->$field());
3185 return 'Access denied to global'
3186 unless grep $curuser->access_right($_), @$null_acl;
3194 =item fields [ TABLE ]
3196 This is a wrapper for real_fields. Code that called
3197 fields before should probably continue to call fields.
3202 my $something = shift;
3204 if($something->isa('FS::Record')) {
3205 $table = $something->table;
3207 $table = $something;
3208 #$something = "FS::$table";
3210 return (real_fields($table));
3214 =item encrypt($value)
3216 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3218 Returns the encrypted string.
3220 You should generally not have to worry about calling this, as the system handles this for you.
3225 my ($self, $value) = @_;
3226 my $encrypted = $value;
3228 if ($conf_encryption) {
3229 if ($self->is_encrypted($value)) {
3230 # Return the original value if it isn't plaintext.
3231 $encrypted = $value;
3234 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3235 # RSA doesn't like the empty string so let's pack it up
3236 # The database doesn't like the RSA data so uuencode it
3237 my $length = length($value)+1;
3238 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3240 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3247 =item is_encrypted($value)
3249 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3255 my ($self, $value) = @_;
3256 # could be more precise about it, but this will do for now
3257 $value =~ /^M/ && length($value) > 80;
3260 =item decrypt($value)
3262 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3264 You should generally not have to worry about calling this, as the system handles this for you.
3269 my ($self,$value) = @_;
3270 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3271 if ($conf_encryption && $self->is_encrypted($value)) {
3273 if (ref($rsa_decrypt) =~ /::RSA/) {
3274 my $encrypted = unpack ("u*", $value);
3275 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3276 if ($@) {warn "Decryption Failed"};
3284 #Initialize the Module
3285 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3287 if ($conf_encryptionmodule && $conf_encryptionmodule ne '') {
3288 $rsa_module = $conf_encryptionmodule;
3292 eval ("require $rsa_module"); # No need to import the namespace
3295 # Initialize Encryption
3296 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3297 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3300 # Intitalize Decryption
3301 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3302 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3306 =item h_search ACTION
3308 Given an ACTION, either "insert", or "delete", returns the appropriate history
3309 record corresponding to this record, if any.
3314 my( $self, $action ) = @_;
3316 my $table = $self->table;
3319 my $primary_key = dbdef->table($table)->primary_key;
3322 'table' => "h_$table",
3323 'hashref' => { $primary_key => $self->$primary_key(),
3324 'history_action' => $action,
3332 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3333 appropriate history record corresponding to this record, if any.
3338 my($self, $action) = @_;
3339 my $h = $self->h_search($action);
3340 $h ? $h->history_date : '';
3343 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3345 A class or object method. Executes the sql statement represented by SQL and
3346 returns a scalar representing the result: the first column of the first row.
3348 Dies on bogus SQL. Returns an empty string if no row is returned.
3350 Typically used for statments which return a single value such as "SELECT
3351 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3356 my($self, $sql) = (shift, shift);
3357 my $sth = dbh->prepare($sql) or die dbh->errstr;
3359 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3360 my $row = $sth->fetchrow_arrayref or return '';
3361 my $scalar = $row->[0];
3362 defined($scalar) ? $scalar : '';
3365 =item count [ WHERE [, PLACEHOLDER ...] ]
3367 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3368 with optional WHERE. Must be called as method on a class with an
3374 my($self, $where) = (shift, shift);
3375 my $table = $self->table or die 'count called on object of class '.ref($self);
3376 my $sql = "SELECT COUNT(*) FROM $table";
3377 $sql .= " WHERE $where" if $where;
3378 $self->scalar_sql($sql, @_);
3381 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3383 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3384 with optional (but almost always needed) WHERE.
3389 my($self, $where) = (shift, shift);
3390 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3391 my $sql = "SELECT 1 FROM $table";
3392 $sql .= " WHERE $where" if $where;
3394 $self->scalar_sql($sql, @_);
3403 =item real_fields [ TABLE ]
3405 Returns a list of the real columns in the specified table. Called only by
3406 fields() and other subroutines elsewhere in FS::Record.
3413 my($table_obj) = dbdef->table($table);
3414 confess "Unknown table $table" unless $table_obj;
3415 $table_obj->columns;
3418 =item pvf FIELD_NAME
3420 Returns the FS::part_virtual_field object corresponding to a field in the
3421 record (specified by FIELD_NAME).
3426 my ($self, $name) = (shift, shift);
3428 if(grep /^$name$/, $self->virtual_fields) {
3430 my $concat = [ "'cf_'", "name" ];
3431 return qsearchs({ table => 'part_virtual_field',
3432 hashref => { dbtable => $self->table,
3435 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3441 =item _quote VALUE, TABLE, COLUMN
3443 This is an internal function used to construct SQL statements. It returns
3444 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3445 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3450 my($value, $table, $column) = @_;
3451 my $column_obj = dbdef->table($table)->column($column);
3452 my $column_type = $column_obj->type;
3453 my $nullable = $column_obj->null;
3455 utf8::upgrade($value);
3457 warn " $table.$column: $value ($column_type".
3458 ( $nullable ? ' NULL' : ' NOT NULL' ).
3459 ")\n" if $DEBUG > 2;
3461 if ( $value eq '' && $nullable ) {
3463 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3464 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3467 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3468 ! $column_type =~ /(char|binary|text)$/i ) {
3470 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3471 && driver_name eq 'Pg'
3475 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3476 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3477 # single-quote the whole mess, and put an "E" in front.
3478 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3486 This is deprecated. Don't use it.
3488 It returns a hash-type list with the fields of this record's table set true.
3493 carp "warning: hfields is deprecated";
3496 foreach (fields($table)) {
3505 "$_: ". $self->getfield($_). "|"
3506 } (fields($self->table)) );
3509 sub DESTROY { return; }
3513 # #use Carp qw(cluck);
3514 # #cluck "DESTROYING $self";
3515 # warn "DESTROYING $self";
3519 # return ! eval { join('',@_), kill 0; 1; };
3522 =item str2time_sql [ DRIVER_NAME ]
3524 Returns a function to convert to unix time based on database type, such as
3525 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3526 the str2time_sql_closing method to return a closing string rather than just
3527 using a closing parenthesis as previously suggested.
3529 You can pass an optional driver name such as "Pg", "mysql" or
3530 $dbh->{Driver}->{Name} to return a function for that database instead of
3531 the current database.
3536 my $driver = shift || driver_name;
3538 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3539 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3541 warn "warning: unknown database type $driver; guessing how to convert ".
3542 "dates to UNIX timestamps";
3543 return 'EXTRACT(EPOCH FROM ';
3547 =item str2time_sql_closing [ DRIVER_NAME ]
3549 Returns the closing suffix of a function to convert to unix time based on
3550 database type, such as ")::integer" for Pg or ")" for mysql.
3552 You can pass an optional driver name such as "Pg", "mysql" or
3553 $dbh->{Driver}->{Name} to return a function for that database instead of
3554 the current database.
3558 sub str2time_sql_closing {
3559 my $driver = shift || driver_name;
3561 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3565 =item regexp_sql [ DRIVER_NAME ]
3567 Returns the operator to do a regular expression comparison based on database
3568 type, such as '~' for Pg or 'REGEXP' for mysql.
3570 You can pass an optional driver name such as "Pg", "mysql" or
3571 $dbh->{Driver}->{Name} to return a function for that database instead of
3572 the current database.
3577 my $driver = shift || driver_name;
3579 return '~' if $driver =~ /^Pg/i;
3580 return 'REGEXP' if $driver =~ /^mysql/i;
3582 die "don't know how to use regular expressions in ". driver_name." databases";
3586 =item not_regexp_sql [ DRIVER_NAME ]
3588 Returns the operator to do a regular expression negation based on database
3589 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3591 You can pass an optional driver name such as "Pg", "mysql" or
3592 $dbh->{Driver}->{Name} to return a function for that database instead of
3593 the current database.
3597 sub not_regexp_sql {
3598 my $driver = shift || driver_name;
3600 return '!~' if $driver =~ /^Pg/i;
3601 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3603 die "don't know how to use regular expressions in ". driver_name." databases";
3607 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3609 Returns the items concatenated based on database type, using "CONCAT()" for
3610 mysql and " || " for Pg and other databases.
3612 You can pass an optional driver name such as "Pg", "mysql" or
3613 $dbh->{Driver}->{Name} to return a function for that database instead of
3614 the current database.
3619 my $driver = ref($_[0]) ? driver_name : shift;
3622 if ( $driver =~ /^mysql/i ) {
3623 'CONCAT('. join(',', @$items). ')';
3625 join('||', @$items);
3630 =item group_concat_sql COLUMN, DELIMITER
3632 Returns an SQL expression to concatenate an aggregate column, using
3633 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3637 sub group_concat_sql {
3638 my ($col, $delim) = @_;
3639 $delim = dbh->quote($delim);
3640 if ( driver_name() =~ /^mysql/i ) {
3641 # DISTINCT(foo) is valid as $col
3642 return "GROUP_CONCAT($col SEPARATOR $delim)";
3644 return "array_to_string(array_agg($col), $delim)";
3648 =item midnight_sql DATE
3650 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3651 on that day in the system timezone, using the default driver name.
3656 my $driver = driver_name;
3658 if ( $driver =~ /^mysql/i ) {
3659 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3662 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3670 This module should probably be renamed, since much of the functionality is
3671 of general use. It is not completely unlike Adapter::DBI (see below).
3673 Exported qsearch and qsearchs should be deprecated in favor of method calls
3674 (against an FS::Record object like the old search and searchs that qsearch
3675 and qsearchs were on top of.)
3677 The whole fields / hfields mess should be removed.
3679 The various WHERE clauses should be subroutined.
3681 table string should be deprecated in favor of DBIx::DBSchema::Table.
3683 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3684 true maps to the database (and WHERE clauses) would also help.
3686 The ut_ methods should ask the dbdef for a default length.
3688 ut_sqltype (like ut_varchar) should all be defined
3690 A fallback check method should be provided which uses the dbdef.
3692 The ut_money method assumes money has two decimal digits.
3694 The Pg money kludge in the new method only strips `$'.
3696 The ut_phonen method only checks US-style phone numbers.
3698 The _quote function should probably use ut_float instead of a regex.
3700 All the subroutines probably should be methods, here or elsewhere.
3702 Probably should borrow/use some dbdef methods where appropriate (like sub
3705 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3706 or allow it to be set. Working around it is ugly any way around - DBI should
3707 be fixed. (only affects RDBMS which return uppercase column names)
3709 ut_zip should take an optional country like ut_phone.
3713 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3715 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.