4 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
5 $conf $conf_encryption $me
7 $nowarn_identical $nowarn_classload
8 $no_update_diff $no_check_foreign
11 use Carp qw(carp cluck croak confess);
12 use Scalar::Util qw( blessed );
13 use File::CounterFile;
16 use File::Slurp qw( slurp );
17 use DBI qw(:sql_types);
18 use DBIx::DBSchema 0.38;
19 use FS::UID qw(dbh getotaker datasrc driver_name);
21 use FS::Schema qw(dbdef);
23 use FS::Msgcat qw(gettext);
24 use NetAddr::IP; # for validation
25 #use FS::Conf; #dependency loop bs, in install_callback below instead
27 use FS::part_virtual_field;
33 #export dbdef for now... everything else expects to find it here
35 dbh fields hfields qsearch qsearchs dbdef jsearch
36 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql concat_sql
42 $nowarn_identical = 0;
43 $nowarn_classload = 0;
45 $no_check_foreign = 0;
53 $conf_encryption = '';
54 FS::UID->install_callback( sub {
57 $conf = FS::Conf->new;
58 $conf_encryption = $conf->exists('encryption');
59 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
60 if ( driver_name eq 'Pg' ) {
61 eval "use DBD::Pg ':pg_types'";
64 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
70 FS::Record - Database record objects
75 use FS::Record qw(dbh fields qsearch qsearchs);
77 $record = new FS::Record 'table', \%hash;
78 $record = new FS::Record 'table', { 'column' => 'value', ... };
80 $record = qsearchs FS::Record 'table', \%hash;
81 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
82 @records = qsearch FS::Record 'table', \%hash;
83 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
85 $table = $record->table;
86 $dbdef_table = $record->dbdef_table;
88 $value = $record->get('column');
89 $value = $record->getfield('column');
90 $value = $record->column;
92 $record->set( 'column' => 'value' );
93 $record->setfield( 'column' => 'value' );
94 $record->column('value');
96 %hash = $record->hash;
98 $hashref = $record->hashref;
100 $error = $record->insert;
102 $error = $record->delete;
104 $error = $new_record->replace($old_record);
106 # external use deprecated - handled by the database (at least for Pg, mysql)
107 $value = $record->unique('column');
109 $error = $record->ut_float('column');
110 $error = $record->ut_floatn('column');
111 $error = $record->ut_number('column');
112 $error = $record->ut_numbern('column');
113 $error = $record->ut_snumber('column');
114 $error = $record->ut_snumbern('column');
115 $error = $record->ut_money('column');
116 $error = $record->ut_text('column');
117 $error = $record->ut_textn('column');
118 $error = $record->ut_alpha('column');
119 $error = $record->ut_alphan('column');
120 $error = $record->ut_phonen('column');
121 $error = $record->ut_anything('column');
122 $error = $record->ut_name('column');
124 $quoted_value = _quote($value,'table','field');
127 $fields = hfields('table');
128 if ( $fields->{Field} ) { # etc.
130 @fields = fields 'table'; #as a subroutine
131 @fields = $record->fields; #as a method call
136 (Mostly) object-oriented interface to database records. Records are currently
137 implemented on top of DBI. FS::Record is intended as a base class for
138 table-specific classes to inherit from, i.e. FS::cust_main.
144 =item new [ TABLE, ] HASHREF
146 Creates a new record. It doesn't store it in the database, though. See
147 L<"insert"> for that.
149 Note that the object stores this hash reference, not a distinct copy of the
150 hash it points to. You can ask the object for a copy with the I<hash>
153 TABLE can only be omitted when a dervived class overrides the table method.
159 my $class = ref($proto) || $proto;
161 bless ($self, $class);
163 unless ( defined ( $self->table ) ) {
164 $self->{'Table'} = shift;
165 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
166 unless $nowarn_classload;
169 $self->{'Hash'} = shift;
171 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
172 $self->{'Hash'}{$field}='';
175 $self->_rebless if $self->can('_rebless');
177 $self->{'modified'} = 0;
179 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
186 my $class = ref($proto) || $proto;
188 bless ($self, $class);
190 $self->{'Table'} = shift unless defined ( $self->table );
192 my $hashref = $self->{'Hash'} = shift;
194 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
195 my $obj = $cache->cache->{$hashref->{$cache->key}};
196 $obj->_cache($hashref, $cache) if $obj->can('_cache');
199 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
206 my $class = ref($proto) || $proto;
208 bless ($self, $class);
209 if ( defined $self->table ) {
210 cluck "create constructor is deprecated, use new!";
213 croak "FS::Record::create called (not from a subclass)!";
217 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
219 Searches the database for all records matching (at least) the key/value pairs
220 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
221 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
224 The preferred usage is to pass a hash reference of named parameters:
226 @records = qsearch( {
227 'table' => 'table_name',
228 'hashref' => { 'field' => 'value'
229 'field' => { 'op' => '<',
234 #these are optional...
236 'extra_sql' => 'AND field = ? AND intfield = ?',
237 'extra_param' => [ 'value', [ 5, 'int' ] ],
238 'order_by' => 'ORDER BY something',
239 #'cache_obj' => '', #optional
240 'addl_from' => 'LEFT JOIN othtable USING ( field )',
245 Much code still uses old-style positional parameters, this is also probably
246 fine in the common case where there are only two parameters:
248 my @records = qsearch( 'table', { 'field' => 'value' } );
250 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
251 the individual PARAMS_HASHREF queries
253 ###oops, argh, FS::Record::new only lets us create database fields.
254 #Normal behaviour if SELECT is not specified is `*', as in
255 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
256 #feature where you can specify SELECT - remember, the objects returned,
257 #although blessed into the appropriate `FS::TABLE' package, will only have the
258 #fields you specify. This might have unwanted results if you then go calling
259 #regular FS::TABLE methods
264 my %TYPE = (); #for debugging
267 my($type, $value) = @_;
269 my $bind_type = { TYPE => SQL_VARCHAR };
271 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^\d+(\.\d+)?$/ ) {
273 $bind_type = { TYPE => SQL_INTEGER };
275 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
277 if ( driver_name eq 'Pg' ) {
279 $bind_type = { pg_type => PG_BYTEA };
281 # $bind_type = ? #SQL_VARCHAR could be fine?
284 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
285 #fixed by DBD::Pg 2.11.8
286 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
287 #(make a Tron test first)
288 } elsif ( _is_fs_float( $type, $value ) ) {
290 $bind_type = { TYPE => SQL_DECIMAL };
299 my($type, $value) = @_;
300 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
301 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
309 my( @stable, @record, @cache );
310 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
312 my %union_options = ();
313 if ( ref($_[0]) eq 'ARRAY' ) {
316 foreach my $href ( @$optlist ) {
317 push @stable, ( $href->{'table'} or die "table name is required" );
318 push @record, ( $href->{'hashref'} || {} );
319 push @select, ( $href->{'select'} || '*' );
320 push @extra_sql, ( $href->{'extra_sql'} || '' );
321 push @extra_param, ( $href->{'extra_param'} || [] );
322 push @order_by, ( $href->{'order_by'} || '' );
323 push @cache, ( $href->{'cache_obj'} || '' );
324 push @addl_from, ( $href->{'addl_from'} || '' );
325 push @debug, ( $href->{'debug'} || '' );
327 die "at least one hashref is required" unless scalar(@stable);
328 } elsif ( ref($_[0]) eq 'HASH' ) {
330 $stable[0] = $opt->{'table'} or die "table name is required";
331 $record[0] = $opt->{'hashref'} || {};
332 $select[0] = $opt->{'select'} || '*';
333 $extra_sql[0] = $opt->{'extra_sql'} || '';
334 $extra_param[0] = $opt->{'extra_param'} || [];
335 $order_by[0] = $opt->{'order_by'} || '';
336 $cache[0] = $opt->{'cache_obj'} || '';
337 $addl_from[0] = $opt->{'addl_from'} || '';
338 $debug[0] = $opt->{'debug'} || '';
349 my $cache = $cache[0];
355 foreach my $stable ( @stable ) {
356 #stop altering the caller's hashref
357 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
358 my $select = shift @select;
359 my $extra_sql = shift @extra_sql;
360 my $extra_param = shift @extra_param;
361 my $order_by = shift @order_by;
362 my $cache = shift @cache;
363 my $addl_from = shift @addl_from;
364 my $debug = shift @debug;
366 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
368 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
371 my $table = $cache ? $cache->table : $stable;
372 my $dbdef_table = dbdef->table($table)
373 or die "No schema for table $table found - ".
374 "do you need to run freeside-upgrade?";
375 my $pkey = $dbdef_table->primary_key;
377 my @real_fields = grep exists($record->{$_}), real_fields($table);
379 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
380 @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
382 cluck "warning: FS::$table not loaded; virtual fields not searchable"
383 unless $nowarn_classload;
384 @virtual_fields = ();
387 my $statement .= "SELECT $select FROM $stable";
388 $statement .= " $addl_from" if $addl_from;
389 if ( @real_fields or @virtual_fields ) {
390 $statement .= ' WHERE '. join(' AND ',
391 get_real_fields($table, $record, \@real_fields) ,
392 get_virtual_fields($table, $pkey, $record, \@virtual_fields),
396 $statement .= " $extra_sql" if defined($extra_sql);
397 $statement .= " $order_by" if defined($order_by);
399 push @statement, $statement;
401 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
405 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
408 my $value = $record->{$field};
409 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
410 $value = $value->{'value'} if ref($value);
411 my $type = dbdef->table($table)->column($field)->type;
413 my $bind_type = _bind_type($type, $value);
417 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
419 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
423 push @bind_type, $bind_type;
427 foreach my $param ( @$extra_param ) {
428 my $bind_type = { TYPE => SQL_VARCHAR };
431 $value = $param->[0];
432 my $type = $param->[1];
433 $bind_type = _bind_type($type, $value);
436 push @bind_type, $bind_type;
440 my $statement = join( ' ) UNION ( ', @statement );
441 $statement = "( $statement )" if scalar(@statement) > 1;
442 $statement .= " $union_options{order_by}" if $union_options{order_by};
444 my $sth = $dbh->prepare($statement)
445 or croak "$dbh->errstr doing $statement";
448 foreach my $value ( @value ) {
449 my $bind_type = shift @bind_type;
450 $sth->bind_param($bind++, $value, $bind_type );
453 # $sth->execute( map $record->{$_},
454 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
455 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
457 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
459 # virtual fields and blessings are nonsense in a heterogeneous UNION, right?
460 my $table = $stable[0];
462 $table = '' if grep { $_ ne $table } @stable;
463 $pkey = dbdef->table($table)->primary_key if $table;
465 my @virtual_fields = ();
466 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
467 @virtual_fields = "FS::$table"->virtual_fields;
469 cluck "warning: FS::$table not loaded; virtual fields not returned either"
470 unless $nowarn_classload;
471 @virtual_fields = ();
475 tie %result, "Tie::IxHash";
476 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
477 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
478 %result = map { $_->{$pkey}, $_ } @stuff;
480 @result{@stuff} = @stuff;
485 if ( keys(%result) and @virtual_fields ) {
487 "SELECT virtual_field.recnum, part_virtual_field.name, ".
488 "virtual_field.value ".
489 "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
490 "WHERE part_virtual_field.dbtable = '$table' AND ".
491 "virtual_field.recnum IN (".
492 join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
493 join(q!', '!, @virtual_fields) . "')";
494 warn "[debug]$me $statement\n" if $DEBUG > 1;
495 $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
496 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
498 foreach (@{ $sth->fetchall_arrayref({}) }) {
499 my $recnum = $_->{recnum};
500 my $name = $_->{name};
501 my $value = $_->{value};
502 if (exists($result{$recnum})) {
503 $result{$recnum}->{$name} = $value;
508 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
509 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
510 #derivied class didn't override new method, so this optimization is safe
513 new_or_cached( "FS::$table", { %{$_} }, $cache )
517 new( "FS::$table", { %{$_} } )
521 #okay, its been tested
522 # warn "untested code (class FS::$table uses custom new method)";
524 eval 'FS::'. $table. '->new( { %{$_} } )';
528 # Check for encrypted fields and decrypt them.
529 ## only in the local copy, not the cached object
530 if ( $conf_encryption
531 && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
532 foreach my $record (@return) {
533 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
534 # Set it directly... This may cause a problem in the future...
535 $record->setfield($field, $record->decrypt($record->getfield($field)));
540 cluck "warning: FS::$table not loaded; returning FS::Record objects"
541 unless $nowarn_classload;
543 FS::Record->new( $table, { %{$_} } );
549 ## makes this easier to read
551 sub get_virtual_fields {
555 my $virtual_fields = shift;
561 if ( ref($record->{$_}) ) {
562 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
563 if ( uc($op) eq 'ILIKE' ) {
565 $record->{$_}{'value'} = lc($record->{$_}{'value'});
566 $column = "LOWER($_)";
568 $record->{$_} = $record->{$_}{'value'};
571 # ... EXISTS ( SELECT name, value FROM part_virtual_field
573 # ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
574 # WHERE recnum = svc_acct.svcnum
575 # AND (name, value) = ('egad', 'brain') )
577 my $value = $record->{$_};
581 $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
582 "( SELECT part_virtual_field.name, virtual_field.value ".
583 "FROM part_virtual_field JOIN virtual_field ".
584 "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
585 "WHERE virtual_field.recnum = ${table}.${pkey} ".
586 "AND part_virtual_field.name = '${column}'".
588 " AND virtual_field.value ${op} '${value}'"
592 } @{ $virtual_fields } ) ;
595 sub get_real_fields {
598 my $real_fields = shift;
600 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
606 my $type = dbdef->table($table)->column($column)->type;
607 my $value = $record->{$column};
608 $value = $value->{'value'} if ref($value);
609 if ( ref($record->{$_}) ) {
610 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
611 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
612 if ( uc($op) eq 'ILIKE' ) {
614 $record->{$_}{'value'} = lc($record->{$_}{'value'});
615 $column = "LOWER($_)";
617 $record->{$_} = $record->{$_}{'value'}
620 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
622 if ( driver_name eq 'Pg' ) {
623 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
624 qq-( $column IS NULL )-;
626 qq-( $column IS NULL OR $column = '' )-;
629 qq-( $column IS NULL OR $column = "" )-;
631 } elsif ( $op eq '!=' ) {
632 if ( driver_name eq 'Pg' ) {
633 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
634 qq-( $column IS NOT NULL )-;
636 qq-( $column IS NOT NULL AND $column != '' )-;
639 qq-( $column IS NOT NULL AND $column != "" )-;
642 if ( driver_name eq 'Pg' ) {
643 qq-( $column $op '' )-;
645 qq-( $column $op "" )-;
648 #if this needs to be re-enabled, it needs to use a custom op like
649 #"APPROX=" or something (better name?, not '=', to avoid affecting other
651 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
652 # ( "$column <= ?", "$column >= ?" );
656 } @{ $real_fields } );
659 =item by_key PRIMARY_KEY_VALUE
661 This is a class method that returns the record with the given primary key
662 value. This method is only useful in FS::Record subclasses. For example:
664 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
668 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
673 my ($class, $pkey_value) = @_;
675 my $table = $class->table
676 or croak "No table for $class found";
678 my $dbdef_table = dbdef->table($table)
679 or die "No schema for table $table found - ".
680 "do you need to create it or run dbdef-create?";
681 my $pkey = $dbdef_table->primary_key
682 or die "No primary key for table $table";
684 return qsearchs($table, { $pkey => $pkey_value });
687 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
689 Experimental JOINed search method. Using this method, you can execute a
690 single SELECT spanning multiple tables, and cache the results for subsequent
691 method calls. Interface will almost definately change in an incompatible
699 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
700 my $cache = FS::SearchCache->new( $ptable, $pkey );
703 grep { !$saw{$_->getfield($pkey)}++ }
704 qsearch($table, $record, $select, $extra_sql, $cache )
708 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
710 Same as qsearch, except that if more than one record matches, it B<carp>s but
711 returns the first. If this happens, you either made a logic error in asking
712 for a single item, or your data is corrupted.
716 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
718 my(@result) = qsearch(@_);
719 cluck "warning: Multiple records in scalar search ($table)"
720 if scalar(@result) > 1;
721 #should warn more vehemently if the search was on a primary key?
722 scalar(@result) ? ($result[0]) : ();
733 Returns the table name.
738 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
745 Returns the DBIx::DBSchema::Table object for the table.
751 my($table)=$self->table;
752 dbdef->table($table);
757 Returns the primary key for the table.
763 my $pkey = $self->dbdef_table->primary_key;
766 =item get, getfield COLUMN
768 Returns the value of the column/field/key COLUMN.
773 my($self,$field) = @_;
774 # to avoid "Use of unitialized value" errors
775 if ( defined ( $self->{Hash}->{$field} ) ) {
776 $self->{Hash}->{$field};
786 =item set, setfield COLUMN, VALUE
788 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
793 my($self,$field,$value) = @_;
794 $self->{'modified'} = 1;
795 $self->{'Hash'}->{$field} = $value;
804 Returns true if the column/field/key COLUMN exists.
809 my($self,$field) = @_;
810 exists($self->{Hash}->{$field});
813 =item AUTLOADED METHODS
815 $record->column is a synonym for $record->get('column');
817 $record->column('value') is a synonym for $record->set('column','value');
824 my($field)=$AUTOLOAD;
826 if ( defined($value) ) {
827 confess "errant AUTOLOAD $field for $self (arg $value)"
828 unless blessed($self) && $self->can('setfield');
829 $self->setfield($field,$value);
831 confess "errant AUTOLOAD $field for $self (no args)"
832 unless blessed($self) && $self->can('getfield');
833 $self->getfield($field);
839 # my $field = $AUTOLOAD;
841 # if ( defined($_[1]) ) {
842 # $_[0]->setfield($field, $_[1]);
844 # $_[0]->getfield($field);
850 Returns a list of the column/value pairs, usually for assigning to a new hash.
852 To make a distinct duplicate of an FS::Record object, you can do:
854 $new = new FS::Record ( $old->table, { $old->hash } );
860 confess $self. ' -> hash: Hash attribute is undefined'
861 unless defined($self->{'Hash'});
862 %{ $self->{'Hash'} };
867 Returns a reference to the column/value hash. This may be deprecated in the
868 future; if there's a reason you can't just use the autoloaded or get/set
880 Returns true if any of this object's values have been modified with set (or via
881 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
891 =item select_for_update
893 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
898 sub select_for_update {
900 my $primary_key = $self->primary_key;
903 'table' => $self->table,
904 'hashref' => { $primary_key => $self->$primary_key() },
905 'extra_sql' => 'FOR UPDATE',
911 Locks this table with a database-driver specific lock method. This is used
912 as a mutex in order to do a duplicate search.
914 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
916 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
918 Errors are fatal; no useful return value.
920 Note: To use this method for new tables other than svc_acct and svc_phone,
921 edit freeside-upgrade and add those tables to the duplicate_lock list.
927 my $table = $self->table;
929 warn "$me locking $table table\n" if $DEBUG;
931 if ( driver_name =~ /^Pg/i ) {
933 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
936 } elsif ( driver_name =~ /^mysql/i ) {
938 dbh->do("SELECT * FROM duplicate_lock
939 WHERE lockname = '$table'
941 ) or die dbh->errstr;
945 die "unknown database ". driver_name. "; don't know how to lock table";
949 warn "$me acquired $table table lock\n" if $DEBUG;
955 Inserts this record to the database. If there is an error, returns the error,
956 otherwise returns false.
964 warn "$self -> insert" if $DEBUG;
966 my $error = $self->check;
967 return $error if $error;
969 #single-field unique keys are given a value if false
970 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
971 foreach ( $self->dbdef_table->unique_singles) {
972 $self->unique($_) unless $self->getfield($_);
975 #and also the primary key, if the database isn't going to
976 my $primary_key = $self->dbdef_table->primary_key;
978 if ( $primary_key ) {
979 my $col = $self->dbdef_table->column($primary_key);
982 uc($col->type) =~ /^(BIG)?SERIAL\d?/
983 || ( driver_name eq 'Pg'
984 && defined($col->default)
985 && $col->quoted_default =~ /^nextval\(/i
987 || ( driver_name eq 'mysql'
988 && defined($col->local)
989 && $col->local =~ /AUTO_INCREMENT/i
991 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
994 my $table = $self->table;
996 # Encrypt before the database
997 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
998 && scalar( eval '@FS::'. $table . '::encrypted_fields')
999 && $conf->exists('encryption')
1001 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
1002 $self->{'saved'} = $self->getfield($field);
1003 $self->setfield($field, $self->encrypt($self->getfield($field)));
1007 #false laziness w/delete
1009 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1012 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1015 my $statement = "INSERT INTO $table ";
1016 if ( @real_fields ) {
1019 join( ', ', @real_fields ).
1021 join( ', ', @values ).
1025 $statement .= 'DEFAULT VALUES';
1027 warn "[debug]$me $statement\n" if $DEBUG > 1;
1028 my $sth = dbh->prepare($statement) or return dbh->errstr;
1030 local $SIG{HUP} = 'IGNORE';
1031 local $SIG{INT} = 'IGNORE';
1032 local $SIG{QUIT} = 'IGNORE';
1033 local $SIG{TERM} = 'IGNORE';
1034 local $SIG{TSTP} = 'IGNORE';
1035 local $SIG{PIPE} = 'IGNORE';
1037 $sth->execute or return $sth->errstr;
1039 # get inserted id from the database, if applicable & needed
1040 if ( $db_seq && ! $self->getfield($primary_key) ) {
1041 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1045 if ( driver_name eq 'Pg' ) {
1047 #my $oid = $sth->{'pg_oid_status'};
1048 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1050 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1051 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1052 dbh->rollback if $FS::UID::AutoCommit;
1053 return "can't parse $table.$primary_key default value".
1054 " for sequence name: $default";
1058 my $i_sql = "SELECT currval('$sequence')";
1059 my $i_sth = dbh->prepare($i_sql) or do {
1060 dbh->rollback if $FS::UID::AutoCommit;
1063 $i_sth->execute() or do { #$i_sth->execute($oid)
1064 dbh->rollback if $FS::UID::AutoCommit;
1065 return $i_sth->errstr;
1067 $insertid = $i_sth->fetchrow_arrayref->[0];
1069 } elsif ( driver_name eq 'mysql' ) {
1071 $insertid = dbh->{'mysql_insertid'};
1072 # work around mysql_insertid being null some of the time, ala RT :/
1073 unless ( $insertid ) {
1074 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1075 "using SELECT LAST_INSERT_ID();";
1076 my $i_sql = "SELECT LAST_INSERT_ID()";
1077 my $i_sth = dbh->prepare($i_sql) or do {
1078 dbh->rollback if $FS::UID::AutoCommit;
1081 $i_sth->execute or do {
1082 dbh->rollback if $FS::UID::AutoCommit;
1083 return $i_sth->errstr;
1085 $insertid = $i_sth->fetchrow_arrayref->[0];
1090 dbh->rollback if $FS::UID::AutoCommit;
1091 return "don't know how to retreive inserted ids from ". driver_name.
1092 ", try using counterfiles (maybe run dbdef-create?)";
1096 $self->setfield($primary_key, $insertid);
1100 my @virtual_fields =
1101 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
1102 $self->virtual_fields;
1103 if (@virtual_fields) {
1104 my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
1106 my $vfieldpart = $self->vfieldpart_hashref;
1108 my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
1111 my $v_sth = dbh->prepare($v_statement) or do {
1112 dbh->rollback if $FS::UID::AutoCommit;
1116 foreach (keys(%v_values)) {
1117 $v_sth->execute($self->getfield($primary_key),
1121 dbh->rollback if $FS::UID::AutoCommit;
1122 return $v_sth->errstr;
1129 if ( defined dbdef->table('h_'. $table) ) {
1130 my $h_statement = $self->_h_statement('insert');
1131 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1132 $h_sth = dbh->prepare($h_statement) or do {
1133 dbh->rollback if $FS::UID::AutoCommit;
1139 $h_sth->execute or return $h_sth->errstr if $h_sth;
1141 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1143 # Now that it has been saved, reset the encrypted fields so that $new
1144 # can still be used.
1145 foreach my $field (keys %{$saved}) {
1146 $self->setfield($field, $saved->{$field});
1154 Depriciated (use insert instead).
1159 cluck "warning: FS::Record::add deprecated!";
1160 insert @_; #call method in this scope
1165 Delete this record from the database. If there is an error, returns the error,
1166 otherwise returns false.
1173 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1175 $self->getfield($_) eq ''
1176 #? "( $_ IS NULL OR $_ = \"\" )"
1177 ? ( driver_name eq 'Pg'
1179 : "( $_ IS NULL OR $_ = \"\" )"
1181 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1182 } ( $self->dbdef_table->primary_key )
1183 ? ( $self->dbdef_table->primary_key)
1184 : real_fields($self->table)
1186 warn "[debug]$me $statement\n" if $DEBUG > 1;
1187 my $sth = dbh->prepare($statement) or return dbh->errstr;
1190 if ( defined dbdef->table('h_'. $self->table) ) {
1191 my $h_statement = $self->_h_statement('delete');
1192 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1193 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1198 my $primary_key = $self->dbdef_table->primary_key;
1201 my $vfp = $self->vfieldpart_hashref;
1202 foreach($self->virtual_fields) {
1203 next if $self->getfield($_) eq '';
1204 unless(@del_vfields) {
1205 my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
1206 $v_sth = dbh->prepare($st) or return dbh->errstr;
1208 push @del_vfields, $_;
1211 local $SIG{HUP} = 'IGNORE';
1212 local $SIG{INT} = 'IGNORE';
1213 local $SIG{QUIT} = 'IGNORE';
1214 local $SIG{TERM} = 'IGNORE';
1215 local $SIG{TSTP} = 'IGNORE';
1216 local $SIG{PIPE} = 'IGNORE';
1218 my $rc = $sth->execute or return $sth->errstr;
1219 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1220 $h_sth->execute or return $h_sth->errstr if $h_sth;
1221 $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
1222 or return $v_sth->errstr
1223 foreach (@del_vfields);
1225 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1227 #no need to needlessly destoy the data either (causes problems actually)
1228 #undef $self; #no need to keep object!
1235 Depriciated (use delete instead).
1240 cluck "warning: FS::Record::del deprecated!";
1241 &delete(@_); #call method in this scope
1244 =item replace OLD_RECORD
1246 Replace the OLD_RECORD with this one in the database. If there is an error,
1247 returns the error, otherwise returns false.
1252 my ($new, $old) = (shift, shift);
1254 $old = $new->replace_old unless defined($old);
1256 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1258 if ( $new->can('replace_check') ) {
1259 my $error = $new->replace_check($old);
1260 return $error if $error;
1263 return "Records not in same table!" unless $new->table eq $old->table;
1265 my $primary_key = $old->dbdef_table->primary_key;
1266 return "Can't change primary key $primary_key ".
1267 'from '. $old->getfield($primary_key).
1268 ' to ' . $new->getfield($primary_key)
1270 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1272 my $error = $new->check;
1273 return $error if $error;
1275 # Encrypt for replace
1277 if ( $conf->exists('encryption')
1278 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1279 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1281 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1282 $saved->{$field} = $new->getfield($field);
1283 $new->setfield($field, $new->encrypt($new->getfield($field)));
1287 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1288 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1289 ? ($_, $new->getfield($_)) : () } $old->fields;
1291 unless (keys(%diff) || $no_update_diff ) {
1292 carp "[warning]$me $new -> replace $old: records identical"
1293 unless $nowarn_identical;
1297 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1299 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1300 } real_fields($old->table)
1305 if ( $old->getfield($_) eq '' ) {
1307 #false laziness w/qsearch
1308 if ( driver_name eq 'Pg' ) {
1309 my $type = $old->dbdef_table->column($_)->type;
1310 if ( $type =~ /(int|(big)?serial)/i ) {
1313 qq-( $_ IS NULL OR $_ = '' )-;
1316 qq-( $_ IS NULL OR $_ = "" )-;
1320 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1323 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1326 warn "[debug]$me $statement\n" if $DEBUG > 1;
1327 my $sth = dbh->prepare($statement) or return dbh->errstr;
1330 if ( defined dbdef->table('h_'. $old->table) ) {
1331 my $h_old_statement = $old->_h_statement('replace_old');
1332 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1333 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1339 if ( defined dbdef->table('h_'. $new->table) ) {
1340 my $h_new_statement = $new->_h_statement('replace_new');
1341 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1342 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1347 # For virtual fields we have three cases with different SQL
1348 # statements: add, replace, delete
1352 my (@add_vfields, @rep_vfields, @del_vfields);
1353 my $vfp = $old->vfieldpart_hashref;
1354 foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
1355 if($diff{$_} eq '') {
1357 unless(@del_vfields) {
1358 my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
1359 "AND vfieldpart = ?";
1360 warn "[debug]$me $st\n" if $DEBUG > 2;
1361 $v_del_sth = dbh->prepare($st) or return dbh->errstr;
1363 push @del_vfields, $_;
1364 } elsif($old->getfield($_) eq '') {
1366 unless(@add_vfields) {
1367 my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
1369 warn "[debug]$me $st\n" if $DEBUG > 2;
1370 $v_add_sth = dbh->prepare($st) or return dbh->errstr;
1372 push @add_vfields, $_;
1375 unless(@rep_vfields) {
1376 my $st = "UPDATE virtual_field SET value = ? ".
1377 "WHERE recnum = ? AND vfieldpart = ?";
1378 warn "[debug]$me $st\n" if $DEBUG > 2;
1379 $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
1381 push @rep_vfields, $_;
1385 local $SIG{HUP} = 'IGNORE';
1386 local $SIG{INT} = 'IGNORE';
1387 local $SIG{QUIT} = 'IGNORE';
1388 local $SIG{TERM} = 'IGNORE';
1389 local $SIG{TSTP} = 'IGNORE';
1390 local $SIG{PIPE} = 'IGNORE';
1392 my $rc = $sth->execute or return $sth->errstr;
1393 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1394 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1395 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1397 $v_del_sth->execute($old->getfield($primary_key),
1399 or return $v_del_sth->errstr
1400 foreach(@del_vfields);
1402 $v_add_sth->execute($new->getfield($_),
1403 $old->getfield($primary_key),
1405 or return $v_add_sth->errstr
1406 foreach(@add_vfields);
1408 $v_rep_sth->execute($new->getfield($_),
1409 $old->getfield($primary_key),
1411 or return $v_rep_sth->errstr
1412 foreach(@rep_vfields);
1414 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1416 # Now that it has been saved, reset the encrypted fields so that $new
1417 # can still be used.
1418 foreach my $field (keys %{$saved}) {
1419 $new->setfield($field, $saved->{$field});
1427 my( $self ) = shift;
1428 warn "[$me] replace called with no arguments; autoloading old record\n"
1431 my $primary_key = $self->dbdef_table->primary_key;
1432 if ( $primary_key ) {
1433 $self->by_key( $self->$primary_key() ) #this is what's returned
1434 or croak "can't find ". $self->table. ".$primary_key ".
1435 $self->$primary_key();
1437 croak $self->table. " has no primary key; pass old record as argument";
1444 Depriciated (use replace instead).
1449 cluck "warning: FS::Record::rep deprecated!";
1450 replace @_; #call method in this scope
1455 Checks virtual fields (using check_blocks). Subclasses should still provide
1456 a check method to validate real fields, foreign keys, etc., and call this
1457 method via $self->SUPER::check.
1459 (FIXME: Should this method try to make sure that it I<is> being called from
1460 a subclass's check method, to keep the current semantics as far as possible?)
1465 #confess "FS::Record::check not implemented; supply one in subclass!";
1468 foreach my $field ($self->virtual_fields) {
1469 for ($self->getfield($field)) {
1470 # See notes on check_block in FS::part_virtual_field.
1471 eval $self->pvf($field)->check_block;
1473 #this is bad, probably want to follow the stack backtrace up and see
1475 my $err = "Fatal error checking $field for $self";
1477 return "$err (see log for backtrace): $@";
1480 $self->setfield($field, $_);
1486 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1488 Processes a batch import as a queued JSRPC job
1490 JOB is an FS::queue entry.
1492 OPTIONS_HASHREF can have the following keys:
1498 Table name (required).
1502 Listref of field names for static fields. They will be given values from the
1503 PARAMS hashref and passed as a "params" hashref to batch_import.
1507 Formats hashref. Keys are field names, values are listrefs that define the
1510 Each listref value can be a column name or a code reference. Coderefs are run
1511 with the row object, data and a FS::Conf object as the three parameters.
1512 For example, this coderef does the same thing as using the "columnname" string:
1515 my( $record, $data, $conf ) = @_;
1516 $record->columnname( $data );
1519 Coderefs are run after all "column name" fields are assigned.
1523 Optional format hashref of types. Keys are field names, values are "csv",
1524 "xls" or "fixedlength". Overrides automatic determination of file type
1527 =item format_headers
1529 Optional format hashref of header lines. Keys are field names, values are 0
1530 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1533 =item format_sep_chars
1535 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1536 CSV separation character.
1538 =item format_fixedlenth_formats
1540 Optional format hashref of fixed length format defintiions. Keys are field
1541 names, values Parse::FixedLength listrefs of field definitions.
1545 Set true to default to CSV file type if the filename does not contain a
1546 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1551 PARAMS is a base64-encoded Storable string containing the POSTed data as
1552 a hash ref. It normally contains at least one field, "uploaded files",
1553 generated by /elements/file-upload.html and containing the list of uploaded
1554 files. Currently only supports a single file named "file".
1558 use Storable qw(thaw);
1561 sub process_batch_import {
1562 my($job, $opt) = ( shift, shift );
1564 my $table = $opt->{table};
1565 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1566 my %formats = %{ $opt->{formats} };
1568 my $param = thaw(decode_base64(shift));
1569 warn Dumper($param) if $DEBUG;
1571 my $files = $param->{'uploaded_files'}
1572 or die "No files provided.\n";
1574 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1576 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1577 my $file = $dir. $files{'file'};
1582 formats => \%formats,
1583 format_types => $opt->{format_types},
1584 format_headers => $opt->{format_headers},
1585 format_sep_chars => $opt->{format_sep_chars},
1586 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1587 format_xml_formats => $opt->{format_xml_formats},
1588 format_row_callbacks => $opt->{format_row_callbacks},
1593 format => $param->{format},
1594 params => { map { $_ => $param->{$_} } @pass_params },
1596 default_csv => $opt->{default_csv},
1597 postinsert_callback => $opt->{postinsert_callback},
1600 if ( $opt->{'batch_namecol'} ) {
1601 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1602 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1605 my $error = FS::Record::batch_import( \%iopt );
1609 die "$error\n" if $error;
1612 =item batch_import PARAM_HASHREF
1614 Class method for batch imports. Available params:
1620 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1626 =item format_headers
1628 =item format_sep_chars
1630 =item format_fixedlength_formats
1632 =item format_row_callbacks
1634 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1636 =item postinsert_callback
1642 FS::queue object, will be updated with progress
1648 csv, xls, fixedlength, xml
1659 warn "$me batch_import call with params: \n". Dumper($param)
1662 my $table = $param->{table};
1664 my $job = $param->{job};
1665 my $file = $param->{file};
1666 my $params = $param->{params} || {};
1668 my( $type, $header, $sep_char, $fixedlength_format,
1669 $xml_format, $row_callback, @fields );
1670 my $postinsert_callback = '';
1671 $postinsert_callback = $param->{'postinsert_callback'}
1672 if $param->{'postinsert_callback'};
1673 if ( $param->{'format'} ) {
1675 my $format = $param->{'format'};
1676 my $formats = $param->{formats};
1677 die "unknown format $format" unless exists $formats->{ $format };
1679 $type = $param->{'format_types'}
1680 ? $param->{'format_types'}{ $format }
1681 : $param->{type} || 'csv';
1684 $header = $param->{'format_headers'}
1685 ? $param->{'format_headers'}{ $param->{'format'} }
1688 $sep_char = $param->{'format_sep_chars'}
1689 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1692 $fixedlength_format =
1693 $param->{'format_fixedlength_formats'}
1694 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1698 $param->{'format_xml_formats'}
1699 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1703 $param->{'format_row_callbacks'}
1704 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1707 @fields = @{ $formats->{ $format } };
1709 } elsif ( $param->{'fields'} ) {
1711 $type = ''; #infer from filename
1714 $fixedlength_format = '';
1716 @fields = @{ $param->{'fields'} };
1719 die "neither format nor fields specified";
1722 #my $file = $param->{file};
1725 if ( $file =~ /\.(\w+)$/i ) {
1729 warn "can't parse file type from filename $file; defaulting to CSV";
1733 if $param->{'default_csv'} && $type ne 'xls';
1741 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1743 if ( $type eq 'csv' ) {
1746 $attr{sep_char} = $sep_char if $sep_char;
1747 $parser = new Text::CSV_XS \%attr;
1749 } elsif ( $type eq 'fixedlength' ) {
1751 eval "use Parse::FixedLength;";
1753 $parser = new Parse::FixedLength $fixedlength_format;
1757 die "Unknown file type $type\n";
1760 @buffer = split(/\r?\n/, slurp($file) );
1761 splice(@buffer, 0, ($header || 0) );
1762 $count = scalar(@buffer);
1764 } elsif ( $type eq 'xls' ) {
1766 eval "use Spreadsheet::ParseExcel;";
1769 eval "use DateTime::Format::Excel;";
1770 #for now, just let the error be thrown if it is used, since only CDR
1771 # formats bill_west and troop use it, not other excel-parsing things
1774 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1776 $parser = $excel->{Worksheet}[0]; #first sheet
1778 $count = $parser->{MaxRow} || $parser->{MinRow};
1781 $row = $header || 0;
1782 } elsif ( $type eq 'xml' ) {
1784 eval "use XML::Simple;";
1786 my $xmlrow = $xml_format->{'xmlrow'};
1787 $parser = $xml_format->{'xmlkeys'};
1788 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1789 my $data = XML::Simple::XMLin(
1791 'SuppressEmpty' => '', #sets empty values to ''
1795 $rows = $rows->{$_} foreach @$xmlrow;
1796 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1797 $count = @buffer = @$rows;
1799 die "Unknown file type $type\n";
1804 local $SIG{HUP} = 'IGNORE';
1805 local $SIG{INT} = 'IGNORE';
1806 local $SIG{QUIT} = 'IGNORE';
1807 local $SIG{TERM} = 'IGNORE';
1808 local $SIG{TSTP} = 'IGNORE';
1809 local $SIG{PIPE} = 'IGNORE';
1811 my $oldAutoCommit = $FS::UID::AutoCommit;
1812 local $FS::UID::AutoCommit = 0;
1815 #my $params = $param->{params} || {};
1816 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1817 my $batch_col = $param->{'batch_keycol'};
1819 my $batch_class = 'FS::'. $param->{'batch_table'};
1820 my $batch = $batch_class->new({
1821 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1823 my $error = $batch->insert;
1825 $dbh->rollback if $oldAutoCommit;
1826 return "can't insert batch record: $error";
1828 #primary key via dbdef? (so the column names don't have to match)
1829 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1831 $params->{ $batch_col } = $batch_value;
1834 #my $job = $param->{job};
1837 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1841 if ( $type eq 'csv' ) {
1843 last unless scalar(@buffer);
1844 $line = shift(@buffer);
1846 next if $line =~ /^\s*$/; #skip empty lines
1848 $line = &{$row_callback}($line) if $row_callback;
1850 $parser->parse($line) or do {
1851 $dbh->rollback if $oldAutoCommit;
1852 return "can't parse: ". $parser->error_input();
1854 @columns = $parser->fields();
1856 } elsif ( $type eq 'fixedlength' ) {
1858 @columns = $parser->parse($line);
1860 } elsif ( $type eq 'xls' ) {
1862 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1863 || ! $parser->{Cells}[$row];
1865 my @row = @{ $parser->{Cells}[$row] };
1866 @columns = map $_->{Val}, @row;
1869 #warn $z++. ": $_\n" for @columns;
1871 } elsif ( $type eq 'xml' ) {
1872 # $parser = [ 'Column0Key', 'Column1Key' ... ]
1873 last unless scalar(@buffer);
1874 my $row = shift @buffer;
1875 @columns = @{ $row }{ @$parser };
1877 die "Unknown file type $type\n";
1881 my %hash = %$params;
1883 foreach my $field ( @fields ) {
1885 my $value = shift @columns;
1887 if ( ref($field) eq 'CODE' ) {
1888 #&{$field}(\%hash, $value);
1889 push @later, $field, $value;
1891 #??? $hash{$field} = $value if length($value);
1892 $hash{$field} = $value if defined($value) && length($value);
1897 #my $table = $param->{table};
1898 my $class = "FS::$table";
1900 my $record = $class->new( \%hash );
1903 while ( scalar(@later) ) {
1904 my $sub = shift @later;
1905 my $data = shift @later;
1907 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
1910 $dbh->rollback if $oldAutoCommit;
1911 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
1913 last if exists( $param->{skiprow} );
1915 next if exists( $param->{skiprow} );
1917 my $error = $record->insert;
1920 $dbh->rollback if $oldAutoCommit;
1921 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1927 if ( $postinsert_callback ) {
1928 my $error = &{$postinsert_callback}($record, $param);
1930 $dbh->rollback if $oldAutoCommit;
1931 return "postinsert_callback error". ( $line ? " for $line" : '' ).
1936 if ( $job && time - $min_sec > $last ) { #progress bar
1937 $job->update_statustext( int(100 * $imported / $count) );
1943 unless ( $imported || $param->{empty_ok} ) {
1944 $dbh->rollback if $oldAutoCommit;
1945 return "Empty file!";
1948 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1955 my( $self, $action, $time ) = @_;
1959 my %nohistory = map { $_=>1 } $self->nohistory_fields;
1962 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
1963 real_fields($self->table);
1966 # If we're encrypting then don't store the payinfo in the history
1967 if ( $conf && $conf->exists('encryption') ) {
1968 @fields = grep { $_ ne 'payinfo' } @fields;
1971 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1973 "INSERT INTO h_". $self->table. " ( ".
1974 join(', ', qw(history_date history_user history_action), @fields ).
1976 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1983 B<Warning>: External use is B<deprecated>.
1985 Replaces COLUMN in record with a unique number, using counters in the
1986 filesystem. Used by the B<insert> method on single-field unique columns
1987 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1988 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1990 Returns the new value.
1995 my($self,$field) = @_;
1996 my($table)=$self->table;
1998 croak "Unique called on field $field, but it is ",
1999 $self->getfield($field),
2001 if $self->getfield($field);
2003 #warn "table $table is tainted" if is_tainted($table);
2004 #warn "field $field is tainted" if is_tainted($field);
2006 my($counter) = new File::CounterFile "$table.$field",0;
2008 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
2010 # my($counter) = new File::CounterFile "$user/$table.$field",0;
2013 my $index = $counter->inc;
2014 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2016 $index =~ /^(\d*)$/;
2019 $self->setfield($field,$index);
2023 =item ut_float COLUMN
2025 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2026 null. If there is an error, returns the error, otherwise returns false.
2031 my($self,$field)=@_ ;
2032 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2033 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2034 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2035 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2036 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2037 $self->setfield($field,$1);
2040 =item ut_floatn COLUMN
2042 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2043 null. If there is an error, returns the error, otherwise returns false.
2047 #false laziness w/ut_ipn
2049 my( $self, $field ) = @_;
2050 if ( $self->getfield($field) =~ /^()$/ ) {
2051 $self->setfield($field,'');
2054 $self->ut_float($field);
2058 =item ut_sfloat COLUMN
2060 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2061 May not be null. If there is an error, returns the error, otherwise returns
2067 my($self,$field)=@_ ;
2068 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2069 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2070 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2071 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2072 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2073 $self->setfield($field,$1);
2076 =item ut_sfloatn COLUMN
2078 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2079 null. If there is an error, returns the error, otherwise returns false.
2084 my( $self, $field ) = @_;
2085 if ( $self->getfield($field) =~ /^()$/ ) {
2086 $self->setfield($field,'');
2089 $self->ut_sfloat($field);
2093 =item ut_snumber COLUMN
2095 Check/untaint signed numeric data (whole numbers). If there is an error,
2096 returns the error, otherwise returns false.
2101 my($self, $field) = @_;
2102 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2103 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2104 $self->setfield($field, "$1$2");
2108 =item ut_snumbern COLUMN
2110 Check/untaint signed numeric data (whole numbers). If there is an error,
2111 returns the error, otherwise returns false.
2116 my($self, $field) = @_;
2117 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2118 or return "Illegal (numeric) $field: ". $self->getfield($field);
2120 return "Illegal (numeric) $field: ". $self->getfield($field)
2123 $self->setfield($field, "$1$2");
2127 =item ut_number COLUMN
2129 Check/untaint simple numeric data (whole numbers). May not be null. If there
2130 is an error, returns the error, otherwise returns false.
2135 my($self,$field)=@_;
2136 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2137 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2138 $self->setfield($field,$1);
2142 =item ut_numbern COLUMN
2144 Check/untaint simple numeric data (whole numbers). May be null. If there is
2145 an error, returns the error, otherwise returns false.
2150 my($self,$field)=@_;
2151 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2152 or return "Illegal (numeric) $field: ". $self->getfield($field);
2153 $self->setfield($field,$1);
2157 =item ut_money COLUMN
2159 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2160 is an error, returns the error, otherwise returns false.
2165 my($self,$field)=@_;
2166 $self->setfield($field, 0) if $self->getfield($field) eq '';
2167 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
2168 or return "Illegal (money) $field: ". $self->getfield($field);
2169 #$self->setfield($field, "$1$2$3" || 0);
2170 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2174 =item ut_moneyn COLUMN
2176 Check/untaint monetary numbers. May be negative. If there
2177 is an error, returns the error, otherwise returns false.
2182 my($self,$field)=@_;
2183 if ($self->getfield($field) eq '') {
2184 $self->setfield($field, '');
2187 $self->ut_money($field);
2190 =item ut_text COLUMN
2192 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2193 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2194 May not be null. If there is an error, returns the error, otherwise returns
2200 my($self,$field)=@_;
2201 #warn "msgcat ". \&msgcat. "\n";
2202 #warn "notexist ". \¬exist. "\n";
2203 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2204 $self->getfield($field)
2205 =~ /^([µ_0123456789aAáÁàÀâÂåÅäÄãêæÆbBcCçÇdDðÐeEéÉèÈêÊëËfFgGhHiIíÍìÌîÎïÏjJkKlLmMnNñÑoOóÓòÒôÔöÖõÕøغpPqQrRsSßtTuUúÚùÙûÛüÜvVwWxXyYýÝÿzZþÞ \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>]+)$/
2206 or return gettext('illegal_or_empty_text'). " $field: ".
2207 $self->getfield($field);
2208 $self->setfield($field,$1);
2212 =item ut_textn COLUMN
2214 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2215 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
2216 May be null. If there is an error, returns the error, otherwise returns false.
2221 my($self,$field)=@_;
2222 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2223 $self->ut_text($field);
2226 =item ut_alpha COLUMN
2228 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2229 an error, returns the error, otherwise returns false.
2234 my($self,$field)=@_;
2235 $self->getfield($field) =~ /^(\w+)$/
2236 or return "Illegal or empty (alphanumeric) $field: ".
2237 $self->getfield($field);
2238 $self->setfield($field,$1);
2242 =item ut_alphan COLUMN
2244 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2245 error, returns the error, otherwise returns false.
2250 my($self,$field)=@_;
2251 $self->getfield($field) =~ /^(\w*)$/
2252 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2253 $self->setfield($field,$1);
2257 =item ut_alphasn COLUMN
2259 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2260 an error, returns the error, otherwise returns false.
2265 my($self,$field)=@_;
2266 $self->getfield($field) =~ /^([\w ]*)$/
2267 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2268 $self->setfield($field,$1);
2273 =item ut_alpha_lower COLUMN
2275 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2276 there is an error, returns the error, otherwise returns false.
2280 sub ut_alpha_lower {
2281 my($self,$field)=@_;
2282 $self->getfield($field) =~ /[[:upper:]]/
2283 and return "Uppercase characters are not permitted in $field";
2284 $self->ut_alpha($field);
2287 =item ut_phonen COLUMN [ COUNTRY ]
2289 Check/untaint phone numbers. May be null. If there is an error, returns
2290 the error, otherwise returns false.
2292 Takes an optional two-letter ISO country code; without it or with unsupported
2293 countries, ut_phonen simply calls ut_alphan.
2298 my( $self, $field, $country ) = @_;
2299 return $self->ut_alphan($field) unless defined $country;
2300 my $phonen = $self->getfield($field);
2301 if ( $phonen eq '' ) {
2302 $self->setfield($field,'');
2303 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2305 $phonen = $conf->config('cust_main-default_areacode').$phonen
2306 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2307 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2308 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2309 $phonen = "$1-$2-$3";
2310 $phonen .= " x$4" if $4;
2311 $self->setfield($field,$phonen);
2313 warn "warning: don't know how to check phone numbers for country $country";
2314 return $self->ut_textn($field);
2321 Check/untaint hexadecimal values.
2326 my($self, $field) = @_;
2327 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2328 or return "Illegal (hex) $field: ". $self->getfield($field);
2329 $self->setfield($field, uc($1));
2333 =item ut_hexn COLUMN
2335 Check/untaint hexadecimal values. May be null.
2340 my($self, $field) = @_;
2341 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2342 or return "Illegal (hex) $field: ". $self->getfield($field);
2343 $self->setfield($field, uc($1));
2348 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2354 my( $self, $field ) = @_;
2355 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2356 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2357 or return "Illegal (IP address) $field: ". $self->getfield($field);
2358 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2359 $self->setfield($field, "$1.$2.$3.$4");
2365 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2366 to 127.0.0.1. May be null.
2371 my( $self, $field ) = @_;
2372 if ( $self->getfield($field) =~ /^()$/ ) {
2373 $self->setfield($field,'');
2376 $self->ut_ip($field);
2380 =item ut_ip46 COLUMN
2382 Check/untaint IPv4 or IPv6 address.
2387 my( $self, $field ) = @_;
2388 my $ip = NetAddr::IP->new($self->getfield($field))
2389 or return "Illegal (IP address) $field: ".$self->getfield($field);
2390 $self->setfield($field, lc($ip->addr));
2396 Check/untaint IPv6 or IPv6 address. May be null.
2401 my( $self, $field ) = @_;
2402 if ( $self->getfield($field) =~ /^$/ ) {
2403 $self->setfield($field, '');
2406 $self->ut_ip46($field);
2409 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2411 Check/untaint coordinates.
2412 Accepts the following forms:
2422 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2423 The latter form (that is, the MMM are thousands of minutes) is
2424 assumed if the "MMM" is exactly three digits or two digits > 59.
2426 To be safe, just use the DDD.DDDDD form.
2428 If LOWER or UPPER are specified, then the coordinate is checked
2429 for lower and upper bounds, respectively.
2435 my ($self, $field) = (shift, shift);
2437 my $lower = shift if scalar(@_);
2438 my $upper = shift if scalar(@_);
2439 my $coord = $self->getfield($field);
2440 my $neg = $coord =~ s/^(-)//;
2442 my ($d, $m, $s) = (0, 0, 0);
2445 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2446 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2447 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2449 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2452 return "Invalid (coordinate with minutes > 59) $field: "
2453 . $self->getfield($field);
2456 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2458 if (defined($lower) and ($coord < $lower)) {
2459 return "Invalid (coordinate < $lower) $field: "
2460 . $self->getfield($field);;
2463 if (defined($upper) and ($coord > $upper)) {
2464 return "Invalid (coordinate > $upper) $field: "
2465 . $self->getfield($field);;
2468 $self->setfield($field, $coord);
2472 return "Invalid (coordinate) $field: " . $self->getfield($field);
2476 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2478 Same as ut_coord, except optionally null.
2484 my ($self, $field) = (shift, shift);
2486 if ($self->getfield($field) =~ /^$/) {
2489 return $self->ut_coord($field, @_);
2495 =item ut_domain COLUMN
2497 Check/untaint host and domain names.
2502 my( $self, $field ) = @_;
2503 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2504 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2505 or return "Illegal (domain) $field: ". $self->getfield($field);
2506 $self->setfield($field,$1);
2510 =item ut_name COLUMN
2512 Check/untaint proper names; allows alphanumerics, spaces and the following
2513 punctuation: , . - '
2520 my( $self, $field ) = @_;
2521 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2522 #$self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2523 $self->getfield($field) =~ /^([µ_0123456789aAáÁàÀâÂåÅäÄãêæÆbBcCçÇdDðÐeEéÉèÈêÊëËfFgGhHiIíÍìÌîÎïÏjJkKlLmMnNñÑoOóÓòÒôÔöÖõÕøغpPqQrRsSßtTuUúÚùÙûÛüÜvVwWxXyYýÝÿzZþÞ \,\.\-\']+)$/
2524 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2525 $self->setfield($field,$1);
2531 Check/untaint zip codes.
2535 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2538 my( $self, $field, $country ) = @_;
2540 if ( $country eq 'US' ) {
2542 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2543 or return gettext('illegal_zip'). " $field for country $country: ".
2544 $self->getfield($field);
2545 $self->setfield($field, $1);
2547 } elsif ( $country eq 'CA' ) {
2549 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2550 or return gettext('illegal_zip'). " $field for country $country: ".
2551 $self->getfield($field);
2552 $self->setfield($field, "$1 $2");
2556 if ( $self->getfield($field) =~ /^\s*$/
2557 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2560 $self->setfield($field,'');
2562 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
2563 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2564 $self->setfield($field,$1);
2572 =item ut_country COLUMN
2574 Check/untaint country codes. Country names are changed to codes, if possible -
2575 see L<Locale::Country>.
2580 my( $self, $field ) = @_;
2581 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2582 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2583 && country2code($1) ) {
2584 $self->setfield($field,uc(country2code($1)));
2587 $self->getfield($field) =~ /^(\w\w)$/
2588 or return "Illegal (country) $field: ". $self->getfield($field);
2589 $self->setfield($field,uc($1));
2593 =item ut_anything COLUMN
2595 Untaints arbitrary data. Be careful.
2600 my( $self, $field ) = @_;
2601 $self->getfield($field) =~ /^(.*)$/s
2602 or return "Illegal $field: ". $self->getfield($field);
2603 $self->setfield($field,$1);
2607 =item ut_enum COLUMN CHOICES_ARRAYREF
2609 Check/untaint a column, supplying all possible choices, like the "enum" type.
2614 my( $self, $field, $choices ) = @_;
2615 foreach my $choice ( @$choices ) {
2616 if ( $self->getfield($field) eq $choice ) {
2617 $self->setfield($field, $choice);
2621 return "Illegal (enum) field $field: ". $self->getfield($field);
2624 =item ut_enumn COLUMN CHOICES_ARRAYREF
2626 Like ut_enum, except the null value is also allowed.
2631 my( $self, $field, $choices ) = @_;
2632 $self->getfield($field)
2633 ? $self->ut_enum($field, $choices)
2638 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2640 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2641 on the column first.
2645 sub ut_foreign_key {
2646 my( $self, $field, $table, $foreign ) = @_;
2647 return '' if $no_check_foreign;
2648 qsearchs($table, { $foreign => $self->getfield($field) })
2649 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2650 " in $table.$foreign";
2654 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2656 Like ut_foreign_key, except the null value is also allowed.
2660 sub ut_foreign_keyn {
2661 my( $self, $field, $table, $foreign ) = @_;
2662 $self->getfield($field)
2663 ? $self->ut_foreign_key($field, $table, $foreign)
2667 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2669 Checks this column as an agentnum, taking into account the current users's
2670 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2671 right or rights allowing no agentnum.
2675 sub ut_agentnum_acl {
2676 my( $self, $field ) = (shift, shift);
2677 my $null_acl = scalar(@_) ? shift : [];
2678 $null_acl = [ $null_acl ] unless ref($null_acl);
2680 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2681 return "Illegal agentnum: $error" if $error;
2683 my $curuser = $FS::CurrentUser::CurrentUser;
2685 if ( $self->$field() ) {
2687 return "Access denied"
2688 unless $curuser->agentnum($self->$field());
2692 return "Access denied"
2693 unless grep $curuser->access_right($_), @$null_acl;
2701 =item virtual_fields [ TABLE ]
2703 Returns a list of virtual fields defined for the table. This should not
2704 be exported, and should only be called as an instance or class method.
2708 sub virtual_fields {
2711 $table = $self->table or confess "virtual_fields called on non-table";
2713 confess "Unknown table $table" unless dbdef->table($table);
2715 return () unless dbdef->table('part_virtual_field');
2717 unless ( $virtual_fields_cache{$table} ) {
2718 my $query = 'SELECT name from part_virtual_field ' .
2719 "WHERE dbtable = '$table'";
2721 my $result = $dbh->selectcol_arrayref($query);
2722 confess "Error executing virtual fields query: $query: ". $dbh->errstr
2724 $virtual_fields_cache{$table} = $result;
2727 @{$virtual_fields_cache{$table}};
2732 =item fields [ TABLE ]
2734 This is a wrapper for real_fields and virtual_fields. Code that called
2735 fields before should probably continue to call fields.
2740 my $something = shift;
2742 if($something->isa('FS::Record')) {
2743 $table = $something->table;
2745 $table = $something;
2746 $something = "FS::$table";
2748 return (real_fields($table), $something->virtual_fields());
2751 =item pvf FIELD_NAME
2753 Returns the FS::part_virtual_field object corresponding to a field in the
2754 record (specified by FIELD_NAME).
2759 my ($self, $name) = (shift, shift);
2761 if(grep /^$name$/, $self->virtual_fields) {
2762 return qsearchs('part_virtual_field', { dbtable => $self->table,
2768 =item vfieldpart_hashref TABLE
2770 Returns a hashref of virtual field names and vfieldparts applicable to the given
2775 sub vfieldpart_hashref {
2777 my $table = $self->table;
2779 return {} unless dbdef->table('part_virtual_field');
2782 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
2783 "dbtable = '$table'";
2784 my $sth = $dbh->prepare($statement);
2785 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
2786 return { map { $_->{name}, $_->{vfieldpart} }
2787 @{$sth->fetchall_arrayref({})} };
2791 =item encrypt($value)
2793 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2795 Returns the encrypted string.
2797 You should generally not have to worry about calling this, as the system handles this for you.
2802 my ($self, $value) = @_;
2805 if ($conf->exists('encryption')) {
2806 if ($self->is_encrypted($value)) {
2807 # Return the original value if it isn't plaintext.
2808 $encrypted = $value;
2811 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2812 # RSA doesn't like the empty string so let's pack it up
2813 # The database doesn't like the RSA data so uuencode it
2814 my $length = length($value)+1;
2815 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2817 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2824 =item is_encrypted($value)
2826 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2832 my ($self, $value) = @_;
2833 # Possible Bug - Some work may be required here....
2835 if ($value =~ /^M/ && length($value) > 80) {
2842 =item decrypt($value)
2844 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2846 You should generally not have to worry about calling this, as the system handles this for you.
2851 my ($self,$value) = @_;
2852 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2853 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2855 if (ref($rsa_decrypt) =~ /::RSA/) {
2856 my $encrypted = unpack ("u*", $value);
2857 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2858 if ($@) {warn "Decryption Failed"};
2866 #Initialize the Module
2867 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2869 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2870 $rsa_module = $conf->config('encryptionmodule');
2874 eval ("require $rsa_module"); # No need to import the namespace
2877 # Initialize Encryption
2878 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2879 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2880 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2883 # Intitalize Decryption
2884 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2885 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2886 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2890 =item h_search ACTION
2892 Given an ACTION, either "insert", or "delete", returns the appropriate history
2893 record corresponding to this record, if any.
2898 my( $self, $action ) = @_;
2900 my $table = $self->table;
2903 my $primary_key = dbdef->table($table)->primary_key;
2906 'table' => "h_$table",
2907 'hashref' => { $primary_key => $self->$primary_key(),
2908 'history_action' => $action,
2916 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2917 appropriate history record corresponding to this record, if any.
2922 my($self, $action) = @_;
2923 my $h = $self->h_search($action);
2924 $h ? $h->history_date : '';
2927 =item scalar_sql SQL [ PLACEHOLDER, ... ]
2929 A class or object method. Executes the sql statement represented by SQL and
2930 returns a scalar representing the result: the first column of the first row.
2932 Dies on bogus SQL. Returns an empty string if no row is returned.
2934 Typically used for statments which return a single value such as "SELECT
2935 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
2940 my($self, $sql) = (shift, shift);
2941 my $sth = dbh->prepare($sql) or die dbh->errstr;
2943 or die "Unexpected error executing statement $sql: ". $sth->errstr;
2944 my $row = $sth->fetchrow_arrayref or return '';
2945 my $scalar = $row->[0];
2946 defined($scalar) ? $scalar : '';
2955 =item real_fields [ TABLE ]
2957 Returns a list of the real columns in the specified table. Called only by
2958 fields() and other subroutines elsewhere in FS::Record.
2965 my($table_obj) = dbdef->table($table);
2966 confess "Unknown table $table" unless $table_obj;
2967 $table_obj->columns;
2970 =item _quote VALUE, TABLE, COLUMN
2972 This is an internal function used to construct SQL statements. It returns
2973 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2974 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2979 my($value, $table, $column) = @_;
2980 my $column_obj = dbdef->table($table)->column($column);
2981 my $column_type = $column_obj->type;
2982 my $nullable = $column_obj->null;
2984 warn " $table.$column: $value ($column_type".
2985 ( $nullable ? ' NULL' : ' NOT NULL' ).
2986 ")\n" if $DEBUG > 2;
2988 if ( $value eq '' && $nullable ) {
2990 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2991 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2994 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2995 ! $column_type =~ /(char|binary|text)$/i ) {
2997 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
2998 && driver_name eq 'Pg'
3002 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
3003 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
3004 # single-quote the whole mess, and put an "E" in front.
3005 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3013 This is deprecated. Don't use it.
3015 It returns a hash-type list with the fields of this record's table set true.
3020 carp "warning: hfields is deprecated";
3023 foreach (fields($table)) {
3032 "$_: ". $self->getfield($_). "|"
3033 } (fields($self->table)) );
3036 sub DESTROY { return; }
3040 # #use Carp qw(cluck);
3041 # #cluck "DESTROYING $self";
3042 # warn "DESTROYING $self";
3046 # return ! eval { join('',@_), kill 0; 1; };
3049 =item str2time_sql [ DRIVER_NAME ]
3051 Returns a function to convert to unix time based on database type, such as
3052 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3053 the str2time_sql_closing method to return a closing string rather than just
3054 using a closing parenthesis as previously suggested.
3056 You can pass an optional driver name such as "Pg", "mysql" or
3057 $dbh->{Driver}->{Name} to return a function for that database instead of
3058 the current database.
3063 my $driver = shift || driver_name;
3065 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3066 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3068 warn "warning: unknown database type $driver; guessing how to convert ".
3069 "dates to UNIX timestamps";
3070 return 'EXTRACT(EPOCH FROM ';
3074 =item str2time_sql_closing [ DRIVER_NAME ]
3076 Returns the closing suffix of a function to convert to unix time based on
3077 database type, such as ")::integer" for Pg or ")" for mysql.
3079 You can pass an optional driver name such as "Pg", "mysql" or
3080 $dbh->{Driver}->{Name} to return a function for that database instead of
3081 the current database.
3085 sub str2time_sql_closing {
3086 my $driver = shift || driver_name;
3088 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3092 =item regexp_sql [ DRIVER_NAME ]
3094 Returns the operator to do a regular expression comparison based on database
3095 type, such as '~' for Pg or 'REGEXP' for mysql.
3097 You can pass an optional driver name such as "Pg", "mysql" or
3098 $dbh->{Driver}->{Name} to return a function for that database instead of
3099 the current database.
3104 my $driver = shift || driver_name;
3106 return '~' if $driver =~ /^Pg/i;
3107 return 'REGEXP' if $driver =~ /^mysql/i;
3109 die "don't know how to use regular expressions in ". driver_name." databases";
3113 =item not_regexp_sql [ DRIVER_NAME ]
3115 Returns the operator to do a regular expression negation based on database
3116 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3118 You can pass an optional driver name such as "Pg", "mysql" or
3119 $dbh->{Driver}->{Name} to return a function for that database instead of
3120 the current database.
3124 sub not_regexp_sql {
3125 my $driver = shift || driver_name;
3127 return '!~' if $driver =~ /^Pg/i;
3128 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3130 die "don't know how to use regular expressions in ". driver_name." databases";
3134 =item concat_sql [ DRIVER_NAME ] ITEMS_ARRAYREF
3136 Returns the items concatendated based on database type, using "CONCAT()" for
3137 mysql and " || " for Pg and other databases.
3139 You can pass an optional driver name such as "Pg", "mysql" or
3140 $dbh->{Driver}->{Name} to return a function for that database instead of
3141 the current database.
3146 my $driver = ref($_[0]) ? driver_name : shift;
3149 if ( $driver =~ /^mysql/i ) {
3150 'CONCAT('. join(',', @$items). ')';
3152 join('||', @$items);
3161 This module should probably be renamed, since much of the functionality is
3162 of general use. It is not completely unlike Adapter::DBI (see below).
3164 Exported qsearch and qsearchs should be deprecated in favor of method calls
3165 (against an FS::Record object like the old search and searchs that qsearch
3166 and qsearchs were on top of.)
3168 The whole fields / hfields mess should be removed.
3170 The various WHERE clauses should be subroutined.
3172 table string should be deprecated in favor of DBIx::DBSchema::Table.
3174 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3175 true maps to the database (and WHERE clauses) would also help.
3177 The ut_ methods should ask the dbdef for a default length.
3179 ut_sqltype (like ut_varchar) should all be defined
3181 A fallback check method should be provided which uses the dbdef.
3183 The ut_money method assumes money has two decimal digits.
3185 The Pg money kludge in the new method only strips `$'.
3187 The ut_phonen method only checks US-style phone numbers.
3189 The _quote function should probably use ut_float instead of a regex.
3191 All the subroutines probably should be methods, here or elsewhere.
3193 Probably should borrow/use some dbdef methods where appropriate (like sub
3196 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3197 or allow it to be set. Working around it is ugly any way around - DBI should
3198 be fixed. (only affects RDBMS which return uppercase column names)
3200 ut_zip should take an optional country like ut_phone.
3204 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3206 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.