2 use base qw( Exporter );
7 %virtual_fields_cache %fk_method_cache $fk_table_cache
8 $money_char $lat_lower $lon_upper
11 use Carp qw(carp cluck croak confess);
12 use Scalar::Util qw( blessed );
13 use File::Slurp qw( slurp );
14 use File::CounterFile;
16 use DBI qw(:sql_types);
17 use DBIx::DBSchema 0.43; #0.43 for foreign keys
20 use NetAddr::IP; # for validation
21 use FS::UID qw(dbh datasrc driver_name);
23 use FS::Schema qw(dbdef);
25 use FS::Msgcat qw(gettext);
26 #use FS::Conf; #dependency loop bs, in install_callback below instead
28 use FS::part_virtual_field;
32 our @encrypt_payby = qw( CARD DCRD CHEK DCHK );
34 #export dbdef for now... everything else expects to find it here
36 dbh fields hfields qsearch qsearchs dbdef jsearch
37 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql
38 concat_sql group_concat_sql
39 midnight_sql fk_methods_init
43 our $me = '[FS::Record]';
45 $use_placeholders = 0;
47 our $nowarn_identical = 0;
48 our $nowarn_classload = 0;
49 our $no_update_diff = 0;
52 our $qsearch_qualify_columns = 1;
54 our $no_check_foreign = 1; #well, not inefficiently in perl by default anymore
62 our $conf_encryption = '';
63 our $conf_encryptionmodule = '';
64 our $conf_encryptionpublickey = '';
65 our $conf_encryptionprivatekey = '';
66 FS::UID->install_callback( sub {
70 $conf = FS::Conf->new;
71 $conf_encryption = $conf->exists('encryption');
72 $conf_encryptionmodule = $conf->config('encryptionmodule');
73 $conf_encryptionpublickey = join("\n",$conf->config('encryptionpublickey'));
74 $conf_encryptionprivatekey = join("\n",$conf->config('encryptionprivatekey'));
75 $money_char = $conf->config('money_char') || '$';
76 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
77 $lat_lower = $nw_coords ? 1 : -90;
78 $lon_upper = $nw_coords ? -1 : 180;
80 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
82 if ( driver_name eq 'Pg' ) {
83 eval "use DBD::Pg ':pg_types'";
86 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
95 FS::Record - Database record objects
100 use FS::Record qw(dbh fields qsearch qsearchs);
102 $record = new FS::Record 'table', \%hash;
103 $record = new FS::Record 'table', { 'column' => 'value', ... };
105 $record = qsearchs FS::Record 'table', \%hash;
106 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
107 @records = qsearch FS::Record 'table', \%hash;
108 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
110 $table = $record->table;
111 $dbdef_table = $record->dbdef_table;
113 $value = $record->get('column');
114 $value = $record->getfield('column');
115 $value = $record->column;
117 $record->set( 'column' => 'value' );
118 $record->setfield( 'column' => 'value' );
119 $record->column('value');
121 %hash = $record->hash;
123 $hashref = $record->hashref;
125 $error = $record->insert;
127 $error = $record->delete;
129 $error = $new_record->replace($old_record);
131 # external use deprecated - handled by the database (at least for Pg, mysql)
132 $value = $record->unique('column');
134 $error = $record->ut_float('column');
135 $error = $record->ut_floatn('column');
136 $error = $record->ut_number('column');
137 $error = $record->ut_numbern('column');
138 $error = $record->ut_decimal('column');
139 $error = $record->ut_decimaln('column');
140 $error = $record->ut_snumber('column');
141 $error = $record->ut_snumbern('column');
142 $error = $record->ut_money('column');
143 $error = $record->ut_text('column');
144 $error = $record->ut_textn('column');
145 $error = $record->ut_alpha('column');
146 $error = $record->ut_alphan('column');
147 $error = $record->ut_phonen('column');
148 $error = $record->ut_anything('column');
149 $error = $record->ut_name('column');
151 $quoted_value = _quote($value,'table','field');
154 $fields = hfields('table');
155 if ( $fields->{Field} ) { # etc.
157 @fields = fields 'table'; #as a subroutine
158 @fields = $record->fields; #as a method call
163 (Mostly) object-oriented interface to database records. Records are currently
164 implemented on top of DBI. FS::Record is intended as a base class for
165 table-specific classes to inherit from, i.e. FS::cust_main.
171 =item new [ TABLE, ] HASHREF
173 Creates a new record. It doesn't store it in the database, though. See
174 L<"insert"> for that.
176 Note that the object stores this hash reference, not a distinct copy of the
177 hash it points to. You can ask the object for a copy with the I<hash>
180 TABLE can only be omitted when a dervived class overrides the table method.
186 my $class = ref($proto) || $proto;
188 bless ($self, $class);
190 unless ( defined ( $self->table ) ) {
191 $self->{'Table'} = shift;
192 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
193 unless $nowarn_classload;
196 $self->{'Hash'} = shift;
198 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
199 $self->{'Hash'}{$field}='';
202 $self->_rebless if $self->can('_rebless');
204 $self->{'modified'} = 0;
206 $self->_simplecache($self->{'Hash'}) if $self->can('_simplecache');
207 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
214 my $class = ref($proto) || $proto;
216 bless ($self, $class);
218 $self->{'Table'} = shift unless defined ( $self->table );
220 my $hashref = $self->{'Hash'} = shift;
222 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
223 my $obj = $cache->cache->{$hashref->{$cache->key}};
224 $obj->_cache($hashref, $cache) if $obj->can('_cache');
227 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
234 my $class = ref($proto) || $proto;
236 bless ($self, $class);
237 if ( defined $self->table ) {
238 cluck "create constructor is deprecated, use new!";
241 croak "FS::Record::create called (not from a subclass)!";
245 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
247 Searches the database for all records matching (at least) the key/value pairs
248 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
249 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
252 The preferred usage is to pass a hash reference of named parameters:
254 @records = qsearch( {
255 'table' => 'table_name',
256 'hashref' => { 'field' => 'value'
257 'field' => { 'op' => '<',
262 #these are optional...
264 'extra_sql' => 'AND field = ? AND intfield = ?',
265 'extra_param' => [ 'value', [ 5, 'int' ] ],
266 'order_by' => 'ORDER BY something',
267 #'cache_obj' => '', #optional
268 'addl_from' => 'LEFT JOIN othtable USING ( field )',
273 Much code still uses old-style positional parameters, this is also probably
274 fine in the common case where there are only two parameters:
276 my @records = qsearch( 'table', { 'field' => 'value' } );
278 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
279 the individual PARAMS_HASHREF queries
281 ###oops, argh, FS::Record::new only lets us create database fields.
282 #Normal behaviour if SELECT is not specified is `*', as in
283 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
284 #feature where you can specify SELECT - remember, the objects returned,
285 #although blessed into the appropriate `FS::TABLE' package, will only have the
286 #fields you specify. This might have unwanted results if you then go calling
287 #regular FS::TABLE methods
292 my %TYPE = (); #for debugging
295 my($type, $value) = @_;
297 my $bind_type = { TYPE => SQL_VARCHAR };
299 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
301 $bind_type = { TYPE => SQL_INTEGER };
303 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
305 if ( driver_name eq 'Pg' ) {
307 $bind_type = { pg_type => PG_BYTEA };
309 # $bind_type = ? #SQL_VARCHAR could be fine?
312 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
313 #fixed by DBD::Pg 2.11.8
314 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
315 #(make a Tron test first)
316 } elsif ( _is_fs_float( $type, $value ) ) {
318 $bind_type = { TYPE => SQL_DECIMAL };
327 my($type, $value) = @_;
328 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
329 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
337 my( @stable, @record, @cache );
338 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
340 my %union_options = ();
341 if ( ref($_[0]) eq 'ARRAY' ) {
344 foreach my $href ( @$optlist ) {
345 push @stable, ( $href->{'table'} or die "table name is required" );
346 push @record, ( $href->{'hashref'} || {} );
347 push @select, ( $href->{'select'} || '*' );
348 push @extra_sql, ( $href->{'extra_sql'} || '' );
349 push @extra_param, ( $href->{'extra_param'} || [] );
350 push @order_by, ( $href->{'order_by'} || '' );
351 push @cache, ( $href->{'cache_obj'} || '' );
352 push @addl_from, ( $href->{'addl_from'} || '' );
353 push @debug, ( $href->{'debug'} || '' );
355 die "at least one hashref is required" unless scalar(@stable);
356 } elsif ( ref($_[0]) eq 'HASH' ) {
358 $stable[0] = $opt->{'table'} or die "table name is required";
359 $record[0] = $opt->{'hashref'} || {};
360 $select[0] = $opt->{'select'} || '*';
361 $extra_sql[0] = $opt->{'extra_sql'} || '';
362 $extra_param[0] = $opt->{'extra_param'} || [];
363 $order_by[0] = $opt->{'order_by'} || '';
364 $cache[0] = $opt->{'cache_obj'} || '';
365 $addl_from[0] = $opt->{'addl_from'} || '';
366 $debug[0] = $opt->{'debug'} || '';
377 my $cache = $cache[0];
383 foreach my $stable ( @stable ) {
385 carp '->qsearch on cust_main called' if $stable eq 'cust_main' && $DEBUG;
387 #stop altering the caller's hashref
388 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
389 my $select = shift @select;
390 my $extra_sql = shift @extra_sql;
391 my $extra_param = shift @extra_param;
392 my $order_by = shift @order_by;
393 my $cache = shift @cache;
394 my $addl_from = shift @addl_from;
395 my $debug = shift @debug;
397 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
399 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
402 my $table = $cache ? $cache->table : $stable;
403 my $dbdef_table = dbdef->table($table)
404 or die "No schema for table $table found - ".
405 "do you need to run freeside-upgrade?";
406 my $pkey = $dbdef_table->primary_key;
408 my @real_fields = grep exists($record->{$_}), real_fields($table);
410 my $statement .= "SELECT $select FROM $stable";
413 $statement .= " $addl_from";
414 # detect aliasing of the main table
415 if ( $addl_from =~ /^\s*AS\s+(\w+)/i ) {
419 if ( @real_fields ) {
420 $statement .= ' WHERE '. join(' AND ',
421 get_real_fields($table, $record, \@real_fields, $alias_main));
424 $statement .= " $extra_sql" if defined($extra_sql);
425 $statement .= " $order_by" if defined($order_by);
427 push @statement, $statement;
429 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
432 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
435 my $value = $record->{$field};
436 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
437 $value = $value->{'value'} if ref($value);
438 my $type = dbdef->table($table)->column($field)->type;
440 my $bind_type = _bind_type($type, $value);
444 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
446 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
450 push @bind_type, $bind_type;
454 foreach my $param ( @$extra_param ) {
455 my $bind_type = { TYPE => SQL_VARCHAR };
458 $value = $param->[0];
459 my $type = $param->[1];
460 $bind_type = _bind_type($type, $value);
463 push @bind_type, $bind_type;
467 my $statement = join( ' ) UNION ( ', @statement );
468 $statement = "( $statement )" if scalar(@statement) > 1;
469 $statement .= " $union_options{order_by}" if $union_options{order_by};
471 my $sth = $dbh->prepare($statement)
472 or croak "$dbh->errstr doing $statement";
475 foreach my $value ( @value ) {
476 my $bind_type = shift @bind_type;
477 $sth->bind_param($bind++, $value, $bind_type );
480 # $sth->execute( map $record->{$_},
481 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
482 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
484 my $ok = $sth->execute;
486 my $error = "Error executing \"$statement\"";
487 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
488 $error .= ': '. $sth->errstr;
493 # Determine how to format rows returned form a union query:
495 # * When all queries involved in the union are from the same table:
496 # Return an array of FS::$table_name objects
498 # * When union query is performed on multiple tables,
499 # Return an array of FS::Record objects
500 # ! Note: As far as I can tell, this functionality was broken, and
501 # ! actually results in a crash. Behavior is left intact
502 # ! as-is, in case the results are in use somewhere
504 # * Union query is performed on multiple table,
505 # and $union_options{classname_from_column} = 1
506 # Return an array of FS::$classname objects, where $classname is
507 # derived for each row from a static field inserted each returned
509 # e.g.: SELECT custnum,first,last,'cust_main' AS `__classname`'.
512 my $table = $stable[0];
514 $table = '' if grep { $_ ne $table } @stable;
515 $pkey = dbdef->table($table)->primary_key if $table;
518 tie %result, "Tie::IxHash";
519 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
520 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
521 %result = map { $_->{$pkey}, $_ } @stuff;
523 @result{@stuff} = @stuff;
528 #below was refactored out to _from_hashref, this should use it at some point
531 if ($union_options{classname_from_column}) {
534 # I'm not implementing the cache for this use case, at least not yet
537 for my $row (@stuff) {
538 my $table_class = $row->{__classname}
539 or die "`__classname` column must be set when ".
540 "using \$union_options{classname_from_column}";
541 push @return, new("FS::$table_class",$row);
545 elsif ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
546 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
547 #derivied class didn't override new method, so this optimization is safe
550 new_or_cached( "FS::$table", { %{$_} }, $cache )
554 new( "FS::$table", { %{$_} } )
558 #okay, its been tested
559 # warn "untested code (class FS::$table uses custom new method)";
561 eval 'FS::'. $table. '->new( { %{$_} } )';
565 # Check for encrypted fields and decrypt them.
566 ## only in the local copy, not the cached object
567 no warnings 'deprecated'; # XXX silence the warning for now
568 if ( $conf_encryption
569 && eval '@FS::'. $table . '::encrypted_fields' ) {
570 foreach my $record (@return) {
571 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
572 next if $field eq 'payinfo'
573 && ($record->isa('FS::payinfo_transaction_Mixin')
574 || $record->isa('FS::payinfo_Mixin') )
576 && !grep { $record->payby eq $_ } @encrypt_payby;
577 # Set it directly... This may cause a problem in the future...
578 $record->setfield($field, $record->decrypt($record->getfield($field)));
583 cluck "warning: FS::$table not loaded; returning FS::Record objects"
584 unless $nowarn_classload;
586 FS::Record->new( $table, { %{$_} } );
594 Construct the SQL statement and parameter-binding list for qsearch. Takes
595 the qsearch parameters.
597 Returns a hash containing:
598 'table': The primary table name (if there is one).
599 'statement': The SQL statement itself.
600 'bind_type': An arrayref of bind types.
601 'value': An arrayref of parameter values.
602 'cache': The cache object, if one was passed.
607 my( @stable, @record, @cache );
608 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
611 my %union_options = ();
612 if ( ref($_[0]) eq 'ARRAY' ) {
615 foreach my $href ( @$optlist ) {
616 push @stable, ( $href->{'table'} or die "table name is required" );
617 push @record, ( $href->{'hashref'} || {} );
618 push @select, ( $href->{'select'} || '*' );
619 push @extra_sql, ( $href->{'extra_sql'} || '' );
620 push @extra_param, ( $href->{'extra_param'} || [] );
621 push @order_by, ( $href->{'order_by'} || '' );
622 push @cache, ( $href->{'cache_obj'} || '' );
623 push @addl_from, ( $href->{'addl_from'} || '' );
624 push @debug, ( $href->{'debug'} || '' );
626 die "at least one hashref is required" unless scalar(@stable);
627 } elsif ( ref($_[0]) eq 'HASH' ) {
629 $stable[0] = $opt->{'table'} or die "table name is required";
630 $record[0] = $opt->{'hashref'} || {};
631 $select[0] = $opt->{'select'} || '*';
632 $extra_sql[0] = $opt->{'extra_sql'} || '';
633 $extra_param[0] = $opt->{'extra_param'} || [];
634 $order_by[0] = $opt->{'order_by'} || '';
635 $cache[0] = $opt->{'cache_obj'} || '';
636 $addl_from[0] = $opt->{'addl_from'} || '';
637 $debug[0] = $opt->{'debug'} || '';
648 my $cache = $cache[0];
654 my $result_table = $stable[0];
655 foreach my $stable ( @stable ) {
656 #stop altering the caller's hashref
657 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
658 my $select = shift @select;
659 my $extra_sql = shift @extra_sql;
660 my $extra_param = shift @extra_param;
661 my $order_by = shift @order_by;
662 my $cache = shift @cache;
663 my $addl_from = shift @addl_from;
664 my $debug = shift @debug;
666 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
668 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
671 $result_table = '' if $result_table ne $stable;
673 my $table = $cache ? $cache->table : $stable;
674 my $dbdef_table = dbdef->table($table)
675 or die "No schema for table $table found - ".
676 "do you need to run freeside-upgrade?";
677 my $pkey = $dbdef_table->primary_key;
679 my @real_fields = grep exists($record->{$_}), real_fields($table);
681 my $statement .= "SELECT $select FROM $stable";
682 $statement .= " $addl_from" if $addl_from;
683 if ( @real_fields ) {
684 $statement .= ' WHERE '. join(' AND ',
685 get_real_fields($table, $record, \@real_fields));
688 $statement .= " $extra_sql" if defined($extra_sql);
689 $statement .= " $order_by" if defined($order_by);
691 push @statement, $statement;
693 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
697 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
700 my $value = $record->{$field};
701 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
702 $value = $value->{'value'} if ref($value);
703 my $type = dbdef->table($table)->column($field)->type;
705 my $bind_type = _bind_type($type, $value);
709 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
711 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
715 push @bind_type, $bind_type;
719 foreach my $param ( @$extra_param ) {
720 my $bind_type = { TYPE => SQL_VARCHAR };
723 $value = $param->[0];
724 my $type = $param->[1];
725 $bind_type = _bind_type($type, $value);
728 push @bind_type, $bind_type;
732 my $statement = join( ' ) UNION ( ', @statement );
733 $statement = "( $statement )" if scalar(@statement) > 1;
734 $statement .= " $union_options{order_by}" if $union_options{order_by};
737 statement => $statement,
738 bind_type => \@bind_type,
740 table => $result_table,
745 # qsearch should eventually use this
747 my ($table, $cache, @hashrefs) = @_;
749 # XXX get rid of these string evals at some point
750 # (when we have time to test it)
751 # my $class = "FS::$table" if $table;
752 # if ( $class and $class->isa('FS::Record') )
753 # if ( $class->can('new') eq \&new )
755 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
756 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
757 #derivied class didn't override new method, so this optimization is safe
760 new_or_cached( "FS::$table", { %{$_} }, $cache )
764 new( "FS::$table", { %{$_} } )
768 #okay, its been tested
769 # warn "untested code (class FS::$table uses custom new method)";
771 eval 'FS::'. $table. '->new( { %{$_} } )';
775 # Check for encrypted fields and decrypt them.
776 ## only in the local copy, not the cached object
777 if ( $conf_encryption
778 && eval '@FS::'. $table . '::encrypted_fields' ) {
779 foreach my $record (@return) {
780 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
781 next if $field eq 'payinfo'
782 && ($record->isa('FS::payinfo_transaction_Mixin')
783 || $record->isa('FS::payinfo_Mixin') )
785 && !grep { $record->payby eq $_ } @encrypt_payby;
786 # Set it directly... This may cause a problem in the future...
787 $record->setfield($field, $record->decrypt($record->getfield($field)));
792 cluck "warning: FS::$table not loaded; returning FS::Record objects"
793 unless $nowarn_classload;
795 FS::Record->new( $table, { %{$_} } );
801 sub get_real_fields {
804 my $real_fields = shift;
805 my $alias_main = shift; # defaults to undef
806 $alias_main ||= $table;
808 ## could be optimized more for readability
814 my $table_column = $qsearch_qualify_columns ? "$alias_main.$column" : $column;
815 my $type = dbdef->table($table)->column($column)->type;
816 my $value = $record->{$column};
817 $value = $value->{'value'} if ref($value);
819 if ( ref($record->{$column}) ) {
820 $op = $record->{$column}{'op'} if $record->{$column}{'op'};
821 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
822 if ( uc($op) eq 'ILIKE' ) {
824 $record->{$column}{'value'} = lc($record->{$column}{'value'});
825 $table_column = "LOWER($table_column)";
827 $record->{$column} = $record->{$column}{'value'}
830 if ( ! defined( $record->{$column} ) || $record->{$column} eq '' ) {
832 if ( driver_name eq 'Pg' ) {
833 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
834 qq-( $table_column IS NULL )-;
836 qq-( $table_column IS NULL OR $table_column = '' )-;
839 qq-( $table_column IS NULL OR $table_column = "" )-;
841 } elsif ( $op eq '!=' ) {
842 if ( driver_name eq 'Pg' ) {
843 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
844 qq-( $table_column IS NOT NULL )-;
846 qq-( $table_column IS NOT NULL AND $table_column != '' )-;
849 qq-( $table_column IS NOT NULL AND $table_column != "" )-;
852 if ( driver_name eq 'Pg' ) {
853 qq-( $table_column $op '' )-;
855 qq-( $table_column $op "" )-;
858 } elsif ( $op eq '!=' ) {
859 qq-( $table_column IS NULL OR $table_column != ? )-;
860 #if this needs to be re-enabled, it needs to use a custom op like
861 #"APPROX=" or something (better name?, not '=', to avoid affecting other
863 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
864 # ( "$table_column <= ?", "$table_column >= ?" );
866 "$table_column $op ?";
873 =item by_key PRIMARY_KEY_VALUE
875 This is a class method that returns the record with the given primary key
876 value. This method is only useful in FS::Record subclasses. For example:
878 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
882 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
887 my ($class, $pkey_value) = @_;
889 my $table = $class->table
890 or croak "No table for $class found";
892 my $dbdef_table = dbdef->table($table)
893 or die "No schema for table $table found - ".
894 "do you need to create it or run dbdef-create?";
895 my $pkey = $dbdef_table->primary_key
896 or die "No primary key for table $table";
898 return qsearchs($table, { $pkey => $pkey_value });
901 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
903 Experimental JOINed search method. Using this method, you can execute a
904 single SELECT spanning multiple tables, and cache the results for subsequent
905 method calls. Interface will almost definately change in an incompatible
913 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
914 my $cache = FS::SearchCache->new( $ptable, $pkey );
917 grep { !$saw{$_->getfield($pkey)}++ }
918 qsearch($table, $record, $select, $extra_sql, $cache )
922 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
924 Same as qsearch, except that if more than one record matches, it B<carp>s but
925 returns the first. If this happens, you either made a logic error in asking
926 for a single item, or your data is corrupted.
930 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
932 my(@result) = qsearch(@_);
933 cluck "warning: Multiple records in scalar search ($table)"
934 #.join(' / ', map "$_=>".$_[1]->{$_}, keys %{ $_[1] } )
935 if scalar(@result) > 1;
936 #should warn more vehemently if the search was on a primary key?
937 scalar(@result) ? ($result[0]) : ();
948 Returns the table name.
953 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
960 Returns the DBIx::DBSchema::Table object for the table.
966 my($table)=$self->table;
967 dbdef->table($table);
972 Returns the primary key for the table.
978 my $pkey = $self->dbdef_table->primary_key;
981 =item get, getfield COLUMN
983 Returns the value of the column/field/key COLUMN.
988 my($self,$field) = @_;
989 # to avoid "Use of unitialized value" errors
990 if ( defined ( $self->{Hash}->{$field} ) ) {
991 $self->{Hash}->{$field};
1001 =item set, setfield COLUMN, VALUE
1003 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
1008 my($self,$field,$value) = @_;
1009 $self->{'modified'} = 1;
1010 $self->{'Hash'}->{$field} = $value;
1019 Returns true if the column/field/key COLUMN exists.
1024 my($self,$field) = @_;
1025 exists($self->{Hash}->{$field});
1028 =item AUTOLOADED METHODS
1030 $record->column is a synonym for $record->get('column');
1032 $record->column('value') is a synonym for $record->set('column','value');
1034 $record->foreign_table_name calls qsearchs and returns a single
1035 FS::foreign_table record (for tables referenced by a column of this table) or
1036 qsearch and returns an array of FS::foreign_table records (for tables
1037 referenced by a column in the foreign table).
1043 my($self,$value)=@_;
1044 my($field)=$AUTOLOAD;
1047 confess "errant AUTOLOAD $field for $self (arg $value)"
1048 unless blessed($self) && $self->can('setfield');
1050 if ( my $fk_info = get_fk_method($self->table, $field) ) {
1052 my $method = $fk_info->{method} || 'qsearchs';
1053 my $table = $fk_info->{table} || $field;
1054 my $column = $fk_info->{column};
1055 my $foreign_column = $fk_info->{references} || $column;
1057 eval "use FS::$table";
1060 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1062 my $pkey_value = $self->$column();
1063 my %search = ( $foreign_column => $pkey_value );
1065 # FS::Record->$method() ? they're actually just subs :/
1066 if ( $method eq 'qsearchs' ) {
1067 return $pkey_value ? qsearchs( $table, \%search ) : '';
1068 } elsif ( $method eq 'qsearch' ) {
1069 return $pkey_value ? qsearch( $table, \%search ) : ();
1071 die "unknown method $method";
1076 if ( defined($value) ) {
1077 $self->setfield($field,$value);
1079 $self->getfield($field);
1083 # efficient (also, old, doesn't support FK stuff)
1085 # my $field = $AUTOLOAD;
1086 # $field =~ s/.*://;
1087 # if ( defined($_[1]) ) {
1088 # $_[0]->setfield($field, $_[1]);
1090 # $_[0]->getfield($field);
1094 # get_fk_method(TABLE, FIELD)
1095 # Internal subroutine for fetching the foreign key descriptor for TABLE.FIELD
1096 # if there is one. If not, returns undef.
1097 # This will initialize fk_method_cache if it hasn't happened yet. It is the
1098 # _only_ allowed way to access the contents of %fk_method_cache.
1100 # if we wanted to be even more efficient we'd create the fk methods in the
1101 # symbol table instead of relying on AUTOLOAD every time
1104 my ($table, $field) = @_;
1106 # maybe should only load one table at a time?
1107 fk_methods_init() unless exists($fk_method_cache{$table});
1109 if ( exists($fk_method_cache{$table}) and
1110 exists($fk_method_cache{$table}{$field}) ) {
1111 return $fk_method_cache{$table}{$field};
1118 sub fk_methods_init {
1119 warn "[fk_methods_init]\n" if $DEBUG;
1120 foreach my $table ( dbdef->tables ) {
1121 $fk_method_cache{$table} = fk_methods($table);
1130 # foreign keys we reference in other tables
1131 foreach my $fk (dbdef->table($table)->foreign_keys) {
1134 if ( scalar( @{$fk->columns} ) == 1 ) {
1135 if ( ! defined($fk->references)
1136 || ! @{$fk->references}
1137 || $fk->columns->[0] eq $fk->references->[0]
1139 $method = $fk->table;
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' => 'qsearchs',
1149 'column' => $fk->columns->[0],
1150 #'references' => $fk->references->[0],
1158 # foreign keys referenced in other tables to us
1159 # (alas. why we're cached. still, might this loop better be done once at
1160 # schema load time insetad of every time we AUTOLOAD a method on a new
1162 if (! defined $fk_table_cache) {
1163 foreach my $f_table ( dbdef->tables ) {
1164 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1165 push @{$fk_table_cache->{$fk->table}},[$f_table,$fk];
1169 foreach my $fks (@{$fk_table_cache->{$table}}) {
1170 my ($f_table,$fk) = @$fks;
1172 if ( scalar( @{$fk->columns} ) == 1 ) {
1173 if ( ! defined($fk->references)
1174 || ! @{$fk->references}
1175 || $fk->columns->[0] eq $fk->references->[0]
1179 #some sort of hint in the table.pm or schema for methods not named
1180 # after their foreign table (well, not a whole lot different than
1181 # just providing a small subroutine...)
1185 $hash{$method} = { #fk_info
1186 'method' => 'qsearch',
1187 'column' => $fk->columns->[0], #references||column
1188 #'references' => $fk->column->[0],
1200 Returns a list of the column/value pairs, usually for assigning to a new hash.
1202 To make a distinct duplicate of an FS::Record object, you can do:
1204 $new = new FS::Record ( $old->table, { $old->hash } );
1210 confess $self. ' -> hash: Hash attribute is undefined'
1211 unless defined($self->{'Hash'});
1212 %{ $self->{'Hash'} };
1217 Returns a reference to the column/value hash. This may be deprecated in the
1218 future; if there's a reason you can't just use the autoloaded or get/set
1232 +{ ( map { $_=>$self->$_ } $self->fields ),
1237 my( $class, %opt ) = @_;
1238 my $table = $class->table;
1239 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1240 my $error = $self->insert;
1241 return +{ 'error' => $error } if $error;
1242 my $pkey = $self->pkey;
1243 return +{ 'error' => '',
1244 'primary_key' => $pkey,
1245 $pkey => $self->$pkey,
1251 Returns true if any of this object's values have been modified with set (or via
1252 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1259 $self->{'modified'};
1262 =item select_for_update
1264 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1269 sub select_for_update {
1271 my $primary_key = $self->primary_key;
1274 'table' => $self->table,
1275 'hashref' => { $primary_key => $self->$primary_key() },
1276 'extra_sql' => 'FOR UPDATE',
1282 Locks this table with a database-driver specific lock method. This is used
1283 as a mutex in order to do a duplicate search.
1285 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1287 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1289 Errors are fatal; no useful return value.
1291 Note: To use this method for new tables other than svc_acct and svc_phone,
1292 edit freeside-upgrade and add those tables to the duplicate_lock list.
1298 my $table = $self->table;
1300 warn "$me locking $table table\n" if $DEBUG;
1302 if ( driver_name =~ /^Pg/i ) {
1304 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1307 } elsif ( driver_name =~ /^mysql/i ) {
1309 dbh->do("SELECT * FROM duplicate_lock
1310 WHERE lockname = '$table'
1312 ) or die dbh->errstr;
1316 die "unknown database ". driver_name. "; don't know how to lock table";
1320 warn "$me acquired $table table lock\n" if $DEBUG;
1326 Inserts this record to the database. If there is an error, returns the error,
1327 otherwise returns false.
1335 warn "$self -> insert" if $DEBUG;
1337 my $error = $self->check;
1338 return $error if $error;
1340 #single-field non-null unique keys are given a value if empty
1341 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1342 foreach ( $self->dbdef_table->unique_singles) {
1343 next if $self->getfield($_);
1344 next if $self->dbdef_table->column($_)->null eq 'NULL';
1348 #and also the primary key, if the database isn't going to
1349 my $primary_key = $self->dbdef_table->primary_key;
1351 if ( $primary_key ) {
1352 my $col = $self->dbdef_table->column($primary_key);
1355 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1356 || ( driver_name eq 'Pg'
1357 && defined($col->default)
1358 && $col->quoted_default =~ /^nextval\(/i
1360 || ( driver_name eq 'mysql'
1361 && defined($col->local)
1362 && $col->local =~ /AUTO_INCREMENT/i
1364 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1367 my $table = $self->table;
1369 # Encrypt before the database
1370 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1373 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1374 next if $field eq 'payinfo'
1375 && ($self->isa('FS::payinfo_transaction_Mixin')
1376 || $self->isa('FS::payinfo_Mixin') )
1378 && !grep { $self->payby eq $_ } @encrypt_payby;
1379 $saved->{$field} = $self->getfield($field);
1380 $self->setfield($field, $self->encrypt($self->getfield($field)));
1384 #false laziness w/delete
1386 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1390 my $statement = "INSERT INTO $table ";
1391 my @bind_values = ();
1393 if ( ! @real_fields ) {
1395 $statement .= 'DEFAULT VALUES';
1399 if ( $use_placeholders ) {
1401 @bind_values = map $self->getfield($_), @real_fields;
1405 join( ', ', @real_fields ).
1407 join( ', ', map '?', @real_fields ). # @bind_values ).
1413 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1417 join( ', ', @real_fields ).
1419 join( ', ', @values ).
1427 warn "[debug]$me $statement\n" if $DEBUG > 1;
1428 my $sth = dbh->prepare($statement) or return dbh->errstr;
1430 local $SIG{HUP} = 'IGNORE';
1431 local $SIG{INT} = 'IGNORE';
1432 local $SIG{QUIT} = 'IGNORE';
1433 local $SIG{TERM} = 'IGNORE';
1434 local $SIG{TSTP} = 'IGNORE';
1435 local $SIG{PIPE} = 'IGNORE';
1437 $sth->execute(@bind_values) or return $sth->errstr;
1439 # get inserted id from the database, if applicable & needed
1440 if ( $db_seq && ! $self->getfield($primary_key) ) {
1441 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1445 if ( driver_name eq 'Pg' ) {
1447 #my $oid = $sth->{'pg_oid_status'};
1448 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1450 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1451 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1452 dbh->rollback if $FS::UID::AutoCommit;
1453 return "can't parse $table.$primary_key default value".
1454 " for sequence name: $default";
1458 my $i_sql = "SELECT currval('$sequence')";
1459 my $i_sth = dbh->prepare($i_sql) or do {
1460 dbh->rollback if $FS::UID::AutoCommit;
1463 $i_sth->execute() or do { #$i_sth->execute($oid)
1464 dbh->rollback if $FS::UID::AutoCommit;
1465 return $i_sth->errstr;
1467 $insertid = $i_sth->fetchrow_arrayref->[0];
1469 } elsif ( driver_name eq 'mysql' ) {
1471 $insertid = dbh->{'mysql_insertid'};
1472 # work around mysql_insertid being null some of the time, ala RT :/
1473 unless ( $insertid ) {
1474 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1475 "using SELECT LAST_INSERT_ID();";
1476 my $i_sql = "SELECT LAST_INSERT_ID()";
1477 my $i_sth = dbh->prepare($i_sql) or do {
1478 dbh->rollback if $FS::UID::AutoCommit;
1481 $i_sth->execute or do {
1482 dbh->rollback if $FS::UID::AutoCommit;
1483 return $i_sth->errstr;
1485 $insertid = $i_sth->fetchrow_arrayref->[0];
1490 dbh->rollback if $FS::UID::AutoCommit;
1491 return "don't know how to retreive inserted ids from ". driver_name.
1492 ", try using counterfiles (maybe run dbdef-create?)";
1496 $self->setfield($primary_key, $insertid);
1501 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1502 my $h_statement = $self->_h_statement('insert');
1503 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1504 $h_sth = dbh->prepare($h_statement) or do {
1505 dbh->rollback if $FS::UID::AutoCommit;
1511 $h_sth->execute or return $h_sth->errstr if $h_sth;
1513 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1515 # Now that it has been saved, reset the encrypted fields so that $new
1516 # can still be used.
1517 foreach my $field (keys %{$saved}) {
1518 $self->setfield($field, $saved->{$field});
1526 Depriciated (use insert instead).
1531 cluck "warning: FS::Record::add deprecated!";
1532 insert @_; #call method in this scope
1537 Delete this record from the database. If there is an error, returns the error,
1538 otherwise returns false.
1545 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1547 $self->getfield($_) eq ''
1548 #? "( $_ IS NULL OR $_ = \"\" )"
1549 ? ( driver_name eq 'Pg'
1551 : "( $_ IS NULL OR $_ = \"\" )"
1553 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1554 } ( $self->dbdef_table->primary_key )
1555 ? ( $self->dbdef_table->primary_key)
1556 : real_fields($self->table)
1558 warn "[debug]$me $statement\n" if $DEBUG > 1;
1559 my $sth = dbh->prepare($statement) or return dbh->errstr;
1562 if ( defined dbdef->table('h_'. $self->table) ) {
1563 my $h_statement = $self->_h_statement('delete');
1564 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1565 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1570 my $primary_key = $self->dbdef_table->primary_key;
1572 local $SIG{HUP} = 'IGNORE';
1573 local $SIG{INT} = 'IGNORE';
1574 local $SIG{QUIT} = 'IGNORE';
1575 local $SIG{TERM} = 'IGNORE';
1576 local $SIG{TSTP} = 'IGNORE';
1577 local $SIG{PIPE} = 'IGNORE';
1579 my $rc = $sth->execute or return $sth->errstr;
1580 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1581 $h_sth->execute or return $h_sth->errstr if $h_sth;
1583 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1585 #no need to needlessly destoy the data either (causes problems actually)
1586 #undef $self; #no need to keep object!
1593 Depriciated (use delete instead).
1598 cluck "warning: FS::Record::del deprecated!";
1599 &delete(@_); #call method in this scope
1602 =item replace OLD_RECORD
1604 Replace the OLD_RECORD with this one in the database. If there is an error,
1605 returns the error, otherwise returns false.
1610 my ($new, $old) = (shift, shift);
1612 $old = $new->replace_old unless defined($old);
1614 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1616 if ( $new->can('replace_check') ) {
1617 my $error = $new->replace_check($old);
1618 return $error if $error;
1621 return "Records not in same table!" unless $new->table eq $old->table;
1623 my $primary_key = $old->dbdef_table->primary_key;
1624 return "Can't change primary key $primary_key ".
1625 'from '. $old->getfield($primary_key).
1626 ' to ' . $new->getfield($primary_key)
1628 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1630 my $error = $new->check;
1631 return $error if $error;
1633 # Encrypt for replace
1635 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1638 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1639 next if $field eq 'payinfo'
1640 && ($new->isa('FS::payinfo_transaction_Mixin')
1641 || $new->isa('FS::payinfo_Mixin') )
1643 && !grep { $new->payby eq $_ } @encrypt_payby;
1644 $saved->{$field} = $new->getfield($field);
1645 $new->setfield($field, $new->encrypt($new->getfield($field)));
1649 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1650 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1651 ? ($_, $new->getfield($_)) : () } $old->fields;
1653 unless (keys(%diff) || $no_update_diff ) {
1654 carp "[warning]$me ". ref($new)."->replace ".
1655 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1656 ": records identical"
1657 unless $nowarn_identical;
1661 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1663 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1664 } real_fields($old->table)
1669 if ( $old->getfield($_) eq '' ) {
1671 #false laziness w/qsearch
1672 if ( driver_name eq 'Pg' ) {
1673 my $type = $old->dbdef_table->column($_)->type;
1674 if ( $type =~ /(int|(big)?serial)/i ) {
1677 qq-( $_ IS NULL OR $_ = '' )-;
1680 qq-( $_ IS NULL OR $_ = "" )-;
1684 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1687 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1690 warn "[debug]$me $statement\n" if $DEBUG > 1;
1691 my $sth = dbh->prepare($statement) or return dbh->errstr;
1694 if ( defined dbdef->table('h_'. $old->table) ) {
1695 my $h_old_statement = $old->_h_statement('replace_old');
1696 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1697 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1703 if ( defined dbdef->table('h_'. $new->table) ) {
1704 my $h_new_statement = $new->_h_statement('replace_new');
1705 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1706 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1711 local $SIG{HUP} = 'IGNORE';
1712 local $SIG{INT} = 'IGNORE';
1713 local $SIG{QUIT} = 'IGNORE';
1714 local $SIG{TERM} = 'IGNORE';
1715 local $SIG{TSTP} = 'IGNORE';
1716 local $SIG{PIPE} = 'IGNORE';
1718 my $rc = $sth->execute or return $sth->errstr;
1719 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1720 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1721 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1723 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1725 # Now that it has been saved, reset the encrypted fields so that $new
1726 # can still be used.
1727 foreach my $field (keys %{$saved}) {
1728 $new->setfield($field, $saved->{$field});
1736 my( $self ) = shift;
1737 warn "[$me] replace called with no arguments; autoloading old record\n"
1740 my $primary_key = $self->dbdef_table->primary_key;
1741 if ( $primary_key ) {
1742 $self->by_key( $self->$primary_key() ) #this is what's returned
1743 or croak "can't find ". $self->table. ".$primary_key ".
1744 $self->$primary_key();
1746 croak $self->table. " has no primary key; pass old record as argument";
1753 Depriciated (use replace instead).
1758 cluck "warning: FS::Record::rep deprecated!";
1759 replace @_; #call method in this scope
1764 Checks custom fields. Subclasses should still provide a check method to validate
1765 non-custom fields, etc., and call this method via $self->SUPER::check.
1771 foreach my $field ($self->virtual_fields) {
1772 my $error = $self->ut_textn($field);
1773 return $error if $error;
1778 =item virtual_fields [ TABLE ]
1780 Returns a list of virtual fields defined for the table. This should not
1781 be exported, and should only be called as an instance or class method.
1785 sub virtual_fields {
1788 $table = $self->table or confess "virtual_fields called on non-table";
1790 confess "Unknown table $table" unless dbdef->table($table);
1792 return () unless dbdef->table('part_virtual_field');
1794 unless ( $virtual_fields_cache{$table} ) {
1795 my $concat = [ "'cf_'", "name" ];
1796 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1797 "WHERE dbtable = '$table'";
1799 my $result = $dbh->selectcol_arrayref($query);
1800 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1802 $virtual_fields_cache{$table} = $result;
1805 @{$virtual_fields_cache{$table}};
1809 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1811 Processes a batch import as a queued JSRPC job
1813 JOB is an FS::queue entry.
1815 OPTIONS_HASHREF can have the following keys:
1821 Table name (required).
1825 Arrayref of field names for static fields. They will be given values from the
1826 PARAMS hashref and passed as a "params" hashref to batch_import.
1830 Formats hashref. Keys are field names, values are listrefs that define the
1833 Each listref value can be a column name or a code reference. Coderefs are run
1834 with the row object, data and a FS::Conf object as the three parameters.
1835 For example, this coderef does the same thing as using the "columnname" string:
1838 my( $record, $data, $conf ) = @_;
1839 $record->columnname( $data );
1842 Coderefs are run after all "column name" fields are assigned.
1846 Optional format hashref of types. Keys are field names, values are "csv",
1847 "xls" or "fixedlength". Overrides automatic determination of file type
1850 =item format_headers
1852 Optional format hashref of header lines. Keys are field names, values are 0
1853 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1856 =item format_sep_chars
1858 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1859 CSV separation character.
1861 =item format_fixedlenth_formats
1863 Optional format hashref of fixed length format defintiions. Keys are field
1864 names, values Parse::FixedLength listrefs of field definitions.
1868 Set true to default to CSV file type if the filename does not contain a
1869 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1874 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1875 POSTed data. It must contain the field "uploaded files", generated by
1876 /elements/file-upload.html and containing the list of uploaded files.
1877 Currently only supports a single file named "file".
1882 sub process_batch_import {
1883 my($job, $opt, $param) = @_;
1885 my $table = $opt->{table};
1886 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1887 my %formats = %{ $opt->{formats} };
1889 warn Dumper($param) if $DEBUG;
1891 my $files = $param->{'uploaded_files'}
1892 or die "No files provided.\n";
1894 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1896 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1897 my $file = $dir. $files{'file'};
1902 formats => \%formats,
1903 format_types => $opt->{format_types},
1904 format_headers => $opt->{format_headers},
1905 format_sep_chars => $opt->{format_sep_chars},
1906 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1907 format_xml_formats => $opt->{format_xml_formats},
1908 format_asn_formats => $opt->{format_asn_formats},
1909 format_row_callbacks => $opt->{format_row_callbacks},
1910 format_hash_callbacks => $opt->{format_hash_callbacks},
1915 format => $param->{format},
1916 params => { map { $_ => $param->{$_} } @pass_params },
1918 default_csv => $opt->{default_csv},
1919 preinsert_callback => $opt->{preinsert_callback},
1920 postinsert_callback => $opt->{postinsert_callback},
1921 insert_args_callback => $opt->{insert_args_callback},
1924 if ( $opt->{'batch_namecol'} ) {
1925 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1926 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1929 my $error = FS::Record::batch_import( \%iopt );
1933 die "$error\n" if $error;
1936 =item batch_import PARAM_HASHREF
1938 Class method for batch imports. Available params:
1944 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1950 =item format_headers
1952 =item format_sep_chars
1954 =item format_fixedlength_formats
1956 =item format_row_callbacks
1958 =item format_hash_callbacks - After parsing, before object creation
1960 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1962 =item preinsert_callback
1964 =item postinsert_callback
1970 FS::queue object, will be updated with progress
1976 csv, xls, fixedlength, xml
1988 warn "$me batch_import call with params: \n". Dumper($param)
1991 my $table = $param->{table};
1993 my $job = $param->{job};
1994 my $file = $param->{file};
1995 my $params = $param->{params} || {};
1997 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1998 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
2000 my( $type, $header, $sep_char,
2001 $fixedlength_format, $xml_format, $asn_format,
2002 $parser_opt, $row_callback, $hash_callback, @fields );
2004 my $postinsert_callback = '';
2005 $postinsert_callback = $param->{'postinsert_callback'}
2006 if $param->{'postinsert_callback'};
2007 my $preinsert_callback = '';
2008 $preinsert_callback = $param->{'preinsert_callback'}
2009 if $param->{'preinsert_callback'};
2010 my $insert_args_callback = '';
2011 $insert_args_callback = $param->{'insert_args_callback'}
2012 if $param->{'insert_args_callback'};
2014 if ( $param->{'format'} ) {
2016 my $format = $param->{'format'};
2017 my $formats = $param->{formats};
2018 die "unknown format $format" unless exists $formats->{ $format };
2020 $type = $param->{'format_types'}
2021 ? $param->{'format_types'}{ $format }
2022 : $param->{type} || 'csv';
2025 $header = $param->{'format_headers'}
2026 ? $param->{'format_headers'}{ $param->{'format'} }
2029 $sep_char = $param->{'format_sep_chars'}
2030 ? $param->{'format_sep_chars'}{ $param->{'format'} }
2033 $fixedlength_format =
2034 $param->{'format_fixedlength_formats'}
2035 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
2039 $param->{'format_parser_opts'}
2040 ? $param->{'format_parser_opts'}{ $param->{'format'} }
2044 $param->{'format_xml_formats'}
2045 ? $param->{'format_xml_formats'}{ $param->{'format'} }
2049 $param->{'format_asn_formats'}
2050 ? $param->{'format_asn_formats'}{ $param->{'format'} }
2054 $param->{'format_row_callbacks'}
2055 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
2059 $param->{'format_hash_callbacks'}
2060 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
2063 @fields = @{ $formats->{ $format } };
2065 } elsif ( $param->{'fields'} ) {
2067 $type = ''; #infer from filename
2070 $fixedlength_format = '';
2072 $hash_callback = '';
2073 @fields = @{ $param->{'fields'} };
2076 die "neither format nor fields specified";
2079 #my $file = $param->{file};
2082 if ( $file =~ /\.(\w+)$/i ) {
2086 warn "can't parse file type from filename $file; defaulting to CSV";
2090 if $param->{'default_csv'} && $type ne 'xls';
2098 my $asn_header_buffer;
2099 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2101 if ( $type eq 'csv' ) {
2103 $parser_opt->{'binary'} = 1;
2104 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2105 $parser = Text::CSV_XS->new($parser_opt);
2107 } elsif ( $type eq 'fixedlength' ) {
2109 eval "use Parse::FixedLength;";
2111 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2114 die "Unknown file type $type\n";
2117 @buffer = split(/\r?\n/, slurp($file) );
2118 splice(@buffer, 0, ($header || 0) );
2119 $count = scalar(@buffer);
2121 } elsif ( $type eq 'xls' ) {
2123 eval "use Spreadsheet::ParseExcel;";
2126 eval "use DateTime::Format::Excel;";
2127 #for now, just let the error be thrown if it is used, since only CDR
2128 # formats bill_west and troop use it, not other excel-parsing things
2131 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2133 $parser = $excel->{Worksheet}[0]; #first sheet
2135 $count = $parser->{MaxRow} || $parser->{MinRow};
2138 $row = $header || 0;
2140 } elsif ( $type eq 'xml' ) {
2143 eval "use XML::Simple;";
2145 my $xmlrow = $xml_format->{'xmlrow'};
2146 $parser = $xml_format->{'xmlkeys'};
2147 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2148 my $data = XML::Simple::XMLin(
2150 'SuppressEmpty' => '', #sets empty values to ''
2154 $rows = $rows->{$_} foreach @$xmlrow;
2155 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2156 $count = @buffer = @$rows;
2158 } elsif ( $type eq 'asn.1' ) {
2160 eval "use Convert::ASN1";
2163 my $asn = Convert::ASN1->new;
2164 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2166 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2168 my $data = slurp($file);
2169 my $asn_output = $parser->decode( $data )
2170 or return "No ". $asn_format->{'macro'}. " found\n";
2172 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2174 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2175 $count = @buffer = @$rows;
2178 die "Unknown file type $type\n";
2183 local $SIG{HUP} = 'IGNORE';
2184 local $SIG{INT} = 'IGNORE';
2185 local $SIG{QUIT} = 'IGNORE';
2186 local $SIG{TERM} = 'IGNORE';
2187 local $SIG{TSTP} = 'IGNORE';
2188 local $SIG{PIPE} = 'IGNORE';
2190 my $oldAutoCommit = $FS::UID::AutoCommit;
2191 local $FS::UID::AutoCommit = 0;
2194 #my $params = $param->{params} || {};
2195 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2196 my $batch_col = $param->{'batch_keycol'};
2198 my $batch_class = 'FS::'. $param->{'batch_table'};
2199 my $batch = $batch_class->new({
2200 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2202 my $error = $batch->insert;
2204 $dbh->rollback if $oldAutoCommit;
2205 return "can't insert batch record: $error";
2207 #primary key via dbdef? (so the column names don't have to match)
2208 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2210 $params->{ $batch_col } = $batch_value;
2213 #my $job = $param->{job};
2216 my $unique_skip = 0; #lines skipped because they're already in the system
2217 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2221 my %hash = %$params;
2222 if ( $type eq 'csv' ) {
2224 last unless scalar(@buffer);
2225 $line = shift(@buffer);
2227 next if $line =~ /^\s*$/; #skip empty lines
2229 $line = &{$row_callback}($line) if $row_callback;
2231 next if $line =~ /^\s*$/; #skip empty lines
2233 $parser->parse($line) or do {
2234 $dbh->rollback if $oldAutoCommit;
2235 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2237 @columns = $parser->fields();
2239 } elsif ( $type eq 'fixedlength' ) {
2241 last unless scalar(@buffer);
2242 $line = shift(@buffer);
2244 @columns = $parser->parse($line);
2246 } elsif ( $type eq 'xls' ) {
2248 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2249 || ! $parser->{Cells}[$row];
2251 my @row = @{ $parser->{Cells}[$row] };
2252 @columns = map $_->{Val}, @row;
2255 #warn $z++. ": $_\n" for @columns;
2257 } elsif ( $type eq 'xml' ) {
2259 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2260 last unless scalar(@buffer);
2261 my $row = shift @buffer;
2262 @columns = @{ $row }{ @$parser };
2264 } elsif ( $type eq 'asn.1' ) {
2266 last unless scalar(@buffer);
2267 my $row = shift @buffer;
2268 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2269 if $asn_format->{row_callback};
2270 foreach my $key ( keys %{ $asn_format->{map} } ) {
2271 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2275 die "Unknown file type $type\n";
2280 foreach my $field ( @fields ) {
2282 my $value = shift @columns;
2284 if ( ref($field) eq 'CODE' ) {
2285 #&{$field}(\%hash, $value);
2286 push @later, $field, $value;
2288 #??? $hash{$field} = $value if length($value);
2289 $hash{$field} = $value if defined($value) && length($value);
2294 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2295 && length($1) == $custnum_length ) {
2296 $hash{custnum} = $2;
2299 %hash = &{$hash_callback}(%hash) if $hash_callback;
2301 #my $table = $param->{table};
2302 my $class = "FS::$table";
2304 my $record = $class->new( \%hash );
2307 while ( scalar(@later) ) {
2308 my $sub = shift @later;
2309 my $data = shift @later;
2311 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2314 $dbh->rollback if $oldAutoCommit;
2315 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2317 last if exists( $param->{skiprow} );
2319 $unique_skip++ if $param->{unique_skip}; #line is already in the system
2320 next if exists( $param->{skiprow} );
2322 if ( $preinsert_callback ) {
2323 my $error = &{$preinsert_callback}($record, $param);
2325 $dbh->rollback if $oldAutoCommit;
2326 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2329 next if exists $param->{skiprow} && $param->{skiprow};
2332 my @insert_args = ();
2333 if ( $insert_args_callback ) {
2334 @insert_args = &{$insert_args_callback}($record, $param);
2337 my $error = $record->insert(@insert_args);
2340 $dbh->rollback if $oldAutoCommit;
2341 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2347 if ( $postinsert_callback ) {
2348 my $error = &{$postinsert_callback}($record, $param);
2350 $dbh->rollback if $oldAutoCommit;
2351 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2356 if ( $job && time - $min_sec > $last ) { #progress bar
2357 $job->update_statustext( int(100 * $imported / $count) );
2363 unless ( $imported || $param->{empty_ok} ) {
2364 $dbh->rollback if $oldAutoCommit;
2365 # freeside-cdr-conexiant-import is sensitive to the text of this message
2366 return $unique_skip ? "All records in file were previously imported" : "Empty file!";
2369 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2376 my( $self, $action, $time ) = @_;
2380 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2383 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2384 real_fields($self->table);
2387 # If we're encrypting then don't store the payinfo in the history
2388 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2389 @fields = grep { $_ ne 'payinfo' } @fields;
2392 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2394 "INSERT INTO h_". $self->table. " ( ".
2395 join(', ', qw(history_date history_usernum history_action), @fields ).
2398 $FS::CurrentUser::CurrentUser->usernum,
2399 dbh->quote($action),
2408 B<Warning>: External use is B<deprecated>.
2410 Replaces COLUMN in record with a unique number, using counters in the
2411 filesystem. Used by the B<insert> method on single-field unique columns
2412 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2413 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2415 Returns the new value.
2420 my($self,$field) = @_;
2421 my($table)=$self->table;
2423 croak "Unique called on field $field, but it is ",
2424 $self->getfield($field),
2426 if $self->getfield($field);
2428 #warn "table $table is tainted" if is_tainted($table);
2429 #warn "field $field is tainted" if is_tainted($field);
2431 my($counter) = new File::CounterFile "$table.$field",0;
2433 my $index = $counter->inc;
2434 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2436 $index =~ /^(\d*)$/;
2439 $self->setfield($field,$index);
2443 =item ut_float COLUMN
2445 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2446 null. If there is an error, returns the error, otherwise returns false.
2451 my($self,$field)=@_ ;
2452 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2453 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2454 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2455 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2456 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2457 $self->setfield($field,$1);
2460 =item ut_floatn COLUMN
2462 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2463 null. If there is an error, returns the error, otherwise returns false.
2467 #false laziness w/ut_ipn
2469 my( $self, $field ) = @_;
2470 if ( $self->getfield($field) =~ /^()$/ ) {
2471 $self->setfield($field,'');
2474 $self->ut_float($field);
2478 =item ut_sfloat COLUMN
2480 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2481 May not be null. If there is an error, returns the error, otherwise returns
2487 my($self,$field)=@_ ;
2488 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2489 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2490 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2491 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2492 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2493 $self->setfield($field,$1);
2496 =item ut_sfloatn COLUMN
2498 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2499 null. If there is an error, returns the error, otherwise returns false.
2504 my( $self, $field ) = @_;
2505 if ( $self->getfield($field) =~ /^()$/ ) {
2506 $self->setfield($field,'');
2509 $self->ut_sfloat($field);
2513 =item ut_snumber COLUMN
2515 Check/untaint signed numeric data (whole numbers). If there is an error,
2516 returns the error, otherwise returns false.
2521 my($self, $field) = @_;
2522 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2523 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2524 $self->setfield($field, "$1$2");
2528 =item ut_snumbern COLUMN
2530 Check/untaint signed numeric data (whole numbers). If there is an error,
2531 returns the error, otherwise returns false.
2536 my($self, $field) = @_;
2537 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2538 or return "Illegal (numeric) $field: ". $self->getfield($field);
2540 return "Illegal (numeric) $field: ". $self->getfield($field)
2543 $self->setfield($field, "$1$2");
2547 =item ut_number COLUMN
2549 Check/untaint simple numeric data (whole numbers). May not be null. If there
2550 is an error, returns the error, otherwise returns false.
2555 my($self,$field)=@_;
2556 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2557 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2558 $self->setfield($field,$1);
2562 =item ut_numbern COLUMN
2564 Check/untaint simple numeric data (whole numbers). May be null. If there is
2565 an error, returns the error, otherwise returns false.
2570 my($self,$field)=@_;
2571 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2572 or return "Illegal (numeric) $field: ". $self->getfield($field);
2573 $self->setfield($field,$1);
2577 =item ut_decimal COLUMN[, DIGITS]
2579 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2580 error, returns the error, otherwise returns false.
2582 =item ut_decimaln COLUMN[, DIGITS]
2584 Check/untaint decimal numbers. May be null. If there is an error, returns
2585 the error, otherwise returns false.
2590 my($self, $field, $digits) = @_;
2592 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2593 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2594 $self->setfield($field, $1);
2599 my($self, $field, $digits) = @_;
2600 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2601 or return "Illegal (decimal) $field: ".$self->getfield($field);
2602 $self->setfield($field, $1);
2606 =item ut_money COLUMN
2608 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2609 is an error, returns the error, otherwise returns false.
2614 my($self,$field)=@_;
2616 if ( $self->getfield($field) eq '' ) {
2617 $self->setfield($field, 0);
2618 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2619 #handle one decimal place without barfing out
2620 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2621 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2622 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2624 return "Illegal (money) $field: ". $self->getfield($field);
2630 =item ut_moneyn COLUMN
2632 Check/untaint monetary numbers. May be negative. If there
2633 is an error, returns the error, otherwise returns false.
2638 my($self,$field)=@_;
2639 if ($self->getfield($field) eq '') {
2640 $self->setfield($field, '');
2643 $self->ut_money($field);
2646 =item ut_currencyn COLUMN
2648 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2649 is an error, returns the error, otherwise returns false.
2654 my($self, $field) = @_;
2655 if ($self->getfield($field) eq '') { #can be null
2656 $self->setfield($field, '');
2659 $self->ut_currency($field);
2662 =item ut_currency COLUMN
2664 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2665 there is an error, returns the error, otherwise returns false.
2670 my($self, $field) = @_;
2671 my $value = uc( $self->getfield($field) );
2672 if ( code2currency($value) ) {
2673 $self->setfield($value);
2675 return "Unknown currency $value";
2681 =item ut_text COLUMN
2683 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2684 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < > ~
2685 May not be null. If there is an error, returns the error, otherwise returns
2691 my($self,$field)=@_;
2692 #warn "msgcat ". \&msgcat. "\n";
2693 #warn "notexist ". \¬exist. "\n";
2694 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2695 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2696 # see perldoc perluniprops
2697 $self->getfield($field)
2698 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>\~$money_char]+)$/
2699 or return gettext('illegal_or_empty_text'). " $field: ".
2700 $self->getfield($field);
2701 $self->setfield($field,$1);
2705 =item ut_textn COLUMN
2707 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2708 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2709 May be null. If there is an error, returns the error, otherwise returns false.
2714 my($self,$field)=@_;
2715 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2716 $self->ut_text($field);
2719 =item ut_alpha COLUMN
2721 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2722 an error, returns the error, otherwise returns false.
2727 my($self,$field)=@_;
2728 $self->getfield($field) =~ /^(\w+)$/
2729 or return "Illegal or empty (alphanumeric) $field: ".
2730 $self->getfield($field);
2731 $self->setfield($field,$1);
2735 =item ut_alphan COLUMN
2737 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2738 error, returns the error, otherwise returns false.
2743 my($self,$field)=@_;
2744 $self->getfield($field) =~ /^(\w*)$/
2745 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2746 $self->setfield($field,$1);
2750 =item ut_alphasn COLUMN
2752 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2753 an error, returns the error, otherwise returns false.
2758 my($self,$field)=@_;
2759 $self->getfield($field) =~ /^([\w ]*)$/
2760 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2761 $self->setfield($field,$1);
2766 =item ut_alpha_lower COLUMN
2768 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2769 there is an error, returns the error, otherwise returns false.
2773 sub ut_alpha_lower {
2774 my($self,$field)=@_;
2775 $self->getfield($field) =~ /[[:upper:]]/
2776 and return "Uppercase characters are not permitted in $field";
2777 $self->ut_alpha($field);
2780 =item ut_phonen COLUMN [ COUNTRY ]
2782 Check/untaint phone numbers. May be null. If there is an error, returns
2783 the error, otherwise returns false.
2785 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2786 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2791 my( $self, $field, $country ) = @_;
2792 return $self->ut_alphan($field) unless defined $country;
2793 my $phonen = $self->getfield($field);
2794 if ( $phonen eq '' ) {
2795 $self->setfield($field,'');
2796 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2798 $phonen = $conf->config('cust_main-default_areacode').$phonen
2799 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2800 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2801 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2802 $phonen = "$1-$2-$3";
2803 $phonen .= " x$4" if $4;
2804 $self->setfield($field,$phonen);
2806 warn "warning: don't know how to check phone numbers for country $country";
2807 return $self->ut_textn($field);
2814 Check/untaint hexadecimal values.
2819 my($self, $field) = @_;
2820 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2821 or return "Illegal (hex) $field: ". $self->getfield($field);
2822 $self->setfield($field, uc($1));
2826 =item ut_hexn COLUMN
2828 Check/untaint hexadecimal values. May be null.
2833 my($self, $field) = @_;
2834 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2835 or return "Illegal (hex) $field: ". $self->getfield($field);
2836 $self->setfield($field, uc($1));
2840 =item ut_mac_addr COLUMN
2842 Check/untaint mac addresses. May be null.
2847 my($self, $field) = @_;
2849 my $mac = $self->get($field);
2852 $self->set($field, $mac);
2854 my $e = $self->ut_hex($field);
2857 return "Illegal (mac address) $field: ". $self->getfield($field)
2858 unless length($self->getfield($field)) == 12;
2864 =item ut_mac_addrn COLUMN
2866 Check/untaint mac addresses. May be null.
2871 my($self, $field) = @_;
2872 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2877 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2883 my( $self, $field ) = @_;
2884 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2885 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2886 or return "Illegal (IP address) $field: ". $self->getfield($field);
2887 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2888 $self->setfield($field, "$1.$2.$3.$4");
2894 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2895 to 127.0.0.1. May be null.
2900 my( $self, $field ) = @_;
2901 if ( $self->getfield($field) =~ /^()$/ ) {
2902 $self->setfield($field,'');
2905 $self->ut_ip($field);
2909 =item ut_ip46 COLUMN
2911 Check/untaint IPv4 or IPv6 address.
2916 my( $self, $field ) = @_;
2917 my $ip = NetAddr::IP->new($self->getfield($field))
2918 or return "Illegal (IP address) $field: ".$self->getfield($field);
2919 $self->setfield($field, lc($ip->addr));
2925 Check/untaint IPv6 or IPv6 address. May be null.
2930 my( $self, $field ) = @_;
2931 if ( $self->getfield($field) =~ /^$/ ) {
2932 $self->setfield($field, '');
2935 $self->ut_ip46($field);
2938 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2940 Check/untaint coordinates.
2941 Accepts the following forms:
2951 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2952 The latter form (that is, the MMM are thousands of minutes) is
2953 assumed if the "MMM" is exactly three digits or two digits > 59.
2955 To be safe, just use the DDD.DDDDD form.
2957 If LOWER or UPPER are specified, then the coordinate is checked
2958 for lower and upper bounds, respectively.
2963 my ($self, $field) = (shift, shift);
2966 if ( $field =~ /latitude/ ) {
2967 $lower = $lat_lower;
2969 } elsif ( $field =~ /longitude/ ) {
2971 $upper = $lon_upper;
2974 my $coord = $self->getfield($field);
2975 my $neg = $coord =~ s/^(-)//;
2977 # ignore degree symbol at the end,
2978 # but not otherwise supporting degree/minutes/seconds symbols
2979 $coord =~ s/\N{DEGREE SIGN}\s*$//;
2981 my ($d, $m, $s) = (0, 0, 0);
2984 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2985 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2986 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2988 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2991 return "Invalid (coordinate with minutes > 59) $field: "
2992 . $self->getfield($field);
2995 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2997 if (defined($lower) and ($coord < $lower)) {
2998 return "Invalid (coordinate < $lower) $field: "
2999 . $self->getfield($field);;
3002 if (defined($upper) and ($coord > $upper)) {
3003 return "Invalid (coordinate > $upper) $field: "
3004 . $self->getfield($field);;
3007 $self->setfield($field, $coord);
3011 return "Invalid (coordinate) $field: " . $self->getfield($field);
3015 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
3017 Same as ut_coord, except optionally null.
3023 my ($self, $field) = (shift, shift);
3025 if ($self->getfield($field) =~ /^\s*$/) {
3028 return $self->ut_coord($field, @_);
3033 =item ut_domain COLUMN
3035 Check/untaint host and domain names. May not be null.
3040 my( $self, $field ) = @_;
3041 #$self->getfield($field) =~/^(\w+\.)*\w+$/
3042 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
3043 or return "Illegal (hostname) $field: ". $self->getfield($field);
3044 $self->setfield($field,$1);
3048 =item ut_domainn COLUMN
3050 Check/untaint host and domain names. May be null.
3055 my( $self, $field ) = @_;
3056 if ( $self->getfield($field) =~ /^()$/ ) {
3057 $self->setfield($field,'');
3060 $self->ut_domain($field);
3064 =item ut_name COLUMN
3066 Check/untaint proper names; allows alphanumerics, spaces and the following
3067 punctuation: , . - '
3074 my( $self, $field ) = @_;
3075 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
3076 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
3081 $self->setfield($field, $name);
3085 =item ut_namen COLUMN
3087 Check/untaint proper names; allows alphanumerics, spaces and the following
3088 punctuation: , . - '
3095 my( $self, $field ) = @_;
3096 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3097 $self->ut_name($field);
3102 Check/untaint zip codes.
3106 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3109 my( $self, $field, $country ) = @_;
3111 if ( $country eq 'US' ) {
3113 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3114 or return gettext('illegal_zip'). " $field for country $country: ".
3115 $self->getfield($field);
3116 $self->setfield($field, $1);
3118 } elsif ( $country eq 'CA' ) {
3120 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3121 or return gettext('illegal_zip'). " $field for country $country: ".
3122 $self->getfield($field);
3123 $self->setfield($field, "$1 $2");
3125 } elsif ( $country eq 'AU' ) {
3127 $self->getfield($field) =~ /^\s*(\d{4})\s*$/
3128 or return gettext('illegal_zip'). " $field for country $country: ".
3129 $self->getfield($field);
3130 $self->setfield($field, $1);
3134 if ( $self->getfield($field) =~ /^\s*$/
3135 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3138 $self->setfield($field,'');
3140 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3141 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3142 $self->setfield($field,$1);
3150 =item ut_country COLUMN
3152 Check/untaint country codes. Country names are changed to codes, if possible -
3153 see L<Locale::Country>.
3158 my( $self, $field ) = @_;
3159 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3160 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3161 && country2code($1) ) {
3162 $self->setfield($field,uc(country2code($1)));
3165 $self->getfield($field) =~ /^(\w\w)$/
3166 or return "Illegal (country) $field: ". $self->getfield($field);
3167 $self->setfield($field,uc($1));
3171 =item ut_anything COLUMN
3173 Untaints arbitrary data. Be careful.
3178 my( $self, $field ) = @_;
3179 $self->getfield($field) =~ /^(.*)$/s
3180 or return "Illegal $field: ". $self->getfield($field);
3181 $self->setfield($field,$1);
3185 =item ut_enum COLUMN CHOICES_ARRAYREF
3187 Check/untaint a column, supplying all possible choices, like the "enum" type.
3192 my( $self, $field, $choices ) = @_;
3193 foreach my $choice ( @$choices ) {
3194 if ( $self->getfield($field) eq $choice ) {
3195 $self->setfield($field, $choice);
3199 return "Illegal (enum) field $field: ". $self->getfield($field);
3202 =item ut_enumn COLUMN CHOICES_ARRAYREF
3204 Like ut_enum, except the null value is also allowed.
3209 my( $self, $field, $choices ) = @_;
3210 $self->getfield($field)
3211 ? $self->ut_enum($field, $choices)
3215 =item ut_flag COLUMN
3217 Check/untaint a column if it contains either an empty string or 'Y'. This
3218 is the standard form for boolean flags in Freeside.
3223 my( $self, $field ) = @_;
3224 my $value = uc($self->getfield($field));
3225 if ( $value eq '' or $value eq 'Y' ) {
3226 $self->setfield($field, $value);
3229 return "Illegal (flag) field $field: $value";
3232 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3234 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3235 on the column first.
3239 sub ut_foreign_key {
3240 my( $self, $field, $table, $foreign ) = @_;
3241 return $self->ut_number($field) if $no_check_foreign;
3242 qsearchs($table, { $foreign => $self->getfield($field) })
3243 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3244 " in $table.$foreign";
3248 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3250 Like ut_foreign_key, except the null value is also allowed.
3254 sub ut_foreign_keyn {
3255 my( $self, $field, $table, $foreign ) = @_;
3256 $self->getfield($field)
3257 ? $self->ut_foreign_key($field, $table, $foreign)
3261 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3263 Checks this column as an agentnum, taking into account the current users's
3264 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3265 right or rights allowing no agentnum.
3269 sub ut_agentnum_acl {
3270 my( $self, $field ) = (shift, shift);
3271 my $null_acl = scalar(@_) ? shift : [];
3272 $null_acl = [ $null_acl ] unless ref($null_acl);
3274 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3275 return "Illegal agentnum: $error" if $error;
3277 my $curuser = $FS::CurrentUser::CurrentUser;
3279 if ( $self->$field() ) {
3281 return 'Access denied to agent '. $self->$field()
3282 unless $curuser->agentnum($self->$field());
3286 return 'Access denied to global'
3287 unless grep $curuser->access_right($_), @$null_acl;
3295 =item trim_whitespace FIELD[, FIELD ... ]
3297 Strip leading and trailing spaces from the value in the named FIELD(s).
3301 sub trim_whitespace {
3303 foreach my $field (@_) {
3304 my $value = $self->get($field);
3307 $self->set($field, $value);
3311 =item fields [ TABLE ]
3313 This is a wrapper for real_fields. Code that called
3314 fields before should probably continue to call fields.
3319 my $something = shift;
3321 if($something->isa('FS::Record')) {
3322 $table = $something->table;
3324 $table = $something;
3325 #$something = "FS::$table";
3327 return (real_fields($table));
3331 =item encrypt($value)
3333 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3335 Returns the encrypted string.
3337 You should generally not have to worry about calling this, as the system handles this for you.
3342 my ($self, $value) = @_;
3343 my $encrypted = $value;
3345 if ($conf_encryption) {
3346 if ($self->is_encrypted($value)) {
3347 # Return the original value if it isn't plaintext.
3348 $encrypted = $value;
3351 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3352 # RSA doesn't like the empty string so let's pack it up
3353 # The database doesn't like the RSA data so uuencode it
3354 my $length = length($value)+1;
3355 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3357 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3364 =item is_encrypted($value)
3366 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3372 my ($self, $value) = @_;
3373 # could be more precise about it, but this will do for now
3374 $value =~ /^M/ && length($value) > 80;
3377 =item decrypt($value)
3379 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3381 You should generally not have to worry about calling this, as the system handles this for you.
3386 my ($self,$value) = @_;
3387 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3388 if ($conf_encryption && $self->is_encrypted($value)) {
3390 if (ref($rsa_decrypt) =~ /::RSA/) {
3391 my $encrypted = unpack ("u*", $value);
3392 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3393 if ($@) {warn "Decryption Failed"};
3401 #Initialize the Module
3402 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
3404 if ($conf_encryptionmodule && $conf_encryptionmodule ne '') {
3405 $rsa_module = $conf_encryptionmodule;
3409 eval ("require $rsa_module"); # No need to import the namespace
3412 # Initialize Encryption
3413 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3414 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3417 # Intitalize Decryption
3418 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3419 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3423 =item h_search ACTION
3425 Given an ACTION, either "insert", or "delete", returns the appropriate history
3426 record corresponding to this record, if any.
3431 my( $self, $action ) = @_;
3433 my $table = $self->table;
3436 my $primary_key = dbdef->table($table)->primary_key;
3439 'table' => "h_$table",
3440 'hashref' => { $primary_key => $self->$primary_key(),
3441 'history_action' => $action,
3449 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3450 appropriate history record corresponding to this record, if any.
3455 my($self, $action) = @_;
3456 my $h = $self->h_search($action);
3457 $h ? $h->history_date : '';
3460 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3462 A class or object method. Executes the sql statement represented by SQL and
3463 returns a scalar representing the result: the first column of the first row.
3465 Dies on bogus SQL. Returns an empty string if no row is returned.
3467 Typically used for statments which return a single value such as "SELECT
3468 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3473 my($self, $sql) = (shift, shift);
3474 my $sth = dbh->prepare($sql) or die dbh->errstr;
3476 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3477 my $row = $sth->fetchrow_arrayref or return '';
3478 my $scalar = $row->[0];
3479 defined($scalar) ? $scalar : '';
3482 =item count [ WHERE [, PLACEHOLDER ...] ]
3484 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3485 with optional WHERE. Must be called as method on a class with an
3491 my($self, $where) = (shift, shift);
3492 my $table = $self->table or die 'count called on object of class '.ref($self);
3493 my $sql = "SELECT COUNT(*) FROM $table";
3494 $sql .= " WHERE $where" if $where;
3495 $self->scalar_sql($sql, @_);
3498 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3500 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3501 with optional (but almost always needed) WHERE.
3506 my($self, $where) = (shift, shift);
3507 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3508 my $sql = "SELECT 1 FROM $table";
3509 $sql .= " WHERE $where" if $where;
3511 $self->scalar_sql($sql, @_);
3520 =item real_fields [ TABLE ]
3522 Returns a list of the real columns in the specified table. Called only by
3523 fields() and other subroutines elsewhere in FS::Record.
3530 my($table_obj) = dbdef->table($table);
3531 confess "Unknown table $table" unless $table_obj;
3532 $table_obj->columns;
3535 =item pvf FIELD_NAME
3537 Returns the FS::part_virtual_field object corresponding to a field in the
3538 record (specified by FIELD_NAME).
3543 my ($self, $name) = (shift, shift);
3545 if(grep /^$name$/, $self->virtual_fields) {
3547 my $concat = [ "'cf_'", "name" ];
3548 return qsearchs({ table => 'part_virtual_field',
3549 hashref => { dbtable => $self->table,
3552 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3558 =item _quote VALUE, TABLE, COLUMN
3560 This is an internal function used to construct SQL statements. It returns
3561 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3562 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3567 my($value, $table, $column) = @_;
3568 my $column_obj = dbdef->table($table)->column($column);
3569 my $column_type = $column_obj->type;
3570 my $nullable = $column_obj->null;
3572 utf8::upgrade($value);
3574 warn " $table.$column: $value ($column_type".
3575 ( $nullable ? ' NULL' : ' NOT NULL' ).
3576 ")\n" if $DEBUG > 2;
3578 if ( $value eq '' && $nullable ) {
3580 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3581 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3584 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3585 ! $column_type =~ /(char|binary|text)$/i ) {
3587 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3588 && driver_name eq 'Pg'
3591 dbh->quote($value, { pg_type => PG_BYTEA() });
3599 This is deprecated. Don't use it.
3601 It returns a hash-type list with the fields of this record's table set true.
3606 carp "warning: hfields is deprecated";
3609 foreach (fields($table)) {
3618 "$_: ". $self->getfield($_). "|"
3619 } (fields($self->table)) );
3622 sub DESTROY { return; }
3626 # #use Carp qw(cluck);
3627 # #cluck "DESTROYING $self";
3628 # warn "DESTROYING $self";
3632 # return ! eval { join('',@_), kill 0; 1; };
3635 =item str2time_sql [ DRIVER_NAME ]
3637 Returns a function to convert to unix time based on database type, such as
3638 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3639 the str2time_sql_closing method to return a closing string rather than just
3640 using a closing parenthesis as previously suggested.
3642 You can pass an optional driver name such as "Pg", "mysql" or
3643 $dbh->{Driver}->{Name} to return a function for that database instead of
3644 the current database.
3649 my $driver = shift || driver_name;
3651 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3652 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3654 warn "warning: unknown database type $driver; guessing how to convert ".
3655 "dates to UNIX timestamps";
3656 return 'EXTRACT(EPOCH FROM ';
3660 =item str2time_sql_closing [ DRIVER_NAME ]
3662 Returns the closing suffix of a function to convert to unix time based on
3663 database type, such as ")::integer" for Pg or ")" for mysql.
3665 You can pass an optional driver name such as "Pg", "mysql" or
3666 $dbh->{Driver}->{Name} to return a function for that database instead of
3667 the current database.
3671 sub str2time_sql_closing {
3672 my $driver = shift || driver_name;
3674 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3678 =item regexp_sql [ DRIVER_NAME ]
3680 Returns the operator to do a regular expression comparison based on database
3681 type, such as '~' for Pg or 'REGEXP' for mysql.
3683 You can pass an optional driver name such as "Pg", "mysql" or
3684 $dbh->{Driver}->{Name} to return a function for that database instead of
3685 the current database.
3690 my $driver = shift || driver_name;
3692 return '~' if $driver =~ /^Pg/i;
3693 return 'REGEXP' if $driver =~ /^mysql/i;
3695 die "don't know how to use regular expressions in ". driver_name." databases";
3699 =item not_regexp_sql [ DRIVER_NAME ]
3701 Returns the operator to do a regular expression negation based on database
3702 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3704 You can pass an optional driver name such as "Pg", "mysql" or
3705 $dbh->{Driver}->{Name} to return a function for that database instead of
3706 the current database.
3710 sub not_regexp_sql {
3711 my $driver = shift || driver_name;
3713 return '!~' if $driver =~ /^Pg/i;
3714 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3716 die "don't know how to use regular expressions in ". driver_name." databases";
3720 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3722 Returns the items concatenated based on database type, using "CONCAT()" for
3723 mysql and " || " for Pg and other databases.
3725 You can pass an optional driver name such as "Pg", "mysql" or
3726 $dbh->{Driver}->{Name} to return a function for that database instead of
3727 the current database.
3732 my $driver = ref($_[0]) ? driver_name : shift;
3735 if ( $driver =~ /^mysql/i ) {
3736 'CONCAT('. join(',', @$items). ')';
3738 join('||', @$items);
3743 =item group_concat_sql COLUMN, DELIMITER
3745 Returns an SQL expression to concatenate an aggregate column, using
3746 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3750 sub group_concat_sql {
3751 my ($col, $delim) = @_;
3752 $delim = dbh->quote($delim);
3753 if ( driver_name() =~ /^mysql/i ) {
3754 # DISTINCT(foo) is valid as $col
3755 return "GROUP_CONCAT($col SEPARATOR $delim)";
3757 return "array_to_string(array_agg($col), $delim)";
3761 =item midnight_sql DATE
3763 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3764 on that day in the system timezone, using the default driver name.
3769 my $driver = driver_name;
3771 if ( $driver =~ /^mysql/i ) {
3772 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3775 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3783 This module should probably be renamed, since much of the functionality is
3784 of general use. It is not completely unlike Adapter::DBI (see below).
3786 Exported qsearch and qsearchs should be deprecated in favor of method calls
3787 (against an FS::Record object like the old search and searchs that qsearch
3788 and qsearchs were on top of.)
3790 The whole fields / hfields mess should be removed.
3792 The various WHERE clauses should be subroutined.
3794 table string should be deprecated in favor of DBIx::DBSchema::Table.
3796 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3797 true maps to the database (and WHERE clauses) would also help.
3799 The ut_ methods should ask the dbdef for a default length.
3801 ut_sqltype (like ut_varchar) should all be defined
3803 A fallback check method should be provided which uses the dbdef.
3805 The ut_money method assumes money has two decimal digits.
3807 The Pg money kludge in the new method only strips `$'.
3809 The ut_phonen method only checks US-style phone numbers.
3811 The _quote function should probably use ut_float instead of a regex.
3813 All the subroutines probably should be methods, here or elsewhere.
3815 Probably should borrow/use some dbdef methods where appropriate (like sub
3818 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3819 or allow it to be set. Working around it is ugly any way around - DBI should
3820 be fixed. (only affects RDBMS which return uppercase column names)
3822 ut_zip should take an optional country like ut_phone.
3826 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3828 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.