4 use vars qw( $dbdef_file $dbdef $setup_hack $AUTOLOAD @ISA @EXPORT_OK $DEBUG
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.19;
13 use FS::UID qw(dbh checkruid getotaker datasrc driver_name);
17 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef jsearch);
22 #ask FS::UID to run this stuff for us later
23 $FS::UID::callback{'FS::Record'} = sub {
24 $File::CounterFile::DEFAULT_DIR = "/usr/local/etc/freeside/counters.". datasrc;
25 $dbdef_file = "/usr/local/etc/freeside/dbdef.". datasrc;
26 &reload_dbdef unless $setup_hack; #$setup_hack needed now?
31 FS::Record - Database record objects
36 use FS::Record qw(dbh fields qsearch qsearchs dbdef);
38 $record = new FS::Record 'table', \%hash;
39 $record = new FS::Record 'table', { 'column' => 'value', ... };
41 $record = qsearchs FS::Record 'table', \%hash;
42 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
43 @records = qsearch FS::Record 'table', \%hash;
44 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
46 $table = $record->table;
47 $dbdef_table = $record->dbdef_table;
49 $value = $record->get('column');
50 $value = $record->getfield('column');
51 $value = $record->column;
53 $record->set( 'column' => 'value' );
54 $record->setfield( 'column' => 'value' );
55 $record->column('value');
57 %hash = $record->hash;
59 $hashref = $record->hashref;
61 $error = $record->insert;
62 #$error = $record->add; #deprecated
64 $error = $record->delete;
65 #$error = $record->del; #deprecated
67 $error = $new_record->replace($old_record);
68 #$error = $new_record->rep($old_record); #deprecated
70 $value = $record->unique('column');
72 $error = $record->ut_float('column');
73 $error = $record->ut_number('column');
74 $error = $record->ut_numbern('column');
75 $error = $record->ut_money('column');
76 $error = $record->ut_text('column');
77 $error = $record->ut_textn('column');
78 $error = $record->ut_alpha('column');
79 $error = $record->ut_alphan('column');
80 $error = $record->ut_phonen('column');
81 $error = $record->ut_anything('column');
82 $error = $record->ut_name('column');
84 $dbdef = reload_dbdef;
85 $dbdef = reload_dbdef "/non/standard/filename";
88 $quoted_value = _quote($value,'table','field');
91 $fields = hfields('table');
92 if ( $fields->{Field} ) { # etc.
94 @fields = fields 'table'; #as a subroutine
95 @fields = $record->fields; #as a method call
100 (Mostly) object-oriented interface to database records. Records are currently
101 implemented on top of DBI. FS::Record is intended as a base class for
102 table-specific classes to inherit from, i.e. FS::cust_main.
108 =item new [ TABLE, ] HASHREF
110 Creates a new record. It doesn't store it in the database, though. See
111 L<"insert"> for that.
113 Note that the object stores this hash reference, not a distinct copy of the
114 hash it points to. You can ask the object for a copy with the I<hash>
117 TABLE can only be omitted when a dervived class overrides the table method.
123 my $class = ref($proto) || $proto;
125 bless ($self, $class);
127 unless ( defined ( $self->table ) ) {
128 $self->{'Table'} = shift;
129 carp "warning: FS::Record::new called with table name ". $self->{'Table'};
132 my $hashref = $self->{'Hash'} = shift;
134 foreach my $field ( $self->fields ) {
135 $hashref->{$field}='' unless defined $hashref->{$field};
136 #trim the '$' and ',' from money fields for Pg (belong HERE?)
137 #(what about Pg i18n?)
138 if ( driver_name =~ /^Pg$/i
139 && $self->dbdef_table->column($field)->type eq 'money' ) {
140 ${$hashref}{$field} =~ s/^\$//;
141 ${$hashref}{$field} =~ s/\,//;
145 $self->_cache($hashref, 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 depriciated, use new!";
179 croak "FS::Record::create called (not from a subclass)!";
183 =item qsearch TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ
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 ) = @_;
203 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
205 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
210 my $table = $cache ? $cache->table : $stable;
212 my @fields = grep exists($record->{$_}), fields($table);
214 my $statement = "SELECT $select FROM $stable";
216 $statement .= ' WHERE '. join(' AND ', map {
219 if ( ref($record->{$_}) ) {
220 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
221 $op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name !~ /^Pg$/i;
222 $record->{$_} = $record->{$_}{'value'}
225 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
226 if ( driver_name =~ /^Pg$/i ) {
227 qq-( $_ IS NULL OR $_ = '' )-;
229 qq-( $_ IS NULL OR $_ = "" )-;
236 $statement .= " $extra_sql" if defined($extra_sql);
238 warn "[debug]$me $statement\n" if $DEBUG;
239 my $sth = $dbh->prepare($statement)
240 or croak "$dbh->errstr doing $statement";
245 grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
247 if ( $record->{$field} =~ /^\d+(\.\d+)?$/
248 && $dbdef->table($table)->column($field)->type =~ /(int)/i
250 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_INTEGER } );
252 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_VARCHAR } );
256 # $sth->execute( map $record->{$_},
257 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
258 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
260 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
262 $dbh->commit or croak $dbh->errstr if $FS::UID::AutoCommit;
264 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
265 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
266 #derivied class didn't override new method, so this optimization is safe
269 new_or_cached( "FS::$table", { %{$_} }, $cache )
270 } @{$sth->fetchall_arrayref( {} )};
273 new( "FS::$table", { %{$_} } )
274 } @{$sth->fetchall_arrayref( {} )};
277 warn "untested code (class FS::$table uses custom new method)";
279 eval 'FS::'. $table. '->new( { %{$_} } )';
280 } @{$sth->fetchall_arrayref( {} )};
283 cluck "warning: FS::$table not loaded; returning FS::Record objects";
285 FS::Record->new( $table, { %{$_} } );
286 } @{$sth->fetchall_arrayref( {} )};
291 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
293 Experimental JOINed search method. Using this method, you can execute a
294 single SELECT spanning multiple tables, and cache the results for subsequent
295 method calls. Interface will almost definately change in an incompatible
303 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
304 my $cache = FS::SearchCache->new( $ptable, $pkey );
307 grep { !$saw{$_->getfield($pkey)}++ }
308 qsearch($table, $record, $select, $extra_sql, $cache )
312 =item qsearchs TABLE, HASHREF
314 Same as qsearch, except that if more than one record matches, it B<carp>s but
315 returns the first. If this happens, you either made a logic error in asking
316 for a single item, or your data is corrupted.
320 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
321 my(@result) = qsearch(@_);
322 carp "warning: Multiple records in scalar search!" if scalar(@result) > 1;
323 #should warn more vehemently if the search was on a primary key?
324 scalar(@result) ? ($result[0]) : ();
335 Returns the table name.
340 # cluck "warning: FS::Record::table depriciated; supply one in subclass!";
347 Returns the FS::dbdef_table object for the table.
353 my($table)=$self->table;
354 $dbdef->table($table);
357 =item get, getfield COLUMN
359 Returns the value of the column/field/key COLUMN.
364 my($self,$field) = @_;
365 # to avoid "Use of unitialized value" errors
366 if ( defined ( $self->{Hash}->{$field} ) ) {
367 $self->{Hash}->{$field};
377 =item set, setfield COLUMN, VALUE
379 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
384 my($self,$field,$value) = @_;
385 $self->{'Hash'}->{$field} = $value;
392 =item AUTLOADED METHODS
394 $record->column is a synonym for $record->get('column');
396 $record->column('value') is a synonym for $record->set('column','value');
402 # my($self,$value)=@_;
403 # my($field)=$AUTOLOAD;
405 # if ( defined($value) ) {
406 # confess "errant AUTOLOAD $field for $self (arg $value)"
407 # unless $self->can('setfield');
408 # $self->setfield($field,$value);
410 # confess "errant AUTOLOAD $field for $self (no args)"
411 # unless $self->can('getfield');
412 # $self->getfield($field);
418 my $field = $AUTOLOAD;
420 if ( defined($_[1]) ) {
421 $_[0]->setfield($field, $_[1]);
423 $_[0]->getfield($field);
429 Returns a list of the column/value pairs, usually for assigning to a new hash.
431 To make a distinct duplicate of an FS::Record object, you can do:
433 $new = new FS::Record ( $old->table, { $old->hash } );
439 %{ $self->{'Hash'} };
444 Returns a reference to the column/value hash.
455 Inserts this record to the database. If there is an error, returns the error,
456 otherwise returns false.
463 my $error = $self->check;
464 return $error if $error;
466 #single-field unique keys are given a value if false
467 #(like MySQL's AUTO_INCREMENT)
468 foreach ( $self->dbdef_table->unique->singles ) {
469 $self->unique($_) unless $self->getfield($_);
471 #and also the primary key
472 my $primary_key = $self->dbdef_table->primary_key;
473 $self->unique($primary_key)
474 if $primary_key && ! $self->getfield($primary_key);
477 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
481 my $statement = "INSERT INTO ". $self->table. " ( ".
484 join(', ',map(_quote($self->getfield($_),$self->table,$_), @fields)).
487 warn "[debug]$me $statement\n" if $DEBUG;
488 my $sth = dbh->prepare($statement) or return dbh->errstr;
490 local $SIG{HUP} = 'IGNORE';
491 local $SIG{INT} = 'IGNORE';
492 local $SIG{QUIT} = 'IGNORE';
493 local $SIG{TERM} = 'IGNORE';
494 local $SIG{TSTP} = 'IGNORE';
495 local $SIG{PIPE} = 'IGNORE';
497 $sth->execute or return $sth->errstr;
498 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
505 Depriciated (use insert instead).
510 cluck "warning: FS::Record::add depriciated!";
511 insert @_; #call method in this scope
516 Delete this record from the database. If there is an error, returns the error,
517 otherwise returns false.
524 my($statement)="DELETE FROM ". $self->table. " WHERE ". join(' AND ',
526 $self->getfield($_) eq ''
527 #? "( $_ IS NULL OR $_ = \"\" )"
528 ? ( driver_name =~ /^Pg$/i
530 : "( $_ IS NULL OR $_ = \"\" )"
532 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
533 } ( $self->dbdef_table->primary_key )
534 ? ( $self->dbdef_table->primary_key)
537 warn "[debug]$me $statement\n" if $DEBUG;
538 my $sth = dbh->prepare($statement) or return dbh->errstr;
540 local $SIG{HUP} = 'IGNORE';
541 local $SIG{INT} = 'IGNORE';
542 local $SIG{QUIT} = 'IGNORE';
543 local $SIG{TERM} = 'IGNORE';
544 local $SIG{TSTP} = 'IGNORE';
545 local $SIG{PIPE} = 'IGNORE';
547 my $rc = $sth->execute or return $sth->errstr;
548 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
549 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
551 undef $self; #no need to keep object!
558 Depriciated (use delete instead).
563 cluck "warning: FS::Record::del depriciated!";
564 &delete(@_); #call method in this scope
567 =item replace OLD_RECORD
569 Replace the OLD_RECORD with this one in the database. If there is an error,
570 returns the error, otherwise returns false.
575 my ( $new, $old ) = ( shift, shift );
576 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
578 my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
580 carp "[warning]$me $new -> replace $old: records identical";
584 return "Records not in same table!" unless $new->table eq $old->table;
586 my $primary_key = $old->dbdef_table->primary_key;
587 return "Can't change $primary_key"
589 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
591 my $error = $new->check;
592 return $error if $error;
594 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
596 "$_ = ". _quote($new->getfield($_),$old->table,$_)
601 $old->getfield($_) eq ''
602 #? "( $_ IS NULL OR $_ = \"\" )"
603 ? ( driver_name =~ /^Pg$/i
605 : "( $_ IS NULL OR $_ = \"\" )"
607 : "$_ = ". _quote($old->getfield($_),$old->table,$_)
608 } ( $primary_key ? ( $primary_key ) : $old->fields )
611 warn "[debug]$me $statement\n" if $DEBUG;
612 my $sth = dbh->prepare($statement) or return dbh->errstr;
614 local $SIG{HUP} = 'IGNORE';
615 local $SIG{INT} = 'IGNORE';
616 local $SIG{QUIT} = 'IGNORE';
617 local $SIG{TERM} = 'IGNORE';
618 local $SIG{TSTP} = 'IGNORE';
619 local $SIG{PIPE} = 'IGNORE';
621 my $rc = $sth->execute or return $sth->errstr;
622 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
623 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
631 Depriciated (use replace instead).
636 cluck "warning: FS::Record::rep depriciated!";
637 replace @_; #call method in this scope
642 Not yet implemented, croaks. Derived classes should provide a check method.
647 confess "FS::Record::check not implemented; supply one in subclass!";
652 Replaces COLUMN in record with a unique number. Called by the B<add> method
653 on primary keys and single-field unique columns (see L<DBIx::DBSchema::Table>).
654 Returns the new value.
659 my($self,$field) = @_;
660 my($table)=$self->table;
662 croak("&FS::UID::checkruid failed") unless &checkruid;
664 croak "Unique called on field $field, but it is ",
665 $self->getfield($field),
667 if $self->getfield($field);
669 #warn "table $table is tainted" if is_tainted($table);
670 #warn "field $field is tainted" if is_tainted($field);
672 my($counter) = new File::CounterFile "$table.$field",0;
674 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
676 # my($counter) = new File::CounterFile "$user/$table.$field",0;
679 my($index)=$counter->inc;
681 while qsearchs($table,{$field=>$index}); #just in case
686 $self->setfield($field,$index);
690 =item ut_float COLUMN
692 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
693 null. If there is an error, returns the error, otherwise returns false.
698 my($self,$field)=@_ ;
699 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
700 $self->getfield($field) =~ /^(\d+)$/ ||
701 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
702 $self->getfield($field) =~ /^(\d+e\d+)$/)
703 or return "Illegal or empty (float) $field: ". $self->getfield($field);
704 $self->setfield($field,$1);
708 =item ut_number COLUMN
710 Check/untaint simple numeric data (whole numbers). May not be null. If there
711 is an error, returns the error, otherwise returns false.
717 $self->getfield($field) =~ /^(\d+)$/
718 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
719 $self->setfield($field,$1);
723 =item ut_numbern COLUMN
725 Check/untaint simple numeric data (whole numbers). May be null. If there is
726 an error, returns the error, otherwise returns false.
732 $self->getfield($field) =~ /^(\d*)$/
733 or return "Illegal (numeric) $field: ". $self->getfield($field);
734 $self->setfield($field,$1);
738 =item ut_money COLUMN
740 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
741 is an error, returns the error, otherwise returns false.
747 $self->setfield($field, 0) if $self->getfield($field) eq '';
748 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
749 or return "Illegal (money) $field: ". $self->getfield($field);
750 #$self->setfield($field, "$1$2$3" || 0);
751 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
757 Check/untaint text. Alphanumerics, spaces, and the following punctuation
758 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
759 May not be null. If there is an error, returns the error, otherwise returns
766 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]+)$/
767 or return "Illegal or empty (text) $field: ". $self->getfield($field);
768 $self->setfield($field,$1);
772 =item ut_textn COLUMN
774 Check/untaint text. Alphanumerics, spaces, and the following punctuation
775 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
776 May be null. If there is an error, returns the error, otherwise returns false.
782 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]*)$/
783 or return "Illegal (text) $field: ". $self->getfield($field);
784 $self->setfield($field,$1);
788 =item ut_alpha COLUMN
790 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
791 an error, returns the error, otherwise returns false.
797 $self->getfield($field) =~ /^(\w+)$/
798 or return "Illegal or empty (alphanumeric) $field: ".
799 $self->getfield($field);
800 $self->setfield($field,$1);
804 =item ut_alpha COLUMN
806 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
807 error, returns the error, otherwise returns false.
813 $self->getfield($field) =~ /^(\w*)$/
814 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
815 $self->setfield($field,$1);
819 =item ut_phonen COLUMN [ COUNTRY ]
821 Check/untaint phone numbers. May be null. If there is an error, returns
822 the error, otherwise returns false.
824 Takes an optional two-letter ISO country code; without it or with unsupported
825 countries, ut_phonen simply calls ut_alphan.
830 my( $self, $field, $country ) = @_;
831 return $self->ut_alphan($field) unless defined $country;
832 my $phonen = $self->getfield($field);
833 if ( $phonen eq '' ) {
834 $self->setfield($field,'');
835 } elsif ( $country eq 'US' || $country eq 'CA' ) {
837 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
838 or return "Illegal (phone) $field: ". $self->getfield($field);
839 $phonen = "$1-$2-$3";
840 $phonen .= " x$4" if $4;
841 $self->setfield($field,$phonen);
843 warn "warning: don't know how to check phone numbers for country $country";
844 return $self->ut_textn($field);
851 Check/untaint ip addresses. IPv4 only for now.
856 my( $self, $field ) = @_;
857 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
858 or return "Illegal (IP address) $field: ". $self->getfield($field);
859 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
860 $self->setfield($field, "$1.$2.$3.$3");
866 Check/untaint ip addresses. IPv4 only for now. May be null.
871 my( $self, $field ) = @_;
872 if ( $self->getfield($field) =~ /^()$/ ) {
873 $self->setfield($field,'');
876 $self->ut_ip($field);
880 =item ut_domain COLUMN
882 Check/untaint host and domain names.
887 my( $self, $field ) = @_;
888 #$self->getfield($field) =~/^(\w+\.)*\w+$/
889 $self->getfield($field) =~/^(\w+\.)*\w+$/
890 or return "Illegal (domain) $field: ". $self->getfield($field);
891 $self->setfield($field,$1);
897 Check/untaint proper names; allows alphanumerics, spaces and the following
905 my( $self, $field ) = @_;
906 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
907 or return "Illegal (name) $field: ". $self->getfield($field);
908 $self->setfield($field,$1);
914 Check/untaint zip codes.
919 my( $self, $field, $country ) = @_;
920 if ( $country eq 'US' ) {
921 $self->getfield($field) =~ /\s*(\d{5}(\-\d{4})?)\s*$/
922 or return "Illegal (zip) $field for country $country: ".
923 $self->getfield($field);
924 $self->setfield($field,$1);
926 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
927 or return "Illegal (zip) $field: ". $self->getfield($field);
928 $self->setfield($field,$1);
933 =item ut_country COLUMN
935 Check/untaint country codes. Country names are changed to codes, if possible -
936 see L<Locale::Country>.
941 my( $self, $field ) = @_;
942 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
943 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
944 && country2code($1) ) {
945 $self->setfield($field,uc(country2code($1)));
948 $self->getfield($field) =~ /^(\w\w)$/
949 or return "Illegal (country) $field: ". $self->getfield($field);
950 $self->setfield($field,uc($1));
954 =item ut_anything COLUMN
956 Untaints arbitrary data. Be careful.
961 my( $self, $field ) = @_;
962 $self->getfield($field) =~ /^(.*)$/s
963 or return "Illegal $field: ". $self->getfield($field);
964 $self->setfield($field,$1);
968 =item ut_enum COLUMN CHOICES_ARRAYREF
970 Check/untaint a column, supplying all possible choices, like the "enum" type.
975 my( $self, $field, $choices ) = @_;
976 foreach my $choice ( @$choices ) {
977 if ( $self->getfield($field) eq $choice ) {
978 $self->setfield($choice);
982 return "Illegal (enum) field $field: ". $self->getfield($field);
985 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
987 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
993 my( $self, $field, $table, $foreign ) = @_;
994 qsearchs($table, { $foreign => $self->getfield($field) })
995 or return "Can't find $field ". $self->getfield($field).
996 " in $table.$foreign";
1000 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1002 Like ut_foreign_key, except the null value is also allowed.
1006 sub ut_foreign_keyn {
1007 my( $self, $field, $table, $foreign ) = @_;
1008 $self->getfield($field)
1009 ? $self->ut_foreign_key($field, $table, $foreign)
1013 =item fields [ TABLE ]
1015 This can be used as both a subroutine and a method call. It returns a list
1016 of the columns in this record's table, or an explicitly specified table.
1017 (See L<DBIx::DBSchema::Table>).
1021 # Usage: @fields = fields($table);
1022 # @fields = $record->fields;
1024 my $something = shift;
1026 if ( ref($something) ) {
1027 $table = $something->table;
1029 $table = $something;
1031 #croak "Usage: \@fields = fields(\$table)\n or: \@fields = \$record->fields" unless $table;
1032 my($table_obj) = $dbdef->table($table);
1033 confess "Unknown table $table" unless $table_obj;
1034 $table_obj->columns;
1043 =item reload_dbdef([FILENAME])
1045 Load a database definition (see L<DBIx::DBSchema>), optionally from a
1046 non-default filename. This command is executed at startup unless
1047 I<$FS::Record::setup_hack> is true. Returns a DBIx::DBSchema object.
1052 my $file = shift || $dbdef_file;
1053 $dbdef = load DBIx::DBSchema $file
1054 or die "can't load database schema from $file";
1059 Returns the current database definition. See L<FS::dbdef>.
1063 sub dbdef { $dbdef; }
1065 =item _quote VALUE, TABLE, COLUMN
1067 This is an internal function used to construct SQL statements. It returns
1068 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
1069 type (see L<FS::dbdef_column>) does not end in `char' or `binary'.
1074 my($value,$table,$field)=@_;
1076 if ( $value =~ /^\d+(\.\d+)?$/ &&
1077 # ! ( datatype($table,$field) =~ /^char/ )
1078 ! ( $dbdef->table($table)->column($field)->type =~ /(char|binary)$/i )
1082 $dbh->quote($value);
1088 This is depriciated. Don't use it.
1090 It returns a hash-type list with the fields of this record's table set true.
1095 carp "warning: hfields is depriciated";
1098 foreach (fields($table)) {
1107 "$_: ". $self->getfield($_). "|"
1108 } (fields($self->table)) );
1111 sub DESTROY { return; }
1115 # #use Carp qw(cluck);
1116 # #cluck "DESTROYING $self";
1117 # warn "DESTROYING $self";
1121 # return ! eval { join('',@_), kill 0; 1; };
1128 This module should probably be renamed, since much of the functionality is
1129 of general use. It is not completely unlike Adapter::DBI (see below).
1131 Exported qsearch and qsearchs should be depriciated in favor of method calls
1132 (against an FS::Record object like the old search and searchs that qsearch
1133 and qsearchs were on top of.)
1135 The whole fields / hfields mess should be removed.
1137 The various WHERE clauses should be subroutined.
1139 table string should be depriciated in favor of FS::dbdef_table.
1141 No doubt we could benefit from a Tied hash. Documenting how exists / defined
1142 true maps to the database (and WHERE clauses) would also help.
1144 The ut_ methods should ask the dbdef for a default length.
1146 ut_sqltype (like ut_varchar) should all be defined
1148 A fallback check method should be provided which uses the dbdef.
1150 The ut_money method assumes money has two decimal digits.
1152 The Pg money kludge in the new method only strips `$'.
1154 The ut_phonen method only checks US-style phone numbers.
1156 The _quote function should probably use ut_float instead of a regex.
1158 All the subroutines probably should be methods, here or elsewhere.
1160 Probably should borrow/use some dbdef methods where appropriate (like sub
1163 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
1164 or allow it to be set. Working around it is ugly any way around - DBI should
1165 be fixed. (only affects RDBMS which return uppercase column names)
1167 ut_zip should take an optional country like ut_phone.
1171 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
1173 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.