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
289 C<$FS::Record::qsearch_qualify_columns> package global is enabled by default.
290 When enabled, the WHERE clause generated from the 'hashref' parameter has
291 the table name prepended to each column name. WHERE column = 'value' becomes
292 WHERE table.coumn = 'value'
296 my %TYPE = (); #for debugging
299 my($type, $value) = @_;
301 my $bind_type = { TYPE => SQL_VARCHAR };
303 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
305 $bind_type = { TYPE => SQL_INTEGER };
307 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
309 if ( driver_name eq 'Pg' ) {
311 $bind_type = { pg_type => PG_BYTEA };
313 # $bind_type = ? #SQL_VARCHAR could be fine?
316 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
317 #fixed by DBD::Pg 2.11.8
318 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
319 #(make a Tron test first)
320 } elsif ( _is_fs_float( $type, $value ) ) {
322 $bind_type = { TYPE => SQL_DECIMAL };
331 my($type, $value) = @_;
332 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
333 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
341 my( @stable, @record, @cache );
342 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
344 my %union_options = ();
345 if ( ref($_[0]) eq 'ARRAY' ) {
348 foreach my $href ( @$optlist ) {
349 push @stable, ( $href->{'table'} or die "table name is required" );
350 push @record, ( $href->{'hashref'} || {} );
351 push @select, ( $href->{'select'} || '*' );
352 push @extra_sql, ( $href->{'extra_sql'} || '' );
353 push @extra_param, ( $href->{'extra_param'} || [] );
354 push @order_by, ( $href->{'order_by'} || '' );
355 push @cache, ( $href->{'cache_obj'} || '' );
356 push @addl_from, ( $href->{'addl_from'} || '' );
357 push @debug, ( $href->{'debug'} || '' );
359 die "at least one hashref is required" unless scalar(@stable);
360 } elsif ( ref($_[0]) eq 'HASH' ) {
362 $stable[0] = $opt->{'table'} or die "table name is required";
363 $record[0] = $opt->{'hashref'} || {};
364 $select[0] = $opt->{'select'} || '*';
365 $extra_sql[0] = $opt->{'extra_sql'} || '';
366 $extra_param[0] = $opt->{'extra_param'} || [];
367 $order_by[0] = $opt->{'order_by'} || '';
368 $cache[0] = $opt->{'cache_obj'} || '';
369 $addl_from[0] = $opt->{'addl_from'} || '';
370 $debug[0] = $opt->{'debug'} || '';
381 my $cache = $cache[0];
387 foreach my $stable ( @stable ) {
389 carp '->qsearch on cust_main called' if $stable eq 'cust_main' && $DEBUG;
391 #stop altering the caller's hashref
392 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
393 my $select = shift @select;
394 my $extra_sql = shift @extra_sql;
395 my $extra_param = shift @extra_param;
396 my $order_by = shift @order_by;
397 my $cache = shift @cache;
398 my $addl_from = shift @addl_from;
399 my $debug = shift @debug;
401 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
403 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
406 my $table = $cache ? $cache->table : $stable;
407 my $dbdef_table = dbdef->table($table)
408 or die "No schema for table $table found - ".
409 "do you need to run freeside-upgrade?";
410 my $pkey = $dbdef_table->primary_key;
412 my @real_fields = grep exists($record->{$_}), real_fields($table);
414 my $statement .= "SELECT $select FROM $stable";
417 $statement .= " $addl_from";
418 # detect aliasing of the main table
419 if ( $addl_from =~ /^\s*AS\s+(\w+)/i ) {
423 if ( @real_fields ) {
424 $statement .= ' WHERE '. join(' AND ',
425 get_real_fields($table, $record, \@real_fields, $alias_main));
428 $statement .= " $extra_sql" if defined($extra_sql);
429 $statement .= " $order_by" if defined($order_by);
431 push @statement, $statement;
433 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
436 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
439 my $value = $record->{$field};
440 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
441 $value = $value->{'value'} if ref($value);
442 my $type = dbdef->table($table)->column($field)->type;
444 my $bind_type = _bind_type($type, $value);
448 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
450 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
454 push @bind_type, $bind_type;
458 foreach my $param ( @$extra_param ) {
459 my $bind_type = { TYPE => SQL_VARCHAR };
462 $value = $param->[0];
463 my $type = $param->[1];
464 $bind_type = _bind_type($type, $value);
467 push @bind_type, $bind_type;
471 my $statement = join( ' ) UNION ( ', @statement );
472 $statement = "( $statement )" if scalar(@statement) > 1;
473 $statement .= " $union_options{order_by}" if $union_options{order_by};
475 my $sth = $dbh->prepare($statement)
476 or croak "$dbh->errstr doing $statement";
479 foreach my $value ( @value ) {
480 my $bind_type = shift @bind_type;
481 $sth->bind_param($bind++, $value, $bind_type );
484 # $sth->execute( map $record->{$_},
485 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
486 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
488 my $ok = $sth->execute;
490 my $error = "Error executing \"$statement\"";
491 $error .= ' (' . join(', ', map {"'$_'"} @value) . ')' if @value;
492 $error .= ': '. $sth->errstr;
497 # Determine how to format rows returned form a union query:
499 # * When all queries involved in the union are from the same table:
500 # Return an array of FS::$table_name objects
502 # * When union query is performed on multiple tables,
503 # Return an array of FS::Record objects
504 # ! Note: As far as I can tell, this functionality was broken, and
505 # ! actually results in a crash. Behavior is left intact
506 # ! as-is, in case the results are in use somewhere
508 # * Union query is performed on multiple table,
509 # and $union_options{classname_from_column} = 1
510 # Return an array of FS::$classname objects, where $classname is
511 # derived for each row from a static field inserted each returned
513 # e.g.: SELECT custnum,first,last,'cust_main' AS `__classname`'.
516 my $table = $stable[0];
518 $table = '' if grep { $_ ne $table } @stable;
519 $pkey = dbdef->table($table)->primary_key if $table;
522 tie %result, "Tie::IxHash";
523 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
524 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
525 %result = map { $_->{$pkey}, $_ } @stuff;
527 @result{@stuff} = @stuff;
532 #below was refactored out to _from_hashref, this should use it at some point
535 if ($union_options{classname_from_column}) {
538 # I'm not implementing the cache for this use case, at least not yet
541 for my $row (@stuff) {
542 my $table_class = $row->{__classname}
543 or die "`__classname` column must be set when ".
544 "using \$union_options{classname_from_column}";
545 push @return, new("FS::$table_class",$row);
549 elsif ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
550 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
551 #derivied class didn't override new method, so this optimization is safe
554 new_or_cached( "FS::$table", { %{$_} }, $cache )
558 new( "FS::$table", { %{$_} } )
562 #okay, its been tested
563 # warn "untested code (class FS::$table uses custom new method)";
565 eval 'FS::'. $table. '->new( { %{$_} } )';
569 # Check for encrypted fields and decrypt them.
570 ## only in the local copy, not the cached object
571 no warnings 'deprecated'; # XXX silence the warning for now
572 if ( $conf_encryption
573 && eval '@FS::'. $table . '::encrypted_fields' ) {
574 foreach my $record (@return) {
575 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
576 next if $field eq 'payinfo'
577 && ($record->isa('FS::payinfo_transaction_Mixin')
578 || $record->isa('FS::payinfo_Mixin') )
580 && !grep { $record->payby eq $_ } @encrypt_payby;
581 # Set it directly... This may cause a problem in the future...
582 $record->setfield($field, $record->decrypt($record->getfield($field)));
587 cluck "warning: FS::$table not loaded; returning FS::Record objects"
588 unless $nowarn_classload;
590 FS::Record->new( $table, { %{$_} } );
598 Construct the SQL statement and parameter-binding list for qsearch. Takes
599 the qsearch parameters.
601 Returns a hash containing:
602 'table': The primary table name (if there is one).
603 'statement': The SQL statement itself.
604 'bind_type': An arrayref of bind types.
605 'value': An arrayref of parameter values.
606 'cache': The cache object, if one was passed.
611 my( @stable, @record, @cache );
612 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
615 my %union_options = ();
616 if ( ref($_[0]) eq 'ARRAY' ) {
619 foreach my $href ( @$optlist ) {
620 push @stable, ( $href->{'table'} or die "table name is required" );
621 push @record, ( $href->{'hashref'} || {} );
622 push @select, ( $href->{'select'} || '*' );
623 push @extra_sql, ( $href->{'extra_sql'} || '' );
624 push @extra_param, ( $href->{'extra_param'} || [] );
625 push @order_by, ( $href->{'order_by'} || '' );
626 push @cache, ( $href->{'cache_obj'} || '' );
627 push @addl_from, ( $href->{'addl_from'} || '' );
628 push @debug, ( $href->{'debug'} || '' );
630 die "at least one hashref is required" unless scalar(@stable);
631 } elsif ( ref($_[0]) eq 'HASH' ) {
633 $stable[0] = $opt->{'table'} or die "table name is required";
634 $record[0] = $opt->{'hashref'} || {};
635 $select[0] = $opt->{'select'} || '*';
636 $extra_sql[0] = $opt->{'extra_sql'} || '';
637 $extra_param[0] = $opt->{'extra_param'} || [];
638 $order_by[0] = $opt->{'order_by'} || '';
639 $cache[0] = $opt->{'cache_obj'} || '';
640 $addl_from[0] = $opt->{'addl_from'} || '';
641 $debug[0] = $opt->{'debug'} || '';
652 my $cache = $cache[0];
658 my $result_table = $stable[0];
659 foreach my $stable ( @stable ) {
660 #stop altering the caller's hashref
661 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
662 my $select = shift @select;
663 my $extra_sql = shift @extra_sql;
664 my $extra_param = shift @extra_param;
665 my $order_by = shift @order_by;
666 my $cache = shift @cache;
667 my $addl_from = shift @addl_from;
668 my $debug = shift @debug;
670 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
672 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
675 $result_table = '' if $result_table ne $stable;
677 my $table = $cache ? $cache->table : $stable;
678 my $dbdef_table = dbdef->table($table)
679 or die "No schema for table $table found - ".
680 "do you need to run freeside-upgrade?";
681 my $pkey = $dbdef_table->primary_key;
683 my @real_fields = grep exists($record->{$_}), real_fields($table);
685 my $statement .= "SELECT $select FROM $stable";
686 $statement .= " $addl_from" if $addl_from;
687 if ( @real_fields ) {
688 $statement .= ' WHERE '. join(' AND ',
689 get_real_fields($table, $record, \@real_fields));
692 $statement .= " $extra_sql" if defined($extra_sql);
693 $statement .= " $order_by" if defined($order_by);
695 push @statement, $statement;
697 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
701 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
704 my $value = $record->{$field};
705 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
706 $value = $value->{'value'} if ref($value);
707 my $type = dbdef->table($table)->column($field)->type;
709 my $bind_type = _bind_type($type, $value);
713 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
715 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
719 push @bind_type, $bind_type;
723 foreach my $param ( @$extra_param ) {
724 my $bind_type = { TYPE => SQL_VARCHAR };
727 $value = $param->[0];
728 my $type = $param->[1];
729 $bind_type = _bind_type($type, $value);
732 push @bind_type, $bind_type;
736 my $statement = join( ' ) UNION ( ', @statement );
737 $statement = "( $statement )" if scalar(@statement) > 1;
738 $statement .= " $union_options{order_by}" if $union_options{order_by};
741 statement => $statement,
742 bind_type => \@bind_type,
744 table => $result_table,
749 # qsearch should eventually use this
751 my ($table, $cache, @hashrefs) = @_;
753 # XXX get rid of these string evals at some point
754 # (when we have time to test it)
755 # my $class = "FS::$table" if $table;
756 # if ( $class and $class->isa('FS::Record') )
757 # if ( $class->can('new') eq \&new )
759 if ( $table && eval 'scalar(@FS::'. $table. '::ISA);' ) {
760 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
761 #derivied class didn't override new method, so this optimization is safe
764 new_or_cached( "FS::$table", { %{$_} }, $cache )
768 new( "FS::$table", { %{$_} } )
772 #okay, its been tested
773 # warn "untested code (class FS::$table uses custom new method)";
775 eval 'FS::'. $table. '->new( { %{$_} } )';
779 # Check for encrypted fields and decrypt them.
780 ## only in the local copy, not the cached object
781 if ( $conf_encryption
782 && eval '@FS::'. $table . '::encrypted_fields' ) {
783 foreach my $record (@return) {
784 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
785 next if $field eq 'payinfo'
786 && ($record->isa('FS::payinfo_transaction_Mixin')
787 || $record->isa('FS::payinfo_Mixin') )
789 && !grep { $record->payby eq $_ } @encrypt_payby;
790 # Set it directly... This may cause a problem in the future...
791 $record->setfield($field, $record->decrypt($record->getfield($field)));
796 cluck "warning: FS::$table not loaded; returning FS::Record objects"
797 unless $nowarn_classload;
799 FS::Record->new( $table, { %{$_} } );
805 sub get_real_fields {
808 my $real_fields = shift;
809 my $alias_main = shift; # defaults to undef
810 $alias_main ||= $table;
812 ## could be optimized more for readability
818 my $table_column = $qsearch_qualify_columns ? "$alias_main.$column" : $column;
819 my $type = dbdef->table($table)->column($column)->type;
820 my $value = $record->{$column};
821 $value = $value->{'value'} if ref($value);
823 if ( ref($record->{$column}) ) {
824 $op = $record->{$column}{'op'} if $record->{$column}{'op'};
825 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
826 if ( uc($op) eq 'ILIKE' ) {
828 $record->{$column}{'value'} = lc($record->{$column}{'value'});
829 $table_column = "LOWER($table_column)";
831 $record->{$column} = $record->{$column}{'value'}
834 if ( ! defined( $record->{$column} ) || $record->{$column} eq '' ) {
836 if ( driver_name eq 'Pg' ) {
837 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
838 qq-( $table_column IS NULL )-;
840 qq-( $table_column IS NULL OR $table_column = '' )-;
843 qq-( $table_column IS NULL OR $table_column = "" )-;
845 } elsif ( $op eq '!=' ) {
846 if ( driver_name eq 'Pg' ) {
847 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
848 qq-( $table_column IS NOT NULL )-;
850 qq-( $table_column IS NOT NULL AND $table_column != '' )-;
853 qq-( $table_column IS NOT NULL AND $table_column != "" )-;
856 if ( driver_name eq 'Pg' ) {
857 qq-( $table_column $op '' )-;
859 qq-( $table_column $op "" )-;
862 } elsif ( $op eq '!=' ) {
863 qq-( $table_column IS NULL OR $table_column != ? )-;
864 #if this needs to be re-enabled, it needs to use a custom op like
865 #"APPROX=" or something (better name?, not '=', to avoid affecting other
867 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
868 # ( "$table_column <= ?", "$table_column >= ?" );
870 "$table_column $op ?";
877 =item by_key PRIMARY_KEY_VALUE
879 This is a class method that returns the record with the given primary key
880 value. This method is only useful in FS::Record subclasses. For example:
882 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
886 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
891 my ($class, $pkey_value) = @_;
893 my $table = $class->table
894 or croak "No table for $class found";
896 my $dbdef_table = dbdef->table($table)
897 or die "No schema for table $table found - ".
898 "do you need to create it or run dbdef-create?";
899 my $pkey = $dbdef_table->primary_key
900 or die "No primary key for table $table";
902 return qsearchs($table, { $pkey => $pkey_value });
905 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
907 Experimental JOINed search method. Using this method, you can execute a
908 single SELECT spanning multiple tables, and cache the results for subsequent
909 method calls. Interface will almost definately change in an incompatible
917 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
918 my $cache = FS::SearchCache->new( $ptable, $pkey );
921 grep { !$saw{$_->getfield($pkey)}++ }
922 qsearch($table, $record, $select, $extra_sql, $cache )
926 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
928 Same as qsearch, except that if more than one record matches, it B<carp>s but
929 returns the first. If this happens, you either made a logic error in asking
930 for a single item, or your data is corrupted.
934 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
936 my(@result) = qsearch(@_);
937 cluck "warning: Multiple records in scalar search ($table)"
938 #.join(' / ', map "$_=>".$_[1]->{$_}, keys %{ $_[1] } )
939 if scalar(@result) > 1;
940 #should warn more vehemently if the search was on a primary key?
941 scalar(@result) ? ($result[0]) : ();
952 Returns the table name.
957 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
964 Returns the DBIx::DBSchema::Table object for the table.
970 my($table)=$self->table;
971 dbdef->table($table);
976 Returns the primary key for the table.
982 my $pkey = $self->dbdef_table->primary_key;
985 =item get, getfield COLUMN
987 Returns the value of the column/field/key COLUMN.
992 my($self,$field) = @_;
993 # to avoid "Use of unitialized value" errors
994 if ( defined ( $self->{Hash}->{$field} ) ) {
995 $self->{Hash}->{$field};
1005 =item set, setfield COLUMN, VALUE
1007 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
1012 my($self,$field,$value) = @_;
1013 $self->{'modified'} = 1;
1014 $self->{'Hash'}->{$field} = $value;
1023 Returns true if the column/field/key COLUMN exists.
1028 my($self,$field) = @_;
1029 exists($self->{Hash}->{$field});
1032 =item AUTOLOADED METHODS
1034 $record->column is a synonym for $record->get('column');
1036 $record->column('value') is a synonym for $record->set('column','value');
1038 $record->foreign_table_name calls qsearchs and returns a single
1039 FS::foreign_table record (for tables referenced by a column of this table) or
1040 qsearch and returns an array of FS::foreign_table records (for tables
1041 referenced by a column in the foreign table).
1047 my($self,$value)=@_;
1048 my($field)=$AUTOLOAD;
1051 confess "errant AUTOLOAD $field for $self (arg $value)"
1052 unless blessed($self) && $self->can('setfield');
1054 if ( my $fk_info = get_fk_method($self->table, $field) ) {
1056 my $method = $fk_info->{method} || 'qsearchs';
1057 my $table = $fk_info->{table} || $field;
1058 my $column = $fk_info->{column};
1059 my $foreign_column = $fk_info->{references} || $column;
1061 eval "use FS::$table";
1064 carp '->cust_main called' if $table eq 'cust_main' && $DEBUG;
1066 my $pkey_value = $self->$column();
1067 my %search = ( $foreign_column => $pkey_value );
1069 # FS::Record->$method() ? they're actually just subs :/
1070 if ( $method eq 'qsearchs' ) {
1071 return $pkey_value ? qsearchs( $table, \%search ) : '';
1072 } elsif ( $method eq 'qsearch' ) {
1073 return $pkey_value ? qsearch( $table, \%search ) : ();
1075 die "unknown method $method";
1080 if ( defined($value) ) {
1081 $self->setfield($field,$value);
1083 $self->getfield($field);
1087 # efficient (also, old, doesn't support FK stuff)
1089 # my $field = $AUTOLOAD;
1090 # $field =~ s/.*://;
1091 # if ( defined($_[1]) ) {
1092 # $_[0]->setfield($field, $_[1]);
1094 # $_[0]->getfield($field);
1098 # get_fk_method(TABLE, FIELD)
1099 # Internal subroutine for fetching the foreign key descriptor for TABLE.FIELD
1100 # if there is one. If not, returns undef.
1101 # This will initialize fk_method_cache if it hasn't happened yet. It is the
1102 # _only_ allowed way to access the contents of %fk_method_cache.
1104 # if we wanted to be even more efficient we'd create the fk methods in the
1105 # symbol table instead of relying on AUTOLOAD every time
1108 my ($table, $field) = @_;
1110 # maybe should only load one table at a time?
1111 fk_methods_init() unless exists($fk_method_cache{$table});
1113 if ( exists($fk_method_cache{$table}) and
1114 exists($fk_method_cache{$table}{$field}) ) {
1115 return $fk_method_cache{$table}{$field};
1122 sub fk_methods_init {
1123 warn "[fk_methods_init]\n" if $DEBUG;
1124 foreach my $table ( dbdef->tables ) {
1125 $fk_method_cache{$table} = fk_methods($table);
1134 # foreign keys we reference in other tables
1135 foreach my $fk (dbdef->table($table)->foreign_keys) {
1138 if ( scalar( @{$fk->columns} ) == 1 ) {
1139 if ( ! defined($fk->references)
1140 || ! @{$fk->references}
1141 || $fk->columns->[0] eq $fk->references->[0]
1143 $method = $fk->table;
1145 #some sort of hint in the table.pm or schema for methods not named
1146 # after their foreign table (well, not a whole lot different than
1147 # just providing a small subroutine...)
1151 $hash{$method} = { #fk_info
1152 'method' => 'qsearchs',
1153 'column' => $fk->columns->[0],
1154 #'references' => $fk->references->[0],
1162 # foreign keys referenced in other tables to us
1163 # (alas. why we're cached. still, might this loop better be done once at
1164 # schema load time insetad of every time we AUTOLOAD a method on a new
1166 if (! defined $fk_table_cache) {
1167 foreach my $f_table ( dbdef->tables ) {
1168 foreach my $fk (dbdef->table($f_table)->foreign_keys) {
1169 push @{$fk_table_cache->{$fk->table}},[$f_table,$fk];
1173 foreach my $fks (@{$fk_table_cache->{$table}}) {
1174 my ($f_table,$fk) = @$fks;
1176 if ( scalar( @{$fk->columns} ) == 1 ) {
1177 if ( ! defined($fk->references)
1178 || ! @{$fk->references}
1179 || $fk->columns->[0] eq $fk->references->[0]
1183 #some sort of hint in the table.pm or schema for methods not named
1184 # after their foreign table (well, not a whole lot different than
1185 # just providing a small subroutine...)
1189 $hash{$method} = { #fk_info
1190 'method' => 'qsearch',
1191 'column' => $fk->columns->[0], #references||column
1192 #'references' => $fk->column->[0],
1204 Returns a list of the column/value pairs, usually for assigning to a new hash.
1206 To make a distinct duplicate of an FS::Record object, you can do:
1208 $new = new FS::Record ( $old->table, { $old->hash } );
1214 confess $self. ' -> hash: Hash attribute is undefined'
1215 unless defined($self->{'Hash'});
1216 %{ $self->{'Hash'} };
1221 Returns a reference to the column/value hash. This may be deprecated in the
1222 future; if there's a reason you can't just use the autoloaded or get/set
1236 +{ ( map { $_=>$self->$_ } $self->fields ),
1241 my( $class, %opt ) = @_;
1242 my $table = $class->table;
1243 my $self = $class->new( { map { $_ => $opt{$_} } fields($table) } );
1244 my $error = $self->insert;
1245 return +{ 'error' => $error } if $error;
1246 my $pkey = $self->pkey;
1247 return +{ 'error' => '',
1248 'primary_key' => $pkey,
1249 $pkey => $self->$pkey,
1255 Returns true if any of this object's values have been modified with set (or via
1256 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
1263 $self->{'modified'};
1266 =item select_for_update
1268 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
1273 sub select_for_update {
1275 my $primary_key = $self->primary_key;
1278 'table' => $self->table,
1279 'hashref' => { $primary_key => $self->$primary_key() },
1280 'extra_sql' => 'FOR UPDATE',
1286 Locks this table with a database-driver specific lock method. This is used
1287 as a mutex in order to do a duplicate search.
1289 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
1291 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
1293 Errors are fatal; no useful return value.
1295 Note: To use this method for new tables other than svc_acct and svc_phone,
1296 edit freeside-upgrade and add those tables to the duplicate_lock list.
1302 my $table = $self->table;
1304 warn "$me locking $table table\n" if $DEBUG;
1306 if ( driver_name =~ /^Pg/i ) {
1308 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
1311 } elsif ( driver_name =~ /^mysql/i ) {
1313 dbh->do("SELECT * FROM duplicate_lock
1314 WHERE lockname = '$table'
1316 ) or die dbh->errstr;
1320 die "unknown database ". driver_name. "; don't know how to lock table";
1324 warn "$me acquired $table table lock\n" if $DEBUG;
1330 Inserts this record to the database. If there is an error, returns the error,
1331 otherwise returns false.
1339 warn "$self -> insert" if $DEBUG;
1341 my $error = $self->check;
1342 return $error if $error;
1344 #single-field non-null unique keys are given a value if empty
1345 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
1346 foreach ( $self->dbdef_table->unique_singles) {
1347 next if $self->getfield($_);
1348 next if $self->dbdef_table->column($_)->null eq 'NULL';
1352 #and also the primary key, if the database isn't going to
1353 my $primary_key = $self->dbdef_table->primary_key;
1355 if ( $primary_key ) {
1356 my $col = $self->dbdef_table->column($primary_key);
1359 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1360 || ( driver_name eq 'Pg'
1361 && defined($col->default)
1362 && $col->quoted_default =~ /^nextval\(/i
1364 || ( driver_name eq 'mysql'
1365 && defined($col->local)
1366 && $col->local =~ /AUTO_INCREMENT/i
1368 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1371 my $table = $self->table;
1373 # Encrypt before the database
1374 if ( scalar( eval '@FS::'. $table . '::encrypted_fields')
1377 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1378 next if $field eq 'payinfo'
1379 && ($self->isa('FS::payinfo_transaction_Mixin')
1380 || $self->isa('FS::payinfo_Mixin') )
1382 && !grep { $self->payby eq $_ } @encrypt_payby;
1383 $saved->{$field} = $self->getfield($field);
1384 $self->setfield($field, $self->encrypt($self->getfield($field)));
1388 #false laziness w/delete
1390 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1394 my $statement = "INSERT INTO $table ";
1395 my @bind_values = ();
1397 if ( ! @real_fields ) {
1399 $statement .= 'DEFAULT VALUES';
1403 if ( $use_placeholders ) {
1405 @bind_values = map $self->getfield($_), @real_fields;
1409 join( ', ', @real_fields ).
1411 join( ', ', map '?', @real_fields ). # @bind_values ).
1417 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1421 join( ', ', @real_fields ).
1423 join( ', ', @values ).
1431 warn "[debug]$me $statement\n" if $DEBUG > 1;
1432 my $sth = dbh->prepare($statement) or return dbh->errstr;
1434 local $SIG{HUP} = 'IGNORE';
1435 local $SIG{INT} = 'IGNORE';
1436 local $SIG{QUIT} = 'IGNORE';
1437 local $SIG{TERM} = 'IGNORE';
1438 local $SIG{TSTP} = 'IGNORE';
1439 local $SIG{PIPE} = 'IGNORE';
1441 $sth->execute(@bind_values) or return $sth->errstr;
1443 # get inserted id from the database, if applicable & needed
1444 if ( $db_seq && ! $self->getfield($primary_key) ) {
1445 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1449 if ( driver_name eq 'Pg' ) {
1451 #my $oid = $sth->{'pg_oid_status'};
1452 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1454 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1455 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1456 dbh->rollback if $FS::UID::AutoCommit;
1457 return "can't parse $table.$primary_key default value".
1458 " for sequence name: $default";
1462 my $i_sql = "SELECT currval('$sequence')";
1463 my $i_sth = dbh->prepare($i_sql) or do {
1464 dbh->rollback if $FS::UID::AutoCommit;
1467 $i_sth->execute() or do { #$i_sth->execute($oid)
1468 dbh->rollback if $FS::UID::AutoCommit;
1469 return $i_sth->errstr;
1471 $insertid = $i_sth->fetchrow_arrayref->[0];
1473 } elsif ( driver_name eq 'mysql' ) {
1475 $insertid = dbh->{'mysql_insertid'};
1476 # work around mysql_insertid being null some of the time, ala RT :/
1477 unless ( $insertid ) {
1478 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1479 "using SELECT LAST_INSERT_ID();";
1480 my $i_sql = "SELECT LAST_INSERT_ID()";
1481 my $i_sth = dbh->prepare($i_sql) or do {
1482 dbh->rollback if $FS::UID::AutoCommit;
1485 $i_sth->execute or do {
1486 dbh->rollback if $FS::UID::AutoCommit;
1487 return $i_sth->errstr;
1489 $insertid = $i_sth->fetchrow_arrayref->[0];
1494 dbh->rollback if $FS::UID::AutoCommit;
1495 return "don't know how to retreive inserted ids from ". driver_name.
1496 ", try using counterfiles (maybe run dbdef-create?)";
1500 $self->setfield($primary_key, $insertid);
1505 if ( defined( dbdef->table('h_'. $table) ) && ! $no_history ) {
1506 my $h_statement = $self->_h_statement('insert');
1507 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1508 $h_sth = dbh->prepare($h_statement) or do {
1509 dbh->rollback if $FS::UID::AutoCommit;
1515 $h_sth->execute or return $h_sth->errstr if $h_sth;
1517 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1519 # Now that it has been saved, reset the encrypted fields so that $new
1520 # can still be used.
1521 foreach my $field (keys %{$saved}) {
1522 $self->setfield($field, $saved->{$field});
1530 Depriciated (use insert instead).
1535 cluck "warning: FS::Record::add deprecated!";
1536 insert @_; #call method in this scope
1541 Delete this record from the database. If there is an error, returns the error,
1542 otherwise returns false.
1549 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1551 $self->getfield($_) eq ''
1552 #? "( $_ IS NULL OR $_ = \"\" )"
1553 ? ( driver_name eq 'Pg'
1555 : "( $_ IS NULL OR $_ = \"\" )"
1557 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1558 } ( $self->dbdef_table->primary_key )
1559 ? ( $self->dbdef_table->primary_key)
1560 : real_fields($self->table)
1562 warn "[debug]$me $statement\n" if $DEBUG > 1;
1563 my $sth = dbh->prepare($statement) or return dbh->errstr;
1566 if ( defined dbdef->table('h_'. $self->table) ) {
1567 my $h_statement = $self->_h_statement('delete');
1568 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1569 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1574 my $primary_key = $self->dbdef_table->primary_key;
1576 local $SIG{HUP} = 'IGNORE';
1577 local $SIG{INT} = 'IGNORE';
1578 local $SIG{QUIT} = 'IGNORE';
1579 local $SIG{TERM} = 'IGNORE';
1580 local $SIG{TSTP} = 'IGNORE';
1581 local $SIG{PIPE} = 'IGNORE';
1583 my $rc = $sth->execute or return $sth->errstr;
1584 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1585 $h_sth->execute or return $h_sth->errstr if $h_sth;
1587 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1589 #no need to needlessly destoy the data either (causes problems actually)
1590 #undef $self; #no need to keep object!
1597 Depriciated (use delete instead).
1602 cluck "warning: FS::Record::del deprecated!";
1603 &delete(@_); #call method in this scope
1606 =item replace OLD_RECORD
1608 Replace the OLD_RECORD with this one in the database. If there is an error,
1609 returns the error, otherwise returns false.
1614 my ($new, $old) = (shift, shift);
1616 $old = $new->replace_old unless defined($old);
1618 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1620 if ( $new->can('replace_check') ) {
1621 my $error = $new->replace_check($old);
1622 return $error if $error;
1625 return "Records not in same table!" unless $new->table eq $old->table;
1627 my $primary_key = $old->dbdef_table->primary_key;
1628 return "Can't change primary key $primary_key ".
1629 'from '. $old->getfield($primary_key).
1630 ' to ' . $new->getfield($primary_key)
1632 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1634 my $error = $new->check;
1635 return $error if $error;
1637 # Encrypt for replace
1639 if ( scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1642 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1643 next if $field eq 'payinfo'
1644 && ($new->isa('FS::payinfo_transaction_Mixin')
1645 || $new->isa('FS::payinfo_Mixin') )
1647 && !grep { $new->payby eq $_ } @encrypt_payby;
1648 $saved->{$field} = $new->getfield($field);
1649 $new->setfield($field, $new->encrypt($new->getfield($field)));
1653 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1654 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1655 ? ($_, $new->getfield($_)) : () } $old->fields;
1657 unless (keys(%diff) || $no_update_diff ) {
1658 carp "[warning]$me ". ref($new)."->replace ".
1659 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1660 ": records identical"
1661 unless $nowarn_identical;
1665 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1667 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1668 } real_fields($old->table)
1673 if ( $old->getfield($_) eq '' ) {
1675 #false laziness w/qsearch
1676 if ( driver_name eq 'Pg' ) {
1677 my $type = $old->dbdef_table->column($_)->type;
1678 if ( $type =~ /(int|(big)?serial)/i ) {
1681 qq-( $_ IS NULL OR $_ = '' )-;
1684 qq-( $_ IS NULL OR $_ = "" )-;
1688 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1691 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1694 warn "[debug]$me $statement\n" if $DEBUG > 1;
1695 my $sth = dbh->prepare($statement) or return dbh->errstr;
1698 if ( defined dbdef->table('h_'. $old->table) ) {
1699 my $h_old_statement = $old->_h_statement('replace_old');
1700 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1701 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1707 if ( defined dbdef->table('h_'. $new->table) ) {
1708 my $h_new_statement = $new->_h_statement('replace_new');
1709 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1710 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1715 local $SIG{HUP} = 'IGNORE';
1716 local $SIG{INT} = 'IGNORE';
1717 local $SIG{QUIT} = 'IGNORE';
1718 local $SIG{TERM} = 'IGNORE';
1719 local $SIG{TSTP} = 'IGNORE';
1720 local $SIG{PIPE} = 'IGNORE';
1722 my $rc = $sth->execute or return $sth->errstr;
1723 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1724 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1725 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1727 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1729 # Now that it has been saved, reset the encrypted fields so that $new
1730 # can still be used.
1731 foreach my $field (keys %{$saved}) {
1732 $new->setfield($field, $saved->{$field});
1740 my( $self ) = shift;
1741 warn "[$me] replace called with no arguments; autoloading old record\n"
1744 my $primary_key = $self->dbdef_table->primary_key;
1745 if ( $primary_key ) {
1746 $self->by_key( $self->$primary_key() ) #this is what's returned
1747 or croak "can't find ". $self->table. ".$primary_key ".
1748 $self->$primary_key();
1750 croak $self->table. " has no primary key; pass old record as argument";
1757 Depriciated (use replace instead).
1762 cluck "warning: FS::Record::rep deprecated!";
1763 replace @_; #call method in this scope
1768 Checks custom fields. Subclasses should still provide a check method to validate
1769 non-custom fields, etc., and call this method via $self->SUPER::check.
1775 foreach my $field ($self->virtual_fields) {
1776 my $error = $self->ut_textn($field);
1777 return $error if $error;
1782 =item virtual_fields [ TABLE ]
1784 Returns a list of virtual fields defined for the table. This should not
1785 be exported, and should only be called as an instance or class method.
1789 sub virtual_fields {
1792 $table = $self->table or confess "virtual_fields called on non-table";
1794 confess "Unknown table $table" unless dbdef->table($table);
1796 return () unless dbdef->table('part_virtual_field');
1798 unless ( $virtual_fields_cache{$table} ) {
1799 my $concat = [ "'cf_'", "name" ];
1800 my $query = "SELECT ".concat_sql($concat).' from part_virtual_field ' .
1801 "WHERE dbtable = '$table'";
1803 my $result = $dbh->selectcol_arrayref($query);
1804 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1806 $virtual_fields_cache{$table} = $result;
1809 @{$virtual_fields_cache{$table}};
1813 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1815 Processes a batch import as a queued JSRPC job
1817 JOB is an FS::queue entry.
1819 OPTIONS_HASHREF can have the following keys:
1825 Table name (required).
1829 Arrayref of field names for static fields. They will be given values from the
1830 PARAMS hashref and passed as a "params" hashref to batch_import.
1834 Formats hashref. Keys are field names, values are listrefs that define the
1837 Each listref value can be a column name or a code reference. Coderefs are run
1838 with the row object, data and a FS::Conf object as the three parameters.
1839 For example, this coderef does the same thing as using the "columnname" string:
1842 my( $record, $data, $conf ) = @_;
1843 $record->columnname( $data );
1846 Coderefs are run after all "column name" fields are assigned.
1850 Optional format hashref of types. Keys are field names, values are "csv",
1851 "xls" or "fixedlength". Overrides automatic determination of file type
1854 =item format_headers
1856 Optional format hashref of header lines. Keys are field names, values are 0
1857 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1860 =item format_sep_chars
1862 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1863 CSV separation character.
1865 =item format_fixedlenth_formats
1867 Optional format hashref of fixed length format defintiions. Keys are field
1868 names, values Parse::FixedLength listrefs of field definitions.
1872 Set true to default to CSV file type if the filename does not contain a
1873 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1878 PARAMS is a hashref (or base64-encoded Storable hashref) containing the
1879 POSTed data. It must contain the field "uploaded files", generated by
1880 /elements/file-upload.html and containing the list of uploaded files.
1881 Currently only supports a single file named "file".
1886 sub process_batch_import {
1887 my($job, $opt, $param) = @_;
1889 my $table = $opt->{table};
1890 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1891 my %formats = %{ $opt->{formats} };
1893 warn Dumper($param) if $DEBUG;
1895 my $files = $param->{'uploaded_files'}
1896 or die "No files provided.\n";
1898 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1900 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1901 my $file = $dir. $files{'file'};
1906 formats => \%formats,
1907 format_types => $opt->{format_types},
1908 format_headers => $opt->{format_headers},
1909 format_sep_chars => $opt->{format_sep_chars},
1910 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1911 format_xml_formats => $opt->{format_xml_formats},
1912 format_asn_formats => $opt->{format_asn_formats},
1913 format_row_callbacks => $opt->{format_row_callbacks},
1914 format_hash_callbacks => $opt->{format_hash_callbacks},
1919 format => $param->{format},
1920 params => { map { $_ => $param->{$_} } @pass_params },
1922 default_csv => $opt->{default_csv},
1923 preinsert_callback => $opt->{preinsert_callback},
1924 postinsert_callback => $opt->{postinsert_callback},
1925 insert_args_callback => $opt->{insert_args_callback},
1928 if ( $opt->{'batch_namecol'} ) {
1929 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1930 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1933 my $error = FS::Record::batch_import( \%iopt );
1937 die "$error\n" if $error;
1940 =item batch_import PARAM_HASHREF
1942 Class method for batch imports. Available params:
1948 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1954 =item format_headers
1956 =item format_sep_chars
1958 =item format_fixedlength_formats
1960 =item format_row_callbacks
1962 =item format_hash_callbacks - After parsing, before object creation
1964 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1966 =item preinsert_callback
1968 =item postinsert_callback
1974 FS::queue object, will be updated with progress
1980 csv, xls, fixedlength, xml
1992 warn "$me batch_import call with params: \n". Dumper($param)
1995 my $table = $param->{table};
1997 my $job = $param->{job};
1998 my $file = $param->{file};
1999 my $params = $param->{params} || {};
2001 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
2002 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
2004 my( $type, $header, $sep_char,
2005 $fixedlength_format, $xml_format, $asn_format,
2006 $parser_opt, $row_callback, $hash_callback, @fields );
2008 my $postinsert_callback = '';
2009 $postinsert_callback = $param->{'postinsert_callback'}
2010 if $param->{'postinsert_callback'};
2011 my $preinsert_callback = '';
2012 $preinsert_callback = $param->{'preinsert_callback'}
2013 if $param->{'preinsert_callback'};
2014 my $insert_args_callback = '';
2015 $insert_args_callback = $param->{'insert_args_callback'}
2016 if $param->{'insert_args_callback'};
2018 if ( $param->{'format'} ) {
2020 my $format = $param->{'format'};
2021 my $formats = $param->{formats};
2022 die "unknown format $format" unless exists $formats->{ $format };
2024 $type = $param->{'format_types'}
2025 ? $param->{'format_types'}{ $format }
2026 : $param->{type} || 'csv';
2029 $header = $param->{'format_headers'}
2030 ? $param->{'format_headers'}{ $param->{'format'} }
2033 $sep_char = $param->{'format_sep_chars'}
2034 ? $param->{'format_sep_chars'}{ $param->{'format'} }
2037 $fixedlength_format =
2038 $param->{'format_fixedlength_formats'}
2039 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
2043 $param->{'format_parser_opts'}
2044 ? $param->{'format_parser_opts'}{ $param->{'format'} }
2048 $param->{'format_xml_formats'}
2049 ? $param->{'format_xml_formats'}{ $param->{'format'} }
2053 $param->{'format_asn_formats'}
2054 ? $param->{'format_asn_formats'}{ $param->{'format'} }
2058 $param->{'format_row_callbacks'}
2059 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
2063 $param->{'format_hash_callbacks'}
2064 ? $param->{'format_hash_callbacks'}{ $param->{'format'} }
2067 @fields = @{ $formats->{ $format } };
2069 } elsif ( $param->{'fields'} ) {
2071 $type = ''; #infer from filename
2074 $fixedlength_format = '';
2076 $hash_callback = '';
2077 @fields = @{ $param->{'fields'} };
2080 die "neither format nor fields specified";
2083 #my $file = $param->{file};
2086 if ( $file =~ /\.(\w+)$/i ) {
2090 warn "can't parse file type from filename $file; defaulting to CSV";
2094 if $param->{'default_csv'} && $type ne 'xls';
2102 my $asn_header_buffer;
2103 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
2105 if ( $type eq 'csv' ) {
2107 $parser_opt->{'binary'} = 1;
2108 $parser_opt->{'sep_char'} = $sep_char if $sep_char;
2109 $parser = Text::CSV_XS->new($parser_opt);
2111 } elsif ( $type eq 'fixedlength' ) {
2113 eval "use Parse::FixedLength;";
2115 $parser = Parse::FixedLength->new($fixedlength_format, $parser_opt);
2118 die "Unknown file type $type\n";
2121 @buffer = split(/\r?\n/, slurp($file) );
2122 splice(@buffer, 0, ($header || 0) );
2123 $count = scalar(@buffer);
2125 } elsif ( $type eq 'xls' ) {
2127 eval "use Spreadsheet::ParseExcel;";
2130 eval "use DateTime::Format::Excel;";
2131 #for now, just let the error be thrown if it is used, since only CDR
2132 # formats bill_west and troop use it, not other excel-parsing things
2135 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
2137 $parser = $excel->{Worksheet}[0]; #first sheet
2139 $count = $parser->{MaxRow} || $parser->{MinRow};
2142 $row = $header || 0;
2144 } elsif ( $type eq 'xml' ) {
2147 eval "use XML::Simple;";
2149 my $xmlrow = $xml_format->{'xmlrow'};
2150 $parser = $xml_format->{'xmlkeys'};
2151 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
2152 my $data = XML::Simple::XMLin(
2154 'SuppressEmpty' => '', #sets empty values to ''
2158 $rows = $rows->{$_} foreach @$xmlrow;
2159 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
2160 $count = @buffer = @$rows;
2162 } elsif ( $type eq 'asn.1' ) {
2164 eval "use Convert::ASN1";
2167 my $asn = Convert::ASN1->new;
2168 $asn->prepare( $asn_format->{'spec'} ) or die $asn->error;
2170 $parser = $asn->find( $asn_format->{'macro'} ) or die $asn->error;
2172 my $data = slurp($file);
2173 my $asn_output = $parser->decode( $data )
2174 or return "No ". $asn_format->{'macro'}. " found\n";
2176 $asn_header_buffer = &{ $asn_format->{'header_buffer'} }( $asn_output );
2178 my $rows = &{ $asn_format->{'arrayref'} }( $asn_output );
2179 $count = @buffer = @$rows;
2182 die "Unknown file type $type\n";
2187 local $SIG{HUP} = 'IGNORE';
2188 local $SIG{INT} = 'IGNORE';
2189 local $SIG{QUIT} = 'IGNORE';
2190 local $SIG{TERM} = 'IGNORE';
2191 local $SIG{TSTP} = 'IGNORE';
2192 local $SIG{PIPE} = 'IGNORE';
2194 my $oldAutoCommit = $FS::UID::AutoCommit;
2195 local $FS::UID::AutoCommit = 0;
2198 #my $params = $param->{params} || {};
2199 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
2200 my $batch_col = $param->{'batch_keycol'};
2202 my $batch_class = 'FS::'. $param->{'batch_table'};
2203 my $batch = $batch_class->new({
2204 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
2206 my $error = $batch->insert;
2208 $dbh->rollback if $oldAutoCommit;
2209 return "can't insert batch record: $error";
2211 #primary key via dbdef? (so the column names don't have to match)
2212 my $batch_value = $batch->get( $param->{'batch_keycol'} );
2214 $params->{ $batch_col } = $batch_value;
2217 #my $job = $param->{job};
2220 my $unique_skip = 0; #lines skipped because they're already in the system
2221 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
2225 my %hash = %$params;
2226 if ( $type eq 'csv' ) {
2228 last unless scalar(@buffer);
2229 $line = shift(@buffer);
2231 next if $line =~ /^\s*$/; #skip empty lines
2233 $line = &{$row_callback}($line) if $row_callback;
2235 next if $line =~ /^\s*$/; #skip empty lines
2237 $parser->parse($line) or do {
2238 $dbh->rollback if $oldAutoCommit;
2239 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
2241 @columns = $parser->fields();
2243 } elsif ( $type eq 'fixedlength' ) {
2245 last unless scalar(@buffer);
2246 $line = shift(@buffer);
2248 @columns = $parser->parse($line);
2250 } elsif ( $type eq 'xls' ) {
2252 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
2253 || ! $parser->{Cells}[$row];
2255 my @row = @{ $parser->{Cells}[$row] };
2256 @columns = map $_->{Val}, @row;
2259 #warn $z++. ": $_\n" for @columns;
2261 } elsif ( $type eq 'xml' ) {
2263 # $parser = [ 'Column0Key', 'Column1Key' ... ]
2264 last unless scalar(@buffer);
2265 my $row = shift @buffer;
2266 @columns = @{ $row }{ @$parser };
2268 } elsif ( $type eq 'asn.1' ) {
2270 last unless scalar(@buffer);
2271 my $row = shift @buffer;
2272 &{ $asn_format->{row_callback} }( $row, $asn_header_buffer )
2273 if $asn_format->{row_callback};
2274 foreach my $key ( keys %{ $asn_format->{map} } ) {
2275 $hash{$key} = &{ $asn_format->{map}{$key} }( $row, $asn_header_buffer );
2279 die "Unknown file type $type\n";
2284 foreach my $field ( @fields ) {
2286 my $value = shift @columns;
2288 if ( ref($field) eq 'CODE' ) {
2289 #&{$field}(\%hash, $value);
2290 push @later, $field, $value;
2292 #??? $hash{$field} = $value if length($value);
2293 $hash{$field} = $value if defined($value) && length($value);
2298 if ( $custnum_prefix && $hash{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
2299 && length($1) == $custnum_length ) {
2300 $hash{custnum} = $2;
2303 %hash = &{$hash_callback}(%hash) if $hash_callback;
2305 #my $table = $param->{table};
2306 my $class = "FS::$table";
2308 my $record = $class->new( \%hash );
2311 while ( scalar(@later) ) {
2312 my $sub = shift @later;
2313 my $data = shift @later;
2315 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
2318 $dbh->rollback if $oldAutoCommit;
2319 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
2321 last if exists( $param->{skiprow} );
2323 $unique_skip++ if $param->{unique_skip}; #line is already in the system
2324 next if exists( $param->{skiprow} );
2326 if ( $preinsert_callback ) {
2327 my $error = &{$preinsert_callback}($record, $param);
2329 $dbh->rollback if $oldAutoCommit;
2330 return "preinsert_callback error". ( $line ? " for $line" : '' ).
2333 next if exists $param->{skiprow} && $param->{skiprow};
2336 my @insert_args = ();
2337 if ( $insert_args_callback ) {
2338 @insert_args = &{$insert_args_callback}($record, $param);
2341 my $error = $record->insert(@insert_args);
2344 $dbh->rollback if $oldAutoCommit;
2345 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
2351 if ( $postinsert_callback ) {
2352 my $error = &{$postinsert_callback}($record, $param);
2354 $dbh->rollback if $oldAutoCommit;
2355 return "postinsert_callback error". ( $line ? " for $line" : '' ).
2360 if ( $job && time - $min_sec > $last ) { #progress bar
2361 $job->update_statustext( int(100 * $imported / $count) );
2367 unless ( $imported || $param->{empty_ok} ) {
2368 $dbh->rollback if $oldAutoCommit;
2369 # freeside-cdr-conexiant-import is sensitive to the text of this message
2370 return $unique_skip ? "All records in file were previously imported" : "Empty file!";
2373 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2380 my( $self, $action, $time ) = @_;
2384 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2387 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2388 real_fields($self->table);
2391 # If we're encrypting then don't store the payinfo in the history
2392 if ( $conf_encryption && $self->table ne 'banned_pay' ) {
2393 @fields = grep { $_ ne 'payinfo' } @fields;
2396 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2398 "INSERT INTO h_". $self->table. " ( ".
2399 join(', ', qw(history_date history_usernum history_action), @fields ).
2402 $FS::CurrentUser::CurrentUser->usernum,
2403 dbh->quote($action),
2412 B<Warning>: External use is B<deprecated>.
2414 Replaces COLUMN in record with a unique number, using counters in the
2415 filesystem. Used by the B<insert> method on single-field unique columns
2416 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2417 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2419 Returns the new value.
2424 my($self,$field) = @_;
2425 my($table)=$self->table;
2427 croak "Unique called on field $field, but it is ",
2428 $self->getfield($field),
2430 if $self->getfield($field);
2432 #warn "table $table is tainted" if is_tainted($table);
2433 #warn "field $field is tainted" if is_tainted($field);
2435 my($counter) = new File::CounterFile "$table.$field",0;
2437 my $index = $counter->inc;
2438 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2440 $index =~ /^(\d*)$/;
2443 $self->setfield($field,$index);
2447 =item ut_float COLUMN
2449 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2450 null. If there is an error, returns the error, otherwise returns false.
2455 my($self,$field)=@_ ;
2456 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2457 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2458 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2459 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2460 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2461 $self->setfield($field,$1);
2464 =item ut_floatn COLUMN
2466 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2467 null. If there is an error, returns the error, otherwise returns false.
2471 #false laziness w/ut_ipn
2473 my( $self, $field ) = @_;
2474 if ( $self->getfield($field) =~ /^()$/ ) {
2475 $self->setfield($field,'');
2478 $self->ut_float($field);
2482 =item ut_sfloat COLUMN
2484 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2485 May not be null. If there is an error, returns the error, otherwise returns
2491 my($self,$field)=@_ ;
2492 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2493 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2494 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2495 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2496 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2497 $self->setfield($field,$1);
2500 =item ut_sfloatn COLUMN
2502 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2503 null. If there is an error, returns the error, otherwise returns false.
2508 my( $self, $field ) = @_;
2509 if ( $self->getfield($field) =~ /^()$/ ) {
2510 $self->setfield($field,'');
2513 $self->ut_sfloat($field);
2517 =item ut_snumber COLUMN
2519 Check/untaint signed numeric data (whole numbers). If there is an error,
2520 returns the error, otherwise returns false.
2525 my($self, $field) = @_;
2526 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2527 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2528 $self->setfield($field, "$1$2");
2532 =item ut_snumbern COLUMN
2534 Check/untaint signed numeric data (whole numbers). If there is an error,
2535 returns the error, otherwise returns false.
2540 my($self, $field) = @_;
2541 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2542 or return "Illegal (numeric) $field: ". $self->getfield($field);
2544 return "Illegal (numeric) $field: ". $self->getfield($field)
2547 $self->setfield($field, "$1$2");
2551 =item ut_number COLUMN
2553 Check/untaint simple numeric data (whole numbers). May not be null. If there
2554 is an error, returns the error, otherwise returns false.
2559 my($self,$field)=@_;
2560 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2561 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2562 $self->setfield($field,$1);
2566 =item ut_numbern COLUMN
2568 Check/untaint simple numeric data (whole numbers). May be null. If there is
2569 an error, returns the error, otherwise returns false.
2574 my($self,$field)=@_;
2575 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2576 or return "Illegal (numeric) $field: ". $self->getfield($field);
2577 $self->setfield($field,$1);
2581 =item ut_decimal COLUMN[, DIGITS]
2583 Check/untaint decimal numbers (up to DIGITS decimal places. If there is an
2584 error, returns the error, otherwise returns false.
2586 =item ut_decimaln COLUMN[, DIGITS]
2588 Check/untaint decimal numbers. May be null. If there is an error, returns
2589 the error, otherwise returns false.
2594 my($self, $field, $digits) = @_;
2596 $self->getfield($field) =~ /^\s*(\d+(\.\d{0,$digits})?)\s*$/
2597 or return "Illegal or empty (decimal) $field: ".$self->getfield($field);
2598 $self->setfield($field, $1);
2603 my($self, $field, $digits) = @_;
2604 $self->getfield($field) =~ /^\s*(\d*(\.\d{0,$digits})?)\s*$/
2605 or return "Illegal (decimal) $field: ".$self->getfield($field);
2606 $self->setfield($field, $1);
2610 =item ut_money COLUMN
2612 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2613 is an error, returns the error, otherwise returns false.
2618 my($self,$field)=@_;
2620 if ( $self->getfield($field) eq '' ) {
2621 $self->setfield($field, 0);
2622 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2623 #handle one decimal place without barfing out
2624 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2625 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2626 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2628 return "Illegal (money) $field: ". $self->getfield($field);
2634 =item ut_moneyn COLUMN
2636 Check/untaint monetary numbers. May be negative. If there
2637 is an error, returns the error, otherwise returns false.
2642 my($self,$field)=@_;
2643 if ($self->getfield($field) eq '') {
2644 $self->setfield($field, '');
2647 $self->ut_money($field);
2650 =item ut_currencyn COLUMN
2652 Check/untaint currency indicators, such as USD or EUR. May be null. If there
2653 is an error, returns the error, otherwise returns false.
2658 my($self, $field) = @_;
2659 if ($self->getfield($field) eq '') { #can be null
2660 $self->setfield($field, '');
2663 $self->ut_currency($field);
2666 =item ut_currency COLUMN
2668 Check/untaint currency indicators, such as USD or EUR. May not be null. If
2669 there is an error, returns the error, otherwise returns false.
2674 my($self, $field) = @_;
2675 my $value = uc( $self->getfield($field) );
2676 if ( code2currency($value) ) {
2677 $self->setfield($value);
2679 return "Unknown currency $value";
2685 =item ut_text COLUMN
2687 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2688 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < > ~
2689 May not be null. If there is an error, returns the error, otherwise returns
2695 my($self,$field)=@_;
2696 #warn "msgcat ". \&msgcat. "\n";
2697 #warn "notexist ". \¬exist. "\n";
2698 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2699 # \p{Word} = alphanumerics, marks (diacritics), and connectors
2700 # see perldoc perluniprops
2701 $self->getfield($field)
2702 =~ /^([\p{Word} \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>\~$money_char]+)$/
2703 or return gettext('illegal_or_empty_text'). " $field: ".
2704 $self->getfield($field);
2705 $self->setfield($field,$1);
2709 =item ut_textn COLUMN
2711 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2712 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2713 May be null. If there is an error, returns the error, otherwise returns false.
2718 my($self,$field)=@_;
2719 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2720 $self->ut_text($field);
2723 =item ut_alpha COLUMN
2725 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2726 an error, returns the error, otherwise returns false.
2731 my($self,$field)=@_;
2732 $self->getfield($field) =~ /^(\w+)$/
2733 or return "Illegal or empty (alphanumeric) $field: ".
2734 $self->getfield($field);
2735 $self->setfield($field,$1);
2739 =item ut_alphan COLUMN
2741 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2742 error, returns the error, otherwise returns false.
2747 my($self,$field)=@_;
2748 $self->getfield($field) =~ /^(\w*)$/
2749 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2750 $self->setfield($field,$1);
2754 =item ut_alphasn COLUMN
2756 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2757 an error, returns the error, otherwise returns false.
2762 my($self,$field)=@_;
2763 $self->getfield($field) =~ /^([\w ]*)$/
2764 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2765 $self->setfield($field,$1);
2770 =item ut_alpha_lower COLUMN
2772 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2773 there is an error, returns the error, otherwise returns false.
2777 sub ut_alpha_lower {
2778 my($self,$field)=@_;
2779 $self->getfield($field) =~ /[[:upper:]]/
2780 and return "Uppercase characters are not permitted in $field";
2781 $self->ut_alpha($field);
2784 =item ut_phonen COLUMN [ COUNTRY ]
2786 Check/untaint phone numbers. May be null. If there is an error, returns
2787 the error, otherwise returns false.
2789 Takes an optional two-letter ISO 3166-1 alpha-2 country code; without
2790 it or with unsupported countries, ut_phonen simply calls ut_alphan.
2795 my( $self, $field, $country ) = @_;
2796 return $self->ut_alphan($field) unless defined $country;
2797 my $phonen = $self->getfield($field);
2798 if ( $phonen eq '' ) {
2799 $self->setfield($field,'');
2800 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2802 $phonen = $conf->config('cust_main-default_areacode').$phonen
2803 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2804 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2805 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2806 $phonen = "$1-$2-$3";
2807 $phonen .= " x$4" if $4;
2808 $self->setfield($field,$phonen);
2810 warn "warning: don't know how to check phone numbers for country $country";
2811 return $self->ut_textn($field);
2818 Check/untaint hexadecimal values.
2823 my($self, $field) = @_;
2824 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2825 or return "Illegal (hex) $field: ". $self->getfield($field);
2826 $self->setfield($field, uc($1));
2830 =item ut_hexn COLUMN
2832 Check/untaint hexadecimal values. May be null.
2837 my($self, $field) = @_;
2838 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2839 or return "Illegal (hex) $field: ". $self->getfield($field);
2840 $self->setfield($field, uc($1));
2844 =item ut_mac_addr COLUMN
2846 Check/untaint mac addresses. May be null.
2851 my($self, $field) = @_;
2853 my $mac = $self->get($field);
2856 $self->set($field, $mac);
2858 my $e = $self->ut_hex($field);
2861 return "Illegal (mac address) $field: ". $self->getfield($field)
2862 unless length($self->getfield($field)) == 12;
2868 =item ut_mac_addrn COLUMN
2870 Check/untaint mac addresses. May be null.
2875 my($self, $field) = @_;
2876 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2881 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2887 my( $self, $field ) = @_;
2888 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2889 return "Illegal (IP address) $field: ".$self->getfield($field)
2890 unless $self->getfield($field) =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/;
2891 $self->ut_ip46($field);
2896 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2897 to 127.0.0.1. May be null.
2902 my( $self, $field ) = @_;
2903 if ( $self->getfield($field) =~ /^()$/ ) {
2904 $self->setfield($field,'');
2907 $self->ut_ip($field);
2911 =item ut_ip46 COLUMN
2913 Check/untaint IPv4 or IPv6 address.
2918 my( $self, $field ) = @_;
2919 my $ip = NetAddr::IP->new(
2920 $self->_ut_ip_strip_leading_zeros( $self->getfield( $field ) )
2921 ) or return "Illegal (IP address) $field: ".$self->getfield($field);
2922 $self->setfield($field, lc($ip->addr));
2928 Check/untaint IPv6 or IPv6 address. May be null.
2933 my( $self, $field ) = @_;
2934 if ( $self->getfield($field) =~ /^$/ ) {
2935 $self->setfield($field, '');
2938 $self->ut_ip46($field);
2941 sub _ut_ip_strip_leading_zeros {
2942 # strip user-entered leading 0's from IP addresses
2943 # so parsers like NetAddr::IP don't mangle the address
2944 # e.g. NetAddr::IP converts 10.0.022.220 into 10.0.18.220
2946 my ( $self, $ip ) = @_;
2948 return join '.', map int, split /\./, $ip
2956 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2958 Check/untaint coordinates.
2959 Accepts the following forms:
2969 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2970 The latter form (that is, the MMM are thousands of minutes) is
2971 assumed if the "MMM" is exactly three digits or two digits > 59.
2973 To be safe, just use the DDD.DDDDD form.
2975 If LOWER or UPPER are specified, then the coordinate is checked
2976 for lower and upper bounds, respectively.
2981 my ($self, $field) = (shift, shift);
2984 if ( $field =~ /latitude/ ) {
2985 $lower = $lat_lower;
2987 } elsif ( $field =~ /longitude/ ) {
2989 $upper = $lon_upper;
2992 my $coord = $self->getfield($field);
2993 my $neg = $coord =~ s/^(-)//;
2995 # ignore degree symbol at the end,
2996 # but not otherwise supporting degree/minutes/seconds symbols
2997 $coord =~ s/\N{DEGREE SIGN}\s*$//;
2999 my ($d, $m, $s) = (0, 0, 0);
3002 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
3003 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
3004 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
3006 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
3009 return "Invalid (coordinate with minutes > 59) $field: "
3010 . $self->getfield($field);
3013 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
3015 if (defined($lower) and ($coord < $lower)) {
3016 return "Invalid (coordinate < $lower) $field: "
3017 . $self->getfield($field);;
3020 if (defined($upper) and ($coord > $upper)) {
3021 return "Invalid (coordinate > $upper) $field: "
3022 . $self->getfield($field);;
3025 $self->setfield($field, $coord);
3029 return "Invalid (coordinate) $field: " . $self->getfield($field);
3033 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
3035 Same as ut_coord, except optionally null.
3041 my ($self, $field) = (shift, shift);
3043 if ($self->getfield($field) =~ /^\s*$/) {
3046 return $self->ut_coord($field, @_);
3051 =item ut_domain COLUMN
3053 Check/untaint host and domain names. May not be null.
3058 my( $self, $field ) = @_;
3059 #$self->getfield($field) =~/^(\w+\.)*\w+$/
3060 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
3061 or return "Illegal (hostname) $field: ". $self->getfield($field);
3062 $self->setfield($field,$1);
3066 =item ut_domainn COLUMN
3068 Check/untaint host and domain names. May be null.
3073 my( $self, $field ) = @_;
3074 if ( $self->getfield($field) =~ /^()$/ ) {
3075 $self->setfield($field,'');
3078 $self->ut_domain($field);
3082 =item ut_name COLUMN
3084 Check/untaint proper names; allows alphanumerics, spaces and the following
3085 punctuation: , . - '
3092 my( $self, $field ) = @_;
3093 $self->getfield($field) =~ /^([\p{Word} \,\.\-\']+)$/
3094 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
3099 $self->setfield($field, $name);
3103 =item ut_namen COLUMN
3105 Check/untaint proper names; allows alphanumerics, spaces and the following
3106 punctuation: , . - '
3113 my( $self, $field ) = @_;
3114 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
3115 $self->ut_name($field);
3120 Check/untaint zip codes.
3124 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
3127 my( $self, $field, $country ) = @_;
3129 if ( $country eq 'US' ) {
3131 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
3132 or return gettext('illegal_zip'). " $field for country $country: ".
3133 $self->getfield($field);
3134 $self->setfield($field, $1);
3136 } elsif ( $country eq 'CA' ) {
3138 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
3139 or return gettext('illegal_zip'). " $field for country $country: ".
3140 $self->getfield($field);
3141 $self->setfield($field, "$1 $2");
3143 } elsif ( $country eq 'AU' ) {
3145 $self->getfield($field) =~ /^\s*(\d{4})\s*$/
3146 or return gettext('illegal_zip'). " $field for country $country: ".
3147 $self->getfield($field);
3148 $self->setfield($field, $1);
3152 if ( $self->getfield($field) =~ /^\s*$/
3153 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
3156 $self->setfield($field,'');
3158 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
3159 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
3160 $self->setfield($field,$1);
3168 =item ut_country COLUMN
3170 Check/untaint country codes. Country names are changed to codes, if possible -
3171 see L<Locale::Country>.
3176 my( $self, $field ) = @_;
3177 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
3178 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
3179 && country2code($1) ) {
3180 $self->setfield($field,uc(country2code($1)));
3183 $self->getfield($field) =~ /^(\w\w)$/
3184 or return "Illegal (country) $field: ". $self->getfield($field);
3185 $self->setfield($field,uc($1));
3189 =item ut_anything COLUMN
3191 Untaints arbitrary data. Be careful.
3196 my( $self, $field ) = @_;
3197 $self->getfield($field) =~ /^(.*)$/s
3198 or return "Illegal $field: ". $self->getfield($field);
3199 $self->setfield($field,$1);
3203 =item ut_enum COLUMN CHOICES_ARRAYREF
3205 Check/untaint a column, supplying all possible choices, like the "enum" type.
3210 my( $self, $field, $choices ) = @_;
3211 foreach my $choice ( @$choices ) {
3212 if ( $self->getfield($field) eq $choice ) {
3213 $self->setfield($field, $choice);
3217 return "Illegal (enum) field $field: ". $self->getfield($field);
3220 =item ut_enumn COLUMN CHOICES_ARRAYREF
3222 Like ut_enum, except the null value is also allowed.
3227 my( $self, $field, $choices ) = @_;
3228 $self->getfield($field)
3229 ? $self->ut_enum($field, $choices)
3233 =item ut_date COLUMN
3235 Check/untaint a column containing a date string.
3237 Date will be normalized to YYYY-MM-DD format
3242 my ( $self, $field ) = @_;
3243 my $value = $self->getfield( $field );
3245 my @date = split /[\-\/]/, $value;
3246 if ( scalar(@date) == 3 ) {
3247 @date = @date[2,0,1] if $date[2] >= 1900;
3252 # DateTime will die given invalid date
3253 $ymd = DateTime->new(
3261 $self->setfield( $field, $ymd ) unless $value eq $ymd;
3266 return "Illegal (date) field $field: $value";
3269 =item ut_daten COLUMN
3271 Check/untaint a column containing a date string.
3275 Date will be normalized to YYYY-MM-DD format
3280 my ( $self, $field ) = @_;
3282 $self->getfield( $field ) =~ /^()$/
3283 ? $self->setfield( $field, '' )
3284 : $self->ut_date( $field );
3287 =item ut_flag COLUMN
3289 Check/untaint a column if it contains either an empty string or 'Y'. This
3290 is the standard form for boolean flags in Freeside.
3295 my( $self, $field ) = @_;
3296 my $value = uc($self->getfield($field));
3297 if ( $value eq '' or $value eq 'Y' ) {
3298 $self->setfield($field, $value);
3301 return "Illegal (flag) field $field: $value";
3304 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3306 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
3307 on the column first.
3311 sub ut_foreign_key {
3312 my( $self, $field, $table, $foreign ) = @_;
3313 return $self->ut_number($field) if $no_check_foreign;
3314 qsearchs($table, { $foreign => $self->getfield($field) })
3315 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
3316 " in $table.$foreign";
3320 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
3322 Like ut_foreign_key, except the null value is also allowed.
3326 sub ut_foreign_keyn {
3327 my( $self, $field, $table, $foreign ) = @_;
3328 $self->getfield($field)
3329 ? $self->ut_foreign_key($field, $table, $foreign)
3333 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
3335 Checks this column as an agentnum, taking into account the current users's
3336 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
3337 right or rights allowing no agentnum.
3341 sub ut_agentnum_acl {
3342 my( $self, $field ) = (shift, shift);
3343 my $null_acl = scalar(@_) ? shift : [];
3344 $null_acl = [ $null_acl ] unless ref($null_acl);
3346 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
3347 return "Illegal agentnum: $error" if $error;
3349 my $curuser = $FS::CurrentUser::CurrentUser;
3351 if ( $self->$field() ) {
3353 return 'Access denied to agent '. $self->$field()
3354 unless $curuser->agentnum($self->$field());
3358 return 'Access denied to global'
3359 unless grep $curuser->access_right($_), @$null_acl;
3367 =item trim_whitespace FIELD[, FIELD ... ]
3369 Strip leading and trailing spaces from the value in the named FIELD(s).
3373 sub trim_whitespace {
3375 foreach my $field (@_) {
3376 my $value = $self->get($field);
3379 $self->set($field, $value);
3383 =item fields [ TABLE ]
3385 This is a wrapper for real_fields. Code that called
3386 fields before should probably continue to call fields.
3391 my $something = shift;
3393 if($something->isa('FS::Record')) {
3394 $table = $something->table;
3396 $table = $something;
3397 #$something = "FS::$table";
3399 return (real_fields($table));
3403 =item encrypt($value)
3405 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
3407 Returns the encrypted string.
3409 You should generally not have to worry about calling this, as the system handles this for you.
3414 my ($self, $value) = @_;
3415 my $encrypted = $value;
3417 if ($conf_encryption) {
3418 if ($self->is_encrypted($value)) {
3419 # Return the original value if it isn't plaintext.
3420 $encrypted = $value;
3423 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
3424 # RSA doesn't like the empty string so let's pack it up
3425 # The database doesn't like the RSA data so uuencode it
3426 my $length = length($value)+1;
3427 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
3429 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
3436 =item is_encrypted($value)
3438 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
3444 my ($self, $value) = @_;
3445 # could be more precise about it, but this will do for now
3446 $value =~ /^M/ && length($value) > 80;
3449 =item decrypt($value)
3451 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
3453 You should generally not have to worry about calling this, as the system handles this for you.
3458 my ($self,$value) = @_;
3459 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
3460 if ($conf_encryption && $self->is_encrypted($value)) {
3462 if (ref($rsa_decrypt) =~ /::RSA/) {
3463 my $encrypted = unpack ("u*", $value);
3464 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
3465 if ($@) {warn "Decryption Failed"};
3474 my $rsa_module = $conf_encryptionmodule || 'Crypt::OpenSSL::RSA';
3476 # Initialize Encryption
3477 if ($conf_encryptionpublickey && $conf_encryptionpublickey ne '') {
3478 $rsa_encrypt = $rsa_module->new_public_key($conf_encryptionpublickey);
3481 # Intitalize Decryption
3482 if ($conf_encryptionprivatekey && $conf_encryptionprivatekey ne '') {
3483 $rsa_decrypt = $rsa_module->new_private_key($conf_encryptionprivatekey);
3487 =item h_search ACTION
3489 Given an ACTION, either "insert", or "delete", returns the appropriate history
3490 record corresponding to this record, if any.
3495 my( $self, $action ) = @_;
3497 my $table = $self->table;
3500 my $primary_key = dbdef->table($table)->primary_key;
3503 'table' => "h_$table",
3504 'hashref' => { $primary_key => $self->$primary_key(),
3505 'history_action' => $action,
3513 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3514 appropriate history record corresponding to this record, if any.
3519 my($self, $action) = @_;
3520 my $h = $self->h_search($action);
3521 $h ? $h->history_date : '';
3524 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3526 A class or object method. Executes the sql statement represented by SQL and
3527 returns a scalar representing the result: the first column of the first row.
3529 Dies on bogus SQL. Returns an empty string if no row is returned.
3531 Typically used for statments which return a single value such as "SELECT
3532 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3537 my($self, $sql) = (shift, shift);
3538 my $sth = dbh->prepare($sql) or die dbh->errstr;
3540 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3541 my $row = $sth->fetchrow_arrayref or return '';
3542 my $scalar = $row->[0];
3543 defined($scalar) ? $scalar : '';
3546 =item count [ WHERE [, PLACEHOLDER ...] ]
3548 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3549 with optional WHERE. Must be called as method on a class with an
3555 my($self, $where) = (shift, shift);
3556 my $table = $self->table or die 'count called on object of class '.ref($self);
3557 my $sql = "SELECT COUNT(*) FROM $table";
3558 $sql .= " WHERE $where" if $where;
3559 $self->scalar_sql($sql, @_);
3562 =item row_exists [ WHERE [, PLACEHOLDER ...] ]
3564 Convenience method for the common case of "SELECT 1 FROM table ... LIMIT 1"
3565 with optional (but almost always needed) WHERE.
3570 my($self, $where) = (shift, shift);
3571 my $table = $self->table or die 'row_exists called on object of class '.ref($self);
3572 my $sql = "SELECT 1 FROM $table";
3573 $sql .= " WHERE $where" if $where;
3575 $self->scalar_sql($sql, @_);
3584 =item real_fields [ TABLE ]
3586 Returns a list of the real columns in the specified table. Called only by
3587 fields() and other subroutines elsewhere in FS::Record.
3594 my($table_obj) = dbdef->table($table);
3595 confess "Unknown table $table" unless $table_obj;
3596 $table_obj->columns;
3599 =item pvf FIELD_NAME
3601 Returns the FS::part_virtual_field object corresponding to a field in the
3602 record (specified by FIELD_NAME).
3607 my ($self, $name) = (shift, shift);
3609 if(grep /^$name$/, $self->virtual_fields) {
3611 my $concat = [ "'cf_'", "name" ];
3612 return qsearchs({ table => 'part_virtual_field',
3613 hashref => { dbtable => $self->table,
3616 select => 'vfieldpart, dbtable, length, label, '.concat_sql($concat).' as name',
3622 =item _quote VALUE, TABLE, COLUMN
3624 This is an internal function used to construct SQL statements. It returns
3625 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3626 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3631 my($value, $table, $column) = @_;
3632 my $column_obj = dbdef->table($table)->column($column);
3633 my $column_type = $column_obj->type;
3634 my $nullable = $column_obj->null;
3636 utf8::upgrade($value);
3638 warn " $table.$column: $value ($column_type".
3639 ( $nullable ? ' NULL' : ' NOT NULL' ).
3640 ")\n" if $DEBUG > 2;
3642 if ( $value eq '' && $nullable ) {
3644 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3645 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3648 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3649 ! $column_type =~ /(char|binary|text)$/i ) {
3651 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3652 && driver_name eq 'Pg'
3657 eval { $value = dbh->quote($value, { pg_type => PG_BYTEA() }); };
3659 if ( $@ && $@ =~ /Wide character/i ) {
3660 warn 'Correcting malformed UTF-8 string for binary quote()'
3662 utf8::decode($value);
3663 utf8::encode($value);
3664 $value = dbh->quote($value, { pg_type => PG_BYTEA() });
3675 This is deprecated. Don't use it.
3677 It returns a hash-type list with the fields of this record's table set true.
3682 carp "warning: hfields is deprecated";
3685 foreach (fields($table)) {
3694 "$_: ". $self->getfield($_). "|"
3695 } (fields($self->table)) );
3698 sub DESTROY { return; }
3702 # #use Carp qw(cluck);
3703 # #cluck "DESTROYING $self";
3704 # warn "DESTROYING $self";
3708 # return ! eval { join('',@_), kill 0; 1; };
3711 =item str2time_sql [ DRIVER_NAME ]
3713 Returns a function to convert to unix time based on database type, such as
3714 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3715 the str2time_sql_closing method to return a closing string rather than just
3716 using a closing parenthesis as previously suggested.
3718 You can pass an optional driver name such as "Pg", "mysql" or
3719 $dbh->{Driver}->{Name} to return a function for that database instead of
3720 the current database.
3725 my $driver = shift || driver_name;
3727 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3728 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3730 warn "warning: unknown database type $driver; guessing how to convert ".
3731 "dates to UNIX timestamps";
3732 return 'EXTRACT(EPOCH FROM ';
3736 =item str2time_sql_closing [ DRIVER_NAME ]
3738 Returns the closing suffix of a function to convert to unix time based on
3739 database type, such as ")::integer" for Pg or ")" for mysql.
3741 You can pass an optional driver name such as "Pg", "mysql" or
3742 $dbh->{Driver}->{Name} to return a function for that database instead of
3743 the current database.
3747 sub str2time_sql_closing {
3748 my $driver = shift || driver_name;
3750 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3754 =item regexp_sql [ DRIVER_NAME ]
3756 Returns the operator to do a regular expression comparison based on database
3757 type, such as '~' for Pg or 'REGEXP' for mysql.
3759 You can pass an optional driver name such as "Pg", "mysql" or
3760 $dbh->{Driver}->{Name} to return a function for that database instead of
3761 the current database.
3766 my $driver = shift || driver_name;
3768 return '~' if $driver =~ /^Pg/i;
3769 return 'REGEXP' if $driver =~ /^mysql/i;
3771 die "don't know how to use regular expressions in ". driver_name." databases";
3775 =item not_regexp_sql [ DRIVER_NAME ]
3777 Returns the operator to do a regular expression negation based on database
3778 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3780 You can pass an optional driver name such as "Pg", "mysql" or
3781 $dbh->{Driver}->{Name} to return a function for that database instead of
3782 the current database.
3786 sub not_regexp_sql {
3787 my $driver = shift || driver_name;
3789 return '!~' if $driver =~ /^Pg/i;
3790 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3792 die "don't know how to use regular expressions in ". driver_name." databases";
3796 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3798 Returns the items concatenated based on database type, using "CONCAT()" for
3799 mysql and " || " for Pg and other databases.
3801 You can pass an optional driver name such as "Pg", "mysql" or
3802 $dbh->{Driver}->{Name} to return a function for that database instead of
3803 the current database.
3808 my $driver = ref($_[0]) ? driver_name : shift;
3811 if ( $driver =~ /^mysql/i ) {
3812 'CONCAT('. join(',', @$items). ')';
3814 join('||', @$items);
3819 =item group_concat_sql COLUMN, DELIMITER
3821 Returns an SQL expression to concatenate an aggregate column, using
3822 GROUP_CONCAT() for mysql and array_to_string() and array_agg() for Pg.
3826 sub group_concat_sql {
3827 my ($col, $delim) = @_;
3828 $delim = dbh->quote($delim);
3829 if ( driver_name() =~ /^mysql/i ) {
3830 # DISTINCT(foo) is valid as $col
3831 return "GROUP_CONCAT($col SEPARATOR $delim)";
3833 return "array_to_string(array_agg($col), $delim)";
3837 =item midnight_sql DATE
3839 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3840 on that day in the system timezone, using the default driver name.
3845 my $driver = driver_name;
3847 if ( $driver =~ /^mysql/i ) {
3848 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3851 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3859 This module should probably be renamed, since much of the functionality is
3860 of general use. It is not completely unlike Adapter::DBI (see below).
3862 Exported qsearch and qsearchs should be deprecated in favor of method calls
3863 (against an FS::Record object like the old search and searchs that qsearch
3864 and qsearchs were on top of.)
3866 The whole fields / hfields mess should be removed.
3868 The various WHERE clauses should be subroutined.
3870 table string should be deprecated in favor of DBIx::DBSchema::Table.
3872 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3873 true maps to the database (and WHERE clauses) would also help.
3875 The ut_ methods should ask the dbdef for a default length.
3877 ut_sqltype (like ut_varchar) should all be defined
3879 A fallback check method should be provided which uses the dbdef.
3881 The ut_money method assumes money has two decimal digits.
3883 The Pg money kludge in the new method only strips `$'.
3885 The ut_phonen method only checks US-style phone numbers.
3887 The _quote function should probably use ut_float instead of a regex.
3889 All the subroutines probably should be methods, here or elsewhere.
3891 Probably should borrow/use some dbdef methods where appropriate (like sub
3894 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3895 or allow it to be set. Working around it is ugly any way around - DBI should
3896 be fixed. (only affects RDBMS which return uppercase column names)
3898 ut_zip should take an optional country like ut_phone.
3902 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3904 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.