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 # maybe should only load one table at a time?
1070 fk_methods_init() unless exists($fk_method_cache{$table});
1072 if ( exists($fk_method_cache{$table}) and
1073 exists($fk_method_cache{$table}{$field}) ) {
1074 return $fk_method_cache{$table}{$field};
1081 sub fk_methods_init {
1082 warn "[fk_methods_init]\n" if $DEBUG;
1083 foreach my $table ( dbdef->tables ) {
1084 $fk_method_cache{$table} = fk_methods($table);
1093 # foreign keys we reference in other tables
1094 foreach my $fk (dbdef->table($table)->foreign_keys) {
1097 if ( scalar( @{$fk->columns} ) == 1 ) {
1098 if ( ! defined($fk->references)
1099 || ! @{$fk->references}
1100 || $fk->columns->[0] eq $fk->references->[0]
1102 $method = $fk->table;
1104 #some sort of hint in the table.pm or schema for methods not named
1105 # after their foreign table (well, not a whole lot different than
1106 # just providing a small subroutine...)
1110 $hash{$method} = { #fk_info
1111 'method' => 'qsearchs',
1112 'column' => $fk->columns->[0],
1113 #'references' => $fk->references->[0],
1121 # foreign keys referenced in other tables to us
1122 # (alas. why we're cached. still, might this loop better be done once at
1123 # schema load time insetad of every time we AUTOLOAD a method on a new
1125 if (! defined $fk_table_cache) {
1126 foreach my $f_table ( dbdef->tables ) {
1127 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1128 push @{$fk_table_cache->{$fk->table}},[$f_table,$fk];
1132 foreach my $fks (@{$fk_table_cache->{$table}}) {
1133 my ($f_table,$fk) = @$fks;
1135 if ( scalar( @{$fk->columns} ) == 1 ) {
1136 if ( ! defined($fk->references)
1137 || ! @{$fk->references}
1138 || $fk->columns->[0] eq $fk->references->[0]
1142 #some sort of hint in the table.pm or schema for methods not named
1143 # after their foreign table (well, not a whole lot different than
1144 # just providing a small subroutine...)
1148 $hash{$method} = { #fk_info
1149 'method' => 'qsearch',
1150 'column' => $fk->columns->[0], #references||column
1151 #'references' => $fk->column->[0],
1163 Returns a list of the column/value pairs, usually for assigning to a new hash.
1165 To make a distinct duplicate of an FS::Record object, you can do:
1167 $new = new FS::Record ( $old->table, { $old->hash } );
1173 confess $self. ' -> hash: Hash attribute is undefined'
1174 unless defined($self->{'Hash'});
1175 %{ $self->{'Hash'} };
1180 Returns a reference to the column/value hash. This may be deprecated in the
1181 future; if there's a reason you can't just use the autoloaded or get/set
1195 +{ ( map { $_=>$self->$_ } $self->fields ),
1200 my( $class, %opt ) = @_;
1201 my $table = $class->table;
1202 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1203 my $error = $self->insert;
1204 return +{ 'error' => $error } if $error;
1205 my $pkey = $self->pkey;
1206 return +{ 'error' => '',
1207 'primary_key' => $pkey,
1208 $pkey => $self->$pkey,
1214 Returns true if any of this object's values have been modified with set (or via
1215 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1222 $self->{'modified'};
1225 =item select_for_update
1227 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1232 sub select_for_update {
1234 my $primary_key = $self->primary_key;
1237 'table' => $self->table,
1238 'hashref' => { $primary_key => $self->$primary_key() },
1239 'extra_sql' => 'FOR UPDATE',
1245 Locks this table with a database-driver specific lock method. This is used
1246 as a mutex in order to do a duplicate search.
1248 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1250 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1252 Errors are fatal; no useful return value.
1254 Note: To use this method for new tables other than svc_acct and svc_phone,
1255 edit freeside-upgrade and add those tables to the duplicate_lock list.
1261 my $table = $self->table;
1263 warn "$me locking $table table\n" if $DEBUG;
1265 if ( driver_name =~ /^Pg/i ) {
1267 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1270 } elsif ( driver_name =~ /^mysql/i ) {
1272 dbh->do("SELECT * FROM duplicate_lock
1273 WHERE lockname = '$table'
1275 ) or die dbh->errstr;
1279 die "unknown database ". driver_name. "; don't know how to lock table";
1283 warn "$me acquired $table table lock\n" if $DEBUG;
1289 Inserts this record to the database. If there is an error, returns the error,
1290 otherwise returns false.
1298 warn "$self -> insert" if $DEBUG;
1300 my $error = $self->check;
1301 return $error if $error;
1303 #single-field non-null unique keys are given a value if empty
1304 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1305 foreach ( $self->dbdef_table->unique_singles) {
1306 next if $self->getfield($_);
1307 next if $self->dbdef_table->column($_)->null eq 'NULL';
1311 #and also the primary key, if the database isn't going to
1312 my $primary_key = $self->dbdef_table->primary_key;
1314 if ( $primary_key ) {
1315 my $col = $self->dbdef_table->column($primary_key);
1318 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1319 || ( driver_name eq 'Pg'
1320 && defined($col->default)
1321 && $col->quoted_default =~ /^nextval\(/i
1323 || ( driver_name eq 'mysql'
1324 && defined($col->local)
1325 && $col->local =~ /AUTO_INCREMENT/i
1327 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1330 my $table = $self->table;
1332 # Encrypt before the database
1333 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1336 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1337 next if $field eq 'payinfo'
1338 && ($self->isa('FS::payinfo_transaction_Mixin')
1339 || $self->isa('FS::payinfo_Mixin') )
1341 && !grep { $self->payby eq $_ } @encrypt_payby;
1342 $saved->{$field} = $self->getfield($field);
1343 $self->setfield($field, $self->encrypt($self->getfield($field)));
1347 #false laziness w/delete
1349 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1352 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1355 my $statement = "INSERT INTO $table ";
1356 if ( @real_fields ) {
1359 join( ', ', @real_fields ).
1361 join( ', ', @values ).
1365 $statement .= 'DEFAULT VALUES';
1367 warn "[debug]$me $statement\n" if $DEBUG > 1;
1368 my $sth = dbh->prepare($statement) or return dbh->errstr;
1370 local $SIG{HUP} = 'IGNORE';
1371 local $SIG{INT} = 'IGNORE';
1372 local $SIG{QUIT} = 'IGNORE';
1373 local $SIG{TERM} = 'IGNORE';
1374 local $SIG{TSTP} = 'IGNORE';
1375 local $SIG{PIPE} = 'IGNORE';
1377 $sth->execute or return $sth->errstr;
1379 # get inserted id from the database, if applicable & needed
1380 if ( $db_seq && ! $self->getfield($primary_key) ) {
1381 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1385 if ( driver_name eq 'Pg' ) {
1387 #my $oid = $sth->{'pg_oid_status'};
1388 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1390 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1391 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1392 dbh->rollback if $FS::UID::AutoCommit;
1393 return "can't parse $table.$primary_key default value".
1394 " for sequence name: $default";
1398 my $i_sql = "SELECT currval('$sequence')";
1399 my $i_sth = dbh->prepare($i_sql) or do {
1400 dbh->rollback if $FS::UID::AutoCommit;
1403 $i_sth->execute() or do { #$i_sth->execute($oid)
1404 dbh->rollback if $FS::UID::AutoCommit;
1405 return $i_sth->errstr;
1407 $insertid = $i_sth->fetchrow_arrayref->[0];
1409 } elsif ( driver_name eq 'mysql' ) {
1411 $insertid = dbh->{'mysql_insertid'};
1412 # work around mysql_insertid being null some of the time, ala RT :/
1413 unless ( $insertid ) {
1414 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1415 "using SELECT LAST_INSERT_ID();";
1416 my $i_sql = "SELECT LAST_INSERT_ID()";
1417 my $i_sth = dbh->prepare($i_sql) or do {
1418 dbh->rollback if $FS::UID::AutoCommit;
1421 $i_sth->execute or do {
1422 dbh->rollback if $FS::UID::AutoCommit;
1423 return $i_sth->errstr;
1425 $insertid = $i_sth->fetchrow_arrayref->[0];
1430 dbh->rollback if $FS::UID::AutoCommit;
1431 return "don't know how to retreive inserted ids from ". driver_name.
1432 ", try using counterfiles (maybe run dbdef-create?)";
1436 $self->setfield($primary_key, $insertid);
1441 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1442 my $h_statement = $self->_h_statement('insert');
1443 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1444 $h_sth = dbh->prepare($h_statement) or do {
1445 dbh->rollback if $FS::UID::AutoCommit;
1451 $h_sth->execute or return $h_sth->errstr if $h_sth;
1453 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1455 # Now that it has been saved, reset the encrypted fields so that $new
1456 # can still be used.
1457 foreach my $field (keys %{$saved}) {
1458 $self->setfield($field, $saved->{$field});
1466 Depriciated (use insert instead).
1471 cluck "warning: FS::Record::add deprecated!";
1472 insert @_; #call method in this scope
1477 Delete this record from the database. If there is an error, returns the error,
1478 otherwise returns false.
1485 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1487 $self->getfield($_) eq ''
1488 #? "( $_ IS NULL OR $_ = \"\" )"
1489 ? ( driver_name eq 'Pg'
1491 : "( $_ IS NULL OR $_ = \"\" )"
1493 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1494 } ( $self->dbdef_table->primary_key )
1495 ? ( $self->dbdef_table->primary_key)
1496 : real_fields($self->table)
1498 warn "[debug]$me $statement\n" if $DEBUG > 1;
1499 my $sth = dbh->prepare($statement) or return dbh->errstr;
1502 if ( defined dbdef->table('h_'. $self->table) ) {
1503 my $h_statement = $self->_h_statement('delete');
1504 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1505 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1510 my $primary_key = $self->dbdef_table->primary_key;
1512 local $SIG{HUP} = 'IGNORE';
1513 local $SIG{INT} = 'IGNORE';
1514 local $SIG{QUIT} = 'IGNORE';
1515 local $SIG{TERM} = 'IGNORE';
1516 local $SIG{TSTP} = 'IGNORE';
1517 local $SIG{PIPE} = 'IGNORE';
1519 my $rc = $sth->execute or return $sth->errstr;
1520 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1521 $h_sth->execute or return $h_sth->errstr if $h_sth;
1523 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1525 #no need to needlessly destoy the data either (causes problems actually)
1526 #undef $self; #no need to keep object!
1533 Depriciated (use delete instead).
1538 cluck "warning: FS::Record::del deprecated!";
1539 &delete(@_); #call method in this scope
1542 =item replace OLD_RECORD
1544 Replace the OLD_RECORD with this one in the database. If there is an error,
1545 returns the error, otherwise returns false.
1550 my ($new, $old) = (shift, shift);
1552 $old = $new->replace_old unless defined($old);
1554 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1556 if ( $new->can('replace_check') ) {
1557 my $error = $new->replace_check($old);
1558 return $error if $error;
1561 return "Records not in same table!" unless $new->table eq $old->table;
1563 my $primary_key = $old->dbdef_table->primary_key;
1564 return "Can't change primary key $primary_key ".
1565 'from '. $old->getfield($primary_key).
1566 ' to ' . $new->getfield($primary_key)
1568 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1570 my $error = $new->check;
1571 return $error if $error;
1573 # Encrypt for replace
1575 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1578 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1579 next if $field eq 'payinfo'
1580 && ($new->isa('FS::payinfo_transaction_Mixin')
1581 || $new->isa('FS::payinfo_Mixin') )
1583 && !grep { $new->payby eq $_ } @encrypt_payby;
1584 $saved->{$field} = $new->getfield($field);
1585 $new->setfield($field, $new->encrypt($new->getfield($field)));
1589 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1590 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1591 ? ($_, $new->getfield($_)) : () } $old->fields;
1593 unless (keys(%diff) || $no_update_diff ) {
1594 carp "[warning]$me ". ref($new)."->replace ".
1595 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1596 ": records identical"
1597 unless $nowarn_identical;
1601 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1603 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1604 } real_fields($old->table)
1609 if ( $old->getfield($_) eq '' ) {
1611 #false laziness w/qsearch
1612 if ( driver_name eq 'Pg' ) {
1613 my $type = $old->dbdef_table->column($_)->type;
1614 if ( $type =~ /(int|(big)?serial)/i ) {
1617 qq-( $_ IS NULL OR $_ = '' )-;
1620 qq-( $_ IS NULL OR $_ = "" )-;
1624 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1627 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1630 warn "[debug]$me $statement\n" if $DEBUG > 1;
1631 my $sth = dbh->prepare($statement) or return dbh->errstr;
1634 if ( defined dbdef->table('h_'. $old->table) ) {
1635 my $h_old_statement = $old->_h_statement('replace_old');
1636 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1637 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1643 if ( defined dbdef->table('h_'. $new->table) ) {
1644 my $h_new_statement = $new->_h_statement('replace_new');
1645 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1646 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1651 local $SIG{HUP} = 'IGNORE';
1652 local $SIG{INT} = 'IGNORE';
1653 local $SIG{QUIT} = 'IGNORE';
1654 local $SIG{TERM} = 'IGNORE';
1655 local $SIG{TSTP} = 'IGNORE';
1656 local $SIG{PIPE} = 'IGNORE';
1658 my $rc = $sth->execute or return $sth->errstr;
1659 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1660 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1661 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1663 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1665 # Now that it has been saved, reset the encrypted fields so that $new
1666 # can still be used.
1667 foreach my $field (keys %{$saved}) {
1668 $new->setfield($field, $saved->{$field});
1676 my( $self ) = shift;
1677 warn "[$me] replace called with no arguments; autoloading old record\n"
1680 my $primary_key = $self->dbdef_table->primary_key;
1681 if ( $primary_key ) {
1682 $self->by_key( $self->$primary_key() ) #this is what's returned
1683 or croak "can't find ". $self->table. ".$primary_key ".
1684 $self->$primary_key();
1686 croak $self->table. " has no primary key; pass old record as argument";
1693 Depriciated (use replace instead).
1698 cluck "warning: FS::Record::rep deprecated!";
1699 replace @_; #call method in this scope
1704 Checks custom fields. Subclasses should still provide a check method to validate
1705 non-custom fields, etc., and call this method via $self->SUPER::check.
1711 foreach my $field ($self->virtual_fields) {
1712 my $error = $self->ut_textn($field);
1713 return $error if $error;
1718 =item virtual_fields [ TABLE ]
1720 Returns a list of virtual fields defined for the table. This should not
1721 be exported, and should only be called as an instance or class method.
1725 sub virtual_fields {
1728 $table = $self->table or confess "virtual_fields called on non-table";
1730 confess "Unknown table $table" unless dbdef->table($table);
1732 return () unless dbdef->table('part_virtual_field');
1734 unless ( $virtual_fields_cache{$table} ) {
1735 my $concat = [ "'cf_'", "name" ];
1736 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1737 "WHERE dbtable = '$table'";
1739 my $result = $dbh->selectcol_arrayref($query);
1740 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1742 $virtual_fields_cache{$table} = $result;
1745 @{$virtual_fields_cache{$table}};
1749 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1751 Processes a batch import as a queued JSRPC job
1753 JOB is an FS::queue entry.
1755 OPTIONS_HASHREF can have the following keys:
1761 Table name (required).
1765 Arrayref of field names for static fields. They will be given values from the
1766 PARAMS hashref and passed as a "params" hashref to batch_import.
1770 Formats hashref. Keys are field names, values are listrefs that define the
1773 Each listref value can be a column name or a code reference. Coderefs are run
1774 with the row object, data and a FS::Conf object as the three parameters.
1775 For example, this coderef does the same thing as using the "columnname" string:
1778 my( $record, $data, $conf ) = @_;
1779 $record->columnname( $data );
1782 Coderefs are run after all "column name" fields are assigned.
1786 Optional format hashref of types. Keys are field names, values are "csv",
1787 "xls" or "fixedlength". Overrides automatic determination of file type
1790 =item format_headers
1792 Optional format hashref of header lines. Keys are field names, values are 0
1793 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1796 =item format_sep_chars
1798 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1799 CSV separation character.
1801 =item format_fixedlenth_formats
1803 Optional format hashref of fixed length format defintiions. Keys are field
1804 names, values Parse::FixedLength listrefs of field definitions.
1808 Set true to default to CSV file type if the filename does not contain a
1809 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1814 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1815 POSTed data. It must contain the field "uploaded files", generated by
1816 /elements/file-upload.html and containing the list of uploaded files.
1817 Currently only supports a single file named "file".
1822 sub process_batch_import {
1823 my($job, $opt, $param) = @_;
1825 my $table = $opt->{table};
1826 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1827 my %formats = %{ $opt->{formats} };
1829 warn Dumper($param) if $DEBUG;
1831 my $files = $param->{'uploaded_files'}
1832 or die "No files provided.\n";
1834 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1836 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1837 my $file = $dir. $files{'file'};
1842 formats => \%formats,
1843 format_types => $opt->{format_types},
1844 format_headers => $opt->{format_headers},
1845 format_sep_chars => $opt->{format_sep_chars},
1846 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1847 format_xml_formats => $opt->{format_xml_formats},
1848 format_asn_formats => $opt->{format_asn_formats},
1849 format_row_callbacks => $opt->{format_row_callbacks},
1850 format_hash_callbacks => $opt->{format_hash_callbacks},
1855 format => $param->{format},
1856 params => { map { $_ => $param->{$_} } @pass_params },
1858 default_csv => $opt->{default_csv},
1859 preinsert_callback => $opt->{preinsert_callback},
1860 postinsert_callback => $opt->{postinsert_callback},
1861 insert_args_callback => $opt->{insert_args_callback},
1864 if ( $opt->{'batch_namecol'} ) {
1865 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1866 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1869 my $error = FS::Record::batch_import( \%iopt );
1873 die "$error\n" if $error;
1876 =item batch_import PARAM_HASHREF
1878 Class method for batch imports. Available params:
1884 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1890 =item format_headers
1892 =item format_sep_chars
1894 =item format_fixedlength_formats
1896 =item format_row_callbacks
1898 =item format_hash_callbacks - After parsing, before object creation
1900 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1902 =item preinsert_callback
1904 =item postinsert_callback
1910 FS::queue object, will be updated with progress
1916 csv, xls, fixedlength, xml
1928 warn "$me batch_import call with params: \n". Dumper($param)
1931 my $table = $param->{table};
1933 my $job = $param->{job};
1934 my $file = $param->{file};
1935 my $params = $param->{params} || {};
1937 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1938 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1940 my( $type, $header, $sep_char,
1941 $fixedlength_format, $xml_format, $asn_format,
1942 $parser_opt, $row_callback, $hash_callback, @fields );
1944 my $postinsert_callback = '';
1945 $postinsert_callback = $param->{'postinsert_callback'}
1946 if $param->{'postinsert_callback'};
1947 my $preinsert_callback = '';
1948 $preinsert_callback = $param->{'preinsert_callback'}
1949 if $param->{'preinsert_callback'};
1950 my $insert_args_callback = '';
1951 $insert_args_callback = $param->{'insert_args_callback'}
1952 if $param->{'insert_args_callback'};
1954 if ( $param->{'format'} ) {
1956 my $format = $param->{'format'};
1957 my $formats = $param->{formats};
1958 die "unknown format $format" unless exists $formats->{ $format };
1960 $type = $param->{'format_types'}
1961 ? $param->{'format_types'}{ $format }
1962 : $param->{type} || 'csv';
1965 $header = $param->{'format_headers'}
1966 ? $param->{'format_headers'}{ $param->{'format'} }
1969 $sep_char = $param->{'format_sep_chars'}
1970 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1973 $fixedlength_format =
1974 $param->{'format_fixedlength_formats'}
1975 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1979 $param->{'format_parser_opts'}
1980 ? $param->{'format_parser_opts'}{ $param->{'format'} }
1984 $param->{'format_xml_formats'}
1985 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1989 $param->{'format_asn_formats'}
1990 ? $param->{'format_asn_formats'}{ $param->{'format'} }
1994 $param->{'format_row_callbacks'}
1995 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1999 $param->{'format_hash_callbacks'}
2000 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
2003 @fields = @{ $formats->{ $format } };
2005 } elsif ( $param->{'fields'} ) {
2007 $type = ''; #infer from filename
2010 $fixedlength_format = '';
2012 $hash_callback = '';
2013 @fields = @{ $param->{'fields'} };
2016 die "neither format nor fields specified";
2019 #my $file = $param->{file};
2022 if ( $file =~ /\.(\w+)$/i ) {
2026 warn "can't parse file type from filename $file; defaulting to CSV";
2030 if $param->{'default_csv'} && $type ne 'xls';
2038 my $asn_header_buffer;
2039 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2041 if ( $type eq 'csv' ) {
2043 $parser_opt->{'binary'} = 1;
2044 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2045 $parser = Text::CSV_XS->new($parser_opt);
2047 } elsif ( $type eq 'fixedlength' ) {
2049 eval "use Parse::FixedLength;";
2051 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2054 die "Unknown file type $type\n";
2057 @buffer = split(/\r?\n/, slurp($file) );
2058 splice(@buffer, 0, ($header || 0) );
2059 $count = scalar(@buffer);
2061 } elsif ( $type eq 'xls' ) {
2063 eval "use Spreadsheet::ParseExcel;";
2066 eval "use DateTime::Format::Excel;";
2067 #for now, just let the error be thrown if it is used, since only CDR
2068 # formats bill_west and troop use it, not other excel-parsing things
2071 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2073 $parser = $excel->{Worksheet}[0]; #first sheet
2075 $count = $parser->{MaxRow} || $parser->{MinRow};
2078 $row = $header || 0;
2080 } elsif ( $type eq 'xml' ) {
2083 eval "use XML::Simple;";
2085 my $xmlrow = $xml_format->{'xmlrow'};
2086 $parser = $xml_format->{'xmlkeys'};
2087 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2088 my $data = XML::Simple::XMLin(
2090 'SuppressEmpty' => '', #sets empty values to ''
2094 $rows = $rows->{$_} foreach @$xmlrow;
2095 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2096 $count = @buffer = @$rows;
2098 } elsif ( $type eq 'asn.1' ) {
2100 eval "use Convert::ASN1";
2103 my $asn = Convert::ASN1->new;
2104 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2106 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2108 my $data = slurp($file);
2109 my $asn_output = $parser->decode( $data )
2110 or return "No ". $asn_format->{'macro'}. " found\n";
2112 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2114 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2115 $count = @buffer = @$rows;
2118 die "Unknown file type $type\n";
2123 local $SIG{HUP} = 'IGNORE';
2124 local $SIG{INT} = 'IGNORE';
2125 local $SIG{QUIT} = 'IGNORE';
2126 local $SIG{TERM} = 'IGNORE';
2127 local $SIG{TSTP} = 'IGNORE';
2128 local $SIG{PIPE} = 'IGNORE';
2130 my $oldAutoCommit = $FS::UID::AutoCommit;
2131 local $FS::UID::AutoCommit = 0;
2134 #my $params = $param->{params} || {};
2135 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2136 my $batch_col = $param->{'batch_keycol'};
2138 my $batch_class = 'FS::'. $param->{'batch_table'};
2139 my $batch = $batch_class->new({
2140 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2142 my $error = $batch->insert;
2144 $dbh->rollback if $oldAutoCommit;
2145 return "can't insert batch record: $error";
2147 #primary key via dbdef? (so the column names don't have to match)
2148 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2150 $params->{ $batch_col } = $batch_value;
2153 #my $job = $param->{job};
2156 my $unique_skip = 0; #lines skipped because they're already in the system
2157 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2161 my %hash = %$params;
2162 if ( $type eq 'csv' ) {
2164 last unless scalar(@buffer);
2165 $line = shift(@buffer);
2167 next if $line =~ /^\s*$/; #skip empty lines
2169 $line = &{$row_callback}($line) if $row_callback;
2171 next if $line =~ /^\s*$/; #skip empty lines
2173 $parser->parse($line) or do {
2174 $dbh->rollback if $oldAutoCommit;
2175 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2177 @columns = $parser->fields();
2179 } elsif ( $type eq 'fixedlength' ) {
2181 last unless scalar(@buffer);
2182 $line = shift(@buffer);
2184 @columns = $parser->parse($line);
2186 } elsif ( $type eq 'xls' ) {
2188 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2189 || ! $parser->{Cells}[$row];
2191 my @row = @{ $parser->{Cells}[$row] };
2192 @columns = map $_->{Val}, @row;
2195 #warn $z++. ": $_\n" for @columns;
2197 } elsif ( $type eq 'xml' ) {
2199 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2200 last unless scalar(@buffer);
2201 my $row = shift @buffer;
2202 @columns = @{ $row }{ @$parser };
2204 } elsif ( $type eq 'asn.1' ) {
2206 last unless scalar(@buffer);
2207 my $row = shift @buffer;
2208 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2209 if $asn_format->{row_callback};
2210 foreach my $key ( keys %{ $asn_format->{map} } ) {
2211 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2215 die "Unknown file type $type\n";
2220 foreach my $field ( @fields ) {
2222 my $value = shift @columns;
2224 if ( ref($field) eq 'CODE' ) {
2225 #&{$field}(\%hash, $value);
2226 push @later, $field, $value;
2228 #??? $hash{$field} = $value if length($value);
2229 $hash{$field} = $value if defined($value) && length($value);
2234 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2235 && length($1) == $custnum_length ) {
2236 $hash{custnum} = $2;
2239 %hash = &{$hash_callback}(%hash) if $hash_callback;
2241 #my $table = $param->{table};
2242 my $class = "FS::$table";
2244 my $record = $class->new( \%hash );
2247 while ( scalar(@later) ) {
2248 my $sub = shift @later;
2249 my $data = shift @later;
2251 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2254 $dbh->rollback if $oldAutoCommit;
2255 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2257 last if exists( $param->{skiprow} );
2259 $unique_skip++ if $param->{unique_skip}; #line is already in the system
2260 next if exists( $param->{skiprow} );
2262 if ( $preinsert_callback ) {
2263 my $error = &{$preinsert_callback}($record, $param);
2265 $dbh->rollback if $oldAutoCommit;
2266 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2269 next if exists $param->{skiprow} && $param->{skiprow};
2272 my @insert_args = ();
2273 if ( $insert_args_callback ) {
2274 @insert_args = &{$insert_args_callback}($record, $param);
2277 my $error = $record->insert(@insert_args);
2280 $dbh->rollback if $oldAutoCommit;
2281 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2287 if ( $postinsert_callback ) {
2288 my $error = &{$postinsert_callback}($record, $param);
2290 $dbh->rollback if $oldAutoCommit;
2291 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2296 if ( $job && time - $min_sec > $last ) { #progress bar
2297 $job->update_statustext( int(100 * $imported / $count) );
2303 unless ( $imported || $param->{empty_ok} ) {
2304 $dbh->rollback if $oldAutoCommit;
2305 # freeside-cdr-conexiant-import is sensitive to the text of this message
2306 return $unique_skip ? "All records in file were previously imported" : "Empty file!";
2309 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2316 my( $self, $action, $time ) = @_;
2320 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2323 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2324 real_fields($self->table);
2327 # If we're encrypting then don't store the payinfo in the history
2328 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2329 @fields = grep { $_ ne 'payinfo' } @fields;
2332 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2334 "INSERT INTO h_". $self->table. " ( ".
2335 join(', ', qw(history_date history_usernum history_action), @fields ).
2338 $FS::CurrentUser::CurrentUser->usernum,
2339 dbh->quote($action),
2348 B<Warning>: External use is B<deprecated>.
2350 Replaces COLUMN in record with a unique number, using counters in the
2351 filesystem. Used by the B<insert> method on single-field unique columns
2352 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2353 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2355 Returns the new value.
2360 my($self,$field) = @_;
2361 my($table)=$self->table;
2363 croak "Unique called on field $field, but it is ",
2364 $self->getfield($field),
2366 if $self->getfield($field);
2368 #warn "table $table is tainted" if is_tainted($table);
2369 #warn "field $field is tainted" if is_tainted($field);
2371 my($counter) = new File::CounterFile "$table.$field",0;
2373 my $index = $counter->inc;
2374 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2376 $index =~ /^(\d*)$/;
2379 $self->setfield($field,$index);
2383 =item ut_float COLUMN
2385 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2386 null. If there is an error, returns the error, otherwise returns false.
2391 my($self,$field)=@_ ;
2392 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2393 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2394 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2395 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2396 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2397 $self->setfield($field,$1);
2400 =item ut_floatn COLUMN
2402 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2403 null. If there is an error, returns the error, otherwise returns false.
2407 #false laziness w/ut_ipn
2409 my( $self, $field ) = @_;
2410 if ( $self->getfield($field) =~ /^()$/ ) {
2411 $self->setfield($field,'');
2414 $self->ut_float($field);
2418 =item ut_sfloat COLUMN
2420 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2421 May not be null. If there is an error, returns the error, otherwise returns
2427 my($self,$field)=@_ ;
2428 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2429 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2430 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2431 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2432 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2433 $self->setfield($field,$1);
2436 =item ut_sfloatn COLUMN
2438 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2439 null. If there is an error, returns the error, otherwise returns false.
2444 my( $self, $field ) = @_;
2445 if ( $self->getfield($field) =~ /^()$/ ) {
2446 $self->setfield($field,'');
2449 $self->ut_sfloat($field);
2453 =item ut_snumber COLUMN
2455 Check/untaint signed numeric data (whole numbers). If there is an error,
2456 returns the error, otherwise returns false.
2461 my($self, $field) = @_;
2462 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2463 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2464 $self->setfield($field, "$1$2");
2468 =item ut_snumbern COLUMN
2470 Check/untaint signed numeric data (whole numbers). If there is an error,
2471 returns the error, otherwise returns false.
2476 my($self, $field) = @_;
2477 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2478 or return "Illegal (numeric) $field: ". $self->getfield($field);
2480 return "Illegal (numeric) $field: ". $self->getfield($field)
2483 $self->setfield($field, "$1$2");
2487 =item ut_number COLUMN
2489 Check/untaint simple numeric data (whole numbers). May not be null. If there
2490 is an error, returns the error, otherwise returns false.
2495 my($self,$field)=@_;
2496 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2497 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2498 $self->setfield($field,$1);
2502 =item ut_numbern COLUMN
2504 Check/untaint simple numeric data (whole numbers). May be null. If there is
2505 an error, returns the error, otherwise returns false.
2510 my($self,$field)=@_;
2511 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2512 or return "Illegal (numeric) $field: ". $self->getfield($field);
2513 $self->setfield($field,$1);
2517 =item ut_decimal COLUMN[, DIGITS]
2519 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2520 error, returns the error, otherwise returns false.
2522 =item ut_decimaln COLUMN[, DIGITS]
2524 Check/untaint decimal numbers. May be null. If there is an error, returns
2525 the error, otherwise returns false.
2530 my($self, $field, $digits) = @_;
2532 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2533 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2534 $self->setfield($field, $1);
2539 my($self, $field, $digits) = @_;
2540 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2541 or return "Illegal (decimal) $field: ".$self->getfield($field);
2542 $self->setfield($field, $1);
2546 =item ut_money COLUMN
2548 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2549 is an error, returns the error, otherwise returns false.
2554 my($self,$field)=@_;
2556 if ( $self->getfield($field) eq '' ) {
2557 $self->setfield($field, 0);
2558 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2559 #handle one decimal place without barfing out
2560 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2561 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2562 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2564 return "Illegal (money) $field: ". $self->getfield($field);
2570 =item ut_moneyn COLUMN
2572 Check/untaint monetary numbers. May be negative. If there
2573 is an error, returns the error, otherwise returns false.
2578 my($self,$field)=@_;
2579 if ($self->getfield($field) eq '') {
2580 $self->setfield($field, '');
2583 $self->ut_money($field);
2586 =item ut_currencyn COLUMN
2588 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2589 is an error, returns the error, otherwise returns false.
2594 my($self, $field) = @_;
2595 if ($self->getfield($field) eq '') { #can be null
2596 $self->setfield($field, '');
2599 $self->ut_currency($field);
2602 =item ut_currency COLUMN
2604 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2605 there is an error, returns the error, otherwise returns false.
2610 my($self, $field) = @_;
2611 my $value = uc( $self->getfield($field) );
2612 if ( code2currency($value) ) {
2613 $self->setfield($value);
2615 return "Unknown currency $value";
2621 =item ut_text COLUMN
2623 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2624 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2625 May not be null. If there is an error, returns the error, otherwise returns
2631 my($self,$field)=@_;
2632 #warn "msgcat ". \&msgcat. "\n";
2633 #warn "notexist ". \¬exist. "\n";
2634 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2635 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2636 # see perldoc perluniprops
2637 $self->getfield($field)
2638 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2639 or return gettext('illegal_or_empty_text'). " $field: ".
2640 $self->getfield($field);
2641 $self->setfield($field,$1);
2645 =item ut_textn COLUMN
2647 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2648 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2649 May be null. If there is an error, returns the error, otherwise returns false.
2654 my($self,$field)=@_;
2655 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2656 $self->ut_text($field);
2659 =item ut_alpha COLUMN
2661 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2662 an error, returns the error, otherwise returns false.
2667 my($self,$field)=@_;
2668 $self->getfield($field) =~ /^(\w+)$/
2669 or return "Illegal or empty (alphanumeric) $field: ".
2670 $self->getfield($field);
2671 $self->setfield($field,$1);
2675 =item ut_alphan COLUMN
2677 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2678 error, returns the error, otherwise returns false.
2683 my($self,$field)=@_;
2684 $self->getfield($field) =~ /^(\w*)$/
2685 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2686 $self->setfield($field,$1);
2690 =item ut_alphasn COLUMN
2692 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2693 an error, returns the error, otherwise returns false.
2698 my($self,$field)=@_;
2699 $self->getfield($field) =~ /^([\w ]*)$/
2700 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2701 $self->setfield($field,$1);
2706 =item ut_alpha_lower COLUMN
2708 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2709 there is an error, returns the error, otherwise returns false.
2713 sub ut_alpha_lower {
2714 my($self,$field)=@_;
2715 $self->getfield($field) =~ /[[:upper:]]/
2716 and return "Uppercase characters are not permitted in $field";
2717 $self->ut_alpha($field);
2720 =item ut_phonen COLUMN [ COUNTRY ]
2722 Check/untaint phone numbers. May be null. If there is an error, returns
2723 the error, otherwise returns false.
2725 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2726 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2731 my( $self, $field, $country ) = @_;
2732 return $self->ut_alphan($field) unless defined $country;
2733 my $phonen = $self->getfield($field);
2734 if ( $phonen eq '' ) {
2735 $self->setfield($field,'');
2736 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2738 $phonen = $conf->config('cust_main-default_areacode').$phonen
2739 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2740 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2741 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2742 $phonen = "$1-$2-$3";
2743 $phonen .= " x$4" if $4;
2744 $self->setfield($field,$phonen);
2746 warn "warning: don't know how to check phone numbers for country $country";
2747 return $self->ut_textn($field);
2754 Check/untaint hexadecimal values.
2759 my($self, $field) = @_;
2760 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2761 or return "Illegal (hex) $field: ". $self->getfield($field);
2762 $self->setfield($field, uc($1));
2766 =item ut_hexn COLUMN
2768 Check/untaint hexadecimal values. May be null.
2773 my($self, $field) = @_;
2774 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2775 or return "Illegal (hex) $field: ". $self->getfield($field);
2776 $self->setfield($field, uc($1));
2780 =item ut_mac_addr COLUMN
2782 Check/untaint mac addresses. May be null.
2787 my($self, $field) = @_;
2789 my $mac = $self->get($field);
2792 $self->set($field, $mac);
2794 my $e = $self->ut_hex($field);
2797 return "Illegal (mac address) $field: ". $self->getfield($field)
2798 unless length($self->getfield($field)) == 12;
2804 =item ut_mac_addrn COLUMN
2806 Check/untaint mac addresses. May be null.
2811 my($self, $field) = @_;
2812 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2817 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2823 my( $self, $field ) = @_;
2824 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2825 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2826 or return "Illegal (IP address) $field: ". $self->getfield($field);
2827 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2828 $self->setfield($field, "$1.$2.$3.$4");
2834 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2835 to 127.0.0.1. May be null.
2840 my( $self, $field ) = @_;
2841 if ( $self->getfield($field) =~ /^()$/ ) {
2842 $self->setfield($field,'');
2845 $self->ut_ip($field);
2849 =item ut_ip46 COLUMN
2851 Check/untaint IPv4 or IPv6 address.
2856 my( $self, $field ) = @_;
2857 my $ip = NetAddr::IP->new($self->getfield($field))
2858 or return "Illegal (IP address) $field: ".$self->getfield($field);
2859 $self->setfield($field, lc($ip->addr));
2865 Check/untaint IPv6 or IPv6 address. May be null.
2870 my( $self, $field ) = @_;
2871 if ( $self->getfield($field) =~ /^$/ ) {
2872 $self->setfield($field, '');
2875 $self->ut_ip46($field);
2878 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2880 Check/untaint coordinates.
2881 Accepts the following forms:
2891 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2892 The latter form (that is, the MMM are thousands of minutes) is
2893 assumed if the "MMM" is exactly three digits or two digits > 59.
2895 To be safe, just use the DDD.DDDDD form.
2897 If LOWER or UPPER are specified, then the coordinate is checked
2898 for lower and upper bounds, respectively.
2903 my ($self, $field) = (shift, shift);
2906 if ( $field =~ /latitude/ ) {
2907 $lower = $lat_lower;
2909 } elsif ( $field =~ /longitude/ ) {
2911 $upper = $lon_upper;
2914 my $coord = $self->getfield($field);
2915 my $neg = $coord =~ s/^(-)//;
2917 # ignore degree symbol at the end,
2918 # but not otherwise supporting degree/minutes/seconds symbols
2919 $coord =~ s/\N{DEGREE SIGN}\s*$//;
2921 my ($d, $m, $s) = (0, 0, 0);
2924 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2925 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2926 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2928 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2931 return "Invalid (coordinate with minutes > 59) $field: "
2932 . $self->getfield($field);
2935 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2937 if (defined($lower) and ($coord < $lower)) {
2938 return "Invalid (coordinate < $lower) $field: "
2939 . $self->getfield($field);;
2942 if (defined($upper) and ($coord > $upper)) {
2943 return "Invalid (coordinate > $upper) $field: "
2944 . $self->getfield($field);;
2947 $self->setfield($field, $coord);
2951 return "Invalid (coordinate) $field: " . $self->getfield($field);
2955 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2957 Same as ut_coord, except optionally null.
2963 my ($self, $field) = (shift, shift);
2965 if ($self->getfield($field) =~ /^\s*$/) {
2968 return $self->ut_coord($field, @_);
2973 =item ut_domain COLUMN
2975 Check/untaint host and domain names. May not be null.
2980 my( $self, $field ) = @_;
2981 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2982 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2983 or return "Illegal (hostname) $field: ". $self->getfield($field);
2984 $self->setfield($field,$1);
2988 =item ut_domainn COLUMN
2990 Check/untaint host and domain names. May be null.
2995 my( $self, $field ) = @_;
2996 if ( $self->getfield($field) =~ /^()$/ ) {
2997 $self->setfield($field,'');
3000 $self->ut_domain($field);
3004 =item ut_name COLUMN
3006 Check/untaint proper names; allows alphanumerics, spaces and the following
3007 punctuation: , . - '
3014 my( $self, $field ) = @_;
3015 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
3016 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
3021 $self->setfield($field, $name);
3025 =item ut_namen COLUMN
3027 Check/untaint proper names; allows alphanumerics, spaces and the following
3028 punctuation: , . - '
3035 my( $self, $field ) = @_;
3036 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3037 $self->ut_name($field);
3042 Check/untaint zip codes.
3046 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3049 my( $self, $field, $country ) = @_;
3051 if ( $country eq 'US' ) {
3053 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3054 or return gettext('illegal_zip'). " $field for country $country: ".
3055 $self->getfield($field);
3056 $self->setfield($field, $1);
3058 } elsif ( $country eq 'CA' ) {
3060 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3061 or return gettext('illegal_zip'). " $field for country $country: ".
3062 $self->getfield($field);
3063 $self->setfield($field, "$1 $2");
3067 if ( $self->getfield($field) =~ /^\s*$/
3068 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3071 $self->setfield($field,'');
3073 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3074 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3075 $self->setfield($field,$1);
3083 =item ut_country COLUMN
3085 Check/untaint country codes. Country names are changed to codes, if possible -
3086 see L<Locale::Country>.
3091 my( $self, $field ) = @_;
3092 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3093 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3094 && country2code($1) ) {
3095 $self->setfield($field,uc(country2code($1)));
3098 $self->getfield($field) =~ /^(\w\w)$/
3099 or return "Illegal (country) $field: ". $self->getfield($field);
3100 $self->setfield($field,uc($1));
3104 =item ut_anything COLUMN
3106 Untaints arbitrary data. Be careful.
3111 my( $self, $field ) = @_;
3112 $self->getfield($field) =~ /^(.*)$/s
3113 or return "Illegal $field: ". $self->getfield($field);
3114 $self->setfield($field,$1);
3118 =item ut_enum COLUMN CHOICES_ARRAYREF
3120 Check/untaint a column, supplying all possible choices, like the "enum" type.
3125 my( $self, $field, $choices ) = @_;
3126 foreach my $choice ( @$choices ) {
3127 if ( $self->getfield($field) eq $choice ) {
3128 $self->setfield($field, $choice);
3132 return "Illegal (enum) field $field: ". $self->getfield($field);
3135 =item ut_enumn COLUMN CHOICES_ARRAYREF
3137 Like ut_enum, except the null value is also allowed.
3142 my( $self, $field, $choices ) = @_;
3143 $self->getfield($field)
3144 ? $self->ut_enum($field, $choices)
3148 =item ut_flag COLUMN
3150 Check/untaint a column if it contains either an empty string or 'Y'. This
3151 is the standard form for boolean flags in Freeside.
3156 my( $self, $field ) = @_;
3157 my $value = uc($self->getfield($field));
3158 if ( $value eq '' or $value eq 'Y' ) {
3159 $self->setfield($field, $value);
3162 return "Illegal (flag) field $field: $value";
3165 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3167 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3168 on the column first.
3172 sub ut_foreign_key {
3173 my( $self, $field, $table, $foreign ) = @_;
3174 return $self->ut_number($field) if $no_check_foreign;
3175 qsearchs($table, { $foreign => $self->getfield($field) })
3176 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3177 " in $table.$foreign";
3181 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3183 Like ut_foreign_key, except the null value is also allowed.
3187 sub ut_foreign_keyn {
3188 my( $self, $field, $table, $foreign ) = @_;
3189 $self->getfield($field)
3190 ? $self->ut_foreign_key($field, $table, $foreign)
3194 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3196 Checks this column as an agentnum, taking into account the current users's
3197 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3198 right or rights allowing no agentnum.
3202 sub ut_agentnum_acl {
3203 my( $self, $field ) = (shift, shift);
3204 my $null_acl = scalar(@_) ? shift : [];
3205 $null_acl = [ $null_acl ] unless ref($null_acl);
3207 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3208 return "Illegal agentnum: $error" if $error;
3210 my $curuser = $FS::CurrentUser::CurrentUser;
3212 if ( $self->$field() ) {
3214 return 'Access denied to agent '. $self->$field()
3215 unless $curuser->agentnum($self->$field());
3219 return 'Access denied to global'
3220 unless grep $curuser->access_right($_), @$null_acl;
3228 =item trim_whitespace FIELD[, FIELD ... ]
3230 Strip leading and trailing spaces from the value in the named FIELD(s).
3234 sub trim_whitespace {
3236 foreach my $field (@_) {
3237 my $value = $self->get($field);
3240 $self->set($field, $value);
3244 =item fields [ TABLE ]
3246 This is a wrapper for real_fields. Code that called
3247 fields before should probably continue to call fields.
3252 my $something = shift;
3254 if($something->isa('FS::Record')) {
3255 $table = $something->table;
3257 $table = $something;
3258 #$something = "FS::$table";
3260 return (real_fields($table));
3264 =item encrypt($value)
3266 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3268 Returns the encrypted string.
3270 You should generally not have to worry about calling this, as the system handles this for you.
3275 my ($self, $value) = @_;
3276 my $encrypted = $value;
3278 if ($conf_encryption) {
3279 if ($self->is_encrypted($value)) {
3280 # Return the original value if it isn't plaintext.
3281 $encrypted = $value;
3284 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3285 # RSA doesn't like the empty string so let's pack it up
3286 # The database doesn't like the RSA data so uuencode it
3287 my $length = length($value)+1;
3288 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3290 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3297 =item is_encrypted($value)
3299 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3305 my ($self, $value) = @_;
3306 # could be more precise about it, but this will do for now
3307 $value =~ /^M/ && length($value) > 80;
3310 =item decrypt($value)
3312 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3314 You should generally not have to worry about calling this, as the system handles this for you.
3319 my ($self,$value) = @_;
3320 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3321 if ($conf_encryption && $self->is_encrypted($value)) {
3323 if (ref($rsa_decrypt) =~ /::RSA/) {
3324 my $encrypted = unpack ("u*", $value);
3325 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3326 if ($@) {warn "Decryption Failed"};
3334 #Initialize the Module
3335 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3337 if ($conf_encryptionmodule && $conf_encryptionmodule ne '') {
3338 $rsa_module = $conf_encryptionmodule;
3342 eval ("require $rsa_module"); # No need to import the namespace
3345 # Initialize Encryption
3346 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3347 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3350 # Intitalize Decryption
3351 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3352 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3356 =item h_search ACTION
3358 Given an ACTION, either "insert", or "delete", returns the appropriate history
3359 record corresponding to this record, if any.
3364 my( $self, $action ) = @_;
3366 my $table = $self->table;
3369 my $primary_key = dbdef->table($table)->primary_key;
3372 'table' => "h_$table",
3373 'hashref' => { $primary_key => $self->$primary_key(),
3374 'history_action' => $action,
3382 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3383 appropriate history record corresponding to this record, if any.
3388 my($self, $action) = @_;
3389 my $h = $self->h_search($action);
3390 $h ? $h->history_date : '';
3393 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3395 A class or object method. Executes the sql statement represented by SQL and
3396 returns a scalar representing the result: the first column of the first row.
3398 Dies on bogus SQL. Returns an empty string if no row is returned.
3400 Typically used for statments which return a single value such as "SELECT
3401 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3406 my($self, $sql) = (shift, shift);
3407 my $sth = dbh->prepare($sql) or die dbh->errstr;
3409 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3410 my $row = $sth->fetchrow_arrayref or return '';
3411 my $scalar = $row->[0];
3412 defined($scalar) ? $scalar : '';
3415 =item count [ WHERE [, PLACEHOLDER ...] ]
3417 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3418 with optional WHERE. Must be called as method on a class with an
3424 my($self, $where) = (shift, shift);
3425 my $table = $self->table or die 'count called on object of class '.ref($self);
3426 my $sql = "SELECT COUNT(*) FROM $table";
3427 $sql .= " WHERE $where" if $where;
3428 $self->scalar_sql($sql, @_);
3431 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3433 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3434 with optional (but almost always needed) WHERE.
3439 my($self, $where) = (shift, shift);
3440 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3441 my $sql = "SELECT 1 FROM $table";
3442 $sql .= " WHERE $where" if $where;
3444 $self->scalar_sql($sql, @_);
3453 =item real_fields [ TABLE ]
3455 Returns a list of the real columns in the specified table. Called only by
3456 fields() and other subroutines elsewhere in FS::Record.
3463 my($table_obj) = dbdef->table($table);
3464 confess "Unknown table $table" unless $table_obj;
3465 $table_obj->columns;
3468 =item pvf FIELD_NAME
3470 Returns the FS::part_virtual_field object corresponding to a field in the
3471 record (specified by FIELD_NAME).
3476 my ($self, $name) = (shift, shift);
3478 if(grep /^$name$/, $self->virtual_fields) {
3480 my $concat = [ "'cf_'", "name" ];
3481 return qsearchs({ table => 'part_virtual_field',
3482 hashref => { dbtable => $self->table,
3485 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3491 =item _quote VALUE, TABLE, COLUMN
3493 This is an internal function used to construct SQL statements. It returns
3494 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3495 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3500 my($value, $table, $column) = @_;
3501 my $column_obj = dbdef->table($table)->column($column);
3502 my $column_type = $column_obj->type;
3503 my $nullable = $column_obj->null;
3505 utf8::upgrade($value);
3507 warn " $table.$column: $value ($column_type".
3508 ( $nullable ? ' NULL' : ' NOT NULL' ).
3509 ")\n" if $DEBUG > 2;
3511 if ( $value eq '' && $nullable ) {
3513 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3514 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3517 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3518 ! $column_type =~ /(char|binary|text)$/i ) {
3520 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3521 && driver_name eq 'Pg'
3525 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3526 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3527 # single-quote the whole mess, and put an "E" in front.
3528 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3536 This is deprecated. Don't use it.
3538 It returns a hash-type list with the fields of this record's table set true.
3543 carp "warning: hfields is deprecated";
3546 foreach (fields($table)) {
3555 "$_: ". $self->getfield($_). "|"
3556 } (fields($self->table)) );
3559 sub DESTROY { return; }
3563 # #use Carp qw(cluck);
3564 # #cluck "DESTROYING $self";
3565 # warn "DESTROYING $self";
3569 # return ! eval { join('',@_), kill 0; 1; };
3572 =item str2time_sql [ DRIVER_NAME ]
3574 Returns a function to convert to unix time based on database type, such as
3575 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3576 the str2time_sql_closing method to return a closing string rather than just
3577 using a closing parenthesis as previously suggested.
3579 You can pass an optional driver name such as "Pg", "mysql" or
3580 $dbh->{Driver}->{Name} to return a function for that database instead of
3581 the current database.
3586 my $driver = shift || driver_name;
3588 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3589 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3591 warn "warning: unknown database type $driver; guessing how to convert ".
3592 "dates to UNIX timestamps";
3593 return 'EXTRACT(EPOCH FROM ';
3597 =item str2time_sql_closing [ DRIVER_NAME ]
3599 Returns the closing suffix of a function to convert to unix time based on
3600 database type, such as ")::integer" for Pg or ")" for mysql.
3602 You can pass an optional driver name such as "Pg", "mysql" or
3603 $dbh->{Driver}->{Name} to return a function for that database instead of
3604 the current database.
3608 sub str2time_sql_closing {
3609 my $driver = shift || driver_name;
3611 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3615 =item regexp_sql [ DRIVER_NAME ]
3617 Returns the operator to do a regular expression comparison based on database
3618 type, such as '~' for Pg or 'REGEXP' for mysql.
3620 You can pass an optional driver name such as "Pg", "mysql" or
3621 $dbh->{Driver}->{Name} to return a function for that database instead of
3622 the current database.
3627 my $driver = shift || driver_name;
3629 return '~' if $driver =~ /^Pg/i;
3630 return 'REGEXP' if $driver =~ /^mysql/i;
3632 die "don't know how to use regular expressions in ". driver_name." databases";
3636 =item not_regexp_sql [ DRIVER_NAME ]
3638 Returns the operator to do a regular expression negation based on database
3639 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3641 You can pass an optional driver name such as "Pg", "mysql" or
3642 $dbh->{Driver}->{Name} to return a function for that database instead of
3643 the current database.
3647 sub not_regexp_sql {
3648 my $driver = shift || driver_name;
3650 return '!~' if $driver =~ /^Pg/i;
3651 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3653 die "don't know how to use regular expressions in ". driver_name." databases";
3657 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3659 Returns the items concatenated based on database type, using "CONCAT()" for
3660 mysql and " || " for Pg and other databases.
3662 You can pass an optional driver name such as "Pg", "mysql" or
3663 $dbh->{Driver}->{Name} to return a function for that database instead of
3664 the current database.
3669 my $driver = ref($_[0]) ? driver_name : shift;
3672 if ( $driver =~ /^mysql/i ) {
3673 'CONCAT('. join(',', @$items). ')';
3675 join('||', @$items);
3680 =item group_concat_sql COLUMN, DELIMITER
3682 Returns an SQL expression to concatenate an aggregate column, using
3683 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3687 sub group_concat_sql {
3688 my ($col, $delim) = @_;
3689 $delim = dbh->quote($delim);
3690 if ( driver_name() =~ /^mysql/i ) {
3691 # DISTINCT(foo) is valid as $col
3692 return "GROUP_CONCAT($col SEPARATOR $delim)";
3694 return "array_to_string(array_agg($col), $delim)";
3698 =item midnight_sql DATE
3700 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3701 on that day in the system timezone, using the default driver name.
3706 my $driver = driver_name;
3708 if ( $driver =~ /^mysql/i ) {
3709 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3712 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3720 This module should probably be renamed, since much of the functionality is
3721 of general use. It is not completely unlike Adapter::DBI (see below).
3723 Exported qsearch and qsearchs should be deprecated in favor of method calls
3724 (against an FS::Record object like the old search and searchs that qsearch
3725 and qsearchs were on top of.)
3727 The whole fields / hfields mess should be removed.
3729 The various WHERE clauses should be subroutined.
3731 table string should be deprecated in favor of DBIx::DBSchema::Table.
3733 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3734 true maps to the database (and WHERE clauses) would also help.
3736 The ut_ methods should ask the dbdef for a default length.
3738 ut_sqltype (like ut_varchar) should all be defined
3740 A fallback check method should be provided which uses the dbdef.
3742 The ut_money method assumes money has two decimal digits.
3744 The Pg money kludge in the new method only strips `$'.
3746 The ut_phonen method only checks US-style phone numbers.
3748 The _quote function should probably use ut_float instead of a regex.
3750 All the subroutines probably should be methods, here or elsewhere.
3752 Probably should borrow/use some dbdef methods where appropriate (like sub
3755 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3756 or allow it to be set. Working around it is ugly any way around - DBI should
3757 be fixed. (only affects RDBMS which return uppercase column names)
3759 ut_zip should take an optional country like ut_phone.
3763 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3765 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.