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 );
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 my $record = shift @record;
354 my $select = shift @select;
355 my $extra_sql = shift @extra_sql;
356 my $extra_param = shift @extra_param;
357 my $order_by = shift @order_by;
358 my $cache = shift @cache;
359 my $addl_from = shift @addl_from;
360 my $debug = shift @debug;
362 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
364 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
367 my $table = $cache ? $cache->table : $stable;
368 my $dbdef_table = dbdef->table($table)
369 or die "No schema for table $table found - ".
370 "do you need to run freeside-upgrade?";
371 my $pkey = $dbdef_table->primary_key;
373 my @real_fields = grep exists($record->{$_}), real_fields($table);
375 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
376 @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
378 cluck "warning: FS::$table not loaded; virtual fields not searchable"
379 unless $nowarn_classload;
380 @virtual_fields = ();
383 my $statement .= "SELECT $select FROM $stable";
384 $statement .= " $addl_from" if $addl_from;
385 if ( @real_fields or @virtual_fields ) {
386 $statement .= ' WHERE '. join(' AND ',
387 get_real_fields($table, $record, \@real_fields) ,
388 get_virtual_fields($table, $pkey, $record, \@virtual_fields),
392 $statement .= " $extra_sql" if defined($extra_sql);
393 $statement .= " $order_by" if defined($order_by);
395 push @statement, $statement;
397 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
401 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
404 my $value = $record->{$field};
405 my $op = (ref($value) && $value->{op}) ? $value->{op} : '=';
406 $value = $value->{'value'} if ref($value);
407 my $type = dbdef->table($table)->column($field)->type;
409 my $bind_type = _bind_type($type, $value);
413 # %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
415 # warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
419 push @bind_type, $bind_type;
423 foreach my $param ( @$extra_param ) {
424 my $bind_type = { TYPE => SQL_VARCHAR };
427 $value = $param->[0];
428 my $type = $param->[1];
429 $bind_type = _bind_type($type, $value);
432 push @bind_type, $bind_type;
436 my $statement = join( ' ) UNION ( ', @statement );
437 $statement = "( $statement )" if scalar(@statement) > 1;
438 $statement .= " $union_options{order_by}" if $union_options{order_by};
440 my $sth = $dbh->prepare($statement)
441 or croak "$dbh->errstr doing $statement";
444 foreach my $value ( @value ) {
445 my $bind_type = shift @bind_type;
446 $sth->bind_param($bind++, $value, $bind_type );
449 # $sth->execute( map $record->{$_},
450 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
451 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
453 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
455 # virtual fields and blessings are nonsense in a heterogeneous UNION, right?
456 my $table = $stable[0];
458 $table = '' if grep { $_ ne $table } @stable;
459 $pkey = dbdef->table($table)->primary_key if $table;
461 my @virtual_fields = ();
462 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
463 @virtual_fields = "FS::$table"->virtual_fields;
465 cluck "warning: FS::$table not loaded; virtual fields not returned either"
466 unless $nowarn_classload;
467 @virtual_fields = ();
471 tie %result, "Tie::IxHash";
472 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
473 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
474 %result = map { $_->{$pkey}, $_ } @stuff;
476 @result{@stuff} = @stuff;
481 if ( keys(%result) and @virtual_fields ) {
483 "SELECT virtual_field.recnum, part_virtual_field.name, ".
484 "virtual_field.value ".
485 "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
486 "WHERE part_virtual_field.dbtable = '$table' AND ".
487 "virtual_field.recnum IN (".
488 join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
489 join(q!', '!, @virtual_fields) . "')";
490 warn "[debug]$me $statement\n" if $DEBUG > 1;
491 $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
492 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
494 foreach (@{ $sth->fetchall_arrayref({}) }) {
495 my $recnum = $_->{recnum};
496 my $name = $_->{name};
497 my $value = $_->{value};
498 if (exists($result{$recnum})) {
499 $result{$recnum}->{$name} = $value;
504 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
505 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
506 #derivied class didn't override new method, so this optimization is safe
509 new_or_cached( "FS::$table", { %{$_} }, $cache )
513 new( "FS::$table", { %{$_} } )
517 #okay, its been tested
518 # warn "untested code (class FS::$table uses custom new method)";
520 eval 'FS::'. $table. '->new( { %{$_} } )';
524 # Check for encrypted fields and decrypt them.
525 ## only in the local copy, not the cached object
526 if ( $conf_encryption
527 && eval 'defined(@FS::'. $table . '::encrypted_fields)' ) {
528 foreach my $record (@return) {
529 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
530 # Set it directly... This may cause a problem in the future...
531 $record->setfield($field, $record->decrypt($record->getfield($field)));
536 cluck "warning: FS::$table not loaded; returning FS::Record objects"
537 unless $nowarn_classload;
539 FS::Record->new( $table, { %{$_} } );
545 ## makes this easier to read
547 sub get_virtual_fields {
551 my $virtual_fields = shift;
557 if ( ref($record->{$_}) ) {
558 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
559 if ( uc($op) eq 'ILIKE' ) {
561 $record->{$_}{'value'} = lc($record->{$_}{'value'});
562 $column = "LOWER($_)";
564 $record->{$_} = $record->{$_}{'value'};
567 # ... EXISTS ( SELECT name, value FROM part_virtual_field
569 # ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
570 # WHERE recnum = svc_acct.svcnum
571 # AND (name, value) = ('egad', 'brain') )
573 my $value = $record->{$_};
577 $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
578 "( SELECT part_virtual_field.name, virtual_field.value ".
579 "FROM part_virtual_field JOIN virtual_field ".
580 "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
581 "WHERE virtual_field.recnum = ${table}.${pkey} ".
582 "AND part_virtual_field.name = '${column}'".
584 " AND virtual_field.value ${op} '${value}'"
588 } @{ $virtual_fields } ) ;
591 sub get_real_fields {
594 my $real_fields = shift;
596 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
602 my $type = dbdef->table($table)->column($column)->type;
603 my $value = $record->{$column};
604 $value = $value->{'value'} if ref($value);
605 if ( ref($record->{$_}) ) {
606 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
607 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
608 if ( uc($op) eq 'ILIKE' ) {
610 $record->{$_}{'value'} = lc($record->{$_}{'value'});
611 $column = "LOWER($_)";
613 $record->{$_} = $record->{$_}{'value'}
616 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
618 if ( driver_name eq 'Pg' ) {
619 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
620 qq-( $column IS NULL )-;
622 qq-( $column IS NULL OR $column = '' )-;
625 qq-( $column IS NULL OR $column = "" )-;
627 } elsif ( $op eq '!=' ) {
628 if ( driver_name eq 'Pg' ) {
629 if ( $type =~ /(int|numeric|real|float4|(big)?serial)/i ) {
630 qq-( $column IS NOT NULL )-;
632 qq-( $column IS NOT NULL AND $column != '' )-;
635 qq-( $column IS NOT NULL AND $column != "" )-;
638 if ( driver_name eq 'Pg' ) {
639 qq-( $column $op '' )-;
641 qq-( $column $op "" )-;
644 #if this needs to be re-enabled, it needs to use a custom op like
645 #"APPROX=" or something (better name?, not '=', to avoid affecting other
647 #} elsif ( $op eq 'APPROX=' && _is_fs_float( $type, $value ) ) {
648 # ( "$column <= ?", "$column >= ?" );
652 } @{ $real_fields } );
655 =item by_key PRIMARY_KEY_VALUE
657 This is a class method that returns the record with the given primary key
658 value. This method is only useful in FS::Record subclasses. For example:
660 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
664 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
669 my ($class, $pkey_value) = @_;
671 my $table = $class->table
672 or croak "No table for $class found";
674 my $dbdef_table = dbdef->table($table)
675 or die "No schema for table $table found - ".
676 "do you need to create it or run dbdef-create?";
677 my $pkey = $dbdef_table->primary_key
678 or die "No primary key for table $table";
680 return qsearchs($table, { $pkey => $pkey_value });
683 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
685 Experimental JOINed search method. Using this method, you can execute a
686 single SELECT spanning multiple tables, and cache the results for subsequent
687 method calls. Interface will almost definately change in an incompatible
695 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
696 my $cache = FS::SearchCache->new( $ptable, $pkey );
699 grep { !$saw{$_->getfield($pkey)}++ }
700 qsearch($table, $record, $select, $extra_sql, $cache )
704 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
706 Same as qsearch, except that if more than one record matches, it B<carp>s but
707 returns the first. If this happens, you either made a logic error in asking
708 for a single item, or your data is corrupted.
712 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
714 my(@result) = qsearch(@_);
715 cluck "warning: Multiple records in scalar search ($table)"
716 if scalar(@result) > 1;
717 #should warn more vehemently if the search was on a primary key?
718 scalar(@result) ? ($result[0]) : ();
729 Returns the table name.
734 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
741 Returns the DBIx::DBSchema::Table object for the table.
747 my($table)=$self->table;
748 dbdef->table($table);
753 Returns the primary key for the table.
759 my $pkey = $self->dbdef_table->primary_key;
762 =item get, getfield COLUMN
764 Returns the value of the column/field/key COLUMN.
769 my($self,$field) = @_;
770 # to avoid "Use of unitialized value" errors
771 if ( defined ( $self->{Hash}->{$field} ) ) {
772 $self->{Hash}->{$field};
782 =item set, setfield COLUMN, VALUE
784 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
789 my($self,$field,$value) = @_;
790 $self->{'modified'} = 1;
791 $self->{'Hash'}->{$field} = $value;
798 =item AUTLOADED METHODS
800 $record->column is a synonym for $record->get('column');
802 $record->column('value') is a synonym for $record->set('column','value');
809 my($field)=$AUTOLOAD;
811 if ( defined($value) ) {
812 confess "errant AUTOLOAD $field for $self (arg $value)"
813 unless blessed($self) && $self->can('setfield');
814 $self->setfield($field,$value);
816 confess "errant AUTOLOAD $field for $self (no args)"
817 unless blessed($self) && $self->can('getfield');
818 $self->getfield($field);
824 # my $field = $AUTOLOAD;
826 # if ( defined($_[1]) ) {
827 # $_[0]->setfield($field, $_[1]);
829 # $_[0]->getfield($field);
835 Returns a list of the column/value pairs, usually for assigning to a new hash.
837 To make a distinct duplicate of an FS::Record object, you can do:
839 $new = new FS::Record ( $old->table, { $old->hash } );
845 confess $self. ' -> hash: Hash attribute is undefined'
846 unless defined($self->{'Hash'});
847 %{ $self->{'Hash'} };
852 Returns a reference to the column/value hash. This may be deprecated in the
853 future; if there's a reason you can't just use the autoloaded or get/set
865 Returns true if any of this object's values have been modified with set (or via
866 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
876 =item select_for_update
878 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
883 sub select_for_update {
885 my $primary_key = $self->primary_key;
888 'table' => $self->table,
889 'hashref' => { $primary_key => $self->$primary_key() },
890 'extra_sql' => 'FOR UPDATE',
896 Locks this table with a database-driver specific lock method. This is used
897 as a mutex in order to do a duplicate search.
899 For PostgreSQL, does "LOCK TABLE tablename IN SHARE ROW EXCLUSIVE MODE".
901 For MySQL, does a SELECT FOR UPDATE on the duplicate_lock table.
903 Errors are fatal; no useful return value.
905 Note: To use this method for new tables other than svc_acct and svc_phone,
906 edit freeside-upgrade and add those tables to the duplicate_lock list.
912 my $table = $self->table;
914 warn "$me locking $table table\n" if $DEBUG;
916 if ( driver_name =~ /^Pg/i ) {
918 dbh->do("LOCK TABLE $table IN SHARE ROW EXCLUSIVE MODE")
921 } elsif ( driver_name =~ /^mysql/i ) {
923 dbh->do("SELECT * FROM duplicate_lock
924 WHERE lockname = '$table'
926 ) or die dbh->errstr;
930 die "unknown database ". driver_name. "; don't know how to lock table";
934 warn "$me acquired $table table lock\n" if $DEBUG;
940 Inserts this record to the database. If there is an error, returns the error,
941 otherwise returns false.
949 warn "$self -> insert" if $DEBUG;
951 my $error = $self->check;
952 return $error if $error;
954 #single-field unique keys are given a value if false
955 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
956 foreach ( $self->dbdef_table->unique_singles) {
957 $self->unique($_) unless $self->getfield($_);
960 #and also the primary key, if the database isn't going to
961 my $primary_key = $self->dbdef_table->primary_key;
963 if ( $primary_key ) {
964 my $col = $self->dbdef_table->column($primary_key);
967 uc($col->type) =~ /^(BIG)?SERIAL\d?/
968 || ( driver_name eq 'Pg'
969 && defined($col->default)
970 && $col->quoted_default =~ /^nextval\(/i
972 || ( driver_name eq 'mysql'
973 && defined($col->local)
974 && $col->local =~ /AUTO_INCREMENT/i
976 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
979 my $table = $self->table;
981 # Encrypt before the database
982 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
983 && scalar( eval '@FS::'. $table . '::encrypted_fields')
984 && $conf->exists('encryption')
986 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
987 $self->{'saved'} = $self->getfield($field);
988 $self->setfield($field, $self->encrypt($self->getfield($field)));
992 #false laziness w/delete
994 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
997 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
1000 my $statement = "INSERT INTO $table ";
1001 if ( @real_fields ) {
1004 join( ', ', @real_fields ).
1006 join( ', ', @values ).
1010 $statement .= 'DEFAULT VALUES';
1012 warn "[debug]$me $statement\n" if $DEBUG > 1;
1013 my $sth = dbh->prepare($statement) or return dbh->errstr;
1015 local $SIG{HUP} = 'IGNORE';
1016 local $SIG{INT} = 'IGNORE';
1017 local $SIG{QUIT} = 'IGNORE';
1018 local $SIG{TERM} = 'IGNORE';
1019 local $SIG{TSTP} = 'IGNORE';
1020 local $SIG{PIPE} = 'IGNORE';
1022 $sth->execute or return $sth->errstr;
1024 # get inserted id from the database, if applicable & needed
1025 if ( $db_seq && ! $self->getfield($primary_key) ) {
1026 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
1030 if ( driver_name eq 'Pg' ) {
1032 #my $oid = $sth->{'pg_oid_status'};
1033 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
1035 my $default = $self->dbdef_table->column($primary_key)->quoted_default;
1036 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
1037 dbh->rollback if $FS::UID::AutoCommit;
1038 return "can't parse $table.$primary_key default value".
1039 " for sequence name: $default";
1043 my $i_sql = "SELECT currval('$sequence')";
1044 my $i_sth = dbh->prepare($i_sql) or do {
1045 dbh->rollback if $FS::UID::AutoCommit;
1048 $i_sth->execute() or do { #$i_sth->execute($oid)
1049 dbh->rollback if $FS::UID::AutoCommit;
1050 return $i_sth->errstr;
1052 $insertid = $i_sth->fetchrow_arrayref->[0];
1054 } elsif ( driver_name eq 'mysql' ) {
1056 $insertid = dbh->{'mysql_insertid'};
1057 # work around mysql_insertid being null some of the time, ala RT :/
1058 unless ( $insertid ) {
1059 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
1060 "using SELECT LAST_INSERT_ID();";
1061 my $i_sql = "SELECT LAST_INSERT_ID()";
1062 my $i_sth = dbh->prepare($i_sql) or do {
1063 dbh->rollback if $FS::UID::AutoCommit;
1066 $i_sth->execute or do {
1067 dbh->rollback if $FS::UID::AutoCommit;
1068 return $i_sth->errstr;
1070 $insertid = $i_sth->fetchrow_arrayref->[0];
1075 dbh->rollback if $FS::UID::AutoCommit;
1076 return "don't know how to retreive inserted ids from ". driver_name.
1077 ", try using counterfiles (maybe run dbdef-create?)";
1081 $self->setfield($primary_key, $insertid);
1085 my @virtual_fields =
1086 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
1087 $self->virtual_fields;
1088 if (@virtual_fields) {
1089 my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
1091 my $vfieldpart = $self->vfieldpart_hashref;
1093 my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
1096 my $v_sth = dbh->prepare($v_statement) or do {
1097 dbh->rollback if $FS::UID::AutoCommit;
1101 foreach (keys(%v_values)) {
1102 $v_sth->execute($self->getfield($primary_key),
1106 dbh->rollback if $FS::UID::AutoCommit;
1107 return $v_sth->errstr;
1114 if ( defined dbdef->table('h_'. $table) ) {
1115 my $h_statement = $self->_h_statement('insert');
1116 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1117 $h_sth = dbh->prepare($h_statement) or do {
1118 dbh->rollback if $FS::UID::AutoCommit;
1124 $h_sth->execute or return $h_sth->errstr if $h_sth;
1126 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1128 # Now that it has been saved, reset the encrypted fields so that $new
1129 # can still be used.
1130 foreach my $field (keys %{$saved}) {
1131 $self->setfield($field, $saved->{$field});
1139 Depriciated (use insert instead).
1144 cluck "warning: FS::Record::add deprecated!";
1145 insert @_; #call method in this scope
1150 Delete this record from the database. If there is an error, returns the error,
1151 otherwise returns false.
1158 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
1160 $self->getfield($_) eq ''
1161 #? "( $_ IS NULL OR $_ = \"\" )"
1162 ? ( driver_name eq 'Pg'
1164 : "( $_ IS NULL OR $_ = \"\" )"
1166 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
1167 } ( $self->dbdef_table->primary_key )
1168 ? ( $self->dbdef_table->primary_key)
1169 : real_fields($self->table)
1171 warn "[debug]$me $statement\n" if $DEBUG > 1;
1172 my $sth = dbh->prepare($statement) or return dbh->errstr;
1175 if ( defined dbdef->table('h_'. $self->table) ) {
1176 my $h_statement = $self->_h_statement('delete');
1177 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1178 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1183 my $primary_key = $self->dbdef_table->primary_key;
1186 my $vfp = $self->vfieldpart_hashref;
1187 foreach($self->virtual_fields) {
1188 next if $self->getfield($_) eq '';
1189 unless(@del_vfields) {
1190 my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
1191 $v_sth = dbh->prepare($st) or return dbh->errstr;
1193 push @del_vfields, $_;
1196 local $SIG{HUP} = 'IGNORE';
1197 local $SIG{INT} = 'IGNORE';
1198 local $SIG{QUIT} = 'IGNORE';
1199 local $SIG{TERM} = 'IGNORE';
1200 local $SIG{TSTP} = 'IGNORE';
1201 local $SIG{PIPE} = 'IGNORE';
1203 my $rc = $sth->execute or return $sth->errstr;
1204 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1205 $h_sth->execute or return $h_sth->errstr if $h_sth;
1206 $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
1207 or return $v_sth->errstr
1208 foreach (@del_vfields);
1210 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1212 #no need to needlessly destoy the data either (causes problems actually)
1213 #undef $self; #no need to keep object!
1220 Depriciated (use delete instead).
1225 cluck "warning: FS::Record::del deprecated!";
1226 &delete(@_); #call method in this scope
1229 =item replace OLD_RECORD
1231 Replace the OLD_RECORD with this one in the database. If there is an error,
1232 returns the error, otherwise returns false.
1237 my ($new, $old) = (shift, shift);
1239 $old = $new->replace_old unless defined($old);
1241 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1243 if ( $new->can('replace_check') ) {
1244 my $error = $new->replace_check($old);
1245 return $error if $error;
1248 return "Records not in same table!" unless $new->table eq $old->table;
1250 my $primary_key = $old->dbdef_table->primary_key;
1251 return "Can't change primary key $primary_key ".
1252 'from '. $old->getfield($primary_key).
1253 ' to ' . $new->getfield($primary_key)
1255 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1257 my $error = $new->check;
1258 return $error if $error;
1260 # Encrypt for replace
1262 if ( $conf->exists('encryption')
1263 && defined(eval '@FS::'. $new->table . '::encrypted_fields')
1264 && scalar( eval '@FS::'. $new->table . '::encrypted_fields')
1266 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1267 $saved->{$field} = $new->getfield($field);
1268 $new->setfield($field, $new->encrypt($new->getfield($field)));
1272 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1273 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1274 ? ($_, $new->getfield($_)) : () } $old->fields;
1276 unless (keys(%diff) || $no_update_diff ) {
1277 carp "[warning]$me $new -> replace $old: records identical"
1278 unless $nowarn_identical;
1282 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1284 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1285 } real_fields($old->table)
1290 if ( $old->getfield($_) eq '' ) {
1292 #false laziness w/qsearch
1293 if ( driver_name eq 'Pg' ) {
1294 my $type = $old->dbdef_table->column($_)->type;
1295 if ( $type =~ /(int|(big)?serial)/i ) {
1298 qq-( $_ IS NULL OR $_ = '' )-;
1301 qq-( $_ IS NULL OR $_ = "" )-;
1305 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1308 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1311 warn "[debug]$me $statement\n" if $DEBUG > 1;
1312 my $sth = dbh->prepare($statement) or return dbh->errstr;
1315 if ( defined dbdef->table('h_'. $old->table) ) {
1316 my $h_old_statement = $old->_h_statement('replace_old');
1317 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1318 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1324 if ( defined dbdef->table('h_'. $new->table) ) {
1325 my $h_new_statement = $new->_h_statement('replace_new');
1326 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1327 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1332 # For virtual fields we have three cases with different SQL
1333 # statements: add, replace, delete
1337 my (@add_vfields, @rep_vfields, @del_vfields);
1338 my $vfp = $old->vfieldpart_hashref;
1339 foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
1340 if($diff{$_} eq '') {
1342 unless(@del_vfields) {
1343 my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
1344 "AND vfieldpart = ?";
1345 warn "[debug]$me $st\n" if $DEBUG > 2;
1346 $v_del_sth = dbh->prepare($st) or return dbh->errstr;
1348 push @del_vfields, $_;
1349 } elsif($old->getfield($_) eq '') {
1351 unless(@add_vfields) {
1352 my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
1354 warn "[debug]$me $st\n" if $DEBUG > 2;
1355 $v_add_sth = dbh->prepare($st) or return dbh->errstr;
1357 push @add_vfields, $_;
1360 unless(@rep_vfields) {
1361 my $st = "UPDATE virtual_field SET value = ? ".
1362 "WHERE recnum = ? AND vfieldpart = ?";
1363 warn "[debug]$me $st\n" if $DEBUG > 2;
1364 $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
1366 push @rep_vfields, $_;
1370 local $SIG{HUP} = 'IGNORE';
1371 local $SIG{INT} = 'IGNORE';
1372 local $SIG{QUIT} = 'IGNORE';
1373 local $SIG{TERM} = 'IGNORE';
1374 local $SIG{TSTP} = 'IGNORE';
1375 local $SIG{PIPE} = 'IGNORE';
1377 my $rc = $sth->execute or return $sth->errstr;
1378 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1379 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1380 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1382 $v_del_sth->execute($old->getfield($primary_key),
1384 or return $v_del_sth->errstr
1385 foreach(@del_vfields);
1387 $v_add_sth->execute($new->getfield($_),
1388 $old->getfield($primary_key),
1390 or return $v_add_sth->errstr
1391 foreach(@add_vfields);
1393 $v_rep_sth->execute($new->getfield($_),
1394 $old->getfield($primary_key),
1396 or return $v_rep_sth->errstr
1397 foreach(@rep_vfields);
1399 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1401 # Now that it has been saved, reset the encrypted fields so that $new
1402 # can still be used.
1403 foreach my $field (keys %{$saved}) {
1404 $new->setfield($field, $saved->{$field});
1412 my( $self ) = shift;
1413 warn "[$me] replace called with no arguments; autoloading old record\n"
1416 my $primary_key = $self->dbdef_table->primary_key;
1417 if ( $primary_key ) {
1418 $self->by_key( $self->$primary_key() ) #this is what's returned
1419 or croak "can't find ". $self->table. ".$primary_key ".
1420 $self->$primary_key();
1422 croak $self->table. " has no primary key; pass old record as argument";
1429 Depriciated (use replace instead).
1434 cluck "warning: FS::Record::rep deprecated!";
1435 replace @_; #call method in this scope
1440 Checks virtual fields (using check_blocks). Subclasses should still provide
1441 a check method to validate real fields, foreign keys, etc., and call this
1442 method via $self->SUPER::check.
1444 (FIXME: Should this method try to make sure that it I<is> being called from
1445 a subclass's check method, to keep the current semantics as far as possible?)
1450 #confess "FS::Record::check not implemented; supply one in subclass!";
1453 foreach my $field ($self->virtual_fields) {
1454 for ($self->getfield($field)) {
1455 # See notes on check_block in FS::part_virtual_field.
1456 eval $self->pvf($field)->check_block;
1458 #this is bad, probably want to follow the stack backtrace up and see
1460 my $err = "Fatal error checking $field for $self";
1462 return "$err (see log for backtrace): $@";
1465 $self->setfield($field, $_);
1471 =item process_batch_import JOB OPTIONS_HASHREF PARAMS
1473 Processes a batch import as a queued JSRPC job
1475 JOB is an FS::queue entry.
1477 OPTIONS_HASHREF can have the following keys:
1483 Table name (required).
1487 Listref of field names for static fields. They will be given values from the
1488 PARAMS hashref and passed as a "params" hashref to batch_import.
1492 Formats hashref. Keys are field names, values are listrefs that define the
1495 Each listref value can be a column name or a code reference. Coderefs are run
1496 with the row object, data and a FS::Conf object as the three parameters.
1497 For example, this coderef does the same thing as using the "columnname" string:
1500 my( $record, $data, $conf ) = @_;
1501 $record->columnname( $data );
1504 Coderefs are run after all "column name" fields are assigned.
1508 Optional format hashref of types. Keys are field names, values are "csv",
1509 "xls" or "fixedlength". Overrides automatic determination of file type
1512 =item format_headers
1514 Optional format hashref of header lines. Keys are field names, values are 0
1515 for no header, 1 to ignore the first line, or to higher numbers to ignore that
1518 =item format_sep_chars
1520 Optional format hashref of CSV sep_chars. Keys are field names, values are the
1521 CSV separation character.
1523 =item format_fixedlenth_formats
1525 Optional format hashref of fixed length format defintiions. Keys are field
1526 names, values Parse::FixedLength listrefs of field definitions.
1530 Set true to default to CSV file type if the filename does not contain a
1531 recognizable ".csv" or ".xls" extension (and type is not pre-specified by
1536 PARAMS is a base64-encoded Storable string containing the POSTed data as
1537 a hash ref. It normally contains at least one field, "uploaded files",
1538 generated by /elements/file-upload.html and containing the list of uploaded
1539 files. Currently only supports a single file named "file".
1543 use Storable qw(thaw);
1546 sub process_batch_import {
1547 my($job, $opt) = ( shift, shift );
1549 my $table = $opt->{table};
1550 my @pass_params = $opt->{params} ? @{ $opt->{params} } : ();
1551 my %formats = %{ $opt->{formats} };
1553 my $param = thaw(decode_base64(shift));
1554 warn Dumper($param) if $DEBUG;
1556 my $files = $param->{'uploaded_files'}
1557 or die "No files provided.\n";
1559 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1561 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1562 my $file = $dir. $files{'file'};
1567 formats => \%formats,
1568 format_types => $opt->{format_types},
1569 format_headers => $opt->{format_headers},
1570 format_sep_chars => $opt->{format_sep_chars},
1571 format_fixedlength_formats => $opt->{format_fixedlength_formats},
1576 format => $param->{format},
1577 params => { map { $_ => $param->{$_} } @pass_params },
1579 default_csv => $opt->{default_csv},
1582 if ( $opt->{'batch_namecol'} ) {
1583 $iopt{'batch_namevalue'} = $param->{ $opt->{'batch_namecol'} };
1584 $iopt{$_} = $opt->{$_} foreach qw( batch_keycol batch_table batch_namecol );
1587 my $error = FS::Record::batch_import( \%iopt );
1591 die "$error\n" if $error;
1594 =item batch_import PARAM_HASHREF
1596 Class method for batch imports. Available params:
1606 =item format_headers
1608 =item format_sep_chars
1610 =item format_fixedlength_formats
1616 FS::queue object, will be updated with progress
1622 csv, xls or fixedlength
1635 warn "$me batch_import call with params: \n". Dumper($param)
1638 my $table = $param->{table};
1639 my $formats = $param->{formats};
1641 my $job = $param->{job};
1642 my $file = $param->{file};
1643 my $format = $param->{'format'};
1644 my $params = $param->{params} || {};
1646 die "unknown format $format" unless exists $formats->{ $format };
1648 my $type = $param->{'format_types'}
1649 ? $param->{'format_types'}{ $format }
1650 : $param->{type} || 'csv';
1653 if ( $file =~ /\.(\w+)$/i ) {
1657 warn "can't parse file type from filename $file; defaulting to CSV";
1661 if $param->{'default_csv'} && $type ne 'xls';
1664 my $header = $param->{'format_headers'}
1665 ? $param->{'format_headers'}{ $param->{'format'} }
1668 my $sep_char = $param->{'format_sep_chars'}
1669 ? $param->{'format_sep_chars'}{ $param->{'format'} }
1672 my $fixedlength_format =
1673 $param->{'format_fixedlength_formats'}
1674 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
1677 my @fields = @{ $formats->{ $format } };
1683 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
1685 if ( $type eq 'csv' ) {
1688 $attr{sep_char} = $sep_char if $sep_char;
1689 $parser = new Text::CSV_XS \%attr;
1691 } elsif ( $type eq 'fixedlength' ) {
1693 eval "use Parse::FixedLength;";
1695 $parser = new Parse::FixedLength $fixedlength_format;
1698 die "Unknown file type $type\n";
1701 @buffer = split(/\r?\n/, slurp($file) );
1702 splice(@buffer, 0, ($header || 0) );
1703 $count = scalar(@buffer);
1705 } elsif ( $type eq 'xls' ) {
1707 eval "use Spreadsheet::ParseExcel;";
1710 eval "use DateTime::Format::Excel;";
1711 #for now, just let the error be thrown if it is used, since only CDR
1712 # formats bill_west and troop use it, not other excel-parsing things
1715 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
1717 $parser = $excel->{Worksheet}[0]; #first sheet
1719 $count = $parser->{MaxRow} || $parser->{MinRow};
1722 $row = $header || 0;
1725 die "Unknown file type $type\n";
1730 local $SIG{HUP} = 'IGNORE';
1731 local $SIG{INT} = 'IGNORE';
1732 local $SIG{QUIT} = 'IGNORE';
1733 local $SIG{TERM} = 'IGNORE';
1734 local $SIG{TSTP} = 'IGNORE';
1735 local $SIG{PIPE} = 'IGNORE';
1737 my $oldAutoCommit = $FS::UID::AutoCommit;
1738 local $FS::UID::AutoCommit = 0;
1741 if ( $param->{'batch_namecol'} && $param->{'batch_namevalue'} ) {
1742 my $batch_col = $param->{'batch_keycol'};
1744 my $batch_class = 'FS::'. $param->{'batch_table'};
1745 my $batch = $batch_class->new({
1746 $param->{'batch_namecol'} => $param->{'batch_namevalue'}
1748 my $error = $batch->insert;
1750 $dbh->rollback if $oldAutoCommit;
1751 return "can't insert batch record: $error";
1753 #primary key via dbdef? (so the column names don't have to match)
1754 my $batch_value = $batch->get( $param->{'batch_keycol'} );
1756 $params->{ $batch_col } = $batch_value;
1761 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1765 if ( $type eq 'csv' ) {
1767 last unless scalar(@buffer);
1768 $line = shift(@buffer);
1770 next if $line =~ /^\s*$/; #skip empty lines
1772 $parser->parse($line) or do {
1773 $dbh->rollback if $oldAutoCommit;
1774 return "can't parse: ". $parser->error_input();
1776 @columns = $parser->fields();
1778 } elsif ( $type eq 'fixedlength' ) {
1780 @columns = $parser->parse($line);
1782 } elsif ( $type eq 'xls' ) {
1784 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1785 || ! $parser->{Cells}[$row];
1787 my @row = @{ $parser->{Cells}[$row] };
1788 @columns = map $_->{Val}, @row;
1791 #warn $z++. ": $_\n" for @columns;
1794 die "Unknown file type $type\n";
1798 my %hash = %$params;
1800 foreach my $field ( @fields ) {
1802 my $value = shift @columns;
1804 if ( ref($field) eq 'CODE' ) {
1805 #&{$field}(\%hash, $value);
1806 push @later, $field, $value;
1808 #??? $hash{$field} = $value if length($value);
1809 $hash{$field} = $value if defined($value) && length($value);
1814 my $class = "FS::$table";
1816 my $record = $class->new( \%hash );
1819 while ( scalar(@later) ) {
1820 my $sub = shift @later;
1821 my $data = shift @later;
1822 &{$sub}($record, $data, $conf, $param); # $record->&{$sub}($data, $conf);
1823 last if exists( $param->{skiprow} );
1825 next if exists( $param->{skiprow} );
1827 my $error = $record->insert;
1830 $dbh->rollback if $oldAutoCommit;
1831 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1837 if ( $job && time - $min_sec > $last ) { #progress bar
1838 $job->update_statustext( int(100 * $imported / $count) );
1844 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1846 return "Empty file!" unless $imported || $param->{empty_ok};
1853 my( $self, $action, $time ) = @_;
1857 my %nohistory = map { $_=>1 } $self->nohistory_fields;
1860 grep { defined($self->get($_)) && $self->get($_) ne "" && ! $nohistory{$_} }
1861 real_fields($self->table);
1864 # If we're encrypting then don't store the payinfo in the history
1865 if ( $conf && $conf->exists('encryption') ) {
1866 @fields = grep { $_ ne 'payinfo' } @fields;
1869 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1871 "INSERT INTO h_". $self->table. " ( ".
1872 join(', ', qw(history_date history_user history_action), @fields ).
1874 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1881 B<Warning>: External use is B<deprecated>.
1883 Replaces COLUMN in record with a unique number, using counters in the
1884 filesystem. Used by the B<insert> method on single-field unique columns
1885 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1886 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1888 Returns the new value.
1893 my($self,$field) = @_;
1894 my($table)=$self->table;
1896 croak "Unique called on field $field, but it is ",
1897 $self->getfield($field),
1899 if $self->getfield($field);
1901 #warn "table $table is tainted" if is_tainted($table);
1902 #warn "field $field is tainted" if is_tainted($field);
1904 my($counter) = new File::CounterFile "$table.$field",0;
1906 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1908 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1911 my $index = $counter->inc;
1912 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1914 $index =~ /^(\d*)$/;
1917 $self->setfield($field,$index);
1921 =item ut_float COLUMN
1923 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1924 null. If there is an error, returns the error, otherwise returns false.
1929 my($self,$field)=@_ ;
1930 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
1931 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
1932 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
1933 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
1934 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1935 $self->setfield($field,$1);
1938 =item ut_floatn COLUMN
1940 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1941 null. If there is an error, returns the error, otherwise returns false.
1945 #false laziness w/ut_ipn
1947 my( $self, $field ) = @_;
1948 if ( $self->getfield($field) =~ /^()$/ ) {
1949 $self->setfield($field,'');
1952 $self->ut_float($field);
1956 =item ut_sfloat COLUMN
1958 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
1959 May not be null. If there is an error, returns the error, otherwise returns
1965 my($self,$field)=@_ ;
1966 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
1967 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
1968 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
1969 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
1970 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1971 $self->setfield($field,$1);
1974 =item ut_sfloatn COLUMN
1976 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1977 null. If there is an error, returns the error, otherwise returns false.
1982 my( $self, $field ) = @_;
1983 if ( $self->getfield($field) =~ /^()$/ ) {
1984 $self->setfield($field,'');
1987 $self->ut_sfloat($field);
1991 =item ut_snumber COLUMN
1993 Check/untaint signed numeric data (whole numbers). If there is an error,
1994 returns the error, otherwise returns false.
1999 my($self, $field) = @_;
2000 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
2001 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2002 $self->setfield($field, "$1$2");
2006 =item ut_snumbern COLUMN
2008 Check/untaint signed numeric data (whole numbers). If there is an error,
2009 returns the error, otherwise returns false.
2014 my($self, $field) = @_;
2015 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
2016 or return "Illegal (numeric) $field: ". $self->getfield($field);
2018 return "Illegal (numeric) $field: ". $self->getfield($field)
2021 $self->setfield($field, "$1$2");
2025 =item ut_number COLUMN
2027 Check/untaint simple numeric data (whole numbers). May not be null. If there
2028 is an error, returns the error, otherwise returns false.
2033 my($self,$field)=@_;
2034 $self->getfield($field) =~ /^\s*(\d+)\s*$/
2035 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
2036 $self->setfield($field,$1);
2040 =item ut_numbern COLUMN
2042 Check/untaint simple numeric data (whole numbers). May be null. If there is
2043 an error, returns the error, otherwise returns false.
2048 my($self,$field)=@_;
2049 $self->getfield($field) =~ /^\s*(\d*)\s*$/
2050 or return "Illegal (numeric) $field: ". $self->getfield($field);
2051 $self->setfield($field,$1);
2055 =item ut_money COLUMN
2057 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
2058 is an error, returns the error, otherwise returns false.
2063 my($self,$field)=@_;
2064 $self->setfield($field, 0) if $self->getfield($field) eq '';
2065 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
2066 or return "Illegal (money) $field: ". $self->getfield($field);
2067 #$self->setfield($field, "$1$2$3" || 0);
2068 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
2072 =item ut_moneyn COLUMN
2074 Check/untaint monetary numbers. May be negative. If there
2075 is an error, returns the error, otherwise returns false.
2080 my($self,$field)=@_;
2081 if ($self->getfield($field) eq '') {
2082 $self->setfield($field, '');
2085 $self->ut_money($field);
2088 =item ut_text COLUMN
2090 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2091 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ] < >
2092 May not be null. If there is an error, returns the error, otherwise returns
2098 my($self,$field)=@_;
2099 #warn "msgcat ". \&msgcat. "\n";
2100 #warn "notexist ". \¬exist. "\n";
2101 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
2102 $self->getfield($field)
2103 =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]\<\>]+)$/
2104 or return gettext('illegal_or_empty_text'). " $field: ".
2105 $self->getfield($field);
2106 $self->setfield($field,$1);
2110 =item ut_textn COLUMN
2112 Check/untaint text. Alphanumerics, spaces, and the following punctuation
2113 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
2114 May be null. If there is an error, returns the error, otherwise returns false.
2119 my($self,$field)=@_;
2120 $self->getfield($field)
2121 =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]]*)$/
2122 or return gettext('illegal_text'). " $field: ". $self->getfield($field);
2123 $self->setfield($field,$1);
2127 =item ut_alpha COLUMN
2129 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
2130 an error, returns the error, otherwise returns false.
2135 my($self,$field)=@_;
2136 $self->getfield($field) =~ /^(\w+)$/
2137 or return "Illegal or empty (alphanumeric) $field: ".
2138 $self->getfield($field);
2139 $self->setfield($field,$1);
2143 =item ut_alpha COLUMN
2145 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
2146 error, returns the error, otherwise returns false.
2151 my($self,$field)=@_;
2152 $self->getfield($field) =~ /^(\w*)$/
2153 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
2154 $self->setfield($field,$1);
2158 =item ut_alpha_lower COLUMN
2160 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
2161 there is an error, returns the error, otherwise returns false.
2165 sub ut_alpha_lower {
2166 my($self,$field)=@_;
2167 $self->getfield($field) =~ /[[:upper:]]/
2168 and return "Uppercase characters are not permitted in $field";
2169 $self->ut_alpha($field);
2172 =item ut_phonen COLUMN [ COUNTRY ]
2174 Check/untaint phone numbers. May be null. If there is an error, returns
2175 the error, otherwise returns false.
2177 Takes an optional two-letter ISO country code; without it or with unsupported
2178 countries, ut_phonen simply calls ut_alphan.
2183 my( $self, $field, $country ) = @_;
2184 return $self->ut_alphan($field) unless defined $country;
2185 my $phonen = $self->getfield($field);
2186 if ( $phonen eq '' ) {
2187 $self->setfield($field,'');
2188 } elsif ( $country eq 'US' || $country eq 'CA' ) {
2190 $phonen = $conf->config('cust_main-default_areacode').$phonen
2191 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
2192 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
2193 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
2194 $phonen = "$1-$2-$3";
2195 $phonen .= " x$4" if $4;
2196 $self->setfield($field,$phonen);
2198 warn "warning: don't know how to check phone numbers for country $country";
2199 return $self->ut_textn($field);
2206 Check/untaint hexadecimal values.
2211 my($self, $field) = @_;
2212 $self->getfield($field) =~ /^([\da-fA-F]+)$/
2213 or return "Illegal (hex) $field: ". $self->getfield($field);
2214 $self->setfield($field, uc($1));
2218 =item ut_hexn COLUMN
2220 Check/untaint hexadecimal values. May be null.
2225 my($self, $field) = @_;
2226 $self->getfield($field) =~ /^([\da-fA-F]*)$/
2227 or return "Illegal (hex) $field: ". $self->getfield($field);
2228 $self->setfield($field, uc($1));
2233 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2239 my( $self, $field ) = @_;
2240 $self->setfield($field, '127.0.0.1') if $self->getfield($field) eq '::1';
2241 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
2242 or return "Illegal (IP address) $field: ". $self->getfield($field);
2243 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
2244 $self->setfield($field, "$1.$2.$3.$4");
2250 Check/untaint ip addresses. IPv4 only for now, though ::1 is auto-translated
2251 to 127.0.0.1. May be null.
2256 my( $self, $field ) = @_;
2257 if ( $self->getfield($field) =~ /^()$/ ) {
2258 $self->setfield($field,'');
2261 $self->ut_ip($field);
2265 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
2267 Check/untaint coordinates.
2268 Accepts the following forms:
2278 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
2279 The latter form (that is, the MMM are thousands of minutes) is
2280 assumed if the "MMM" is exactly three digits or two digits > 59.
2282 To be safe, just use the DDD.DDDDD form.
2284 If LOWER or UPPER are specified, then the coordinate is checked
2285 for lower and upper bounds, respectively.
2291 my ($self, $field) = (shift, shift);
2293 my $lower = shift if scalar(@_);
2294 my $upper = shift if scalar(@_);
2295 my $coord = $self->getfield($field);
2296 my $neg = $coord =~ s/^(-)//;
2298 my ($d, $m, $s) = (0, 0, 0);
2301 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
2302 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
2303 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
2305 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
2308 return "Invalid (coordinate with minutes > 59) $field: "
2309 . $self->getfield($field);
2312 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
2314 if (defined($lower) and ($coord < $lower)) {
2315 return "Invalid (coordinate < $lower) $field: "
2316 . $self->getfield($field);;
2319 if (defined($upper) and ($coord > $upper)) {
2320 return "Invalid (coordinate > $upper) $field: "
2321 . $self->getfield($field);;
2324 $self->setfield($field, $coord);
2328 return "Invalid (coordinate) $field: " . $self->getfield($field);
2332 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
2334 Same as ut_coord, except optionally null.
2340 my ($self, $field) = (shift, shift);
2342 if ($self->getfield($field) =~ /^$/) {
2345 return $self->ut_coord($field, @_);
2351 =item ut_domain COLUMN
2353 Check/untaint host and domain names.
2358 my( $self, $field ) = @_;
2359 #$self->getfield($field) =~/^(\w+\.)*\w+$/
2360 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
2361 or return "Illegal (domain) $field: ". $self->getfield($field);
2362 $self->setfield($field,$1);
2366 =item ut_name COLUMN
2368 Check/untaint proper names; allows alphanumerics, spaces and the following
2369 punctuation: , . - '
2376 my( $self, $field ) = @_;
2377 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
2378 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
2379 $self->setfield($field,$1);
2385 Check/untaint zip codes.
2389 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2392 my( $self, $field, $country ) = @_;
2394 if ( $country eq 'US' ) {
2396 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2397 or return gettext('illegal_zip'). " $field for country $country: ".
2398 $self->getfield($field);
2399 $self->setfield($field, $1);
2401 } elsif ( $country eq 'CA' ) {
2403 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2404 or return gettext('illegal_zip'). " $field for country $country: ".
2405 $self->getfield($field);
2406 $self->setfield($field, "$1 $2");
2410 if ( $self->getfield($field) =~ /^\s*$/
2411 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2414 $self->setfield($field,'');
2416 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
2417 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2418 $self->setfield($field,$1);
2426 =item ut_country COLUMN
2428 Check/untaint country codes. Country names are changed to codes, if possible -
2429 see L<Locale::Country>.
2434 my( $self, $field ) = @_;
2435 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2436 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2437 && country2code($1) ) {
2438 $self->setfield($field,uc(country2code($1)));
2441 $self->getfield($field) =~ /^(\w\w)$/
2442 or return "Illegal (country) $field: ". $self->getfield($field);
2443 $self->setfield($field,uc($1));
2447 =item ut_anything COLUMN
2449 Untaints arbitrary data. Be careful.
2454 my( $self, $field ) = @_;
2455 $self->getfield($field) =~ /^(.*)$/s
2456 or return "Illegal $field: ". $self->getfield($field);
2457 $self->setfield($field,$1);
2461 =item ut_enum COLUMN CHOICES_ARRAYREF
2463 Check/untaint a column, supplying all possible choices, like the "enum" type.
2468 my( $self, $field, $choices ) = @_;
2469 foreach my $choice ( @$choices ) {
2470 if ( $self->getfield($field) eq $choice ) {
2471 $self->setfield($field, $choice);
2475 return "Illegal (enum) field $field: ". $self->getfield($field);
2478 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2480 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2481 on the column first.
2485 sub ut_foreign_key {
2486 my( $self, $field, $table, $foreign ) = @_;
2487 return '' if $no_check_foreign;
2488 qsearchs($table, { $foreign => $self->getfield($field) })
2489 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2490 " in $table.$foreign";
2494 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2496 Like ut_foreign_key, except the null value is also allowed.
2500 sub ut_foreign_keyn {
2501 my( $self, $field, $table, $foreign ) = @_;
2502 $self->getfield($field)
2503 ? $self->ut_foreign_key($field, $table, $foreign)
2507 =item ut_agentnum_acl COLUMN [ NULL_RIGHT | NULL_RIGHT_LISTREF ]
2509 Checks this column as an agentnum, taking into account the current users's
2510 ACLs. NULL_RIGHT or NULL_RIGHT_LISTREF, if specified, indicates the access
2511 right or rights allowing no agentnum.
2515 sub ut_agentnum_acl {
2516 my( $self, $field ) = (shift, shift);
2517 my $null_acl = scalar(@_) ? shift : [];
2518 $null_acl = [ $null_acl ] unless ref($null_acl);
2520 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2521 return "Illegal agentnum: $error" if $error;
2523 my $curuser = $FS::CurrentUser::CurrentUser;
2525 if ( $self->$field() ) {
2527 return "Access denied"
2528 unless $curuser->agentnum($self->$field());
2532 return "Access denied"
2533 unless grep $curuser->access_right($_), @$null_acl;
2541 =item virtual_fields [ TABLE ]
2543 Returns a list of virtual fields defined for the table. This should not
2544 be exported, and should only be called as an instance or class method.
2548 sub virtual_fields {
2551 $table = $self->table or confess "virtual_fields called on non-table";
2553 confess "Unknown table $table" unless dbdef->table($table);
2555 return () unless dbdef->table('part_virtual_field');
2557 unless ( $virtual_fields_cache{$table} ) {
2558 my $query = 'SELECT name from part_virtual_field ' .
2559 "WHERE dbtable = '$table'";
2561 my $result = $dbh->selectcol_arrayref($query);
2562 confess "Error executing virtual fields query: $query: ". $dbh->errstr
2564 $virtual_fields_cache{$table} = $result;
2567 @{$virtual_fields_cache{$table}};
2572 =item fields [ TABLE ]
2574 This is a wrapper for real_fields and virtual_fields. Code that called
2575 fields before should probably continue to call fields.
2580 my $something = shift;
2582 if($something->isa('FS::Record')) {
2583 $table = $something->table;
2585 $table = $something;
2586 $something = "FS::$table";
2588 return (real_fields($table), $something->virtual_fields());
2591 =item pvf FIELD_NAME
2593 Returns the FS::part_virtual_field object corresponding to a field in the
2594 record (specified by FIELD_NAME).
2599 my ($self, $name) = (shift, shift);
2601 if(grep /^$name$/, $self->virtual_fields) {
2602 return qsearchs('part_virtual_field', { dbtable => $self->table,
2608 =item vfieldpart_hashref TABLE
2610 Returns a hashref of virtual field names and vfieldparts applicable to the given
2615 sub vfieldpart_hashref {
2617 my $table = $self->table;
2619 return {} unless dbdef->table('part_virtual_field');
2622 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
2623 "dbtable = '$table'";
2624 my $sth = $dbh->prepare($statement);
2625 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
2626 return { map { $_->{name}, $_->{vfieldpart} }
2627 @{$sth->fetchall_arrayref({})} };
2631 =item encrypt($value)
2633 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2635 Returns the encrypted string.
2637 You should generally not have to worry about calling this, as the system handles this for you.
2642 my ($self, $value) = @_;
2645 if ($conf->exists('encryption')) {
2646 if ($self->is_encrypted($value)) {
2647 # Return the original value if it isn't plaintext.
2648 $encrypted = $value;
2651 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2652 # RSA doesn't like the empty string so let's pack it up
2653 # The database doesn't like the RSA data so uuencode it
2654 my $length = length($value)+1;
2655 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2657 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2664 =item is_encrypted($value)
2666 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2672 my ($self, $value) = @_;
2673 # Possible Bug - Some work may be required here....
2675 if ($value =~ /^M/ && length($value) > 80) {
2682 =item decrypt($value)
2684 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2686 You should generally not have to worry about calling this, as the system handles this for you.
2691 my ($self,$value) = @_;
2692 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2693 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2695 if (ref($rsa_decrypt) =~ /::RSA/) {
2696 my $encrypted = unpack ("u*", $value);
2697 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2698 if ($@) {warn "Decryption Failed"};
2706 #Initialize the Module
2707 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2709 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2710 $rsa_module = $conf->config('encryptionmodule');
2714 eval ("require $rsa_module"); # No need to import the namespace
2717 # Initialize Encryption
2718 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2719 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2720 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2723 # Intitalize Decryption
2724 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2725 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2726 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2730 =item h_search ACTION
2732 Given an ACTION, either "insert", or "delete", returns the appropriate history
2733 record corresponding to this record, if any.
2738 my( $self, $action ) = @_;
2740 my $table = $self->table;
2743 my $primary_key = dbdef->table($table)->primary_key;
2746 'table' => "h_$table",
2747 'hashref' => { $primary_key => $self->$primary_key(),
2748 'history_action' => $action,
2756 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2757 appropriate history record corresponding to this record, if any.
2762 my($self, $action) = @_;
2763 my $h = $self->h_search($action);
2764 $h ? $h->history_date : '';
2767 =item scalar_sql SQL
2769 A class method with a propensity for becoming an instance method. This
2770 method executes the sql statement represented by SQL and returns a scalar
2771 representing the result. Don't ask for rows -- you get the first column
2772 of the first row. Don't give me bogus SQL or I'll die on you.
2774 Returns an empty string in the event of no rows.
2779 my($self, $sql ) = ( shift, shift );
2780 my $sth = dbh->prepare($sql) or die dbh->errstr;
2782 or die "Unexpected error executing statement $sql: ". $sth->errstr;
2783 $sth->fetchrow_arrayref->[0] || '';
2792 =item real_fields [ TABLE ]
2794 Returns a list of the real columns in the specified table. Called only by
2795 fields() and other subroutines elsewhere in FS::Record.
2802 my($table_obj) = dbdef->table($table);
2803 confess "Unknown table $table" unless $table_obj;
2804 $table_obj->columns;
2807 =item _quote VALUE, TABLE, COLUMN
2809 This is an internal function used to construct SQL statements. It returns
2810 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2811 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2816 my($value, $table, $column) = @_;
2817 my $column_obj = dbdef->table($table)->column($column);
2818 my $column_type = $column_obj->type;
2819 my $nullable = $column_obj->null;
2821 warn " $table.$column: $value ($column_type".
2822 ( $nullable ? ' NULL' : ' NOT NULL' ).
2823 ")\n" if $DEBUG > 2;
2825 if ( $value eq '' && $nullable ) {
2827 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2828 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2831 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2832 ! $column_type =~ /(char|binary|text)$/i ) {
2834 } elsif (( $column_type =~ /^bytea$/i || $column_type =~ /(blob|varbinary)/i )
2835 && driver_name eq 'Pg'
2839 # dbh->quote($value, { pg_type => PG_BYTEA() }); # doesn't work right
2840 # Pg binary string quoting: convert each character to 3-digit octal prefixed with \\,
2841 # single-quote the whole mess, and put an "E" in front.
2842 return ("E'" . join('', map { sprintf('\\\\%03o', ord($_)) } split(//, $value) ) . "'");
2850 This is deprecated. Don't use it.
2852 It returns a hash-type list with the fields of this record's table set true.
2857 carp "warning: hfields is deprecated";
2860 foreach (fields($table)) {
2869 "$_: ". $self->getfield($_). "|"
2870 } (fields($self->table)) );
2873 sub DESTROY { return; }
2877 # #use Carp qw(cluck);
2878 # #cluck "DESTROYING $self";
2879 # warn "DESTROYING $self";
2883 # return ! eval { join('',@_), kill 0; 1; };
2886 =item str2time_sql [ DRIVER_NAME ]
2888 Returns a function to convert to unix time based on database type, such as
2889 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
2890 the str2time_sql_closing method to return a closing string rather than just
2891 using a closing parenthesis as previously suggested.
2893 You can pass an optional driver name such as "Pg", "mysql" or
2894 $dbh->{Driver}->{Name} to return a function for that database instead of
2895 the current database.
2900 my $driver = shift || driver_name;
2902 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
2903 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
2905 warn "warning: unknown database type $driver; guessing how to convert ".
2906 "dates to UNIX timestamps";
2907 return 'EXTRACT(EPOCH FROM ';
2911 =item str2time_sql_closing [ DRIVER_NAME ]
2913 Returns the closing suffix of a function to convert to unix time based on
2914 database type, such as ")::integer" for Pg or ")" for mysql.
2916 You can pass an optional driver name such as "Pg", "mysql" or
2917 $dbh->{Driver}->{Name} to return a function for that database instead of
2918 the current database.
2922 sub str2time_sql_closing {
2923 my $driver = shift || driver_name;
2925 return ' )::INTEGER ' if $driver =~ /^Pg/i;
2933 This module should probably be renamed, since much of the functionality is
2934 of general use. It is not completely unlike Adapter::DBI (see below).
2936 Exported qsearch and qsearchs should be deprecated in favor of method calls
2937 (against an FS::Record object like the old search and searchs that qsearch
2938 and qsearchs were on top of.)
2940 The whole fields / hfields mess should be removed.
2942 The various WHERE clauses should be subroutined.
2944 table string should be deprecated in favor of DBIx::DBSchema::Table.
2946 No doubt we could benefit from a Tied hash. Documenting how exists / defined
2947 true maps to the database (and WHERE clauses) would also help.
2949 The ut_ methods should ask the dbdef for a default length.
2951 ut_sqltype (like ut_varchar) should all be defined
2953 A fallback check method should be provided which uses the dbdef.
2955 The ut_money method assumes money has two decimal digits.
2957 The Pg money kludge in the new method only strips `$'.
2959 The ut_phonen method only checks US-style phone numbers.
2961 The _quote function should probably use ut_float instead of a regex.
2963 All the subroutines probably should be methods, here or elsewhere.
2965 Probably should borrow/use some dbdef methods where appropriate (like sub
2968 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
2969 or allow it to be set. Working around it is ugly any way around - DBI should
2970 be fixed. (only affects RDBMS which return uppercase column names)
2972 ut_zip should take an optional country like ut_phone.
2976 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
2978 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.