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 my $hashref = $self->{'Hash'} = shift;
137 foreach my $field ( grep !defined($hashref->{$_}), $self->fields ) {
138 $hashref->{$field}='';
141 $self->_cache($hashref, shift) if $self->can('_cache') && @_;
148 my $class = ref($proto) || $proto;
150 bless ($self, $class);
152 $self->{'Table'} = shift unless defined ( $self->table );
154 my $hashref = $self->{'Hash'} = shift;
156 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
157 my $obj = $cache->cache->{$hashref->{$cache->key}};
158 $obj->_cache($hashref, $cache) if $obj->can('_cache');
161 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
168 my $class = ref($proto) || $proto;
170 bless ($self, $class);
171 if ( defined $self->table ) {
172 cluck "create constructor is deprecated, use new!";
175 croak "FS::Record::create called (not from a subclass)!";
179 =item qsearch TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ
181 Searches the database for all records matching (at least) the key/value pairs
182 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
183 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
186 ###oops, argh, FS::Record::new only lets us create database fields.
187 #Normal behaviour if SELECT is not specified is `*', as in
188 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
189 #feature where you can specify SELECT - remember, the objects returned,
190 #although blessed into the appropriate `FS::TABLE' package, will only have the
191 #fields you specify. This might have unwanted results if you then go calling
192 #regular FS::TABLE methods
198 my($stable, $record, $select, $extra_sql, $cache ) = @_;
199 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
201 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
206 my $table = $cache ? $cache->table : $stable;
207 my $dbdef_table = $dbdef->table($table)
208 or die "No schema for table $table found - ".
209 "do you need to create it or run dbdef-create?";
210 my $pkey = $dbdef_table->primary_key;
212 my @real_fields = grep exists($record->{$_}), real_fields($table);
213 my @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
215 my $statement = "SELECT $select FROM $stable";
216 if ( @real_fields or @virtual_fields ) {
217 $statement .= ' WHERE '. join(' AND ',
222 if ( ref($record->{$_}) ) {
223 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
224 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
225 if ( uc($op) eq 'ILIKE' ) {
227 $record->{$_}{'value'} = lc($record->{$_}{'value'});
228 $column = "LOWER($_)";
230 $record->{$_} = $record->{$_}{'value'}
233 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
235 if ( driver_name eq 'Pg' ) {
236 my $type = $dbdef->table($table)->column($column)->type;
237 if ( $type =~ /(int|serial)/i ) {
238 qq-( $column IS NULL )-;
240 qq-( $column IS NULL OR $column = '' )-;
243 qq-( $column IS NULL OR $column = "" )-;
245 } elsif ( $op 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 NOT NULL )-;
251 qq-( $column IS NOT NULL AND $column != '' )-;
254 qq-( $column IS NOT NULL AND $column != "" )-;
257 if ( driver_name eq 'Pg' ) {
258 qq-( $column $op '' )-;
260 qq-( $column $op "" )-;
270 if ( ref($record->{$_}) ) {
271 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
272 if ( uc($op) eq 'ILIKE' ) {
274 $record->{$_}{'value'} = lc($record->{$_}{'value'});
275 $column = "LOWER($_)";
277 $record->{$_} = $record->{$_}{'value'};
280 # ... EXISTS ( SELECT name, value FROM part_virtual_field
282 # ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
283 # WHERE recnum = svc_acct.svcnum
284 # AND (name, value) = ('egad', 'brain') )
286 my $value = $record->{$_};
290 $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
291 "( SELECT part_virtual_field.name, virtual_field.value ".
292 "FROM part_virtual_field JOIN virtual_field ".
293 "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
294 "WHERE virtual_field.recnum = ${table}.${pkey} ".
295 "AND part_virtual_field.name = '${column}'".
297 " AND virtual_field.value ${op} '${value}'"
301 } @virtual_fields ) );
305 $statement .= " $extra_sql" if defined($extra_sql);
307 warn "[debug]$me $statement\n" if $DEBUG > 1;
308 my $sth = $dbh->prepare($statement)
309 or croak "$dbh->errstr doing $statement";
314 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
316 if ( $record->{$field} =~ /^\d+(\.\d+)?$/
317 && $dbdef->table($table)->column($field)->type =~ /(int|serial)/i
319 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_INTEGER } );
321 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_VARCHAR } );
325 # $sth->execute( map $record->{$_},
326 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
327 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
329 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
332 tie %result, "Tie::IxHash";
333 @virtual_fields = "FS::$table"->virtual_fields;
335 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
337 %result = map { $_->{$pkey}, $_ } @stuff;
339 @result{@stuff} = @stuff;
343 if ( keys(%result) and @virtual_fields ) {
345 "SELECT virtual_field.recnum, part_virtual_field.name, ".
346 "virtual_field.value ".
347 "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
348 "WHERE part_virtual_field.dbtable = '$table' AND ".
349 "virtual_field.recnum IN (".
350 join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
351 join(q!', '!, @virtual_fields) . "')";
352 warn "[debug]$me $statement\n" if $DEBUG > 1;
353 $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
354 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
356 foreach (@{ $sth->fetchall_arrayref({}) }) {
357 my $recnum = $_->{recnum};
358 my $name = $_->{name};
359 my $value = $_->{value};
360 if (exists($result{$recnum})) {
361 $result{$recnum}->{$name} = $value;
366 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
367 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
368 #derivied class didn't override new method, so this optimization is safe
371 new_or_cached( "FS::$table", { %{$_} }, $cache )
375 new( "FS::$table", { %{$_} } )
379 warn "untested code (class FS::$table uses custom new method)";
381 eval 'FS::'. $table. '->new( { %{$_} } )';
385 cluck "warning: FS::$table not loaded; returning FS::Record objects";
387 FS::Record->new( $table, { %{$_} } );
393 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
395 Experimental JOINed search method. Using this method, you can execute a
396 single SELECT spanning multiple tables, and cache the results for subsequent
397 method calls. Interface will almost definately change in an incompatible
405 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
406 my $cache = FS::SearchCache->new( $ptable, $pkey );
409 grep { !$saw{$_->getfield($pkey)}++ }
410 qsearch($table, $record, $select, $extra_sql, $cache )
414 =item qsearchs TABLE, HASHREF
416 Same as qsearch, except that if more than one record matches, it B<carp>s but
417 returns the first. If this happens, you either made a logic error in asking
418 for a single item, or your data is corrupted.
422 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
424 my(@result) = qsearch(@_);
425 carp "warning: Multiple records in scalar search ($table)"
426 if scalar(@result) > 1;
427 #should warn more vehemently if the search was on a primary key?
428 scalar(@result) ? ($result[0]) : ();
439 Returns the table name.
444 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
451 Returns the DBIx::DBSchema::Table object for the table.
457 my($table)=$self->table;
458 $dbdef->table($table);
461 =item get, getfield COLUMN
463 Returns the value of the column/field/key COLUMN.
468 my($self,$field) = @_;
469 # to avoid "Use of unitialized value" errors
470 if ( defined ( $self->{Hash}->{$field} ) ) {
471 $self->{Hash}->{$field};
481 =item set, setfield COLUMN, VALUE
483 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
488 my($self,$field,$value) = @_;
489 $self->{'Hash'}->{$field} = $value;
496 =item AUTLOADED METHODS
498 $record->column is a synonym for $record->get('column');
500 $record->column('value') is a synonym for $record->set('column','value');
507 my($field)=$AUTOLOAD;
509 if ( defined($value) ) {
510 confess "errant AUTOLOAD $field for $self (arg $value)"
511 unless ref($self) && $self->can('setfield');
512 $self->setfield($field,$value);
514 confess "errant AUTOLOAD $field for $self (no args)"
515 unless ref($self) && $self->can('getfield');
516 $self->getfield($field);
522 # my $field = $AUTOLOAD;
524 # if ( defined($_[1]) ) {
525 # $_[0]->setfield($field, $_[1]);
527 # $_[0]->getfield($field);
533 Returns a list of the column/value pairs, usually for assigning to a new hash.
535 To make a distinct duplicate of an FS::Record object, you can do:
537 $new = new FS::Record ( $old->table, { $old->hash } );
543 confess $self. ' -> hash: Hash attribute is undefined'
544 unless defined($self->{'Hash'});
545 %{ $self->{'Hash'} };
550 Returns a reference to the column/value hash.
561 Inserts this record to the database. If there is an error, returns the error,
562 otherwise returns false.
569 my $error = $self->check;
570 return $error if $error;
572 #single-field unique keys are given a value if false
573 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
574 foreach ( $self->dbdef_table->unique->singles ) {
575 $self->unique($_) unless $self->getfield($_);
578 #and also the primary key, if the database isn't going to
579 my $primary_key = $self->dbdef_table->primary_key;
581 if ( $primary_key ) {
582 my $col = $self->dbdef_table->column($primary_key);
585 uc($col->type) eq 'SERIAL'
586 || ( driver_name eq 'Pg'
587 && defined($col->default)
588 && $col->default =~ /^nextval\(/i
590 || ( driver_name eq 'mysql'
591 && defined($col->local)
592 && $col->local =~ /AUTO_INCREMENT/i
594 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
597 my $table = $self->table;
598 #false laziness w/delete
600 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
603 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
606 my $statement = "INSERT INTO $table ( ".
607 join( ', ', @real_fields ).
609 join( ', ', @values ).
612 warn "[debug]$me $statement\n" if $DEBUG > 1;
613 my $sth = dbh->prepare($statement) or return dbh->errstr;
615 local $SIG{HUP} = 'IGNORE';
616 local $SIG{INT} = 'IGNORE';
617 local $SIG{QUIT} = 'IGNORE';
618 local $SIG{TERM} = 'IGNORE';
619 local $SIG{TSTP} = 'IGNORE';
620 local $SIG{PIPE} = 'IGNORE';
622 $sth->execute or return $sth->errstr;
625 if ( $db_seq ) { # get inserted id from the database, if applicable
626 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
627 if ( driver_name eq 'Pg' ) {
629 my $oid = $sth->{'pg_oid_status'};
630 my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
631 my $i_sth = dbh->prepare($i_sql) or do {
632 dbh->rollback if $FS::UID::AutoCommit;
635 $i_sth->execute($oid) or do {
636 dbh->rollback if $FS::UID::AutoCommit;
637 return $i_sth->errstr;
639 $insertid = $i_sth->fetchrow_arrayref->[0];
641 } elsif ( driver_name eq 'mysql' ) {
643 $insertid = dbh->{'mysql_insertid'};
644 # work around mysql_insertid being null some of the time, ala RT :/
645 unless ( $insertid ) {
646 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
647 "using SELECT LAST_INSERT_ID();";
648 my $i_sql = "SELECT LAST_INSERT_ID()";
649 my $i_sth = dbh->prepare($i_sql) or do {
650 dbh->rollback if $FS::UID::AutoCommit;
653 $i_sth->execute or do {
654 dbh->rollback if $FS::UID::AutoCommit;
655 return $i_sth->errstr;
657 $insertid = $i_sth->fetchrow_arrayref->[0];
661 dbh->rollback if $FS::UID::AutoCommit;
662 return "don't know how to retreive inserted ids from ". driver_name.
663 ", try using counterfiles (maybe run dbdef-create?)";
665 $self->setfield($primary_key, $insertid);
669 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
670 $self->virtual_fields;
671 if (@virtual_fields) {
672 my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
674 my $vfieldpart = $self->vfieldpart_hashref;
676 my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
679 my $v_sth = dbh->prepare($v_statement) or do {
680 dbh->rollback if $FS::UID::AutoCommit;
684 foreach (keys(%v_values)) {
685 $v_sth->execute($self->getfield($primary_key),
689 dbh->rollback if $FS::UID::AutoCommit;
690 return $v_sth->errstr;
697 if ( defined $dbdef->table('h_'. $table) ) {
698 my $h_statement = $self->_h_statement('insert');
699 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
700 $h_sth = dbh->prepare($h_statement) or do {
701 dbh->rollback if $FS::UID::AutoCommit;
707 $h_sth->execute or return $h_sth->errstr if $h_sth;
709 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
716 Depriciated (use insert instead).
721 cluck "warning: FS::Record::add deprecated!";
722 insert @_; #call method in this scope
727 Delete this record from the database. If there is an error, returns the error,
728 otherwise returns false.
735 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
737 $self->getfield($_) eq ''
738 #? "( $_ IS NULL OR $_ = \"\" )"
739 ? ( driver_name eq 'Pg'
741 : "( $_ IS NULL OR $_ = \"\" )"
743 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
744 } ( $self->dbdef_table->primary_key )
745 ? ( $self->dbdef_table->primary_key)
746 : real_fields($self->table)
748 warn "[debug]$me $statement\n" if $DEBUG > 1;
749 my $sth = dbh->prepare($statement) or return dbh->errstr;
752 if ( defined $dbdef->table('h_'. $self->table) ) {
753 my $h_statement = $self->_h_statement('delete');
754 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
755 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
760 my $primary_key = $self->dbdef_table->primary_key;
763 my $vfp = $self->vfieldpart_hashref;
764 foreach($self->virtual_fields) {
765 next if $self->getfield($_) eq '';
766 unless(@del_vfields) {
767 my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
768 $v_sth = dbh->prepare($st) or return dbh->errstr;
770 push @del_vfields, $_;
773 local $SIG{HUP} = 'IGNORE';
774 local $SIG{INT} = 'IGNORE';
775 local $SIG{QUIT} = 'IGNORE';
776 local $SIG{TERM} = 'IGNORE';
777 local $SIG{TSTP} = 'IGNORE';
778 local $SIG{PIPE} = 'IGNORE';
780 my $rc = $sth->execute or return $sth->errstr;
781 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
782 $h_sth->execute or return $h_sth->errstr if $h_sth;
783 $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
784 or return $v_sth->errstr
785 foreach (@del_vfields);
787 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
789 #no need to needlessly destoy the data either (causes problems actually)
790 #undef $self; #no need to keep object!
797 Depriciated (use delete instead).
802 cluck "warning: FS::Record::del deprecated!";
803 &delete(@_); #call method in this scope
806 =item replace OLD_RECORD
808 Replace the OLD_RECORD with this one in the database. If there is an error,
809 returns the error, otherwise returns false.
820 warn "[debug]$me replace called with no arguments; autoloading old record\n"
822 my $primary_key = $new->dbdef_table->primary_key;
823 if ( $primary_key ) {
824 $old = qsearchs($new->table, { $primary_key => $new->$primary_key() } )
825 or croak "can't find ". $new->table. ".$primary_key ".
826 $new->$primary_key();
828 croak $new->table. " has no primary key; pass old record as argument";
832 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
834 return "Records not in same table!" unless $new->table eq $old->table;
836 my $primary_key = $old->dbdef_table->primary_key;
837 return "Can't change $primary_key"
839 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
841 my $error = $new->check;
842 return $error if $error;
844 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
845 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
846 ? ($_, $new->getfield($_)) : () } $old->fields;
848 unless ( keys(%diff) ) {
849 carp "[warning]$me $new -> replace $old: records identical";
853 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
855 "$_ = ". _quote($new->getfield($_),$old->table,$_)
856 } real_fields($old->table)
860 $old->getfield($_) eq ''
861 #? "( $_ IS NULL OR $_ = \"\" )"
862 ? ( driver_name eq 'Pg'
863 ? "( $_ IS NULL OR $_ = '' )"
864 : "( $_ IS NULL OR $_ = \"\" )"
866 : "$_ = ". _quote($old->getfield($_),$old->table,$_)
867 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
870 warn "[debug]$me $statement\n" if $DEBUG > 1;
871 my $sth = dbh->prepare($statement) or return dbh->errstr;
874 if ( defined $dbdef->table('h_'. $old->table) ) {
875 my $h_old_statement = $old->_h_statement('replace_old');
876 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
877 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
883 if ( defined $dbdef->table('h_'. $new->table) ) {
884 my $h_new_statement = $new->_h_statement('replace_new');
885 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
886 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
891 # For virtual fields we have three cases with different SQL
892 # statements: add, replace, delete
896 my (@add_vfields, @rep_vfields, @del_vfields);
897 my $vfp = $old->vfieldpart_hashref;
898 foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
899 if($diff{$_} eq '') {
901 unless(@del_vfields) {
902 my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
903 "AND vfieldpart = ?";
904 warn "[debug]$me $st\n" if $DEBUG > 2;
905 $v_del_sth = dbh->prepare($st) or return dbh->errstr;
907 push @del_vfields, $_;
908 } elsif($old->getfield($_) eq '') {
910 unless(@add_vfields) {
911 my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
913 warn "[debug]$me $st\n" if $DEBUG > 2;
914 $v_add_sth = dbh->prepare($st) or return dbh->errstr;
916 push @add_vfields, $_;
919 unless(@rep_vfields) {
920 my $st = "UPDATE virtual_field SET value = ? ".
921 "WHERE recnum = ? AND vfieldpart = ?";
922 warn "[debug]$me $st\n" if $DEBUG > 2;
923 $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
925 push @rep_vfields, $_;
929 local $SIG{HUP} = 'IGNORE';
930 local $SIG{INT} = 'IGNORE';
931 local $SIG{QUIT} = 'IGNORE';
932 local $SIG{TERM} = 'IGNORE';
933 local $SIG{TSTP} = 'IGNORE';
934 local $SIG{PIPE} = 'IGNORE';
936 my $rc = $sth->execute or return $sth->errstr;
937 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
938 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
939 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
941 $v_del_sth->execute($old->getfield($primary_key),
943 or return $v_del_sth->errstr
944 foreach(@del_vfields);
946 $v_add_sth->execute($new->getfield($_),
947 $old->getfield($primary_key),
949 or return $v_add_sth->errstr
950 foreach(@add_vfields);
952 $v_rep_sth->execute($new->getfield($_),
953 $old->getfield($primary_key),
955 or return $v_rep_sth->errstr
956 foreach(@rep_vfields);
958 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
966 Depriciated (use replace instead).
971 cluck "warning: FS::Record::rep deprecated!";
972 replace @_; #call method in this scope
977 Checks virtual fields (using check_blocks). Subclasses should still provide
978 a check method to validate real fields, foreign keys, etc., and call this
979 method via $self->SUPER::check.
981 (FIXME: Should this method try to make sure that it I<is> being called from
982 a subclass's check method, to keep the current semantics as far as possible?)
987 #confess "FS::Record::check not implemented; supply one in subclass!";
990 foreach my $field ($self->virtual_fields) {
991 for ($self->getfield($field)) {
992 # See notes on check_block in FS::part_virtual_field.
993 eval $self->pvf($field)->check_block;
995 #this is bad, probably want to follow the stack backtrace up and see
997 my $err = "Fatal error checking $field for $self";
999 return "$err (see log for backtrace): $@";
1002 $self->setfield($field, $_);
1009 my( $self, $action ) = @_;
1012 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
1013 real_fields($self->table);
1015 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1017 "INSERT INTO h_". $self->table. " ( ".
1018 join(', ', qw(history_date history_user history_action), @fields ).
1020 join(', ', time, dbh->quote(getotaker()), dbh->quote($action), @values).
1027 B<Warning>: External use is B<deprecated>.
1029 Replaces COLUMN in record with a unique number, using counters in the
1030 filesystem. Used by the B<insert> method on single-field unique columns
1031 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1032 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1034 Returns the new value.
1039 my($self,$field) = @_;
1040 my($table)=$self->table;
1042 croak "Unique called on field $field, but it is ",
1043 $self->getfield($field),
1045 if $self->getfield($field);
1047 #warn "table $table is tainted" if is_tainted($table);
1048 #warn "field $field is tainted" if is_tainted($field);
1050 my($counter) = new File::CounterFile "$table.$field",0;
1052 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1054 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1057 my $index = $counter->inc;
1058 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1060 $index =~ /^(\d*)$/;
1063 $self->setfield($field,$index);
1067 =item ut_float COLUMN
1069 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1070 null. If there is an error, returns the error, otherwise returns false.
1075 my($self,$field)=@_ ;
1076 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
1077 $self->getfield($field) =~ /^(\d+)$/ ||
1078 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
1079 $self->getfield($field) =~ /^(\d+e\d+)$/)
1080 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1081 $self->setfield($field,$1);
1085 =item ut_snumber COLUMN
1087 Check/untaint signed numeric data (whole numbers). May not be null. If there
1088 is an error, returns the error, otherwise returns false.
1093 my($self, $field) = @_;
1094 $self->getfield($field) =~ /^(-?)\s*(\d+)$/
1095 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1096 $self->setfield($field, "$1$2");
1100 =item ut_number COLUMN
1102 Check/untaint simple numeric data (whole numbers). May not be null. If there
1103 is an error, returns the error, otherwise returns false.
1108 my($self,$field)=@_;
1109 $self->getfield($field) =~ /^(\d+)$/
1110 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1111 $self->setfield($field,$1);
1115 =item ut_numbern COLUMN
1117 Check/untaint simple numeric data (whole numbers). May be null. If there is
1118 an error, returns the error, otherwise returns false.
1123 my($self,$field)=@_;
1124 $self->getfield($field) =~ /^(\d*)$/
1125 or return "Illegal (numeric) $field: ". $self->getfield($field);
1126 $self->setfield($field,$1);
1130 =item ut_money COLUMN
1132 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
1133 is an error, returns the error, otherwise returns false.
1138 my($self,$field)=@_;
1139 $self->setfield($field, 0) if $self->getfield($field) eq '';
1140 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
1141 or return "Illegal (money) $field: ". $self->getfield($field);
1142 #$self->setfield($field, "$1$2$3" || 0);
1143 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
1147 =item ut_text COLUMN
1149 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1150 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / =
1151 May not be null. If there is an error, returns the error, otherwise returns
1157 my($self,$field)=@_;
1158 #warn "msgcat ". \&msgcat. "\n";
1159 #warn "notexist ". \¬exist. "\n";
1160 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
1161 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]+)$/
1162 or return gettext('illegal_or_empty_text'). " $field: ".
1163 $self->getfield($field);
1164 $self->setfield($field,$1);
1168 =item ut_textn COLUMN
1170 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1171 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
1172 May be null. If there is an error, returns the error, otherwise returns false.
1177 my($self,$field)=@_;
1178 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]*)$/
1179 or return gettext('illegal_text'). " $field: ". $self->getfield($field);
1180 $self->setfield($field,$1);
1184 =item ut_alpha COLUMN
1186 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
1187 an error, returns the error, otherwise returns false.
1192 my($self,$field)=@_;
1193 $self->getfield($field) =~ /^(\w+)$/
1194 or return "Illegal or empty (alphanumeric) $field: ".
1195 $self->getfield($field);
1196 $self->setfield($field,$1);
1200 =item ut_alpha COLUMN
1202 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
1203 error, returns the error, otherwise returns false.
1208 my($self,$field)=@_;
1209 $self->getfield($field) =~ /^(\w*)$/
1210 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
1211 $self->setfield($field,$1);
1215 =item ut_phonen COLUMN [ COUNTRY ]
1217 Check/untaint phone numbers. May be null. If there is an error, returns
1218 the error, otherwise returns false.
1220 Takes an optional two-letter ISO country code; without it or with unsupported
1221 countries, ut_phonen simply calls ut_alphan.
1226 my( $self, $field, $country ) = @_;
1227 return $self->ut_alphan($field) unless defined $country;
1228 my $phonen = $self->getfield($field);
1229 if ( $phonen eq '' ) {
1230 $self->setfield($field,'');
1231 } elsif ( $country eq 'US' || $country eq 'CA' ) {
1233 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
1234 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
1235 $phonen = "$1-$2-$3";
1236 $phonen .= " x$4" if $4;
1237 $self->setfield($field,$phonen);
1239 warn "warning: don't know how to check phone numbers for country $country";
1240 return $self->ut_textn($field);
1247 Check/untaint ip addresses. IPv4 only for now.
1252 my( $self, $field ) = @_;
1253 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
1254 or return "Illegal (IP address) $field: ". $self->getfield($field);
1255 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
1256 $self->setfield($field, "$1.$2.$3.$4");
1262 Check/untaint ip addresses. IPv4 only for now. May be null.
1267 my( $self, $field ) = @_;
1268 if ( $self->getfield($field) =~ /^()$/ ) {
1269 $self->setfield($field,'');
1272 $self->ut_ip($field);
1276 =item ut_domain COLUMN
1278 Check/untaint host and domain names.
1283 my( $self, $field ) = @_;
1284 #$self->getfield($field) =~/^(\w+\.)*\w+$/
1285 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
1286 or return "Illegal (domain) $field: ". $self->getfield($field);
1287 $self->setfield($field,$1);
1291 =item ut_name COLUMN
1293 Check/untaint proper names; allows alphanumerics, spaces and the following
1294 punctuation: , . - '
1301 my( $self, $field ) = @_;
1302 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
1303 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
1304 $self->setfield($field,$1);
1310 Check/untaint zip codes.
1315 my( $self, $field, $country ) = @_;
1316 if ( $country eq 'US' ) {
1317 $self->getfield($field) =~ /\s*(\d{5}(\-\d{4})?)\s*$/
1318 or return gettext('illegal_zip'). " $field for country $country: ".
1319 $self->getfield($field);
1320 $self->setfield($field,$1);
1322 if ( $self->getfield($field) =~ /^\s*$/ ) {
1323 $self->setfield($field,'');
1325 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
1326 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
1327 $self->setfield($field,$1);
1333 =item ut_country COLUMN
1335 Check/untaint country codes. Country names are changed to codes, if possible -
1336 see L<Locale::Country>.
1341 my( $self, $field ) = @_;
1342 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
1343 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
1344 && country2code($1) ) {
1345 $self->setfield($field,uc(country2code($1)));
1348 $self->getfield($field) =~ /^(\w\w)$/
1349 or return "Illegal (country) $field: ". $self->getfield($field);
1350 $self->setfield($field,uc($1));
1354 =item ut_anything COLUMN
1356 Untaints arbitrary data. Be careful.
1361 my( $self, $field ) = @_;
1362 $self->getfield($field) =~ /^(.*)$/s
1363 or return "Illegal $field: ". $self->getfield($field);
1364 $self->setfield($field,$1);
1368 =item ut_enum COLUMN CHOICES_ARRAYREF
1370 Check/untaint a column, supplying all possible choices, like the "enum" type.
1375 my( $self, $field, $choices ) = @_;
1376 foreach my $choice ( @$choices ) {
1377 if ( $self->getfield($field) eq $choice ) {
1378 $self->setfield($choice);
1382 return "Illegal (enum) field $field: ". $self->getfield($field);
1385 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1387 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
1388 on the column first.
1392 sub ut_foreign_key {
1393 my( $self, $field, $table, $foreign ) = @_;
1394 qsearchs($table, { $foreign => $self->getfield($field) })
1395 or return "Can't find $field ". $self->getfield($field).
1396 " in $table.$foreign";
1400 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1402 Like ut_foreign_key, except the null value is also allowed.
1406 sub ut_foreign_keyn {
1407 my( $self, $field, $table, $foreign ) = @_;
1408 $self->getfield($field)
1409 ? $self->ut_foreign_key($field, $table, $foreign)
1414 =item virtual_fields [ TABLE ]
1416 Returns a list of virtual fields defined for the table. This should not
1417 be exported, and should only be called as an instance or class method.
1421 sub virtual_fields {
1424 $table = $self->table or confess "virtual_fields called on non-table";
1426 confess "Unknown table $table" unless $dbdef->table($table);
1428 return () unless $self->dbdef->table('part_virtual_field');
1430 unless ( $virtual_fields_cache{$table} ) {
1431 my $query = 'SELECT name from part_virtual_field ' .
1432 "WHERE dbtable = '$table'";
1434 my $result = $dbh->selectcol_arrayref($query);
1435 confess $dbh->errstr if $dbh->err;
1436 $virtual_fields_cache{$table} = $result;
1439 @{$virtual_fields_cache{$table}};
1444 =item fields [ TABLE ]
1446 This is a wrapper for real_fields and virtual_fields. Code that called
1447 fields before should probably continue to call fields.
1452 my $something = shift;
1454 if($something->isa('FS::Record')) {
1455 $table = $something->table;
1457 $table = $something;
1458 $something = "FS::$table";
1460 return (real_fields($table), $something->virtual_fields());
1465 =item pvf FIELD_NAME
1467 Returns the FS::part_virtual_field object corresponding to a field in the
1468 record (specified by FIELD_NAME).
1473 my ($self, $name) = (shift, shift);
1475 if(grep /^$name$/, $self->virtual_fields) {
1476 return qsearchs('part_virtual_field', { dbtable => $self->table,
1486 =item real_fields [ TABLE ]
1488 Returns a list of the real columns in the specified table. Called only by
1489 fields() and other subroutines elsewhere in FS::Record.
1496 my($table_obj) = $dbdef->table($table);
1497 confess "Unknown table $table" unless $table_obj;
1498 $table_obj->columns;
1501 =item reload_dbdef([FILENAME])
1503 Load a database definition (see L<DBIx::DBSchema>), optionally from a
1504 non-default filename. This command is executed at startup unless
1505 I<$FS::Record::setup_hack> is true. Returns a DBIx::DBSchema object.
1510 my $file = shift || $dbdef_file;
1512 unless ( exists $dbdef_cache{$file} ) {
1513 warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
1514 $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
1515 or die "can't load database schema from $file";
1517 warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
1519 $dbdef = $dbdef_cache{$file};
1524 Returns the current database definition. See L<DBIx::DBSchema>.
1528 sub dbdef { $dbdef; }
1530 =item _quote VALUE, TABLE, COLUMN
1532 This is an internal function used to construct SQL statements. It returns
1533 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
1534 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
1539 my($value, $table, $column) = @_;
1540 my $column_obj = $dbdef->table($table)->column($column);
1541 my $column_type = $column_obj->type;
1543 if ( $value eq '' && $column_type =~ /^int/ ) {
1544 if ( $column_obj->null ) {
1547 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
1551 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
1552 ! $column_type =~ /(char|binary|text)$/i ) {
1559 =item vfieldpart_hashref TABLE
1561 Returns a hashref of virtual field names and vfieldparts applicable to the given
1566 sub vfieldpart_hashref {
1568 my $table = $self->table;
1570 return {} unless $self->dbdef->table('part_virtual_field');
1573 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
1574 "dbtable = '$table'";
1575 my $sth = $dbh->prepare($statement);
1576 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
1577 return { map { $_->{name}, $_->{vfieldpart} }
1578 @{$sth->fetchall_arrayref({})} };
1585 This is deprecated. Don't use it.
1587 It returns a hash-type list with the fields of this record's table set true.
1592 carp "warning: hfields is deprecated";
1595 foreach (fields($table)) {
1604 "$_: ". $self->getfield($_). "|"
1605 } (fields($self->table)) );
1608 sub DESTROY { return; }
1612 # #use Carp qw(cluck);
1613 # #cluck "DESTROYING $self";
1614 # warn "DESTROYING $self";
1618 # return ! eval { join('',@_), kill 0; 1; };
1625 This module should probably be renamed, since much of the functionality is
1626 of general use. It is not completely unlike Adapter::DBI (see below).
1628 Exported qsearch and qsearchs should be deprecated in favor of method calls
1629 (against an FS::Record object like the old search and searchs that qsearch
1630 and qsearchs were on top of.)
1632 The whole fields / hfields mess should be removed.
1634 The various WHERE clauses should be subroutined.
1636 table string should be deprecated in favor of DBIx::DBSchema::Table.
1638 No doubt we could benefit from a Tied hash. Documenting how exists / defined
1639 true maps to the database (and WHERE clauses) would also help.
1641 The ut_ methods should ask the dbdef for a default length.
1643 ut_sqltype (like ut_varchar) should all be defined
1645 A fallback check method should be provided which uses the dbdef.
1647 The ut_money method assumes money has two decimal digits.
1649 The Pg money kludge in the new method only strips `$'.
1651 The ut_phonen method only checks US-style phone numbers.
1653 The _quote function should probably use ut_float instead of a regex.
1655 All the subroutines probably should be methods, here or elsewhere.
1657 Probably should borrow/use some dbdef methods where appropriate (like sub
1660 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
1661 or allow it to be set. Working around it is ugly any way around - DBI should
1662 be fixed. (only affects RDBMS which return uppercase column names)
1664 ut_zip should take an optional country like ut_phone.
1668 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
1670 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.