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 FS::Conf; #dependency loop bs, in install_callback below instead
26 use FS::part_virtual_field;
32 #export dbdef for now... everything else expects to find it here
33 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef jsearch
34 str2time_sql str2time_sql_closing regexp_sql not_regexp_sql );
39 $nowarn_identical = 0;
40 $nowarn_classload = 0;
42 $no_check_foreign = 0;
50 $conf_encryption = '';
51 FS::UID->install_callback( sub {
54 $conf = FS::Conf->new;
55 $conf_encryption = $conf->exists('encryption');
56 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
57 if ( driver_name eq 'Pg' ) {
58 eval "use DBD::Pg ':pg_types'";
61 eval "sub PG_BYTEA { die 'guru meditation #9: calling PG_BYTEA when not running Pg?'; }";
67 FS::Record - Database record objects
72 use FS::Record qw(dbh fields qsearch qsearchs);
74 $record = new FS::Record 'table', \%hash;
75 $record = new FS::Record 'table', { 'column' => 'value', ... };
77 $record = qsearchs FS::Record 'table', \%hash;
78 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
79 @records = qsearch FS::Record 'table', \%hash;
80 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
82 $table = $record->table;
83 $dbdef_table = $record->dbdef_table;
85 $value = $record->get('column');
86 $value = $record->getfield('column');
87 $value = $record->column;
89 $record->set( 'column' => 'value' );
90 $record->setfield( 'column' => 'value' );
91 $record->column('value');
93 %hash = $record->hash;
95 $hashref = $record->hashref;
97 $error = $record->insert;
99 $error = $record->delete;
101 $error = $new_record->replace($old_record);
103 # external use deprecated - handled by the database (at least for Pg, mysql)
104 $value = $record->unique('column');
106 $error = $record->ut_float('column');
107 $error = $record->ut_floatn('column');
108 $error = $record->ut_number('column');
109 $error = $record->ut_numbern('column');
110 $error = $record->ut_snumber('column');
111 $error = $record->ut_snumbern('column');
112 $error = $record->ut_money('column');
113 $error = $record->ut_text('column');
114 $error = $record->ut_textn('column');
115 $error = $record->ut_alpha('column');
116 $error = $record->ut_alphan('column');
117 $error = $record->ut_phonen('column');
118 $error = $record->ut_anything('column');
119 $error = $record->ut_name('column');
121 $quoted_value = _quote($value,'table','field');
124 $fields = hfields('table');
125 if ( $fields->{Field} ) { # etc.
127 @fields = fields 'table'; #as a subroutine
128 @fields = $record->fields; #as a method call
133 (Mostly) object-oriented interface to database records. Records are currently
134 implemented on top of DBI. FS::Record is intended as a base class for
135 table-specific classes to inherit from, i.e. FS::cust_main.
141 =item new [ TABLE, ] HASHREF
143 Creates a new record. It doesn't store it in the database, though. See
144 L<"insert"> for that.
146 Note that the object stores this hash reference, not a distinct copy of the
147 hash it points to. You can ask the object for a copy with the I<hash>
150 TABLE can only be omitted when a dervived class overrides the table method.
156 my $class = ref($proto) || $proto;
158 bless ($self, $class);
160 unless ( defined ( $self->table ) ) {
161 $self->{'Table'} = shift;
162 carp "warning: FS::Record::new called with table name ". $self->{'Table'}
163 unless $nowarn_classload;
166 $self->{'Hash'} = shift;
168 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
169 $self->{'Hash'}{$field}='';
172 $self->_rebless if $self->can('_rebless');
174 $self->{'modified'} = 0;
176 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
183 my $class = ref($proto) || $proto;
185 bless ($self, $class);
187 $self->{'Table'} = shift unless defined ( $self->table );
189 my $hashref = $self->{'Hash'} = shift;
191 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
192 my $obj = $cache->cache->{$hashref->{$cache->key}};
193 $obj->_cache($hashref, $cache) if $obj->can('_cache');
196 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
203 my $class = ref($proto) || $proto;
205 bless ($self, $class);
206 if ( defined $self->table ) {
207 cluck "create constructor is deprecated, use new!";
210 croak "FS::Record::create called (not from a subclass)!";
214 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
216 Searches the database for all records matching (at least) the key/value pairs
217 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
218 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
221 The preferred usage is to pass a hash reference of named parameters:
223 @records = qsearch( {
224 'table' => 'table_name',
225 'hashref' => { 'field' => 'value'
226 'field' => { 'op' => '<',
231 #these are optional...
233 'extra_sql' => 'AND field = ? AND intfield = ?',
234 'extra_param' => [ 'value', [ 5, 'int' ] ],
235 'order_by' => 'ORDER BY something',
236 #'cache_obj' => '', #optional
237 'addl_from' => 'LEFT JOIN othtable USING ( field )',
242 Much code still uses old-style positional parameters, this is also probably
243 fine in the common case where there are only two parameters:
245 my @records = qsearch( 'table', { 'field' => 'value' } );
247 Also possible is an experimental LISTREF of PARAMS_HASHREFs for a UNION of
248 the individual PARAMS_HASHREF queries
250 ###oops, argh, FS::Record::new only lets us create database fields.
251 #Normal behaviour if SELECT is not specified is `*', as in
252 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
253 #feature where you can specify SELECT - remember, the objects returned,
254 #although blessed into the appropriate `FS::TABLE' package, will only have the
255 #fields you specify. This might have unwanted results if you then go calling
256 #regular FS::TABLE methods
261 my %TYPE = (); #for debugging
264 my($type, $value) = @_;
266 my $bind_type = { TYPE => SQL_VARCHAR };
268 if ( $type =~ /(big)?(int|serial)/i && $value =~ /^\d+(\.\d+)?$/ ) {
270 $bind_type = { TYPE => SQL_INTEGER };
272 } elsif ( $type =~ /^bytea$/i || $type =~ /(blob|varbinary)/i ) {
274 if ( driver_name eq 'Pg' ) {
276 $bind_type = { pg_type => PG_BYTEA };
278 # $bind_type = ? #SQL_VARCHAR could be fine?
281 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
282 #fixed by DBD::Pg 2.11.8
283 #can change back to SQL_FLOAT in early-mid 2010, once everyone's upgraded
284 #(make a Tron test first)
285 } elsif ( _is_fs_float( $type, $value ) ) {
287 $bind_type = { TYPE => SQL_DECIMAL };
296 my($type, $value) = @_;
297 if ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/ ) ||
298 ( $type =~ /(real|float4)/i && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/)
306 my( @stable, @record, @cache );
307 my( @select, @extra_sql, @extra_param, @order_by, @addl_from );
309 my %union_options = ();
310 if ( ref($_[0]) eq 'ARRAY' ) {
313 foreach my $href ( @$optlist ) {
314 push @stable, ( $href->{'table'} or die "table name is required" );
315 push @record, ( $href->{'hashref'} || {} );
316 push @select, ( $href->{'select'} || '*' );
317 push @extra_sql, ( $href->{'extra_sql'} || '' );
318 push @extra_param, ( $href->{'extra_param'} || [] );
319 push @order_by, ( $href->{'order_by'} || '' );
320 push @cache, ( $href->{'cache_obj'} || '' );
321 push @addl_from, ( $href->{'addl_from'} || '' );
322 push @debug, ( $href->{'debug'} || '' );
324 die "at least one hashref is required" unless scalar(@stable);
325 } elsif ( ref($_[0]) eq 'HASH' ) {
327 $stable[0] = $opt->{'table'} or die "table name is required";
328 $record[0] = $opt->{'hashref'} || {};
329 $select[0] = $opt->{'select'} || '*';
330 $extra_sql[0] = $opt->{'extra_sql'} || '';
331 $extra_param[0] = $opt->{'extra_param'} || [];
332 $order_by[0] = $opt->{'order_by'} || '';
333 $cache[0] = $opt->{'cache_obj'} || '';
334 $addl_from[0] = $opt->{'addl_from'} || '';
335 $debug[0] = $opt->{'debug'} || '';
346 my $cache = $cache[0];
352 foreach my $stable ( @stable ) {
353 #stop altering the caller's hashref
354 my $record = { %{ shift(@record) || {} } };#and be liberal in receipt
355 my $select = shift @select;
356 my $extra_sql = shift @extra_sql;
357 my $extra_param = shift @extra_param;
358 my $order_by = shift @order_by;
359 my $cache = shift @cache;
360 my $addl_from = shift @addl_from;
361 my $debug = shift @debug;
363 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
365 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
368 my $table = $cache ? $cache->table : $stable;
369 my $dbdef_table = dbdef->table($table)
370 or die "No schema for table $table found - ".
371 "do you need to run freeside-upgrade?";
372 my $pkey = $dbdef_table->primary_key;
374 my @real_fields = grep exists($record->{$_}), real_fields($table);
376 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
377 @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
379 cluck "warning: FS::$table not loaded; virtual fields not searchable"
380 unless $nowarn_classload;
381 @virtual_fields = ();
384 my $statement .= "SELECT $select FROM $stable";
385 $statement .= " $addl_from" if $addl_from;
386 if ( @real_fields or @virtual_fields ) {
387 $statement .= ' WHERE '. join(' AND ',
388 get_real_fields($table, $record, \@real_fields) ,
389 get_virtual_fields($table, $pkey, $record, \@virtual_fields),
393 $statement .= " $extra_sql" if defined($extra_sql);
394 $statement .= " $order_by" if defined($order_by);
396 push @statement, $statement;
398 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
402 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
405 my $value = $record->{$field};
406 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
407 $value = $value->{'value'} if ref($value);
408 my $type = dbdef->table($table)->column($field)->type;
410 my $bind_type = _bind_type($type, $value);
414 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
416 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
420 push @bind_type, $bind_type;
424 foreach my $param ( @$extra_param ) {
425 my $bind_type = { TYPE => SQL_VARCHAR };
428 $value = $param->[0];
429 my $type = $param->[1];
430 $bind_type = _bind_type($type, $value);
433 push @bind_type, $bind_type;
437 my $statement = join( ' ) UNION ( ', @statement );
438 $statement = "( $statement )" if scalar(@statement) > 1;
439 $statement .= " $union_options{order_by}" if $union_options{order_by};
441 my $sth = $dbh->prepare($statement)
442 or croak "$dbh->errstr doing $statement";
445 foreach my $value ( @value ) {
446 my $bind_type = shift @bind_type;
447 $sth->bind_param($bind++, $value, $bind_type );
450 # $sth->execute( map $record->{$_},
451 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
452 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
454 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
456 # virtual fields and blessings are nonsense in a heterogeneous UNION, right?
457 my $table = $stable[0];
459 $table = '' if grep { $_ ne $table } @stable;
460 $pkey = dbdef->table($table)->primary_key if $table;
462 my @virtual_fields = ();
463 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
464 @virtual_fields = "FS::$table"->virtual_fields;
466 cluck "warning: FS::$table not loaded; virtual fields not returned either"
467 unless $nowarn_classload;
468 @virtual_fields = ();
472 tie %result, "Tie::IxHash";
473 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
474 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
475 %result = map { $_->{$pkey}, $_ } @stuff;
477 @result{@stuff} = @stuff;
482 if ( keys(%result) and @virtual_fields ) {
484 "SELECT virtual_field.recnum, part_virtual_field.name, ".
485 "virtual_field.value ".
486 "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
487 "WHERE part_virtual_field.dbtable = '$table' AND ".
488 "virtual_field.recnum IN (".
489 join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
490 join(q!', '!, @virtual_fields) . "')";
491 warn "[debug]$me $statement\n" if $DEBUG > 1;
492 $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
493 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
495 foreach (@{ $sth->fetchall_arrayref({}) }) {
496 my $recnum = $_->{recnum};
497 my $name = $_->{name};
498 my $value = $_->{value};
499 if (exists($result{$recnum})) {
500 $result{$recnum}->{$name} = $value;
505 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
506 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
507 #derivied class didn't override new method, so this optimization is safe
510 new_or_cached( "FS::$table", { %{$_} }, $cache )
514 new( "FS::$table", { %{$_} } )
518 #okay, its been tested
519 # warn "untested code (class FS::$table uses custom new method)";
521 eval 'FS::'. $table. '->new( { %{$_} } )';
525 # Check for encrypted fields and decrypt them.
526 ## only in the local copy, not the cached object
527 if ( $conf_encryption
528 && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
529 foreach my $record (@return) {
530 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
531 # Set it directly... This may cause a problem in the future...
532 $record->setfield($field, $record->decrypt($record->getfield($field)));
537 cluck "warning: FS::$table not loaded; returning FS::Record objects"
538 unless $nowarn_classload;
540 FS::Record->new( $table, { %{$_} } );
546 ## makes this easier to read
548 sub get_virtual_fields {
552 my $virtual_fields = shift;
558 if ( ref($record->{$_}) ) {
559 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
560 if ( uc($op) eq 'ILIKE' ) {
562 $record->{$_}{'value'} = lc($record->{$_}{'value'});
563 $column = "LOWER($_)";
565 $record->{$_} = $record->{$_}{'value'};
568 # ... EXISTS ( SELECT name, value FROM part_virtual_field
570 # ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
571 # WHERE recnum = svc_acct.svcnum
572 # AND (name, value) = ('egad', 'brain') )
574 my $value = $record->{$_};
578 $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
579 "( SELECT part_virtual_field.name, virtual_field.value ".
580 "FROM part_virtual_field JOIN virtual_field ".
581 "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
582 "WHERE virtual_field.recnum = ${table}.${pkey} ".
583 "AND part_virtual_field.name = '${column}'".
585 " AND virtual_field.value ${op} '${value}'"
589 } @{ $virtual_fields } ) ;
592 sub get_real_fields {
595 my $real_fields = shift;
597 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
603 my $type = dbdef->table($table)->column($column)->type;
604 my $value = $record->{$column};
605 $value = $value->{'value'} if ref($value);
606 if ( ref($record->{$_}) ) {
607 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
608 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
609 if ( uc($op) eq 'ILIKE' ) {
611 $record->{$_}{'value'} = lc($record->{$_}{'value'});
612 $column = "LOWER($_)";
614 $record->{$_} = $record->{$_}{'value'}
617 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
619 if ( driver_name eq 'Pg' ) {
620 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
621 qq-( $column IS NULL )-;
623 qq-( $column IS NULL OR $column = '' )-;
626 qq-( $column IS NULL OR $column = "" )-;
628 } elsif ( $op eq '!=' ) {
629 if ( driver_name eq 'Pg' ) {
630 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
631 qq-( $column IS NOT NULL )-;
633 qq-( $column IS NOT NULL AND $column != '' )-;
636 qq-( $column IS NOT NULL AND $column != "" )-;
639 if ( driver_name eq 'Pg' ) {
640 qq-( $column $op '' )-;
642 qq-( $column $op "" )-;
645 #if this needs to be re-enabled, it needs to use a custom op like
646 #"APPROX=" or something (better name?, not '=', to avoid affecting other
648 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
649 # ( "$column <= ?", "$column >= ?" );
653 } @{ $real_fields } );
656 =item by_key PRIMARY_KEY_VALUE
658 This is a class method that returns the record with the given primary key
659 value. This method is only useful in FS::Record subclasses. For example:
661 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
665 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
670 my ($class, $pkey_value) = @_;
672 my $table = $class->table
673 or croak "No table for $class found";
675 my $dbdef_table = dbdef->table($table)
676 or die "No schema for table $table found - ".
677 "do you need to create it or run dbdef-create?";
678 my $pkey = $dbdef_table->primary_key
679 or die "No primary key for table $table";
681 return qsearchs($table, { $pkey => $pkey_value });
684 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
686 Experimental JOINed search method. Using this method, you can execute a
687 single SELECT spanning multiple tables, and cache the results for subsequent
688 method calls. Interface will almost definately change in an incompatible
696 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
697 my $cache = FS::SearchCache->new( $ptable, $pkey );
700 grep { !$saw{$_->getfield($pkey)}++ }
701 qsearch($table, $record, $select, $extra_sql, $cache )
705 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
707 Same as qsearch, except that if more than one record matches, it B<carp>s but
708 returns the first. If this happens, you either made a logic error in asking
709 for a single item, or your data is corrupted.
713 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
715 my(@result) = qsearch(@_);
716 cluck "warning: Multiple records in scalar search ($table)"
717 if scalar(@result) > 1;
718 #should warn more vehemently if the search was on a primary key?
719 scalar(@result) ? ($result[0]) : ();
730 Returns the table name.
735 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
742 Returns the DBIx::DBSchema::Table object for the table.
748 my($table)=$self->table;
749 dbdef->table($table);
754 Returns the primary key for the table.
760 my $pkey = $self->dbdef_table->primary_key;
763 =item get, getfield COLUMN
765 Returns the value of the column/field/key COLUMN.
770 my($self,$field) = @_;
771 # to avoid "Use of unitialized value" errors
772 if ( defined ( $self->{Hash}->{$field} ) ) {
773 $self->{Hash}->{$field};
783 =item set, setfield COLUMN, VALUE
785 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
790 my($self,$field,$value) = @_;
791 $self->{'modified'} = 1;
792 $self->{'Hash'}->{$field} = $value;
801 Returns true if the column/field/key COLUMN exists.
806 my($self,$field) = @_;
807 exists($self->{Hash}->{$field});
810 =item AUTLOADED METHODS
812 $record->column is a synonym for $record->get('column');
814 $record->column('value') is a synonym for $record->set('column','value');
821 my($field)=$AUTOLOAD;
823 if ( defined($value) ) {
824 confess "errant AUTOLOAD $field for $self (arg $value)"
825 unless blessed($self) && $self->can('setfield');
826 $self->setfield($field,$value);
828 confess "errant AUTOLOAD $field for $self (no args)"
829 unless blessed($self) && $self->can('getfield');
830 $self->getfield($field);
836 # my $field = $AUTOLOAD;
838 # if ( defined($_[1]) ) {
839 # $_[0]->setfield($field, $_[1]);
841 # $_[0]->getfield($field);
847 Returns a list of the column/value pairs, usually for assigning to a new hash.
849 To make a distinct duplicate of an FS::Record object, you can do:
851 $new = new FS::Record ( $old->table, { $old->hash } );
857 confess $self. ' -> hash: Hash attribute is undefined'
858 unless defined($self->{'Hash'});
859 %{ $self->{'Hash'} };
864 Returns a reference to the column/value hash. This may be deprecated in the
865 future; if there's a reason you can't just use the autoloaded or get/set
877 Returns true if any of this object's values have been modified with set (or via
878 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
888 =item select_for_update
890 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
895 sub select_for_update {
897 my $primary_key = $self->primary_key;
900 'table' => $self->table,
901 'hashref' => { $primary_key => $self->$primary_key() },
902 'extra_sql' => 'FOR UPDATE',
908 Locks this table with a database-driver specific lock method. This is used
909 as a mutex in order to do a duplicate search.
911 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
913 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
915 Errors are fatal; no useful return value.
917 Note: To use this method for new tables other than svc_acct and svc_phone,
918 edit freeside-upgrade and add those tables to the duplicate_lock list.
924 my $table = $self->table;
926 warn "$me locking $table table\n" if $DEBUG;
928 if ( driver_name =~ /^Pg/i ) {
930 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
933 } elsif ( driver_name =~ /^mysql/i ) {
935 dbh->do("SELECT * FROM duplicate_lock
936 WHERE lockname = '$table'
938 ) or die dbh->errstr;
942 die "unknown database ". driver_name. "; don't know how to lock table";
946 warn "$me acquired $table table lock\n" if $DEBUG;
952 Inserts this record to the database. If there is an error, returns the error,
953 otherwise returns false.
961 warn "$self -> insert" if $DEBUG;
963 my $error = $self->check;
964 return $error if $error;
966 #single-field unique keys are given a value if false
967 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
968 foreach ( $self->dbdef_table->unique_singles) {
969 $self->unique($_) unless $self->getfield($_);
972 #and also the primary key, if the database isn't going to
973 my $primary_key = $self->dbdef_table->primary_key;
975 if ( $primary_key ) {
976 my $col = $self->dbdef_table->column($primary_key);
979 uc($col->type) =~ /^(BIG)?SERIAL\d?/
980 || ( driver_name eq 'Pg'
981 && defined($col->default)
982 && $col->quoted_default =~ /^nextval\(/i
984 || ( driver_name eq 'mysql'
985 && defined($col->local)
986 && $col->local =~ /AUTO_INCREMENT/i
988 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
991 my $table = $self->table;
993 # Encrypt before the database
994 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
995 && scalar( eval '@FS::'. $table . '::encrypted_fields')
996 && $conf->exists('encryption')
998 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
999 $self->{'saved'} = $self->getfield($field);
1000 $self->setfield($field, $self->encrypt($self->getfield($field)));
1004 #false laziness w/delete
1006 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1009 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1012 my $statement = "INSERT INTO $table ";
1013 if ( @real_fields ) {
1016 join( ', ', @real_fields ).
1018 join( ', ', @values ).
1022 $statement .= 'DEFAULT VALUES';
1024 warn "[debug]$me $statement\n" if $DEBUG > 1;
1025 my $sth = dbh->prepare($statement) or return dbh->errstr;
1027 local $SIG{HUP} = 'IGNORE';
1028 local $SIG{INT} = 'IGNORE';
1029 local $SIG{QUIT} = 'IGNORE';
1030 local $SIG{TERM} = 'IGNORE';
1031 local $SIG{TSTP} = 'IGNORE';
1032 local $SIG{PIPE} = 'IGNORE';
1034 $sth->execute or return $sth->errstr;
1036 # get inserted id from the database, if applicable & needed
1037 if ( $db_seq && ! $self->getfield($primary_key) ) {
1038 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1042 if ( driver_name eq 'Pg' ) {
1044 #my $oid = $sth->{'pg_oid_status'};
1045 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1047 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1048 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1049 dbh->rollback if $FS::UID::AutoCommit;
1050 return "can't parse $table.$primary_key default value".
1051 " for sequence name: $default";
1055 my $i_sql = "SELECT currval('$sequence')";
1056 my $i_sth = dbh->prepare($i_sql) or do {
1057 dbh->rollback if $FS::UID::AutoCommit;
1060 $i_sth->execute() or do { #$i_sth->execute($oid)
1061 dbh->rollback if $FS::UID::AutoCommit;
1062 return $i_sth->errstr;
1064 $insertid = $i_sth->fetchrow_arrayref->[0];
1066 } elsif ( driver_name eq 'mysql' ) {
1068 $insertid = dbh->{'mysql_insertid'};
1069 # work around mysql_insertid being null some of the time, ala RT :/
1070 unless ( $insertid ) {
1071 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1072 "using SELECT LAST_INSERT_ID();";
1073 my $i_sql = "SELECT LAST_INSERT_ID()";
1074 my $i_sth = dbh->prepare($i_sql) or do {
1075 dbh->rollback if $FS::UID::AutoCommit;
1078 $i_sth->execute or do {
1079 dbh->rollback if $FS::UID::AutoCommit;
1080 return $i_sth->errstr;
1082 $insertid = $i_sth->fetchrow_arrayref->[0];
1087 dbh->rollback if $FS::UID::AutoCommit;
1088 return "don't know how to retreive inserted ids from ". driver_name.
1089 ", try using counterfiles (maybe run dbdef-create?)";
1093 $self->setfield($primary_key, $insertid);
1097 my @virtual_fields =
1098 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
1099 $self->virtual_fields;
1100 if (@virtual_fields) {
1101 my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
1103 my $vfieldpart = $self->vfieldpart_hashref;
1105 my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
1108 my $v_sth = dbh->prepare($v_statement) or do {
1109 dbh->rollback if $FS::UID::AutoCommit;
1113 foreach (keys(%v_values)) {
1114 $v_sth->execute($self->getfield($primary_key),
1118 dbh->rollback if $FS::UID::AutoCommit;
1119 return $v_sth->errstr;
1126 if ( defined dbdef->table('h_'. $table) ) {
1127 my $h_statement = $self->_h_statement('insert');
1128 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1129 $h_sth = dbh->prepare($h_statement) or do {
1130 dbh->rollback if $FS::UID::AutoCommit;
1136 $h_sth->execute or return $h_sth->errstr if $h_sth;
1138 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1140 # Now that it has been saved, reset the encrypted fields so that $new
1141 # can still be used.
1142 foreach my $field (keys %{$saved}) {
1143 $self->setfield($field, $saved->{$field});
1151 Depriciated (use insert instead).
1156 cluck "warning: FS::Record::add deprecated!";
1157 insert @_; #call method in this scope
1162 Delete this record from the database. If there is an error, returns the error,
1163 otherwise returns false.
1170 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1172 $self->getfield($_) eq ''
1173 #? "( $_ IS NULL OR $_ = \"\" )"
1174 ? ( driver_name eq 'Pg'
1176 : "( $_ IS NULL OR $_ = \"\" )"
1178 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1179 } ( $self->dbdef_table->primary_key )
1180 ? ( $self->dbdef_table->primary_key)
1181 : real_fields($self->table)
1183 warn "[debug]$me $statement\n" if $DEBUG > 1;
1184 my $sth = dbh->prepare($statement) or return dbh->errstr;
1187 if ( defined dbdef->table('h_'. $self->table) ) {
1188 my $h_statement = $self->_h_statement('delete');
1189 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1190 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1195 my $primary_key = $self->dbdef_table->primary_key;
1198 my $vfp = $self->vfieldpart_hashref;
1199 foreach($self->virtual_fields) {
1200 next if $self->getfield($_) eq '';
1201 unless(@del_vfields) {
1202 my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
1203 $v_sth = dbh->prepare($st) or return dbh->errstr;
1205 push @del_vfields, $_;
1208 local $SIG{HUP} = 'IGNORE';
1209 local $SIG{INT} = 'IGNORE';
1210 local $SIG{QUIT} = 'IGNORE';
1211 local $SIG{TERM} = 'IGNORE';
1212 local $SIG{TSTP} = 'IGNORE';
1213 local $SIG{PIPE} = 'IGNORE';
1215 my $rc = $sth->execute or return $sth->errstr;
1216 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1217 $h_sth->execute or return $h_sth->errstr if $h_sth;
1218 $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
1219 or return $v_sth->errstr
1220 foreach (@del_vfields);
1222 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1224 #no need to needlessly destoy the data either (causes problems actually)
1225 #undef $self; #no need to keep object!
1232 Depriciated (use delete instead).
1237 cluck "warning: FS::Record::del deprecated!";
1238 &delete(@_); #call method in this scope
1241 =item replace OLD_RECORD
1243 Replace the OLD_RECORD with this one in the database. If there is an error,
1244 returns the error, otherwise returns false.
1249 my ($new, $old) = (shift, shift);
1251 $old = $new->replace_old unless defined($old);
1253 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1255 if ( $new->can('replace_check') ) {
1256 my $error = $new->replace_check($old);
1257 return $error if $error;
1260 return "Records not in same table!" unless $new->table eq $old->table;
1262 my $primary_key = $old->dbdef_table->primary_key;
1263 return "Can't change primary key $primary_key ".
1264 'from '. $old->getfield($primary_key).
1265 ' to ' . $new->getfield($primary_key)
1267 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1269 my $error = $new->check;
1270 return $error if $error;
1272 # Encrypt for replace
1274 if ( $conf->exists('encryption')
1275 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1276 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1278 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1279 $saved->{$field} = $new->getfield($field);
1280 $new->setfield($field, $new->encrypt($new->getfield($field)));
1284 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1285 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1286 ? ($_, $new->getfield($_)) : () } $old->fields;
1288 unless (keys(%diff) || $no_update_diff ) {
1289 carp "[warning]$me $new -> replace $old: records identical"
1290 unless $nowarn_identical;
1294 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1296 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1297 } real_fields($old->table)
1302 if ( $old->getfield($_) eq '' ) {
1304 #false laziness w/qsearch
1305 if ( driver_name eq 'Pg' ) {
1306 my $type = $old->dbdef_table->column($_)->type;
1307 if ( $type =~ /(int|(big)?serial)/i ) {
1310 qq-( $_ IS NULL OR $_ = '' )-;
1313 qq-( $_ IS NULL OR $_ = "" )-;
1317 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1320 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1323 warn "[debug]$me $statement\n" if $DEBUG > 1;
1324 my $sth = dbh->prepare($statement) or return dbh->errstr;
1327 if ( defined dbdef->table('h_'. $old->table) ) {
1328 my $h_old_statement = $old->_h_statement('replace_old');
1329 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1330 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1336 if ( defined dbdef->table('h_'. $new->table) ) {
1337 my $h_new_statement = $new->_h_statement('replace_new');
1338 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1339 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1344 # For virtual fields we have three cases with different SQL
1345 # statements: add, replace, delete
1349 my (@add_vfields, @rep_vfields, @del_vfields);
1350 my $vfp = $old->vfieldpart_hashref;
1351 foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
1352 if($diff{$_} eq '') {
1354 unless(@del_vfields) {
1355 my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
1356 "AND vfieldpart = ?";
1357 warn "[debug]$me $st\n" if $DEBUG > 2;
1358 $v_del_sth = dbh->prepare($st) or return dbh->errstr;
1360 push @del_vfields, $_;
1361 } elsif($old->getfield($_) eq '') {
1363 unless(@add_vfields) {
1364 my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
1366 warn "[debug]$me $st\n" if $DEBUG > 2;
1367 $v_add_sth = dbh->prepare($st) or return dbh->errstr;
1369 push @add_vfields, $_;
1372 unless(@rep_vfields) {
1373 my $st = "UPDATE virtual_field SET value = ? ".
1374 "WHERE recnum = ? AND vfieldpart = ?";
1375 warn "[debug]$me $st\n" if $DEBUG > 2;
1376 $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
1378 push @rep_vfields, $_;
1382 local $SIG{HUP} = 'IGNORE';
1383 local $SIG{INT} = 'IGNORE';
1384 local $SIG{QUIT} = 'IGNORE';
1385 local $SIG{TERM} = 'IGNORE';
1386 local $SIG{TSTP} = 'IGNORE';
1387 local $SIG{PIPE} = 'IGNORE';
1389 my $rc = $sth->execute or return $sth->errstr;
1390 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1391 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1392 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1394 $v_del_sth->execute($old->getfield($primary_key),
1396 or return $v_del_sth->errstr
1397 foreach(@del_vfields);
1399 $v_add_sth->execute($new->getfield($_),
1400 $old->getfield($primary_key),
1402 or return $v_add_sth->errstr
1403 foreach(@add_vfields);
1405 $v_rep_sth->execute($new->getfield($_),
1406 $old->getfield($primary_key),
1408 or return $v_rep_sth->errstr
1409 foreach(@rep_vfields);
1411 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1413 # Now that it has been saved, reset the encrypted fields so that $new
1414 # can still be used.
1415 foreach my $field (keys %{$saved}) {
1416 $new->setfield($field, $saved->{$field});
1424 my( $self ) = shift;
1425 warn "[$me] replace called with no arguments; autoloading old record\n"
1428 my $primary_key = $self->dbdef_table->primary_key;
1429 if ( $primary_key ) {
1430 $self->by_key( $self->$primary_key() ) #this is what's returned
1431 or croak "can't find ". $self->table. ".$primary_key ".
1432 $self->$primary_key();
1434 croak $self->table. " has no primary key; pass old record as argument";
1441 Depriciated (use replace instead).
1446 cluck "warning: FS::Record::rep deprecated!";
1447 replace @_; #call method in this scope
1452 Checks virtual fields (using check_blocks). Subclasses should still provide
1453 a check method to validate real fields, foreign keys, etc., and call this
1454 method via $self->SUPER::check.
1456 (FIXME: Should this method try to make sure that it I<is> being called from
1457 a subclass's check method, to keep the current semantics as far as possible?)
1462 #confess "FS::Record::check not implemented; supply one in subclass!";
1465 foreach my $field ($self->virtual_fields) {
1466 for ($self->getfield($field)) {
1467 # See notes on check_block in FS::part_virtual_field.
1468 eval $self->pvf($field)->check_block;
1470 #this is bad, probably want to follow the stack backtrace up and see
1472 my $err = "Fatal error checking $field for $self";
1474 return "$err (see log for backtrace): $@";
1477 $self->setfield($field, $_);
1483 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1485 Processes a batch import as a queued JSRPC job
1487 JOB is an FS::queue entry.
1489 OPTIONS_HASHREF can have the following keys:
1495 Table name (required).
1499 Listref of field names for static fields. They will be given values from the
1500 PARAMS hashref and passed as a "params" hashref to batch_import.
1504 Formats hashref. Keys are field names, values are listrefs that define the
1507 Each listref value can be a column name or a code reference. Coderefs are run
1508 with the row object, data and a FS::Conf object as the three parameters.
1509 For example, this coderef does the same thing as using the "columnname" string:
1512 my( $record, $data, $conf ) = @_;
1513 $record->columnname( $data );
1516 Coderefs are run after all "column name" fields are assigned.
1520 Optional format hashref of types. Keys are field names, values are "csv",
1521 "xls" or "fixedlength". Overrides automatic determination of file type
1524 =item format_headers
1526 Optional format hashref of header lines. Keys are field names, values are 0
1527 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1530 =item format_sep_chars
1532 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1533 CSV separation character.
1535 =item format_fixedlenth_formats
1537 Optional format hashref of fixed length format defintiions. Keys are field
1538 names, values Parse::FixedLength listrefs of field definitions.
1542 Set true to default to CSV file type if the filename does not contain a
1543 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1548 PARAMS is a base64-encoded Storable string containing the POSTed data as
1549 a hash ref. It normally contains at least one field, "uploaded files",
1550 generated by /elements/file-upload.html and containing the list of uploaded
1551 files. Currently only supports a single file named "file".
1555 use Storable qw(thaw);
1558 sub process_batch_import {
1559 my($job, $opt) = ( shift, shift );
1561 my $table = $opt->{table};
1562 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1563 my %formats = %{ $opt->{formats} };
1565 my $param = thaw(decode_base64(shift));
1566 warn Dumper($param) if $DEBUG;
1568 my $files = $param->{'uploaded_files'}
1569 or die "No files provided.\n";
1571 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1573 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1574 my $file = $dir. $files{'file'};
1579 formats => \%formats,
1580 format_types => $opt->{format_types},
1581 format_headers => $opt->{format_headers},
1582 format_sep_chars => $opt->{format_sep_chars},
1583 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1584 format_xml_formats => $opt->{format_xml_formats},
1585 format_row_callbacks => $opt->{format_row_callbacks},
1590 format => $param->{format},
1591 params => { map { $_ => $param->{$_} } @pass_params },
1593 default_csv => $opt->{default_csv},
1594 postinsert_callback => $opt->{postinsert_callback},
1597 if ( $opt->{'batch_namecol'} ) {
1598 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1599 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1602 my $error = FS::Record::batch_import( \%iopt );
1606 die "$error\n" if $error;
1609 =item batch_import PARAM_HASHREF
1611 Class method for batch imports. Available params:
1617 =item format - usual way to specify import, with this format string selecting data from the formats and format_* info hashes
1623 =item format_headers
1625 =item format_sep_chars
1627 =item format_fixedlength_formats
1629 =item format_row_callbacks
1631 =item fields - Alternate way to specify import, specifying import fields directly as a listref
1633 =item preinsert_callback
1635 =item postinsert_callback
1641 FS::queue object, will be updated with progress
1647 csv, xls, fixedlength, xml
1658 warn "$me batch_import call with params: \n". Dumper($param)
1661 my $table = $param->{table};
1663 my $job = $param->{job};
1664 my $file = $param->{file};
1665 my $params = $param->{params} || {};
1667 my( $type, $header, $sep_char, $fixedlength_format,
1668 $xml_format, $row_callback, @fields );
1670 my $postinsert_callback = '';
1671 $postinsert_callback = $param->{'postinsert_callback'}
1672 if $param->{'postinsert_callback'};
1673 my $preinsert_callback = '';
1674 $preinsert_callback = $param->{'preinsert_callback'}
1675 if $param->{'preinsert_callback'};
1677 if ( $param->{'format'} ) {
1679 my $format = $param->{'format'};
1680 my $formats = $param->{formats};
1681 die "unknown format $format" unless exists $formats->{ $format };
1683 $type = $param->{'format_types'}
1684 ? $param->{'format_types'}{ $format }
1685 : $param->{type} || 'csv';
1688 $header = $param->{'format_headers'}
1689 ? $param->{'format_headers'}{ $param->{'format'} }
1692 $sep_char = $param->{'format_sep_chars'}
1693 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1696 $fixedlength_format =
1697 $param->{'format_fixedlength_formats'}
1698 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1702 $param->{'format_xml_formats'}
1703 ? $param->{'format_xml_formats'}{ $param->{'format'} }
1707 $param->{'format_row_callbacks'}
1708 ? $param->{'format_row_callbacks'}{ $param->{'format'} }
1711 @fields = @{ $formats->{ $format } };
1713 } elsif ( $param->{'fields'} ) {
1715 $type = ''; #infer from filename
1718 $fixedlength_format = '';
1720 @fields = @{ $param->{'fields'} };
1723 die "neither format nor fields specified";
1726 #my $file = $param->{file};
1729 if ( $file =~ /\.(\w+)$/i ) {
1733 warn "can't parse file type from filename $file; defaulting to CSV";
1737 if $param->{'default_csv'} && $type ne 'xls';
1745 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1747 if ( $type eq 'csv' ) {
1750 $attr{sep_char} = $sep_char if $sep_char;
1751 $parser = new Text::CSV_XS \%attr;
1753 } elsif ( $type eq 'fixedlength' ) {
1755 eval "use Parse::FixedLength;";
1757 $parser = Parse::FixedLength->new($fixedlength_format);
1761 die "Unknown file type $type\n";
1764 @buffer = split(/\r?\n/, slurp($file) );
1765 splice(@buffer, 0, ($header || 0) );
1766 $count = scalar(@buffer);
1768 } elsif ( $type eq 'xls' ) {
1770 eval "use Spreadsheet::ParseExcel;";
1773 eval "use DateTime::Format::Excel;";
1774 #for now, just let the error be thrown if it is used, since only CDR
1775 # formats bill_west and troop use it, not other excel-parsing things
1778 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1780 $parser = $excel->{Worksheet}[0]; #first sheet
1782 $count = $parser->{MaxRow} || $parser->{MinRow};
1785 $row = $header || 0;
1786 } elsif ( $type eq 'xml' ) {
1788 eval "use XML::Simple;";
1790 my $xmlrow = $xml_format->{'xmlrow'};
1791 $parser = $xml_format->{'xmlkeys'};
1792 die 'no xmlkeys specified' unless ref $parser eq 'ARRAY';
1793 my $data = XML::Simple::XMLin(
1795 'SuppressEmpty' => '', #sets empty values to ''
1799 $rows = $rows->{$_} foreach @$xmlrow;
1800 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
1801 $count = @buffer = @$rows;
1803 die "Unknown file type $type\n";
1808 local $SIG{HUP} = 'IGNORE';
1809 local $SIG{INT} = 'IGNORE';
1810 local $SIG{QUIT} = 'IGNORE';
1811 local $SIG{TERM} = 'IGNORE';
1812 local $SIG{TSTP} = 'IGNORE';
1813 local $SIG{PIPE} = 'IGNORE';
1815 my $oldAutoCommit = $FS::UID::AutoCommit;
1816 local $FS::UID::AutoCommit = 0;
1819 #my $params = $param->{params} || {};
1820 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1821 my $batch_col = $param->{'batch_keycol'};
1823 my $batch_class = 'FS::'. $param->{'batch_table'};
1824 my $batch = $batch_class->new({
1825 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1827 my $error = $batch->insert;
1829 $dbh->rollback if $oldAutoCommit;
1830 return "can't insert batch record: $error";
1832 #primary key via dbdef? (so the column names don't have to match)
1833 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1835 $params->{ $batch_col } = $batch_value;
1838 #my $job = $param->{job};
1841 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1845 if ( $type eq 'csv' ) {
1847 last unless scalar(@buffer);
1848 $line = shift(@buffer);
1850 next if $line =~ /^\s*$/; #skip empty lines
1852 $line = &{$row_callback}($line) if $row_callback;
1854 $parser->parse($line) or do {
1855 $dbh->rollback if $oldAutoCommit;
1856 return "can't parse: ". $parser->error_input();
1858 @columns = $parser->fields();
1860 } elsif ( $type eq 'fixedlength' ) {
1862 last unless scalar(@buffer);
1863 $line = shift(@buffer);
1865 @columns = $parser->parse($line);
1867 } elsif ( $type eq 'xls' ) {
1869 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1870 || ! $parser->{Cells}[$row];
1872 my @row = @{ $parser->{Cells}[$row] };
1873 @columns = map $_->{Val}, @row;
1876 #warn $z++. ": $_\n" for @columns;
1878 } elsif ( $type eq 'xml' ) {
1879 # $parser = [ 'Column0Key', 'Column1Key' ... ]
1880 last unless scalar(@buffer);
1881 my $row = shift @buffer;
1882 @columns = @{ $row }{ @$parser };
1884 die "Unknown file type $type\n";
1888 my %hash = %$params;
1890 foreach my $field ( @fields ) {
1892 my $value = shift @columns;
1894 if ( ref($field) eq 'CODE' ) {
1895 #&{$field}(\%hash, $value);
1896 push @later, $field, $value;
1898 #??? $hash{$field} = $value if length($value);
1899 $hash{$field} = $value if defined($value) && length($value);
1904 #my $table = $param->{table};
1905 my $class = "FS::$table";
1907 my $record = $class->new( \%hash );
1910 while ( scalar(@later) ) {
1911 my $sub = shift @later;
1912 my $data = shift @later;
1914 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf)
1917 $dbh->rollback if $oldAutoCommit;
1918 return "can't insert record". ( $line ? " for $line" : '' ). ": $@";
1920 last if exists( $param->{skiprow} );
1922 next if exists( $param->{skiprow} );
1924 if ( $preinsert_callback ) {
1925 my $error = &{$preinsert_callback}($record, $param);
1927 $dbh->rollback if $oldAutoCommit;
1928 return "preinsert_callback error". ( $line ? " for $line" : '' ).
1931 next if exists $param->{skiprow} && $param->{skiprow};
1934 my $error = $record->insert;
1937 $dbh->rollback if $oldAutoCommit;
1938 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1944 if ( $postinsert_callback ) {
1945 my $error = &{$postinsert_callback}($record, $param);
1947 $dbh->rollback if $oldAutoCommit;
1948 return "postinsert_callback error". ( $line ? " for $line" : '' ).
1953 if ( $job && time - $min_sec > $last ) { #progress bar
1954 $job->update_statustext( int(100 * $imported / $count) );
1960 unless ( $imported || $param->{empty_ok} ) {
1961 $dbh->rollback if $oldAutoCommit;
1962 return "Empty file!";
1965 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1972 my( $self, $action, $time ) = @_;
1976 my %nohistory = map { $_=>1 } $self->nohistory_fields;
1979 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
1980 real_fields($self->table);
1983 # If we're encrypting then don't store the payinfo in the history
1984 if ( $conf && $conf->exists('encryption') ) {
1985 @fields = grep { $_ ne 'payinfo' } @fields;
1988 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1990 "INSERT INTO h_". $self->table. " ( ".
1991 join(', ', qw(history_date history_user history_action), @fields ).
1993 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
2000 B<Warning>: External use is B<deprecated>.
2002 Replaces COLUMN in record with a unique number, using counters in the
2003 filesystem. Used by the B<insert> method on single-field unique columns
2004 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
2005 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
2007 Returns the new value.
2012 my($self,$field) = @_;
2013 my($table)=$self->table;
2015 croak "Unique called on field $field, but it is ",
2016 $self->getfield($field),
2018 if $self->getfield($field);
2020 #warn "table $table is tainted" if is_tainted($table);
2021 #warn "field $field is tainted" if is_tainted($field);
2023 my($counter) = new File::CounterFile "$table.$field",0;
2025 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
2027 # my($counter) = new File::CounterFile "$user/$table.$field",0;
2030 my $index = $counter->inc;
2031 $index = $counter->inc while qsearchs($table, { $field=>$index } );
2033 $index =~ /^(\d*)$/;
2036 $self->setfield($field,$index);
2040 =item ut_float COLUMN
2042 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
2043 null. If there is an error, returns the error, otherwise returns false.
2048 my($self,$field)=@_ ;
2049 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
2050 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
2051 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
2052 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
2053 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2054 $self->setfield($field,$1);
2057 =item ut_floatn COLUMN
2059 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2060 null. If there is an error, returns the error, otherwise returns false.
2064 #false laziness w/ut_ipn
2066 my( $self, $field ) = @_;
2067 if ( $self->getfield($field) =~ /^()$/ ) {
2068 $self->setfield($field,'');
2071 $self->ut_float($field);
2075 =item ut_sfloat COLUMN
2077 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
2078 May not be null. If there is an error, returns the error, otherwise returns
2084 my($self,$field)=@_ ;
2085 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
2086 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
2087 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
2088 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
2089 or return "Illegal or empty (float) $field: ". $self->getfield($field);
2090 $self->setfield($field,$1);
2093 =item ut_sfloatn COLUMN
2095 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
2096 null. If there is an error, returns the error, otherwise returns false.
2101 my( $self, $field ) = @_;
2102 if ( $self->getfield($field) =~ /^()$/ ) {
2103 $self->setfield($field,'');
2106 $self->ut_sfloat($field);
2110 =item ut_snumber COLUMN
2112 Check/untaint signed numeric data (whole numbers). If there is an error,
2113 returns the error, otherwise returns false.
2118 my($self, $field) = @_;
2119 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2120 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2121 $self->setfield($field, "$1$2");
2125 =item ut_snumbern COLUMN
2127 Check/untaint signed numeric data (whole numbers). If there is an error,
2128 returns the error, otherwise returns false.
2133 my($self, $field) = @_;
2134 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2135 or return "Illegal (numeric) $field: ". $self->getfield($field);
2137 return "Illegal (numeric) $field: ". $self->getfield($field)
2140 $self->setfield($field, "$1$2");
2144 =item ut_number COLUMN
2146 Check/untaint simple numeric data (whole numbers). May not be null. If there
2147 is an error, returns the error, otherwise returns false.
2152 my($self,$field)=@_;
2153 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2154 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2155 $self->setfield($field,$1);
2159 =item ut_numbern COLUMN
2161 Check/untaint simple numeric data (whole numbers). May be null. If there is
2162 an error, returns the error, otherwise returns false.
2167 my($self,$field)=@_;
2168 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2169 or return "Illegal (numeric) $field: ". $self->getfield($field);
2170 $self->setfield($field,$1);
2174 =item ut_money COLUMN
2176 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2177 is an error, returns the error, otherwise returns false.
2182 my($self,$field)=@_;
2183 $self->setfield($field, 0) if $self->getfield($field) eq '';
2184 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
2185 or return "Illegal (money) $field: ". $self->getfield($field);
2186 #$self->setfield($field, "$1$2$3" || 0);
2187 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2191 =item ut_moneyn COLUMN
2193 Check/untaint monetary numbers. May be negative. If there
2194 is an error, returns the error, otherwise returns false.
2199 my($self,$field)=@_;
2200 if ($self->getfield($field) eq '') {
2201 $self->setfield($field, '');
2204 $self->ut_money($field);
2207 =item ut_text COLUMN
2209 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2210 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2211 May not be null. If there is an error, returns the error, otherwise returns
2217 my($self,$field)=@_;
2218 #warn "msgcat ". \&msgcat. "\n";
2219 #warn "notexist ". \¬exist. "\n";
2220 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2221 $self->getfield($field)
2222 =~ /^([µ_0123456789aAáÁàÀâÂåÅäÄãêæÆbBcCçÇdDðÐeEéÉèÈêÊëËfFgGhHiIíÍìÌîÎïÏjJkKlLmMnNñÑoOóÓòÒôÔöÖõÕøغpPqQrRsSßtTuUúÚùÙûÛüÜvVwWxXyYýÝÿzZþÞ \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>]+)$/
2223 or return gettext('illegal_or_empty_text'). " $field: ".
2224 $self->getfield($field);
2225 $self->setfield($field,$1);
2229 =item ut_textn COLUMN
2231 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2232 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
2233 May be null. If there is an error, returns the error, otherwise returns false.
2238 my($self,$field)=@_;
2239 return $self->setfield($field, '') if $self->getfield($field) =~ /^$/;
2240 $self->ut_text($field);
2243 =item ut_alpha COLUMN
2245 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2246 an error, returns the error, otherwise returns false.
2251 my($self,$field)=@_;
2252 $self->getfield($field) =~ /^(\w+)$/
2253 or return "Illegal or empty (alphanumeric) $field: ".
2254 $self->getfield($field);
2255 $self->setfield($field,$1);
2259 =item ut_alphan COLUMN
2261 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2262 error, returns the error, otherwise returns false.
2267 my($self,$field)=@_;
2268 $self->getfield($field) =~ /^(\w*)$/
2269 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2270 $self->setfield($field,$1);
2274 =item ut_alphasn COLUMN
2276 Check/untaint alphanumeric strings, spaces allowed. May be null. If there is
2277 an error, returns the error, otherwise returns false.
2282 my($self,$field)=@_;
2283 $self->getfield($field) =~ /^([\w ]*)$/
2284 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2285 $self->setfield($field,$1);
2290 =item ut_alpha_lower COLUMN
2292 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2293 there is an error, returns the error, otherwise returns false.
2297 sub ut_alpha_lower {
2298 my($self,$field)=@_;
2299 $self->getfield($field) =~ /[[:upper:]]/
2300 and return "Uppercase characters are not permitted in $field";
2301 $self->ut_alpha($field);
2304 =item ut_phonen COLUMN [ COUNTRY ]
2306 Check/untaint phone numbers. May be null. If there is an error, returns
2307 the error, otherwise returns false.
2309 Takes an optional two-letter ISO country code; without it or with unsupported
2310 countries, ut_phonen simply calls ut_alphan.
2315 my( $self, $field, $country ) = @_;
2316 return $self->ut_alphan($field) unless defined $country;
2317 my $phonen = $self->getfield($field);
2318 if ( $phonen eq '' ) {
2319 $self->setfield($field,'');
2320 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2322 $phonen = $conf->config('cust_main-default_areacode').$phonen
2323 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2324 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2325 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2326 $phonen = "$1-$2-$3";
2327 $phonen .= " x$4" if $4;
2328 $self->setfield($field,$phonen);
2330 warn "warning: don't know how to check phone numbers for country $country";
2331 return $self->ut_textn($field);
2338 Check/untaint hexadecimal values.
2343 my($self, $field) = @_;
2344 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2345 or return "Illegal (hex) $field: ". $self->getfield($field);
2346 $self->setfield($field, uc($1));
2350 =item ut_hexn COLUMN
2352 Check/untaint hexadecimal values. May be null.
2357 my($self, $field) = @_;
2358 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2359 or return "Illegal (hex) $field: ". $self->getfield($field);
2360 $self->setfield($field, uc($1));
2365 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2371 my( $self, $field ) = @_;
2372 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2373 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2374 or return "Illegal (IP address) $field: ". $self->getfield($field);
2375 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2376 $self->setfield($field, "$1.$2.$3.$4");
2382 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2383 to 127.0.0.1. May be null.
2388 my( $self, $field ) = @_;
2389 if ( $self->getfield($field) =~ /^()$/ ) {
2390 $self->setfield($field,'');
2393 $self->ut_ip($field);
2397 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2399 Check/untaint coordinates.
2400 Accepts the following forms:
2410 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2411 The latter form (that is, the MMM are thousands of minutes) is
2412 assumed if the "MMM" is exactly three digits or two digits > 59.
2414 To be safe, just use the DDD.DDDDD form.
2416 If LOWER or UPPER are specified, then the coordinate is checked
2417 for lower and upper bounds, respectively.
2423 my ($self, $field) = (shift, shift);
2425 my $lower = shift if scalar(@_);
2426 my $upper = shift if scalar(@_);
2427 my $coord = $self->getfield($field);
2428 my $neg = $coord =~ s/^(-)//;
2430 my ($d, $m, $s) = (0, 0, 0);
2433 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2434 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2435 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2437 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2440 return "Invalid (coordinate with minutes > 59) $field: "
2441 . $self->getfield($field);
2444 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2446 if (defined($lower) and ($coord < $lower)) {
2447 return "Invalid (coordinate < $lower) $field: "
2448 . $self->getfield($field);;
2451 if (defined($upper) and ($coord > $upper)) {
2452 return "Invalid (coordinate > $upper) $field: "
2453 . $self->getfield($field);;
2456 $self->setfield($field, $coord);
2460 return "Invalid (coordinate) $field: " . $self->getfield($field);
2464 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2466 Same as ut_coord, except optionally null.
2472 my ($self, $field) = (shift, shift);
2474 if ($self->getfield($field) =~ /^$/) {
2477 return $self->ut_coord($field, @_);
2483 =item ut_domain COLUMN
2485 Check/untaint host and domain names.
2490 my( $self, $field ) = @_;
2491 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2492 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2493 or return "Illegal (domain) $field: ". $self->getfield($field);
2494 $self->setfield($field,$1);
2498 =item ut_name COLUMN
2500 Check/untaint proper names; allows alphanumerics, spaces and the following
2501 punctuation: , . - '
2508 my( $self, $field ) = @_;
2509 # warn "ut_name allowed alphanumerics: +(sort grep /\w/, map { chr() } 0..255), "\n";
2510 #$self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2511 $self->getfield($field) =~ /^([µ_0123456789aAáÁàÀâÂåÅäÄãêæÆbBcCçÇdDðÐeEéÉèÈêÊëËfFgGhHiIíÍìÌîÎïÏjJkKlLmMnNñÑoOóÓòÒôÔöÖõÕøغpPqQrRsSßtTuUúÚùÙûÛüÜvVwWxXyYýÝÿzZþÞ \,\.\-\']+)$/
2512 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2513 $self->setfield($field,$1);
2519 Check/untaint zip codes.
2523 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2526 my( $self, $field, $country ) = @_;
2528 if ( $country eq 'US' ) {
2530 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2531 or return gettext('illegal_zip'). " $field for country $country: ".
2532 $self->getfield($field);
2533 $self->setfield($field, $1);
2535 } elsif ( $country eq 'CA' ) {
2537 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2538 or return gettext('illegal_zip'). " $field for country $country: ".
2539 $self->getfield($field);
2540 $self->setfield($field, "$1 $2");
2544 if ( $self->getfield($field) =~ /^\s*$/
2545 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2548 $self->setfield($field,'');
2550 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
2551 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2552 $self->setfield($field,$1);
2560 =item ut_country COLUMN
2562 Check/untaint country codes. Country names are changed to codes, if possible -
2563 see L<Locale::Country>.
2568 my( $self, $field ) = @_;
2569 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2570 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2571 && country2code($1) ) {
2572 $self->setfield($field,uc(country2code($1)));
2575 $self->getfield($field) =~ /^(\w\w)$/
2576 or return "Illegal (country) $field: ". $self->getfield($field);
2577 $self->setfield($field,uc($1));
2581 =item ut_anything COLUMN
2583 Untaints arbitrary data. Be careful.
2588 my( $self, $field ) = @_;
2589 $self->getfield($field) =~ /^(.*)$/s
2590 or return "Illegal $field: ". $self->getfield($field);
2591 $self->setfield($field,$1);
2595 =item ut_enum COLUMN CHOICES_ARRAYREF
2597 Check/untaint a column, supplying all possible choices, like the "enum" type.
2602 my( $self, $field, $choices ) = @_;
2603 foreach my $choice ( @$choices ) {
2604 if ( $self->getfield($field) eq $choice ) {
2605 $self->setfield($field, $choice);
2609 return "Illegal (enum) field $field: ". $self->getfield($field);
2612 =item ut_enumn COLUMN CHOICES_ARRAYREF
2614 Like ut_enum, except the null value is also allowed.
2619 my( $self, $field, $choices ) = @_;
2620 $self->getfield($field)
2621 ? $self->ut_enum($field, $choices)
2626 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2628 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2629 on the column first.
2633 sub ut_foreign_key {
2634 my( $self, $field, $table, $foreign ) = @_;
2635 return '' if $no_check_foreign;
2636 qsearchs($table, { $foreign => $self->getfield($field) })
2637 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2638 " in $table.$foreign";
2642 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2644 Like ut_foreign_key, except the null value is also allowed.
2648 sub ut_foreign_keyn {
2649 my( $self, $field, $table, $foreign ) = @_;
2650 $self->getfield($field)
2651 ? $self->ut_foreign_key($field, $table, $foreign)
2655 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2657 Checks this column as an agentnum, taking into account the current users's
2658 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2659 right or rights allowing no agentnum.
2663 sub ut_agentnum_acl {
2664 my( $self, $field ) = (shift, shift);
2665 my $null_acl = scalar(@_) ? shift : [];
2666 $null_acl = [ $null_acl ] unless ref($null_acl);
2668 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2669 return "Illegal agentnum: $error" if $error;
2671 my $curuser = $FS::CurrentUser::CurrentUser;
2673 if ( $self->$field() ) {
2675 return "Access denied"
2676 unless $curuser->agentnum($self->$field());
2680 return "Access denied"
2681 unless grep $curuser->access_right($_), @$null_acl;
2689 =item virtual_fields [ TABLE ]
2691 Returns a list of virtual fields defined for the table. This should not
2692 be exported, and should only be called as an instance or class method.
2696 sub virtual_fields {
2699 $table = $self->table or confess "virtual_fields called on non-table";
2701 confess "Unknown table $table" unless dbdef->table($table);
2703 return () unless dbdef->table('part_virtual_field');
2705 unless ( $virtual_fields_cache{$table} ) {
2706 my $query = 'SELECT name from part_virtual_field ' .
2707 "WHERE dbtable = '$table'";
2709 my $result = $dbh->selectcol_arrayref($query);
2710 confess "Error executing virtual fields query: $query: ". $dbh->errstr
2712 $virtual_fields_cache{$table} = $result;
2715 @{$virtual_fields_cache{$table}};
2720 =item fields [ TABLE ]
2722 This is a wrapper for real_fields and virtual_fields. Code that called
2723 fields before should probably continue to call fields.
2728 my $something = shift;
2730 if($something->isa('FS::Record')) {
2731 $table = $something->table;
2733 $table = $something;
2734 $something = "FS::$table";
2736 return (real_fields($table), $something->virtual_fields());
2739 =item pvf FIELD_NAME
2741 Returns the FS::part_virtual_field object corresponding to a field in the
2742 record (specified by FIELD_NAME).
2747 my ($self, $name) = (shift, shift);
2749 if(grep /^$name$/, $self->virtual_fields) {
2750 return qsearchs('part_virtual_field', { dbtable => $self->table,
2756 =item vfieldpart_hashref TABLE
2758 Returns a hashref of virtual field names and vfieldparts applicable to the given
2763 sub vfieldpart_hashref {
2765 my $table = $self->table;
2767 return {} unless dbdef->table('part_virtual_field');
2770 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
2771 "dbtable = '$table'";
2772 my $sth = $dbh->prepare($statement);
2773 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
2774 return { map { $_->{name}, $_->{vfieldpart} }
2775 @{$sth->fetchall_arrayref({})} };
2779 =item encrypt($value)
2781 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2783 Returns the encrypted string.
2785 You should generally not have to worry about calling this, as the system handles this for you.
2790 my ($self, $value) = @_;
2793 if ($conf->exists('encryption')) {
2794 if ($self->is_encrypted($value)) {
2795 # Return the original value if it isn't plaintext.
2796 $encrypted = $value;
2799 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2800 # RSA doesn't like the empty string so let's pack it up
2801 # The database doesn't like the RSA data so uuencode it
2802 my $length = length($value)+1;
2803 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2805 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2812 =item is_encrypted($value)
2814 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2820 my ($self, $value) = @_;
2821 # Possible Bug - Some work may be required here....
2823 if ($value =~ /^M/ && length($value) > 80) {
2830 =item decrypt($value)
2832 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2834 You should generally not have to worry about calling this, as the system handles this for you.
2839 my ($self,$value) = @_;
2840 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2841 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2843 if (ref($rsa_decrypt) =~ /::RSA/) {
2844 my $encrypted = unpack ("u*", $value);
2845 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2846 if ($@) {warn "Decryption Failed"};
2854 #Initialize the Module
2855 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2857 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2858 $rsa_module = $conf->config('encryptionmodule');
2862 eval ("require $rsa_module"); # No need to import the namespace
2865 # Initialize Encryption
2866 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2867 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2868 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2871 # Intitalize Decryption
2872 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2873 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2874 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2878 =item h_search ACTION
2880 Given an ACTION, either "insert", or "delete", returns the appropriate history
2881 record corresponding to this record, if any.
2886 my( $self, $action ) = @_;
2888 my $table = $self->table;
2891 my $primary_key = dbdef->table($table)->primary_key;
2894 'table' => "h_$table",
2895 'hashref' => { $primary_key => $self->$primary_key(),
2896 'history_action' => $action,
2904 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2905 appropriate history record corresponding to this record, if any.
2910 my($self, $action) = @_;
2911 my $h = $self->h_search($action);
2912 $h ? $h->history_date : '';
2915 =item scalar_sql SQL [ PLACEHOLDER, ... ]
2917 A class or object method. Executes the sql statement represented by SQL and
2918 returns a scalar representing the result: the first column of the first row.
2920 Dies on bogus SQL. Returns an empty string if no row is returned.
2922 Typically used for statments which return a single value such as "SELECT
2923 COUNT(*) FROM table WHERE something" OR "SELECT column FROM table WHERE key = ?"
2928 my($self, $sql) = (shift, shift);
2929 my $sth = dbh->prepare($sql) or die dbh->errstr;
2931 or die "Unexpected error executing statement $sql: ". $sth->errstr;
2932 my $scalar = $sth->fetchrow_arrayref->[0];
2933 defined($scalar) ? $scalar : '';
2942 =item real_fields [ TABLE ]
2944 Returns a list of the real columns in the specified table. Called only by
2945 fields() and other subroutines elsewhere in FS::Record.
2952 my($table_obj) = dbdef->table($table);
2953 confess "Unknown table $table" unless $table_obj;
2954 $table_obj->columns;
2957 =item _quote VALUE, TABLE, COLUMN
2959 This is an internal function used to construct SQL statements. It returns
2960 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2961 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2966 my($value, $table, $column) = @_;
2967 my $column_obj = dbdef->table($table)->column($column);
2968 my $column_type = $column_obj->type;
2969 my $nullable = $column_obj->null;
2971 warn " $table.$column: $value ($column_type".
2972 ( $nullable ? ' NULL' : ' NOT NULL' ).
2973 ")\n" if $DEBUG > 2;
2975 if ( $value eq '' && $nullable ) {
2977 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2978 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2981 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2982 ! $column_type =~ /(char|binary|text)$/i ) {
2984 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
2985 && driver_name eq 'Pg'
2989 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
2990 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
2991 # single-quote the whole mess, and put an "E" in front.
2992 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
3000 This is deprecated. Don't use it.
3002 It returns a hash-type list with the fields of this record's table set true.
3007 carp "warning: hfields is deprecated";
3010 foreach (fields($table)) {
3019 "$_: ". $self->getfield($_). "|"
3020 } (fields($self->table)) );
3023 sub DESTROY { return; }
3027 # #use Carp qw(cluck);
3028 # #cluck "DESTROYING $self";
3029 # warn "DESTROYING $self";
3033 # return ! eval { join('',@_), kill 0; 1; };
3036 =item str2time_sql [ DRIVER_NAME ]
3038 Returns a function to convert to unix time based on database type, such as
3039 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
3040 the str2time_sql_closing method to return a closing string rather than just
3041 using a closing parenthesis as previously suggested.
3043 You can pass an optional driver name such as "Pg", "mysql" or
3044 $dbh->{Driver}->{Name} to return a function for that database instead of
3045 the current database.
3050 my $driver = shift || driver_name;
3052 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
3053 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
3055 warn "warning: unknown database type $driver; guessing how to convert ".
3056 "dates to UNIX timestamps";
3057 return 'EXTRACT(EPOCH FROM ';
3061 =item str2time_sql_closing [ DRIVER_NAME ]
3063 Returns the closing suffix of a function to convert to unix time based on
3064 database type, such as ")::integer" for Pg or ")" for mysql.
3066 You can pass an optional driver name such as "Pg", "mysql" or
3067 $dbh->{Driver}->{Name} to return a function for that database instead of
3068 the current database.
3072 sub str2time_sql_closing {
3073 my $driver = shift || driver_name;
3075 return ' )::INTEGER ' if $driver =~ /^Pg/i;
3079 =item regexp_sql [ DRIVER_NAME ]
3081 Returns the operator to do a regular expression comparison based on database
3082 type, such as '~' for Pg or 'REGEXP' for mysql.
3084 You can pass an optional driver name such as "Pg", "mysql" or
3085 $dbh->{Driver}->{Name} to return a function for that database instead of
3086 the current database.
3091 my $driver = shift || driver_name;
3093 return '~' if $driver =~ /^Pg/i;
3094 return 'REGEXP' if $driver =~ /^mysql/i;
3096 die "don't know how to use regular expressions in ". driver_name." databases";
3100 =item not_regexp_sql [ DRIVER_NAME ]
3102 Returns the operator to do a regular expression negation based on database
3103 type, such as '!~' for Pg or 'NOT REGEXP' for mysql.
3105 You can pass an optional driver name such as "Pg", "mysql" or
3106 $dbh->{Driver}->{Name} to return a function for that database instead of
3107 the current database.
3111 sub not_regexp_sql {
3112 my $driver = shift || driver_name;
3114 return '!~' if $driver =~ /^Pg/i;
3115 return 'NOT REGEXP' if $driver =~ /^mysql/i;
3117 die "don't know how to use regular expressions in ". driver_name." databases";
3125 This module should probably be renamed, since much of the functionality is
3126 of general use. It is not completely unlike Adapter::DBI (see below).
3128 Exported qsearch and qsearchs should be deprecated in favor of method calls
3129 (against an FS::Record object like the old search and searchs that qsearch
3130 and qsearchs were on top of.)
3132 The whole fields / hfields mess should be removed.
3134 The various WHERE clauses should be subroutined.
3136 table string should be deprecated in favor of DBIx::DBSchema::Table.
3138 No doubt we could benefit from a Tied hash. Documenting how exists / defined
3139 true maps to the database (and WHERE clauses) would also help.
3141 The ut_ methods should ask the dbdef for a default length.
3143 ut_sqltype (like ut_varchar) should all be defined
3145 A fallback check method should be provided which uses the dbdef.
3147 The ut_money method assumes money has two decimal digits.
3149 The Pg money kludge in the new method only strips `$'.
3151 The ut_phonen method only checks US-style phone numbers.
3153 The _quote function should probably use ut_float instead of a regex.
3155 All the subroutines probably should be methods, here or elsewhere.
3157 Probably should borrow/use some dbdef methods where appropriate (like sub
3160 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
3161 or allow it to be set. Working around it is ugly any way around - DBI should
3162 be fixed. (only affects RDBMS which return uppercase column names)
3164 ut_zip should take an optional country like ut_phone.
3168 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
3170 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.