4 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
6 $conf $conf_encryption $money_char $lat_lower $lon_upper
8 $nowarn_identical $nowarn_classload
9 $no_update_diff $no_check_foreign
13 use Carp qw(carp cluck croak confess);
14 use Scalar::Util qw( blessed );
15 use File::CounterFile;
18 use File::Slurp qw( slurp );
19 use DBI qw(:sql_types);
20 use DBIx::DBSchema 0.38;
21 use FS::UID qw(dbh getotaker datasrc driver_name);
23 use FS::Schema qw(dbdef);
25 use FS::Msgcat qw(gettext);
26 use NetAddr::IP; # for validation
27 #use FS::Conf; #dependency loop bs, in install_callback below instead
29 use FS::part_virtual_field;
35 @encrypt_payby = qw( CARD DCRD CHEK DCHK );
37 #export dbdef for now... everything else expects to find it here
39 dbh fields hfields qsearch qsearchs dbdef jsearch
40 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql concat_sql
47 $nowarn_identical = 0;
48 $nowarn_classload = 0;
50 $no_check_foreign = 0;
58 $conf_encryption = '';
59 FS::UID->install_callback( sub {
63 $conf = FS::Conf->new;
64 $conf_encryption = $conf->exists('encryption');
65 $money_char = $conf->config('money_char') || '$';
66 my $nw_coords = $conf->exists('geocode-require_nw_coordinates');
67 $lat_lower = $nw_coords ? 1 : -90;
68 $lon_upper = $nw_coords ? -1 : 180;
70 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
72 if ( driver_name eq 'Pg' ) {
73 eval "use DBD::Pg ':pg_types'";
76 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
83 FS::Record - Database record objects
88 use FS::Record qw(dbh fields qsearch qsearchs);
90 $record = new FS::Record 'table', \%hash;
91 $record = new FS::Record 'table', { 'column' => 'value', ... };
93 $record = qsearchs FS::Record 'table', \%hash;
94 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
95 @records = qsearch FS::Record 'table', \%hash;
96 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
98 $table = $record->table;
99 $dbdef_table = $record->dbdef_table;
101 $value = $record->get('column');
102 $value = $record->getfield('column');
103 $value = $record->column;
105 $record->set( 'column' => 'value' );
106 $record->setfield( 'column' => 'value' );
107 $record->column('value');
109 %hash = $record->hash;
111 $hashref = $record->hashref;
113 $error = $record->insert;
115 $error = $record->delete;
117 $error = $new_record->replace($old_record);
119 # external use deprecated - handled by the database (at least for Pg, mysql)
120 $value = $record->unique('column');
122 $error = $record->ut_float('column');
123 $error = $record->ut_floatn('column');
124 $error = $record->ut_number('column');
125 $error = $record->ut_numbern('column');
126 $error = $record->ut_snumber('column');
127 $error = $record->ut_snumbern('column');
128 $error = $record->ut_money('column');
129 $error = $record->ut_text('column');
130 $error = $record->ut_textn('column');
131 $error = $record->ut_alpha('column');
132 $error = $record->ut_alphan('column');
133 $error = $record->ut_phonen('column');
134 $error = $record->ut_anything('column');
135 $error = $record->ut_name('column');
137 $quoted_value = _quote($value,'table','field');
140 $fields = hfields('table');
141 if ( $fields->{Field} ) { # etc.
143 @fields = fields 'table'; #as a subroutine
144 @fields = $record->fields; #as a method call
149 (Mostly) object-oriented interface to database records. Records are currently
150 implemented on top of DBI. FS::Record is intended as a base class for
151 table-specific classes to inherit from, i.e. FS::cust_main.
157 =item new [ TABLE, ] HASHREF
159 Creates a new record. It doesn't store it in the database, though. See
160 L<"insert"> for that.
162 Note that the object stores this hash reference, not a distinct copy of the
163 hash it points to. You can ask the object for a copy with the I<hash>
166 TABLE can only be omitted when a dervived class overrides the table method.
172 my $class = ref($proto) || $proto;
174 bless ($self, $class);
176 unless ( defined ( $self->table ) ) {
177 $self->{'Table'} = shift;
178 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
179 unless $nowarn_classload;
182 $self->{'Hash'} = shift;
184 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
185 $self->{'Hash'}{$field}='';
188 $self->_rebless if $self->can('_rebless');
190 $self->{'modified'} = 0;
192 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
199 my $class = ref($proto) || $proto;
201 bless ($self, $class);
203 $self->{'Table'} = shift unless defined ( $self->table );
205 my $hashref = $self->{'Hash'} = shift;
207 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
208 my $obj = $cache->cache->{$hashref->{$cache->key}};
209 $obj->_cache($hashref, $cache) if $obj->can('_cache');
212 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
219 my $class = ref($proto) || $proto;
221 bless ($self, $class);
222 if ( defined $self->table ) {
223 cluck "create constructor is deprecated, use new!";
226 croak "FS::Record::create called (not from a subclass)!";
230 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
232 Searches the database for all records matching (at least) the key/value pairs
233 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
234 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
237 The preferred usage is to pass a hash reference of named parameters:
239 @records = qsearch( {
240 'table' => 'table_name',
241 'hashref' => { 'field' => 'value'
242 'field' => { 'op' => '<',
247 #these are optional...
249 'extra_sql' => 'AND field = ? AND intfield = ?',
250 'extra_param' => [ 'value', [ 5, 'int' ] ],
251 'order_by' => 'ORDER BY something',
252 #'cache_obj' => '', #optional
253 'addl_from' => 'LEFT JOIN othtable USING ( field )',
258 Much code still uses old-style positional parameters, this is also probably
259 fine in the common case where there are only two parameters:
261 my @records = qsearch( 'table', { 'field' => 'value' } );
263 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
264 the individual PARAMS_HASHREF queries
266 ###oops, argh, FS::Record::new only lets us create database fields.
267 #Normal behaviour if SELECT is not specified is `*', as in
268 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
269 #feature where you can specify SELECT - remember, the objects returned,
270 #although blessed into the appropriate `FS::TABLE' package, will only have the
271 #fields you specify. This might have unwanted results if you then go calling
272 #regular FS::TABLE methods
277 my %TYPE = (); #for debugging
280 my($type, $value) = @_;
282 my $bind_type = { TYPE => SQL_VARCHAR };
284 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^-?\d+(\.\d+)?$/ ) {
286 $bind_type = { TYPE => SQL_INTEGER };
288 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
290 if ( driver_name eq 'Pg' ) {
292 $bind_type = { pg_type => PG_BYTEA };
294 # $bind_type = ? #SQL_VARCHAR could be fine?
297 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
298 #fixed by DBD::Pg 2.11.8
299 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
300 #(make a Tron test first)
301 } elsif ( _is_fs_float( $type, $value ) ) {
303 $bind_type = { TYPE => SQL_DECIMAL };
312 my($type, $value) = @_;
313 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
314 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
322 my( @stable, @record, @cache );
323 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
325 my %union_options = ();
326 if ( ref($_[0]) eq 'ARRAY' ) {
329 foreach my $href ( @$optlist ) {
330 push @stable, ( $href->{'table'} or die "table name is required" );
331 push @record, ( $href->{'hashref'} || {} );
332 push @select, ( $href->{'select'} || '*' );
333 push @extra_sql, ( $href->{'extra_sql'} || '' );
334 push @extra_param, ( $href->{'extra_param'} || [] );
335 push @order_by, ( $href->{'order_by'} || '' );
336 push @cache, ( $href->{'cache_obj'} || '' );
337 push @addl_from, ( $href->{'addl_from'} || '' );
338 push @debug, ( $href->{'debug'} || '' );
340 die "at least one hashref is required" unless scalar(@stable);
341 } elsif ( ref($_[0]) eq 'HASH' ) {
343 $stable[0] = $opt->{'table'} or die "table name is required";
344 $record[0] = $opt->{'hashref'} || {};
345 $select[0] = $opt->{'select'} || '*';
346 $extra_sql[0] = $opt->{'extra_sql'} || '';
347 $extra_param[0] = $opt->{'extra_param'} || [];
348 $order_by[0] = $opt->{'order_by'} || '';
349 $cache[0] = $opt->{'cache_obj'} || '';
350 $addl_from[0] = $opt->{'addl_from'} || '';
351 $debug[0] = $opt->{'debug'} || '';
362 my $cache = $cache[0];
368 foreach my $stable ( @stable ) {
369 #stop altering the caller's hashref
370 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
371 my $select = shift @select;
372 my $extra_sql = shift @extra_sql;
373 my $extra_param = shift @extra_param;
374 my $order_by = shift @order_by;
375 my $cache = shift @cache;
376 my $addl_from = shift @addl_from;
377 my $debug = shift @debug;
379 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
381 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
384 my $table = $cache ? $cache->table : $stable;
385 my $dbdef_table = dbdef->table($table)
386 or die "No schema for table $table found - ".
387 "do you need to run freeside-upgrade?";
388 my $pkey = $dbdef_table->primary_key;
390 my @real_fields = grep exists($record->{$_}), real_fields($table);
392 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
393 @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
395 cluck "warning: FS::$table not loaded; virtual fields not searchable"
396 unless $nowarn_classload;
397 @virtual_fields = ();
400 my $statement .= "SELECT $select FROM $stable";
401 $statement .= " $addl_from" if $addl_from;
402 if ( @real_fields or @virtual_fields ) {
403 $statement .= ' WHERE '. join(' AND ',
404 get_real_fields($table, $record, \@real_fields) ,
405 get_virtual_fields($table, $pkey, $record, \@virtual_fields),
409 $statement .= " $extra_sql" if defined($extra_sql);
410 $statement .= " $order_by" if defined($order_by);
412 push @statement, $statement;
414 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
418 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
421 my $value = $record->{$field};
422 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
423 $value = $value->{'value'} if ref($value);
424 my $type = dbdef->table($table)->column($field)->type;
426 my $bind_type = _bind_type($type, $value);
430 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
432 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
436 push @bind_type, $bind_type;
440 foreach my $param ( @$extra_param ) {
441 my $bind_type = { TYPE => SQL_VARCHAR };
444 $value = $param->[0];
445 my $type = $param->[1];
446 $bind_type = _bind_type($type, $value);
449 push @bind_type, $bind_type;
453 my $statement = join( ' ) UNION ( ', @statement );
454 $statement = "( $statement )" if scalar(@statement) > 1;
455 $statement .= " $union_options{order_by}" if $union_options{order_by};
457 my $sth = $dbh->prepare($statement)
458 or croak "$dbh->errstr doing $statement";
461 foreach my $value ( @value ) {
462 my $bind_type = shift @bind_type;
463 $sth->bind_param($bind++, $value, $bind_type );
466 # $sth->execute( map $record->{$_},
467 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
468 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
470 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
472 # virtual fields and blessings are nonsense in a heterogeneous UNION, right?
473 my $table = $stable[0];
475 $table = '' if grep { $_ ne $table } @stable;
476 $pkey = dbdef->table($table)->primary_key if $table;
478 my @virtual_fields = ();
479 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
480 @virtual_fields = "FS::$table"->virtual_fields;
482 cluck "warning: FS::$table not loaded; virtual fields not returned either"
483 unless $nowarn_classload;
484 @virtual_fields = ();
488 tie %result, "Tie::IxHash";
489 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
490 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
491 %result = map { $_->{$pkey}, $_ } @stuff;
493 @result{@stuff} = @stuff;
498 if ( keys(%result) and @virtual_fields ) {
500 "SELECT virtual_field.recnum, part_virtual_field.name, ".
501 "virtual_field.value ".
502 "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
503 "WHERE part_virtual_field.dbtable = '$table' AND ".
504 "virtual_field.recnum IN (".
505 join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
506 join(q!', '!, @virtual_fields) . "')";
507 warn "[debug]$me $statement\n" if $DEBUG > 1;
508 $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
509 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
511 foreach (@{ $sth->fetchall_arrayref({}) }) {
512 my $recnum = $_->{recnum};
513 my $name = $_->{name};
514 my $value = $_->{value};
515 if (exists($result{$recnum})) {
516 $result{$recnum}->{$name} = $value;
521 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
522 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
523 #derivied class didn't override new method, so this optimization is safe
526 new_or_cached( "FS::$table", { %{$_} }, $cache )
530 new( "FS::$table", { %{$_} } )
534 #okay, its been tested
535 # warn "untested code (class FS::$table uses custom new method)";
537 eval 'FS::'. $table. '->new( { %{$_} } )';
541 # Check for encrypted fields and decrypt them.
542 ## only in the local copy, not the cached object
543 if ( $conf_encryption
544 && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
545 foreach my $record (@return) {
546 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
547 next if $field eq 'payinfo'
548 && ($record->isa('FS::payinfo_transaction_Mixin')
549 || $record->isa('FS::payinfo_Mixin') )
551 && !grep { $record->payby eq $_ } @encrypt_payby;
552 # Set it directly... This may cause a problem in the future...
553 $record->setfield($field, $record->decrypt($record->getfield($field)));
558 cluck "warning: FS::$table not loaded; returning FS::Record objects"
559 unless $nowarn_classload;
561 FS::Record->new( $table, { %{$_} } );
567 ## makes this easier to read
569 sub get_virtual_fields {
573 my $virtual_fields = shift;
579 if ( ref($record->{$_}) ) {
580 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
581 if ( uc($op) eq 'ILIKE' ) {
583 $record->{$_}{'value'} = lc($record->{$_}{'value'});
584 $column = "LOWER($_)";
586 $record->{$_} = $record->{$_}{'value'};
589 # ... EXISTS ( SELECT name, value FROM part_virtual_field
591 # ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
592 # WHERE recnum = svc_acct.svcnum
593 # AND (name, value) = ('egad', 'brain') )
595 my $value = $record->{$_};
599 $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
600 "( SELECT part_virtual_field.name, virtual_field.value ".
601 "FROM part_virtual_field JOIN virtual_field ".
602 "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
603 "WHERE virtual_field.recnum = ${table}.${pkey} ".
604 "AND part_virtual_field.name = '${column}'".
606 " AND virtual_field.value ${op} '${value}'"
610 } @{ $virtual_fields } ) ;
613 sub get_real_fields {
616 my $real_fields = shift;
618 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
624 my $type = dbdef->table($table)->column($column)->type;
625 my $value = $record->{$column};
626 $value = $value->{'value'} if ref($value);
627 if ( ref($record->{$_}) ) {
628 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
629 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
630 if ( uc($op) eq 'ILIKE' ) {
632 $record->{$_}{'value'} = lc($record->{$_}{'value'});
633 $column = "LOWER($_)";
635 $record->{$_} = $record->{$_}{'value'}
638 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
640 if ( driver_name eq 'Pg' ) {
641 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
642 qq-( $column IS NULL )-;
644 qq-( $column IS NULL OR $column = '' )-;
647 qq-( $column IS NULL OR $column = "" )-;
649 } elsif ( $op eq '!=' ) {
650 if ( driver_name eq 'Pg' ) {
651 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
652 qq-( $column IS NOT NULL )-;
654 qq-( $column IS NOT NULL AND $column != '' )-;
657 qq-( $column IS NOT NULL AND $column != "" )-;
660 if ( driver_name eq 'Pg' ) {
661 qq-( $column $op '' )-;
663 qq-( $column $op "" )-;
666 } elsif ( $op eq '!=' ) {
667 qq-( $column IS NULL OR $column != ? )-;
668 #if this needs to be re-enabled, it needs to use a custom op like
669 #"APPROX=" or something (better name?, not '=', to avoid affecting other
671 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
672 # ( "$column <= ?", "$column >= ?" );
676 } @{ $real_fields } );
679 =item by_key PRIMARY_KEY_VALUE
681 This is a class method that returns the record with the given primary key
682 value. This method is only useful in FS::Record subclasses. For example:
684 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
688 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
693 my ($class, $pkey_value) = @_;
695 my $table = $class->table
696 or croak "No table for $class found";
698 my $dbdef_table = dbdef->table($table)
699 or die "No schema for table $table found - ".
700 "do you need to create it or run dbdef-create?";
701 my $pkey = $dbdef_table->primary_key
702 or die "No primary key for table $table";
704 return qsearchs($table, { $pkey => $pkey_value });
707 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
709 Experimental JOINed search method. Using this method, you can execute a
710 single SELECT spanning multiple tables, and cache the results for subsequent
711 method calls. Interface will almost definately change in an incompatible
719 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
720 my $cache = FS::SearchCache->new( $ptable, $pkey );
723 grep { !$saw{$_->getfield($pkey)}++ }
724 qsearch($table, $record, $select, $extra_sql, $cache )
728 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
730 Same as qsearch, except that if more than one record matches, it B<carp>s but
731 returns the first. If this happens, you either made a logic error in asking
732 for a single item, or your data is corrupted.
736 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
738 my(@result) = qsearch(@_);
739 cluck "warning: Multiple records in scalar search ($table)"
740 if scalar(@result) > 1;
741 #should warn more vehemently if the search was on a primary key?
742 scalar(@result) ? ($result[0]) : ();
753 Returns the table name.
758 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
765 Returns the DBIx::DBSchema::Table object for the table.
771 my($table)=$self->table;
772 dbdef->table($table);
777 Returns the primary key for the table.
783 my $pkey = $self->dbdef_table->primary_key;
786 =item get, getfield COLUMN
788 Returns the value of the column/field/key COLUMN.
793 my($self,$field) = @_;
794 # to avoid "Use of unitialized value" errors
795 if ( defined ( $self->{Hash}->{$field} ) ) {
796 $self->{Hash}->{$field};
806 =item set, setfield COLUMN, VALUE
808 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
813 my($self,$field,$value) = @_;
814 $self->{'modified'} = 1;
815 $self->{'Hash'}->{$field} = $value;
824 Returns true if the column/field/key COLUMN exists.
829 my($self,$field) = @_;
830 exists($self->{Hash}->{$field});
833 =item AUTLOADED METHODS
835 $record->column is a synonym for $record->get('column');
837 $record->column('value') is a synonym for $record->set('column','value');
844 my($field)=$AUTOLOAD;
846 if ( defined($value) ) {
847 confess "errant AUTOLOAD $field for $self (arg $value)"
848 unless blessed($self) && $self->can('setfield');
849 $self->setfield($field,$value);
851 confess "errant AUTOLOAD $field for $self (no args)"
852 unless blessed($self) && $self->can('getfield');
853 $self->getfield($field);
859 # my $field = $AUTOLOAD;
861 # if ( defined($_[1]) ) {
862 # $_[0]->setfield($field, $_[1]);
864 # $_[0]->getfield($field);
870 Returns a list of the column/value pairs, usually for assigning to a new hash.
872 To make a distinct duplicate of an FS::Record object, you can do:
874 $new = new FS::Record ( $old->table, { $old->hash } );
880 confess $self. ' -> hash: Hash attribute is undefined'
881 unless defined($self->{'Hash'});
882 %{ $self->{'Hash'} };
887 Returns a reference to the column/value hash. This may be deprecated in the
888 future; if there's a reason you can't just use the autoloaded or get/set
900 Returns true if any of this object's values have been modified with set (or via
901 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
911 =item select_for_update
913 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
918 sub select_for_update {
920 my $primary_key = $self->primary_key;
923 'table' => $self->table,
924 'hashref' => { $primary_key => $self->$primary_key() },
925 'extra_sql' => 'FOR UPDATE',
931 Locks this table with a database-driver specific lock method. This is used
932 as a mutex in order to do a duplicate search.
934 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
936 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
938 Errors are fatal; no useful return value.
940 Note: To use this method for new tables other than svc_acct and svc_phone,
941 edit freeside-upgrade and add those tables to the duplicate_lock list.
947 my $table = $self->table;
949 warn "$me locking $table table\n" if $DEBUG;
951 if ( driver_name =~ /^Pg/i ) {
953 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
956 } elsif ( driver_name =~ /^mysql/i ) {
958 dbh->do("SELECT * FROM duplicate_lock
959 WHERE lockname = '$table'
961 ) or die dbh->errstr;
965 die "unknown database ". driver_name. "; don't know how to lock table";
969 warn "$me acquired $table table lock\n" if $DEBUG;
975 Inserts this record to the database. If there is an error, returns the error,
976 otherwise returns false.
984 warn "$self -> insert" if $DEBUG;
986 my $error = $self->check;
987 return $error if $error;
989 #single-field non-null unique keys are given a value if empty
990 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
991 foreach ( $self->dbdef_table->unique_singles) {
992 next if $self->getfield($_);
993 next if $self->dbdef_table->column($_)->null eq 'NULL';
997 #and also the primary key, if the database isn't going to
998 my $primary_key = $self->dbdef_table->primary_key;
1000 if ( $primary_key ) {
1001 my $col = $self->dbdef_table->column($primary_key);
1004 uc($col->type) =~ /^(BIG)?SERIAL\d?/
1005 || ( driver_name eq 'Pg'
1006 && defined($col->default)
1007 && $col->quoted_default =~ /^nextval\(/i
1009 || ( driver_name eq 'mysql'
1010 && defined($col->local)
1011 && $col->local =~ /AUTO_INCREMENT/i
1013 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
1016 my $table = $self->table;
1018 # Encrypt before the database
1019 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
1020 && scalar( eval '@FS::'. $table . '::encrypted_fields')
1021 && $conf->exists('encryption')
1023 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1024 next if $field eq 'payinfo'
1025 && ($self->isa('FS::payinfo_transaction_Mixin')
1026 || $self->isa('FS::payinfo_Mixin') )
1028 && !grep { $self->payby eq $_ } @encrypt_payby;
1029 $saved->{$field} = $self->getfield($field);
1030 $self->setfield($field, $self->encrypt($self->getfield($field)));
1034 #false laziness w/delete
1036 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1039 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1042 my $statement = "INSERT INTO $table ";
1043 if ( @real_fields ) {
1046 join( ', ', @real_fields ).
1048 join( ', ', @values ).
1052 $statement .= 'DEFAULT VALUES';
1054 warn "[debug]$me $statement\n" if $DEBUG > 1;
1055 my $sth = dbh->prepare($statement) or return dbh->errstr;
1057 local $SIG{HUP} = 'IGNORE';
1058 local $SIG{INT} = 'IGNORE';
1059 local $SIG{QUIT} = 'IGNORE';
1060 local $SIG{TERM} = 'IGNORE';
1061 local $SIG{TSTP} = 'IGNORE';
1062 local $SIG{PIPE} = 'IGNORE';
1064 $sth->execute or return $sth->errstr;
1066 # get inserted id from the database, if applicable & needed
1067 if ( $db_seq && ! $self->getfield($primary_key) ) {
1068 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1072 if ( driver_name eq 'Pg' ) {
1074 #my $oid = $sth->{'pg_oid_status'};
1075 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1077 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1078 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1079 dbh->rollback if $FS::UID::AutoCommit;
1080 return "can't parse $table.$primary_key default value".
1081 " for sequence name: $default";
1085 my $i_sql = "SELECT currval('$sequence')";
1086 my $i_sth = dbh->prepare($i_sql) or do {
1087 dbh->rollback if $FS::UID::AutoCommit;
1090 $i_sth->execute() or do { #$i_sth->execute($oid)
1091 dbh->rollback if $FS::UID::AutoCommit;
1092 return $i_sth->errstr;
1094 $insertid = $i_sth->fetchrow_arrayref->[0];
1096 } elsif ( driver_name eq 'mysql' ) {
1098 $insertid = dbh->{'mysql_insertid'};
1099 # work around mysql_insertid being null some of the time, ala RT :/
1100 unless ( $insertid ) {
1101 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1102 "using SELECT LAST_INSERT_ID();";
1103 my $i_sql = "SELECT LAST_INSERT_ID()";
1104 my $i_sth = dbh->prepare($i_sql) or do {
1105 dbh->rollback if $FS::UID::AutoCommit;
1108 $i_sth->execute or do {
1109 dbh->rollback if $FS::UID::AutoCommit;
1110 return $i_sth->errstr;
1112 $insertid = $i_sth->fetchrow_arrayref->[0];
1117 dbh->rollback if $FS::UID::AutoCommit;
1118 return "don't know how to retreive inserted ids from ". driver_name.
1119 ", try using counterfiles (maybe run dbdef-create?)";
1123 $self->setfield($primary_key, $insertid);
1127 my @virtual_fields =
1128 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
1129 $self->virtual_fields;
1130 if (@virtual_fields) {
1131 my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
1133 my $vfieldpart = $self->vfieldpart_hashref;
1135 my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
1138 my $v_sth = dbh->prepare($v_statement) or do {
1139 dbh->rollback if $FS::UID::AutoCommit;
1143 foreach (keys(%v_values)) {
1144 $v_sth->execute($self->getfield($primary_key),
1148 dbh->rollback if $FS::UID::AutoCommit;
1149 return $v_sth->errstr;
1156 if ( defined dbdef->table('h_'. $table) ) {
1157 my $h_statement = $self->_h_statement('insert');
1158 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1159 $h_sth = dbh->prepare($h_statement) or do {
1160 dbh->rollback if $FS::UID::AutoCommit;
1166 $h_sth->execute or return $h_sth->errstr if $h_sth;
1168 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1170 # Now that it has been saved, reset the encrypted fields so that $new
1171 # can still be used.
1172 foreach my $field (keys %{$saved}) {
1173 $self->setfield($field, $saved->{$field});
1181 Depriciated (use insert instead).
1186 cluck "warning: FS::Record::add deprecated!";
1187 insert @_; #call method in this scope
1192 Delete this record from the database. If there is an error, returns the error,
1193 otherwise returns false.
1200 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1202 $self->getfield($_) eq ''
1203 #? "( $_ IS NULL OR $_ = \"\" )"
1204 ? ( driver_name eq 'Pg'
1206 : "( $_ IS NULL OR $_ = \"\" )"
1208 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1209 } ( $self->dbdef_table->primary_key )
1210 ? ( $self->dbdef_table->primary_key)
1211 : real_fields($self->table)
1213 warn "[debug]$me $statement\n" if $DEBUG > 1;
1214 my $sth = dbh->prepare($statement) or return dbh->errstr;
1217 if ( defined dbdef->table('h_'. $self->table) ) {
1218 my $h_statement = $self->_h_statement('delete');
1219 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1220 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1225 my $primary_key = $self->dbdef_table->primary_key;
1228 my $vfp = $self->vfieldpart_hashref;
1229 foreach($self->virtual_fields) {
1230 next if $self->getfield($_) eq '';
1231 unless(@del_vfields) {
1232 my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
1233 $v_sth = dbh->prepare($st) or return dbh->errstr;
1235 push @del_vfields, $_;
1238 local $SIG{HUP} = 'IGNORE';
1239 local $SIG{INT} = 'IGNORE';
1240 local $SIG{QUIT} = 'IGNORE';
1241 local $SIG{TERM} = 'IGNORE';
1242 local $SIG{TSTP} = 'IGNORE';
1243 local $SIG{PIPE} = 'IGNORE';
1245 my $rc = $sth->execute or return $sth->errstr;
1246 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1247 $h_sth->execute or return $h_sth->errstr if $h_sth;
1248 $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
1249 or return $v_sth->errstr
1250 foreach (@del_vfields);
1252 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1254 #no need to needlessly destoy the data either (causes problems actually)
1255 #undef $self; #no need to keep object!
1262 Depriciated (use delete instead).
1267 cluck "warning: FS::Record::del deprecated!";
1268 &delete(@_); #call method in this scope
1271 =item replace OLD_RECORD
1273 Replace the OLD_RECORD with this one in the database. If there is an error,
1274 returns the error, otherwise returns false.
1279 my ($new, $old) = (shift, shift);
1281 $old = $new->replace_old unless defined($old);
1283 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1285 if ( $new->can('replace_check') ) {
1286 my $error = $new->replace_check($old);
1287 return $error if $error;
1290 return "Records not in same table!" unless $new->table eq $old->table;
1292 my $primary_key = $old->dbdef_table->primary_key;
1293 return "Can't change primary key $primary_key ".
1294 'from '. $old->getfield($primary_key).
1295 ' to ' . $new->getfield($primary_key)
1297 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1299 my $error = $new->check;
1300 return $error if $error;
1302 # Encrypt for replace
1304 if ( $conf->exists('encryption')
1305 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1306 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1308 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1309 next if $field eq 'payinfo'
1310 && ($new->isa('FS::payinfo_transaction_Mixin')
1311 || $new->isa('FS::payinfo_Mixin') )
1313 && !grep { $new->payby eq $_ } @encrypt_payby;
1314 $saved->{$field} = $new->getfield($field);
1315 $new->setfield($field, $new->encrypt($new->getfield($field)));
1319 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1320 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1321 ? ($_, $new->getfield($_)) : () } $old->fields;
1323 unless (keys(%diff) || $no_update_diff ) {
1324 carp "[warning]$me ". ref($new)."->replace ".
1325 ( $primary_key ? "$primary_key ".$new->get($primary_key) : '' ).
1326 ": records identical"
1327 unless $nowarn_identical;
1331 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1333 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1334 } real_fields($old->table)
1339 if ( $old->getfield($_) eq '' ) {
1341 #false laziness w/qsearch
1342 if ( driver_name eq 'Pg' ) {
1343 my $type = $old->dbdef_table->column($_)->type;
1344 if ( $type =~ /(int|(big)?serial)/i ) {
1347 qq-( $_ IS NULL OR $_ = '' )-;
1350 qq-( $_ IS NULL OR $_ = "" )-;
1354 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1357 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1360 warn "[debug]$me $statement\n" if $DEBUG > 1;
1361 my $sth = dbh->prepare($statement) or return dbh->errstr;
1364 if ( defined dbdef->table('h_'. $old->table) ) {
1365 my $h_old_statement = $old->_h_statement('replace_old');
1366 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1367 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1373 if ( defined dbdef->table('h_'. $new->table) ) {
1374 my $h_new_statement = $new->_h_statement('replace_new');
1375 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1376 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1381 # For virtual fields we have three cases with different SQL
1382 # statements: add, replace, delete
1386 my (@add_vfields, @rep_vfields, @del_vfields);
1387 my $vfp = $old->vfieldpart_hashref;
1388 foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
1389 if($diff{$_} eq '') {
1391 unless(@del_vfields) {
1392 my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
1393 "AND vfieldpart = ?";
1394 warn "[debug]$me $st\n" if $DEBUG > 2;
1395 $v_del_sth = dbh->prepare($st) or return dbh->errstr;
1397 push @del_vfields, $_;
1398 } elsif($old->getfield($_) eq '') {
1400 unless(@add_vfields) {
1401 my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
1403 warn "[debug]$me $st\n" if $DEBUG > 2;
1404 $v_add_sth = dbh->prepare($st) or return dbh->errstr;
1406 push @add_vfields, $_;
1409 unless(@rep_vfields) {
1410 my $st = "UPDATE virtual_field SET value = ? ".
1411 "WHERE recnum = ? AND vfieldpart = ?";
1412 warn "[debug]$me $st\n" if $DEBUG > 2;
1413 $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
1415 push @rep_vfields, $_;
1419 local $SIG{HUP} = 'IGNORE';
1420 local $SIG{INT} = 'IGNORE';
1421 local $SIG{QUIT} = 'IGNORE';
1422 local $SIG{TERM} = 'IGNORE';
1423 local $SIG{TSTP} = 'IGNORE';
1424 local $SIG{PIPE} = 'IGNORE';
1426 my $rc = $sth->execute or return $sth->errstr;
1427 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1428 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1429 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1431 $v_del_sth->execute($old->getfield($primary_key),
1433 or return $v_del_sth->errstr
1434 foreach(@del_vfields);
1436 $v_add_sth->execute($new->getfield($_),
1437 $old->getfield($primary_key),
1439 or return $v_add_sth->errstr
1440 foreach(@add_vfields);
1442 $v_rep_sth->execute($new->getfield($_),
1443 $old->getfield($primary_key),
1445 or return $v_rep_sth->errstr
1446 foreach(@rep_vfields);
1448 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1450 # Now that it has been saved, reset the encrypted fields so that $new
1451 # can still be used.
1452 foreach my $field (keys %{$saved}) {
1453 $new->setfield($field, $saved->{$field});
1461 my( $self ) = shift;
1462 warn "[$me] replace called with no arguments; autoloading old record\n"
1465 my $primary_key = $self->dbdef_table->primary_key;
1466 if ( $primary_key ) {
1467 $self->by_key( $self->$primary_key() ) #this is what's returned
1468 or croak "can't find ". $self->table. ".$primary_key ".
1469 $self->$primary_key();
1471 croak $self->table. " has no primary key; pass old record as argument";
1478 Depriciated (use replace instead).
1483 cluck "warning: FS::Record::rep deprecated!";
1484 replace @_; #call method in this scope
1489 Checks virtual fields (using check_blocks). Subclasses should still provide
1490 a check method to validate real fields, foreign keys, etc., and call this
1491 method via $self->SUPER::check.
1493 (FIXME: Should this method try to make sure that it I<is> being called from
1494 a subclass's check method, to keep the current semantics as far as possible?)
1499 #confess "FS::Record::check not implemented; supply one in subclass!";
1502 foreach my $field ($self->virtual_fields) {
1503 for ($self->getfield($field)) {
1504 # See notes on check_block in FS::part_virtual_field.
1505 eval $self->pvf($field)->check_block;
1507 #this is bad, probably want to follow the stack backtrace up and see
1509 my $err = "Fatal error checking $field for $self";
1511 return "$err (see log for backtrace): $@";
1514 $self->setfield($field, $_);
1520 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1522 Processes a batch import as a queued JSRPC job
1524 JOB is an FS::queue entry.
1526 OPTIONS_HASHREF can have the following keys:
1532 Table name (required).
1536 Listref of field names for static fields. They will be given values from the
1537 PARAMS hashref and passed as a "params" hashref to batch_import.
1541 Formats hashref. Keys are field names, values are listrefs that define the
1544 Each listref value can be a column name or a code reference. Coderefs are run
1545 with the row object, data and a FS::Conf object as the three parameters.
1546 For example, this coderef does the same thing as using the "columnname" string:
1549 my( $record, $data, $conf ) = @_;
1550 $record->columnname( $data );
1553 Coderefs are run after all "column name" fields are assigned.
1557 Optional format hashref of types. Keys are field names, values are "csv",
1558 "xls" or "fixedlength". Overrides automatic determination of file type
1561 =item format_headers
1563 Optional format hashref of header lines. Keys are field names, values are 0
1564 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1567 =item format_sep_chars
1569 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1570 CSV separation character.
1572 =item format_fixedlenth_formats
1574 Optional format hashref of fixed length format defintiions. Keys are field
1575 names, values Parse::FixedLength listrefs of field definitions.
1579 Set true to default to CSV file type if the filename does not contain a
1580 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1585 PARAMS is a base64-encoded Storable string containing the POSTed data as
1586 a hash ref. It normally contains at least one field, "uploaded files",
1587 generated by /elements/file-upload.html and containing the list of uploaded
1588 files. Currently only supports a single file named "file".
1592 use Storable qw(thaw);
1595 sub process_batch_import {
1596 my($job, $opt) = ( shift, shift );
1598 my $table = $opt->{table};
1599 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1600 my %formats = %{ $opt->{formats} };
1602 my $param = thaw(decode_base64(shift));
1603 warn Dumper($param) if $DEBUG;
1605 my $files = $param->{'uploaded_files'}
1606 or die "No files provided.\n";
1608 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1610 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1611 my $file = $dir. $files{'file'};
1616 formats => \%formats,
1617 format_types => $opt->{format_types},
1618 format_headers => $opt->{format_headers},
1619 format_sep_chars => $opt->{format_sep_chars},
1620 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1621 format_xml_formats => $opt->{format_xml_formats},
1622 format_row_callbacks => $opt->{format_row_callbacks},
1627 format => $param->{format},
1628 params => { map { $_ => $param->{$_} } @pass_params },
1630 default_csv => $opt->{default_csv},
1631 postinsert_callback => $opt->{postinsert_callback},
1634 if ( $opt->{'batch_namecol'} ) {
1635 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1636 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1639 my $error = FS::Record::batch_import( \%iopt );
1643 die "$error\n" if $error;
1646 =item batch_import PARAM_HASHREF
1648 Class method for batch imports. Available params:
1654 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1660 =item format_headers
1662 =item format_sep_chars
1664 =item format_fixedlength_formats
1666 =item format_row_callbacks
1668 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1670 =item preinsert_callback
1672 =item postinsert_callback
1678 FS::queue object, will be updated with progress
1684 csv, xls, fixedlength, xml
1695 warn "$me batch_import call with params: \n". Dumper($param)
1698 my $table = $param->{table};
1700 my $job = $param->{job};
1701 my $file = $param->{file};
1702 my $params = $param->{params} || {};
1704 my( $type, $header, $sep_char, $fixedlength_format,
1705 $xml_format, $row_callback, @fields );
1707 my $postinsert_callback = '';
1708 $postinsert_callback = $param->{'postinsert_callback'}
1709 if $param->{'postinsert_callback'};
1710 my $preinsert_callback = '';
1711 $preinsert_callback = $param->{'preinsert_callback'}
1712 if $param->{'preinsert_callback'};
1714 if ( $param->{'format'} ) {
1716 my $format = $param->{'format'};
1717 my $formats = $param->{formats};
1718 die "unknown format $format" unless exists $formats->{ $format };
1720 $type = $param->{'format_types'}
1721 ? $param->{'format_types'}{ $format }
1722 : $param->{type} || 'csv';
1725 $header = $param->{'format_headers'}
1726 ? $param->{'format_headers'}{ $param->{'format'} }
1729 $sep_char = $param->{'format_sep_chars'}
1730 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1733 $fixedlength_format =
1734 $param->{'format_fixedlength_formats'}
1735 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1739 $param->{'format_xml_formats'}
1740 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1744 $param->{'format_row_callbacks'}
1745 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1748 @fields = @{ $formats->{ $format } };
1750 } elsif ( $param->{'fields'} ) {
1752 $type = ''; #infer from filename
1755 $fixedlength_format = '';
1757 @fields = @{ $param->{'fields'} };
1760 die "neither format nor fields specified";
1763 #my $file = $param->{file};
1766 if ( $file =~ /\.(\w+)$/i ) {
1770 warn "can't parse file type from filename $file; defaulting to CSV";
1774 if $param->{'default_csv'} && $type ne 'xls';
1782 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1784 if ( $type eq 'csv' ) {
1786 my %attr = ( 'binary' => 1, );
1787 $attr{sep_char} = $sep_char if $sep_char;
1788 $parser = new Text::CSV_XS \%attr;
1790 } elsif ( $type eq 'fixedlength' ) {
1792 eval "use Parse::FixedLength;";
1794 $parser = Parse::FixedLength->new($fixedlength_format);
1798 die "Unknown file type $type\n";
1801 @buffer = split(/\r?\n/, slurp($file) );
1802 splice(@buffer, 0, ($header || 0) );
1803 $count = scalar(@buffer);
1805 } elsif ( $type eq 'xls' ) {
1807 eval "use Spreadsheet::ParseExcel;";
1810 eval "use DateTime::Format::Excel;";
1811 #for now, just let the error be thrown if it is used, since only CDR
1812 # formats bill_west and troop use it, not other excel-parsing things
1815 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1817 $parser = $excel->{Worksheet}[0]; #first sheet
1819 $count = $parser->{MaxRow} || $parser->{MinRow};
1822 $row = $header || 0;
1823 } elsif ( $type eq 'xml' ) {
1825 eval "use XML::Simple;";
1827 my $xmlrow = $xml_format->{'xmlrow'};
1828 $parser = $xml_format->{'xmlkeys'};
1829 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1830 my $data = XML::Simple::XMLin(
1832 'SuppressEmpty' => '', #sets empty values to ''
1836 $rows = $rows->{$_} foreach @$xmlrow;
1837 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1838 $count = @buffer = @$rows;
1840 die "Unknown file type $type\n";
1845 local $SIG{HUP} = 'IGNORE';
1846 local $SIG{INT} = 'IGNORE';
1847 local $SIG{QUIT} = 'IGNORE';
1848 local $SIG{TERM} = 'IGNORE';
1849 local $SIG{TSTP} = 'IGNORE';
1850 local $SIG{PIPE} = 'IGNORE';
1852 my $oldAutoCommit = $FS::UID::AutoCommit;
1853 local $FS::UID::AutoCommit = 0;
1856 #my $params = $param->{params} || {};
1857 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1858 my $batch_col = $param->{'batch_keycol'};
1860 my $batch_class = 'FS::'. $param->{'batch_table'};
1861 my $batch = $batch_class->new({
1862 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1864 my $error = $batch->insert;
1866 $dbh->rollback if $oldAutoCommit;
1867 return "can't insert batch record: $error";
1869 #primary key via dbdef? (so the column names don't have to match)
1870 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1872 $params->{ $batch_col } = $batch_value;
1875 #my $job = $param->{job};
1878 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1882 if ( $type eq 'csv' ) {
1884 last unless scalar(@buffer);
1885 $line = shift(@buffer);
1887 next if $line =~ /^\s*$/; #skip empty lines
1889 $line = &{$row_callback}($line) if $row_callback;
1891 next if $line =~ /^\s*$/; #skip empty lines
1893 $parser->parse($line) or do {
1894 $dbh->rollback if $oldAutoCommit;
1895 return "can't parse: ". $parser->error_input() . " " . $parser->error_diag;
1897 @columns = $parser->fields();
1899 } elsif ( $type eq 'fixedlength' ) {
1901 last unless scalar(@buffer);
1902 $line = shift(@buffer);
1904 @columns = $parser->parse($line);
1906 } elsif ( $type eq 'xls' ) {
1908 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1909 || ! $parser->{Cells}[$row];
1911 my @row = @{ $parser->{Cells}[$row] };
1912 @columns = map $_->{Val}, @row;
1915 #warn $z++. ": $_\n" for @columns;
1917 } elsif ( $type eq 'xml' ) {
1918 # $parser = [ 'Column0Key', 'Column1Key' ... ]
1919 last unless scalar(@buffer);
1920 my $row = shift @buffer;
1921 @columns = @{ $row }{ @$parser };
1923 die "Unknown file type $type\n";
1927 my %hash = %$params;
1929 foreach my $field ( @fields ) {
1931 my $value = shift @columns;
1933 if ( ref($field) eq 'CODE' ) {
1934 #&{$field}(\%hash, $value);
1935 push @later, $field, $value;
1937 #??? $hash{$field} = $value if length($value);
1938 $hash{$field} = $value if defined($value) && length($value);
1943 #my $table = $param->{table};
1944 my $class = "FS::$table";
1946 my $record = $class->new( \%hash );
1949 while ( scalar(@later) ) {
1950 my $sub = shift @later;
1951 my $data = shift @later;
1953 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
1956 $dbh->rollback if $oldAutoCommit;
1957 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
1959 last if exists( $param->{skiprow} );
1961 next if exists( $param->{skiprow} );
1963 if ( $preinsert_callback ) {
1964 my $error = &{$preinsert_callback}($record, $param);
1966 $dbh->rollback if $oldAutoCommit;
1967 return "preinsert_callback error". ( $line ? " for $line" : '' ).
1970 next if exists $param->{skiprow} && $param->{skiprow};
1973 my $error = $record->insert;
1976 $dbh->rollback if $oldAutoCommit;
1977 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1983 if ( $postinsert_callback ) {
1984 my $error = &{$postinsert_callback}($record, $param);
1986 $dbh->rollback if $oldAutoCommit;
1987 return "postinsert_callback error". ( $line ? " for $line" : '' ).
1992 if ( $job && time - $min_sec > $last ) { #progress bar
1993 $job->update_statustext( int(100 * $imported / $count) );
1999 unless ( $imported || $param->{empty_ok} ) {
2000 $dbh->rollback if $oldAutoCommit;
2001 return "Empty file!";
2004 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
2011 my( $self, $action, $time ) = @_;
2015 my %nohistory = map { $_=>1 } $self->nohistory_fields;
2018 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
2019 real_fields($self->table);
2022 # If we're encrypting then don't store the payinfo in the history
2023 if ( $conf && $conf->exists('encryption') && $self->table ne 'banned_pay' ) {
2024 @fields = grep { $_ ne 'payinfo' } @fields;
2027 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
2029 "INSERT INTO h_". $self->table. " ( ".
2030 join(', ', qw(history_date history_user history_action), @fields ).
2032 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
2039 B<Warning>: External use is B<deprecated>.
2041 Replaces COLUMN in record with a unique number, using counters in the
2042 filesystem. Used by the B<insert> method on single-field unique columns
2043 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2044 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2046 Returns the new value.
2051 my($self,$field) = @_;
2052 my($table)=$self->table;
2054 croak "Unique called on field $field, but it is ",
2055 $self->getfield($field),
2057 if $self->getfield($field);
2059 #warn "table $table is tainted" if is_tainted($table);
2060 #warn "field $field is tainted" if is_tainted($field);
2062 my($counter) = new File::CounterFile "$table.$field",0;
2064 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
2066 # my($counter) = new File::CounterFile "$user/$table.$field",0;
2069 my $index = $counter->inc;
2070 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2072 $index =~ /^(\d*)$/;
2075 $self->setfield($field,$index);
2079 =item ut_float COLUMN
2081 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2082 null. If there is an error, returns the error, otherwise returns false.
2087 my($self,$field)=@_ ;
2088 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2089 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2090 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2091 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2092 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2093 $self->setfield($field,$1);
2096 =item ut_floatn COLUMN
2098 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2099 null. If there is an error, returns the error, otherwise returns false.
2103 #false laziness w/ut_ipn
2105 my( $self, $field ) = @_;
2106 if ( $self->getfield($field) =~ /^()$/ ) {
2107 $self->setfield($field,'');
2110 $self->ut_float($field);
2114 =item ut_sfloat COLUMN
2116 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2117 May not be null. If there is an error, returns the error, otherwise returns
2123 my($self,$field)=@_ ;
2124 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2125 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2126 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2127 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2128 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2129 $self->setfield($field,$1);
2132 =item ut_sfloatn COLUMN
2134 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2135 null. If there is an error, returns the error, otherwise returns false.
2140 my( $self, $field ) = @_;
2141 if ( $self->getfield($field) =~ /^()$/ ) {
2142 $self->setfield($field,'');
2145 $self->ut_sfloat($field);
2149 =item ut_snumber COLUMN
2151 Check/untaint signed numeric data (whole numbers). If there is an error,
2152 returns the error, otherwise returns false.
2157 my($self, $field) = @_;
2158 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2159 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2160 $self->setfield($field, "$1$2");
2164 =item ut_snumbern COLUMN
2166 Check/untaint signed numeric data (whole numbers). If there is an error,
2167 returns the error, otherwise returns false.
2172 my($self, $field) = @_;
2173 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2174 or return "Illegal (numeric) $field: ". $self->getfield($field);
2176 return "Illegal (numeric) $field: ". $self->getfield($field)
2179 $self->setfield($field, "$1$2");
2183 =item ut_number COLUMN
2185 Check/untaint simple numeric data (whole numbers). May not be null. If there
2186 is an error, returns the error, otherwise returns false.
2191 my($self,$field)=@_;
2192 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2193 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2194 $self->setfield($field,$1);
2198 =item ut_numbern COLUMN
2200 Check/untaint simple numeric data (whole numbers). May be null. If there is
2201 an error, returns the error, otherwise returns false.
2206 my($self,$field)=@_;
2207 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2208 or return "Illegal (numeric) $field: ". $self->getfield($field);
2209 $self->setfield($field,$1);
2213 =item ut_money COLUMN
2215 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2216 is an error, returns the error, otherwise returns false.
2221 my($self,$field)=@_;
2223 if ( $self->getfield($field) eq '' ) {
2224 $self->setfield($field, 0);
2225 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{1})\s*$/ ) {
2226 #handle one decimal place without barfing out
2227 $self->setfield($field, ( ($1||''). ($2||''). ($3.'0') ) || 0);
2228 } elsif ( $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/ ) {
2229 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2231 return "Illegal (money) $field: ". $self->getfield($field);
2237 =item ut_moneyn COLUMN
2239 Check/untaint monetary numbers. May be negative. If there
2240 is an error, returns the error, otherwise returns false.
2245 my($self,$field)=@_;
2246 if ($self->getfield($field) eq '') {
2247 $self->setfield($field, '');
2250 $self->ut_money($field);
2253 =item ut_text COLUMN
2255 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2256 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2257 May not be null. If there is an error, returns the error, otherwise returns
2263 my($self,$field)=@_;
2264 #warn "msgcat ". \&msgcat. "\n";
2265 #warn "notexist ". \¬exist. "\n";
2266 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2267 $self->getfield($field)
2268 =~ /^([\wô \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>$money_char]+)$/
2269 or return gettext('illegal_or_empty_text'). " $field: ".
2270 $self->getfield($field);
2271 $self->setfield($field,$1);
2275 =item ut_textn COLUMN
2277 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2278 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2279 May be null. If there is an error, returns the error, otherwise returns false.
2284 my($self,$field)=@_;
2285 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2286 $self->ut_text($field);
2289 =item ut_alpha COLUMN
2291 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2292 an error, returns the error, otherwise returns false.
2297 my($self,$field)=@_;
2298 $self->getfield($field) =~ /^(\w+)$/
2299 or return "Illegal or empty (alphanumeric) $field: ".
2300 $self->getfield($field);
2301 $self->setfield($field,$1);
2305 =item ut_alphan COLUMN
2307 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2308 error, returns the error, otherwise returns false.
2313 my($self,$field)=@_;
2314 $self->getfield($field) =~ /^(\w*)$/
2315 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2316 $self->setfield($field,$1);
2320 =item ut_alphasn COLUMN
2322 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2323 an error, returns the error, otherwise returns false.
2328 my($self,$field)=@_;
2329 $self->getfield($field) =~ /^([\w ]*)$/
2330 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2331 $self->setfield($field,$1);
2336 =item ut_alpha_lower COLUMN
2338 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2339 there is an error, returns the error, otherwise returns false.
2343 sub ut_alpha_lower {
2344 my($self,$field)=@_;
2345 $self->getfield($field) =~ /[[:upper:]]/
2346 and return "Uppercase characters are not permitted in $field";
2347 $self->ut_alpha($field);
2350 =item ut_phonen COLUMN [ COUNTRY ]
2352 Check/untaint phone numbers. May be null. If there is an error, returns
2353 the error, otherwise returns false.
2355 Takes an optional two-letter ISO country code; without it or with unsupported
2356 countries, ut_phonen simply calls ut_alphan.
2361 my( $self, $field, $country ) = @_;
2362 return $self->ut_alphan($field) unless defined $country;
2363 my $phonen = $self->getfield($field);
2364 if ( $phonen eq '' ) {
2365 $self->setfield($field,'');
2366 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2368 $phonen = $conf->config('cust_main-default_areacode').$phonen
2369 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2370 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2371 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2372 $phonen = "$1-$2-$3";
2373 $phonen .= " x$4" if $4;
2374 $self->setfield($field,$phonen);
2376 warn "warning: don't know how to check phone numbers for country $country";
2377 return $self->ut_textn($field);
2384 Check/untaint hexadecimal values.
2389 my($self, $field) = @_;
2390 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2391 or return "Illegal (hex) $field: ". $self->getfield($field);
2392 $self->setfield($field, uc($1));
2396 =item ut_hexn COLUMN
2398 Check/untaint hexadecimal values. May be null.
2403 my($self, $field) = @_;
2404 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2405 or return "Illegal (hex) $field: ". $self->getfield($field);
2406 $self->setfield($field, uc($1));
2410 =item ut_mac_addr COLUMN
2412 Check/untaint mac addresses. May be null.
2417 my($self, $field) = @_;
2419 my $mac = $self->get($field);
2422 $self->set($field, $mac);
2424 my $e = $self->ut_hex($field);
2427 return "Illegal (mac address) $field: ". $self->getfield($field)
2428 unless length($self->getfield($field)) == 12;
2434 =item ut_mac_addrn COLUMN
2436 Check/untaint mac addresses. May be null.
2441 my($self, $field) = @_;
2442 ($self->getfield($field) eq '') ? '' : $self->ut_mac_addr($field);
2447 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2453 my( $self, $field ) = @_;
2454 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2455 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2456 or return "Illegal (IP address) $field: ". $self->getfield($field);
2457 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2458 $self->setfield($field, "$1.$2.$3.$4");
2464 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2465 to 127.0.0.1. May be null.
2470 my( $self, $field ) = @_;
2471 if ( $self->getfield($field) =~ /^()$/ ) {
2472 $self->setfield($field,'');
2475 $self->ut_ip($field);
2479 =item ut_ip46 COLUMN
2481 Check/untaint IPv4 or IPv6 address.
2486 my( $self, $field ) = @_;
2487 my $ip = NetAddr::IP->new($self->getfield($field))
2488 or return "Illegal (IP address) $field: ".$self->getfield($field);
2489 $self->setfield($field, lc($ip->addr));
2495 Check/untaint IPv6 or IPv6 address. May be null.
2500 my( $self, $field ) = @_;
2501 if ( $self->getfield($field) =~ /^$/ ) {
2502 $self->setfield($field, '');
2505 $self->ut_ip46($field);
2508 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2510 Check/untaint coordinates.
2511 Accepts the following forms:
2521 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2522 The latter form (that is, the MMM are thousands of minutes) is
2523 assumed if the "MMM" is exactly three digits or two digits > 59.
2525 To be safe, just use the DDD.DDDDD form.
2527 If LOWER or UPPER are specified, then the coordinate is checked
2528 for lower and upper bounds, respectively.
2533 my ($self, $field) = (shift, shift);
2536 if ( $field =~ /latitude/ ) {
2537 $lower = $lat_lower;
2539 } elsif ( $field =~ /longitude/ ) {
2541 $upper = $lon_upper;
2544 my $coord = $self->getfield($field);
2545 my $neg = $coord =~ s/^(-)//;
2547 my ($d, $m, $s) = (0, 0, 0);
2550 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2551 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2552 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2554 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2557 return "Invalid (coordinate with minutes > 59) $field: "
2558 . $self->getfield($field);
2561 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2563 if (defined($lower) and ($coord < $lower)) {
2564 return "Invalid (coordinate < $lower) $field: "
2565 . $self->getfield($field);;
2568 if (defined($upper) and ($coord > $upper)) {
2569 return "Invalid (coordinate > $upper) $field: "
2570 . $self->getfield($field);;
2573 $self->setfield($field, $coord);
2577 return "Invalid (coordinate) $field: " . $self->getfield($field);
2581 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2583 Same as ut_coord, except optionally null.
2589 my ($self, $field) = (shift, shift);
2591 if ($self->getfield($field) =~ /^\s*$/) {
2594 return $self->ut_coord($field, @_);
2600 =item ut_domain COLUMN
2602 Check/untaint host and domain names.
2607 my( $self, $field ) = @_;
2608 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2609 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2610 or return "Illegal (domain) $field: ". $self->getfield($field);
2611 $self->setfield($field,$1);
2615 =item ut_name COLUMN
2617 Check/untaint proper names; allows alphanumerics, spaces and the following
2618 punctuation: , . - '
2625 my( $self, $field ) = @_;
2626 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2627 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2628 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2633 $self->setfield($field, $name);
2637 =item ut_namen COLUMN
2639 Check/untaint proper names; allows alphanumerics, spaces and the following
2640 punctuation: , . - '
2647 my( $self, $field ) = @_;
2648 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2649 $self->ut_name($field);
2654 Check/untaint zip codes.
2658 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2661 my( $self, $field, $country ) = @_;
2663 if ( $country eq 'US' ) {
2665 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2666 or return gettext('illegal_zip'). " $field for country $country: ".
2667 $self->getfield($field);
2668 $self->setfield($field, $1);
2670 } elsif ( $country eq 'CA' ) {
2672 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2673 or return gettext('illegal_zip'). " $field for country $country: ".
2674 $self->getfield($field);
2675 $self->setfield($field, "$1 $2");
2679 if ( $self->getfield($field) =~ /^\s*$/
2680 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2683 $self->setfield($field,'');
2685 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{0,8}\w)\s*$/
2686 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2687 $self->setfield($field,$1);
2695 =item ut_country COLUMN
2697 Check/untaint country codes. Country names are changed to codes, if possible -
2698 see L<Locale::Country>.
2703 my( $self, $field ) = @_;
2704 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2705 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2706 && country2code($1) ) {
2707 $self->setfield($field,uc(country2code($1)));
2710 $self->getfield($field) =~ /^(\w\w)$/
2711 or return "Illegal (country) $field: ". $self->getfield($field);
2712 $self->setfield($field,uc($1));
2716 =item ut_anything COLUMN
2718 Untaints arbitrary data. Be careful.
2723 my( $self, $field ) = @_;
2724 $self->getfield($field) =~ /^(.*)$/s
2725 or return "Illegal $field: ". $self->getfield($field);
2726 $self->setfield($field,$1);
2730 =item ut_enum COLUMN CHOICES_ARRAYREF
2732 Check/untaint a column, supplying all possible choices, like the "enum" type.
2737 my( $self, $field, $choices ) = @_;
2738 foreach my $choice ( @$choices ) {
2739 if ( $self->getfield($field) eq $choice ) {
2740 $self->setfield($field, $choice);
2744 return "Illegal (enum) field $field: ". $self->getfield($field);
2747 =item ut_enumn COLUMN CHOICES_ARRAYREF
2749 Like ut_enum, except the null value is also allowed.
2754 my( $self, $field, $choices ) = @_;
2755 $self->getfield($field)
2756 ? $self->ut_enum($field, $choices)
2761 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2763 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2764 on the column first.
2768 sub ut_foreign_key {
2769 my( $self, $field, $table, $foreign ) = @_;
2770 return '' if $no_check_foreign;
2771 qsearchs($table, { $foreign => $self->getfield($field) })
2772 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2773 " in $table.$foreign";
2777 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2779 Like ut_foreign_key, except the null value is also allowed.
2783 sub ut_foreign_keyn {
2784 my( $self, $field, $table, $foreign ) = @_;
2785 $self->getfield($field)
2786 ? $self->ut_foreign_key($field, $table, $foreign)
2790 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2792 Checks this column as an agentnum, taking into account the current users's
2793 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2794 right or rights allowing no agentnum.
2798 sub ut_agentnum_acl {
2799 my( $self, $field ) = (shift, shift);
2800 my $null_acl = scalar(@_) ? shift : [];
2801 $null_acl = [ $null_acl ] unless ref($null_acl);
2803 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2804 return "Illegal agentnum: $error" if $error;
2806 my $curuser = $FS::CurrentUser::CurrentUser;
2808 if ( $self->$field() ) {
2810 return "Access denied"
2811 unless $curuser->agentnum($self->$field());
2815 return "Access denied"
2816 unless grep $curuser->access_right($_), @$null_acl;
2824 =item virtual_fields [ TABLE ]
2826 Returns a list of virtual fields defined for the table. This should not
2827 be exported, and should only be called as an instance or class method.
2831 sub virtual_fields {
2834 $table = $self->table or confess "virtual_fields called on non-table";
2836 confess "Unknown table $table" unless dbdef->table($table);
2838 return () unless dbdef->table('part_virtual_field');
2840 unless ( $virtual_fields_cache{$table} ) {
2841 my $query = 'SELECT name from part_virtual_field ' .
2842 "WHERE dbtable = '$table'";
2844 my $result = $dbh->selectcol_arrayref($query);
2845 confess "Error executing virtual fields query: $query: ". $dbh->errstr
2847 $virtual_fields_cache{$table} = $result;
2850 @{$virtual_fields_cache{$table}};
2855 =item fields [ TABLE ]
2857 This is a wrapper for real_fields and virtual_fields. Code that called
2858 fields before should probably continue to call fields.
2863 my $something = shift;
2865 if($something->isa('FS::Record')) {
2866 $table = $something->table;
2868 $table = $something;
2869 $something = "FS::$table";
2871 return (real_fields($table), $something->virtual_fields());
2874 =item pvf FIELD_NAME
2876 Returns the FS::part_virtual_field object corresponding to a field in the
2877 record (specified by FIELD_NAME).
2882 my ($self, $name) = (shift, shift);
2884 if(grep /^$name$/, $self->virtual_fields) {
2885 return qsearchs('part_virtual_field', { dbtable => $self->table,
2891 =item vfieldpart_hashref TABLE
2893 Returns a hashref of virtual field names and vfieldparts applicable to the given
2898 sub vfieldpart_hashref {
2900 my $table = $self->table;
2902 return {} unless dbdef->table('part_virtual_field');
2905 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
2906 "dbtable = '$table'";
2907 my $sth = $dbh->prepare($statement);
2908 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
2909 return { map { $_->{name}, $_->{vfieldpart} }
2910 @{$sth->fetchall_arrayref({})} };
2914 =item encrypt($value)
2916 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2918 Returns the encrypted string.
2920 You should generally not have to worry about calling this, as the system handles this for you.
2925 my ($self, $value) = @_;
2928 if ($conf->exists('encryption')) {
2929 if ($self->is_encrypted($value)) {
2930 # Return the original value if it isn't plaintext.
2931 $encrypted = $value;
2934 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2935 # RSA doesn't like the empty string so let's pack it up
2936 # The database doesn't like the RSA data so uuencode it
2937 my $length = length($value)+1;
2938 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2940 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2947 =item is_encrypted($value)
2949 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2955 my ($self, $value) = @_;
2956 # Possible Bug - Some work may be required here....
2958 if ($value =~ /^M/ && length($value) > 80) {
2965 =item decrypt($value)
2967 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2969 You should generally not have to worry about calling this, as the system handles this for you.
2974 my ($self,$value) = @_;
2975 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2976 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2978 if (ref($rsa_decrypt) =~ /::RSA/) {
2979 my $encrypted = unpack ("u*", $value);
2980 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2981 if ($@) {warn "Decryption Failed"};
2989 #Initialize the Module
2990 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2992 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2993 $rsa_module = $conf->config('encryptionmodule');
2997 eval ("require $rsa_module"); # No need to import the namespace
3000 # Initialize Encryption
3001 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
3002 my $public_key = join("\n",$conf->config('encryptionpublickey'));
3003 $rsa_encrypt = $rsa_module->new_public_key($public_key);
3006 # Intitalize Decryption
3007 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
3008 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
3009 $rsa_decrypt = $rsa_module->new_private_key($private_key);
3013 =item h_search ACTION
3015 Given an ACTION, either "insert", or "delete", returns the appropriate history
3016 record corresponding to this record, if any.
3021 my( $self, $action ) = @_;
3023 my $table = $self->table;
3026 my $primary_key = dbdef->table($table)->primary_key;
3029 'table' => "h_$table",
3030 'hashref' => { $primary_key => $self->$primary_key(),
3031 'history_action' => $action,
3039 Given an ACTION, either "insert", or "delete", returns the timestamp of the
3040 appropriate history record corresponding to this record, if any.
3045 my($self, $action) = @_;
3046 my $h = $self->h_search($action);
3047 $h ? $h->history_date : '';
3050 =item scalar_sql SQL [ PLACEHOLDER, ... ]
3052 A class or object method. Executes the sql statement represented by SQL and
3053 returns a scalar representing the result: the first column of the first row.
3055 Dies on bogus SQL. Returns an empty string if no row is returned.
3057 Typically used for statments which return a single value such as "SELECT
3058 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
3063 my($self, $sql) = (shift, shift);
3064 my $sth = dbh->prepare($sql) or die dbh->errstr;
3066 or die "Unexpected error executing statement $sql: ". $sth->errstr;
3067 my $row = $sth->fetchrow_arrayref or return '';
3068 my $scalar = $row->[0];
3069 defined($scalar) ? $scalar : '';
3072 =item count [ WHERE ]
3074 Convenience method for the common case of "SELECT COUNT(*) FROM table",
3075 with optional WHERE. Must be called as method on a class with an
3081 my($self, $where) = (shift, shift);
3082 my $table = $self->table or die 'count called on object of class '.ref($self);
3083 my $sql = "SELECT COUNT(*) FROM $table";
3084 $sql .= " WHERE $where" if $where;
3085 $self->scalar_sql($sql);
3094 =item real_fields [ TABLE ]
3096 Returns a list of the real columns in the specified table. Called only by
3097 fields() and other subroutines elsewhere in FS::Record.
3104 my($table_obj) = dbdef->table($table);
3105 confess "Unknown table $table" unless $table_obj;
3106 $table_obj->columns;
3109 =item _quote VALUE, TABLE, COLUMN
3111 This is an internal function used to construct SQL statements. It returns
3112 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
3113 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
3118 my($value, $table, $column) = @_;
3119 my $column_obj = dbdef->table($table)->column($column);
3120 my $column_type = $column_obj->type;
3121 my $nullable = $column_obj->null;
3123 warn " $table.$column: $value ($column_type".
3124 ( $nullable ? ' NULL' : ' NOT NULL' ).
3125 ")\n" if $DEBUG > 2;
3127 if ( $value eq '' && $nullable ) {
3129 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
3130 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
3133 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
3134 ! $column_type =~ /(char|binary|text)$/i ) {
3136 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
3137 && driver_name eq 'Pg'
3141 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3142 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3143 # single-quote the whole mess, and put an "E" in front.
3144 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3152 This is deprecated. Don't use it.
3154 It returns a hash-type list with the fields of this record's table set true.
3159 carp "warning: hfields is deprecated";
3162 foreach (fields($table)) {
3171 "$_: ". $self->getfield($_). "|"
3172 } (fields($self->table)) );
3175 sub DESTROY { return; }
3179 # #use Carp qw(cluck);
3180 # #cluck "DESTROYING $self";
3181 # warn "DESTROYING $self";
3185 # return ! eval { join('',@_), kill 0; 1; };
3188 =item str2time_sql [ DRIVER_NAME ]
3190 Returns a function to convert to unix time based on database type, such as
3191 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3192 the str2time_sql_closing method to return a closing string rather than just
3193 using a closing parenthesis as previously suggested.
3195 You can pass an optional driver name such as "Pg", "mysql" or
3196 $dbh->{Driver}->{Name} to return a function for that database instead of
3197 the current database.
3202 my $driver = shift || driver_name;
3204 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3205 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3207 warn "warning: unknown database type $driver; guessing how to convert ".
3208 "dates to UNIX timestamps";
3209 return 'EXTRACT(EPOCH FROM ';
3213 =item str2time_sql_closing [ DRIVER_NAME ]
3215 Returns the closing suffix of a function to convert to unix time based on
3216 database type, such as ")::integer" for Pg or ")" for mysql.
3218 You can pass an optional driver name such as "Pg", "mysql" or
3219 $dbh->{Driver}->{Name} to return a function for that database instead of
3220 the current database.
3224 sub str2time_sql_closing {
3225 my $driver = shift || driver_name;
3227 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3231 =item regexp_sql [ DRIVER_NAME ]
3233 Returns the operator to do a regular expression comparison based on database
3234 type, such as '~' for Pg or 'REGEXP' for mysql.
3236 You can pass an optional driver name such as "Pg", "mysql" or
3237 $dbh->{Driver}->{Name} to return a function for that database instead of
3238 the current database.
3243 my $driver = shift || driver_name;
3245 return '~' if $driver =~ /^Pg/i;
3246 return 'REGEXP' if $driver =~ /^mysql/i;
3248 die "don't know how to use regular expressions in ". driver_name." databases";
3252 =item not_regexp_sql [ DRIVER_NAME ]
3254 Returns the operator to do a regular expression negation based on database
3255 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3257 You can pass an optional driver name such as "Pg", "mysql" or
3258 $dbh->{Driver}->{Name} to return a function for that database instead of
3259 the current database.
3263 sub not_regexp_sql {
3264 my $driver = shift || driver_name;
3266 return '!~' if $driver =~ /^Pg/i;
3267 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3269 die "don't know how to use regular expressions in ". driver_name." databases";
3273 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3275 Returns the items concatenated based on database type, using "CONCAT()" for
3276 mysql and " || " for Pg and other databases.
3278 You can pass an optional driver name such as "Pg", "mysql" or
3279 $dbh->{Driver}->{Name} to return a function for that database instead of
3280 the current database.
3285 my $driver = ref($_[0]) ? driver_name : shift;
3288 if ( $driver =~ /^mysql/i ) {
3289 'CONCAT('. join(',', @$items). ')';
3291 join('||', @$items);
3296 =item midnight_sql DATE
3298 Returns an SQL expression to convert DATE (a unix timestamp) to midnight
3299 on that day in the system timezone, using the default driver name.
3304 my $driver = driver_name;
3306 if ( $driver =~ /^mysql/i ) {
3307 "UNIX_TIMESTAMP(DATE(FROM_UNIXTIME($expr)))";
3310 "EXTRACT( EPOCH FROM DATE(TO_TIMESTAMP($expr)) )";
3318 This module should probably be renamed, since much of the functionality is
3319 of general use. It is not completely unlike Adapter::DBI (see below).
3321 Exported qsearch and qsearchs should be deprecated in favor of method calls
3322 (against an FS::Record object like the old search and searchs that qsearch
3323 and qsearchs were on top of.)
3325 The whole fields / hfields mess should be removed.
3327 The various WHERE clauses should be subroutined.
3329 table string should be deprecated in favor of DBIx::DBSchema::Table.
3331 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3332 true maps to the database (and WHERE clauses) would also help.
3334 The ut_ methods should ask the dbdef for a default length.
3336 ut_sqltype (like ut_varchar) should all be defined
3338 A fallback check method should be provided which uses the dbdef.
3340 The ut_money method assumes money has two decimal digits.
3342 The Pg money kludge in the new method only strips `$'.
3344 The ut_phonen method only checks US-style phone numbers.
3346 The _quote function should probably use ut_float instead of a regex.
3348 All the subroutines probably should be methods, here or elsewhere.
3350 Probably should borrow/use some dbdef methods where appropriate (like sub
3353 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3354 or allow it to be set. Working around it is ugly any way around - DBI should
3355 be fixed. (only affects RDBMS which return uppercase column names)
3357 ut_zip should take an optional country like ut_phone.
3361 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3363 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.