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 Crypt::OpenSSL::RSA;
22 use FS::UID qw(dbh datasrc driver_name);
24 use FS::Schema qw(dbdef);
26 use FS::Msgcat qw(gettext);
27 #use FS::Conf; #dependency loop bs, in install_callback below instead
29 use FS::part_virtual_field;
33 our @encrypt_payby = qw( CARD DCRD CHEK DCHK );
35 #export dbdef for now... everything else expects to find it here
37 dbh fields hfields qsearch qsearchs dbdef jsearch
38 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql
39 concat_sql group_concat_sql
40 midnight_sql fk_methods_init
44 our $me = '[FS::Record]';
46 $use_placeholders = 0;
48 our $nowarn_identical = 0;
49 our $nowarn_classload = 0;
50 our $no_update_diff = 0;
53 our $qsearch_qualify_columns = 1;
55 our $no_check_foreign = 1; #well, not inefficiently in perl by default anymore
61 our $conf_encryption = '';
62 our $conf_encryptionmodule = '';
63 our $conf_encryptionpublickey = '';
64 our $conf_encryptionprivatekey = '';
65 FS::UID->install_callback( sub {
69 $conf = FS::Conf->new;
70 $conf_encryption = $conf->exists('encryption');
71 $conf_encryptionmodule = $conf->config('encryptionmodule');
72 $conf_encryptionpublickey = join("\n",$conf->config('encryptionpublickey'));
73 $conf_encryptionprivatekey = join("\n",$conf->config('encryptionprivatekey'));
74 $money_char = $conf->config('money_char') || '$';
75 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
76 $lat_lower = $nw_coords ? 1 : -90;
77 $lon_upper = $nw_coords ? -1 : 180;
79 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
81 if ( driver_name eq 'Pg' ) {
82 eval "use DBD::Pg ':pg_types'";
85 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
94 FS::Record - Database record objects
99 use FS::Record qw(dbh fields qsearch qsearchs);
101 $record = new FS::Record 'table', \%hash;
102 $record = new FS::Record 'table', { 'column' => 'value', ... };
104 $record = qsearchs FS::Record 'table', \%hash;
105 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
106 @records = qsearch FS::Record 'table', \%hash;
107 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
109 $table = $record->table;
110 $dbdef_table = $record->dbdef_table;
112 $value = $record->get('column');
113 $value = $record->getfield('column');
114 $value = $record->column;
116 $record->set( 'column' => 'value' );
117 $record->setfield( 'column' => 'value' );
118 $record->column('value');
120 %hash = $record->hash;
122 $hashref = $record->hashref;
124 $error = $record->insert;
126 $error = $record->delete;
128 $error = $new_record->replace($old_record);
130 # external use deprecated - handled by the database (at least for Pg, mysql)
131 $value = $record->unique('column');
133 $error = $record->ut_float('column');
134 $error = $record->ut_floatn('column');
135 $error = $record->ut_number('column');
136 $error = $record->ut_numbern('column');
137 $error = $record->ut_decimal('column');
138 $error = $record->ut_decimaln('column');
139 $error = $record->ut_snumber('column');
140 $error = $record->ut_snumbern('column');
141 $error = $record->ut_money('column');
142 $error = $record->ut_text('column');
143 $error = $record->ut_textn('column');
144 $error = $record->ut_alpha('column');
145 $error = $record->ut_alphan('column');
146 $error = $record->ut_phonen('column');
147 $error = $record->ut_anything('column');
148 $error = $record->ut_name('column');
150 $quoted_value = _quote($value,'table','field');
153 $fields = hfields('table');
154 if ( $fields->{Field} ) { # etc.
156 @fields = fields 'table'; #as a subroutine
157 @fields = $record->fields; #as a method call
162 (Mostly) object-oriented interface to database records. Records are currently
163 implemented on top of DBI. FS::Record is intended as a base class for
164 table-specific classes to inherit from, i.e. FS::cust_main.
170 =item new [ TABLE, ] HASHREF
172 Creates a new record. It doesn't store it in the database, though. See
173 L<"insert"> for that.
175 Note that the object stores this hash reference, not a distinct copy of the
176 hash it points to. You can ask the object for a copy with the I<hash>
179 TABLE can only be omitted when a dervived class overrides the table method.
185 my $class = ref($proto) || $proto;
187 bless ($self, $class);
189 unless ( defined ( $self->table ) ) {
190 $self->{'Table'} = shift;
191 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
192 unless $nowarn_classload;
195 $self->{'Hash'} = shift;
197 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
198 $self->{'Hash'}{$field}='';
201 $self->_rebless if $self->can('_rebless');
203 $self->{'modified'} = 0;
205 $self->_simplecache($self->{'Hash'}) if $self->can('_simplecache');
206 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
213 my $class = ref($proto) || $proto;
215 bless ($self, $class);
217 $self->{'Table'} = shift unless defined ( $self->table );
219 my $hashref = $self->{'Hash'} = shift;
221 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
222 my $obj = $cache->cache->{$hashref->{$cache->key}};
223 $obj->_cache($hashref, $cache) if $obj->can('_cache');
226 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
233 my $class = ref($proto) || $proto;
235 bless ($self, $class);
236 if ( defined $self->table ) {
237 cluck "create constructor is deprecated, use new!";
240 croak "FS::Record::create called (not from a subclass)!";
244 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
246 Searches the database for all records matching (at least) the key/value pairs
247 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
248 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
251 The preferred usage is to pass a hash reference of named parameters:
253 @records = qsearch( {
254 'table' => 'table_name',
255 'hashref' => { 'field' => 'value'
256 'field' => { 'op' => '<',
261 #these are optional...
263 'extra_sql' => 'AND field = ? AND intfield = ?',
264 'extra_param' => [ 'value', [ 5, 'int' ] ],
265 'order_by' => 'ORDER BY something',
266 #'cache_obj' => '', #optional
267 'addl_from' => 'LEFT JOIN othtable USING ( field )',
272 Much code still uses old-style positional parameters, this is also probably
273 fine in the common case where there are only two parameters:
275 my @records = qsearch( 'table', { 'field' => 'value' } );
277 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
278 the individual PARAMS_HASHREF queries
280 ###oops, argh, FS::Record::new only lets us create database fields.
281 #Normal behaviour if SELECT is not specified is `*', as in
282 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
283 #feature where you can specify SELECT - remember, the objects returned,
284 #although blessed into the appropriate `FS::TABLE' package, will only have the
285 #fields you specify. This might have unwanted results if you then go calling
286 #regular FS::TABLE methods
291 my %TYPE = (); #for debugging
294 my($type, $value) = @_;
296 my $bind_type = { TYPE => SQL_VARCHAR };
298 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
300 $bind_type = { TYPE => SQL_INTEGER };
302 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
304 if ( driver_name eq 'Pg' ) {
306 $bind_type = { pg_type => PG_BYTEA };
308 # $bind_type = ? #SQL_VARCHAR could be fine?
311 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
312 #fixed by DBD::Pg 2.11.8
313 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
314 #(make a Tron test first)
315 } elsif ( _is_fs_float( $type, $value ) ) {
317 $bind_type = { TYPE => SQL_DECIMAL };
326 my($type, $value) = @_;
327 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
328 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
336 my( @stable, @record, @cache );
337 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
339 my %union_options = ();
340 if ( ref($_[0]) eq 'ARRAY' ) {
343 foreach my $href ( @$optlist ) {
344 push @stable, ( $href->{'table'} or die "table name is required" );
345 push @record, ( $href->{'hashref'} || {} );
346 push @select, ( $href->{'select'} || '*' );
347 push @extra_sql, ( $href->{'extra_sql'} || '' );
348 push @extra_param, ( $href->{'extra_param'} || [] );
349 push @order_by, ( $href->{'order_by'} || '' );
350 push @cache, ( $href->{'cache_obj'} || '' );
351 push @addl_from, ( $href->{'addl_from'} || '' );
352 push @debug, ( $href->{'debug'} || '' );
354 die "at least one hashref is required" unless scalar(@stable);
355 } elsif ( ref($_[0]) eq 'HASH' ) {
357 $stable[0] = $opt->{'table'} or die "table name is required";
358 $record[0] = $opt->{'hashref'} || {};
359 $select[0] = $opt->{'select'} || '*';
360 $extra_sql[0] = $opt->{'extra_sql'} || '';
361 $extra_param[0] = $opt->{'extra_param'} || [];
362 $order_by[0] = $opt->{'order_by'} || '';
363 $cache[0] = $opt->{'cache_obj'} || '';
364 $addl_from[0] = $opt->{'addl_from'} || '';
365 $debug[0] = $opt->{'debug'} || '';
376 my $cache = $cache[0];
382 foreach my $stable ( @stable ) {
384 carp '->qsearch on cust_main called' if $stable eq 'cust_main' && $DEBUG;
386 #stop altering the caller's hashref
387 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
388 my $select = shift @select;
389 my $extra_sql = shift @extra_sql;
390 my $extra_param = shift @extra_param;
391 my $order_by = shift @order_by;
392 my $cache = shift @cache;
393 my $addl_from = shift @addl_from;
394 my $debug = shift @debug;
396 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
398 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
401 my $table = $cache ? $cache->table : $stable;
402 my $dbdef_table = dbdef->table($table)
403 or die "No schema for table $table found - ".
404 "do you need to run freeside-upgrade?";
405 my $pkey = $dbdef_table->primary_key;
407 my @real_fields = grep exists($record->{$_}), real_fields($table);
409 my $statement .= "SELECT $select FROM $stable";
412 $statement .= " $addl_from";
413 # detect aliasing of the main table
414 if ( $addl_from =~ /^\s*AS\s+(\w+)/i ) {
418 if ( @real_fields ) {
419 $statement .= ' WHERE '. join(' AND ',
420 get_real_fields($table, $record, \@real_fields, $alias_main));
423 $statement .= " $extra_sql" if defined($extra_sql);
424 $statement .= " $order_by" if defined($order_by);
426 push @statement, $statement;
428 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
431 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
434 my $value = $record->{$field};
435 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
436 $value = $value->{'value'} if ref($value);
437 my $type = dbdef->table($table)->column($field)->type;
439 my $bind_type = _bind_type($type, $value);
443 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
445 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
449 push @bind_type, $bind_type;
453 foreach my $param ( @$extra_param ) {
454 my $bind_type = { TYPE => SQL_VARCHAR };
457 $value = $param->[0];
458 my $type = $param->[1];
459 $bind_type = _bind_type($type, $value);
462 push @bind_type, $bind_type;
466 my $statement = join( ' ) UNION ( ', @statement );
467 $statement = "( $statement )" if scalar(@statement) > 1;
468 $statement .= " $union_options{order_by}" if $union_options{order_by};
470 my $sth = $dbh->prepare($statement)
471 or croak "$dbh->errstr doing $statement";
474 foreach my $value ( @value ) {
475 my $bind_type = shift @bind_type;
476 $sth->bind_param($bind++, $value, $bind_type );
479 # $sth->execute( map $record->{$_},
480 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
481 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
483 my $ok = $sth->execute;
485 my $error = "Error executing \"$statement\"";
486 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
487 $error .= ': '. $sth->errstr;
492 # Determine how to format rows returned form a union query:
494 # * When all queries involved in the union are from the same table:
495 # Return an array of FS::$table_name objects
497 # * When union query is performed on multiple tables,
498 # Return an array of FS::Record objects
499 # ! Note: As far as I can tell, this functionality was broken, and
500 # ! actually results in a crash. Behavior is left intact
501 # ! as-is, in case the results are in use somewhere
503 # * Union query is performed on multiple table,
504 # and $union_options{classname_from_column} = 1
505 # Return an array of FS::$classname objects, where $classname is
506 # derived for each row from a static field inserted each returned
508 # e.g.: SELECT custnum,first,last,'cust_main' AS `__classname`'.
511 my $table = $stable[0];
513 $table = '' if grep { $_ ne $table } @stable;
514 $pkey = dbdef->table($table)->primary_key if $table;
517 tie %result, "Tie::IxHash";
518 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
519 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
520 %result = map { $_->{$pkey}, $_ } @stuff;
522 @result{@stuff} = @stuff;
527 #below was refactored out to _from_hashref, this should use it at some point
530 if ($union_options{classname_from_column}) {
533 # I'm not implementing the cache for this use case, at least not yet
536 for my $row (@stuff) {
537 my $table_class = $row->{__classname}
538 or die "`__classname` column must be set when ".
539 "using \$union_options{classname_from_column}";
540 push @return, new("FS::$table_class",$row);
544 elsif ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
545 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
546 #derivied class didn't override new method, so this optimization is safe
549 new_or_cached( "FS::$table", { %{$_} }, $cache )
553 new( "FS::$table", { %{$_} } )
557 #okay, its been tested
558 # warn "untested code (class FS::$table uses custom new method)";
560 eval 'FS::'. $table. '->new( { %{$_} } )';
564 # Check for encrypted fields and decrypt them.
565 ## only in the local copy, not the cached object
566 no warnings 'deprecated'; # XXX silence the warning for now
567 if ( $conf_encryption
568 && eval '@FS::'. $table . '::encrypted_fields' ) {
569 foreach my $record (@return) {
570 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
571 next if $field eq 'payinfo'
572 && ($record->isa('FS::payinfo_transaction_Mixin')
573 || $record->isa('FS::payinfo_Mixin') )
575 && !grep { $record->payby eq $_ } @encrypt_payby;
576 # Set it directly... This may cause a problem in the future...
577 $record->setfield($field, $record->decrypt($record->getfield($field)));
582 cluck "warning: FS::$table not loaded; returning FS::Record objects"
583 unless $nowarn_classload;
585 FS::Record->new( $table, { %{$_} } );
593 Construct the SQL statement and parameter-binding list for qsearch. Takes
594 the qsearch parameters.
596 Returns a hash containing:
597 'table': The primary table name (if there is one).
598 'statement': The SQL statement itself.
599 'bind_type': An arrayref of bind types.
600 'value': An arrayref of parameter values.
601 'cache': The cache object, if one was passed.
606 my( @stable, @record, @cache );
607 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
610 my %union_options = ();
611 if ( ref($_[0]) eq 'ARRAY' ) {
614 foreach my $href ( @$optlist ) {
615 push @stable, ( $href->{'table'} or die "table name is required" );
616 push @record, ( $href->{'hashref'} || {} );
617 push @select, ( $href->{'select'} || '*' );
618 push @extra_sql, ( $href->{'extra_sql'} || '' );
619 push @extra_param, ( $href->{'extra_param'} || [] );
620 push @order_by, ( $href->{'order_by'} || '' );
621 push @cache, ( $href->{'cache_obj'} || '' );
622 push @addl_from, ( $href->{'addl_from'} || '' );
623 push @debug, ( $href->{'debug'} || '' );
625 die "at least one hashref is required" unless scalar(@stable);
626 } elsif ( ref($_[0]) eq 'HASH' ) {
628 $stable[0] = $opt->{'table'} or die "table name is required";
629 $record[0] = $opt->{'hashref'} || {};
630 $select[0] = $opt->{'select'} || '*';
631 $extra_sql[0] = $opt->{'extra_sql'} || '';
632 $extra_param[0] = $opt->{'extra_param'} || [];
633 $order_by[0] = $opt->{'order_by'} || '';
634 $cache[0] = $opt->{'cache_obj'} || '';
635 $addl_from[0] = $opt->{'addl_from'} || '';
636 $debug[0] = $opt->{'debug'} || '';
647 my $cache = $cache[0];
653 my $result_table = $stable[0];
654 foreach my $stable ( @stable ) {
655 #stop altering the caller's hashref
656 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
657 my $select = shift @select;
658 my $extra_sql = shift @extra_sql;
659 my $extra_param = shift @extra_param;
660 my $order_by = shift @order_by;
661 my $cache = shift @cache;
662 my $addl_from = shift @addl_from;
663 my $debug = shift @debug;
665 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
667 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
670 $result_table = '' if $result_table ne $stable;
672 my $table = $cache ? $cache->table : $stable;
673 my $dbdef_table = dbdef->table($table)
674 or die "No schema for table $table found - ".
675 "do you need to run freeside-upgrade?";
676 my $pkey = $dbdef_table->primary_key;
678 my @real_fields = grep exists($record->{$_}), real_fields($table);
680 my $statement .= "SELECT $select FROM $stable";
681 $statement .= " $addl_from" if $addl_from;
682 if ( @real_fields ) {
683 $statement .= ' WHERE '. join(' AND ',
684 get_real_fields($table, $record, \@real_fields));
687 $statement .= " $extra_sql" if defined($extra_sql);
688 $statement .= " $order_by" if defined($order_by);
690 push @statement, $statement;
692 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
696 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
699 my $value = $record->{$field};
700 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
701 $value = $value->{'value'} if ref($value);
702 my $type = dbdef->table($table)->column($field)->type;
704 my $bind_type = _bind_type($type, $value);
708 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
710 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
714 push @bind_type, $bind_type;
718 foreach my $param ( @$extra_param ) {
719 my $bind_type = { TYPE => SQL_VARCHAR };
722 $value = $param->[0];
723 my $type = $param->[1];
724 $bind_type = _bind_type($type, $value);
727 push @bind_type, $bind_type;
731 my $statement = join( ' ) UNION ( ', @statement );
732 $statement = "( $statement )" if scalar(@statement) > 1;
733 $statement .= " $union_options{order_by}" if $union_options{order_by};
736 statement => $statement,
737 bind_type => \@bind_type,
739 table => $result_table,
744 # qsearch should eventually use this
746 my ($table, $cache, @hashrefs) = @_;
748 # XXX get rid of these string evals at some point
749 # (when we have time to test it)
750 # my $class = "FS::$table" if $table;
751 # if ( $class and $class->isa('FS::Record') )
752 # if ( $class->can('new') eq \&new )
754 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
755 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
756 #derivied class didn't override new method, so this optimization is safe
759 new_or_cached( "FS::$table", { %{$_} }, $cache )
763 new( "FS::$table", { %{$_} } )
767 #okay, its been tested
768 # warn "untested code (class FS::$table uses custom new method)";
770 eval 'FS::'. $table. '->new( { %{$_} } )';
774 # Check for encrypted fields and decrypt them.
775 ## only in the local copy, not the cached object
776 if ( $conf_encryption
777 && eval '@FS::'. $table . '::encrypted_fields' ) {
778 foreach my $record (@return) {
779 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
780 next if $field eq 'payinfo'
781 && ($record->isa('FS::payinfo_transaction_Mixin')
782 || $record->isa('FS::payinfo_Mixin') )
784 && !grep { $record->payby eq $_ } @encrypt_payby;
785 # Set it directly... This may cause a problem in the future...
786 $record->setfield($field, $record->decrypt($record->getfield($field)));
791 cluck "warning: FS::$table not loaded; returning FS::Record objects"
792 unless $nowarn_classload;
794 FS::Record->new( $table, { %{$_} } );
800 sub get_real_fields {
803 my $real_fields = shift;
804 my $alias_main = shift; # defaults to undef
805 $alias_main ||= $table;
807 ## could be optimized more for readability
813 my $table_column = $qsearch_qualify_columns ? "$alias_main.$column" : $column;
814 my $type = dbdef->table($table)->column($column)->type;
815 my $value = $record->{$column};
816 $value = $value->{'value'} if ref($value);
818 if ( ref($record->{$column}) ) {
819 $op = $record->{$column}{'op'} if $record->{$column}{'op'};
820 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
821 if ( uc($op) eq 'ILIKE' ) {
823 $record->{$column}{'value'} = lc($record->{$column}{'value'});
824 $table_column = "LOWER($table_column)";
826 $record->{$column} = $record->{$column}{'value'}
829 if ( ! defined( $record->{$column} ) || $record->{$column} eq '' ) {
831 if ( driver_name eq 'Pg' ) {
832 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
833 qq-( $table_column IS NULL )-;
835 qq-( $table_column IS NULL OR $table_column = '' )-;
838 qq-( $table_column IS NULL OR $table_column = "" )-;
840 } elsif ( $op eq '!=' ) {
841 if ( driver_name eq 'Pg' ) {
842 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
843 qq-( $table_column IS NOT NULL )-;
845 qq-( $table_column IS NOT NULL AND $table_column != '' )-;
848 qq-( $table_column IS NOT NULL AND $table_column != "" )-;
851 if ( driver_name eq 'Pg' ) {
852 qq-( $table_column $op '' )-;
854 qq-( $table_column $op "" )-;
857 } elsif ( $op eq '!=' ) {
858 qq-( $table_column IS NULL OR $table_column != ? )-;
859 #if this needs to be re-enabled, it needs to use a custom op like
860 #"APPROX=" or something (better name?, not '=', to avoid affecting other
862 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
863 # ( "$table_column <= ?", "$table_column >= ?" );
865 "$table_column $op ?";
872 =item by_key PRIMARY_KEY_VALUE
874 This is a class method that returns the record with the given primary key
875 value. This method is only useful in FS::Record subclasses. For example:
877 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
881 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
886 my ($class, $pkey_value) = @_;
888 my $table = $class->table
889 or croak "No table for $class found";
891 my $dbdef_table = dbdef->table($table)
892 or die "No schema for table $table found - ".
893 "do you need to create it or run dbdef-create?";
894 my $pkey = $dbdef_table->primary_key
895 or die "No primary key for table $table";
897 return qsearchs($table, { $pkey => $pkey_value });
900 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
902 Experimental JOINed search method. Using this method, you can execute a
903 single SELECT spanning multiple tables, and cache the results for subsequent
904 method calls. Interface will almost definately change in an incompatible
912 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
913 my $cache = FS::SearchCache->new( $ptable, $pkey );
916 grep { !$saw{$_->getfield($pkey)}++ }
917 qsearch($table, $record, $select, $extra_sql, $cache )
921 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
923 Same as qsearch, except that if more than one record matches, it B<carp>s but
924 returns the first. If this happens, you either made a logic error in asking
925 for a single item, or your data is corrupted.
929 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
931 my(@result) = qsearch(@_);
932 cluck "warning: Multiple records in scalar search ($table)"
933 #.join(' / ', map "$_=>".$_[1]->{$_}, keys %{ $_[1] } )
934 if scalar(@result) > 1;
935 #should warn more vehemently if the search was on a primary key?
936 scalar(@result) ? ($result[0]) : ();
947 Returns the table name.
952 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
959 Returns the DBIx::DBSchema::Table object for the table.
965 my($table)=$self->table;
966 dbdef->table($table);
971 Returns the primary key for the table.
977 my $pkey = $self->dbdef_table->primary_key;
980 =item get, getfield COLUMN
982 Returns the value of the column/field/key COLUMN.
987 my($self,$field) = @_;
988 # to avoid "Use of unitialized value" errors
989 if ( defined ( $self->{Hash}->{$field} ) ) {
990 $self->{Hash}->{$field};
1000 =item set, setfield COLUMN, VALUE
1002 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
1007 my($self,$field,$value) = @_;
1008 $self->{'modified'} = 1;
1009 $self->{'Hash'}->{$field} = $value;
1018 Returns true if the column/field/key COLUMN exists.
1023 my($self,$field) = @_;
1024 exists($self->{Hash}->{$field});
1027 =item AUTOLOADED METHODS
1029 $record->column is a synonym for $record->get('column');
1031 $record->column('value') is a synonym for $record->set('column','value');
1033 $record->foreign_table_name calls qsearchs and returns a single
1034 FS::foreign_table record (for tables referenced by a column of this table) or
1035 qsearch and returns an array of FS::foreign_table records (for tables
1036 referenced by a column in the foreign table).
1042 my($self,$value)=@_;
1043 my($field)=$AUTOLOAD;
1046 confess "errant AUTOLOAD $field for $self (arg $value)"
1047 unless blessed($self) && $self->can('setfield');
1049 if ( my $fk_info = get_fk_method($self->table, $field) ) {
1051 my $method = $fk_info->{method} || 'qsearchs';
1052 my $table = $fk_info->{table} || $field;
1053 my $column = $fk_info->{column};
1054 my $foreign_column = $fk_info->{references} || $column;
1056 eval "use FS::$table";
1059 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1061 my $pkey_value = $self->$column();
1062 my %search = ( $foreign_column => $pkey_value );
1064 # FS::Record->$method() ? they're actually just subs :/
1065 if ( $method eq 'qsearchs' ) {
1066 return $pkey_value ? qsearchs( $table, \%search ) : '';
1067 } elsif ( $method eq 'qsearch' ) {
1068 return $pkey_value ? qsearch( $table, \%search ) : ();
1070 die "unknown method $method";
1075 if ( defined($value) ) {
1076 $self->setfield($field,$value);
1078 $self->getfield($field);
1082 # efficient (also, old, doesn't support FK stuff)
1084 # my $field = $AUTOLOAD;
1085 # $field =~ s/.*://;
1086 # if ( defined($_[1]) ) {
1087 # $_[0]->setfield($field, $_[1]);
1089 # $_[0]->getfield($field);
1093 # get_fk_method(TABLE, FIELD)
1094 # Internal subroutine for fetching the foreign key descriptor for TABLE.FIELD
1095 # if there is one. If not, returns undef.
1096 # This will initialize fk_method_cache if it hasn't happened yet. It is the
1097 # _only_ allowed way to access the contents of %fk_method_cache.
1099 # if we wanted to be even more efficient we'd create the fk methods in the
1100 # symbol table instead of relying on AUTOLOAD every time
1103 my ($table, $field) = @_;
1105 fk_methods_init() unless exists($fk_method_cache{$table});
1107 if ( exists($fk_method_cache{$table}) and
1108 exists($fk_method_cache{$table}{$field}) ) {
1109 return $fk_method_cache{$table}{$field};
1116 sub fk_methods_init {
1117 warn "[fk_methods_init]\n" if $DEBUG;
1118 foreach my $table ( dbdef->tables ) {
1119 $fk_method_cache{$table} = fk_methods($table);
1128 # foreign keys we reference in other tables
1129 foreach my $fk (dbdef->table($table)->foreign_keys) {
1132 if ( scalar( @{$fk->columns} ) == 1 ) {
1133 if ( ! defined($fk->references)
1134 || ! @{$fk->references}
1135 || $fk->columns->[0] eq $fk->references->[0]
1137 $method = $fk->table;
1139 #some sort of hint in the table.pm or schema for methods not named
1140 # after their foreign table (well, not a whole lot different than
1141 # just providing a small subroutine...)
1145 $hash{$method} = { #fk_info
1146 'method' => 'qsearchs',
1147 'column' => $fk->columns->[0],
1148 #'references' => $fk->references->[0],
1156 # foreign keys referenced in other tables to us
1157 # (alas. why we're cached. still, might this loop better be done once at
1158 # schema load time insetad of every time we AUTOLOAD a method on a new
1160 if (! defined $fk_table_cache) {
1161 foreach my $f_table ( dbdef->tables ) {
1162 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1163 push @{$fk_table_cache->{$fk->table}},[$f_table,$fk];
1167 foreach my $fks (@{$fk_table_cache->{$table}}) {
1168 my ($f_table,$fk) = @$fks;
1170 if ( scalar( @{$fk->columns} ) == 1 ) {
1171 if ( ! defined($fk->references)
1172 || ! @{$fk->references}
1173 || $fk->columns->[0] eq $fk->references->[0]
1177 #some sort of hint in the table.pm or schema for methods not named
1178 # after their foreign table (well, not a whole lot different than
1179 # just providing a small subroutine...)
1183 $hash{$method} = { #fk_info
1184 'method' => 'qsearch',
1185 'column' => $fk->columns->[0], #references||column
1186 #'references' => $fk->column->[0],
1198 Returns a list of the column/value pairs, usually for assigning to a new hash.
1200 To make a distinct duplicate of an FS::Record object, you can do:
1202 $new = new FS::Record ( $old->table, { $old->hash } );
1208 confess $self. ' -> hash: Hash attribute is undefined'
1209 unless defined($self->{'Hash'});
1210 %{ $self->{'Hash'} };
1215 Returns a reference to the column/value hash. This may be deprecated in the
1216 future; if there's a reason you can't just use the autoloaded or get/set
1230 +{ ( map { $_=>$self->$_ } $self->fields ),
1235 my( $class, %opt ) = @_;
1236 my $table = $class->table;
1237 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1238 my $error = $self->insert;
1239 return +{ 'error' => $error } if $error;
1240 my $pkey = $self->pkey;
1241 return +{ 'error' => '',
1242 'primary_key' => $pkey,
1243 $pkey => $self->$pkey,
1249 Returns true if any of this object's values have been modified with set (or via
1250 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1257 $self->{'modified'};
1260 =item select_for_update
1262 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1267 sub select_for_update {
1269 my $primary_key = $self->primary_key;
1272 'table' => $self->table,
1273 'hashref' => { $primary_key => $self->$primary_key() },
1274 'extra_sql' => 'FOR UPDATE',
1280 Locks this table with a database-driver specific lock method. This is used
1281 as a mutex in order to do a duplicate search.
1283 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1285 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1287 Errors are fatal; no useful return value.
1289 Note: To use this method for new tables other than svc_acct and svc_phone,
1290 edit freeside-upgrade and add those tables to the duplicate_lock list.
1296 my $table = $self->table;
1298 warn "$me locking $table table\n" if $DEBUG;
1300 if ( driver_name =~ /^Pg/i ) {
1302 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1305 } elsif ( driver_name =~ /^mysql/i ) {
1307 dbh->do("SELECT * FROM duplicate_lock
1308 WHERE lockname = '$table'
1310 ) or die dbh->errstr;
1314 die "unknown database ". driver_name. "; don't know how to lock table";
1318 warn "$me acquired $table table lock\n" if $DEBUG;
1324 Inserts this record to the database. If there is an error, returns the error,
1325 otherwise returns false.
1333 warn "$self -> insert" if $DEBUG;
1335 my $error = $self->check;
1336 return $error if $error;
1338 #single-field non-null unique keys are given a value if empty
1339 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1340 foreach ( $self->dbdef_table->unique_singles) {
1341 next if $self->getfield($_);
1342 next if $self->dbdef_table->column($_)->null eq 'NULL';
1346 #and also the primary key, if the database isn't going to
1347 my $primary_key = $self->dbdef_table->primary_key;
1349 if ( $primary_key ) {
1350 my $col = $self->dbdef_table->column($primary_key);
1353 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1354 || ( driver_name eq 'Pg'
1355 && defined($col->default)
1356 && $col->quoted_default =~ /^nextval\(/i
1358 || ( driver_name eq 'mysql'
1359 && defined($col->local)
1360 && $col->local =~ /AUTO_INCREMENT/i
1362 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1365 my $table = $self->table;
1367 # Encrypt before the database
1368 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1371 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1372 next if $field eq 'payinfo'
1373 && ($self->isa('FS::payinfo_transaction_Mixin')
1374 || $self->isa('FS::payinfo_Mixin') )
1376 && !grep { $self->payby eq $_ } @encrypt_payby;
1377 $saved->{$field} = $self->getfield($field);
1378 $self->setfield($field, $self->encrypt($self->getfield($field)));
1382 #false laziness w/delete
1384 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1388 my $statement = "INSERT INTO $table ";
1389 my @bind_values = ();
1391 if ( ! @real_fields ) {
1393 $statement .= 'DEFAULT VALUES';
1397 if ( $use_placeholders ) {
1399 @bind_values = map $self->getfield($_), @real_fields;
1403 join( ', ', @real_fields ).
1405 join( ', ', map '?', @real_fields ). # @bind_values ).
1411 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1415 join( ', ', @real_fields ).
1417 join( ', ', @values ).
1425 warn "[debug]$me $statement\n" if $DEBUG > 1;
1426 my $sth = dbh->prepare($statement) or return dbh->errstr;
1428 local $SIG{HUP} = 'IGNORE';
1429 local $SIG{INT} = 'IGNORE';
1430 local $SIG{QUIT} = 'IGNORE';
1431 local $SIG{TERM} = 'IGNORE';
1432 local $SIG{TSTP} = 'IGNORE';
1433 local $SIG{PIPE} = 'IGNORE';
1435 $sth->execute(@bind_values) or return $sth->errstr;
1437 # get inserted id from the database, if applicable & needed
1438 if ( $db_seq && ! $self->getfield($primary_key) ) {
1439 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1443 if ( driver_name eq 'Pg' ) {
1445 #my $oid = $sth->{'pg_oid_status'};
1446 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1448 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1449 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1450 dbh->rollback if $FS::UID::AutoCommit;
1451 return "can't parse $table.$primary_key default value".
1452 " for sequence name: $default";
1456 my $i_sql = "SELECT currval('$sequence')";
1457 my $i_sth = dbh->prepare($i_sql) or do {
1458 dbh->rollback if $FS::UID::AutoCommit;
1461 $i_sth->execute() or do { #$i_sth->execute($oid)
1462 dbh->rollback if $FS::UID::AutoCommit;
1463 return $i_sth->errstr;
1465 $insertid = $i_sth->fetchrow_arrayref->[0];
1467 } elsif ( driver_name eq 'mysql' ) {
1469 $insertid = dbh->{'mysql_insertid'};
1470 # work around mysql_insertid being null some of the time, ala RT :/
1471 unless ( $insertid ) {
1472 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1473 "using SELECT LAST_INSERT_ID();";
1474 my $i_sql = "SELECT LAST_INSERT_ID()";
1475 my $i_sth = dbh->prepare($i_sql) or do {
1476 dbh->rollback if $FS::UID::AutoCommit;
1479 $i_sth->execute or do {
1480 dbh->rollback if $FS::UID::AutoCommit;
1481 return $i_sth->errstr;
1483 $insertid = $i_sth->fetchrow_arrayref->[0];
1488 dbh->rollback if $FS::UID::AutoCommit;
1489 return "don't know how to retreive inserted ids from ". driver_name.
1490 ", try using counterfiles (maybe run dbdef-create?)";
1494 $self->setfield($primary_key, $insertid);
1499 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1500 my $h_statement = $self->_h_statement('insert');
1501 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1502 $h_sth = dbh->prepare($h_statement) or do {
1503 dbh->rollback if $FS::UID::AutoCommit;
1509 $h_sth->execute or return $h_sth->errstr if $h_sth;
1511 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1513 # Now that it has been saved, reset the encrypted fields so that $new
1514 # can still be used.
1515 foreach my $field (keys %{$saved}) {
1516 $self->setfield($field, $saved->{$field});
1524 Depriciated (use insert instead).
1529 cluck "warning: FS::Record::add deprecated!";
1530 insert @_; #call method in this scope
1535 Delete this record from the database. If there is an error, returns the error,
1536 otherwise returns false.
1543 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1545 $self->getfield($_) eq ''
1546 #? "( $_ IS NULL OR $_ = \"\" )"
1547 ? ( driver_name eq 'Pg'
1549 : "( $_ IS NULL OR $_ = \"\" )"
1551 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1552 } ( $self->dbdef_table->primary_key )
1553 ? ( $self->dbdef_table->primary_key)
1554 : real_fields($self->table)
1556 warn "[debug]$me $statement\n" if $DEBUG > 1;
1557 my $sth = dbh->prepare($statement) or return dbh->errstr;
1560 if ( defined dbdef->table('h_'. $self->table) ) {
1561 my $h_statement = $self->_h_statement('delete');
1562 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1563 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1568 my $primary_key = $self->dbdef_table->primary_key;
1570 local $SIG{HUP} = 'IGNORE';
1571 local $SIG{INT} = 'IGNORE';
1572 local $SIG{QUIT} = 'IGNORE';
1573 local $SIG{TERM} = 'IGNORE';
1574 local $SIG{TSTP} = 'IGNORE';
1575 local $SIG{PIPE} = 'IGNORE';
1577 my $rc = $sth->execute or return $sth->errstr;
1578 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1579 $h_sth->execute or return $h_sth->errstr if $h_sth;
1581 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1583 #no need to needlessly destoy the data either (causes problems actually)
1584 #undef $self; #no need to keep object!
1591 Depriciated (use delete instead).
1596 cluck "warning: FS::Record::del deprecated!";
1597 &delete(@_); #call method in this scope
1600 =item replace OLD_RECORD
1602 Replace the OLD_RECORD with this one in the database. If there is an error,
1603 returns the error, otherwise returns false.
1608 my ($new, $old) = (shift, shift);
1610 $old = $new->replace_old unless defined($old);
1612 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1614 if ( $new->can('replace_check') ) {
1615 my $error = $new->replace_check($old);
1616 return $error if $error;
1619 return "Records not in same table!" unless $new->table eq $old->table;
1621 my $primary_key = $old->dbdef_table->primary_key;
1622 return "Can't change primary key $primary_key ".
1623 'from '. $old->getfield($primary_key).
1624 ' to ' . $new->getfield($primary_key)
1626 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1628 my $error = $new->check;
1629 return $error if $error;
1631 # Encrypt for replace
1633 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1636 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1637 next if $field eq 'payinfo'
1638 && ($new->isa('FS::payinfo_transaction_Mixin')
1639 || $new->isa('FS::payinfo_Mixin') )
1641 && !grep { $new->payby eq $_ } @encrypt_payby;
1642 $saved->{$field} = $new->getfield($field);
1643 $new->setfield($field, $new->encrypt($new->getfield($field)));
1647 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1648 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1649 ? ($_, $new->getfield($_)) : () } $old->fields;
1651 unless (keys(%diff) || $no_update_diff ) {
1652 carp "[warning]$me ". ref($new)."->replace ".
1653 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1654 ": records identical"
1655 unless $nowarn_identical;
1659 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1661 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1662 } real_fields($old->table)
1667 if ( $old->getfield($_) eq '' ) {
1669 #false laziness w/qsearch
1670 if ( driver_name eq 'Pg' ) {
1671 my $type = $old->dbdef_table->column($_)->type;
1672 if ( $type =~ /(int|(big)?serial)/i ) {
1675 qq-( $_ IS NULL OR $_ = '' )-;
1678 qq-( $_ IS NULL OR $_ = "" )-;
1682 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1685 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1688 warn "[debug]$me $statement\n" if $DEBUG > 1;
1689 my $sth = dbh->prepare($statement) or return dbh->errstr;
1692 if ( defined dbdef->table('h_'. $old->table) ) {
1693 my $h_old_statement = $old->_h_statement('replace_old');
1694 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1695 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1701 if ( defined dbdef->table('h_'. $new->table) ) {
1702 my $h_new_statement = $new->_h_statement('replace_new');
1703 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1704 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1709 local $SIG{HUP} = 'IGNORE';
1710 local $SIG{INT} = 'IGNORE';
1711 local $SIG{QUIT} = 'IGNORE';
1712 local $SIG{TERM} = 'IGNORE';
1713 local $SIG{TSTP} = 'IGNORE';
1714 local $SIG{PIPE} = 'IGNORE';
1716 my $rc = $sth->execute or return $sth->errstr;
1717 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1718 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1719 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1721 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1723 # Now that it has been saved, reset the encrypted fields so that $new
1724 # can still be used.
1725 foreach my $field (keys %{$saved}) {
1726 $new->setfield($field, $saved->{$field});
1734 my( $self ) = shift;
1735 warn "[$me] replace called with no arguments; autoloading old record\n"
1738 my $primary_key = $self->dbdef_table->primary_key;
1739 if ( $primary_key ) {
1740 $self->by_key( $self->$primary_key() ) #this is what's returned
1741 or croak "can't find ". $self->table. ".$primary_key ".
1742 $self->$primary_key();
1744 croak $self->table. " has no primary key; pass old record as argument";
1751 Depriciated (use replace instead).
1756 cluck "warning: FS::Record::rep deprecated!";
1757 replace @_; #call method in this scope
1762 Checks custom fields. Subclasses should still provide a check method to validate
1763 non-custom fields, etc., and call this method via $self->SUPER::check.
1769 foreach my $field ($self->virtual_fields) {
1770 my $error = $self->ut_textn($field);
1771 return $error if $error;
1776 =item virtual_fields [ TABLE ]
1778 Returns a list of virtual fields defined for the table. This should not
1779 be exported, and should only be called as an instance or class method.
1783 sub virtual_fields {
1786 $table = $self->table or confess "virtual_fields called on non-table";
1788 confess "Unknown table $table" unless dbdef->table($table);
1790 return () unless dbdef->table('part_virtual_field');
1792 unless ( $virtual_fields_cache{$table} ) {
1793 my $concat = [ "'cf_'", "name" ];
1794 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1795 "WHERE dbtable = '$table'";
1797 my $result = $dbh->selectcol_arrayref($query);
1798 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1800 $virtual_fields_cache{$table} = $result;
1803 @{$virtual_fields_cache{$table}};
1807 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1809 Processes a batch import as a queued JSRPC job
1811 JOB is an FS::queue entry.
1813 OPTIONS_HASHREF can have the following keys:
1819 Table name (required).
1823 Arrayref of field names for static fields. They will be given values from the
1824 PARAMS hashref and passed as a "params" hashref to batch_import.
1828 Formats hashref. Keys are field names, values are listrefs that define the
1831 Each listref value can be a column name or a code reference. Coderefs are run
1832 with the row object, data and a FS::Conf object as the three parameters.
1833 For example, this coderef does the same thing as using the "columnname" string:
1836 my( $record, $data, $conf ) = @_;
1837 $record->columnname( $data );
1840 Coderefs are run after all "column name" fields are assigned.
1844 Optional format hashref of types. Keys are field names, values are "csv",
1845 "xls" or "fixedlength". Overrides automatic determination of file type
1848 =item format_headers
1850 Optional format hashref of header lines. Keys are field names, values are 0
1851 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1854 =item format_sep_chars
1856 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1857 CSV separation character.
1859 =item format_fixedlenth_formats
1861 Optional format hashref of fixed length format defintiions. Keys are field
1862 names, values Parse::FixedLength listrefs of field definitions.
1866 Set true to default to CSV file type if the filename does not contain a
1867 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1872 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1873 POSTed data. It must contain the field "uploaded files", generated by
1874 /elements/file-upload.html and containing the list of uploaded files.
1875 Currently only supports a single file named "file".
1880 sub process_batch_import {
1881 my($job, $opt, $param) = @_;
1883 my $table = $opt->{table};
1884 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1885 my %formats = %{ $opt->{formats} };
1887 warn Dumper($param) if $DEBUG;
1889 my $files = $param->{'uploaded_files'}
1890 or die "No files provided.\n";
1892 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1894 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1895 my $file = $dir. $files{'file'};
1900 formats => \%formats,
1901 format_types => $opt->{format_types},
1902 format_headers => $opt->{format_headers},
1903 format_sep_chars => $opt->{format_sep_chars},
1904 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1905 format_xml_formats => $opt->{format_xml_formats},
1906 format_asn_formats => $opt->{format_asn_formats},
1907 format_row_callbacks => $opt->{format_row_callbacks},
1908 format_hash_callbacks => $opt->{format_hash_callbacks},
1913 format => $param->{format},
1914 params => { map { $_ => $param->{$_} } @pass_params },
1916 default_csv => $opt->{default_csv},
1917 preinsert_callback => $opt->{preinsert_callback},
1918 postinsert_callback => $opt->{postinsert_callback},
1919 insert_args_callback => $opt->{insert_args_callback},
1922 if ( $opt->{'batch_namecol'} ) {
1923 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1924 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1927 my $error = FS::Record::batch_import( \%iopt );
1931 die "$error\n" if $error;
1934 =item batch_import PARAM_HASHREF
1936 Class method for batch imports. Available params:
1942 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1948 =item format_headers
1950 =item format_sep_chars
1952 =item format_fixedlength_formats
1954 =item format_row_callbacks
1956 =item format_hash_callbacks - After parsing, before object creation
1958 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1960 =item preinsert_callback
1962 =item postinsert_callback
1968 FS::queue object, will be updated with progress
1974 csv, xls, fixedlength, xml
1986 warn "$me batch_import call with params: \n". Dumper($param)
1989 my $table = $param->{table};
1991 my $job = $param->{job};
1992 my $file = $param->{file};
1993 my $params = $param->{params} || {};
1995 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1996 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1998 my( $type, $header, $sep_char,
1999 $fixedlength_format, $xml_format, $asn_format,
2000 $parser_opt, $row_callback, $hash_callback, @fields );
2002 my $postinsert_callback = '';
2003 $postinsert_callback = $param->{'postinsert_callback'}
2004 if $param->{'postinsert_callback'};
2005 my $preinsert_callback = '';
2006 $preinsert_callback = $param->{'preinsert_callback'}
2007 if $param->{'preinsert_callback'};
2008 my $insert_args_callback = '';
2009 $insert_args_callback = $param->{'insert_args_callback'}
2010 if $param->{'insert_args_callback'};
2012 if ( $param->{'format'} ) {
2014 my $format = $param->{'format'};
2015 my $formats = $param->{formats};
2016 die "unknown format $format" unless exists $formats->{ $format };
2018 $type = $param->{'format_types'}
2019 ? $param->{'format_types'}{ $format }
2020 : $param->{type} || 'csv';
2023 $header = $param->{'format_headers'}
2024 ? $param->{'format_headers'}{ $param->{'format'} }
2027 $sep_char = $param->{'format_sep_chars'}
2028 ? $param->{'format_sep_chars'}{ $param->{'format'} }
2031 $fixedlength_format =
2032 $param->{'format_fixedlength_formats'}
2033 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
2037 $param->{'format_parser_opts'}
2038 ? $param->{'format_parser_opts'}{ $param->{'format'} }
2042 $param->{'format_xml_formats'}
2043 ? $param->{'format_xml_formats'}{ $param->{'format'} }
2047 $param->{'format_asn_formats'}
2048 ? $param->{'format_asn_formats'}{ $param->{'format'} }
2052 $param->{'format_row_callbacks'}
2053 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
2057 $param->{'format_hash_callbacks'}
2058 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
2061 @fields = @{ $formats->{ $format } };
2063 } elsif ( $param->{'fields'} ) {
2065 $type = ''; #infer from filename
2068 $fixedlength_format = '';
2070 $hash_callback = '';
2071 @fields = @{ $param->{'fields'} };
2074 die "neither format nor fields specified";
2077 #my $file = $param->{file};
2080 if ( $file =~ /\.(\w+)$/i ) {
2084 warn "can't parse file type from filename $file; defaulting to CSV";
2088 if $param->{'default_csv'} && $type ne 'xls';
2096 my $asn_header_buffer;
2097 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2099 if ( $type eq 'csv' ) {
2101 $parser_opt->{'binary'} = 1;
2102 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2103 $parser = Text::CSV_XS->new($parser_opt);
2105 } elsif ( $type eq 'fixedlength' ) {
2107 eval "use Parse::FixedLength;";
2109 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2112 die "Unknown file type $type\n";
2115 @buffer = split(/\r?\n/, slurp($file) );
2116 splice(@buffer, 0, ($header || 0) );
2117 $count = scalar(@buffer);
2119 } elsif ( $type eq 'xls' ) {
2121 eval "use Spreadsheet::ParseExcel;";
2124 eval "use DateTime::Format::Excel;";
2125 #for now, just let the error be thrown if it is used, since only CDR
2126 # formats bill_west and troop use it, not other excel-parsing things
2129 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2131 $parser = $excel->{Worksheet}[0]; #first sheet
2133 $count = $parser->{MaxRow} || $parser->{MinRow};
2136 $row = $header || 0;
2138 } elsif ( $type eq 'xml' ) {
2141 eval "use XML::Simple;";
2143 my $xmlrow = $xml_format->{'xmlrow'};
2144 $parser = $xml_format->{'xmlkeys'};
2145 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2146 my $data = XML::Simple::XMLin(
2148 'SuppressEmpty' => '', #sets empty values to ''
2152 $rows = $rows->{$_} foreach @$xmlrow;
2153 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2154 $count = @buffer = @$rows;
2156 } elsif ( $type eq 'asn.1' ) {
2158 eval "use Convert::ASN1";
2161 my $asn = Convert::ASN1->new;
2162 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2164 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2166 my $data = slurp($file);
2167 my $asn_output = $parser->decode( $data )
2168 or return "No ". $asn_format->{'macro'}. " found\n";
2170 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2172 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2173 $count = @buffer = @$rows;
2176 die "Unknown file type $type\n";
2181 local $SIG{HUP} = 'IGNORE';
2182 local $SIG{INT} = 'IGNORE';
2183 local $SIG{QUIT} = 'IGNORE';
2184 local $SIG{TERM} = 'IGNORE';
2185 local $SIG{TSTP} = 'IGNORE';
2186 local $SIG{PIPE} = 'IGNORE';
2188 my $oldAutoCommit = $FS::UID::AutoCommit;
2189 local $FS::UID::AutoCommit = 0;
2192 #my $params = $param->{params} || {};
2193 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2194 my $batch_col = $param->{'batch_keycol'};
2196 my $batch_class = 'FS::'. $param->{'batch_table'};
2197 my $batch = $batch_class->new({
2198 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2200 my $error = $batch->insert;
2202 $dbh->rollback if $oldAutoCommit;
2203 return "can't insert batch record: $error";
2205 #primary key via dbdef? (so the column names don't have to match)
2206 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2208 $params->{ $batch_col } = $batch_value;
2211 #my $job = $param->{job};
2214 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2218 my %hash = %$params;
2219 if ( $type eq 'csv' ) {
2221 last unless scalar(@buffer);
2222 $line = shift(@buffer);
2224 next if $line =~ /^\s*$/; #skip empty lines
2226 $line = &{$row_callback}($line) if $row_callback;
2228 next if $line =~ /^\s*$/; #skip empty lines
2230 $parser->parse($line) or do {
2231 $dbh->rollback if $oldAutoCommit;
2232 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2234 @columns = $parser->fields();
2236 } elsif ( $type eq 'fixedlength' ) {
2238 last unless scalar(@buffer);
2239 $line = shift(@buffer);
2241 @columns = $parser->parse($line);
2243 } elsif ( $type eq 'xls' ) {
2245 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2246 || ! $parser->{Cells}[$row];
2248 my @row = @{ $parser->{Cells}[$row] };
2249 @columns = map $_->{Val}, @row;
2252 #warn $z++. ": $_\n" for @columns;
2254 } elsif ( $type eq 'xml' ) {
2256 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2257 last unless scalar(@buffer);
2258 my $row = shift @buffer;
2259 @columns = @{ $row }{ @$parser };
2261 } elsif ( $type eq 'asn.1' ) {
2263 last unless scalar(@buffer);
2264 my $row = shift @buffer;
2265 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2266 if $asn_format->{row_callback};
2267 foreach my $key ( keys %{ $asn_format->{map} } ) {
2268 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2272 die "Unknown file type $type\n";
2277 foreach my $field ( @fields ) {
2279 my $value = shift @columns;
2281 if ( ref($field) eq 'CODE' ) {
2282 #&{$field}(\%hash, $value);
2283 push @later, $field, $value;
2285 #??? $hash{$field} = $value if length($value);
2286 $hash{$field} = $value if defined($value) && length($value);
2291 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2292 && length($1) == $custnum_length ) {
2293 $hash{custnum} = $2;
2296 %hash = &{$hash_callback}(%hash) if $hash_callback;
2298 #my $table = $param->{table};
2299 my $class = "FS::$table";
2301 my $record = $class->new( \%hash );
2304 while ( scalar(@later) ) {
2305 my $sub = shift @later;
2306 my $data = shift @later;
2308 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2311 $dbh->rollback if $oldAutoCommit;
2312 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2314 last if exists( $param->{skiprow} );
2316 next if exists( $param->{skiprow} );
2318 if ( $preinsert_callback ) {
2319 my $error = &{$preinsert_callback}($record, $param);
2321 $dbh->rollback if $oldAutoCommit;
2322 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2325 next if exists $param->{skiprow} && $param->{skiprow};
2328 my @insert_args = ();
2329 if ( $insert_args_callback ) {
2330 @insert_args = &{$insert_args_callback}($record, $param);
2333 my $error = $record->insert(@insert_args);
2336 $dbh->rollback if $oldAutoCommit;
2337 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2343 if ( $postinsert_callback ) {
2344 my $error = &{$postinsert_callback}($record, $param);
2346 $dbh->rollback if $oldAutoCommit;
2347 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2352 if ( $job && time - $min_sec > $last ) { #progress bar
2353 $job->update_statustext( int(100 * $imported / $count) );
2359 unless ( $imported || $param->{empty_ok} ) {
2360 $dbh->rollback if $oldAutoCommit;
2361 return "Empty file!";
2364 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2371 my( $self, $action, $time ) = @_;
2375 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2378 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2379 real_fields($self->table);
2382 # If we're encrypting then don't store the payinfo in the history
2383 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2384 @fields = grep { $_ ne 'payinfo' } @fields;
2387 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2389 "INSERT INTO h_". $self->table. " ( ".
2390 join(', ', qw(history_date history_usernum history_action), @fields ).
2393 $FS::CurrentUser::CurrentUser->usernum,
2394 dbh->quote($action),
2403 B<Warning>: External use is B<deprecated>.
2405 Replaces COLUMN in record with a unique number, using counters in the
2406 filesystem. Used by the B<insert> method on single-field unique columns
2407 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2408 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2410 Returns the new value.
2415 my($self,$field) = @_;
2416 my($table)=$self->table;
2418 croak "Unique called on field $field, but it is ",
2419 $self->getfield($field),
2421 if $self->getfield($field);
2423 #warn "table $table is tainted" if is_tainted($table);
2424 #warn "field $field is tainted" if is_tainted($field);
2426 my($counter) = new File::CounterFile "$table.$field",0;
2428 my $index = $counter->inc;
2429 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2431 $index =~ /^(\d*)$/;
2434 $self->setfield($field,$index);
2438 =item ut_float COLUMN
2440 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2441 null. If there is an error, returns the error, otherwise returns false.
2446 my($self,$field)=@_ ;
2447 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2448 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2449 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2450 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2451 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2452 $self->setfield($field,$1);
2455 =item ut_floatn COLUMN
2457 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2458 null. If there is an error, returns the error, otherwise returns false.
2462 #false laziness w/ut_ipn
2464 my( $self, $field ) = @_;
2465 if ( $self->getfield($field) =~ /^()$/ ) {
2466 $self->setfield($field,'');
2469 $self->ut_float($field);
2473 =item ut_sfloat COLUMN
2475 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2476 May not be null. If there is an error, returns the error, otherwise returns
2482 my($self,$field)=@_ ;
2483 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2484 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2485 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2486 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2487 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2488 $self->setfield($field,$1);
2491 =item ut_sfloatn COLUMN
2493 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2494 null. If there is an error, returns the error, otherwise returns false.
2499 my( $self, $field ) = @_;
2500 if ( $self->getfield($field) =~ /^()$/ ) {
2501 $self->setfield($field,'');
2504 $self->ut_sfloat($field);
2508 =item ut_snumber COLUMN
2510 Check/untaint signed numeric data (whole numbers). If there is an error,
2511 returns the error, otherwise returns false.
2516 my($self, $field) = @_;
2517 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2518 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2519 $self->setfield($field, "$1$2");
2523 =item ut_snumbern COLUMN
2525 Check/untaint signed numeric data (whole numbers). If there is an error,
2526 returns the error, otherwise returns false.
2531 my($self, $field) = @_;
2532 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2533 or return "Illegal (numeric) $field: ". $self->getfield($field);
2535 return "Illegal (numeric) $field: ". $self->getfield($field)
2538 $self->setfield($field, "$1$2");
2542 =item ut_number COLUMN
2544 Check/untaint simple numeric data (whole numbers). May not be null. If there
2545 is an error, returns the error, otherwise returns false.
2550 my($self,$field)=@_;
2551 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2552 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2553 $self->setfield($field,$1);
2557 =item ut_numbern COLUMN
2559 Check/untaint simple numeric data (whole numbers). May be null. If there is
2560 an error, returns the error, otherwise returns false.
2565 my($self,$field)=@_;
2566 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2567 or return "Illegal (numeric) $field: ". $self->getfield($field);
2568 $self->setfield($field,$1);
2572 =item ut_decimal COLUMN[, DIGITS]
2574 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2575 error, returns the error, otherwise returns false.
2577 =item ut_decimaln COLUMN[, DIGITS]
2579 Check/untaint decimal numbers. May be null. If there is an error, returns
2580 the error, otherwise returns false.
2585 my($self, $field, $digits) = @_;
2587 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2588 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2589 $self->setfield($field, $1);
2594 my($self, $field, $digits) = @_;
2595 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2596 or return "Illegal (decimal) $field: ".$self->getfield($field);
2597 $self->setfield($field, $1);
2601 =item ut_money COLUMN
2603 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2604 is an error, returns the error, otherwise returns false.
2609 my($self,$field)=@_;
2611 if ( $self->getfield($field) eq '' ) {
2612 $self->setfield($field, 0);
2613 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2614 #handle one decimal place without barfing out
2615 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2616 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2617 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2619 return "Illegal (money) $field: ". $self->getfield($field);
2625 =item ut_moneyn COLUMN
2627 Check/untaint monetary numbers. May be negative. If there
2628 is an error, returns the error, otherwise returns false.
2633 my($self,$field)=@_;
2634 if ($self->getfield($field) eq '') {
2635 $self->setfield($field, '');
2638 $self->ut_money($field);
2641 =item ut_currencyn COLUMN
2643 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2644 is an error, returns the error, otherwise returns false.
2649 my($self, $field) = @_;
2650 if ($self->getfield($field) eq '') { #can be null
2651 $self->setfield($field, '');
2654 $self->ut_currency($field);
2657 =item ut_currency COLUMN
2659 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2660 there is an error, returns the error, otherwise returns false.
2665 my($self, $field) = @_;
2666 my $value = uc( $self->getfield($field) );
2667 if ( code2currency($value) ) {
2668 $self->setfield($value);
2670 return "Unknown currency $value";
2676 =item ut_text COLUMN
2678 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2679 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < > ~
2680 May not be null. If there is an error, returns the error, otherwise returns
2686 my($self,$field)=@_;
2687 #warn "msgcat ". \&msgcat. "\n";
2688 #warn "notexist ". \¬exist. "\n";
2689 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2690 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2691 # see perldoc perluniprops
2692 $self->getfield($field)
2693 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>\~$money_char]+)$/
2694 or return gettext('illegal_or_empty_text'). " $field: ".
2695 $self->getfield($field);
2696 $self->setfield($field,$1);
2700 =item ut_textn COLUMN
2702 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2703 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2704 May be null. If there is an error, returns the error, otherwise returns false.
2709 my($self,$field)=@_;
2710 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2711 $self->ut_text($field);
2714 =item ut_alpha COLUMN
2716 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2717 an error, returns the error, otherwise returns false.
2722 my($self,$field)=@_;
2723 $self->getfield($field) =~ /^(\w+)$/
2724 or return "Illegal or empty (alphanumeric) $field: ".
2725 $self->getfield($field);
2726 $self->setfield($field,$1);
2730 =item ut_alphan COLUMN
2732 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2733 error, returns the error, otherwise returns false.
2738 my($self,$field)=@_;
2739 $self->getfield($field) =~ /^(\w*)$/
2740 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2741 $self->setfield($field,$1);
2745 =item ut_alphasn COLUMN
2747 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2748 an error, returns the error, otherwise returns false.
2753 my($self,$field)=@_;
2754 $self->getfield($field) =~ /^([\w ]*)$/
2755 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2756 $self->setfield($field,$1);
2761 =item ut_alpha_lower COLUMN
2763 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2764 there is an error, returns the error, otherwise returns false.
2768 sub ut_alpha_lower {
2769 my($self,$field)=@_;
2770 $self->getfield($field) =~ /[[:upper:]]/
2771 and return "Uppercase characters are not permitted in $field";
2772 $self->ut_alpha($field);
2775 =item ut_phonen COLUMN [ COUNTRY ]
2777 Check/untaint phone numbers. May be null. If there is an error, returns
2778 the error, otherwise returns false.
2780 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2781 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2786 my( $self, $field, $country ) = @_;
2787 return $self->ut_alphan($field) unless defined $country;
2788 my $phonen = $self->getfield($field);
2789 if ( $phonen eq '' ) {
2790 $self->setfield($field,'');
2791 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2793 $phonen = $conf->config('cust_main-default_areacode').$phonen
2794 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2795 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2796 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2797 $phonen = "$1-$2-$3";
2798 $phonen .= " x$4" if $4;
2799 $self->setfield($field,$phonen);
2801 warn "warning: don't know how to check phone numbers for country $country";
2802 return $self->ut_textn($field);
2809 Check/untaint hexadecimal values.
2814 my($self, $field) = @_;
2815 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2816 or return "Illegal (hex) $field: ". $self->getfield($field);
2817 $self->setfield($field, uc($1));
2821 =item ut_hexn COLUMN
2823 Check/untaint hexadecimal values. May be null.
2828 my($self, $field) = @_;
2829 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2830 or return "Illegal (hex) $field: ". $self->getfield($field);
2831 $self->setfield($field, uc($1));
2835 =item ut_mac_addr COLUMN
2837 Check/untaint mac addresses. May be null.
2842 my($self, $field) = @_;
2844 my $mac = $self->get($field);
2847 $self->set($field, $mac);
2849 my $e = $self->ut_hex($field);
2852 return "Illegal (mac address) $field: ". $self->getfield($field)
2853 unless length($self->getfield($field)) == 12;
2859 =item ut_mac_addrn COLUMN
2861 Check/untaint mac addresses. May be null.
2866 my($self, $field) = @_;
2867 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2872 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2878 my( $self, $field ) = @_;
2879 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2880 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2881 or return "Illegal (IP address) $field: ". $self->getfield($field);
2882 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2883 $self->setfield($field, "$1.$2.$3.$4");
2889 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2890 to 127.0.0.1. May be null.
2895 my( $self, $field ) = @_;
2896 if ( $self->getfield($field) =~ /^()$/ ) {
2897 $self->setfield($field,'');
2900 $self->ut_ip($field);
2904 =item ut_ip46 COLUMN
2906 Check/untaint IPv4 or IPv6 address.
2911 my( $self, $field ) = @_;
2912 my $ip = NetAddr::IP->new($self->getfield($field))
2913 or return "Illegal (IP address) $field: ".$self->getfield($field);
2914 $self->setfield($field, lc($ip->addr));
2920 Check/untaint IPv6 or IPv6 address. May be null.
2925 my( $self, $field ) = @_;
2926 if ( $self->getfield($field) =~ /^$/ ) {
2927 $self->setfield($field, '');
2930 $self->ut_ip46($field);
2933 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2935 Check/untaint coordinates.
2936 Accepts the following forms:
2946 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2947 The latter form (that is, the MMM are thousands of minutes) is
2948 assumed if the "MMM" is exactly three digits or two digits > 59.
2950 To be safe, just use the DDD.DDDDD form.
2952 If LOWER or UPPER are specified, then the coordinate is checked
2953 for lower and upper bounds, respectively.
2958 my ($self, $field) = (shift, shift);
2961 if ( $field =~ /latitude/ ) {
2962 $lower = $lat_lower;
2964 } elsif ( $field =~ /longitude/ ) {
2966 $upper = $lon_upper;
2969 my $coord = $self->getfield($field);
2970 my $neg = $coord =~ s/^(-)//;
2972 # ignore degree symbol at the end,
2973 # but not otherwise supporting degree/minutes/seconds symbols
2974 $coord =~ s/\N{DEGREE SIGN}\s*$//;
2976 my ($d, $m, $s) = (0, 0, 0);
2979 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2980 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2981 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2983 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2986 return "Invalid (coordinate with minutes > 59) $field: "
2987 . $self->getfield($field);
2990 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2992 if (defined($lower) and ($coord < $lower)) {
2993 return "Invalid (coordinate < $lower) $field: "
2994 . $self->getfield($field);;
2997 if (defined($upper) and ($coord > $upper)) {
2998 return "Invalid (coordinate > $upper) $field: "
2999 . $self->getfield($field);;
3002 $self->setfield($field, $coord);
3006 return "Invalid (coordinate) $field: " . $self->getfield($field);
3010 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
3012 Same as ut_coord, except optionally null.
3018 my ($self, $field) = (shift, shift);
3020 if ($self->getfield($field) =~ /^\s*$/) {
3023 return $self->ut_coord($field, @_);
3028 =item ut_domain COLUMN
3030 Check/untaint host and domain names. May not be null.
3035 my( $self, $field ) = @_;
3036 #$self->getfield($field) =~/^(\w+\.)*\w+$/
3037 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
3038 or return "Illegal (hostname) $field: ". $self->getfield($field);
3039 $self->setfield($field,$1);
3043 =item ut_domainn COLUMN
3045 Check/untaint host and domain names. May be null.
3050 my( $self, $field ) = @_;
3051 if ( $self->getfield($field) =~ /^()$/ ) {
3052 $self->setfield($field,'');
3055 $self->ut_domain($field);
3059 =item ut_name COLUMN
3061 Check/untaint proper names; allows alphanumerics, spaces and the following
3062 punctuation: , . - '
3069 my( $self, $field ) = @_;
3070 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
3071 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
3076 $self->setfield($field, $name);
3080 =item ut_namen COLUMN
3082 Check/untaint proper names; allows alphanumerics, spaces and the following
3083 punctuation: , . - '
3090 my( $self, $field ) = @_;
3091 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3092 $self->ut_name($field);
3097 Check/untaint zip codes.
3101 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3104 my( $self, $field, $country ) = @_;
3106 if ( $country eq 'US' ) {
3108 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3109 or return gettext('illegal_zip'). " $field for country $country: ".
3110 $self->getfield($field);
3111 $self->setfield($field, $1);
3113 } elsif ( $country eq 'CA' ) {
3115 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3116 or return gettext('illegal_zip'). " $field for country $country: ".
3117 $self->getfield($field);
3118 $self->setfield($field, "$1 $2");
3120 } elsif ( $country eq 'AU' ) {
3122 $self->getfield($field) =~ /^\s*(\d{4})\s*$/
3123 or return gettext('illegal_zip'). " $field for country $country: ".
3124 $self->getfield($field);
3125 $self->setfield($field, $1);
3129 if ( $self->getfield($field) =~ /^\s*$/
3130 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3133 $self->setfield($field,'');
3135 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3136 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3137 $self->setfield($field,$1);
3145 =item ut_country COLUMN
3147 Check/untaint country codes. Country names are changed to codes, if possible -
3148 see L<Locale::Country>.
3153 my( $self, $field ) = @_;
3154 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3155 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3156 && country2code($1) ) {
3157 $self->setfield($field,uc(country2code($1)));
3160 $self->getfield($field) =~ /^(\w\w)$/
3161 or return "Illegal (country) $field: ". $self->getfield($field);
3162 $self->setfield($field,uc($1));
3166 =item ut_anything COLUMN
3168 Untaints arbitrary data. Be careful.
3173 my( $self, $field ) = @_;
3174 $self->getfield($field) =~ /^(.*)$/s
3175 or return "Illegal $field: ". $self->getfield($field);
3176 $self->setfield($field,$1);
3180 =item ut_enum COLUMN CHOICES_ARRAYREF
3182 Check/untaint a column, supplying all possible choices, like the "enum" type.
3187 my( $self, $field, $choices ) = @_;
3188 foreach my $choice ( @$choices ) {
3189 if ( $self->getfield($field) eq $choice ) {
3190 $self->setfield($field, $choice);
3194 return "Illegal (enum) field $field: ". $self->getfield($field);
3197 =item ut_enumn COLUMN CHOICES_ARRAYREF
3199 Like ut_enum, except the null value is also allowed.
3204 my( $self, $field, $choices ) = @_;
3205 $self->getfield($field)
3206 ? $self->ut_enum($field, $choices)
3210 =item ut_date COLUMN
3212 Check/untaint a column containing a date string.
3214 Date will be normalized to YYYY-MM-DD format
3219 my ( $self, $field ) = @_;
3220 my $value = $self->getfield( $field );
3222 my @date = split /[\-\/]/, $value;
3223 if ( scalar(@date) == 3 ) {
3224 @date = @date[2,0,1] if $date[2] >= 1900;
3229 # DateTime will die given invalid date
3230 $ymd = DateTime->new(
3238 $self->setfield( $field, $ymd ) unless $value eq $ymd;
3243 return "Illegal (date) field $field: $value";
3246 =item ut_daten COLUMN
3248 Check/untaint a column containing a date string.
3252 Date will be normalized to YYYY-MM-DD format
3257 my ( $self, $field ) = @_;
3259 $self->getfield( $field ) =~ /^()$/
3260 ? $self->setfield( $field, '' )
3261 : $self->ut_date( $field );
3264 =item ut_flag COLUMN
3266 Check/untaint a column if it contains either an empty string or 'Y'. This
3267 is the standard form for boolean flags in Freeside.
3272 my( $self, $field ) = @_;
3273 my $value = uc($self->getfield($field));
3274 if ( $value eq '' or $value eq 'Y' ) {
3275 $self->setfield($field, $value);
3278 return "Illegal (flag) field $field: $value";
3281 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3283 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3284 on the column first.
3288 sub ut_foreign_key {
3289 my( $self, $field, $table, $foreign ) = @_;
3290 return $self->ut_number($field) if $no_check_foreign;
3291 qsearchs($table, { $foreign => $self->getfield($field) })
3292 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3293 " in $table.$foreign";
3297 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3299 Like ut_foreign_key, except the null value is also allowed.
3303 sub ut_foreign_keyn {
3304 my( $self, $field, $table, $foreign ) = @_;
3305 $self->getfield($field)
3306 ? $self->ut_foreign_key($field, $table, $foreign)
3310 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3312 Checks this column as an agentnum, taking into account the current users's
3313 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3314 right or rights allowing no agentnum.
3318 sub ut_agentnum_acl {
3319 my( $self, $field ) = (shift, shift);
3320 my $null_acl = scalar(@_) ? shift : [];
3321 $null_acl = [ $null_acl ] unless ref($null_acl);
3323 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3324 return "Illegal agentnum: $error" if $error;
3326 my $curuser = $FS::CurrentUser::CurrentUser;
3328 if ( $self->$field() ) {
3330 return 'Access denied to agent '. $self->$field()
3331 unless $curuser->agentnum($self->$field());
3335 return 'Access denied to global'
3336 unless grep $curuser->access_right($_), @$null_acl;
3344 =item trim_whitespace FIELD[, FIELD ... ]
3346 Strip leading and trailing spaces from the value in the named FIELD(s).
3350 sub trim_whitespace {
3352 foreach my $field (@_) {
3353 my $value = $self->get($field);
3356 $self->set($field, $value);
3360 =item fields [ TABLE ]
3362 This is a wrapper for real_fields. Code that called
3363 fields before should probably continue to call fields.
3368 my $something = shift;
3370 if($something->isa('FS::Record')) {
3371 $table = $something->table;
3373 $table = $something;
3374 #$something = "FS::$table";
3376 return (real_fields($table));
3380 =item encrypt($value)
3382 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3384 Returns the encrypted string.
3386 You should generally not have to worry about calling this, as the system handles this for you.
3391 my ($self, $value) = @_;
3392 my $encrypted = $value;
3394 if ($conf_encryption) {
3395 if ($self->is_encrypted($value)) {
3396 # Return the original value if it isn't plaintext.
3397 $encrypted = $value;
3400 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3401 # RSA doesn't like the empty string so let's pack it up
3402 # The database doesn't like the RSA data so uuencode it
3403 my $length = length($value)+1;
3404 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3406 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3413 =item is_encrypted($value)
3415 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3421 my ($self, $value) = @_;
3422 # could be more precise about it, but this will do for now
3423 $value =~ /^M/ && length($value) > 80;
3426 =item decrypt($value)
3428 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3430 You should generally not have to worry about calling this, as the system handles this for you.
3435 my ($self,$value) = @_;
3436 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3437 if ($conf_encryption && $self->is_encrypted($value)) {
3439 if (ref($rsa_decrypt) =~ /::RSA/) {
3440 my $encrypted = unpack ("u*", $value);
3441 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3442 if ($@) {warn "Decryption Failed"};
3451 my $rsa_module = $conf_encryptionmodule || 'Crypt::OpenSSL::RSA';
3453 # Initialize Encryption
3454 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3455 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3458 # Intitalize Decryption
3459 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3460 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3464 =item h_search ACTION
3466 Given an ACTION, either "insert", or "delete", returns the appropriate history
3467 record corresponding to this record, if any.
3472 my( $self, $action ) = @_;
3474 my $table = $self->table;
3477 my $primary_key = dbdef->table($table)->primary_key;
3480 'table' => "h_$table",
3481 'hashref' => { $primary_key => $self->$primary_key(),
3482 'history_action' => $action,
3490 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3491 appropriate history record corresponding to this record, if any.
3496 my($self, $action) = @_;
3497 my $h = $self->h_search($action);
3498 $h ? $h->history_date : '';
3501 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3503 A class or object method. Executes the sql statement represented by SQL and
3504 returns a scalar representing the result: the first column of the first row.
3506 Dies on bogus SQL. Returns an empty string if no row is returned.
3508 Typically used for statments which return a single value such as "SELECT
3509 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3514 my($self, $sql) = (shift, shift);
3515 my $sth = dbh->prepare($sql) or die dbh->errstr;
3517 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3518 my $row = $sth->fetchrow_arrayref or return '';
3519 my $scalar = $row->[0];
3520 defined($scalar) ? $scalar : '';
3523 =item count [ WHERE [, PLACEHOLDER ...] ]
3525 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3526 with optional WHERE. Must be called as method on a class with an
3532 my($self, $where) = (shift, shift);
3533 my $table = $self->table or die 'count called on object of class '.ref($self);
3534 my $sql = "SELECT COUNT(*) FROM $table";
3535 $sql .= " WHERE $where" if $where;
3536 $self->scalar_sql($sql, @_);
3539 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3541 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3542 with optional (but almost always needed) WHERE.
3547 my($self, $where) = (shift, shift);
3548 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3549 my $sql = "SELECT 1 FROM $table";
3550 $sql .= " WHERE $where" if $where;
3552 $self->scalar_sql($sql, @_);
3561 =item real_fields [ TABLE ]
3563 Returns a list of the real columns in the specified table. Called only by
3564 fields() and other subroutines elsewhere in FS::Record.
3571 my($table_obj) = dbdef->table($table);
3572 confess "Unknown table $table" unless $table_obj;
3573 $table_obj->columns;
3576 =item pvf FIELD_NAME
3578 Returns the FS::part_virtual_field object corresponding to a field in the
3579 record (specified by FIELD_NAME).
3584 my ($self, $name) = (shift, shift);
3586 if(grep /^$name$/, $self->virtual_fields) {
3588 my $concat = [ "'cf_'", "name" ];
3589 return qsearchs({ table => 'part_virtual_field',
3590 hashref => { dbtable => $self->table,
3593 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3599 =item _quote VALUE, TABLE, COLUMN
3601 This is an internal function used to construct SQL statements. It returns
3602 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3603 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3608 my($value, $table, $column) = @_;
3609 my $column_obj = dbdef->table($table)->column($column);
3610 my $column_type = $column_obj->type;
3611 my $nullable = $column_obj->null;
3613 utf8::upgrade($value);
3615 warn " $table.$column: $value ($column_type".
3616 ( $nullable ? ' NULL' : ' NOT NULL' ).
3617 ")\n" if $DEBUG > 2;
3619 if ( $value eq '' && $nullable ) {
3621 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3622 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3625 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3626 ! $column_type =~ /(char|binary|text)$/i ) {
3628 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3629 && driver_name eq 'Pg'
3632 dbh->quote($value, { pg_type => PG_BYTEA() });
3640 This is deprecated. Don't use it.
3642 It returns a hash-type list with the fields of this record's table set true.
3647 carp "warning: hfields is deprecated";
3650 foreach (fields($table)) {
3659 "$_: ". $self->getfield($_). "|"
3660 } (fields($self->table)) );
3663 sub DESTROY { return; }
3667 # #use Carp qw(cluck);
3668 # #cluck "DESTROYING $self";
3669 # warn "DESTROYING $self";
3673 # return ! eval { join('',@_), kill 0; 1; };
3676 =item str2time_sql [ DRIVER_NAME ]
3678 Returns a function to convert to unix time based on database type, such as
3679 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3680 the str2time_sql_closing method to return a closing string rather than just
3681 using a closing parenthesis as previously suggested.
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 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3693 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3695 warn "warning: unknown database type $driver; guessing how to convert ".
3696 "dates to UNIX timestamps";
3697 return 'EXTRACT(EPOCH FROM ';
3701 =item str2time_sql_closing [ DRIVER_NAME ]
3703 Returns the closing suffix of a function to convert to unix time based on
3704 database type, such as ")::integer" for Pg or ")" for mysql.
3706 You can pass an optional driver name such as "Pg", "mysql" or
3707 $dbh->{Driver}->{Name} to return a function for that database instead of
3708 the current database.
3712 sub str2time_sql_closing {
3713 my $driver = shift || driver_name;
3715 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3719 =item regexp_sql [ DRIVER_NAME ]
3721 Returns the operator to do a regular expression comparison based on database
3722 type, such as '~' for Pg or 'REGEXP' for mysql.
3724 You can pass an optional driver name such as "Pg", "mysql" or
3725 $dbh->{Driver}->{Name} to return a function for that database instead of
3726 the current database.
3731 my $driver = shift || driver_name;
3733 return '~' if $driver =~ /^Pg/i;
3734 return 'REGEXP' if $driver =~ /^mysql/i;
3736 die "don't know how to use regular expressions in ". driver_name." databases";
3740 =item not_regexp_sql [ DRIVER_NAME ]
3742 Returns the operator to do a regular expression negation based on database
3743 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3745 You can pass an optional driver name such as "Pg", "mysql" or
3746 $dbh->{Driver}->{Name} to return a function for that database instead of
3747 the current database.
3751 sub not_regexp_sql {
3752 my $driver = shift || driver_name;
3754 return '!~' if $driver =~ /^Pg/i;
3755 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3757 die "don't know how to use regular expressions in ". driver_name." databases";
3761 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3763 Returns the items concatenated based on database type, using "CONCAT()" for
3764 mysql and " || " for Pg and other databases.
3766 You can pass an optional driver name such as "Pg", "mysql" or
3767 $dbh->{Driver}->{Name} to return a function for that database instead of
3768 the current database.
3773 my $driver = ref($_[0]) ? driver_name : shift;
3776 if ( $driver =~ /^mysql/i ) {
3777 'CONCAT('. join(',', @$items). ')';
3779 join('||', @$items);
3784 =item group_concat_sql COLUMN, DELIMITER
3786 Returns an SQL expression to concatenate an aggregate column, using
3787 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3791 sub group_concat_sql {
3792 my ($col, $delim) = @_;
3793 $delim = dbh->quote($delim);
3794 if ( driver_name() =~ /^mysql/i ) {
3795 # DISTINCT(foo) is valid as $col
3796 return "GROUP_CONCAT($col SEPARATOR $delim)";
3798 return "array_to_string(array_agg($col), $delim)";
3802 =item midnight_sql DATE
3804 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3805 on that day in the system timezone, using the default driver name.
3810 my $driver = driver_name;
3812 if ( $driver =~ /^mysql/i ) {
3813 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3816 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3824 This module should probably be renamed, since much of the functionality is
3825 of general use. It is not completely unlike Adapter::DBI (see below).
3827 Exported qsearch and qsearchs should be deprecated in favor of method calls
3828 (against an FS::Record object like the old search and searchs that qsearch
3829 and qsearchs were on top of.)
3831 The whole fields / hfields mess should be removed.
3833 The various WHERE clauses should be subroutined.
3835 table string should be deprecated in favor of DBIx::DBSchema::Table.
3837 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3838 true maps to the database (and WHERE clauses) would also help.
3840 The ut_ methods should ask the dbdef for a default length.
3842 ut_sqltype (like ut_varchar) should all be defined
3844 A fallback check method should be provided which uses the dbdef.
3846 The ut_money method assumes money has two decimal digits.
3848 The Pg money kludge in the new method only strips `$'.
3850 The ut_phonen method only checks US-style phone numbers.
3852 The _quote function should probably use ut_float instead of a regex.
3854 All the subroutines probably should be methods, here or elsewhere.
3856 Probably should borrow/use some dbdef methods where appropriate (like sub
3859 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3860 or allow it to be set. Working around it is ugly any way around - DBI should
3861 be fixed. (only affects RDBMS which return uppercase column names)
3863 ut_zip should take an optional country like ut_phone.
3867 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3869 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.