4 use vars qw( $dbdef_file $dbdef $setup_hack $AUTOLOAD @ISA @EXPORT_OK $DEBUG
5 $me %dbdef_cache %virtual_fields_cache );
6 use subs qw(reload_dbdef);
8 use Carp qw(carp cluck croak confess);
11 use DBI qw(:sql_types);
12 use DBIx::DBSchema 0.23;
13 use FS::UID qw(dbh getotaker datasrc driver_name);
15 use FS::Msgcat qw(gettext);
17 use FS::part_virtual_field;
22 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef jsearch);
27 #ask FS::UID to run this stuff for us later
28 $FS::UID::callback{'FS::Record'} = sub {
29 $File::CounterFile::DEFAULT_DIR = "/usr/local/etc/freeside/counters.". datasrc;
30 $dbdef_file = "/usr/local/etc/freeside/dbdef.". datasrc;
31 &reload_dbdef unless $setup_hack; #$setup_hack needed now?
36 FS::Record - Database record objects
41 use FS::Record qw(dbh fields qsearch qsearchs dbdef);
43 $record = new FS::Record 'table', \%hash;
44 $record = new FS::Record 'table', { 'column' => 'value', ... };
46 $record = qsearchs FS::Record 'table', \%hash;
47 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
48 @records = qsearch FS::Record 'table', \%hash;
49 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
51 $table = $record->table;
52 $dbdef_table = $record->dbdef_table;
54 $value = $record->get('column');
55 $value = $record->getfield('column');
56 $value = $record->column;
58 $record->set( 'column' => 'value' );
59 $record->setfield( 'column' => 'value' );
60 $record->column('value');
62 %hash = $record->hash;
64 $hashref = $record->hashref;
66 $error = $record->insert;
68 $error = $record->delete;
70 $error = $new_record->replace($old_record);
72 # external use deprecated - handled by the database (at least for Pg, mysql)
73 $value = $record->unique('column');
75 $error = $record->ut_float('column');
76 $error = $record->ut_number('column');
77 $error = $record->ut_numbern('column');
78 $error = $record->ut_money('column');
79 $error = $record->ut_text('column');
80 $error = $record->ut_textn('column');
81 $error = $record->ut_alpha('column');
82 $error = $record->ut_alphan('column');
83 $error = $record->ut_phonen('column');
84 $error = $record->ut_anything('column');
85 $error = $record->ut_name('column');
87 $dbdef = reload_dbdef;
88 $dbdef = reload_dbdef "/non/standard/filename";
91 $quoted_value = _quote($value,'table','field');
94 $fields = hfields('table');
95 if ( $fields->{Field} ) { # etc.
97 @fields = fields 'table'; #as a subroutine
98 @fields = $record->fields; #as a method call
103 (Mostly) object-oriented interface to database records. Records are currently
104 implemented on top of DBI. FS::Record is intended as a base class for
105 table-specific classes to inherit from, i.e. FS::cust_main.
111 =item new [ TABLE, ] HASHREF
113 Creates a new record. It doesn't store it in the database, though. See
114 L<"insert"> for that.
116 Note that the object stores this hash reference, not a distinct copy of the
117 hash it points to. You can ask the object for a copy with the I<hash>
120 TABLE can only be omitted when a dervived class overrides the table method.
126 my $class = ref($proto) || $proto;
128 bless ($self, $class);
130 unless ( defined ( $self->table ) ) {
131 $self->{'Table'} = shift;
132 carp "warning: FS::Record::new called with table name ". $self->{'Table'};
135 $self->{'Hash'} = shift;
137 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
138 $self->{'Hash'}{$field}='';
141 $self->_rebless if $self->can('_rebless');
143 $self->{'modified'} = 0;
145 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
152 my $class = ref($proto) || $proto;
154 bless ($self, $class);
156 $self->{'Table'} = shift unless defined ( $self->table );
158 my $hashref = $self->{'Hash'} = shift;
160 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
161 my $obj = $cache->cache->{$hashref->{$cache->key}};
162 $obj->_cache($hashref, $cache) if $obj->can('_cache');
165 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
172 my $class = ref($proto) || $proto;
174 bless ($self, $class);
175 if ( defined $self->table ) {
176 cluck "create constructor is deprecated, use new!";
179 croak "FS::Record::create called (not from a subclass)!";
183 =item qsearch TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
185 Searches the database for all records matching (at least) the key/value pairs
186 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
187 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
190 ###oops, argh, FS::Record::new only lets us create database fields.
191 #Normal behaviour if SELECT is not specified is `*', as in
192 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
193 #feature where you can specify SELECT - remember, the objects returned,
194 #although blessed into the appropriate `FS::TABLE' package, will only have the
195 #fields you specify. This might have unwanted results if you then go calling
196 #regular FS::TABLE methods
202 my($stable, $record, $select, $extra_sql, $cache, $addl_from ) = @_;
203 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
205 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
210 my $table = $cache ? $cache->table : $stable;
211 my $dbdef_table = $dbdef->table($table)
212 or die "No schema for table $table found - ".
213 "do you need to create it or run dbdef-create?";
214 my $pkey = $dbdef_table->primary_key;
216 my @real_fields = grep exists($record->{$_}), real_fields($table);
218 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
219 @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
221 cluck "warning: FS::$table not loaded; virtual fields not searchable";
222 @virtual_fields = ();
225 my $statement = "SELECT $select FROM $stable";
226 $statement .= " $addl_from" if $addl_from;
227 if ( @real_fields or @virtual_fields ) {
228 $statement .= ' WHERE '. join(' AND ',
233 if ( ref($record->{$_}) ) {
234 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
235 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
236 if ( uc($op) eq 'ILIKE' ) {
238 $record->{$_}{'value'} = lc($record->{$_}{'value'});
239 $column = "LOWER($_)";
241 $record->{$_} = $record->{$_}{'value'}
244 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
246 if ( driver_name eq 'Pg' ) {
247 my $type = $dbdef->table($table)->column($column)->type;
248 if ( $type =~ /(int|serial)/i ) {
249 qq-( $column IS NULL )-;
251 qq-( $column IS NULL OR $column = '' )-;
254 qq-( $column IS NULL OR $column = "" )-;
256 } elsif ( $op eq '!=' ) {
257 if ( driver_name eq 'Pg' ) {
258 my $type = $dbdef->table($table)->column($column)->type;
259 if ( $type =~ /(int|serial)/i ) {
260 qq-( $column IS NOT NULL )-;
262 qq-( $column IS NOT NULL AND $column != '' )-;
265 qq-( $column IS NOT NULL AND $column != "" )-;
268 if ( driver_name eq 'Pg' ) {
269 qq-( $column $op '' )-;
271 qq-( $column $op "" )-;
281 if ( ref($record->{$_}) ) {
282 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
283 if ( uc($op) eq 'ILIKE' ) {
285 $record->{$_}{'value'} = lc($record->{$_}{'value'});
286 $column = "LOWER($_)";
288 $record->{$_} = $record->{$_}{'value'};
291 # ... EXISTS ( SELECT name, value FROM part_virtual_field
293 # ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
294 # WHERE recnum = svc_acct.svcnum
295 # AND (name, value) = ('egad', 'brain') )
297 my $value = $record->{$_};
301 $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
302 "( SELECT part_virtual_field.name, virtual_field.value ".
303 "FROM part_virtual_field JOIN virtual_field ".
304 "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
305 "WHERE virtual_field.recnum = ${table}.${pkey} ".
306 "AND part_virtual_field.name = '${column}'".
308 " AND virtual_field.value ${op} '${value}'"
312 } @virtual_fields ) );
316 $statement .= " $extra_sql" if defined($extra_sql);
318 warn "[debug]$me $statement\n" if $DEBUG > 1;
319 my $sth = $dbh->prepare($statement)
320 or croak "$dbh->errstr doing $statement";
325 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
327 if ( $record->{$field} =~ /^\d+(\.\d+)?$/
328 && $dbdef->table($table)->column($field)->type =~ /(int|serial)/i
330 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_INTEGER } );
332 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_VARCHAR } );
336 # $sth->execute( map $record->{$_},
337 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
338 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
340 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
342 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
343 @virtual_fields = "FS::$table"->virtual_fields;
345 cluck "warning: FS::$table not loaded; virtual fields not returned either";
346 @virtual_fields = ();
350 tie %result, "Tie::IxHash";
351 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
353 %result = map { $_->{$pkey}, $_ } @stuff;
355 @result{@stuff} = @stuff;
360 if ( keys(%result) and @virtual_fields ) {
362 "SELECT virtual_field.recnum, part_virtual_field.name, ".
363 "virtual_field.value ".
364 "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
365 "WHERE part_virtual_field.dbtable = '$table' AND ".
366 "virtual_field.recnum IN (".
367 join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
368 join(q!', '!, @virtual_fields) . "')";
369 warn "[debug]$me $statement\n" if $DEBUG > 1;
370 $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
371 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
373 foreach (@{ $sth->fetchall_arrayref({}) }) {
374 my $recnum = $_->{recnum};
375 my $name = $_->{name};
376 my $value = $_->{value};
377 if (exists($result{$recnum})) {
378 $result{$recnum}->{$name} = $value;
383 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
384 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
385 #derivied class didn't override new method, so this optimization is safe
388 new_or_cached( "FS::$table", { %{$_} }, $cache )
392 new( "FS::$table", { %{$_} } )
396 warn "untested code (class FS::$table uses custom new method)";
398 eval 'FS::'. $table. '->new( { %{$_} } )';
402 cluck "warning: FS::$table not loaded; returning FS::Record objects";
404 FS::Record->new( $table, { %{$_} } );
410 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
412 Experimental JOINed search method. Using this method, you can execute a
413 single SELECT spanning multiple tables, and cache the results for subsequent
414 method calls. Interface will almost definately change in an incompatible
422 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
423 my $cache = FS::SearchCache->new( $ptable, $pkey );
426 grep { !$saw{$_->getfield($pkey)}++ }
427 qsearch($table, $record, $select, $extra_sql, $cache )
431 =item qsearchs TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
433 Same as qsearch, except that if more than one record matches, it B<carp>s but
434 returns the first. If this happens, you either made a logic error in asking
435 for a single item, or your data is corrupted.
439 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
441 my(@result) = qsearch(@_);
442 cluck "warning: Multiple records in scalar search ($table)"
443 if scalar(@result) > 1;
444 #should warn more vehemently if the search was on a primary key?
445 scalar(@result) ? ($result[0]) : ();
456 Returns the table name.
461 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
468 Returns the DBIx::DBSchema::Table object for the table.
474 my($table)=$self->table;
475 $dbdef->table($table);
478 =item get, getfield COLUMN
480 Returns the value of the column/field/key COLUMN.
485 my($self,$field) = @_;
486 # to avoid "Use of unitialized value" errors
487 if ( defined ( $self->{Hash}->{$field} ) ) {
488 $self->{Hash}->{$field};
498 =item set, setfield COLUMN, VALUE
500 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
505 my($self,$field,$value) = @_;
506 $self->{'modified'} = 1;
507 $self->{'Hash'}->{$field} = $value;
514 =item AUTLOADED METHODS
516 $record->column is a synonym for $record->get('column');
518 $record->column('value') is a synonym for $record->set('column','value');
525 my($field)=$AUTOLOAD;
527 if ( defined($value) ) {
528 confess "errant AUTOLOAD $field for $self (arg $value)"
529 unless ref($self) && $self->can('setfield');
530 $self->setfield($field,$value);
532 confess "errant AUTOLOAD $field for $self (no args)"
533 unless ref($self) && $self->can('getfield');
534 $self->getfield($field);
540 # my $field = $AUTOLOAD;
542 # if ( defined($_[1]) ) {
543 # $_[0]->setfield($field, $_[1]);
545 # $_[0]->getfield($field);
551 Returns a list of the column/value pairs, usually for assigning to a new hash.
553 To make a distinct duplicate of an FS::Record object, you can do:
555 $new = new FS::Record ( $old->table, { $old->hash } );
561 confess $self. ' -> hash: Hash attribute is undefined'
562 unless defined($self->{'Hash'});
563 %{ $self->{'Hash'} };
568 Returns a reference to the column/value hash. This may be deprecated in the
569 future; if there's a reason you can't just use the autoloaded or get/set
581 Returns true if any of this object's values have been modified with set (or via
582 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
594 Inserts this record to the database. If there is an error, returns the error,
595 otherwise returns false.
602 my $error = $self->check;
603 return $error if $error;
605 #single-field unique keys are given a value if false
606 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
607 foreach ( $self->dbdef_table->unique->singles ) {
608 $self->unique($_) unless $self->getfield($_);
611 #and also the primary key, if the database isn't going to
612 my $primary_key = $self->dbdef_table->primary_key;
614 if ( $primary_key ) {
615 my $col = $self->dbdef_table->column($primary_key);
618 uc($col->type) eq 'SERIAL'
619 || ( driver_name eq 'Pg'
620 && defined($col->default)
621 && $col->default =~ /^nextval\(/i
623 || ( driver_name eq 'mysql'
624 && defined($col->local)
625 && $col->local =~ /AUTO_INCREMENT/i
627 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
630 my $table = $self->table;
631 #false laziness w/delete
633 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
636 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
639 my $statement = "INSERT INTO $table ( ".
640 join( ', ', @real_fields ).
642 join( ', ', @values ).
645 warn "[debug]$me $statement\n" if $DEBUG > 1;
646 my $sth = dbh->prepare($statement) or return dbh->errstr;
648 local $SIG{HUP} = 'IGNORE';
649 local $SIG{INT} = 'IGNORE';
650 local $SIG{QUIT} = 'IGNORE';
651 local $SIG{TERM} = 'IGNORE';
652 local $SIG{TSTP} = 'IGNORE';
653 local $SIG{PIPE} = 'IGNORE';
655 $sth->execute or return $sth->errstr;
658 if ( $db_seq ) { # get inserted id from the database, if applicable
659 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
660 if ( driver_name eq 'Pg' ) {
662 my $oid = $sth->{'pg_oid_status'};
663 my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
664 my $i_sth = dbh->prepare($i_sql) or do {
665 dbh->rollback if $FS::UID::AutoCommit;
668 $i_sth->execute($oid) or do {
669 dbh->rollback if $FS::UID::AutoCommit;
670 return $i_sth->errstr;
672 $insertid = $i_sth->fetchrow_arrayref->[0];
674 } elsif ( driver_name eq 'mysql' ) {
676 $insertid = dbh->{'mysql_insertid'};
677 # work around mysql_insertid being null some of the time, ala RT :/
678 unless ( $insertid ) {
679 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
680 "using SELECT LAST_INSERT_ID();";
681 my $i_sql = "SELECT LAST_INSERT_ID()";
682 my $i_sth = dbh->prepare($i_sql) or do {
683 dbh->rollback if $FS::UID::AutoCommit;
686 $i_sth->execute or do {
687 dbh->rollback if $FS::UID::AutoCommit;
688 return $i_sth->errstr;
690 $insertid = $i_sth->fetchrow_arrayref->[0];
694 dbh->rollback if $FS::UID::AutoCommit;
695 return "don't know how to retreive inserted ids from ". driver_name.
696 ", try using counterfiles (maybe run dbdef-create?)";
698 $self->setfield($primary_key, $insertid);
702 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
703 $self->virtual_fields;
704 if (@virtual_fields) {
705 my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
707 my $vfieldpart = $self->vfieldpart_hashref;
709 my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
712 my $v_sth = dbh->prepare($v_statement) or do {
713 dbh->rollback if $FS::UID::AutoCommit;
717 foreach (keys(%v_values)) {
718 $v_sth->execute($self->getfield($primary_key),
722 dbh->rollback if $FS::UID::AutoCommit;
723 return $v_sth->errstr;
730 if ( defined $dbdef->table('h_'. $table) ) {
731 my $h_statement = $self->_h_statement('insert');
732 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
733 $h_sth = dbh->prepare($h_statement) or do {
734 dbh->rollback if $FS::UID::AutoCommit;
740 $h_sth->execute or return $h_sth->errstr if $h_sth;
742 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
749 Depriciated (use insert instead).
754 cluck "warning: FS::Record::add deprecated!";
755 insert @_; #call method in this scope
760 Delete this record from the database. If there is an error, returns the error,
761 otherwise returns false.
768 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
770 $self->getfield($_) eq ''
771 #? "( $_ IS NULL OR $_ = \"\" )"
772 ? ( driver_name eq 'Pg'
774 : "( $_ IS NULL OR $_ = \"\" )"
776 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
777 } ( $self->dbdef_table->primary_key )
778 ? ( $self->dbdef_table->primary_key)
779 : real_fields($self->table)
781 warn "[debug]$me $statement\n" if $DEBUG > 1;
782 my $sth = dbh->prepare($statement) or return dbh->errstr;
785 if ( defined $dbdef->table('h_'. $self->table) ) {
786 my $h_statement = $self->_h_statement('delete');
787 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
788 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
793 my $primary_key = $self->dbdef_table->primary_key;
796 my $vfp = $self->vfieldpart_hashref;
797 foreach($self->virtual_fields) {
798 next if $self->getfield($_) eq '';
799 unless(@del_vfields) {
800 my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
801 $v_sth = dbh->prepare($st) or return dbh->errstr;
803 push @del_vfields, $_;
806 local $SIG{HUP} = 'IGNORE';
807 local $SIG{INT} = 'IGNORE';
808 local $SIG{QUIT} = 'IGNORE';
809 local $SIG{TERM} = 'IGNORE';
810 local $SIG{TSTP} = 'IGNORE';
811 local $SIG{PIPE} = 'IGNORE';
813 my $rc = $sth->execute or return $sth->errstr;
814 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
815 $h_sth->execute or return $h_sth->errstr if $h_sth;
816 $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
817 or return $v_sth->errstr
818 foreach (@del_vfields);
820 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
822 #no need to needlessly destoy the data either (causes problems actually)
823 #undef $self; #no need to keep object!
830 Depriciated (use delete instead).
835 cluck "warning: FS::Record::del deprecated!";
836 &delete(@_); #call method in this scope
839 =item replace OLD_RECORD
841 Replace the OLD_RECORD with this one in the database. If there is an error,
842 returns the error, otherwise returns false.
853 warn "[debug]$me replace called with no arguments; autoloading old record\n"
855 my $primary_key = $new->dbdef_table->primary_key;
856 if ( $primary_key ) {
857 $old = qsearchs($new->table, { $primary_key => $new->$primary_key() } )
858 or croak "can't find ". $new->table. ".$primary_key ".
859 $new->$primary_key();
861 croak $new->table. " has no primary key; pass old record as argument";
865 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
867 return "Records not in same table!" unless $new->table eq $old->table;
869 my $primary_key = $old->dbdef_table->primary_key;
870 return "Can't change $primary_key"
872 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
874 my $error = $new->check;
875 return $error if $error;
877 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
878 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
879 ? ($_, $new->getfield($_)) : () } $old->fields;
881 unless ( keys(%diff) ) {
882 carp "[warning]$me $new -> replace $old: records identical";
886 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
888 "$_ = ". _quote($new->getfield($_),$old->table,$_)
889 } real_fields($old->table)
894 if ( $old->getfield($_) eq '' ) {
896 #false laziness w/qsearch
897 if ( driver_name eq 'Pg' ) {
898 my $type = $old->dbdef_table->column($_)->type;
899 if ( $type =~ /(int|serial)/i ) {
902 qq-( $_ IS NULL OR $_ = '' )-;
905 qq-( $_ IS NULL OR $_ = "" )-;
909 "$_ = ". _quote($old->getfield($_),$old->table,$_);
912 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
915 warn "[debug]$me $statement\n" if $DEBUG > 1;
916 my $sth = dbh->prepare($statement) or return dbh->errstr;
919 if ( defined $dbdef->table('h_'. $old->table) ) {
920 my $h_old_statement = $old->_h_statement('replace_old');
921 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
922 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
928 if ( defined $dbdef->table('h_'. $new->table) ) {
929 my $h_new_statement = $new->_h_statement('replace_new');
930 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
931 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
936 # For virtual fields we have three cases with different SQL
937 # statements: add, replace, delete
941 my (@add_vfields, @rep_vfields, @del_vfields);
942 my $vfp = $old->vfieldpart_hashref;
943 foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
944 if($diff{$_} eq '') {
946 unless(@del_vfields) {
947 my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
948 "AND vfieldpart = ?";
949 warn "[debug]$me $st\n" if $DEBUG > 2;
950 $v_del_sth = dbh->prepare($st) or return dbh->errstr;
952 push @del_vfields, $_;
953 } elsif($old->getfield($_) eq '') {
955 unless(@add_vfields) {
956 my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
958 warn "[debug]$me $st\n" if $DEBUG > 2;
959 $v_add_sth = dbh->prepare($st) or return dbh->errstr;
961 push @add_vfields, $_;
964 unless(@rep_vfields) {
965 my $st = "UPDATE virtual_field SET value = ? ".
966 "WHERE recnum = ? AND vfieldpart = ?";
967 warn "[debug]$me $st\n" if $DEBUG > 2;
968 $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
970 push @rep_vfields, $_;
974 local $SIG{HUP} = 'IGNORE';
975 local $SIG{INT} = 'IGNORE';
976 local $SIG{QUIT} = 'IGNORE';
977 local $SIG{TERM} = 'IGNORE';
978 local $SIG{TSTP} = 'IGNORE';
979 local $SIG{PIPE} = 'IGNORE';
981 my $rc = $sth->execute or return $sth->errstr;
982 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
983 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
984 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
986 $v_del_sth->execute($old->getfield($primary_key),
988 or return $v_del_sth->errstr
989 foreach(@del_vfields);
991 $v_add_sth->execute($new->getfield($_),
992 $old->getfield($primary_key),
994 or return $v_add_sth->errstr
995 foreach(@add_vfields);
997 $v_rep_sth->execute($new->getfield($_),
998 $old->getfield($primary_key),
1000 or return $v_rep_sth->errstr
1001 foreach(@rep_vfields);
1003 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1011 Depriciated (use replace instead).
1016 cluck "warning: FS::Record::rep deprecated!";
1017 replace @_; #call method in this scope
1022 Checks virtual fields (using check_blocks). Subclasses should still provide
1023 a check method to validate real fields, foreign keys, etc., and call this
1024 method via $self->SUPER::check.
1026 (FIXME: Should this method try to make sure that it I<is> being called from
1027 a subclass's check method, to keep the current semantics as far as possible?)
1032 #confess "FS::Record::check not implemented; supply one in subclass!";
1035 foreach my $field ($self->virtual_fields) {
1036 for ($self->getfield($field)) {
1037 # See notes on check_block in FS::part_virtual_field.
1038 eval $self->pvf($field)->check_block;
1040 #this is bad, probably want to follow the stack backtrace up and see
1042 my $err = "Fatal error checking $field for $self";
1044 return "$err (see log for backtrace): $@";
1047 $self->setfield($field, $_);
1054 my( $self, $action ) = @_;
1057 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
1058 real_fields($self->table);
1060 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1062 "INSERT INTO h_". $self->table. " ( ".
1063 join(', ', qw(history_date history_user history_action), @fields ).
1065 join(', ', time, dbh->quote(getotaker()), dbh->quote($action), @values).
1072 B<Warning>: External use is B<deprecated>.
1074 Replaces COLUMN in record with a unique number, using counters in the
1075 filesystem. Used by the B<insert> method on single-field unique columns
1076 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1077 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1079 Returns the new value.
1084 my($self,$field) = @_;
1085 my($table)=$self->table;
1087 croak "Unique called on field $field, but it is ",
1088 $self->getfield($field),
1090 if $self->getfield($field);
1092 #warn "table $table is tainted" if is_tainted($table);
1093 #warn "field $field is tainted" if is_tainted($field);
1095 my($counter) = new File::CounterFile "$table.$field",0;
1097 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1099 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1102 my $index = $counter->inc;
1103 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1105 $index =~ /^(\d*)$/;
1108 $self->setfield($field,$index);
1112 =item ut_float COLUMN
1114 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1115 null. If there is an error, returns the error, otherwise returns false.
1120 my($self,$field)=@_ ;
1121 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
1122 $self->getfield($field) =~ /^(\d+)$/ ||
1123 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
1124 $self->getfield($field) =~ /^(\d+e\d+)$/)
1125 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1126 $self->setfield($field,$1);
1130 =item ut_snumber COLUMN
1132 Check/untaint signed numeric data (whole numbers). May not be null. If there
1133 is an error, returns the error, otherwise returns false.
1138 my($self, $field) = @_;
1139 $self->getfield($field) =~ /^(-?)\s*(\d+)$/
1140 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1141 $self->setfield($field, "$1$2");
1145 =item ut_number COLUMN
1147 Check/untaint simple numeric data (whole numbers). May not be null. If there
1148 is an error, returns the error, otherwise returns false.
1153 my($self,$field)=@_;
1154 $self->getfield($field) =~ /^(\d+)$/
1155 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1156 $self->setfield($field,$1);
1160 =item ut_numbern COLUMN
1162 Check/untaint simple numeric data (whole numbers). May be null. If there is
1163 an error, returns the error, otherwise returns false.
1168 my($self,$field)=@_;
1169 $self->getfield($field) =~ /^(\d*)$/
1170 or return "Illegal (numeric) $field: ". $self->getfield($field);
1171 $self->setfield($field,$1);
1175 =item ut_money COLUMN
1177 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
1178 is an error, returns the error, otherwise returns false.
1183 my($self,$field)=@_;
1184 $self->setfield($field, 0) if $self->getfield($field) eq '';
1185 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
1186 or return "Illegal (money) $field: ". $self->getfield($field);
1187 #$self->setfield($field, "$1$2$3" || 0);
1188 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
1192 =item ut_text COLUMN
1194 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1195 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / =
1196 May not be null. If there is an error, returns the error, otherwise returns
1202 my($self,$field)=@_;
1203 #warn "msgcat ". \&msgcat. "\n";
1204 #warn "notexist ". \¬exist. "\n";
1205 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
1206 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]+)$/
1207 or return gettext('illegal_or_empty_text'). " $field: ".
1208 $self->getfield($field);
1209 $self->setfield($field,$1);
1213 =item ut_textn COLUMN
1215 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1216 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
1217 May be null. If there is an error, returns the error, otherwise returns false.
1222 my($self,$field)=@_;
1223 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]*)$/
1224 or return gettext('illegal_text'). " $field: ". $self->getfield($field);
1225 $self->setfield($field,$1);
1229 =item ut_alpha COLUMN
1231 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
1232 an error, returns the error, otherwise returns false.
1237 my($self,$field)=@_;
1238 $self->getfield($field) =~ /^(\w+)$/
1239 or return "Illegal or empty (alphanumeric) $field: ".
1240 $self->getfield($field);
1241 $self->setfield($field,$1);
1245 =item ut_alpha COLUMN
1247 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
1248 error, returns the error, otherwise returns false.
1253 my($self,$field)=@_;
1254 $self->getfield($field) =~ /^(\w*)$/
1255 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
1256 $self->setfield($field,$1);
1260 =item ut_phonen COLUMN [ COUNTRY ]
1262 Check/untaint phone numbers. May be null. If there is an error, returns
1263 the error, otherwise returns false.
1265 Takes an optional two-letter ISO country code; without it or with unsupported
1266 countries, ut_phonen simply calls ut_alphan.
1271 my( $self, $field, $country ) = @_;
1272 return $self->ut_alphan($field) unless defined $country;
1273 my $phonen = $self->getfield($field);
1274 if ( $phonen eq '' ) {
1275 $self->setfield($field,'');
1276 } elsif ( $country eq 'US' || $country eq 'CA' ) {
1278 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
1279 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
1280 $phonen = "$1-$2-$3";
1281 $phonen .= " x$4" if $4;
1282 $self->setfield($field,$phonen);
1284 warn "warning: don't know how to check phone numbers for country $country";
1285 return $self->ut_textn($field);
1292 Check/untaint ip addresses. IPv4 only for now.
1297 my( $self, $field ) = @_;
1298 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
1299 or return "Illegal (IP address) $field: ". $self->getfield($field);
1300 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
1301 $self->setfield($field, "$1.$2.$3.$4");
1307 Check/untaint ip addresses. IPv4 only for now. May be null.
1312 my( $self, $field ) = @_;
1313 if ( $self->getfield($field) =~ /^()$/ ) {
1314 $self->setfield($field,'');
1317 $self->ut_ip($field);
1321 =item ut_domain COLUMN
1323 Check/untaint host and domain names.
1328 my( $self, $field ) = @_;
1329 #$self->getfield($field) =~/^(\w+\.)*\w+$/
1330 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
1331 or return "Illegal (domain) $field: ". $self->getfield($field);
1332 $self->setfield($field,$1);
1336 =item ut_name COLUMN
1338 Check/untaint proper names; allows alphanumerics, spaces and the following
1339 punctuation: , . - '
1346 my( $self, $field ) = @_;
1347 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
1348 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
1349 $self->setfield($field,$1);
1355 Check/untaint zip codes.
1360 my( $self, $field, $country ) = @_;
1361 if ( $country eq 'US' ) {
1362 $self->getfield($field) =~ /\s*(\d{5}(\-\d{4})?)\s*$/
1363 or return gettext('illegal_zip'). " $field for country $country: ".
1364 $self->getfield($field);
1365 $self->setfield($field,$1);
1367 if ( $self->getfield($field) =~ /^\s*$/ ) {
1368 $self->setfield($field,'');
1370 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
1371 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
1372 $self->setfield($field,$1);
1378 =item ut_country COLUMN
1380 Check/untaint country codes. Country names are changed to codes, if possible -
1381 see L<Locale::Country>.
1386 my( $self, $field ) = @_;
1387 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
1388 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
1389 && country2code($1) ) {
1390 $self->setfield($field,uc(country2code($1)));
1393 $self->getfield($field) =~ /^(\w\w)$/
1394 or return "Illegal (country) $field: ". $self->getfield($field);
1395 $self->setfield($field,uc($1));
1399 =item ut_anything COLUMN
1401 Untaints arbitrary data. Be careful.
1406 my( $self, $field ) = @_;
1407 $self->getfield($field) =~ /^(.*)$/s
1408 or return "Illegal $field: ". $self->getfield($field);
1409 $self->setfield($field,$1);
1413 =item ut_enum COLUMN CHOICES_ARRAYREF
1415 Check/untaint a column, supplying all possible choices, like the "enum" type.
1420 my( $self, $field, $choices ) = @_;
1421 foreach my $choice ( @$choices ) {
1422 if ( $self->getfield($field) eq $choice ) {
1423 $self->setfield($choice);
1427 return "Illegal (enum) field $field: ". $self->getfield($field);
1430 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1432 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
1433 on the column first.
1437 sub ut_foreign_key {
1438 my( $self, $field, $table, $foreign ) = @_;
1439 qsearchs($table, { $foreign => $self->getfield($field) })
1440 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
1441 " in $table.$foreign";
1445 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1447 Like ut_foreign_key, except the null value is also allowed.
1451 sub ut_foreign_keyn {
1452 my( $self, $field, $table, $foreign ) = @_;
1453 $self->getfield($field)
1454 ? $self->ut_foreign_key($field, $table, $foreign)
1459 =item virtual_fields [ TABLE ]
1461 Returns a list of virtual fields defined for the table. This should not
1462 be exported, and should only be called as an instance or class method.
1466 sub virtual_fields {
1469 $table = $self->table or confess "virtual_fields called on non-table";
1471 confess "Unknown table $table" unless $dbdef->table($table);
1473 return () unless $self->dbdef->table('part_virtual_field');
1475 unless ( $virtual_fields_cache{$table} ) {
1476 my $query = 'SELECT name from part_virtual_field ' .
1477 "WHERE dbtable = '$table'";
1479 my $result = $dbh->selectcol_arrayref($query);
1480 confess $dbh->errstr if $dbh->err;
1481 $virtual_fields_cache{$table} = $result;
1484 @{$virtual_fields_cache{$table}};
1489 =item fields [ TABLE ]
1491 This is a wrapper for real_fields and virtual_fields. Code that called
1492 fields before should probably continue to call fields.
1497 my $something = shift;
1499 if($something->isa('FS::Record')) {
1500 $table = $something->table;
1502 $table = $something;
1503 $something = "FS::$table";
1505 return (real_fields($table), $something->virtual_fields());
1510 =item pvf FIELD_NAME
1512 Returns the FS::part_virtual_field object corresponding to a field in the
1513 record (specified by FIELD_NAME).
1518 my ($self, $name) = (shift, shift);
1520 if(grep /^$name$/, $self->virtual_fields) {
1521 return qsearchs('part_virtual_field', { dbtable => $self->table,
1531 =item real_fields [ TABLE ]
1533 Returns a list of the real columns in the specified table. Called only by
1534 fields() and other subroutines elsewhere in FS::Record.
1541 my($table_obj) = $dbdef->table($table);
1542 confess "Unknown table $table" unless $table_obj;
1543 $table_obj->columns;
1546 =item reload_dbdef([FILENAME])
1548 Load a database definition (see L<DBIx::DBSchema>), optionally from a
1549 non-default filename. This command is executed at startup unless
1550 I<$FS::Record::setup_hack> is true. Returns a DBIx::DBSchema object.
1555 my $file = shift || $dbdef_file;
1557 unless ( exists $dbdef_cache{$file} ) {
1558 warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
1559 $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
1560 or die "can't load database schema from $file";
1562 warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
1564 $dbdef = $dbdef_cache{$file};
1569 Returns the current database definition. See L<DBIx::DBSchema>.
1573 sub dbdef { $dbdef; }
1575 =item _quote VALUE, TABLE, COLUMN
1577 This is an internal function used to construct SQL statements. It returns
1578 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
1579 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
1584 my($value, $table, $column) = @_;
1585 my $column_obj = $dbdef->table($table)->column($column);
1586 my $column_type = $column_obj->type;
1587 my $nullable = $column_obj->null;
1589 warn " $table.$column: $value ($column_type".
1590 ( $nullable ? ' NULL' : ' NOT NULL' ).
1591 ")\n" if $DEBUG > 2;
1593 if ( $value eq '' && $column_type =~ /^int/ ) {
1597 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
1601 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
1602 ! $column_type =~ /(char|binary|text)$/i ) {
1609 =item vfieldpart_hashref TABLE
1611 Returns a hashref of virtual field names and vfieldparts applicable to the given
1616 sub vfieldpart_hashref {
1618 my $table = $self->table;
1620 return {} unless $self->dbdef->table('part_virtual_field');
1623 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
1624 "dbtable = '$table'";
1625 my $sth = $dbh->prepare($statement);
1626 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
1627 return { map { $_->{name}, $_->{vfieldpart} }
1628 @{$sth->fetchall_arrayref({})} };
1635 This is deprecated. Don't use it.
1637 It returns a hash-type list with the fields of this record's table set true.
1642 carp "warning: hfields is deprecated";
1645 foreach (fields($table)) {
1654 "$_: ". $self->getfield($_). "|"
1655 } (fields($self->table)) );
1658 sub DESTROY { return; }
1662 # #use Carp qw(cluck);
1663 # #cluck "DESTROYING $self";
1664 # warn "DESTROYING $self";
1668 # return ! eval { join('',@_), kill 0; 1; };
1675 This module should probably be renamed, since much of the functionality is
1676 of general use. It is not completely unlike Adapter::DBI (see below).
1678 Exported qsearch and qsearchs should be deprecated in favor of method calls
1679 (against an FS::Record object like the old search and searchs that qsearch
1680 and qsearchs were on top of.)
1682 The whole fields / hfields mess should be removed.
1684 The various WHERE clauses should be subroutined.
1686 table string should be deprecated in favor of DBIx::DBSchema::Table.
1688 No doubt we could benefit from a Tied hash. Documenting how exists / defined
1689 true maps to the database (and WHERE clauses) would also help.
1691 The ut_ methods should ask the dbdef for a default length.
1693 ut_sqltype (like ut_varchar) should all be defined
1695 A fallback check method should be provided which uses the dbdef.
1697 The ut_money method assumes money has two decimal digits.
1699 The Pg money kludge in the new method only strips `$'.
1701 The ut_phonen method only checks US-style phone numbers.
1703 The _quote function should probably use ut_float instead of a regex.
1705 All the subroutines probably should be methods, here or elsewhere.
1707 Probably should borrow/use some dbdef methods where appropriate (like sub
1710 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
1711 or allow it to be set. Working around it is ugly any way around - DBI should
1712 be fixed. (only affects RDBMS which return uppercase column names)
1714 ut_zip should take an optional country like ut_phone.
1718 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
1720 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.