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; #depriciated
64 $error = $record->delete;
65 #$error = $record->del; #depriciated
67 $error = $new_record->replace($old_record);
68 #$error = $new_record->rep($old_record); #depriciated
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
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 {
217 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
218 if ( driver_name =~ /^Pg$/i ) {
219 qq-( $_ IS NULL OR $_ = '' )-;
221 qq-( $_ IS NULL OR $_ = "" )-;
228 $statement .= " $extra_sql" if defined($extra_sql);
230 warn "[debug]$me $statement\n" if $DEBUG;
231 my $sth = $dbh->prepare($statement)
232 or croak "$dbh->errstr doing $statement";
237 grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
239 if ( $record->{$field} =~ /^\d+(\.\d+)?$/
240 && $dbdef->table($table)->column($field)->type =~ /(int)/i
242 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_INTEGER } );
244 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_VARCHAR } );
248 # $sth->execute( map $record->{$_},
249 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
250 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
252 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
254 $dbh->commit or croak $dbh->errstr if $FS::UID::AutoCommit;
256 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
257 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
258 #derivied class didn't override new method, so this optimization is safe
261 new_or_cached( "FS::$table", { %{$_} }, $cache )
262 } @{$sth->fetchall_arrayref( {} )};
265 new( "FS::$table", { %{$_} } )
266 } @{$sth->fetchall_arrayref( {} )};
269 warn "untested code (class FS::$table uses custom new method)";
271 eval 'FS::'. $table. '->new( { %{$_} } )';
272 } @{$sth->fetchall_arrayref( {} )};
275 cluck "warning: FS::$table not loaded; returning FS::Record objects";
277 FS::Record->new( $table, { %{$_} } );
278 } @{$sth->fetchall_arrayref( {} )};
283 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
285 Experimental JOINed search method. Using this method, you can execute a
286 single SELECT spanning multiple tables, and cache the results for subsequent
287 method calls. Interface will almost definately change in an incompatible
295 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
296 my $cache = FS::SearchCache->new( $ptable, $pkey );
299 grep { !$saw{$_->getfield($pkey)}++ }
300 qsearch($table, $record, $select, $extra_sql, $cache )
304 =item qsearchs TABLE, HASHREF
306 Same as qsearch, except that if more than one record matches, it B<carp>s but
307 returns the first. If this happens, you either made a logic error in asking
308 for a single item, or your data is corrupted.
312 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
313 my(@result) = qsearch(@_);
314 carp "warning: Multiple records in scalar search!" if scalar(@result) > 1;
315 #should warn more vehemently if the search was on a primary key?
316 scalar(@result) ? ($result[0]) : ();
327 Returns the table name.
332 # cluck "warning: FS::Record::table depriciated; supply one in subclass!";
339 Returns the FS::dbdef_table object for the table.
345 my($table)=$self->table;
346 $dbdef->table($table);
349 =item get, getfield COLUMN
351 Returns the value of the column/field/key COLUMN.
356 my($self,$field) = @_;
357 # to avoid "Use of unitialized value" errors
358 if ( defined ( $self->{Hash}->{$field} ) ) {
359 $self->{Hash}->{$field};
369 =item set, setfield COLUMN, VALUE
371 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
376 my($self,$field,$value) = @_;
377 $self->{'Hash'}->{$field} = $value;
384 =item AUTLOADED METHODS
386 $record->column is a synonym for $record->get('column');
388 $record->column('value') is a synonym for $record->set('column','value');
394 # my($self,$value)=@_;
395 # my($field)=$AUTOLOAD;
397 # if ( defined($value) ) {
398 # confess "errant AUTOLOAD $field for $self (arg $value)"
399 # unless $self->can('setfield');
400 # $self->setfield($field,$value);
402 # confess "errant AUTOLOAD $field for $self (no args)"
403 # unless $self->can('getfield');
404 # $self->getfield($field);
410 my $field = $AUTOLOAD;
412 if ( defined($_[1]) ) {
413 $_[0]->setfield($field, $_[1]);
415 $_[0]->getfield($field);
421 Returns a list of the column/value pairs, usually for assigning to a new hash.
423 To make a distinct duplicate of an FS::Record object, you can do:
425 $new = new FS::Record ( $old->table, { $old->hash } );
431 %{ $self->{'Hash'} };
436 Returns a reference to the column/value hash.
447 Inserts this record to the database. If there is an error, returns the error,
448 otherwise returns false.
455 my $error = $self->check;
456 return $error if $error;
458 #single-field unique keys are given a value if false
459 #(like MySQL's AUTO_INCREMENT)
460 foreach ( $self->dbdef_table->unique->singles ) {
461 $self->unique($_) unless $self->getfield($_);
463 #and also the primary key
464 my $primary_key = $self->dbdef_table->primary_key;
465 $self->unique($primary_key)
466 if $primary_key && ! $self->getfield($primary_key);
469 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
473 my $statement = "INSERT INTO ". $self->table. " ( ".
476 join(', ',map(_quote($self->getfield($_),$self->table,$_), @fields)).
479 warn "[debug]$me $statement\n" if $DEBUG;
480 my $sth = dbh->prepare($statement) or return dbh->errstr;
482 local $SIG{HUP} = 'IGNORE';
483 local $SIG{INT} = 'IGNORE';
484 local $SIG{QUIT} = 'IGNORE';
485 local $SIG{TERM} = 'IGNORE';
486 local $SIG{TSTP} = 'IGNORE';
487 local $SIG{PIPE} = 'IGNORE';
489 $sth->execute or return $sth->errstr;
490 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
497 Depriciated (use insert instead).
502 cluck "warning: FS::Record::add depriciated!";
503 insert @_; #call method in this scope
508 Delete this record from the database. If there is an error, returns the error,
509 otherwise returns false.
516 my($statement)="DELETE FROM ". $self->table. " WHERE ". join(' AND ',
518 $self->getfield($_) eq ''
519 #? "( $_ IS NULL OR $_ = \"\" )"
520 ? ( driver_name =~ /^Pg$/i
522 : "( $_ IS NULL OR $_ = \"\" )"
524 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
525 } ( $self->dbdef_table->primary_key )
526 ? ( $self->dbdef_table->primary_key)
529 warn "[debug]$me $statement\n" if $DEBUG;
530 my $sth = dbh->prepare($statement) or return dbh->errstr;
532 local $SIG{HUP} = 'IGNORE';
533 local $SIG{INT} = 'IGNORE';
534 local $SIG{QUIT} = 'IGNORE';
535 local $SIG{TERM} = 'IGNORE';
536 local $SIG{TSTP} = 'IGNORE';
537 local $SIG{PIPE} = 'IGNORE';
539 my $rc = $sth->execute or return $sth->errstr;
540 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
541 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
543 undef $self; #no need to keep object!
550 Depriciated (use delete instead).
555 cluck "warning: FS::Record::del depriciated!";
556 &delete(@_); #call method in this scope
559 =item replace OLD_RECORD
561 Replace the OLD_RECORD with this one in the database. If there is an error,
562 returns the error, otherwise returns false.
567 my ( $new, $old ) = ( shift, shift );
568 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
570 my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
572 carp "[warning]$me $new -> replace $old: records identical";
576 return "Records not in same table!" unless $new->table eq $old->table;
578 my $primary_key = $old->dbdef_table->primary_key;
579 return "Can't change $primary_key"
581 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
583 my $error = $new->check;
584 return $error if $error;
586 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
588 "$_ = ". _quote($new->getfield($_),$old->table,$_)
593 $old->getfield($_) eq ''
594 #? "( $_ IS NULL OR $_ = \"\" )"
595 ? ( driver_name =~ /^Pg$/i
597 : "( $_ IS NULL OR $_ = \"\" )"
599 : "$_ = ". _quote($old->getfield($_),$old->table,$_)
600 } ( $primary_key ? ( $primary_key ) : $old->fields )
603 warn "[debug]$me $statement\n" if $DEBUG;
604 my $sth = dbh->prepare($statement) or return dbh->errstr;
606 local $SIG{HUP} = 'IGNORE';
607 local $SIG{INT} = 'IGNORE';
608 local $SIG{QUIT} = 'IGNORE';
609 local $SIG{TERM} = 'IGNORE';
610 local $SIG{TSTP} = 'IGNORE';
611 local $SIG{PIPE} = 'IGNORE';
613 my $rc = $sth->execute or return $sth->errstr;
614 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
615 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
623 Depriciated (use replace instead).
628 cluck "warning: FS::Record::rep depriciated!";
629 replace @_; #call method in this scope
634 Not yet implemented, croaks. Derived classes should provide a check method.
639 confess "FS::Record::check not implemented; supply one in subclass!";
644 Replaces COLUMN in record with a unique number. Called by the B<add> method
645 on primary keys and single-field unique columns (see L<DBIx::DBSchema::Table>).
646 Returns the new value.
651 my($self,$field) = @_;
652 my($table)=$self->table;
654 croak("&FS::UID::checkruid failed") unless &checkruid;
656 croak "Unique called on field $field, but it is ",
657 $self->getfield($field),
659 if $self->getfield($field);
661 #warn "table $table is tainted" if is_tainted($table);
662 #warn "field $field is tainted" if is_tainted($field);
664 my($counter) = new File::CounterFile "$table.$field",0;
666 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
668 # my($counter) = new File::CounterFile "$user/$table.$field",0;
671 my($index)=$counter->inc;
673 while qsearchs($table,{$field=>$index}); #just in case
678 $self->setfield($field,$index);
682 =item ut_float COLUMN
684 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
685 null. If there is an error, returns the error, otherwise returns false.
690 my($self,$field)=@_ ;
691 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
692 $self->getfield($field) =~ /^(\d+)$/ ||
693 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
694 $self->getfield($field) =~ /^(\d+e\d+)$/)
695 or return "Illegal or empty (float) $field: ". $self->getfield($field);
696 $self->setfield($field,$1);
700 =item ut_number COLUMN
702 Check/untaint simple numeric data (whole numbers). May not be null. If there
703 is an error, returns the error, otherwise returns false.
709 $self->getfield($field) =~ /^(\d+)$/
710 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
711 $self->setfield($field,$1);
715 =item ut_numbern COLUMN
717 Check/untaint simple numeric data (whole numbers). May be null. If there is
718 an error, returns the error, otherwise returns false.
724 $self->getfield($field) =~ /^(\d*)$/
725 or return "Illegal (numeric) $field: ". $self->getfield($field);
726 $self->setfield($field,$1);
730 =item ut_money COLUMN
732 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
733 is an error, returns the error, otherwise returns false.
739 $self->setfield($field, 0) if $self->getfield($field) eq '';
740 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
741 or return "Illegal (money) $field: ". $self->getfield($field);
742 #$self->setfield($field, "$1$2$3" || 0);
743 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
749 Check/untaint text. Alphanumerics, spaces, and the following punctuation
750 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
751 May not be null. If there is an error, returns the error, otherwise returns
758 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]+)$/
759 or return "Illegal or empty (text) $field: ". $self->getfield($field);
760 $self->setfield($field,$1);
764 =item ut_textn COLUMN
766 Check/untaint text. Alphanumerics, spaces, and the following punctuation
767 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
768 May be null. If there is an error, returns the error, otherwise returns false.
774 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]*)$/
775 or return "Illegal (text) $field: ". $self->getfield($field);
776 $self->setfield($field,$1);
780 =item ut_alpha COLUMN
782 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
783 an error, returns the error, otherwise returns false.
789 $self->getfield($field) =~ /^(\w+)$/
790 or return "Illegal or empty (alphanumeric) $field: ".
791 $self->getfield($field);
792 $self->setfield($field,$1);
796 =item ut_alpha COLUMN
798 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
799 error, returns the error, otherwise returns false.
805 $self->getfield($field) =~ /^(\w*)$/
806 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
807 $self->setfield($field,$1);
811 =item ut_phonen COLUMN [ COUNTRY ]
813 Check/untaint phone numbers. May be null. If there is an error, returns
814 the error, otherwise returns false.
816 Takes an optional two-letter ISO country code; without it or with unsupported
817 countries, ut_phonen simply calls ut_alphan.
822 my( $self, $field, $country ) = @_;
823 return $self->ut_alphan($field) unless defined $country;
824 my $phonen = $self->getfield($field);
825 if ( $phonen eq '' ) {
826 $self->setfield($field,'');
827 } elsif ( $country eq 'US' || $country eq 'CA' ) {
829 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
830 or return "Illegal (phone) $field: ". $self->getfield($field);
831 $phonen = "$1-$2-$3";
832 $phonen .= " x$4" if $4;
833 $self->setfield($field,$phonen);
835 warn "warning: don't know how to check phone numbers for country $country";
836 return $self->ut_textn($field);
843 Check/untaint ip addresses. IPv4 only for now.
848 my( $self, $field ) = @_;
849 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
850 or return "Illegal (IP address) $field: ". $self->getfield($field);
851 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
852 $self->setfield($field, "$1.$2.$3.$3");
858 Check/untaint ip addresses. IPv4 only for now. May be null.
863 my( $self, $field ) = @_;
864 if ( $self->getfield($field) =~ /^()$/ ) {
865 $self->setfield($field,'');
868 $self->ut_ip($field);
872 =item ut_domain COLUMN
874 Check/untaint host and domain names.
879 my( $self, $field ) = @_;
880 #$self->getfield($field) =~/^(\w+\.)*\w+$/
881 $self->getfield($field) =~/^(\w+\.)*\w+$/
882 or return "Illegal (domain) $field: ". $self->getfield($field);
883 $self->setfield($field,$1);
889 Check/untaint proper names; allows alphanumerics, spaces and the following
897 my( $self, $field ) = @_;
898 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
899 or return "Illegal (name) $field: ". $self->getfield($field);
900 $self->setfield($field,$1);
906 Check/untaint zip codes.
911 my( $self, $field, $country ) = @_;
912 if ( $country eq 'US' ) {
913 $self->getfield($field) =~ /\s*(\d{5}(\-\d{4})?)\s*$/
914 or return "Illegal (zip) $field for country $country: ".
915 $self->getfield($field);
916 $self->setfield($field,$1);
918 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
919 or return "Illegal (zip) $field: ". $self->getfield($field);
920 $self->setfield($field,$1);
925 =item ut_country COLUMN
927 Check/untaint country codes. Country names are changed to codes, if possible -
928 see L<Locale::Country>.
933 my( $self, $field ) = @_;
934 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
935 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
936 && country2code($1) ) {
937 $self->setfield($field,uc(country2code($1)));
940 $self->getfield($field) =~ /^(\w\w)$/
941 or return "Illegal (country) $field: ". $self->getfield($field);
942 $self->setfield($field,uc($1));
946 =item ut_anything COLUMN
948 Untaints arbitrary data. Be careful.
953 my( $self, $field ) = @_;
954 $self->getfield($field) =~ /^(.*)$/s
955 or return "Illegal $field: ". $self->getfield($field);
956 $self->setfield($field,$1);
960 =item ut_enum COLUMN CHOICES_ARRAYREF
962 Check/untaint a column, supplying all possible choices, like the "enum" type.
967 my( $self, $field, $choices ) = @_;
968 foreach my $choice ( @$choices ) {
969 if ( $self->getfield($field) eq $choice ) {
970 $self->setfield($choice);
974 return "Illegal (enum) field $field: ". $self->getfield($field);
977 =item fields [ TABLE ]
979 This can be used as both a subroutine and a method call. It returns a list
980 of the columns in this record's table, or an explicitly specified table.
981 (See L<DBIx::DBSchema::Table>).
985 # Usage: @fields = fields($table);
986 # @fields = $record->fields;
988 my $something = shift;
990 if ( ref($something) ) {
991 $table = $something->table;
995 #croak "Usage: \@fields = fields(\$table)\n or: \@fields = \$record->fields" unless $table;
996 my($table_obj) = $dbdef->table($table);
997 confess "Unknown table $table" unless $table_obj;
1007 =item reload_dbdef([FILENAME])
1009 Load a database definition (see L<DBIx::DBSchema>), optionally from a
1010 non-default filename. This command is executed at startup unless
1011 I<$FS::Record::setup_hack> is true. Returns a DBIx::DBSchema object.
1016 my $file = shift || $dbdef_file;
1017 $dbdef = load DBIx::DBSchema $file
1018 or die "can't load database schema from $file";
1023 Returns the current database definition. See L<FS::dbdef>.
1027 sub dbdef { $dbdef; }
1029 =item _quote VALUE, TABLE, COLUMN
1031 This is an internal function used to construct SQL statements. It returns
1032 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
1033 type (see L<FS::dbdef_column>) does not end in `char' or `binary'.
1038 my($value,$table,$field)=@_;
1040 if ( $value =~ /^\d+(\.\d+)?$/ &&
1041 # ! ( datatype($table,$field) =~ /^char/ )
1042 ! ( $dbdef->table($table)->column($field)->type =~ /(char|binary)$/i )
1046 $dbh->quote($value);
1052 This is depriciated. Don't use it.
1054 It returns a hash-type list with the fields of this record's table set true.
1059 carp "warning: hfields is depriciated";
1062 foreach (fields($table)) {
1071 "$_: ". $self->getfield($_). "|"
1072 } (fields($self->table)) );
1075 sub DESTROY { return; }
1079 # #use Carp qw(cluck);
1080 # #cluck "DESTROYING $self";
1081 # warn "DESTROYING $self";
1085 # return ! eval { join('',@_), kill 0; 1; };
1092 This module should probably be renamed, since much of the functionality is
1093 of general use. It is not completely unlike Adapter::DBI (see below).
1095 Exported qsearch and qsearchs should be depriciated in favor of method calls
1096 (against an FS::Record object like the old search and searchs that qsearch
1097 and qsearchs were on top of.)
1099 The whole fields / hfields mess should be removed.
1101 The various WHERE clauses should be subroutined.
1103 table string should be depriciated in favor of FS::dbdef_table.
1105 No doubt we could benefit from a Tied hash. Documenting how exists / defined
1106 true maps to the database (and WHERE clauses) would also help.
1108 The ut_ methods should ask the dbdef for a default length.
1110 ut_sqltype (like ut_varchar) should all be defined
1112 A fallback check method should be provided which uses the dbdef.
1114 The ut_money method assumes money has two decimal digits.
1116 The Pg money kludge in the new method only strips `$'.
1118 The ut_phonen method only checks US-style phone numbers.
1120 The _quote function should probably use ut_float instead of a regex.
1122 All the subroutines probably should be methods, here or elsewhere.
1124 Probably should borrow/use some dbdef methods where appropriate (like sub
1127 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
1128 or allow it to be set. Working around it is ugly any way around - DBI should
1129 be fixed. (only affects RDBMS which return uppercase column names)
1131 ut_zip should take an optional country like ut_phone.
1135 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
1137 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.