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 # maybe should only load one table at a time?
1106 fk_methods_init() unless exists($fk_method_cache{$table});
1108 if ( exists($fk_method_cache{$table}) and
1109 exists($fk_method_cache{$table}{$field}) ) {
1110 return $fk_method_cache{$table}{$field};
1117 sub fk_methods_init {
1118 warn "[fk_methods_init]\n" if $DEBUG;
1119 foreach my $table ( dbdef->tables ) {
1120 $fk_method_cache{$table} = fk_methods($table);
1129 # foreign keys we reference in other tables
1130 foreach my $fk (dbdef->table($table)->foreign_keys) {
1133 if ( scalar( @{$fk->columns} ) == 1 ) {
1134 if ( ! defined($fk->references)
1135 || ! @{$fk->references}
1136 || $fk->columns->[0] eq $fk->references->[0]
1138 $method = $fk->table;
1140 #some sort of hint in the table.pm or schema for methods not named
1141 # after their foreign table (well, not a whole lot different than
1142 # just providing a small subroutine...)
1146 $hash{$method} = { #fk_info
1147 'method' => 'qsearchs',
1148 'column' => $fk->columns->[0],
1149 #'references' => $fk->references->[0],
1157 # foreign keys referenced in other tables to us
1158 # (alas. why we're cached. still, might this loop better be done once at
1159 # schema load time insetad of every time we AUTOLOAD a method on a new
1161 if (! defined $fk_table_cache) {
1162 foreach my $f_table ( dbdef->tables ) {
1163 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1164 push @{$fk_table_cache->{$fk->table}},[$f_table,$fk];
1168 foreach my $fks (@{$fk_table_cache->{$table}}) {
1169 my ($f_table,$fk) = @$fks;
1171 if ( scalar( @{$fk->columns} ) == 1 ) {
1172 if ( ! defined($fk->references)
1173 || ! @{$fk->references}
1174 || $fk->columns->[0] eq $fk->references->[0]
1178 #some sort of hint in the table.pm or schema for methods not named
1179 # after their foreign table (well, not a whole lot different than
1180 # just providing a small subroutine...)
1184 $hash{$method} = { #fk_info
1185 'method' => 'qsearch',
1186 'column' => $fk->columns->[0], #references||column
1187 #'references' => $fk->column->[0],
1199 Returns a list of the column/value pairs, usually for assigning to a new hash.
1201 To make a distinct duplicate of an FS::Record object, you can do:
1203 $new = new FS::Record ( $old->table, { $old->hash } );
1209 confess $self. ' -> hash: Hash attribute is undefined'
1210 unless defined($self->{'Hash'});
1211 %{ $self->{'Hash'} };
1216 Returns a reference to the column/value hash. This may be deprecated in the
1217 future; if there's a reason you can't just use the autoloaded or get/set
1231 +{ ( map { $_=>$self->$_ } $self->fields ),
1236 my( $class, %opt ) = @_;
1237 my $table = $class->table;
1238 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1239 my $error = $self->insert;
1240 return +{ 'error' => $error } if $error;
1241 my $pkey = $self->pkey;
1242 return +{ 'error' => '',
1243 'primary_key' => $pkey,
1244 $pkey => $self->$pkey,
1250 Returns true if any of this object's values have been modified with set (or via
1251 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1258 $self->{'modified'};
1261 =item select_for_update
1263 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1268 sub select_for_update {
1270 my $primary_key = $self->primary_key;
1273 'table' => $self->table,
1274 'hashref' => { $primary_key => $self->$primary_key() },
1275 'extra_sql' => 'FOR UPDATE',
1281 Locks this table with a database-driver specific lock method. This is used
1282 as a mutex in order to do a duplicate search.
1284 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1286 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1288 Errors are fatal; no useful return value.
1290 Note: To use this method for new tables other than svc_acct and svc_phone,
1291 edit freeside-upgrade and add those tables to the duplicate_lock list.
1297 my $table = $self->table;
1299 warn "$me locking $table table\n" if $DEBUG;
1301 if ( driver_name =~ /^Pg/i ) {
1303 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1306 } elsif ( driver_name =~ /^mysql/i ) {
1308 dbh->do("SELECT * FROM duplicate_lock
1309 WHERE lockname = '$table'
1311 ) or die dbh->errstr;
1315 die "unknown database ". driver_name. "; don't know how to lock table";
1319 warn "$me acquired $table table lock\n" if $DEBUG;
1325 Inserts this record to the database. If there is an error, returns the error,
1326 otherwise returns false.
1334 warn "$self -> insert" if $DEBUG;
1336 my $error = $self->check;
1337 return $error if $error;
1339 #single-field non-null unique keys are given a value if empty
1340 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1341 foreach ( $self->dbdef_table->unique_singles) {
1342 next if $self->getfield($_);
1343 next if $self->dbdef_table->column($_)->null eq 'NULL';
1347 #and also the primary key, if the database isn't going to
1348 my $primary_key = $self->dbdef_table->primary_key;
1350 if ( $primary_key ) {
1351 my $col = $self->dbdef_table->column($primary_key);
1354 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1355 || ( driver_name eq 'Pg'
1356 && defined($col->default)
1357 && $col->quoted_default =~ /^nextval\(/i
1359 || ( driver_name eq 'mysql'
1360 && defined($col->local)
1361 && $col->local =~ /AUTO_INCREMENT/i
1363 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1366 my $table = $self->table;
1368 # Encrypt before the database
1369 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1372 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1373 next if $field eq 'payinfo'
1374 && ($self->isa('FS::payinfo_transaction_Mixin')
1375 || $self->isa('FS::payinfo_Mixin') )
1377 && !grep { $self->payby eq $_ } @encrypt_payby;
1378 $saved->{$field} = $self->getfield($field);
1379 $self->setfield($field, $self->encrypt($self->getfield($field)));
1383 #false laziness w/delete
1385 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1389 my $statement = "INSERT INTO $table ";
1390 my @bind_values = ();
1392 if ( ! @real_fields ) {
1394 $statement .= 'DEFAULT VALUES';
1398 if ( $use_placeholders ) {
1400 @bind_values = map $self->getfield($_), @real_fields;
1404 join( ', ', @real_fields ).
1406 join( ', ', map '?', @real_fields ). # @bind_values ).
1412 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1416 join( ', ', @real_fields ).
1418 join( ', ', @values ).
1426 warn "[debug]$me $statement\n" if $DEBUG > 1;
1427 my $sth = dbh->prepare($statement) or return dbh->errstr;
1429 local $SIG{HUP} = 'IGNORE';
1430 local $SIG{INT} = 'IGNORE';
1431 local $SIG{QUIT} = 'IGNORE';
1432 local $SIG{TERM} = 'IGNORE';
1433 local $SIG{TSTP} = 'IGNORE';
1434 local $SIG{PIPE} = 'IGNORE';
1436 $sth->execute(@bind_values) or return $sth->errstr;
1438 # get inserted id from the database, if applicable & needed
1439 if ( $db_seq && ! $self->getfield($primary_key) ) {
1440 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1444 if ( driver_name eq 'Pg' ) {
1446 #my $oid = $sth->{'pg_oid_status'};
1447 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1449 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1450 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1451 dbh->rollback if $FS::UID::AutoCommit;
1452 return "can't parse $table.$primary_key default value".
1453 " for sequence name: $default";
1457 my $i_sql = "SELECT currval('$sequence')";
1458 my $i_sth = dbh->prepare($i_sql) or do {
1459 dbh->rollback if $FS::UID::AutoCommit;
1462 $i_sth->execute() or do { #$i_sth->execute($oid)
1463 dbh->rollback if $FS::UID::AutoCommit;
1464 return $i_sth->errstr;
1466 $insertid = $i_sth->fetchrow_arrayref->[0];
1468 } elsif ( driver_name eq 'mysql' ) {
1470 $insertid = dbh->{'mysql_insertid'};
1471 # work around mysql_insertid being null some of the time, ala RT :/
1472 unless ( $insertid ) {
1473 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1474 "using SELECT LAST_INSERT_ID();";
1475 my $i_sql = "SELECT LAST_INSERT_ID()";
1476 my $i_sth = dbh->prepare($i_sql) or do {
1477 dbh->rollback if $FS::UID::AutoCommit;
1480 $i_sth->execute or do {
1481 dbh->rollback if $FS::UID::AutoCommit;
1482 return $i_sth->errstr;
1484 $insertid = $i_sth->fetchrow_arrayref->[0];
1489 dbh->rollback if $FS::UID::AutoCommit;
1490 return "don't know how to retreive inserted ids from ". driver_name.
1491 ", try using counterfiles (maybe run dbdef-create?)";
1495 $self->setfield($primary_key, $insertid);
1500 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1501 my $h_statement = $self->_h_statement('insert');
1502 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1503 $h_sth = dbh->prepare($h_statement) or do {
1504 dbh->rollback if $FS::UID::AutoCommit;
1510 $h_sth->execute or return $h_sth->errstr if $h_sth;
1512 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1514 # Now that it has been saved, reset the encrypted fields so that $new
1515 # can still be used.
1516 foreach my $field (keys %{$saved}) {
1517 $self->setfield($field, $saved->{$field});
1525 Depriciated (use insert instead).
1530 cluck "warning: FS::Record::add deprecated!";
1531 insert @_; #call method in this scope
1536 Delete this record from the database. If there is an error, returns the error,
1537 otherwise returns false.
1544 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1546 $self->getfield($_) eq ''
1547 #? "( $_ IS NULL OR $_ = \"\" )"
1548 ? ( driver_name eq 'Pg'
1550 : "( $_ IS NULL OR $_ = \"\" )"
1552 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1553 } ( $self->dbdef_table->primary_key )
1554 ? ( $self->dbdef_table->primary_key)
1555 : real_fields($self->table)
1557 warn "[debug]$me $statement\n" if $DEBUG > 1;
1558 my $sth = dbh->prepare($statement) or return dbh->errstr;
1561 if ( defined dbdef->table('h_'. $self->table) ) {
1562 my $h_statement = $self->_h_statement('delete');
1563 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1564 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1569 my $primary_key = $self->dbdef_table->primary_key;
1571 local $SIG{HUP} = 'IGNORE';
1572 local $SIG{INT} = 'IGNORE';
1573 local $SIG{QUIT} = 'IGNORE';
1574 local $SIG{TERM} = 'IGNORE';
1575 local $SIG{TSTP} = 'IGNORE';
1576 local $SIG{PIPE} = 'IGNORE';
1578 my $rc = $sth->execute or return $sth->errstr;
1579 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1580 $h_sth->execute or return $h_sth->errstr if $h_sth;
1582 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1584 #no need to needlessly destoy the data either (causes problems actually)
1585 #undef $self; #no need to keep object!
1592 Depriciated (use delete instead).
1597 cluck "warning: FS::Record::del deprecated!";
1598 &delete(@_); #call method in this scope
1601 =item replace OLD_RECORD
1603 Replace the OLD_RECORD with this one in the database. If there is an error,
1604 returns the error, otherwise returns false.
1609 my ($new, $old) = (shift, shift);
1611 $old = $new->replace_old unless defined($old);
1613 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1615 if ( $new->can('replace_check') ) {
1616 my $error = $new->replace_check($old);
1617 return $error if $error;
1620 return "Records not in same table!" unless $new->table eq $old->table;
1622 my $primary_key = $old->dbdef_table->primary_key;
1623 return "Can't change primary key $primary_key ".
1624 'from '. $old->getfield($primary_key).
1625 ' to ' . $new->getfield($primary_key)
1627 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1629 my $error = $new->check;
1630 return $error if $error;
1632 # Encrypt for replace
1634 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1637 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1638 next if $field eq 'payinfo'
1639 && ($new->isa('FS::payinfo_transaction_Mixin')
1640 || $new->isa('FS::payinfo_Mixin') )
1642 && !grep { $new->payby eq $_ } @encrypt_payby;
1643 $saved->{$field} = $new->getfield($field);
1644 $new->setfield($field, $new->encrypt($new->getfield($field)));
1648 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1649 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1650 ? ($_, $new->getfield($_)) : () } $old->fields;
1652 unless (keys(%diff) || $no_update_diff ) {
1653 carp "[warning]$me ". ref($new)."->replace ".
1654 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1655 ": records identical"
1656 unless $nowarn_identical;
1660 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1662 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1663 } real_fields($old->table)
1668 if ( $old->getfield($_) eq '' ) {
1670 #false laziness w/qsearch
1671 if ( driver_name eq 'Pg' ) {
1672 my $type = $old->dbdef_table->column($_)->type;
1673 if ( $type =~ /(int|(big)?serial)/i ) {
1676 qq-( $_ IS NULL OR $_ = '' )-;
1679 qq-( $_ IS NULL OR $_ = "" )-;
1683 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1686 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1689 warn "[debug]$me $statement\n" if $DEBUG > 1;
1690 my $sth = dbh->prepare($statement) or return dbh->errstr;
1693 if ( defined dbdef->table('h_'. $old->table) ) {
1694 my $h_old_statement = $old->_h_statement('replace_old');
1695 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1696 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1702 if ( defined dbdef->table('h_'. $new->table) ) {
1703 my $h_new_statement = $new->_h_statement('replace_new');
1704 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1705 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1710 local $SIG{HUP} = 'IGNORE';
1711 local $SIG{INT} = 'IGNORE';
1712 local $SIG{QUIT} = 'IGNORE';
1713 local $SIG{TERM} = 'IGNORE';
1714 local $SIG{TSTP} = 'IGNORE';
1715 local $SIG{PIPE} = 'IGNORE';
1717 my $rc = $sth->execute or return $sth->errstr;
1718 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1719 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1720 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1722 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1724 # Now that it has been saved, reset the encrypted fields so that $new
1725 # can still be used.
1726 foreach my $field (keys %{$saved}) {
1727 $new->setfield($field, $saved->{$field});
1735 my( $self ) = shift;
1736 warn "[$me] replace called with no arguments; autoloading old record\n"
1739 my $primary_key = $self->dbdef_table->primary_key;
1740 if ( $primary_key ) {
1741 $self->by_key( $self->$primary_key() ) #this is what's returned
1742 or croak "can't find ". $self->table. ".$primary_key ".
1743 $self->$primary_key();
1745 croak $self->table. " has no primary key; pass old record as argument";
1752 Depriciated (use replace instead).
1757 cluck "warning: FS::Record::rep deprecated!";
1758 replace @_; #call method in this scope
1763 Checks custom fields. Subclasses should still provide a check method to validate
1764 non-custom fields, etc., and call this method via $self->SUPER::check.
1770 foreach my $field ($self->virtual_fields) {
1771 my $error = $self->ut_textn($field);
1772 return $error if $error;
1777 =item virtual_fields [ TABLE ]
1779 Returns a list of virtual fields defined for the table. This should not
1780 be exported, and should only be called as an instance or class method.
1784 sub virtual_fields {
1787 $table = $self->table or confess "virtual_fields called on non-table";
1789 confess "Unknown table $table" unless dbdef->table($table);
1791 return () unless dbdef->table('part_virtual_field');
1793 unless ( $virtual_fields_cache{$table} ) {
1794 my $concat = [ "'cf_'", "name" ];
1795 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1796 "WHERE dbtable = '$table'";
1798 my $result = $dbh->selectcol_arrayref($query);
1799 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1801 $virtual_fields_cache{$table} = $result;
1804 @{$virtual_fields_cache{$table}};
1808 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1810 Processes a batch import as a queued JSRPC job
1812 JOB is an FS::queue entry.
1814 OPTIONS_HASHREF can have the following keys:
1820 Table name (required).
1824 Arrayref of field names for static fields. They will be given values from the
1825 PARAMS hashref and passed as a "params" hashref to batch_import.
1829 Formats hashref. Keys are field names, values are listrefs that define the
1832 Each listref value can be a column name or a code reference. Coderefs are run
1833 with the row object, data and a FS::Conf object as the three parameters.
1834 For example, this coderef does the same thing as using the "columnname" string:
1837 my( $record, $data, $conf ) = @_;
1838 $record->columnname( $data );
1841 Coderefs are run after all "column name" fields are assigned.
1845 Optional format hashref of types. Keys are field names, values are "csv",
1846 "xls" or "fixedlength". Overrides automatic determination of file type
1849 =item format_headers
1851 Optional format hashref of header lines. Keys are field names, values are 0
1852 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1855 =item format_sep_chars
1857 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1858 CSV separation character.
1860 =item format_fixedlenth_formats
1862 Optional format hashref of fixed length format defintiions. Keys are field
1863 names, values Parse::FixedLength listrefs of field definitions.
1867 Set true to default to CSV file type if the filename does not contain a
1868 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1873 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1874 POSTed data. It must contain the field "uploaded files", generated by
1875 /elements/file-upload.html and containing the list of uploaded files.
1876 Currently only supports a single file named "file".
1881 sub process_batch_import {
1882 my($job, $opt, $param) = @_;
1884 my $table = $opt->{table};
1885 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1886 my %formats = %{ $opt->{formats} };
1888 warn Dumper($param) if $DEBUG;
1890 my $files = $param->{'uploaded_files'}
1891 or die "No files provided.\n";
1893 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1895 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1896 my $file = $dir. $files{'file'};
1901 formats => \%formats,
1902 format_types => $opt->{format_types},
1903 format_headers => $opt->{format_headers},
1904 format_sep_chars => $opt->{format_sep_chars},
1905 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1906 format_xml_formats => $opt->{format_xml_formats},
1907 format_asn_formats => $opt->{format_asn_formats},
1908 format_row_callbacks => $opt->{format_row_callbacks},
1909 format_hash_callbacks => $opt->{format_hash_callbacks},
1914 format => $param->{format},
1915 params => { map { $_ => $param->{$_} } @pass_params },
1917 default_csv => $opt->{default_csv},
1918 preinsert_callback => $opt->{preinsert_callback},
1919 postinsert_callback => $opt->{postinsert_callback},
1920 insert_args_callback => $opt->{insert_args_callback},
1923 if ( $opt->{'batch_namecol'} ) {
1924 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1925 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1928 my $error = FS::Record::batch_import( \%iopt );
1932 die "$error\n" if $error;
1935 =item batch_import PARAM_HASHREF
1937 Class method for batch imports. Available params:
1943 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1949 =item format_headers
1951 =item format_sep_chars
1953 =item format_fixedlength_formats
1955 =item format_row_callbacks
1957 =item format_hash_callbacks - After parsing, before object creation
1959 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1961 =item preinsert_callback
1963 =item postinsert_callback
1969 FS::queue object, will be updated with progress
1975 csv, xls, fixedlength, xml
1987 warn "$me batch_import call with params: \n". Dumper($param)
1990 my $table = $param->{table};
1992 my $job = $param->{job};
1993 my $file = $param->{file};
1994 my $params = $param->{params} || {};
1996 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1997 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1999 my( $type, $header, $sep_char,
2000 $fixedlength_format, $xml_format, $asn_format,
2001 $parser_opt, $row_callback, $hash_callback, @fields );
2003 my $postinsert_callback = '';
2004 $postinsert_callback = $param->{'postinsert_callback'}
2005 if $param->{'postinsert_callback'};
2006 my $preinsert_callback = '';
2007 $preinsert_callback = $param->{'preinsert_callback'}
2008 if $param->{'preinsert_callback'};
2009 my $insert_args_callback = '';
2010 $insert_args_callback = $param->{'insert_args_callback'}
2011 if $param->{'insert_args_callback'};
2013 if ( $param->{'format'} ) {
2015 my $format = $param->{'format'};
2016 my $formats = $param->{formats};
2017 die "unknown format $format" unless exists $formats->{ $format };
2019 $type = $param->{'format_types'}
2020 ? $param->{'format_types'}{ $format }
2021 : $param->{type} || 'csv';
2024 $header = $param->{'format_headers'}
2025 ? $param->{'format_headers'}{ $param->{'format'} }
2028 $sep_char = $param->{'format_sep_chars'}
2029 ? $param->{'format_sep_chars'}{ $param->{'format'} }
2032 $fixedlength_format =
2033 $param->{'format_fixedlength_formats'}
2034 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
2038 $param->{'format_parser_opts'}
2039 ? $param->{'format_parser_opts'}{ $param->{'format'} }
2043 $param->{'format_xml_formats'}
2044 ? $param->{'format_xml_formats'}{ $param->{'format'} }
2048 $param->{'format_asn_formats'}
2049 ? $param->{'format_asn_formats'}{ $param->{'format'} }
2053 $param->{'format_row_callbacks'}
2054 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
2058 $param->{'format_hash_callbacks'}
2059 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
2062 @fields = @{ $formats->{ $format } };
2064 } elsif ( $param->{'fields'} ) {
2066 $type = ''; #infer from filename
2069 $fixedlength_format = '';
2071 $hash_callback = '';
2072 @fields = @{ $param->{'fields'} };
2075 die "neither format nor fields specified";
2078 #my $file = $param->{file};
2081 if ( $file =~ /\.(\w+)$/i ) {
2085 warn "can't parse file type from filename $file; defaulting to CSV";
2089 if $param->{'default_csv'} && $type ne 'xls';
2097 my $asn_header_buffer;
2098 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2100 if ( $type eq 'csv' ) {
2102 $parser_opt->{'binary'} = 1;
2103 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2104 $parser = Text::CSV_XS->new($parser_opt);
2106 } elsif ( $type eq 'fixedlength' ) {
2108 eval "use Parse::FixedLength;";
2110 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2113 die "Unknown file type $type\n";
2116 @buffer = split(/\r?\n/, slurp($file) );
2117 splice(@buffer, 0, ($header || 0) );
2118 $count = scalar(@buffer);
2120 } elsif ( $type eq 'xls' ) {
2122 eval "use Spreadsheet::ParseExcel;";
2125 eval "use DateTime::Format::Excel;";
2126 #for now, just let the error be thrown if it is used, since only CDR
2127 # formats bill_west and troop use it, not other excel-parsing things
2130 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2132 $parser = $excel->{Worksheet}[0]; #first sheet
2134 $count = $parser->{MaxRow} || $parser->{MinRow};
2137 $row = $header || 0;
2139 } elsif ( $type eq 'xml' ) {
2142 eval "use XML::Simple;";
2144 my $xmlrow = $xml_format->{'xmlrow'};
2145 $parser = $xml_format->{'xmlkeys'};
2146 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2147 my $data = XML::Simple::XMLin(
2149 'SuppressEmpty' => '', #sets empty values to ''
2153 $rows = $rows->{$_} foreach @$xmlrow;
2154 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2155 $count = @buffer = @$rows;
2157 } elsif ( $type eq 'asn.1' ) {
2159 eval "use Convert::ASN1";
2162 my $asn = Convert::ASN1->new;
2163 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2165 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2167 my $data = slurp($file);
2168 my $asn_output = $parser->decode( $data )
2169 or return "No ". $asn_format->{'macro'}. " found\n";
2171 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2173 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2174 $count = @buffer = @$rows;
2177 die "Unknown file type $type\n";
2182 local $SIG{HUP} = 'IGNORE';
2183 local $SIG{INT} = 'IGNORE';
2184 local $SIG{QUIT} = 'IGNORE';
2185 local $SIG{TERM} = 'IGNORE';
2186 local $SIG{TSTP} = 'IGNORE';
2187 local $SIG{PIPE} = 'IGNORE';
2189 my $oldAutoCommit = $FS::UID::AutoCommit;
2190 local $FS::UID::AutoCommit = 0;
2193 #my $params = $param->{params} || {};
2194 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2195 my $batch_col = $param->{'batch_keycol'};
2197 my $batch_class = 'FS::'. $param->{'batch_table'};
2198 my $batch = $batch_class->new({
2199 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2201 my $error = $batch->insert;
2203 $dbh->rollback if $oldAutoCommit;
2204 return "can't insert batch record: $error";
2206 #primary key via dbdef? (so the column names don't have to match)
2207 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2209 $params->{ $batch_col } = $batch_value;
2212 #my $job = $param->{job};
2215 my $unique_skip = 0; #lines skipped because they're already in the system
2216 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2220 my %hash = %$params;
2221 if ( $type eq 'csv' ) {
2223 last unless scalar(@buffer);
2224 $line = shift(@buffer);
2226 next if $line =~ /^\s*$/; #skip empty lines
2228 $line = &{$row_callback}($line) if $row_callback;
2230 next if $line =~ /^\s*$/; #skip empty lines
2232 $parser->parse($line) or do {
2233 $dbh->rollback if $oldAutoCommit;
2234 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2236 @columns = $parser->fields();
2238 } elsif ( $type eq 'fixedlength' ) {
2240 last unless scalar(@buffer);
2241 $line = shift(@buffer);
2243 @columns = $parser->parse($line);
2245 } elsif ( $type eq 'xls' ) {
2247 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2248 || ! $parser->{Cells}[$row];
2250 my @row = @{ $parser->{Cells}[$row] };
2251 @columns = map $_->{Val}, @row;
2254 #warn $z++. ": $_\n" for @columns;
2256 } elsif ( $type eq 'xml' ) {
2258 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2259 last unless scalar(@buffer);
2260 my $row = shift @buffer;
2261 @columns = @{ $row }{ @$parser };
2263 } elsif ( $type eq 'asn.1' ) {
2265 last unless scalar(@buffer);
2266 my $row = shift @buffer;
2267 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2268 if $asn_format->{row_callback};
2269 foreach my $key ( keys %{ $asn_format->{map} } ) {
2270 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2274 die "Unknown file type $type\n";
2279 foreach my $field ( @fields ) {
2281 my $value = shift @columns;
2283 if ( ref($field) eq 'CODE' ) {
2284 #&{$field}(\%hash, $value);
2285 push @later, $field, $value;
2287 #??? $hash{$field} = $value if length($value);
2288 $hash{$field} = $value if defined($value) && length($value);
2293 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2294 && length($1) == $custnum_length ) {
2295 $hash{custnum} = $2;
2298 %hash = &{$hash_callback}(%hash) if $hash_callback;
2300 #my $table = $param->{table};
2301 my $class = "FS::$table";
2303 my $record = $class->new( \%hash );
2306 while ( scalar(@later) ) {
2307 my $sub = shift @later;
2308 my $data = shift @later;
2310 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2313 $dbh->rollback if $oldAutoCommit;
2314 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2316 last if exists( $param->{skiprow} );
2318 $unique_skip++ if $param->{unique_skip}; #line is already in the system
2319 next if exists( $param->{skiprow} );
2321 if ( $preinsert_callback ) {
2322 my $error = &{$preinsert_callback}($record, $param);
2324 $dbh->rollback if $oldAutoCommit;
2325 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2328 next if exists $param->{skiprow} && $param->{skiprow};
2331 my @insert_args = ();
2332 if ( $insert_args_callback ) {
2333 @insert_args = &{$insert_args_callback}($record, $param);
2336 my $error = $record->insert(@insert_args);
2339 $dbh->rollback if $oldAutoCommit;
2340 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2346 if ( $postinsert_callback ) {
2347 my $error = &{$postinsert_callback}($record, $param);
2349 $dbh->rollback if $oldAutoCommit;
2350 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2355 if ( $job && time - $min_sec > $last ) { #progress bar
2356 $job->update_statustext( int(100 * $imported / $count) );
2362 unless ( $imported || $param->{empty_ok} ) {
2363 $dbh->rollback if $oldAutoCommit;
2364 # freeside-cdr-conexiant-import is sensitive to the text of this message
2365 return $unique_skip ? "All records in file were previously imported" : "Empty file!";
2368 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2375 my( $self, $action, $time ) = @_;
2379 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2382 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2383 real_fields($self->table);
2386 # If we're encrypting then don't store the payinfo in the history
2387 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2388 @fields = grep { $_ ne 'payinfo' } @fields;
2391 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2393 "INSERT INTO h_". $self->table. " ( ".
2394 join(', ', qw(history_date history_usernum history_action), @fields ).
2397 $FS::CurrentUser::CurrentUser->usernum,
2398 dbh->quote($action),
2407 B<Warning>: External use is B<deprecated>.
2409 Replaces COLUMN in record with a unique number, using counters in the
2410 filesystem. Used by the B<insert> method on single-field unique columns
2411 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2412 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2414 Returns the new value.
2419 my($self,$field) = @_;
2420 my($table)=$self->table;
2422 croak "Unique called on field $field, but it is ",
2423 $self->getfield($field),
2425 if $self->getfield($field);
2427 #warn "table $table is tainted" if is_tainted($table);
2428 #warn "field $field is tainted" if is_tainted($field);
2430 my($counter) = new File::CounterFile "$table.$field",0;
2432 my $index = $counter->inc;
2433 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2435 $index =~ /^(\d*)$/;
2438 $self->setfield($field,$index);
2442 =item ut_float COLUMN
2444 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2445 null. If there is an error, returns the error, otherwise returns false.
2450 my($self,$field)=@_ ;
2451 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2452 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2453 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2454 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2455 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2456 $self->setfield($field,$1);
2459 =item ut_floatn COLUMN
2461 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2462 null. If there is an error, returns the error, otherwise returns false.
2466 #false laziness w/ut_ipn
2468 my( $self, $field ) = @_;
2469 if ( $self->getfield($field) =~ /^()$/ ) {
2470 $self->setfield($field,'');
2473 $self->ut_float($field);
2477 =item ut_sfloat COLUMN
2479 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2480 May not be null. If there is an error, returns the error, otherwise returns
2486 my($self,$field)=@_ ;
2487 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2488 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2489 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2490 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2491 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2492 $self->setfield($field,$1);
2495 =item ut_sfloatn COLUMN
2497 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2498 null. If there is an error, returns the error, otherwise returns false.
2503 my( $self, $field ) = @_;
2504 if ( $self->getfield($field) =~ /^()$/ ) {
2505 $self->setfield($field,'');
2508 $self->ut_sfloat($field);
2512 =item ut_snumber COLUMN
2514 Check/untaint signed numeric data (whole numbers). If there is an error,
2515 returns the error, otherwise returns false.
2520 my($self, $field) = @_;
2521 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2522 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2523 $self->setfield($field, "$1$2");
2527 =item ut_snumbern COLUMN
2529 Check/untaint signed numeric data (whole numbers). If there is an error,
2530 returns the error, otherwise returns false.
2535 my($self, $field) = @_;
2536 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2537 or return "Illegal (numeric) $field: ". $self->getfield($field);
2539 return "Illegal (numeric) $field: ". $self->getfield($field)
2542 $self->setfield($field, "$1$2");
2546 =item ut_number COLUMN
2548 Check/untaint simple numeric data (whole numbers). May not be null. If there
2549 is an error, returns the error, otherwise returns false.
2554 my($self,$field)=@_;
2555 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2556 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2557 $self->setfield($field,$1);
2561 =item ut_numbern COLUMN
2563 Check/untaint simple numeric data (whole numbers). May be null. If there is
2564 an error, returns the error, otherwise returns false.
2569 my($self,$field)=@_;
2570 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2571 or return "Illegal (numeric) $field: ". $self->getfield($field);
2572 $self->setfield($field,$1);
2576 =item ut_decimal COLUMN[, DIGITS]
2578 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2579 error, returns the error, otherwise returns false.
2581 =item ut_decimaln COLUMN[, DIGITS]
2583 Check/untaint decimal numbers. May be null. If there is an error, returns
2584 the error, otherwise returns false.
2589 my($self, $field, $digits) = @_;
2591 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2592 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2593 $self->setfield($field, $1);
2598 my($self, $field, $digits) = @_;
2599 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2600 or return "Illegal (decimal) $field: ".$self->getfield($field);
2601 $self->setfield($field, $1);
2605 =item ut_money COLUMN
2607 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2608 is an error, returns the error, otherwise returns false.
2613 my($self,$field)=@_;
2615 if ( $self->getfield($field) eq '' ) {
2616 $self->setfield($field, 0);
2617 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2618 #handle one decimal place without barfing out
2619 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2620 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2621 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2623 return "Illegal (money) $field: ". $self->getfield($field);
2629 =item ut_moneyn COLUMN
2631 Check/untaint monetary numbers. May be negative. If there
2632 is an error, returns the error, otherwise returns false.
2637 my($self,$field)=@_;
2638 if ($self->getfield($field) eq '') {
2639 $self->setfield($field, '');
2642 $self->ut_money($field);
2645 =item ut_currencyn COLUMN
2647 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2648 is an error, returns the error, otherwise returns false.
2653 my($self, $field) = @_;
2654 if ($self->getfield($field) eq '') { #can be null
2655 $self->setfield($field, '');
2658 $self->ut_currency($field);
2661 =item ut_currency COLUMN
2663 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2664 there is an error, returns the error, otherwise returns false.
2669 my($self, $field) = @_;
2670 my $value = uc( $self->getfield($field) );
2671 if ( code2currency($value) ) {
2672 $self->setfield($value);
2674 return "Unknown currency $value";
2680 =item ut_text COLUMN
2682 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2683 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < > ~
2684 May not be null. If there is an error, returns the error, otherwise returns
2690 my($self,$field)=@_;
2691 #warn "msgcat ". \&msgcat. "\n";
2692 #warn "notexist ". \¬exist. "\n";
2693 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2694 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2695 # see perldoc perluniprops
2696 $self->getfield($field)
2697 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>\~$money_char]+)$/
2698 or return gettext('illegal_or_empty_text'). " $field: ".
2699 $self->getfield($field);
2700 $self->setfield($field,$1);
2704 =item ut_textn COLUMN
2706 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2707 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2708 May be null. If there is an error, returns the error, otherwise returns false.
2713 my($self,$field)=@_;
2714 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2715 $self->ut_text($field);
2718 =item ut_alpha COLUMN
2720 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2721 an error, returns the error, otherwise returns false.
2726 my($self,$field)=@_;
2727 $self->getfield($field) =~ /^(\w+)$/
2728 or return "Illegal or empty (alphanumeric) $field: ".
2729 $self->getfield($field);
2730 $self->setfield($field,$1);
2734 =item ut_alphan COLUMN
2736 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2737 error, returns the error, otherwise returns false.
2742 my($self,$field)=@_;
2743 $self->getfield($field) =~ /^(\w*)$/
2744 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2745 $self->setfield($field,$1);
2749 =item ut_alphasn COLUMN
2751 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2752 an error, returns the error, otherwise returns false.
2757 my($self,$field)=@_;
2758 $self->getfield($field) =~ /^([\w ]*)$/
2759 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2760 $self->setfield($field,$1);
2765 =item ut_alpha_lower COLUMN
2767 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2768 there is an error, returns the error, otherwise returns false.
2772 sub ut_alpha_lower {
2773 my($self,$field)=@_;
2774 $self->getfield($field) =~ /[[:upper:]]/
2775 and return "Uppercase characters are not permitted in $field";
2776 $self->ut_alpha($field);
2779 =item ut_phonen COLUMN [ COUNTRY ]
2781 Check/untaint phone numbers. May be null. If there is an error, returns
2782 the error, otherwise returns false.
2784 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2785 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2790 my( $self, $field, $country ) = @_;
2791 return $self->ut_alphan($field) unless defined $country;
2792 my $phonen = $self->getfield($field);
2793 if ( $phonen eq '' ) {
2794 $self->setfield($field,'');
2795 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2797 $phonen = $conf->config('cust_main-default_areacode').$phonen
2798 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2799 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2800 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2801 $phonen = "$1-$2-$3";
2802 $phonen .= " x$4" if $4;
2803 $self->setfield($field,$phonen);
2805 warn "warning: don't know how to check phone numbers for country $country";
2806 return $self->ut_textn($field);
2813 Check/untaint hexadecimal values.
2818 my($self, $field) = @_;
2819 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2820 or return "Illegal (hex) $field: ". $self->getfield($field);
2821 $self->setfield($field, uc($1));
2825 =item ut_hexn COLUMN
2827 Check/untaint hexadecimal values. May be null.
2832 my($self, $field) = @_;
2833 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2834 or return "Illegal (hex) $field: ". $self->getfield($field);
2835 $self->setfield($field, uc($1));
2839 =item ut_mac_addr COLUMN
2841 Check/untaint mac addresses. May be null.
2846 my($self, $field) = @_;
2848 my $mac = $self->get($field);
2851 $self->set($field, $mac);
2853 my $e = $self->ut_hex($field);
2856 return "Illegal (mac address) $field: ". $self->getfield($field)
2857 unless length($self->getfield($field)) == 12;
2863 =item ut_mac_addrn COLUMN
2865 Check/untaint mac addresses. May be null.
2870 my($self, $field) = @_;
2871 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2876 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2882 my( $self, $field ) = @_;
2883 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2884 return "Illegal (IP address) $field: ".$self->getfield($field)
2885 unless $self->getfield($field) =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/;
2886 $self->ut_ip46($field);
2891 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2892 to 127.0.0.1. May be null.
2897 my( $self, $field ) = @_;
2898 if ( $self->getfield($field) =~ /^()$/ ) {
2899 $self->setfield($field,'');
2902 $self->ut_ip($field);
2906 =item ut_ip46 COLUMN
2908 Check/untaint IPv4 or IPv6 address.
2913 my( $self, $field ) = @_;
2914 my $ip_addr = $self->getfield( $field );
2916 # strip user-entered leading 0's from IPv4 addresses
2917 # Parsers like NetAddr::IP interpret them as octal instead of decimal
2918 $ip_addr = join( '.', (
2920 split( /\./, $ip_addr )
2922 ) if $ip_addr =~ /\./ && $ip_addr =~ /[\.^]0/;
2924 my $ip = NetAddr::IP->new( $ip_addr )
2925 or return "Illegal (IP address) $field: ".$self->getfield($field);
2926 $self->setfield($field, lc($ip->addr));
2932 Check/untaint IPv6 or IPv6 address. May be null.
2937 my( $self, $field ) = @_;
2938 if ( $self->getfield($field) =~ /^$/ ) {
2939 $self->setfield($field, '');
2942 $self->ut_ip46($field);
2945 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2947 Check/untaint coordinates.
2948 Accepts the following forms:
2958 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2959 The latter form (that is, the MMM are thousands of minutes) is
2960 assumed if the "MMM" is exactly three digits or two digits > 59.
2962 To be safe, just use the DDD.DDDDD form.
2964 If LOWER or UPPER are specified, then the coordinate is checked
2965 for lower and upper bounds, respectively.
2970 my ($self, $field) = (shift, shift);
2973 if ( $field =~ /latitude/ ) {
2974 $lower = $lat_lower;
2976 } elsif ( $field =~ /longitude/ ) {
2978 $upper = $lon_upper;
2981 my $coord = $self->getfield($field);
2982 my $neg = $coord =~ s/^(-)//;
2984 # ignore degree symbol at the end,
2985 # but not otherwise supporting degree/minutes/seconds symbols
2986 $coord =~ s/\N{DEGREE SIGN}\s*$//;
2988 my ($d, $m, $s) = (0, 0, 0);
2991 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2992 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2993 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2995 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2998 return "Invalid (coordinate with minutes > 59) $field: "
2999 . $self->getfield($field);
3002 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
3004 if (defined($lower) and ($coord < $lower)) {
3005 return "Invalid (coordinate < $lower) $field: "
3006 . $self->getfield($field);;
3009 if (defined($upper) and ($coord > $upper)) {
3010 return "Invalid (coordinate > $upper) $field: "
3011 . $self->getfield($field);;
3014 $self->setfield($field, $coord);
3018 return "Invalid (coordinate) $field: " . $self->getfield($field);
3022 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
3024 Same as ut_coord, except optionally null.
3030 my ($self, $field) = (shift, shift);
3032 if ($self->getfield($field) =~ /^\s*$/) {
3035 return $self->ut_coord($field, @_);
3040 =item ut_domain COLUMN
3042 Check/untaint host and domain names. May not be null.
3047 my( $self, $field ) = @_;
3048 #$self->getfield($field) =~/^(\w+\.)*\w+$/
3049 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
3050 or return "Illegal (hostname) $field: ". $self->getfield($field);
3051 $self->setfield($field,$1);
3055 =item ut_domainn COLUMN
3057 Check/untaint host and domain names. May be null.
3062 my( $self, $field ) = @_;
3063 if ( $self->getfield($field) =~ /^()$/ ) {
3064 $self->setfield($field,'');
3067 $self->ut_domain($field);
3071 =item ut_name COLUMN
3073 Check/untaint proper names; allows alphanumerics, spaces and the following
3074 punctuation: , . - '
3081 my( $self, $field ) = @_;
3082 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
3083 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
3088 $self->setfield($field, $name);
3092 =item ut_namen COLUMN
3094 Check/untaint proper names; allows alphanumerics, spaces and the following
3095 punctuation: , . - '
3102 my( $self, $field ) = @_;
3103 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3104 $self->ut_name($field);
3109 Check/untaint zip codes.
3113 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3116 my( $self, $field, $country ) = @_;
3118 if ( $country eq 'US' ) {
3120 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3121 or return gettext('illegal_zip'). " $field for country $country: ".
3122 $self->getfield($field);
3123 $self->setfield($field, $1);
3125 } elsif ( $country eq 'CA' ) {
3127 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3128 or return gettext('illegal_zip'). " $field for country $country: ".
3129 $self->getfield($field);
3130 $self->setfield($field, "$1 $2");
3132 } elsif ( $country eq 'AU' ) {
3134 $self->getfield($field) =~ /^\s*(\d{4})\s*$/
3135 or return gettext('illegal_zip'). " $field for country $country: ".
3136 $self->getfield($field);
3137 $self->setfield($field, $1);
3141 if ( $self->getfield($field) =~ /^\s*$/
3142 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3145 $self->setfield($field,'');
3147 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3148 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3149 $self->setfield($field,$1);
3157 =item ut_country COLUMN
3159 Check/untaint country codes. Country names are changed to codes, if possible -
3160 see L<Locale::Country>.
3165 my( $self, $field ) = @_;
3166 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3167 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3168 && country2code($1) ) {
3169 $self->setfield($field,uc(country2code($1)));
3172 $self->getfield($field) =~ /^(\w\w)$/
3173 or return "Illegal (country) $field: ". $self->getfield($field);
3174 $self->setfield($field,uc($1));
3178 =item ut_anything COLUMN
3180 Untaints arbitrary data. Be careful.
3185 my( $self, $field ) = @_;
3186 $self->getfield($field) =~ /^(.*)$/s
3187 or return "Illegal $field: ". $self->getfield($field);
3188 $self->setfield($field,$1);
3192 =item ut_enum COLUMN CHOICES_ARRAYREF
3194 Check/untaint a column, supplying all possible choices, like the "enum" type.
3199 my( $self, $field, $choices ) = @_;
3200 foreach my $choice ( @$choices ) {
3201 if ( $self->getfield($field) eq $choice ) {
3202 $self->setfield($field, $choice);
3206 return "Illegal (enum) field $field: ". $self->getfield($field);
3209 =item ut_enumn COLUMN CHOICES_ARRAYREF
3211 Like ut_enum, except the null value is also allowed.
3216 my( $self, $field, $choices ) = @_;
3217 $self->getfield($field)
3218 ? $self->ut_enum($field, $choices)
3222 =item ut_flag COLUMN
3224 Check/untaint a column if it contains either an empty string or 'Y'. This
3225 is the standard form for boolean flags in Freeside.
3230 my( $self, $field ) = @_;
3231 my $value = uc($self->getfield($field));
3232 if ( $value eq '' or $value eq 'Y' ) {
3233 $self->setfield($field, $value);
3236 return "Illegal (flag) field $field: $value";
3239 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3241 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3242 on the column first.
3246 sub ut_foreign_key {
3247 my( $self, $field, $table, $foreign ) = @_;
3248 return $self->ut_number($field) if $no_check_foreign;
3249 qsearchs($table, { $foreign => $self->getfield($field) })
3250 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3251 " in $table.$foreign";
3255 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3257 Like ut_foreign_key, except the null value is also allowed.
3261 sub ut_foreign_keyn {
3262 my( $self, $field, $table, $foreign ) = @_;
3263 $self->getfield($field)
3264 ? $self->ut_foreign_key($field, $table, $foreign)
3268 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3270 Checks this column as an agentnum, taking into account the current users's
3271 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3272 right or rights allowing no agentnum.
3276 sub ut_agentnum_acl {
3277 my( $self, $field ) = (shift, shift);
3278 my $null_acl = scalar(@_) ? shift : [];
3279 $null_acl = [ $null_acl ] unless ref($null_acl);
3281 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3282 return "Illegal agentnum: $error" if $error;
3284 my $curuser = $FS::CurrentUser::CurrentUser;
3286 if ( $self->$field() ) {
3288 return 'Access denied to agent '. $self->$field()
3289 unless $curuser->agentnum($self->$field());
3293 return 'Access denied to global'
3294 unless grep $curuser->access_right($_), @$null_acl;
3302 =item trim_whitespace FIELD[, FIELD ... ]
3304 Strip leading and trailing spaces from the value in the named FIELD(s).
3308 sub trim_whitespace {
3310 foreach my $field (@_) {
3311 my $value = $self->get($field);
3314 $self->set($field, $value);
3318 =item fields [ TABLE ]
3320 This is a wrapper for real_fields. Code that called
3321 fields before should probably continue to call fields.
3326 my $something = shift;
3328 if($something->isa('FS::Record')) {
3329 $table = $something->table;
3331 $table = $something;
3332 #$something = "FS::$table";
3334 return (real_fields($table));
3338 =item encrypt($value)
3340 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3342 Returns the encrypted string.
3344 You should generally not have to worry about calling this, as the system handles this for you.
3349 my ($self, $value) = @_;
3350 my $encrypted = $value;
3352 if ($conf_encryption) {
3353 if ($self->is_encrypted($value)) {
3354 # Return the original value if it isn't plaintext.
3355 $encrypted = $value;
3358 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3359 # RSA doesn't like the empty string so let's pack it up
3360 # The database doesn't like the RSA data so uuencode it
3361 my $length = length($value)+1;
3362 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3364 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3371 =item is_encrypted($value)
3373 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3379 my ($self, $value) = @_;
3380 # could be more precise about it, but this will do for now
3381 $value =~ /^M/ && length($value) > 80;
3384 =item decrypt($value)
3386 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3388 You should generally not have to worry about calling this, as the system handles this for you.
3393 my ($self,$value) = @_;
3394 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3395 if ($conf_encryption && $self->is_encrypted($value)) {
3397 if (ref($rsa_decrypt) =~ /::RSA/) {
3398 my $encrypted = unpack ("u*", $value);
3399 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3400 if ($@) {warn "Decryption Failed"};
3409 my $rsa_module = $conf_encryptionmodule || 'Crypt::OpenSSL::RSA';
3411 # Initialize Encryption
3412 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3413 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3416 # Intitalize Decryption
3417 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3418 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3422 =item h_search ACTION
3424 Given an ACTION, either "insert", or "delete", returns the appropriate history
3425 record corresponding to this record, if any.
3430 my( $self, $action ) = @_;
3432 my $table = $self->table;
3435 my $primary_key = dbdef->table($table)->primary_key;
3438 'table' => "h_$table",
3439 'hashref' => { $primary_key => $self->$primary_key(),
3440 'history_action' => $action,
3448 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3449 appropriate history record corresponding to this record, if any.
3454 my($self, $action) = @_;
3455 my $h = $self->h_search($action);
3456 $h ? $h->history_date : '';
3459 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3461 A class or object method. Executes the sql statement represented by SQL and
3462 returns a scalar representing the result: the first column of the first row.
3464 Dies on bogus SQL. Returns an empty string if no row is returned.
3466 Typically used for statments which return a single value such as "SELECT
3467 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3472 my($self, $sql) = (shift, shift);
3473 my $sth = dbh->prepare($sql) or die dbh->errstr;
3475 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3476 my $row = $sth->fetchrow_arrayref or return '';
3477 my $scalar = $row->[0];
3478 defined($scalar) ? $scalar : '';
3481 =item count [ WHERE [, PLACEHOLDER ...] ]
3483 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3484 with optional WHERE. Must be called as method on a class with an
3490 my($self, $where) = (shift, shift);
3491 my $table = $self->table or die 'count called on object of class '.ref($self);
3492 my $sql = "SELECT COUNT(*) FROM $table";
3493 $sql .= " WHERE $where" if $where;
3494 $self->scalar_sql($sql, @_);
3497 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3499 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3500 with optional (but almost always needed) WHERE.
3505 my($self, $where) = (shift, shift);
3506 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3507 my $sql = "SELECT 1 FROM $table";
3508 $sql .= " WHERE $where" if $where;
3510 $self->scalar_sql($sql, @_);
3519 =item real_fields [ TABLE ]
3521 Returns a list of the real columns in the specified table. Called only by
3522 fields() and other subroutines elsewhere in FS::Record.
3529 my($table_obj) = dbdef->table($table);
3530 confess "Unknown table $table" unless $table_obj;
3531 $table_obj->columns;
3534 =item pvf FIELD_NAME
3536 Returns the FS::part_virtual_field object corresponding to a field in the
3537 record (specified by FIELD_NAME).
3542 my ($self, $name) = (shift, shift);
3544 if(grep /^$name$/, $self->virtual_fields) {
3546 my $concat = [ "'cf_'", "name" ];
3547 return qsearchs({ table => 'part_virtual_field',
3548 hashref => { dbtable => $self->table,
3551 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3557 =item _quote VALUE, TABLE, COLUMN
3559 This is an internal function used to construct SQL statements. It returns
3560 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3561 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3566 my($value, $table, $column) = @_;
3567 my $column_obj = dbdef->table($table)->column($column);
3568 my $column_type = $column_obj->type;
3569 my $nullable = $column_obj->null;
3571 utf8::upgrade($value);
3573 warn " $table.$column: $value ($column_type".
3574 ( $nullable ? ' NULL' : ' NOT NULL' ).
3575 ")\n" if $DEBUG > 2;
3577 if ( $value eq '' && $nullable ) {
3579 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3580 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3583 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3584 ! $column_type =~ /(char|binary|text)$/i ) {
3586 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3587 && driver_name eq 'Pg'
3590 dbh->quote($value, { pg_type => PG_BYTEA() });
3598 This is deprecated. Don't use it.
3600 It returns a hash-type list with the fields of this record's table set true.
3605 carp "warning: hfields is deprecated";
3608 foreach (fields($table)) {
3617 "$_: ". $self->getfield($_). "|"
3618 } (fields($self->table)) );
3621 sub DESTROY { return; }
3625 # #use Carp qw(cluck);
3626 # #cluck "DESTROYING $self";
3627 # warn "DESTROYING $self";
3631 # return ! eval { join('',@_), kill 0; 1; };
3634 =item str2time_sql [ DRIVER_NAME ]
3636 Returns a function to convert to unix time based on database type, such as
3637 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3638 the str2time_sql_closing method to return a closing string rather than just
3639 using a closing parenthesis as previously suggested.
3641 You can pass an optional driver name such as "Pg", "mysql" or
3642 $dbh->{Driver}->{Name} to return a function for that database instead of
3643 the current database.
3648 my $driver = shift || driver_name;
3650 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3651 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3653 warn "warning: unknown database type $driver; guessing how to convert ".
3654 "dates to UNIX timestamps";
3655 return 'EXTRACT(EPOCH FROM ';
3659 =item str2time_sql_closing [ DRIVER_NAME ]
3661 Returns the closing suffix of a function to convert to unix time based on
3662 database type, such as ")::integer" for Pg or ")" for mysql.
3664 You can pass an optional driver name such as "Pg", "mysql" or
3665 $dbh->{Driver}->{Name} to return a function for that database instead of
3666 the current database.
3670 sub str2time_sql_closing {
3671 my $driver = shift || driver_name;
3673 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3677 =item regexp_sql [ DRIVER_NAME ]
3679 Returns the operator to do a regular expression comparison based on database
3680 type, such as '~' for Pg or 'REGEXP' for mysql.
3682 You can pass an optional driver name such as "Pg", "mysql" or
3683 $dbh->{Driver}->{Name} to return a function for that database instead of
3684 the current database.
3689 my $driver = shift || driver_name;
3691 return '~' if $driver =~ /^Pg/i;
3692 return 'REGEXP' if $driver =~ /^mysql/i;
3694 die "don't know how to use regular expressions in ". driver_name." databases";
3698 =item not_regexp_sql [ DRIVER_NAME ]
3700 Returns the operator to do a regular expression negation based on database
3701 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3703 You can pass an optional driver name such as "Pg", "mysql" or
3704 $dbh->{Driver}->{Name} to return a function for that database instead of
3705 the current database.
3709 sub not_regexp_sql {
3710 my $driver = shift || driver_name;
3712 return '!~' if $driver =~ /^Pg/i;
3713 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3715 die "don't know how to use regular expressions in ". driver_name." databases";
3719 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3721 Returns the items concatenated based on database type, using "CONCAT()" for
3722 mysql and " || " for Pg and other databases.
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 = ref($_[0]) ? driver_name : shift;
3734 if ( $driver =~ /^mysql/i ) {
3735 'CONCAT('. join(',', @$items). ')';
3737 join('||', @$items);
3742 =item group_concat_sql COLUMN, DELIMITER
3744 Returns an SQL expression to concatenate an aggregate column, using
3745 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3749 sub group_concat_sql {
3750 my ($col, $delim) = @_;
3751 $delim = dbh->quote($delim);
3752 if ( driver_name() =~ /^mysql/i ) {
3753 # DISTINCT(foo) is valid as $col
3754 return "GROUP_CONCAT($col SEPARATOR $delim)";
3756 return "array_to_string(array_agg($col), $delim)";
3760 =item midnight_sql DATE
3762 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3763 on that day in the system timezone, using the default driver name.
3768 my $driver = driver_name;
3770 if ( $driver =~ /^mysql/i ) {
3771 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3774 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3782 This module should probably be renamed, since much of the functionality is
3783 of general use. It is not completely unlike Adapter::DBI (see below).
3785 Exported qsearch and qsearchs should be deprecated in favor of method calls
3786 (against an FS::Record object like the old search and searchs that qsearch
3787 and qsearchs were on top of.)
3789 The whole fields / hfields mess should be removed.
3791 The various WHERE clauses should be subroutined.
3793 table string should be deprecated in favor of DBIx::DBSchema::Table.
3795 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3796 true maps to the database (and WHERE clauses) would also help.
3798 The ut_ methods should ask the dbdef for a default length.
3800 ut_sqltype (like ut_varchar) should all be defined
3802 A fallback check method should be provided which uses the dbdef.
3804 The ut_money method assumes money has two decimal digits.
3806 The Pg money kludge in the new method only strips `$'.
3808 The ut_phonen method only checks US-style phone numbers.
3810 The _quote function should probably use ut_float instead of a regex.
3812 All the subroutines probably should be methods, here or elsewhere.
3814 Probably should borrow/use some dbdef methods where appropriate (like sub
3817 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3818 or allow it to be set. Working around it is ugly any way around - DBI should
3819 be fixed. (only affects RDBMS which return uppercase column names)
3821 ut_zip should take an optional country like ut_phone.
3825 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3827 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.