2 use base qw( Exporter );
6 %virtual_fields_cache %fk_method_cache $fk_table_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
37 midnight_sql fk_methods_init
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?'; }";
91 FS::Record - Database record objects
96 use FS::Record qw(dbh fields qsearch qsearchs);
98 $record = new FS::Record 'table', \%hash;
99 $record = new FS::Record 'table', { 'column' => 'value', ... };
101 $record = qsearchs FS::Record 'table', \%hash;
102 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
103 @records = qsearch FS::Record 'table', \%hash;
104 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
106 $table = $record->table;
107 $dbdef_table = $record->dbdef_table;
109 $value = $record->get('column');
110 $value = $record->getfield('column');
111 $value = $record->column;
113 $record->set( 'column' => 'value' );
114 $record->setfield( 'column' => 'value' );
115 $record->column('value');
117 %hash = $record->hash;
119 $hashref = $record->hashref;
121 $error = $record->insert;
123 $error = $record->delete;
125 $error = $new_record->replace($old_record);
127 # external use deprecated - handled by the database (at least for Pg, mysql)
128 $value = $record->unique('column');
130 $error = $record->ut_float('column');
131 $error = $record->ut_floatn('column');
132 $error = $record->ut_number('column');
133 $error = $record->ut_numbern('column');
134 $error = $record->ut_decimal('column');
135 $error = $record->ut_decimaln('column');
136 $error = $record->ut_snumber('column');
137 $error = $record->ut_snumbern('column');
138 $error = $record->ut_money('column');
139 $error = $record->ut_text('column');
140 $error = $record->ut_textn('column');
141 $error = $record->ut_alpha('column');
142 $error = $record->ut_alphan('column');
143 $error = $record->ut_phonen('column');
144 $error = $record->ut_anything('column');
145 $error = $record->ut_name('column');
147 $quoted_value = _quote($value,'table','field');
150 $fields = hfields('table');
151 if ( $fields->{Field} ) { # etc.
153 @fields = fields 'table'; #as a subroutine
154 @fields = $record->fields; #as a method call
159 (Mostly) object-oriented interface to database records. Records are currently
160 implemented on top of DBI. FS::Record is intended as a base class for
161 table-specific classes to inherit from, i.e. FS::cust_main.
167 =item new [ TABLE, ] HASHREF
169 Creates a new record. It doesn't store it in the database, though. See
170 L<"insert"> for that.
172 Note that the object stores this hash reference, not a distinct copy of the
173 hash it points to. You can ask the object for a copy with the I<hash>
176 TABLE can only be omitted when a dervived class overrides the table method.
182 my $class = ref($proto) || $proto;
184 bless ($self, $class);
186 unless ( defined ( $self->table ) ) {
187 $self->{'Table'} = shift;
188 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
189 unless $nowarn_classload;
192 $self->{'Hash'} = shift;
194 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
195 $self->{'Hash'}{$field}='';
198 $self->_rebless if $self->can('_rebless');
200 $self->{'modified'} = 0;
202 $self->_simplecache($self->{'Hash'}) if $self->can('_simplecache');
203 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
210 my $class = ref($proto) || $proto;
212 bless ($self, $class);
214 $self->{'Table'} = shift unless defined ( $self->table );
216 my $hashref = $self->{'Hash'} = shift;
218 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
219 my $obj = $cache->cache->{$hashref->{$cache->key}};
220 $obj->_cache($hashref, $cache) if $obj->can('_cache');
223 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
230 my $class = ref($proto) || $proto;
232 bless ($self, $class);
233 if ( defined $self->table ) {
234 cluck "create constructor is deprecated, use new!";
237 croak "FS::Record::create called (not from a subclass)!";
241 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
243 Searches the database for all records matching (at least) the key/value pairs
244 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
245 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
248 The preferred usage is to pass a hash reference of named parameters:
250 @records = qsearch( {
251 'table' => 'table_name',
252 'hashref' => { 'field' => 'value'
253 'field' => { 'op' => '<',
258 #these are optional...
260 'extra_sql' => 'AND field = ? AND intfield = ?',
261 'extra_param' => [ 'value', [ 5, 'int' ] ],
262 'order_by' => 'ORDER BY something',
263 #'cache_obj' => '', #optional
264 'addl_from' => 'LEFT JOIN othtable USING ( field )',
269 Much code still uses old-style positional parameters, this is also probably
270 fine in the common case where there are only two parameters:
272 my @records = qsearch( 'table', { 'field' => 'value' } );
274 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
275 the individual PARAMS_HASHREF queries
277 ###oops, argh, FS::Record::new only lets us create database fields.
278 #Normal behaviour if SELECT is not specified is `*', as in
279 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
280 #feature where you can specify SELECT - remember, the objects returned,
281 #although blessed into the appropriate `FS::TABLE' package, will only have the
282 #fields you specify. This might have unwanted results if you then go calling
283 #regular FS::TABLE methods
288 my %TYPE = (); #for debugging
291 my($type, $value) = @_;
293 my $bind_type = { TYPE => SQL_VARCHAR };
295 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
297 $bind_type = { TYPE => SQL_INTEGER };
299 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
301 if ( driver_name eq 'Pg' ) {
303 $bind_type = { pg_type => PG_BYTEA };
305 # $bind_type = ? #SQL_VARCHAR could be fine?
308 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
309 #fixed by DBD::Pg 2.11.8
310 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
311 #(make a Tron test first)
312 } elsif ( _is_fs_float( $type, $value ) ) {
314 $bind_type = { TYPE => SQL_DECIMAL };
323 my($type, $value) = @_;
324 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
325 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
333 my( @stable, @record, @cache );
334 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
336 my %union_options = ();
337 if ( ref($_[0]) eq 'ARRAY' ) {
340 foreach my $href ( @$optlist ) {
341 push @stable, ( $href->{'table'} or die "table name is required" );
342 push @record, ( $href->{'hashref'} || {} );
343 push @select, ( $href->{'select'} || '*' );
344 push @extra_sql, ( $href->{'extra_sql'} || '' );
345 push @extra_param, ( $href->{'extra_param'} || [] );
346 push @order_by, ( $href->{'order_by'} || '' );
347 push @cache, ( $href->{'cache_obj'} || '' );
348 push @addl_from, ( $href->{'addl_from'} || '' );
349 push @debug, ( $href->{'debug'} || '' );
351 die "at least one hashref is required" unless scalar(@stable);
352 } elsif ( ref($_[0]) eq 'HASH' ) {
354 $stable[0] = $opt->{'table'} or die "table name is required";
355 $record[0] = $opt->{'hashref'} || {};
356 $select[0] = $opt->{'select'} || '*';
357 $extra_sql[0] = $opt->{'extra_sql'} || '';
358 $extra_param[0] = $opt->{'extra_param'} || [];
359 $order_by[0] = $opt->{'order_by'} || '';
360 $cache[0] = $opt->{'cache_obj'} || '';
361 $addl_from[0] = $opt->{'addl_from'} || '';
362 $debug[0] = $opt->{'debug'} || '';
373 my $cache = $cache[0];
379 foreach my $stable ( @stable ) {
381 carp '->qsearch on cust_main called' if $stable eq 'cust_main' && $DEBUG;
383 #stop altering the caller's hashref
384 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
385 my $select = shift @select;
386 my $extra_sql = shift @extra_sql;
387 my $extra_param = shift @extra_param;
388 my $order_by = shift @order_by;
389 my $cache = shift @cache;
390 my $addl_from = shift @addl_from;
391 my $debug = shift @debug;
393 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
395 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
398 my $table = $cache ? $cache->table : $stable;
399 my $dbdef_table = dbdef->table($table)
400 or die "No schema for table $table found - ".
401 "do you need to run freeside-upgrade?";
402 my $pkey = $dbdef_table->primary_key;
404 my @real_fields = grep exists($record->{$_}), real_fields($table);
406 my $statement .= "SELECT $select FROM $stable";
409 $statement .= " $addl_from";
410 # detect aliasing of the main table
411 if ( $addl_from =~ /^\s*AS\s+(\w+)/i ) {
415 if ( @real_fields ) {
416 $statement .= ' WHERE '. join(' AND ',
417 get_real_fields($table, $record, \@real_fields, $alias_main));
420 $statement .= " $extra_sql" if defined($extra_sql);
421 $statement .= " $order_by" if defined($order_by);
423 push @statement, $statement;
425 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
428 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
431 my $value = $record->{$field};
432 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
433 $value = $value->{'value'} if ref($value);
434 my $type = dbdef->table($table)->column($field)->type;
436 my $bind_type = _bind_type($type, $value);
440 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
442 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
446 push @bind_type, $bind_type;
450 foreach my $param ( @$extra_param ) {
451 my $bind_type = { TYPE => SQL_VARCHAR };
454 $value = $param->[0];
455 my $type = $param->[1];
456 $bind_type = _bind_type($type, $value);
459 push @bind_type, $bind_type;
463 my $statement = join( ' ) UNION ( ', @statement );
464 $statement = "( $statement )" if scalar(@statement) > 1;
465 $statement .= " $union_options{order_by}" if $union_options{order_by};
467 my $sth = $dbh->prepare($statement)
468 or croak "$dbh->errstr doing $statement";
471 foreach my $value ( @value ) {
472 my $bind_type = shift @bind_type;
473 $sth->bind_param($bind++, $value, $bind_type );
476 # $sth->execute( map $record->{$_},
477 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
478 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
480 my $ok = $sth->execute;
482 my $error = "Error executing \"$statement\"";
483 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
484 $error .= ': '. $sth->errstr;
488 my $table = $stable[0];
490 $table = '' if grep { $_ ne $table } @stable;
491 $pkey = dbdef->table($table)->primary_key if $table;
494 tie %result, "Tie::IxHash";
495 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
496 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
497 %result = map { $_->{$pkey}, $_ } @stuff;
499 @result{@stuff} = @stuff;
504 #below was refactored out to _from_hashref, this should use it at some point
507 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
508 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
509 #derivied class didn't override new method, so this optimization is safe
512 new_or_cached( "FS::$table", { %{$_} }, $cache )
516 new( "FS::$table", { %{$_} } )
520 #okay, its been tested
521 # warn "untested code (class FS::$table uses custom new method)";
523 eval 'FS::'. $table. '->new( { %{$_} } )';
527 # Check for encrypted fields and decrypt them.
528 ## only in the local copy, not the cached object
529 no warnings 'deprecated'; # XXX silence the warning for now
530 if ( $conf_encryption
531 && eval '@FS::'. $table . '::encrypted_fields' ) {
532 foreach my $record (@return) {
533 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
534 next if $field eq 'payinfo'
535 && ($record->isa('FS::payinfo_transaction_Mixin')
536 || $record->isa('FS::payinfo_Mixin') )
538 && !grep { $record->payby eq $_ } @encrypt_payby;
539 # Set it directly... This may cause a problem in the future...
540 $record->setfield($field, $record->decrypt($record->getfield($field)));
545 cluck "warning: FS::$table not loaded; returning FS::Record objects"
546 unless $nowarn_classload;
548 FS::Record->new( $table, { %{$_} } );
556 Construct the SQL statement and parameter-binding list for qsearch. Takes
557 the qsearch parameters.
559 Returns a hash containing:
560 'table': The primary table name (if there is one).
561 'statement': The SQL statement itself.
562 'bind_type': An arrayref of bind types.
563 'value': An arrayref of parameter values.
564 'cache': The cache object, if one was passed.
569 my( @stable, @record, @cache );
570 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
573 my %union_options = ();
574 if ( ref($_[0]) eq 'ARRAY' ) {
577 foreach my $href ( @$optlist ) {
578 push @stable, ( $href->{'table'} or die "table name is required" );
579 push @record, ( $href->{'hashref'} || {} );
580 push @select, ( $href->{'select'} || '*' );
581 push @extra_sql, ( $href->{'extra_sql'} || '' );
582 push @extra_param, ( $href->{'extra_param'} || [] );
583 push @order_by, ( $href->{'order_by'} || '' );
584 push @cache, ( $href->{'cache_obj'} || '' );
585 push @addl_from, ( $href->{'addl_from'} || '' );
586 push @debug, ( $href->{'debug'} || '' );
588 die "at least one hashref is required" unless scalar(@stable);
589 } elsif ( ref($_[0]) eq 'HASH' ) {
591 $stable[0] = $opt->{'table'} or die "table name is required";
592 $record[0] = $opt->{'hashref'} || {};
593 $select[0] = $opt->{'select'} || '*';
594 $extra_sql[0] = $opt->{'extra_sql'} || '';
595 $extra_param[0] = $opt->{'extra_param'} || [];
596 $order_by[0] = $opt->{'order_by'} || '';
597 $cache[0] = $opt->{'cache_obj'} || '';
598 $addl_from[0] = $opt->{'addl_from'} || '';
599 $debug[0] = $opt->{'debug'} || '';
610 my $cache = $cache[0];
616 my $result_table = $stable[0];
617 foreach my $stable ( @stable ) {
618 #stop altering the caller's hashref
619 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
620 my $select = shift @select;
621 my $extra_sql = shift @extra_sql;
622 my $extra_param = shift @extra_param;
623 my $order_by = shift @order_by;
624 my $cache = shift @cache;
625 my $addl_from = shift @addl_from;
626 my $debug = shift @debug;
628 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
630 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
633 $result_table = '' if $result_table ne $stable;
635 my $table = $cache ? $cache->table : $stable;
636 my $dbdef_table = dbdef->table($table)
637 or die "No schema for table $table found - ".
638 "do you need to run freeside-upgrade?";
639 my $pkey = $dbdef_table->primary_key;
641 my @real_fields = grep exists($record->{$_}), real_fields($table);
643 my $statement .= "SELECT $select FROM $stable";
644 $statement .= " $addl_from" if $addl_from;
645 if ( @real_fields ) {
646 $statement .= ' WHERE '. join(' AND ',
647 get_real_fields($table, $record, \@real_fields));
650 $statement .= " $extra_sql" if defined($extra_sql);
651 $statement .= " $order_by" if defined($order_by);
653 push @statement, $statement;
655 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
659 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
662 my $value = $record->{$field};
663 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
664 $value = $value->{'value'} if ref($value);
665 my $type = dbdef->table($table)->column($field)->type;
667 my $bind_type = _bind_type($type, $value);
671 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
673 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
677 push @bind_type, $bind_type;
681 foreach my $param ( @$extra_param ) {
682 my $bind_type = { TYPE => SQL_VARCHAR };
685 $value = $param->[0];
686 my $type = $param->[1];
687 $bind_type = _bind_type($type, $value);
690 push @bind_type, $bind_type;
694 my $statement = join( ' ) UNION ( ', @statement );
695 $statement = "( $statement )" if scalar(@statement) > 1;
696 $statement .= " $union_options{order_by}" if $union_options{order_by};
699 statement => $statement,
700 bind_type => \@bind_type,
702 table => $result_table,
707 # qsearch should eventually use this
709 my ($table, $cache, @hashrefs) = @_;
711 # XXX get rid of these string evals at some point
712 # (when we have time to test it)
713 # my $class = "FS::$table" if $table;
714 # if ( $class and $class->isa('FS::Record') )
715 # if ( $class->can('new') eq \&new )
717 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
718 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
719 #derivied class didn't override new method, so this optimization is safe
722 new_or_cached( "FS::$table", { %{$_} }, $cache )
726 new( "FS::$table", { %{$_} } )
730 #okay, its been tested
731 # warn "untested code (class FS::$table uses custom new method)";
733 eval 'FS::'. $table. '->new( { %{$_} } )';
737 # Check for encrypted fields and decrypt them.
738 ## only in the local copy, not the cached object
739 if ( $conf_encryption
740 && eval '@FS::'. $table . '::encrypted_fields' ) {
741 foreach my $record (@return) {
742 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
743 next if $field eq 'payinfo'
744 && ($record->isa('FS::payinfo_transaction_Mixin')
745 || $record->isa('FS::payinfo_Mixin') )
747 && !grep { $record->payby eq $_ } @encrypt_payby;
748 # Set it directly... This may cause a problem in the future...
749 $record->setfield($field, $record->decrypt($record->getfield($field)));
754 cluck "warning: FS::$table not loaded; returning FS::Record objects"
755 unless $nowarn_classload;
757 FS::Record->new( $table, { %{$_} } );
763 sub get_real_fields {
766 my $real_fields = shift;
767 my $alias_main = shift; # defaults to undef
768 $alias_main ||= $table;
770 ## could be optimized more for readability
776 my $table_column = $qsearch_qualify_columns ? "$alias_main.$column" : $column;
777 my $type = dbdef->table($table)->column($column)->type;
778 my $value = $record->{$column};
779 $value = $value->{'value'} if ref($value);
781 if ( ref($record->{$column}) ) {
782 $op = $record->{$column}{'op'} if $record->{$column}{'op'};
783 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
784 if ( uc($op) eq 'ILIKE' ) {
786 $record->{$column}{'value'} = lc($record->{$column}{'value'});
787 $table_column = "LOWER($table_column)";
789 $record->{$column} = $record->{$column}{'value'}
792 if ( ! defined( $record->{$column} ) || $record->{$column} eq '' ) {
794 if ( driver_name eq 'Pg' ) {
795 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
796 qq-( $table_column IS NULL )-;
798 qq-( $table_column IS NULL OR $table_column = '' )-;
801 qq-( $table_column IS NULL OR $table_column = "" )-;
803 } elsif ( $op eq '!=' ) {
804 if ( driver_name eq 'Pg' ) {
805 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
806 qq-( $table_column IS NOT NULL )-;
808 qq-( $table_column IS NOT NULL AND $table_column != '' )-;
811 qq-( $table_column IS NOT NULL AND $table_column != "" )-;
814 if ( driver_name eq 'Pg' ) {
815 qq-( $table_column $op '' )-;
817 qq-( $table_column $op "" )-;
820 } elsif ( $op eq '!=' ) {
821 qq-( $table_column IS NULL OR $table_column != ? )-;
822 #if this needs to be re-enabled, it needs to use a custom op like
823 #"APPROX=" or something (better name?, not '=', to avoid affecting other
825 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
826 # ( "$table_column <= ?", "$table_column >= ?" );
828 "$table_column $op ?";
835 =item by_key PRIMARY_KEY_VALUE
837 This is a class method that returns the record with the given primary key
838 value. This method is only useful in FS::Record subclasses. For example:
840 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
844 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
849 my ($class, $pkey_value) = @_;
851 my $table = $class->table
852 or croak "No table for $class found";
854 my $dbdef_table = dbdef->table($table)
855 or die "No schema for table $table found - ".
856 "do you need to create it or run dbdef-create?";
857 my $pkey = $dbdef_table->primary_key
858 or die "No primary key for table $table";
860 return qsearchs($table, { $pkey => $pkey_value });
863 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
865 Experimental JOINed search method. Using this method, you can execute a
866 single SELECT spanning multiple tables, and cache the results for subsequent
867 method calls. Interface will almost definately change in an incompatible
875 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
876 my $cache = FS::SearchCache->new( $ptable, $pkey );
879 grep { !$saw{$_->getfield($pkey)}++ }
880 qsearch($table, $record, $select, $extra_sql, $cache )
884 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
886 Same as qsearch, except that if more than one record matches, it B<carp>s but
887 returns the first. If this happens, you either made a logic error in asking
888 for a single item, or your data is corrupted.
892 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
894 my(@result) = qsearch(@_);
895 cluck "warning: Multiple records in scalar search ($table)"
896 #.join(' / ', map "$_=>".$_[1]->{$_}, keys %{ $_[1] } )
897 if scalar(@result) > 1;
898 #should warn more vehemently if the search was on a primary key?
899 scalar(@result) ? ($result[0]) : ();
910 Returns the table name.
915 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
922 Returns the DBIx::DBSchema::Table object for the table.
928 my($table)=$self->table;
929 dbdef->table($table);
934 Returns the primary key for the table.
940 my $pkey = $self->dbdef_table->primary_key;
943 =item get, getfield COLUMN
945 Returns the value of the column/field/key COLUMN.
950 my($self,$field) = @_;
951 # to avoid "Use of unitialized value" errors
952 if ( defined ( $self->{Hash}->{$field} ) ) {
953 $self->{Hash}->{$field};
963 =item set, setfield COLUMN, VALUE
965 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
970 my($self,$field,$value) = @_;
971 $self->{'modified'} = 1;
972 $self->{'Hash'}->{$field} = $value;
981 Returns true if the column/field/key COLUMN exists.
986 my($self,$field) = @_;
987 exists($self->{Hash}->{$field});
990 =item AUTOLOADED METHODS
992 $record->column is a synonym for $record->get('column');
994 $record->column('value') is a synonym for $record->set('column','value');
996 $record->foreign_table_name calls qsearchs and returns a single
997 FS::foreign_table record (for tables referenced by a column of this table) or
998 qsearch and returns an array of FS::foreign_table records (for tables
999 referenced by a column in the foreign table).
1005 my($self,$value)=@_;
1006 my($field)=$AUTOLOAD;
1009 confess "errant AUTOLOAD $field for $self (arg $value)"
1010 unless blessed($self) && $self->can('setfield');
1012 if ( my $fk_info = get_fk_method($self->table, $field) ) {
1014 my $method = $fk_info->{method} || 'qsearchs';
1015 my $table = $fk_info->{table} || $field;
1016 my $column = $fk_info->{column};
1017 my $foreign_column = $fk_info->{references} || $column;
1019 eval "use FS::$table";
1022 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1024 my $pkey_value = $self->$column();
1025 my %search = ( $foreign_column => $pkey_value );
1027 # FS::Record->$method() ? they're actually just subs :/
1028 if ( $method eq 'qsearchs' ) {
1029 return $pkey_value ? qsearchs( $table, \%search ) : '';
1030 } elsif ( $method eq 'qsearch' ) {
1031 return $pkey_value ? qsearch( $table, \%search ) : ();
1033 die "unknown method $method";
1038 if ( defined($value) ) {
1039 $self->setfield($field,$value);
1041 $self->getfield($field);
1045 # efficient (also, old, doesn't support FK stuff)
1047 # my $field = $AUTOLOAD;
1048 # $field =~ s/.*://;
1049 # if ( defined($_[1]) ) {
1050 # $_[0]->setfield($field, $_[1]);
1052 # $_[0]->getfield($field);
1056 # get_fk_method(TABLE, FIELD)
1057 # Internal subroutine for fetching the foreign key descriptor for TABLE.FIELD
1058 # if there is one. If not, returns undef.
1059 # This will initialize fk_method_cache if it hasn't happened yet. It is the
1060 # _only_ allowed way to access the contents of %fk_method_cache.
1062 # if we wanted to be even more efficient we'd create the fk methods in the
1063 # symbol table instead of relying on AUTOLOAD every time
1066 my ($table, $field) = @_;
1068 fk_methods_init() unless exists($fk_method_cache{$table});
1070 if ( exists($fk_method_cache{$table}) and
1071 exists($fk_method_cache{$table}{$field}) ) {
1072 return $fk_method_cache{$table}{$field};
1079 sub fk_methods_init {
1080 warn "[fk_methods_init]\n" if $DEBUG;
1081 foreach my $table ( dbdef->tables ) {
1082 $fk_method_cache{$table} = fk_methods($table);
1091 # foreign keys we reference in other tables
1092 foreach my $fk (dbdef->table($table)->foreign_keys) {
1095 if ( scalar( @{$fk->columns} ) == 1 ) {
1096 if ( ! defined($fk->references)
1097 || ! @{$fk->references}
1098 || $fk->columns->[0] eq $fk->references->[0]
1100 $method = $fk->table;
1102 #some sort of hint in the table.pm or schema for methods not named
1103 # after their foreign table (well, not a whole lot different than
1104 # just providing a small subroutine...)
1108 $hash{$method} = { #fk_info
1109 'method' => 'qsearchs',
1110 'column' => $fk->columns->[0],
1111 #'references' => $fk->references->[0],
1119 # foreign keys referenced in other tables to us
1120 # (alas. why we're cached. still, might this loop better be done once at
1121 # schema load time insetad of every time we AUTOLOAD a method on a new
1123 if (! defined $fk_table_cache) {
1124 foreach my $f_table ( dbdef->tables ) {
1125 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1126 push @{$fk_table_cache->{$fk->table}},[$f_table,$fk];
1130 foreach my $fks (@{$fk_table_cache->{$table}}) {
1131 my ($f_table,$fk) = @$fks;
1133 if ( scalar( @{$fk->columns} ) == 1 ) {
1134 if ( ! defined($fk->references)
1135 || ! @{$fk->references}
1136 || $fk->columns->[0] eq $fk->references->[0]
1140 #some sort of hint in the table.pm or schema for methods not named
1141 # after their foreign table (well, not a whole lot different than
1142 # just providing a small subroutine...)
1146 $hash{$method} = { #fk_info
1147 'method' => 'qsearch',
1148 'column' => $fk->columns->[0], #references||column
1149 #'references' => $fk->column->[0],
1161 Returns a list of the column/value pairs, usually for assigning to a new hash.
1163 To make a distinct duplicate of an FS::Record object, you can do:
1165 $new = new FS::Record ( $old->table, { $old->hash } );
1171 confess $self. ' -> hash: Hash attribute is undefined'
1172 unless defined($self->{'Hash'});
1173 %{ $self->{'Hash'} };
1178 Returns a reference to the column/value hash. This may be deprecated in the
1179 future; if there's a reason you can't just use the autoloaded or get/set
1193 +{ ( map { $_=>$self->$_ } $self->fields ),
1198 my( $class, %opt ) = @_;
1199 my $table = $class->table;
1200 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1201 my $error = $self->insert;
1202 return +{ 'error' => $error } if $error;
1203 my $pkey = $self->pkey;
1204 return +{ 'error' => '',
1205 'primary_key' => $pkey,
1206 $pkey => $self->$pkey,
1212 Returns true if any of this object's values have been modified with set (or via
1213 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1220 $self->{'modified'};
1223 =item select_for_update
1225 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1230 sub select_for_update {
1232 my $primary_key = $self->primary_key;
1235 'table' => $self->table,
1236 'hashref' => { $primary_key => $self->$primary_key() },
1237 'extra_sql' => 'FOR UPDATE',
1243 Locks this table with a database-driver specific lock method. This is used
1244 as a mutex in order to do a duplicate search.
1246 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1248 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1250 Errors are fatal; no useful return value.
1252 Note: To use this method for new tables other than svc_acct and svc_phone,
1253 edit freeside-upgrade and add those tables to the duplicate_lock list.
1259 my $table = $self->table;
1261 warn "$me locking $table table\n" if $DEBUG;
1263 if ( driver_name =~ /^Pg/i ) {
1265 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1268 } elsif ( driver_name =~ /^mysql/i ) {
1270 dbh->do("SELECT * FROM duplicate_lock
1271 WHERE lockname = '$table'
1273 ) or die dbh->errstr;
1277 die "unknown database ". driver_name. "; don't know how to lock table";
1281 warn "$me acquired $table table lock\n" if $DEBUG;
1287 Inserts this record to the database. If there is an error, returns the error,
1288 otherwise returns false.
1296 warn "$self -> insert" if $DEBUG;
1298 my $error = $self->check;
1299 return $error if $error;
1301 #single-field non-null unique keys are given a value if empty
1302 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1303 foreach ( $self->dbdef_table->unique_singles) {
1304 next if $self->getfield($_);
1305 next if $self->dbdef_table->column($_)->null eq 'NULL';
1309 #and also the primary key, if the database isn't going to
1310 my $primary_key = $self->dbdef_table->primary_key;
1312 if ( $primary_key ) {
1313 my $col = $self->dbdef_table->column($primary_key);
1316 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1317 || ( driver_name eq 'Pg'
1318 && defined($col->default)
1319 && $col->quoted_default =~ /^nextval\(/i
1321 || ( driver_name eq 'mysql'
1322 && defined($col->local)
1323 && $col->local =~ /AUTO_INCREMENT/i
1325 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1328 my $table = $self->table;
1330 # Encrypt before the database
1331 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1334 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1335 next if $field eq 'payinfo'
1336 && ($self->isa('FS::payinfo_transaction_Mixin')
1337 || $self->isa('FS::payinfo_Mixin') )
1339 && !grep { $self->payby eq $_ } @encrypt_payby;
1340 $saved->{$field} = $self->getfield($field);
1341 $self->setfield($field, $self->encrypt($self->getfield($field)));
1345 #false laziness w/delete
1347 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1350 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1353 my $statement = "INSERT INTO $table ";
1354 if ( @real_fields ) {
1357 join( ', ', @real_fields ).
1359 join( ', ', @values ).
1363 $statement .= 'DEFAULT VALUES';
1365 warn "[debug]$me $statement\n" if $DEBUG > 1;
1366 my $sth = dbh->prepare($statement) or return dbh->errstr;
1368 local $SIG{HUP} = 'IGNORE';
1369 local $SIG{INT} = 'IGNORE';
1370 local $SIG{QUIT} = 'IGNORE';
1371 local $SIG{TERM} = 'IGNORE';
1372 local $SIG{TSTP} = 'IGNORE';
1373 local $SIG{PIPE} = 'IGNORE';
1375 $sth->execute or return $sth->errstr;
1377 # get inserted id from the database, if applicable & needed
1378 if ( $db_seq && ! $self->getfield($primary_key) ) {
1379 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1383 if ( driver_name eq 'Pg' ) {
1385 #my $oid = $sth->{'pg_oid_status'};
1386 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1388 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1389 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1390 dbh->rollback if $FS::UID::AutoCommit;
1391 return "can't parse $table.$primary_key default value".
1392 " for sequence name: $default";
1396 my $i_sql = "SELECT currval('$sequence')";
1397 my $i_sth = dbh->prepare($i_sql) or do {
1398 dbh->rollback if $FS::UID::AutoCommit;
1401 $i_sth->execute() or do { #$i_sth->execute($oid)
1402 dbh->rollback if $FS::UID::AutoCommit;
1403 return $i_sth->errstr;
1405 $insertid = $i_sth->fetchrow_arrayref->[0];
1407 } elsif ( driver_name eq 'mysql' ) {
1409 $insertid = dbh->{'mysql_insertid'};
1410 # work around mysql_insertid being null some of the time, ala RT :/
1411 unless ( $insertid ) {
1412 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1413 "using SELECT LAST_INSERT_ID();";
1414 my $i_sql = "SELECT LAST_INSERT_ID()";
1415 my $i_sth = dbh->prepare($i_sql) or do {
1416 dbh->rollback if $FS::UID::AutoCommit;
1419 $i_sth->execute or do {
1420 dbh->rollback if $FS::UID::AutoCommit;
1421 return $i_sth->errstr;
1423 $insertid = $i_sth->fetchrow_arrayref->[0];
1428 dbh->rollback if $FS::UID::AutoCommit;
1429 return "don't know how to retreive inserted ids from ". driver_name.
1430 ", try using counterfiles (maybe run dbdef-create?)";
1434 $self->setfield($primary_key, $insertid);
1439 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1440 my $h_statement = $self->_h_statement('insert');
1441 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1442 $h_sth = dbh->prepare($h_statement) or do {
1443 dbh->rollback if $FS::UID::AutoCommit;
1449 $h_sth->execute or return $h_sth->errstr if $h_sth;
1451 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1453 # Now that it has been saved, reset the encrypted fields so that $new
1454 # can still be used.
1455 foreach my $field (keys %{$saved}) {
1456 $self->setfield($field, $saved->{$field});
1464 Depriciated (use insert instead).
1469 cluck "warning: FS::Record::add deprecated!";
1470 insert @_; #call method in this scope
1475 Delete this record from the database. If there is an error, returns the error,
1476 otherwise returns false.
1483 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1485 $self->getfield($_) eq ''
1486 #? "( $_ IS NULL OR $_ = \"\" )"
1487 ? ( driver_name eq 'Pg'
1489 : "( $_ IS NULL OR $_ = \"\" )"
1491 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1492 } ( $self->dbdef_table->primary_key )
1493 ? ( $self->dbdef_table->primary_key)
1494 : real_fields($self->table)
1496 warn "[debug]$me $statement\n" if $DEBUG > 1;
1497 my $sth = dbh->prepare($statement) or return dbh->errstr;
1500 if ( defined dbdef->table('h_'. $self->table) ) {
1501 my $h_statement = $self->_h_statement('delete');
1502 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1503 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1508 my $primary_key = $self->dbdef_table->primary_key;
1510 local $SIG{HUP} = 'IGNORE';
1511 local $SIG{INT} = 'IGNORE';
1512 local $SIG{QUIT} = 'IGNORE';
1513 local $SIG{TERM} = 'IGNORE';
1514 local $SIG{TSTP} = 'IGNORE';
1515 local $SIG{PIPE} = 'IGNORE';
1517 my $rc = $sth->execute or return $sth->errstr;
1518 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1519 $h_sth->execute or return $h_sth->errstr if $h_sth;
1521 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1523 #no need to needlessly destoy the data either (causes problems actually)
1524 #undef $self; #no need to keep object!
1531 Depriciated (use delete instead).
1536 cluck "warning: FS::Record::del deprecated!";
1537 &delete(@_); #call method in this scope
1540 =item replace OLD_RECORD
1542 Replace the OLD_RECORD with this one in the database. If there is an error,
1543 returns the error, otherwise returns false.
1548 my ($new, $old) = (shift, shift);
1550 $old = $new->replace_old unless defined($old);
1552 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1554 if ( $new->can('replace_check') ) {
1555 my $error = $new->replace_check($old);
1556 return $error if $error;
1559 return "Records not in same table!" unless $new->table eq $old->table;
1561 my $primary_key = $old->dbdef_table->primary_key;
1562 return "Can't change primary key $primary_key ".
1563 'from '. $old->getfield($primary_key).
1564 ' to ' . $new->getfield($primary_key)
1566 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1568 my $error = $new->check;
1569 return $error if $error;
1571 # Encrypt for replace
1573 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1576 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1577 next if $field eq 'payinfo'
1578 && ($new->isa('FS::payinfo_transaction_Mixin')
1579 || $new->isa('FS::payinfo_Mixin') )
1581 && !grep { $new->payby eq $_ } @encrypt_payby;
1582 $saved->{$field} = $new->getfield($field);
1583 $new->setfield($field, $new->encrypt($new->getfield($field)));
1587 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1588 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1589 ? ($_, $new->getfield($_)) : () } $old->fields;
1591 unless (keys(%diff) || $no_update_diff ) {
1592 carp "[warning]$me ". ref($new)."->replace ".
1593 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1594 ": records identical"
1595 unless $nowarn_identical;
1599 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1601 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1602 } real_fields($old->table)
1607 if ( $old->getfield($_) eq '' ) {
1609 #false laziness w/qsearch
1610 if ( driver_name eq 'Pg' ) {
1611 my $type = $old->dbdef_table->column($_)->type;
1612 if ( $type =~ /(int|(big)?serial)/i ) {
1615 qq-( $_ IS NULL OR $_ = '' )-;
1618 qq-( $_ IS NULL OR $_ = "" )-;
1622 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1625 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1628 warn "[debug]$me $statement\n" if $DEBUG > 1;
1629 my $sth = dbh->prepare($statement) or return dbh->errstr;
1632 if ( defined dbdef->table('h_'. $old->table) ) {
1633 my $h_old_statement = $old->_h_statement('replace_old');
1634 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1635 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1641 if ( defined dbdef->table('h_'. $new->table) ) {
1642 my $h_new_statement = $new->_h_statement('replace_new');
1643 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1644 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1649 local $SIG{HUP} = 'IGNORE';
1650 local $SIG{INT} = 'IGNORE';
1651 local $SIG{QUIT} = 'IGNORE';
1652 local $SIG{TERM} = 'IGNORE';
1653 local $SIG{TSTP} = 'IGNORE';
1654 local $SIG{PIPE} = 'IGNORE';
1656 my $rc = $sth->execute or return $sth->errstr;
1657 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1658 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1659 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1661 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1663 # Now that it has been saved, reset the encrypted fields so that $new
1664 # can still be used.
1665 foreach my $field (keys %{$saved}) {
1666 $new->setfield($field, $saved->{$field});
1674 my( $self ) = shift;
1675 warn "[$me] replace called with no arguments; autoloading old record\n"
1678 my $primary_key = $self->dbdef_table->primary_key;
1679 if ( $primary_key ) {
1680 $self->by_key( $self->$primary_key() ) #this is what's returned
1681 or croak "can't find ". $self->table. ".$primary_key ".
1682 $self->$primary_key();
1684 croak $self->table. " has no primary key; pass old record as argument";
1691 Depriciated (use replace instead).
1696 cluck "warning: FS::Record::rep deprecated!";
1697 replace @_; #call method in this scope
1702 Checks custom fields. Subclasses should still provide a check method to validate
1703 non-custom fields, etc., and call this method via $self->SUPER::check.
1709 foreach my $field ($self->virtual_fields) {
1710 my $error = $self->ut_textn($field);
1711 return $error if $error;
1716 =item virtual_fields [ TABLE ]
1718 Returns a list of virtual fields defined for the table. This should not
1719 be exported, and should only be called as an instance or class method.
1723 sub virtual_fields {
1726 $table = $self->table or confess "virtual_fields called on non-table";
1728 confess "Unknown table $table" unless dbdef->table($table);
1730 return () unless dbdef->table('part_virtual_field');
1732 unless ( $virtual_fields_cache{$table} ) {
1733 my $concat = [ "'cf_'", "name" ];
1734 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1735 "WHERE dbtable = '$table'";
1737 my $result = $dbh->selectcol_arrayref($query);
1738 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1740 $virtual_fields_cache{$table} = $result;
1743 @{$virtual_fields_cache{$table}};
1747 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1749 Processes a batch import as a queued JSRPC job
1751 JOB is an FS::queue entry.
1753 OPTIONS_HASHREF can have the following keys:
1759 Table name (required).
1763 Arrayref of field names for static fields. They will be given values from the
1764 PARAMS hashref and passed as a "params" hashref to batch_import.
1768 Formats hashref. Keys are field names, values are listrefs that define the
1771 Each listref value can be a column name or a code reference. Coderefs are run
1772 with the row object, data and a FS::Conf object as the three parameters.
1773 For example, this coderef does the same thing as using the "columnname" string:
1776 my( $record, $data, $conf ) = @_;
1777 $record->columnname( $data );
1780 Coderefs are run after all "column name" fields are assigned.
1784 Optional format hashref of types. Keys are field names, values are "csv",
1785 "xls" or "fixedlength". Overrides automatic determination of file type
1788 =item format_headers
1790 Optional format hashref of header lines. Keys are field names, values are 0
1791 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1794 =item format_sep_chars
1796 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1797 CSV separation character.
1799 =item format_fixedlenth_formats
1801 Optional format hashref of fixed length format defintiions. Keys are field
1802 names, values Parse::FixedLength listrefs of field definitions.
1806 Set true to default to CSV file type if the filename does not contain a
1807 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1812 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1813 POSTed data. It must contain the field "uploaded files", generated by
1814 /elements/file-upload.html and containing the list of uploaded files.
1815 Currently only supports a single file named "file".
1820 sub process_batch_import {
1821 my($job, $opt, $param) = @_;
1823 my $table = $opt->{table};
1824 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1825 my %formats = %{ $opt->{formats} };
1827 warn Dumper($param) if $DEBUG;
1829 my $files = $param->{'uploaded_files'}
1830 or die "No files provided.\n";
1832 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1834 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1835 my $file = $dir. $files{'file'};
1840 formats => \%formats,
1841 format_types => $opt->{format_types},
1842 format_headers => $opt->{format_headers},
1843 format_sep_chars => $opt->{format_sep_chars},
1844 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1845 format_xml_formats => $opt->{format_xml_formats},
1846 format_asn_formats => $opt->{format_asn_formats},
1847 format_row_callbacks => $opt->{format_row_callbacks},
1848 format_hash_callbacks => $opt->{format_hash_callbacks},
1853 format => $param->{format},
1854 params => { map { $_ => $param->{$_} } @pass_params },
1856 default_csv => $opt->{default_csv},
1857 preinsert_callback => $opt->{preinsert_callback},
1858 postinsert_callback => $opt->{postinsert_callback},
1859 insert_args_callback => $opt->{insert_args_callback},
1862 if ( $opt->{'batch_namecol'} ) {
1863 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1864 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1867 my $error = FS::Record::batch_import( \%iopt );
1871 die "$error\n" if $error;
1874 =item batch_import PARAM_HASHREF
1876 Class method for batch imports. Available params:
1882 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1888 =item format_headers
1890 =item format_sep_chars
1892 =item format_fixedlength_formats
1894 =item format_row_callbacks
1896 =item format_hash_callbacks - After parsing, before object creation
1898 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1900 =item preinsert_callback
1902 =item postinsert_callback
1908 FS::queue object, will be updated with progress
1914 csv, xls, fixedlength, xml
1926 warn "$me batch_import call with params: \n". Dumper($param)
1929 my $table = $param->{table};
1931 my $job = $param->{job};
1932 my $file = $param->{file};
1933 my $params = $param->{params} || {};
1935 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1936 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1938 my( $type, $header, $sep_char,
1939 $fixedlength_format, $xml_format, $asn_format,
1940 $parser_opt, $row_callback, $hash_callback, @fields );
1942 my $postinsert_callback = '';
1943 $postinsert_callback = $param->{'postinsert_callback'}
1944 if $param->{'postinsert_callback'};
1945 my $preinsert_callback = '';
1946 $preinsert_callback = $param->{'preinsert_callback'}
1947 if $param->{'preinsert_callback'};
1948 my $insert_args_callback = '';
1949 $insert_args_callback = $param->{'insert_args_callback'}
1950 if $param->{'insert_args_callback'};
1952 if ( $param->{'format'} ) {
1954 my $format = $param->{'format'};
1955 my $formats = $param->{formats};
1956 die "unknown format $format" unless exists $formats->{ $format };
1958 $type = $param->{'format_types'}
1959 ? $param->{'format_types'}{ $format }
1960 : $param->{type} || 'csv';
1963 $header = $param->{'format_headers'}
1964 ? $param->{'format_headers'}{ $param->{'format'} }
1967 $sep_char = $param->{'format_sep_chars'}
1968 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1971 $fixedlength_format =
1972 $param->{'format_fixedlength_formats'}
1973 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1977 $param->{'format_parser_opts'}
1978 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1982 $param->{'format_xml_formats'}
1983 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1987 $param->{'format_asn_formats'}
1988 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1992 $param->{'format_row_callbacks'}
1993 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1997 $param->{'format_hash_callbacks'}
1998 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
2001 @fields = @{ $formats->{ $format } };
2003 } elsif ( $param->{'fields'} ) {
2005 $type = ''; #infer from filename
2008 $fixedlength_format = '';
2010 $hash_callback = '';
2011 @fields = @{ $param->{'fields'} };
2014 die "neither format nor fields specified";
2017 #my $file = $param->{file};
2020 if ( $file =~ /\.(\w+)$/i ) {
2024 warn "can't parse file type from filename $file; defaulting to CSV";
2028 if $param->{'default_csv'} && $type ne 'xls';
2036 my $asn_header_buffer;
2037 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2039 if ( $type eq 'csv' ) {
2041 $parser_opt->{'binary'} = 1;
2042 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2043 $parser = Text::CSV_XS->new($parser_opt);
2045 } elsif ( $type eq 'fixedlength' ) {
2047 eval "use Parse::FixedLength;";
2049 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2052 die "Unknown file type $type\n";
2055 @buffer = split(/\r?\n/, slurp($file) );
2056 splice(@buffer, 0, ($header || 0) );
2057 $count = scalar(@buffer);
2059 } elsif ( $type eq 'xls' ) {
2061 eval "use Spreadsheet::ParseExcel;";
2064 eval "use DateTime::Format::Excel;";
2065 #for now, just let the error be thrown if it is used, since only CDR
2066 # formats bill_west and troop use it, not other excel-parsing things
2069 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2071 $parser = $excel->{Worksheet}[0]; #first sheet
2073 $count = $parser->{MaxRow} || $parser->{MinRow};
2076 $row = $header || 0;
2078 } elsif ( $type eq 'xml' ) {
2081 eval "use XML::Simple;";
2083 my $xmlrow = $xml_format->{'xmlrow'};
2084 $parser = $xml_format->{'xmlkeys'};
2085 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2086 my $data = XML::Simple::XMLin(
2088 'SuppressEmpty' => '', #sets empty values to ''
2092 $rows = $rows->{$_} foreach @$xmlrow;
2093 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2094 $count = @buffer = @$rows;
2096 } elsif ( $type eq 'asn.1' ) {
2098 eval "use Convert::ASN1";
2101 my $asn = Convert::ASN1->new;
2102 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2104 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2106 my $data = slurp($file);
2107 my $asn_output = $parser->decode( $data )
2108 or return "No ". $asn_format->{'macro'}. " found\n";
2110 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2112 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2113 $count = @buffer = @$rows;
2116 die "Unknown file type $type\n";
2121 local $SIG{HUP} = 'IGNORE';
2122 local $SIG{INT} = 'IGNORE';
2123 local $SIG{QUIT} = 'IGNORE';
2124 local $SIG{TERM} = 'IGNORE';
2125 local $SIG{TSTP} = 'IGNORE';
2126 local $SIG{PIPE} = 'IGNORE';
2128 my $oldAutoCommit = $FS::UID::AutoCommit;
2129 local $FS::UID::AutoCommit = 0;
2132 #my $params = $param->{params} || {};
2133 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2134 my $batch_col = $param->{'batch_keycol'};
2136 my $batch_class = 'FS::'. $param->{'batch_table'};
2137 my $batch = $batch_class->new({
2138 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2140 my $error = $batch->insert;
2142 $dbh->rollback if $oldAutoCommit;
2143 return "can't insert batch record: $error";
2145 #primary key via dbdef? (so the column names don't have to match)
2146 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2148 $params->{ $batch_col } = $batch_value;
2151 #my $job = $param->{job};
2154 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2158 my %hash = %$params;
2159 if ( $type eq 'csv' ) {
2161 last unless scalar(@buffer);
2162 $line = shift(@buffer);
2164 next if $line =~ /^\s*$/; #skip empty lines
2166 $line = &{$row_callback}($line) if $row_callback;
2168 next if $line =~ /^\s*$/; #skip empty lines
2170 $parser->parse($line) or do {
2171 $dbh->rollback if $oldAutoCommit;
2172 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2174 @columns = $parser->fields();
2176 } elsif ( $type eq 'fixedlength' ) {
2178 last unless scalar(@buffer);
2179 $line = shift(@buffer);
2181 @columns = $parser->parse($line);
2183 } elsif ( $type eq 'xls' ) {
2185 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2186 || ! $parser->{Cells}[$row];
2188 my @row = @{ $parser->{Cells}[$row] };
2189 @columns = map $_->{Val}, @row;
2192 #warn $z++. ": $_\n" for @columns;
2194 } elsif ( $type eq 'xml' ) {
2196 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2197 last unless scalar(@buffer);
2198 my $row = shift @buffer;
2199 @columns = @{ $row }{ @$parser };
2201 } elsif ( $type eq 'asn.1' ) {
2203 last unless scalar(@buffer);
2204 my $row = shift @buffer;
2205 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2206 if $asn_format->{row_callback};
2207 foreach my $key ( keys %{ $asn_format->{map} } ) {
2208 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2212 die "Unknown file type $type\n";
2217 foreach my $field ( @fields ) {
2219 my $value = shift @columns;
2221 if ( ref($field) eq 'CODE' ) {
2222 #&{$field}(\%hash, $value);
2223 push @later, $field, $value;
2225 #??? $hash{$field} = $value if length($value);
2226 $hash{$field} = $value if defined($value) && length($value);
2231 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2232 && length($1) == $custnum_length ) {
2233 $hash{custnum} = $2;
2236 %hash = &{$hash_callback}(%hash) if $hash_callback;
2238 #my $table = $param->{table};
2239 my $class = "FS::$table";
2241 my $record = $class->new( \%hash );
2244 while ( scalar(@later) ) {
2245 my $sub = shift @later;
2246 my $data = shift @later;
2248 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2251 $dbh->rollback if $oldAutoCommit;
2252 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2254 last if exists( $param->{skiprow} );
2256 next if exists( $param->{skiprow} );
2258 if ( $preinsert_callback ) {
2259 my $error = &{$preinsert_callback}($record, $param);
2261 $dbh->rollback if $oldAutoCommit;
2262 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2265 next if exists $param->{skiprow} && $param->{skiprow};
2268 my @insert_args = ();
2269 if ( $insert_args_callback ) {
2270 @insert_args = &{$insert_args_callback}($record, $param);
2273 my $error = $record->insert(@insert_args);
2276 $dbh->rollback if $oldAutoCommit;
2277 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2283 if ( $postinsert_callback ) {
2284 my $error = &{$postinsert_callback}($record, $param);
2286 $dbh->rollback if $oldAutoCommit;
2287 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2292 if ( $job && time - $min_sec > $last ) { #progress bar
2293 $job->update_statustext( int(100 * $imported / $count) );
2299 unless ( $imported || $param->{empty_ok} ) {
2300 $dbh->rollback if $oldAutoCommit;
2301 return "Empty file!";
2304 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2311 my( $self, $action, $time ) = @_;
2315 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2318 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2319 real_fields($self->table);
2322 # If we're encrypting then don't store the payinfo in the history
2323 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2324 @fields = grep { $_ ne 'payinfo' } @fields;
2327 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2329 "INSERT INTO h_". $self->table. " ( ".
2330 join(', ', qw(history_date history_usernum history_action), @fields ).
2333 $FS::CurrentUser::CurrentUser->usernum,
2334 dbh->quote($action),
2343 B<Warning>: External use is B<deprecated>.
2345 Replaces COLUMN in record with a unique number, using counters in the
2346 filesystem. Used by the B<insert> method on single-field unique columns
2347 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2348 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2350 Returns the new value.
2355 my($self,$field) = @_;
2356 my($table)=$self->table;
2358 croak "Unique called on field $field, but it is ",
2359 $self->getfield($field),
2361 if $self->getfield($field);
2363 #warn "table $table is tainted" if is_tainted($table);
2364 #warn "field $field is tainted" if is_tainted($field);
2366 my($counter) = new File::CounterFile "$table.$field",0;
2368 my $index = $counter->inc;
2369 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2371 $index =~ /^(\d*)$/;
2374 $self->setfield($field,$index);
2378 =item ut_float COLUMN
2380 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2381 null. If there is an error, returns the error, otherwise returns false.
2386 my($self,$field)=@_ ;
2387 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2388 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2389 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2390 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2391 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2392 $self->setfield($field,$1);
2395 =item ut_floatn COLUMN
2397 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2398 null. If there is an error, returns the error, otherwise returns false.
2402 #false laziness w/ut_ipn
2404 my( $self, $field ) = @_;
2405 if ( $self->getfield($field) =~ /^()$/ ) {
2406 $self->setfield($field,'');
2409 $self->ut_float($field);
2413 =item ut_sfloat COLUMN
2415 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2416 May not be null. If there is an error, returns the error, otherwise returns
2422 my($self,$field)=@_ ;
2423 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2424 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2425 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2426 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2427 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2428 $self->setfield($field,$1);
2431 =item ut_sfloatn COLUMN
2433 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2434 null. If there is an error, returns the error, otherwise returns false.
2439 my( $self, $field ) = @_;
2440 if ( $self->getfield($field) =~ /^()$/ ) {
2441 $self->setfield($field,'');
2444 $self->ut_sfloat($field);
2448 =item ut_snumber COLUMN
2450 Check/untaint signed numeric data (whole numbers). If there is an error,
2451 returns the error, otherwise returns false.
2456 my($self, $field) = @_;
2457 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2458 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2459 $self->setfield($field, "$1$2");
2463 =item ut_snumbern COLUMN
2465 Check/untaint signed numeric data (whole numbers). If there is an error,
2466 returns the error, otherwise returns false.
2471 my($self, $field) = @_;
2472 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2473 or return "Illegal (numeric) $field: ". $self->getfield($field);
2475 return "Illegal (numeric) $field: ". $self->getfield($field)
2478 $self->setfield($field, "$1$2");
2482 =item ut_number COLUMN
2484 Check/untaint simple numeric data (whole numbers). May not be null. If there
2485 is an error, returns the error, otherwise returns false.
2490 my($self,$field)=@_;
2491 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2492 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2493 $self->setfield($field,$1);
2497 =item ut_numbern COLUMN
2499 Check/untaint simple numeric data (whole numbers). May be null. If there is
2500 an error, returns the error, otherwise returns false.
2505 my($self,$field)=@_;
2506 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2507 or return "Illegal (numeric) $field: ". $self->getfield($field);
2508 $self->setfield($field,$1);
2512 =item ut_decimal COLUMN[, DIGITS]
2514 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2515 error, returns the error, otherwise returns false.
2517 =item ut_decimaln COLUMN[, DIGITS]
2519 Check/untaint decimal numbers. May be null. If there is an error, returns
2520 the error, otherwise returns false.
2525 my($self, $field, $digits) = @_;
2527 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2528 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2529 $self->setfield($field, $1);
2534 my($self, $field, $digits) = @_;
2535 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2536 or return "Illegal (decimal) $field: ".$self->getfield($field);
2537 $self->setfield($field, $1);
2541 =item ut_money COLUMN
2543 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2544 is an error, returns the error, otherwise returns false.
2549 my($self,$field)=@_;
2551 if ( $self->getfield($field) eq '' ) {
2552 $self->setfield($field, 0);
2553 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2554 #handle one decimal place without barfing out
2555 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2556 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2557 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2559 return "Illegal (money) $field: ". $self->getfield($field);
2565 =item ut_moneyn COLUMN
2567 Check/untaint monetary numbers. May be negative. If there
2568 is an error, returns the error, otherwise returns false.
2573 my($self,$field)=@_;
2574 if ($self->getfield($field) eq '') {
2575 $self->setfield($field, '');
2578 $self->ut_money($field);
2581 =item ut_currencyn COLUMN
2583 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2584 is an error, returns the error, otherwise returns false.
2589 my($self, $field) = @_;
2590 if ($self->getfield($field) eq '') { #can be null
2591 $self->setfield($field, '');
2594 $self->ut_currency($field);
2597 =item ut_currency COLUMN
2599 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2600 there is an error, returns the error, otherwise returns false.
2605 my($self, $field) = @_;
2606 my $value = uc( $self->getfield($field) );
2607 if ( code2currency($value) ) {
2608 $self->setfield($value);
2610 return "Unknown currency $value";
2616 =item ut_text COLUMN
2618 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2619 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2620 May not be null. If there is an error, returns the error, otherwise returns
2626 my($self,$field)=@_;
2627 #warn "msgcat ". \&msgcat. "\n";
2628 #warn "notexist ". \¬exist. "\n";
2629 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2630 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2631 # see perldoc perluniprops
2632 $self->getfield($field)
2633 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2634 or return gettext('illegal_or_empty_text'). " $field: ".
2635 $self->getfield($field);
2636 $self->setfield($field,$1);
2640 =item ut_textn COLUMN
2642 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2643 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2644 May be null. If there is an error, returns the error, otherwise returns false.
2649 my($self,$field)=@_;
2650 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2651 $self->ut_text($field);
2654 =item ut_alpha COLUMN
2656 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2657 an error, returns the error, otherwise returns false.
2662 my($self,$field)=@_;
2663 $self->getfield($field) =~ /^(\w+)$/
2664 or return "Illegal or empty (alphanumeric) $field: ".
2665 $self->getfield($field);
2666 $self->setfield($field,$1);
2670 =item ut_alphan COLUMN
2672 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2673 error, returns the error, otherwise returns false.
2678 my($self,$field)=@_;
2679 $self->getfield($field) =~ /^(\w*)$/
2680 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2681 $self->setfield($field,$1);
2685 =item ut_alphasn COLUMN
2687 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2688 an error, returns the error, otherwise returns false.
2693 my($self,$field)=@_;
2694 $self->getfield($field) =~ /^([\w ]*)$/
2695 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2696 $self->setfield($field,$1);
2701 =item ut_alpha_lower COLUMN
2703 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2704 there is an error, returns the error, otherwise returns false.
2708 sub ut_alpha_lower {
2709 my($self,$field)=@_;
2710 $self->getfield($field) =~ /[[:upper:]]/
2711 and return "Uppercase characters are not permitted in $field";
2712 $self->ut_alpha($field);
2715 =item ut_phonen COLUMN [ COUNTRY ]
2717 Check/untaint phone numbers. May be null. If there is an error, returns
2718 the error, otherwise returns false.
2720 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2721 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2726 my( $self, $field, $country ) = @_;
2727 return $self->ut_alphan($field) unless defined $country;
2728 my $phonen = $self->getfield($field);
2729 if ( $phonen eq '' ) {
2730 $self->setfield($field,'');
2731 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2733 $phonen = $conf->config('cust_main-default_areacode').$phonen
2734 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2735 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2736 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2737 $phonen = "$1-$2-$3";
2738 $phonen .= " x$4" if $4;
2739 $self->setfield($field,$phonen);
2741 warn "warning: don't know how to check phone numbers for country $country";
2742 return $self->ut_textn($field);
2749 Check/untaint hexadecimal values.
2754 my($self, $field) = @_;
2755 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2756 or return "Illegal (hex) $field: ". $self->getfield($field);
2757 $self->setfield($field, uc($1));
2761 =item ut_hexn COLUMN
2763 Check/untaint hexadecimal values. May be null.
2768 my($self, $field) = @_;
2769 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2770 or return "Illegal (hex) $field: ". $self->getfield($field);
2771 $self->setfield($field, uc($1));
2775 =item ut_mac_addr COLUMN
2777 Check/untaint mac addresses. May be null.
2782 my($self, $field) = @_;
2784 my $mac = $self->get($field);
2787 $self->set($field, $mac);
2789 my $e = $self->ut_hex($field);
2792 return "Illegal (mac address) $field: ". $self->getfield($field)
2793 unless length($self->getfield($field)) == 12;
2799 =item ut_mac_addrn COLUMN
2801 Check/untaint mac addresses. May be null.
2806 my($self, $field) = @_;
2807 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2812 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2818 my( $self, $field ) = @_;
2819 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2820 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2821 or return "Illegal (IP address) $field: ". $self->getfield($field);
2822 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2823 $self->setfield($field, "$1.$2.$3.$4");
2829 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2830 to 127.0.0.1. May be null.
2835 my( $self, $field ) = @_;
2836 if ( $self->getfield($field) =~ /^()$/ ) {
2837 $self->setfield($field,'');
2840 $self->ut_ip($field);
2844 =item ut_ip46 COLUMN
2846 Check/untaint IPv4 or IPv6 address.
2851 my( $self, $field ) = @_;
2852 my $ip = NetAddr::IP->new($self->getfield($field))
2853 or return "Illegal (IP address) $field: ".$self->getfield($field);
2854 $self->setfield($field, lc($ip->addr));
2860 Check/untaint IPv6 or IPv6 address. May be null.
2865 my( $self, $field ) = @_;
2866 if ( $self->getfield($field) =~ /^$/ ) {
2867 $self->setfield($field, '');
2870 $self->ut_ip46($field);
2873 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2875 Check/untaint coordinates.
2876 Accepts the following forms:
2886 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2887 The latter form (that is, the MMM are thousands of minutes) is
2888 assumed if the "MMM" is exactly three digits or two digits > 59.
2890 To be safe, just use the DDD.DDDDD form.
2892 If LOWER or UPPER are specified, then the coordinate is checked
2893 for lower and upper bounds, respectively.
2898 my ($self, $field) = (shift, shift);
2901 if ( $field =~ /latitude/ ) {
2902 $lower = $lat_lower;
2904 } elsif ( $field =~ /longitude/ ) {
2906 $upper = $lon_upper;
2909 my $coord = $self->getfield($field);
2910 my $neg = $coord =~ s/^(-)//;
2912 my ($d, $m, $s) = (0, 0, 0);
2915 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2916 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2917 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2919 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2922 return "Invalid (coordinate with minutes > 59) $field: "
2923 . $self->getfield($field);
2926 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2928 if (defined($lower) and ($coord < $lower)) {
2929 return "Invalid (coordinate < $lower) $field: "
2930 . $self->getfield($field);;
2933 if (defined($upper) and ($coord > $upper)) {
2934 return "Invalid (coordinate > $upper) $field: "
2935 . $self->getfield($field);;
2938 $self->setfield($field, $coord);
2942 return "Invalid (coordinate) $field: " . $self->getfield($field);
2946 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2948 Same as ut_coord, except optionally null.
2954 my ($self, $field) = (shift, shift);
2956 if ($self->getfield($field) =~ /^\s*$/) {
2959 return $self->ut_coord($field, @_);
2964 =item ut_domain COLUMN
2966 Check/untaint host and domain names. May not be null.
2971 my( $self, $field ) = @_;
2972 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2973 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2974 or return "Illegal (hostname) $field: ". $self->getfield($field);
2975 $self->setfield($field,$1);
2979 =item ut_domainn COLUMN
2981 Check/untaint host and domain names. May be null.
2986 my( $self, $field ) = @_;
2987 if ( $self->getfield($field) =~ /^()$/ ) {
2988 $self->setfield($field,'');
2991 $self->ut_domain($field);
2995 =item ut_name COLUMN
2997 Check/untaint proper names; allows alphanumerics, spaces and the following
2998 punctuation: , . - '
3005 my( $self, $field ) = @_;
3006 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
3007 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
3012 $self->setfield($field, $name);
3016 =item ut_namen COLUMN
3018 Check/untaint proper names; allows alphanumerics, spaces and the following
3019 punctuation: , . - '
3026 my( $self, $field ) = @_;
3027 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3028 $self->ut_name($field);
3033 Check/untaint zip codes.
3037 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3040 my( $self, $field, $country ) = @_;
3042 if ( $country eq 'US' ) {
3044 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3045 or return gettext('illegal_zip'). " $field for country $country: ".
3046 $self->getfield($field);
3047 $self->setfield($field, $1);
3049 } elsif ( $country eq 'CA' ) {
3051 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3052 or return gettext('illegal_zip'). " $field for country $country: ".
3053 $self->getfield($field);
3054 $self->setfield($field, "$1 $2");
3058 if ( $self->getfield($field) =~ /^\s*$/
3059 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3062 $self->setfield($field,'');
3064 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3065 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3066 $self->setfield($field,$1);
3074 =item ut_country COLUMN
3076 Check/untaint country codes. Country names are changed to codes, if possible -
3077 see L<Locale::Country>.
3082 my( $self, $field ) = @_;
3083 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3084 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3085 && country2code($1) ) {
3086 $self->setfield($field,uc(country2code($1)));
3089 $self->getfield($field) =~ /^(\w\w)$/
3090 or return "Illegal (country) $field: ". $self->getfield($field);
3091 $self->setfield($field,uc($1));
3095 =item ut_anything COLUMN
3097 Untaints arbitrary data. Be careful.
3102 my( $self, $field ) = @_;
3103 $self->getfield($field) =~ /^(.*)$/s
3104 or return "Illegal $field: ". $self->getfield($field);
3105 $self->setfield($field,$1);
3109 =item ut_enum COLUMN CHOICES_ARRAYREF
3111 Check/untaint a column, supplying all possible choices, like the "enum" type.
3116 my( $self, $field, $choices ) = @_;
3117 foreach my $choice ( @$choices ) {
3118 if ( $self->getfield($field) eq $choice ) {
3119 $self->setfield($field, $choice);
3123 return "Illegal (enum) field $field: ". $self->getfield($field);
3126 =item ut_enumn COLUMN CHOICES_ARRAYREF
3128 Like ut_enum, except the null value is also allowed.
3133 my( $self, $field, $choices ) = @_;
3134 $self->getfield($field)
3135 ? $self->ut_enum($field, $choices)
3139 =item ut_flag COLUMN
3141 Check/untaint a column if it contains either an empty string or 'Y'. This
3142 is the standard form for boolean flags in Freeside.
3147 my( $self, $field ) = @_;
3148 my $value = uc($self->getfield($field));
3149 if ( $value eq '' or $value eq 'Y' ) {
3150 $self->setfield($field, $value);
3153 return "Illegal (flag) field $field: $value";
3156 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3158 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3159 on the column first.
3163 sub ut_foreign_key {
3164 my( $self, $field, $table, $foreign ) = @_;
3165 return $self->ut_number($field) if $no_check_foreign;
3166 qsearchs($table, { $foreign => $self->getfield($field) })
3167 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3168 " in $table.$foreign";
3172 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3174 Like ut_foreign_key, except the null value is also allowed.
3178 sub ut_foreign_keyn {
3179 my( $self, $field, $table, $foreign ) = @_;
3180 $self->getfield($field)
3181 ? $self->ut_foreign_key($field, $table, $foreign)
3185 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3187 Checks this column as an agentnum, taking into account the current users's
3188 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3189 right or rights allowing no agentnum.
3193 sub ut_agentnum_acl {
3194 my( $self, $field ) = (shift, shift);
3195 my $null_acl = scalar(@_) ? shift : [];
3196 $null_acl = [ $null_acl ] unless ref($null_acl);
3198 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3199 return "Illegal agentnum: $error" if $error;
3201 my $curuser = $FS::CurrentUser::CurrentUser;
3203 if ( $self->$field() ) {
3205 return 'Access denied to agent '. $self->$field()
3206 unless $curuser->agentnum($self->$field());
3210 return 'Access denied to global'
3211 unless grep $curuser->access_right($_), @$null_acl;
3219 =item fields [ TABLE ]
3221 This is a wrapper for real_fields. Code that called
3222 fields before should probably continue to call fields.
3227 my $something = shift;
3229 if($something->isa('FS::Record')) {
3230 $table = $something->table;
3232 $table = $something;
3233 #$something = "FS::$table";
3235 return (real_fields($table));
3239 =item encrypt($value)
3241 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3243 Returns the encrypted string.
3245 You should generally not have to worry about calling this, as the system handles this for you.
3250 my ($self, $value) = @_;
3251 my $encrypted = $value;
3253 if ($conf_encryption) {
3254 if ($self->is_encrypted($value)) {
3255 # Return the original value if it isn't plaintext.
3256 $encrypted = $value;
3259 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3260 # RSA doesn't like the empty string so let's pack it up
3261 # The database doesn't like the RSA data so uuencode it
3262 my $length = length($value)+1;
3263 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3265 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3272 =item is_encrypted($value)
3274 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3280 my ($self, $value) = @_;
3281 # could be more precise about it, but this will do for now
3282 $value =~ /^M/ && length($value) > 80;
3285 =item decrypt($value)
3287 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3289 You should generally not have to worry about calling this, as the system handles this for you.
3294 my ($self,$value) = @_;
3295 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3296 if ($conf_encryption && $self->is_encrypted($value)) {
3298 if (ref($rsa_decrypt) =~ /::RSA/) {
3299 my $encrypted = unpack ("u*", $value);
3300 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3301 if ($@) {warn "Decryption Failed"};
3309 #Initialize the Module
3310 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3312 if ($conf_encryptionmodule && $conf_encryptionmodule ne '') {
3313 $rsa_module = $conf_encryptionmodule;
3317 eval ("require $rsa_module"); # No need to import the namespace
3320 # Initialize Encryption
3321 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3322 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3325 # Intitalize Decryption
3326 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3327 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3331 =item h_search ACTION
3333 Given an ACTION, either "insert", or "delete", returns the appropriate history
3334 record corresponding to this record, if any.
3339 my( $self, $action ) = @_;
3341 my $table = $self->table;
3344 my $primary_key = dbdef->table($table)->primary_key;
3347 'table' => "h_$table",
3348 'hashref' => { $primary_key => $self->$primary_key(),
3349 'history_action' => $action,
3357 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3358 appropriate history record corresponding to this record, if any.
3363 my($self, $action) = @_;
3364 my $h = $self->h_search($action);
3365 $h ? $h->history_date : '';
3368 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3370 A class or object method. Executes the sql statement represented by SQL and
3371 returns a scalar representing the result: the first column of the first row.
3373 Dies on bogus SQL. Returns an empty string if no row is returned.
3375 Typically used for statments which return a single value such as "SELECT
3376 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3381 my($self, $sql) = (shift, shift);
3382 my $sth = dbh->prepare($sql) or die dbh->errstr;
3384 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3385 my $row = $sth->fetchrow_arrayref or return '';
3386 my $scalar = $row->[0];
3387 defined($scalar) ? $scalar : '';
3390 =item count [ WHERE [, PLACEHOLDER ...] ]
3392 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3393 with optional WHERE. Must be called as method on a class with an
3399 my($self, $where) = (shift, shift);
3400 my $table = $self->table or die 'count called on object of class '.ref($self);
3401 my $sql = "SELECT COUNT(*) FROM $table";
3402 $sql .= " WHERE $where" if $where;
3403 $self->scalar_sql($sql, @_);
3406 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3408 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3409 with optional (but almost always needed) WHERE.
3414 my($self, $where) = (shift, shift);
3415 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3416 my $sql = "SELECT 1 FROM $table";
3417 $sql .= " WHERE $where" if $where;
3419 $self->scalar_sql($sql, @_);
3428 =item real_fields [ TABLE ]
3430 Returns a list of the real columns in the specified table. Called only by
3431 fields() and other subroutines elsewhere in FS::Record.
3438 my($table_obj) = dbdef->table($table);
3439 confess "Unknown table $table" unless $table_obj;
3440 $table_obj->columns;
3443 =item pvf FIELD_NAME
3445 Returns the FS::part_virtual_field object corresponding to a field in the
3446 record (specified by FIELD_NAME).
3451 my ($self, $name) = (shift, shift);
3453 if(grep /^$name$/, $self->virtual_fields) {
3455 my $concat = [ "'cf_'", "name" ];
3456 return qsearchs({ table => 'part_virtual_field',
3457 hashref => { dbtable => $self->table,
3460 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3466 =item _quote VALUE, TABLE, COLUMN
3468 This is an internal function used to construct SQL statements. It returns
3469 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3470 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3475 my($value, $table, $column) = @_;
3476 my $column_obj = dbdef->table($table)->column($column);
3477 my $column_type = $column_obj->type;
3478 my $nullable = $column_obj->null;
3480 utf8::upgrade($value);
3482 warn " $table.$column: $value ($column_type".
3483 ( $nullable ? ' NULL' : ' NOT NULL' ).
3484 ")\n" if $DEBUG > 2;
3486 if ( $value eq '' && $nullable ) {
3488 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3489 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3492 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3493 ! $column_type =~ /(char|binary|text)$/i ) {
3495 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3496 && driver_name eq 'Pg'
3500 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3501 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3502 # single-quote the whole mess, and put an "E" in front.
3503 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3511 This is deprecated. Don't use it.
3513 It returns a hash-type list with the fields of this record's table set true.
3518 carp "warning: hfields is deprecated";
3521 foreach (fields($table)) {
3530 "$_: ". $self->getfield($_). "|"
3531 } (fields($self->table)) );
3534 sub DESTROY { return; }
3538 # #use Carp qw(cluck);
3539 # #cluck "DESTROYING $self";
3540 # warn "DESTROYING $self";
3544 # return ! eval { join('',@_), kill 0; 1; };
3547 =item str2time_sql [ DRIVER_NAME ]
3549 Returns a function to convert to unix time based on database type, such as
3550 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3551 the str2time_sql_closing method to return a closing string rather than just
3552 using a closing parenthesis as previously suggested.
3554 You can pass an optional driver name such as "Pg", "mysql" or
3555 $dbh->{Driver}->{Name} to return a function for that database instead of
3556 the current database.
3561 my $driver = shift || driver_name;
3563 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3564 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3566 warn "warning: unknown database type $driver; guessing how to convert ".
3567 "dates to UNIX timestamps";
3568 return 'EXTRACT(EPOCH FROM ';
3572 =item str2time_sql_closing [ DRIVER_NAME ]
3574 Returns the closing suffix of a function to convert to unix time based on
3575 database type, such as ")::integer" for Pg or ")" for mysql.
3577 You can pass an optional driver name such as "Pg", "mysql" or
3578 $dbh->{Driver}->{Name} to return a function for that database instead of
3579 the current database.
3583 sub str2time_sql_closing {
3584 my $driver = shift || driver_name;
3586 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3590 =item regexp_sql [ DRIVER_NAME ]
3592 Returns the operator to do a regular expression comparison based on database
3593 type, such as '~' for Pg or 'REGEXP' for mysql.
3595 You can pass an optional driver name such as "Pg", "mysql" or
3596 $dbh->{Driver}->{Name} to return a function for that database instead of
3597 the current database.
3602 my $driver = shift || driver_name;
3604 return '~' if $driver =~ /^Pg/i;
3605 return 'REGEXP' if $driver =~ /^mysql/i;
3607 die "don't know how to use regular expressions in ". driver_name." databases";
3611 =item not_regexp_sql [ DRIVER_NAME ]
3613 Returns the operator to do a regular expression negation based on database
3614 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3616 You can pass an optional driver name such as "Pg", "mysql" or
3617 $dbh->{Driver}->{Name} to return a function for that database instead of
3618 the current database.
3622 sub not_regexp_sql {
3623 my $driver = shift || driver_name;
3625 return '!~' if $driver =~ /^Pg/i;
3626 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3628 die "don't know how to use regular expressions in ". driver_name." databases";
3632 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3634 Returns the items concatenated based on database type, using "CONCAT()" for
3635 mysql and " || " for Pg and other databases.
3637 You can pass an optional driver name such as "Pg", "mysql" or
3638 $dbh->{Driver}->{Name} to return a function for that database instead of
3639 the current database.
3644 my $driver = ref($_[0]) ? driver_name : shift;
3647 if ( $driver =~ /^mysql/i ) {
3648 'CONCAT('. join(',', @$items). ')';
3650 join('||', @$items);
3655 =item group_concat_sql COLUMN, DELIMITER
3657 Returns an SQL expression to concatenate an aggregate column, using
3658 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3662 sub group_concat_sql {
3663 my ($col, $delim) = @_;
3664 $delim = dbh->quote($delim);
3665 if ( driver_name() =~ /^mysql/i ) {
3666 # DISTINCT(foo) is valid as $col
3667 return "GROUP_CONCAT($col SEPARATOR $delim)";
3669 return "array_to_string(array_agg($col), $delim)";
3673 =item midnight_sql DATE
3675 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3676 on that day in the system timezone, using the default driver name.
3681 my $driver = driver_name;
3683 if ( $driver =~ /^mysql/i ) {
3684 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3687 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3695 This module should probably be renamed, since much of the functionality is
3696 of general use. It is not completely unlike Adapter::DBI (see below).
3698 Exported qsearch and qsearchs should be deprecated in favor of method calls
3699 (against an FS::Record object like the old search and searchs that qsearch
3700 and qsearchs were on top of.)
3702 The whole fields / hfields mess should be removed.
3704 The various WHERE clauses should be subroutined.
3706 table string should be deprecated in favor of DBIx::DBSchema::Table.
3708 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3709 true maps to the database (and WHERE clauses) would also help.
3711 The ut_ methods should ask the dbdef for a default length.
3713 ut_sqltype (like ut_varchar) should all be defined
3715 A fallback check method should be provided which uses the dbdef.
3717 The ut_money method assumes money has two decimal digits.
3719 The Pg money kludge in the new method only strips `$'.
3721 The ut_phonen method only checks US-style phone numbers.
3723 The _quote function should probably use ut_float instead of a regex.
3725 All the subroutines probably should be methods, here or elsewhere.
3727 Probably should borrow/use some dbdef methods where appropriate (like sub
3730 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3731 or allow it to be set. Working around it is ugly any way around - DBI should
3732 be fixed. (only affects RDBMS which return uppercase column names)
3734 ut_zip should take an optional country like ut_phone.
3738 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3740 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.