2 use base qw( Exporter );
7 %virtual_fields_cache %fk_method_cache $fk_table_cache
8 $money_char $lat_lower $lon_upper
10 use Carp qw(carp cluck croak confess);
11 use Scalar::Util qw( blessed );
12 use File::Slurp qw( slurp );
13 use File::CounterFile;
15 use DBI qw(:sql_types);
16 use DBIx::DBSchema 0.43; #0.43 for foreign keys
19 use NetAddr::IP; # for validation
20 use FS::UID qw(dbh datasrc driver_name);
22 use FS::Schema qw(dbdef);
24 use FS::Msgcat qw(gettext);
25 #use FS::Conf; #dependency loop bs, in install_callback below instead
27 use FS::part_virtual_field;
31 our @encrypt_payby = qw( CARD DCRD CHEK DCHK );
33 #export dbdef for now... everything else expects to find it here
35 dbh fields hfields qsearch qsearchs dbdef jsearch
36 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql
37 concat_sql group_concat_sql
38 midnight_sql fk_methods_init
42 our $me = '[FS::Record]';
44 our $nowarn_identical = 0;
45 our $nowarn_classload = 0;
46 our $no_update_diff = 0;
49 our $qsearch_qualify_columns = 1;
51 our $no_check_foreign = 1; #well, not inefficiently in perl by default anymore
59 our $conf_encryption = '';
60 our $conf_encryptionmodule = '';
61 our $conf_encryptionpublickey = '';
62 our $conf_encryptionprivatekey = '';
63 FS::UID->install_callback( sub {
67 $conf = FS::Conf->new;
68 $conf_encryption = $conf->exists('encryption');
69 $conf_encryptionmodule = $conf->config('encryptionmodule');
70 $conf_encryptionpublickey = join("\n",$conf->config('encryptionpublickey'));
71 $conf_encryptionprivatekey = join("\n",$conf->config('encryptionprivatekey'));
72 $money_char = $conf->config('money_char') || '$';
73 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
74 $lat_lower = $nw_coords ? 1 : -90;
75 $lon_upper = $nw_coords ? -1 : 180;
77 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
79 if ( driver_name eq 'Pg' ) {
80 eval "use DBD::Pg ':pg_types'";
83 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
92 FS::Record - Database record objects
97 use FS::Record qw(dbh fields qsearch qsearchs);
99 $record = new FS::Record 'table', \%hash;
100 $record = new FS::Record 'table', { 'column' => 'value', ... };
102 $record = qsearchs FS::Record 'table', \%hash;
103 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
104 @records = qsearch FS::Record 'table', \%hash;
105 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
107 $table = $record->table;
108 $dbdef_table = $record->dbdef_table;
110 $value = $record->get('column');
111 $value = $record->getfield('column');
112 $value = $record->column;
114 $record->set( 'column' => 'value' );
115 $record->setfield( 'column' => 'value' );
116 $record->column('value');
118 %hash = $record->hash;
120 $hashref = $record->hashref;
122 $error = $record->insert;
124 $error = $record->delete;
126 $error = $new_record->replace($old_record);
128 # external use deprecated - handled by the database (at least for Pg, mysql)
129 $value = $record->unique('column');
131 $error = $record->ut_float('column');
132 $error = $record->ut_floatn('column');
133 $error = $record->ut_number('column');
134 $error = $record->ut_numbern('column');
135 $error = $record->ut_decimal('column');
136 $error = $record->ut_decimaln('column');
137 $error = $record->ut_snumber('column');
138 $error = $record->ut_snumbern('column');
139 $error = $record->ut_money('column');
140 $error = $record->ut_text('column');
141 $error = $record->ut_textn('column');
142 $error = $record->ut_alpha('column');
143 $error = $record->ut_alphan('column');
144 $error = $record->ut_phonen('column');
145 $error = $record->ut_anything('column');
146 $error = $record->ut_name('column');
148 $quoted_value = _quote($value,'table','field');
151 $fields = hfields('table');
152 if ( $fields->{Field} ) { # etc.
154 @fields = fields 'table'; #as a subroutine
155 @fields = $record->fields; #as a method call
160 (Mostly) object-oriented interface to database records. Records are currently
161 implemented on top of DBI. FS::Record is intended as a base class for
162 table-specific classes to inherit from, i.e. FS::cust_main.
168 =item new [ TABLE, ] HASHREF
170 Creates a new record. It doesn't store it in the database, though. See
171 L<"insert"> for that.
173 Note that the object stores this hash reference, not a distinct copy of the
174 hash it points to. You can ask the object for a copy with the I<hash>
177 TABLE can only be omitted when a dervived class overrides the table method.
183 my $class = ref($proto) || $proto;
185 bless ($self, $class);
187 unless ( defined ( $self->table ) ) {
188 $self->{'Table'} = shift;
189 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
190 unless $nowarn_classload;
193 $self->{'Hash'} = shift;
195 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
196 $self->{'Hash'}{$field}='';
199 $self->_rebless if $self->can('_rebless');
201 $self->{'modified'} = 0;
203 $self->_simplecache($self->{'Hash'}) if $self->can('_simplecache');
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 AUTOLOADED 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 if ( my $fk_info = get_fk_method($self->table, $field) ) {
1015 my $method = $fk_info->{method} || 'qsearchs';
1016 my $table = $fk_info->{table} || $field;
1017 my $column = $fk_info->{column};
1018 my $foreign_column = $fk_info->{references} || $column;
1020 eval "use FS::$table";
1023 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1025 my $pkey_value = $self->$column();
1026 my %search = ( $foreign_column => $pkey_value );
1028 # FS::Record->$method() ? they're actually just subs :/
1029 if ( $method eq 'qsearchs' ) {
1030 return $pkey_value ? qsearchs( $table, \%search ) : '';
1031 } elsif ( $method eq 'qsearch' ) {
1032 return $pkey_value ? qsearch( $table, \%search ) : ();
1034 die "unknown method $method";
1039 if ( defined($value) ) {
1040 $self->setfield($field,$value);
1042 $self->getfield($field);
1046 # efficient (also, old, doesn't support FK stuff)
1048 # my $field = $AUTOLOAD;
1049 # $field =~ s/.*://;
1050 # if ( defined($_[1]) ) {
1051 # $_[0]->setfield($field, $_[1]);
1053 # $_[0]->getfield($field);
1057 # get_fk_method(TABLE, FIELD)
1058 # Internal subroutine for fetching the foreign key descriptor for TABLE.FIELD
1059 # if there is one. If not, returns undef.
1060 # This will initialize fk_method_cache if it hasn't happened yet. It is the
1061 # _only_ allowed way to access the contents of %fk_method_cache.
1063 # if we wanted to be even more efficient we'd create the fk methods in the
1064 # symbol table instead of relying on AUTOLOAD every time
1067 my ($table, $field) = @_;
1069 fk_methods_init() unless exists($fk_method_cache{$table});
1071 if ( exists($fk_method_cache{$table}) and
1072 exists($fk_method_cache{$table}{$field}) ) {
1073 return $fk_method_cache{$table}{$field};
1080 sub fk_methods_init {
1081 warn "[fk_methods_init]\n" if $DEBUG;
1082 foreach my $table ( dbdef->tables ) {
1083 $fk_method_cache{$table} = fk_methods($table);
1092 # foreign keys we reference in other tables
1093 foreach my $fk (dbdef->table($table)->foreign_keys) {
1096 if ( scalar( @{$fk->columns} ) == 1 ) {
1097 if ( ! defined($fk->references)
1098 || ! @{$fk->references}
1099 || $fk->columns->[0] eq $fk->references->[0]
1101 $method = $fk->table;
1103 #some sort of hint in the table.pm or schema for methods not named
1104 # after their foreign table (well, not a whole lot different than
1105 # just providing a small subroutine...)
1109 $hash{$method} = { #fk_info
1110 'method' => 'qsearchs',
1111 'column' => $fk->columns->[0],
1112 #'references' => $fk->references->[0],
1120 # foreign keys referenced in other tables to us
1121 # (alas. why we're cached. still, might this loop better be done once at
1122 # schema load time insetad of every time we AUTOLOAD a method on a new
1124 if (! defined $fk_table_cache) {
1125 foreach my $f_table ( dbdef->tables ) {
1126 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1127 push @{$fk_table_cache->{$fk->table}},[$f_table,$fk];
1131 foreach my $fks (@{$fk_table_cache->{$table}}) {
1132 my ($f_table,$fk) = @$fks;
1134 if ( scalar( @{$fk->columns} ) == 1 ) {
1135 if ( ! defined($fk->references)
1136 || ! @{$fk->references}
1137 || $fk->columns->[0] eq $fk->references->[0]
1141 #some sort of hint in the table.pm or schema for methods not named
1142 # after their foreign table (well, not a whole lot different than
1143 # just providing a small subroutine...)
1147 $hash{$method} = { #fk_info
1148 'method' => 'qsearch',
1149 'column' => $fk->columns->[0], #references||column
1150 #'references' => $fk->column->[0],
1162 Returns a list of the column/value pairs, usually for assigning to a new hash.
1164 To make a distinct duplicate of an FS::Record object, you can do:
1166 $new = new FS::Record ( $old->table, { $old->hash } );
1172 confess $self. ' -> hash: Hash attribute is undefined'
1173 unless defined($self->{'Hash'});
1174 %{ $self->{'Hash'} };
1179 Returns a reference to the column/value hash. This may be deprecated in the
1180 future; if there's a reason you can't just use the autoloaded or get/set
1194 +{ ( map { $_=>$self->$_ } $self->fields ),
1199 my( $class, %opt ) = @_;
1200 my $table = $class->table;
1201 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1202 my $error = $self->insert;
1203 return +{ 'error' => $error } if $error;
1204 my $pkey = $self->pkey;
1205 return +{ 'error' => '',
1206 'primary_key' => $pkey,
1207 $pkey => $self->$pkey,
1213 Returns true if any of this object's values have been modified with set (or via
1214 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1221 $self->{'modified'};
1224 =item select_for_update
1226 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1231 sub select_for_update {
1233 my $primary_key = $self->primary_key;
1236 'table' => $self->table,
1237 'hashref' => { $primary_key => $self->$primary_key() },
1238 'extra_sql' => 'FOR UPDATE',
1244 Locks this table with a database-driver specific lock method. This is used
1245 as a mutex in order to do a duplicate search.
1247 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1249 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1251 Errors are fatal; no useful return value.
1253 Note: To use this method for new tables other than svc_acct and svc_phone,
1254 edit freeside-upgrade and add those tables to the duplicate_lock list.
1260 my $table = $self->table;
1262 warn "$me locking $table table\n" if $DEBUG;
1264 if ( driver_name =~ /^Pg/i ) {
1266 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1269 } elsif ( driver_name =~ /^mysql/i ) {
1271 dbh->do("SELECT * FROM duplicate_lock
1272 WHERE lockname = '$table'
1274 ) or die dbh->errstr;
1278 die "unknown database ". driver_name. "; don't know how to lock table";
1282 warn "$me acquired $table table lock\n" if $DEBUG;
1288 Inserts this record to the database. If there is an error, returns the error,
1289 otherwise returns false.
1297 warn "$self -> insert" if $DEBUG;
1299 my $error = $self->check;
1300 return $error if $error;
1302 #single-field non-null unique keys are given a value if empty
1303 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1304 foreach ( $self->dbdef_table->unique_singles) {
1305 next if $self->getfield($_);
1306 next if $self->dbdef_table->column($_)->null eq 'NULL';
1310 #and also the primary key, if the database isn't going to
1311 my $primary_key = $self->dbdef_table->primary_key;
1313 if ( $primary_key ) {
1314 my $col = $self->dbdef_table->column($primary_key);
1317 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1318 || ( driver_name eq 'Pg'
1319 && defined($col->default)
1320 && $col->quoted_default =~ /^nextval\(/i
1322 || ( driver_name eq 'mysql'
1323 && defined($col->local)
1324 && $col->local =~ /AUTO_INCREMENT/i
1326 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1329 my $table = $self->table;
1331 # Encrypt before the database
1332 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1335 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1336 next if $field eq 'payinfo'
1337 && ($self->isa('FS::payinfo_transaction_Mixin')
1338 || $self->isa('FS::payinfo_Mixin') )
1340 && !grep { $self->payby eq $_ } @encrypt_payby;
1341 $saved->{$field} = $self->getfield($field);
1342 $self->setfield($field, $self->encrypt($self->getfield($field)));
1346 #false laziness w/delete
1348 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1351 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1354 my $statement = "INSERT INTO $table ";
1355 if ( @real_fields ) {
1358 join( ', ', @real_fields ).
1360 join( ', ', @values ).
1364 $statement .= 'DEFAULT VALUES';
1366 warn "[debug]$me $statement\n" if $DEBUG > 1;
1367 my $sth = dbh->prepare($statement) or return dbh->errstr;
1369 local $SIG{HUP} = 'IGNORE';
1370 local $SIG{INT} = 'IGNORE';
1371 local $SIG{QUIT} = 'IGNORE';
1372 local $SIG{TERM} = 'IGNORE';
1373 local $SIG{TSTP} = 'IGNORE';
1374 local $SIG{PIPE} = 'IGNORE';
1376 $sth->execute or return $sth->errstr;
1378 # get inserted id from the database, if applicable & needed
1379 if ( $db_seq && ! $self->getfield($primary_key) ) {
1380 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1384 if ( driver_name eq 'Pg' ) {
1386 #my $oid = $sth->{'pg_oid_status'};
1387 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1389 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1390 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1391 dbh->rollback if $FS::UID::AutoCommit;
1392 return "can't parse $table.$primary_key default value".
1393 " for sequence name: $default";
1397 my $i_sql = "SELECT currval('$sequence')";
1398 my $i_sth = dbh->prepare($i_sql) or do {
1399 dbh->rollback if $FS::UID::AutoCommit;
1402 $i_sth->execute() or do { #$i_sth->execute($oid)
1403 dbh->rollback if $FS::UID::AutoCommit;
1404 return $i_sth->errstr;
1406 $insertid = $i_sth->fetchrow_arrayref->[0];
1408 } elsif ( driver_name eq 'mysql' ) {
1410 $insertid = dbh->{'mysql_insertid'};
1411 # work around mysql_insertid being null some of the time, ala RT :/
1412 unless ( $insertid ) {
1413 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1414 "using SELECT LAST_INSERT_ID();";
1415 my $i_sql = "SELECT LAST_INSERT_ID()";
1416 my $i_sth = dbh->prepare($i_sql) or do {
1417 dbh->rollback if $FS::UID::AutoCommit;
1420 $i_sth->execute or do {
1421 dbh->rollback if $FS::UID::AutoCommit;
1422 return $i_sth->errstr;
1424 $insertid = $i_sth->fetchrow_arrayref->[0];
1429 dbh->rollback if $FS::UID::AutoCommit;
1430 return "don't know how to retreive inserted ids from ". driver_name.
1431 ", try using counterfiles (maybe run dbdef-create?)";
1435 $self->setfield($primary_key, $insertid);
1440 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1441 my $h_statement = $self->_h_statement('insert');
1442 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1443 $h_sth = dbh->prepare($h_statement) or do {
1444 dbh->rollback if $FS::UID::AutoCommit;
1450 $h_sth->execute or return $h_sth->errstr if $h_sth;
1452 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1454 # Now that it has been saved, reset the encrypted fields so that $new
1455 # can still be used.
1456 foreach my $field (keys %{$saved}) {
1457 $self->setfield($field, $saved->{$field});
1465 Depriciated (use insert instead).
1470 cluck "warning: FS::Record::add deprecated!";
1471 insert @_; #call method in this scope
1476 Delete this record from the database. If there is an error, returns the error,
1477 otherwise returns false.
1484 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1486 $self->getfield($_) eq ''
1487 #? "( $_ IS NULL OR $_ = \"\" )"
1488 ? ( driver_name eq 'Pg'
1490 : "( $_ IS NULL OR $_ = \"\" )"
1492 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1493 } ( $self->dbdef_table->primary_key )
1494 ? ( $self->dbdef_table->primary_key)
1495 : real_fields($self->table)
1497 warn "[debug]$me $statement\n" if $DEBUG > 1;
1498 my $sth = dbh->prepare($statement) or return dbh->errstr;
1501 if ( defined dbdef->table('h_'. $self->table) ) {
1502 my $h_statement = $self->_h_statement('delete');
1503 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1504 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1509 my $primary_key = $self->dbdef_table->primary_key;
1511 local $SIG{HUP} = 'IGNORE';
1512 local $SIG{INT} = 'IGNORE';
1513 local $SIG{QUIT} = 'IGNORE';
1514 local $SIG{TERM} = 'IGNORE';
1515 local $SIG{TSTP} = 'IGNORE';
1516 local $SIG{PIPE} = 'IGNORE';
1518 my $rc = $sth->execute or return $sth->errstr;
1519 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1520 $h_sth->execute or return $h_sth->errstr if $h_sth;
1522 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1524 #no need to needlessly destoy the data either (causes problems actually)
1525 #undef $self; #no need to keep object!
1532 Depriciated (use delete instead).
1537 cluck "warning: FS::Record::del deprecated!";
1538 &delete(@_); #call method in this scope
1541 =item replace OLD_RECORD
1543 Replace the OLD_RECORD with this one in the database. If there is an error,
1544 returns the error, otherwise returns false.
1549 my ($new, $old) = (shift, shift);
1551 $old = $new->replace_old unless defined($old);
1553 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1555 if ( $new->can('replace_check') ) {
1556 my $error = $new->replace_check($old);
1557 return $error if $error;
1560 return "Records not in same table!" unless $new->table eq $old->table;
1562 my $primary_key = $old->dbdef_table->primary_key;
1563 return "Can't change primary key $primary_key ".
1564 'from '. $old->getfield($primary_key).
1565 ' to ' . $new->getfield($primary_key)
1567 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1569 my $error = $new->check;
1570 return $error if $error;
1572 # Encrypt for replace
1574 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1577 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1578 next if $field eq 'payinfo'
1579 && ($new->isa('FS::payinfo_transaction_Mixin')
1580 || $new->isa('FS::payinfo_Mixin') )
1582 && !grep { $new->payby eq $_ } @encrypt_payby;
1583 $saved->{$field} = $new->getfield($field);
1584 $new->setfield($field, $new->encrypt($new->getfield($field)));
1588 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1589 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1590 ? ($_, $new->getfield($_)) : () } $old->fields;
1592 unless (keys(%diff) || $no_update_diff ) {
1593 carp "[warning]$me ". ref($new)."->replace ".
1594 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1595 ": records identical"
1596 unless $nowarn_identical;
1600 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1602 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1603 } real_fields($old->table)
1608 if ( $old->getfield($_) eq '' ) {
1610 #false laziness w/qsearch
1611 if ( driver_name eq 'Pg' ) {
1612 my $type = $old->dbdef_table->column($_)->type;
1613 if ( $type =~ /(int|(big)?serial)/i ) {
1616 qq-( $_ IS NULL OR $_ = '' )-;
1619 qq-( $_ IS NULL OR $_ = "" )-;
1623 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1626 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1629 warn "[debug]$me $statement\n" if $DEBUG > 1;
1630 my $sth = dbh->prepare($statement) or return dbh->errstr;
1633 if ( defined dbdef->table('h_'. $old->table) ) {
1634 my $h_old_statement = $old->_h_statement('replace_old');
1635 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1636 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1642 if ( defined dbdef->table('h_'. $new->table) ) {
1643 my $h_new_statement = $new->_h_statement('replace_new');
1644 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1645 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1650 local $SIG{HUP} = 'IGNORE';
1651 local $SIG{INT} = 'IGNORE';
1652 local $SIG{QUIT} = 'IGNORE';
1653 local $SIG{TERM} = 'IGNORE';
1654 local $SIG{TSTP} = 'IGNORE';
1655 local $SIG{PIPE} = 'IGNORE';
1657 my $rc = $sth->execute or return $sth->errstr;
1658 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1659 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1660 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1662 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1664 # Now that it has been saved, reset the encrypted fields so that $new
1665 # can still be used.
1666 foreach my $field (keys %{$saved}) {
1667 $new->setfield($field, $saved->{$field});
1675 my( $self ) = shift;
1676 warn "[$me] replace called with no arguments; autoloading old record\n"
1679 my $primary_key = $self->dbdef_table->primary_key;
1680 if ( $primary_key ) {
1681 $self->by_key( $self->$primary_key() ) #this is what's returned
1682 or croak "can't find ". $self->table. ".$primary_key ".
1683 $self->$primary_key();
1685 croak $self->table. " has no primary key; pass old record as argument";
1692 Depriciated (use replace instead).
1697 cluck "warning: FS::Record::rep deprecated!";
1698 replace @_; #call method in this scope
1703 Checks custom fields. Subclasses should still provide a check method to validate
1704 non-custom fields, etc., and call this method via $self->SUPER::check.
1710 foreach my $field ($self->virtual_fields) {
1711 my $error = $self->ut_textn($field);
1712 return $error if $error;
1717 =item virtual_fields [ TABLE ]
1719 Returns a list of virtual fields defined for the table. This should not
1720 be exported, and should only be called as an instance or class method.
1724 sub virtual_fields {
1727 $table = $self->table or confess "virtual_fields called on non-table";
1729 confess "Unknown table $table" unless dbdef->table($table);
1731 return () unless dbdef->table('part_virtual_field');
1733 unless ( $virtual_fields_cache{$table} ) {
1734 my $concat = [ "'cf_'", "name" ];
1735 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1736 "WHERE dbtable = '$table'";
1738 my $result = $dbh->selectcol_arrayref($query);
1739 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1741 $virtual_fields_cache{$table} = $result;
1744 @{$virtual_fields_cache{$table}};
1748 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1750 Processes a batch import as a queued JSRPC job
1752 JOB is an FS::queue entry.
1754 OPTIONS_HASHREF can have the following keys:
1760 Table name (required).
1764 Arrayref of field names for static fields. They will be given values from the
1765 PARAMS hashref and passed as a "params" hashref to batch_import.
1769 Formats hashref. Keys are field names, values are listrefs that define the
1772 Each listref value can be a column name or a code reference. Coderefs are run
1773 with the row object, data and a FS::Conf object as the three parameters.
1774 For example, this coderef does the same thing as using the "columnname" string:
1777 my( $record, $data, $conf ) = @_;
1778 $record->columnname( $data );
1781 Coderefs are run after all "column name" fields are assigned.
1785 Optional format hashref of types. Keys are field names, values are "csv",
1786 "xls" or "fixedlength". Overrides automatic determination of file type
1789 =item format_headers
1791 Optional format hashref of header lines. Keys are field names, values are 0
1792 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1795 =item format_sep_chars
1797 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1798 CSV separation character.
1800 =item format_fixedlenth_formats
1802 Optional format hashref of fixed length format defintiions. Keys are field
1803 names, values Parse::FixedLength listrefs of field definitions.
1807 Set true to default to CSV file type if the filename does not contain a
1808 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1813 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1814 POSTed data. It must contain the field "uploaded files", generated by
1815 /elements/file-upload.html and containing the list of uploaded files.
1816 Currently only supports a single file named "file".
1821 sub process_batch_import {
1822 my($job, $opt, $param) = @_;
1824 my $table = $opt->{table};
1825 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1826 my %formats = %{ $opt->{formats} };
1828 warn Dumper($param) if $DEBUG;
1830 my $files = $param->{'uploaded_files'}
1831 or die "No files provided.\n";
1833 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1835 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1836 my $file = $dir. $files{'file'};
1841 formats => \%formats,
1842 format_types => $opt->{format_types},
1843 format_headers => $opt->{format_headers},
1844 format_sep_chars => $opt->{format_sep_chars},
1845 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1846 format_xml_formats => $opt->{format_xml_formats},
1847 format_asn_formats => $opt->{format_asn_formats},
1848 format_row_callbacks => $opt->{format_row_callbacks},
1849 format_hash_callbacks => $opt->{format_hash_callbacks},
1854 format => $param->{format},
1855 params => { map { $_ => $param->{$_} } @pass_params },
1857 default_csv => $opt->{default_csv},
1858 preinsert_callback => $opt->{preinsert_callback},
1859 postinsert_callback => $opt->{postinsert_callback},
1860 insert_args_callback => $opt->{insert_args_callback},
1863 if ( $opt->{'batch_namecol'} ) {
1864 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1865 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1868 my $error = FS::Record::batch_import( \%iopt );
1872 die "$error\n" if $error;
1875 =item batch_import PARAM_HASHREF
1877 Class method for batch imports. Available params:
1883 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1889 =item format_headers
1891 =item format_sep_chars
1893 =item format_fixedlength_formats
1895 =item format_row_callbacks
1897 =item format_hash_callbacks - After parsing, before object creation
1899 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1901 =item preinsert_callback
1903 =item postinsert_callback
1909 FS::queue object, will be updated with progress
1915 csv, xls, fixedlength, xml
1927 warn "$me batch_import call with params: \n". Dumper($param)
1930 my $table = $param->{table};
1932 my $job = $param->{job};
1933 my $file = $param->{file};
1934 my $params = $param->{params} || {};
1936 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1937 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1939 my( $type, $header, $sep_char,
1940 $fixedlength_format, $xml_format, $asn_format,
1941 $parser_opt, $row_callback, $hash_callback, @fields );
1943 my $postinsert_callback = '';
1944 $postinsert_callback = $param->{'postinsert_callback'}
1945 if $param->{'postinsert_callback'};
1946 my $preinsert_callback = '';
1947 $preinsert_callback = $param->{'preinsert_callback'}
1948 if $param->{'preinsert_callback'};
1949 my $insert_args_callback = '';
1950 $insert_args_callback = $param->{'insert_args_callback'}
1951 if $param->{'insert_args_callback'};
1953 if ( $param->{'format'} ) {
1955 my $format = $param->{'format'};
1956 my $formats = $param->{formats};
1957 die "unknown format $format" unless exists $formats->{ $format };
1959 $type = $param->{'format_types'}
1960 ? $param->{'format_types'}{ $format }
1961 : $param->{type} || 'csv';
1964 $header = $param->{'format_headers'}
1965 ? $param->{'format_headers'}{ $param->{'format'} }
1968 $sep_char = $param->{'format_sep_chars'}
1969 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1972 $fixedlength_format =
1973 $param->{'format_fixedlength_formats'}
1974 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1978 $param->{'format_parser_opts'}
1979 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1983 $param->{'format_xml_formats'}
1984 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1988 $param->{'format_asn_formats'}
1989 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1993 $param->{'format_row_callbacks'}
1994 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1998 $param->{'format_hash_callbacks'}
1999 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
2002 @fields = @{ $formats->{ $format } };
2004 } elsif ( $param->{'fields'} ) {
2006 $type = ''; #infer from filename
2009 $fixedlength_format = '';
2011 $hash_callback = '';
2012 @fields = @{ $param->{'fields'} };
2015 die "neither format nor fields specified";
2018 #my $file = $param->{file};
2021 if ( $file =~ /\.(\w+)$/i ) {
2025 warn "can't parse file type from filename $file; defaulting to CSV";
2029 if $param->{'default_csv'} && $type ne 'xls';
2037 my $asn_header_buffer;
2038 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2040 if ( $type eq 'csv' ) {
2042 $parser_opt->{'binary'} = 1;
2043 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2044 $parser = Text::CSV_XS->new($parser_opt);
2046 } elsif ( $type eq 'fixedlength' ) {
2048 eval "use Parse::FixedLength;";
2050 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2053 die "Unknown file type $type\n";
2056 @buffer = split(/\r?\n/, slurp($file) );
2057 splice(@buffer, 0, ($header || 0) );
2058 $count = scalar(@buffer);
2060 } elsif ( $type eq 'xls' ) {
2062 eval "use Spreadsheet::ParseExcel;";
2065 eval "use DateTime::Format::Excel;";
2066 #for now, just let the error be thrown if it is used, since only CDR
2067 # formats bill_west and troop use it, not other excel-parsing things
2070 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2072 $parser = $excel->{Worksheet}[0]; #first sheet
2074 $count = $parser->{MaxRow} || $parser->{MinRow};
2077 $row = $header || 0;
2079 } elsif ( $type eq 'xml' ) {
2082 eval "use XML::Simple;";
2084 my $xmlrow = $xml_format->{'xmlrow'};
2085 $parser = $xml_format->{'xmlkeys'};
2086 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2087 my $data = XML::Simple::XMLin(
2089 'SuppressEmpty' => '', #sets empty values to ''
2093 $rows = $rows->{$_} foreach @$xmlrow;
2094 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2095 $count = @buffer = @$rows;
2097 } elsif ( $type eq 'asn.1' ) {
2099 eval "use Convert::ASN1";
2102 my $asn = Convert::ASN1->new;
2103 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2105 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2107 my $data = slurp($file);
2108 my $asn_output = $parser->decode( $data )
2109 or return "No ". $asn_format->{'macro'}. " found\n";
2111 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2113 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2114 $count = @buffer = @$rows;
2117 die "Unknown file type $type\n";
2122 local $SIG{HUP} = 'IGNORE';
2123 local $SIG{INT} = 'IGNORE';
2124 local $SIG{QUIT} = 'IGNORE';
2125 local $SIG{TERM} = 'IGNORE';
2126 local $SIG{TSTP} = 'IGNORE';
2127 local $SIG{PIPE} = 'IGNORE';
2129 my $oldAutoCommit = $FS::UID::AutoCommit;
2130 local $FS::UID::AutoCommit = 0;
2133 #my $params = $param->{params} || {};
2134 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2135 my $batch_col = $param->{'batch_keycol'};
2137 my $batch_class = 'FS::'. $param->{'batch_table'};
2138 my $batch = $batch_class->new({
2139 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2141 my $error = $batch->insert;
2143 $dbh->rollback if $oldAutoCommit;
2144 return "can't insert batch record: $error";
2146 #primary key via dbdef? (so the column names don't have to match)
2147 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2149 $params->{ $batch_col } = $batch_value;
2152 #my $job = $param->{job};
2155 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2159 my %hash = %$params;
2160 if ( $type eq 'csv' ) {
2162 last unless scalar(@buffer);
2163 $line = shift(@buffer);
2165 next if $line =~ /^\s*$/; #skip empty lines
2167 $line = &{$row_callback}($line) if $row_callback;
2169 next if $line =~ /^\s*$/; #skip empty lines
2171 $parser->parse($line) or do {
2172 $dbh->rollback if $oldAutoCommit;
2173 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2175 @columns = $parser->fields();
2177 } elsif ( $type eq 'fixedlength' ) {
2179 last unless scalar(@buffer);
2180 $line = shift(@buffer);
2182 @columns = $parser->parse($line);
2184 } elsif ( $type eq 'xls' ) {
2186 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2187 || ! $parser->{Cells}[$row];
2189 my @row = @{ $parser->{Cells}[$row] };
2190 @columns = map $_->{Val}, @row;
2193 #warn $z++. ": $_\n" for @columns;
2195 } elsif ( $type eq 'xml' ) {
2197 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2198 last unless scalar(@buffer);
2199 my $row = shift @buffer;
2200 @columns = @{ $row }{ @$parser };
2202 } elsif ( $type eq 'asn.1' ) {
2204 last unless scalar(@buffer);
2205 my $row = shift @buffer;
2206 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2207 if $asn_format->{row_callback};
2208 foreach my $key ( keys %{ $asn_format->{map} } ) {
2209 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2213 die "Unknown file type $type\n";
2218 foreach my $field ( @fields ) {
2220 my $value = shift @columns;
2222 if ( ref($field) eq 'CODE' ) {
2223 #&{$field}(\%hash, $value);
2224 push @later, $field, $value;
2226 #??? $hash{$field} = $value if length($value);
2227 $hash{$field} = $value if defined($value) && length($value);
2232 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2233 && length($1) == $custnum_length ) {
2234 $hash{custnum} = $2;
2237 %hash = &{$hash_callback}(%hash) if $hash_callback;
2239 #my $table = $param->{table};
2240 my $class = "FS::$table";
2242 my $record = $class->new( \%hash );
2245 while ( scalar(@later) ) {
2246 my $sub = shift @later;
2247 my $data = shift @later;
2249 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2252 $dbh->rollback if $oldAutoCommit;
2253 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2255 last if exists( $param->{skiprow} );
2257 next if exists( $param->{skiprow} );
2259 if ( $preinsert_callback ) {
2260 my $error = &{$preinsert_callback}($record, $param);
2262 $dbh->rollback if $oldAutoCommit;
2263 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2266 next if exists $param->{skiprow} && $param->{skiprow};
2269 my @insert_args = ();
2270 if ( $insert_args_callback ) {
2271 @insert_args = &{$insert_args_callback}($record, $param);
2274 my $error = $record->insert(@insert_args);
2277 $dbh->rollback if $oldAutoCommit;
2278 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2284 if ( $postinsert_callback ) {
2285 my $error = &{$postinsert_callback}($record, $param);
2287 $dbh->rollback if $oldAutoCommit;
2288 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2293 if ( $job && time - $min_sec > $last ) { #progress bar
2294 $job->update_statustext( int(100 * $imported / $count) );
2300 unless ( $imported || $param->{empty_ok} ) {
2301 $dbh->rollback if $oldAutoCommit;
2302 return "Empty file!";
2305 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2312 my( $self, $action, $time ) = @_;
2316 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2319 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2320 real_fields($self->table);
2323 # If we're encrypting then don't store the payinfo in the history
2324 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2325 @fields = grep { $_ ne 'payinfo' } @fields;
2328 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2330 "INSERT INTO h_". $self->table. " ( ".
2331 join(', ', qw(history_date history_usernum history_action), @fields ).
2334 $FS::CurrentUser::CurrentUser->usernum,
2335 dbh->quote($action),
2344 B<Warning>: External use is B<deprecated>.
2346 Replaces COLUMN in record with a unique number, using counters in the
2347 filesystem. Used by the B<insert> method on single-field unique columns
2348 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2349 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2351 Returns the new value.
2356 my($self,$field) = @_;
2357 my($table)=$self->table;
2359 croak "Unique called on field $field, but it is ",
2360 $self->getfield($field),
2362 if $self->getfield($field);
2364 #warn "table $table is tainted" if is_tainted($table);
2365 #warn "field $field is tainted" if is_tainted($field);
2367 my($counter) = new File::CounterFile "$table.$field",0;
2369 my $index = $counter->inc;
2370 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2372 $index =~ /^(\d*)$/;
2375 $self->setfield($field,$index);
2379 =item ut_float COLUMN
2381 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2382 null. If there is an error, returns the error, otherwise returns false.
2387 my($self,$field)=@_ ;
2388 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2389 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2390 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2391 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2392 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2393 $self->setfield($field,$1);
2396 =item ut_floatn COLUMN
2398 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2399 null. If there is an error, returns the error, otherwise returns false.
2403 #false laziness w/ut_ipn
2405 my( $self, $field ) = @_;
2406 if ( $self->getfield($field) =~ /^()$/ ) {
2407 $self->setfield($field,'');
2410 $self->ut_float($field);
2414 =item ut_sfloat COLUMN
2416 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2417 May not be null. If there is an error, returns the error, otherwise returns
2423 my($self,$field)=@_ ;
2424 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2425 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2426 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2427 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2428 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2429 $self->setfield($field,$1);
2432 =item ut_sfloatn COLUMN
2434 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2435 null. If there is an error, returns the error, otherwise returns false.
2440 my( $self, $field ) = @_;
2441 if ( $self->getfield($field) =~ /^()$/ ) {
2442 $self->setfield($field,'');
2445 $self->ut_sfloat($field);
2449 =item ut_snumber COLUMN
2451 Check/untaint signed numeric data (whole numbers). If there is an error,
2452 returns the error, otherwise returns false.
2457 my($self, $field) = @_;
2458 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2459 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2460 $self->setfield($field, "$1$2");
2464 =item ut_snumbern COLUMN
2466 Check/untaint signed numeric data (whole numbers). If there is an error,
2467 returns the error, otherwise returns false.
2472 my($self, $field) = @_;
2473 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2474 or return "Illegal (numeric) $field: ". $self->getfield($field);
2476 return "Illegal (numeric) $field: ". $self->getfield($field)
2479 $self->setfield($field, "$1$2");
2483 =item ut_number COLUMN
2485 Check/untaint simple numeric data (whole numbers). May not be null. If there
2486 is an error, returns the error, otherwise returns false.
2491 my($self,$field)=@_;
2492 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2493 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2494 $self->setfield($field,$1);
2498 =item ut_numbern COLUMN
2500 Check/untaint simple numeric data (whole numbers). May be null. If there is
2501 an error, returns the error, otherwise returns false.
2506 my($self,$field)=@_;
2507 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2508 or return "Illegal (numeric) $field: ". $self->getfield($field);
2509 $self->setfield($field,$1);
2513 =item ut_decimal COLUMN[, DIGITS]
2515 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2516 error, returns the error, otherwise returns false.
2518 =item ut_decimaln COLUMN[, DIGITS]
2520 Check/untaint decimal numbers. May be null. If there is an error, returns
2521 the error, otherwise returns false.
2526 my($self, $field, $digits) = @_;
2528 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2529 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2530 $self->setfield($field, $1);
2535 my($self, $field, $digits) = @_;
2536 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2537 or return "Illegal (decimal) $field: ".$self->getfield($field);
2538 $self->setfield($field, $1);
2542 =item ut_money COLUMN
2544 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2545 is an error, returns the error, otherwise returns false.
2550 my($self,$field)=@_;
2552 if ( $self->getfield($field) eq '' ) {
2553 $self->setfield($field, 0);
2554 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2555 #handle one decimal place without barfing out
2556 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2557 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2558 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2560 return "Illegal (money) $field: ". $self->getfield($field);
2566 =item ut_moneyn COLUMN
2568 Check/untaint monetary numbers. May be negative. If there
2569 is an error, returns the error, otherwise returns false.
2574 my($self,$field)=@_;
2575 if ($self->getfield($field) eq '') {
2576 $self->setfield($field, '');
2579 $self->ut_money($field);
2582 =item ut_currencyn COLUMN
2584 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2585 is an error, returns the error, otherwise returns false.
2590 my($self, $field) = @_;
2591 if ($self->getfield($field) eq '') { #can be null
2592 $self->setfield($field, '');
2595 $self->ut_currency($field);
2598 =item ut_currency COLUMN
2600 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2601 there is an error, returns the error, otherwise returns false.
2606 my($self, $field) = @_;
2607 my $value = uc( $self->getfield($field) );
2608 if ( code2currency($value) ) {
2609 $self->setfield($value);
2611 return "Unknown currency $value";
2617 =item ut_text COLUMN
2619 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2620 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2621 May not be null. If there is an error, returns the error, otherwise returns
2627 my($self,$field)=@_;
2628 #warn "msgcat ". \&msgcat. "\n";
2629 #warn "notexist ". \¬exist. "\n";
2630 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2631 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2632 # see perldoc perluniprops
2633 $self->getfield($field)
2634 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2635 or return gettext('illegal_or_empty_text'). " $field: ".
2636 $self->getfield($field);
2637 $self->setfield($field,$1);
2641 =item ut_textn COLUMN
2643 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2644 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2645 May be null. If there is an error, returns the error, otherwise returns false.
2650 my($self,$field)=@_;
2651 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2652 $self->ut_text($field);
2655 =item ut_alpha COLUMN
2657 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2658 an error, returns the error, otherwise returns false.
2663 my($self,$field)=@_;
2664 $self->getfield($field) =~ /^(\w+)$/
2665 or return "Illegal or empty (alphanumeric) $field: ".
2666 $self->getfield($field);
2667 $self->setfield($field,$1);
2671 =item ut_alphan COLUMN
2673 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2674 error, returns the error, otherwise returns false.
2679 my($self,$field)=@_;
2680 $self->getfield($field) =~ /^(\w*)$/
2681 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2682 $self->setfield($field,$1);
2686 =item ut_alphasn COLUMN
2688 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2689 an error, returns the error, otherwise returns false.
2694 my($self,$field)=@_;
2695 $self->getfield($field) =~ /^([\w ]*)$/
2696 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2697 $self->setfield($field,$1);
2702 =item ut_alpha_lower COLUMN
2704 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2705 there is an error, returns the error, otherwise returns false.
2709 sub ut_alpha_lower {
2710 my($self,$field)=@_;
2711 $self->getfield($field) =~ /[[:upper:]]/
2712 and return "Uppercase characters are not permitted in $field";
2713 $self->ut_alpha($field);
2716 =item ut_phonen COLUMN [ COUNTRY ]
2718 Check/untaint phone numbers. May be null. If there is an error, returns
2719 the error, otherwise returns false.
2721 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2722 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2727 my( $self, $field, $country ) = @_;
2728 return $self->ut_alphan($field) unless defined $country;
2729 my $phonen = $self->getfield($field);
2730 if ( $phonen eq '' ) {
2731 $self->setfield($field,'');
2732 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2734 $phonen = $conf->config('cust_main-default_areacode').$phonen
2735 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2736 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2737 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2738 $phonen = "$1-$2-$3";
2739 $phonen .= " x$4" if $4;
2740 $self->setfield($field,$phonen);
2742 warn "warning: don't know how to check phone numbers for country $country";
2743 return $self->ut_textn($field);
2750 Check/untaint hexadecimal values.
2755 my($self, $field) = @_;
2756 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2757 or return "Illegal (hex) $field: ". $self->getfield($field);
2758 $self->setfield($field, uc($1));
2762 =item ut_hexn COLUMN
2764 Check/untaint hexadecimal values. May be null.
2769 my($self, $field) = @_;
2770 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2771 or return "Illegal (hex) $field: ". $self->getfield($field);
2772 $self->setfield($field, uc($1));
2776 =item ut_mac_addr COLUMN
2778 Check/untaint mac addresses. May be null.
2783 my($self, $field) = @_;
2785 my $mac = $self->get($field);
2788 $self->set($field, $mac);
2790 my $e = $self->ut_hex($field);
2793 return "Illegal (mac address) $field: ". $self->getfield($field)
2794 unless length($self->getfield($field)) == 12;
2800 =item ut_mac_addrn COLUMN
2802 Check/untaint mac addresses. May be null.
2807 my($self, $field) = @_;
2808 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2813 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2819 my( $self, $field ) = @_;
2820 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2821 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2822 or return "Illegal (IP address) $field: ". $self->getfield($field);
2823 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2824 $self->setfield($field, "$1.$2.$3.$4");
2830 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2831 to 127.0.0.1. May be null.
2836 my( $self, $field ) = @_;
2837 if ( $self->getfield($field) =~ /^()$/ ) {
2838 $self->setfield($field,'');
2841 $self->ut_ip($field);
2845 =item ut_ip46 COLUMN
2847 Check/untaint IPv4 or IPv6 address.
2852 my( $self, $field ) = @_;
2853 my $ip = NetAddr::IP->new($self->getfield($field))
2854 or return "Illegal (IP address) $field: ".$self->getfield($field);
2855 $self->setfield($field, lc($ip->addr));
2861 Check/untaint IPv6 or IPv6 address. May be null.
2866 my( $self, $field ) = @_;
2867 if ( $self->getfield($field) =~ /^$/ ) {
2868 $self->setfield($field, '');
2871 $self->ut_ip46($field);
2874 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2876 Check/untaint coordinates.
2877 Accepts the following forms:
2887 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2888 The latter form (that is, the MMM are thousands of minutes) is
2889 assumed if the "MMM" is exactly three digits or two digits > 59.
2891 To be safe, just use the DDD.DDDDD form.
2893 If LOWER or UPPER are specified, then the coordinate is checked
2894 for lower and upper bounds, respectively.
2899 my ($self, $field) = (shift, shift);
2902 if ( $field =~ /latitude/ ) {
2903 $lower = $lat_lower;
2905 } elsif ( $field =~ /longitude/ ) {
2907 $upper = $lon_upper;
2910 my $coord = $self->getfield($field);
2911 my $neg = $coord =~ s/^(-)//;
2913 # ignore degree symbol at the end,
2914 # but not otherwise supporting degree/minutes/seconds symbols
2915 $coord =~ s/\N{DEGREE SIGN}\s*$//;
2917 my ($d, $m, $s) = (0, 0, 0);
2920 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2921 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2922 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2924 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2927 return "Invalid (coordinate with minutes > 59) $field: "
2928 . $self->getfield($field);
2931 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2933 if (defined($lower) and ($coord < $lower)) {
2934 return "Invalid (coordinate < $lower) $field: "
2935 . $self->getfield($field);;
2938 if (defined($upper) and ($coord > $upper)) {
2939 return "Invalid (coordinate > $upper) $field: "
2940 . $self->getfield($field);;
2943 $self->setfield($field, $coord);
2947 return "Invalid (coordinate) $field: " . $self->getfield($field);
2951 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2953 Same as ut_coord, except optionally null.
2959 my ($self, $field) = (shift, shift);
2961 if ($self->getfield($field) =~ /^\s*$/) {
2964 return $self->ut_coord($field, @_);
2969 =item ut_domain COLUMN
2971 Check/untaint host and domain names. May not be null.
2976 my( $self, $field ) = @_;
2977 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2978 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2979 or return "Illegal (hostname) $field: ". $self->getfield($field);
2980 $self->setfield($field,$1);
2984 =item ut_domainn COLUMN
2986 Check/untaint host and domain names. May be null.
2991 my( $self, $field ) = @_;
2992 if ( $self->getfield($field) =~ /^()$/ ) {
2993 $self->setfield($field,'');
2996 $self->ut_domain($field);
3000 =item ut_name COLUMN
3002 Check/untaint proper names; allows alphanumerics, spaces and the following
3003 punctuation: , . - '
3010 my( $self, $field ) = @_;
3011 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
3012 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
3017 $self->setfield($field, $name);
3021 =item ut_namen COLUMN
3023 Check/untaint proper names; allows alphanumerics, spaces and the following
3024 punctuation: , . - '
3031 my( $self, $field ) = @_;
3032 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3033 $self->ut_name($field);
3038 Check/untaint zip codes.
3042 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3045 my( $self, $field, $country ) = @_;
3047 if ( $country eq 'US' ) {
3049 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3050 or return gettext('illegal_zip'). " $field for country $country: ".
3051 $self->getfield($field);
3052 $self->setfield($field, $1);
3054 } elsif ( $country eq 'CA' ) {
3056 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3057 or return gettext('illegal_zip'). " $field for country $country: ".
3058 $self->getfield($field);
3059 $self->setfield($field, "$1 $2");
3063 if ( $self->getfield($field) =~ /^\s*$/
3064 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3067 $self->setfield($field,'');
3069 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3070 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3071 $self->setfield($field,$1);
3079 =item ut_country COLUMN
3081 Check/untaint country codes. Country names are changed to codes, if possible -
3082 see L<Locale::Country>.
3087 my( $self, $field ) = @_;
3088 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3089 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3090 && country2code($1) ) {
3091 $self->setfield($field,uc(country2code($1)));
3094 $self->getfield($field) =~ /^(\w\w)$/
3095 or return "Illegal (country) $field: ". $self->getfield($field);
3096 $self->setfield($field,uc($1));
3100 =item ut_anything COLUMN
3102 Untaints arbitrary data. Be careful.
3107 my( $self, $field ) = @_;
3108 $self->getfield($field) =~ /^(.*)$/s
3109 or return "Illegal $field: ". $self->getfield($field);
3110 $self->setfield($field,$1);
3114 =item ut_enum COLUMN CHOICES_ARRAYREF
3116 Check/untaint a column, supplying all possible choices, like the "enum" type.
3121 my( $self, $field, $choices ) = @_;
3122 foreach my $choice ( @$choices ) {
3123 if ( $self->getfield($field) eq $choice ) {
3124 $self->setfield($field, $choice);
3128 return "Illegal (enum) field $field: ". $self->getfield($field);
3131 =item ut_enumn COLUMN CHOICES_ARRAYREF
3133 Like ut_enum, except the null value is also allowed.
3138 my( $self, $field, $choices ) = @_;
3139 $self->getfield($field)
3140 ? $self->ut_enum($field, $choices)
3144 =item ut_flag COLUMN
3146 Check/untaint a column if it contains either an empty string or 'Y'. This
3147 is the standard form for boolean flags in Freeside.
3152 my( $self, $field ) = @_;
3153 my $value = uc($self->getfield($field));
3154 if ( $value eq '' or $value eq 'Y' ) {
3155 $self->setfield($field, $value);
3158 return "Illegal (flag) field $field: $value";
3161 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3163 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3164 on the column first.
3168 sub ut_foreign_key {
3169 my( $self, $field, $table, $foreign ) = @_;
3170 return $self->ut_number($field) if $no_check_foreign;
3171 qsearchs($table, { $foreign => $self->getfield($field) })
3172 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3173 " in $table.$foreign";
3177 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3179 Like ut_foreign_key, except the null value is also allowed.
3183 sub ut_foreign_keyn {
3184 my( $self, $field, $table, $foreign ) = @_;
3185 $self->getfield($field)
3186 ? $self->ut_foreign_key($field, $table, $foreign)
3190 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3192 Checks this column as an agentnum, taking into account the current users's
3193 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3194 right or rights allowing no agentnum.
3198 sub ut_agentnum_acl {
3199 my( $self, $field ) = (shift, shift);
3200 my $null_acl = scalar(@_) ? shift : [];
3201 $null_acl = [ $null_acl ] unless ref($null_acl);
3203 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3204 return "Illegal agentnum: $error" if $error;
3206 my $curuser = $FS::CurrentUser::CurrentUser;
3208 if ( $self->$field() ) {
3210 return 'Access denied to agent '. $self->$field()
3211 unless $curuser->agentnum($self->$field());
3215 return 'Access denied to global'
3216 unless grep $curuser->access_right($_), @$null_acl;
3224 =item trim_whitespace FIELD[, FIELD ... ]
3226 Strip leading and trailing spaces from the value in the named FIELD(s).
3230 sub trim_whitespace {
3232 foreach my $field (@_) {
3233 my $value = $self->get($field);
3236 $self->set($field, $value);
3240 =item fields [ TABLE ]
3242 This is a wrapper for real_fields. Code that called
3243 fields before should probably continue to call fields.
3248 my $something = shift;
3250 if($something->isa('FS::Record')) {
3251 $table = $something->table;
3253 $table = $something;
3254 #$something = "FS::$table";
3256 return (real_fields($table));
3260 =item encrypt($value)
3262 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3264 Returns the encrypted string.
3266 You should generally not have to worry about calling this, as the system handles this for you.
3271 my ($self, $value) = @_;
3272 my $encrypted = $value;
3274 if ($conf_encryption) {
3275 if ($self->is_encrypted($value)) {
3276 # Return the original value if it isn't plaintext.
3277 $encrypted = $value;
3280 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3281 # RSA doesn't like the empty string so let's pack it up
3282 # The database doesn't like the RSA data so uuencode it
3283 my $length = length($value)+1;
3284 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3286 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3293 =item is_encrypted($value)
3295 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3301 my ($self, $value) = @_;
3302 # could be more precise about it, but this will do for now
3303 $value =~ /^M/ && length($value) > 80;
3306 =item decrypt($value)
3308 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3310 You should generally not have to worry about calling this, as the system handles this for you.
3315 my ($self,$value) = @_;
3316 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3317 if ($conf_encryption && $self->is_encrypted($value)) {
3319 if (ref($rsa_decrypt) =~ /::RSA/) {
3320 my $encrypted = unpack ("u*", $value);
3321 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3322 if ($@) {warn "Decryption Failed"};
3330 #Initialize the Module
3331 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3333 if ($conf_encryptionmodule && $conf_encryptionmodule ne '') {
3334 $rsa_module = $conf_encryptionmodule;
3338 eval ("require $rsa_module"); # No need to import the namespace
3341 # Initialize Encryption
3342 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3343 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3346 # Intitalize Decryption
3347 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3348 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3352 =item h_search ACTION
3354 Given an ACTION, either "insert", or "delete", returns the appropriate history
3355 record corresponding to this record, if any.
3360 my( $self, $action ) = @_;
3362 my $table = $self->table;
3365 my $primary_key = dbdef->table($table)->primary_key;
3368 'table' => "h_$table",
3369 'hashref' => { $primary_key => $self->$primary_key(),
3370 'history_action' => $action,
3378 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3379 appropriate history record corresponding to this record, if any.
3384 my($self, $action) = @_;
3385 my $h = $self->h_search($action);
3386 $h ? $h->history_date : '';
3389 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3391 A class or object method. Executes the sql statement represented by SQL and
3392 returns a scalar representing the result: the first column of the first row.
3394 Dies on bogus SQL. Returns an empty string if no row is returned.
3396 Typically used for statments which return a single value such as "SELECT
3397 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3402 my($self, $sql) = (shift, shift);
3403 my $sth = dbh->prepare($sql) or die dbh->errstr;
3405 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3406 my $row = $sth->fetchrow_arrayref or return '';
3407 my $scalar = $row->[0];
3408 defined($scalar) ? $scalar : '';
3411 =item count [ WHERE [, PLACEHOLDER ...] ]
3413 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3414 with optional WHERE. Must be called as method on a class with an
3420 my($self, $where) = (shift, shift);
3421 my $table = $self->table or die 'count called on object of class '.ref($self);
3422 my $sql = "SELECT COUNT(*) FROM $table";
3423 $sql .= " WHERE $where" if $where;
3424 $self->scalar_sql($sql, @_);
3427 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3429 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3430 with optional (but almost always needed) WHERE.
3435 my($self, $where) = (shift, shift);
3436 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3437 my $sql = "SELECT 1 FROM $table";
3438 $sql .= " WHERE $where" if $where;
3440 $self->scalar_sql($sql, @_);
3449 =item real_fields [ TABLE ]
3451 Returns a list of the real columns in the specified table. Called only by
3452 fields() and other subroutines elsewhere in FS::Record.
3459 my($table_obj) = dbdef->table($table);
3460 confess "Unknown table $table" unless $table_obj;
3461 $table_obj->columns;
3464 =item pvf FIELD_NAME
3466 Returns the FS::part_virtual_field object corresponding to a field in the
3467 record (specified by FIELD_NAME).
3472 my ($self, $name) = (shift, shift);
3474 if(grep /^$name$/, $self->virtual_fields) {
3476 my $concat = [ "'cf_'", "name" ];
3477 return qsearchs({ table => 'part_virtual_field',
3478 hashref => { dbtable => $self->table,
3481 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3487 =item _quote VALUE, TABLE, COLUMN
3489 This is an internal function used to construct SQL statements. It returns
3490 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3491 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3496 my($value, $table, $column) = @_;
3497 my $column_obj = dbdef->table($table)->column($column);
3498 my $column_type = $column_obj->type;
3499 my $nullable = $column_obj->null;
3501 utf8::upgrade($value);
3503 warn " $table.$column: $value ($column_type".
3504 ( $nullable ? ' NULL' : ' NOT NULL' ).
3505 ")\n" if $DEBUG > 2;
3507 if ( $value eq '' && $nullable ) {
3509 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3510 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3513 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3514 ! $column_type =~ /(char|binary|text)$/i ) {
3516 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3517 && driver_name eq 'Pg'
3521 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3522 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3523 # single-quote the whole mess, and put an "E" in front.
3524 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3532 This is deprecated. Don't use it.
3534 It returns a hash-type list with the fields of this record's table set true.
3539 carp "warning: hfields is deprecated";
3542 foreach (fields($table)) {
3551 "$_: ". $self->getfield($_). "|"
3552 } (fields($self->table)) );
3555 sub DESTROY { return; }
3559 # #use Carp qw(cluck);
3560 # #cluck "DESTROYING $self";
3561 # warn "DESTROYING $self";
3565 # return ! eval { join('',@_), kill 0; 1; };
3568 =item str2time_sql [ DRIVER_NAME ]
3570 Returns a function to convert to unix time based on database type, such as
3571 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3572 the str2time_sql_closing method to return a closing string rather than just
3573 using a closing parenthesis as previously suggested.
3575 You can pass an optional driver name such as "Pg", "mysql" or
3576 $dbh->{Driver}->{Name} to return a function for that database instead of
3577 the current database.
3582 my $driver = shift || driver_name;
3584 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3585 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3587 warn "warning: unknown database type $driver; guessing how to convert ".
3588 "dates to UNIX timestamps";
3589 return 'EXTRACT(EPOCH FROM ';
3593 =item str2time_sql_closing [ DRIVER_NAME ]
3595 Returns the closing suffix of a function to convert to unix time based on
3596 database type, such as ")::integer" for Pg or ")" for mysql.
3598 You can pass an optional driver name such as "Pg", "mysql" or
3599 $dbh->{Driver}->{Name} to return a function for that database instead of
3600 the current database.
3604 sub str2time_sql_closing {
3605 my $driver = shift || driver_name;
3607 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3611 =item regexp_sql [ DRIVER_NAME ]
3613 Returns the operator to do a regular expression comparison based on database
3614 type, such as '~' for Pg or '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.
3623 my $driver = shift || driver_name;
3625 return '~' if $driver =~ /^Pg/i;
3626 return 'REGEXP' if $driver =~ /^mysql/i;
3628 die "don't know how to use regular expressions in ". driver_name." databases";
3632 =item not_regexp_sql [ DRIVER_NAME ]
3634 Returns the operator to do a regular expression negation based on database
3635 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
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.
3643 sub not_regexp_sql {
3644 my $driver = shift || driver_name;
3646 return '!~' if $driver =~ /^Pg/i;
3647 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3649 die "don't know how to use regular expressions in ". driver_name." databases";
3653 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3655 Returns the items concatenated based on database type, using "CONCAT()" for
3656 mysql and " || " for Pg and other databases.
3658 You can pass an optional driver name such as "Pg", "mysql" or
3659 $dbh->{Driver}->{Name} to return a function for that database instead of
3660 the current database.
3665 my $driver = ref($_[0]) ? driver_name : shift;
3668 if ( $driver =~ /^mysql/i ) {
3669 'CONCAT('. join(',', @$items). ')';
3671 join('||', @$items);
3676 =item group_concat_sql COLUMN, DELIMITER
3678 Returns an SQL expression to concatenate an aggregate column, using
3679 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3683 sub group_concat_sql {
3684 my ($col, $delim) = @_;
3685 $delim = dbh->quote($delim);
3686 if ( driver_name() =~ /^mysql/i ) {
3687 # DISTINCT(foo) is valid as $col
3688 return "GROUP_CONCAT($col SEPARATOR $delim)";
3690 return "array_to_string(array_agg($col), $delim)";
3694 =item midnight_sql DATE
3696 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3697 on that day in the system timezone, using the default driver name.
3702 my $driver = driver_name;
3704 if ( $driver =~ /^mysql/i ) {
3705 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3708 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3716 This module should probably be renamed, since much of the functionality is
3717 of general use. It is not completely unlike Adapter::DBI (see below).
3719 Exported qsearch and qsearchs should be deprecated in favor of method calls
3720 (against an FS::Record object like the old search and searchs that qsearch
3721 and qsearchs were on top of.)
3723 The whole fields / hfields mess should be removed.
3725 The various WHERE clauses should be subroutined.
3727 table string should be deprecated in favor of DBIx::DBSchema::Table.
3729 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3730 true maps to the database (and WHERE clauses) would also help.
3732 The ut_ methods should ask the dbdef for a default length.
3734 ut_sqltype (like ut_varchar) should all be defined
3736 A fallback check method should be provided which uses the dbdef.
3738 The ut_money method assumes money has two decimal digits.
3740 The Pg money kludge in the new method only strips `$'.
3742 The ut_phonen method only checks US-style phone numbers.
3744 The _quote function should probably use ut_float instead of a regex.
3746 All the subroutines probably should be methods, here or elsewhere.
3748 Probably should borrow/use some dbdef methods where appropriate (like sub
3751 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3752 or allow it to be set. Working around it is ugly any way around - DBI should
3753 be fixed. (only affects RDBMS which return uppercase column names)
3755 ut_zip should take an optional country like ut_phone.
3759 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3761 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.