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);
15 use FS::Msgcat qw(gettext);
18 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef jsearch);
23 #ask FS::UID to run this stuff for us later
24 $FS::UID::callback{'FS::Record'} = sub {
25 $File::CounterFile::DEFAULT_DIR = "/usr/local/etc/freeside/counters.". datasrc;
26 $dbdef_file = "/usr/local/etc/freeside/dbdef.". datasrc;
27 &reload_dbdef unless $setup_hack; #$setup_hack needed now?
32 FS::Record - Database record objects
37 use FS::Record qw(dbh fields qsearch qsearchs dbdef);
39 $record = new FS::Record 'table', \%hash;
40 $record = new FS::Record 'table', { 'column' => 'value', ... };
42 $record = qsearchs FS::Record 'table', \%hash;
43 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
44 @records = qsearch FS::Record 'table', \%hash;
45 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
47 $table = $record->table;
48 $dbdef_table = $record->dbdef_table;
50 $value = $record->get('column');
51 $value = $record->getfield('column');
52 $value = $record->column;
54 $record->set( 'column' => 'value' );
55 $record->setfield( 'column' => 'value' );
56 $record->column('value');
58 %hash = $record->hash;
60 $hashref = $record->hashref;
62 $error = $record->insert;
63 #$error = $record->add; #deprecated
65 $error = $record->delete;
66 #$error = $record->del; #deprecated
68 $error = $new_record->replace($old_record);
69 #$error = $new_record->rep($old_record); #deprecated
71 $value = $record->unique('column');
73 $error = $record->ut_float('column');
74 $error = $record->ut_number('column');
75 $error = $record->ut_numbern('column');
76 $error = $record->ut_money('column');
77 $error = $record->ut_text('column');
78 $error = $record->ut_textn('column');
79 $error = $record->ut_alpha('column');
80 $error = $record->ut_alphan('column');
81 $error = $record->ut_phonen('column');
82 $error = $record->ut_anything('column');
83 $error = $record->ut_name('column');
85 $dbdef = reload_dbdef;
86 $dbdef = reload_dbdef "/non/standard/filename";
89 $quoted_value = _quote($value,'table','field');
92 $fields = hfields('table');
93 if ( $fields->{Field} ) { # etc.
95 @fields = fields 'table'; #as a subroutine
96 @fields = $record->fields; #as a method call
101 (Mostly) object-oriented interface to database records. Records are currently
102 implemented on top of DBI. FS::Record is intended as a base class for
103 table-specific classes to inherit from, i.e. FS::cust_main.
109 =item new [ TABLE, ] HASHREF
111 Creates a new record. It doesn't store it in the database, though. See
112 L<"insert"> for that.
114 Note that the object stores this hash reference, not a distinct copy of the
115 hash it points to. You can ask the object for a copy with the I<hash>
118 TABLE can only be omitted when a dervived class overrides the table method.
124 my $class = ref($proto) || $proto;
126 bless ($self, $class);
128 unless ( defined ( $self->table ) ) {
129 $self->{'Table'} = shift;
130 carp "warning: FS::Record::new called with table name ". $self->{'Table'};
133 my $hashref = $self->{'Hash'} = shift;
135 foreach my $field ( $self->fields ) {
136 $hashref->{$field}='' unless defined $hashref->{$field};
137 #trim the '$' and ',' from money fields for Pg (belong HERE?)
138 #(what about Pg i18n?)
139 if ( driver_name =~ /^Pg$/i
140 && $self->dbdef_table->column($field)->type eq 'money' ) {
141 ${$hashref}{$field} =~ s/^\$//;
142 ${$hashref}{$field} =~ s/\,//;
146 $self->_cache($hashref, shift) if $self->can('_cache') && @_;
153 my $class = ref($proto) || $proto;
155 bless ($self, $class);
157 $self->{'Table'} = shift unless defined ( $self->table );
159 my $hashref = $self->{'Hash'} = shift;
161 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
162 my $obj = $cache->cache->{$hashref->{$cache->key}};
163 $obj->_cache($hashref, $cache) if $obj->can('_cache');
166 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
173 my $class = ref($proto) || $proto;
175 bless ($self, $class);
176 if ( defined $self->table ) {
177 cluck "create constructor is depriciated, use new!";
180 croak "FS::Record::create called (not from a subclass)!";
184 =item qsearch TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ
186 Searches the database for all records matching (at least) the key/value pairs
187 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
188 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
191 ###oops, argh, FS::Record::new only lets us create database fields.
192 #Normal behaviour if SELECT is not specified is `*', as in
193 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
194 #feature where you can specify SELECT - remember, the objects returned,
195 #although blessed into the appropriate `FS::TABLE' package, will only have the
196 #fields you specify. This might have unwanted results if you then go calling
197 #regular FS::TABLE methods
203 my($stable, $record, $select, $extra_sql, $cache ) = @_;
204 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
206 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
211 my $table = $cache ? $cache->table : $stable;
213 my @fields = grep exists($record->{$_}), fields($table);
215 my $statement = "SELECT $select FROM $stable";
217 $statement .= ' WHERE '. join(' AND ', map {
220 if ( ref($record->{$_}) ) {
221 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
222 $op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name !~ /^Pg$/i;
223 $record->{$_} = $record->{$_}{'value'}
226 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
228 if ( driver_name =~ /^Pg$/i ) {
229 qq-( $_ IS NULL OR $_ = '' )-;
231 qq-( $_ IS NULL OR $_ = "" )-;
233 } elsif ( $op eq '!=' ) {
234 if ( driver_name =~ /^Pg$/i ) {
235 qq-( $_ IS NOT NULL AND $_ != '' )-;
237 qq-( $_ IS NOT NULL AND $_ != "" )-;
240 if ( driver_name =~ /^Pg$/i ) {
251 $statement .= " $extra_sql" if defined($extra_sql);
253 warn "[debug]$me $statement\n" if $DEBUG;
254 my $sth = $dbh->prepare($statement)
255 or croak "$dbh->errstr doing $statement";
260 grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
262 if ( $record->{$field} =~ /^\d+(\.\d+)?$/
263 && $dbdef->table($table)->column($field)->type =~ /(int)/i
265 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_INTEGER } );
267 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_VARCHAR } );
271 # $sth->execute( map $record->{$_},
272 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
273 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
275 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
277 $dbh->commit or croak $dbh->errstr if $FS::UID::AutoCommit;
279 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
280 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
281 #derivied class didn't override new method, so this optimization is safe
284 new_or_cached( "FS::$table", { %{$_} }, $cache )
285 } @{$sth->fetchall_arrayref( {} )};
288 new( "FS::$table", { %{$_} } )
289 } @{$sth->fetchall_arrayref( {} )};
292 warn "untested code (class FS::$table uses custom new method)";
294 eval 'FS::'. $table. '->new( { %{$_} } )';
295 } @{$sth->fetchall_arrayref( {} )};
298 cluck "warning: FS::$table not loaded; returning FS::Record objects";
300 FS::Record->new( $table, { %{$_} } );
301 } @{$sth->fetchall_arrayref( {} )};
306 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
308 Experimental JOINed search method. Using this method, you can execute a
309 single SELECT spanning multiple tables, and cache the results for subsequent
310 method calls. Interface will almost definately change in an incompatible
318 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
319 my $cache = FS::SearchCache->new( $ptable, $pkey );
322 grep { !$saw{$_->getfield($pkey)}++ }
323 qsearch($table, $record, $select, $extra_sql, $cache )
327 =item qsearchs TABLE, HASHREF
329 Same as qsearch, except that if more than one record matches, it B<carp>s but
330 returns the first. If this happens, you either made a logic error in asking
331 for a single item, or your data is corrupted.
335 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
336 my(@result) = qsearch(@_);
337 carp "warning: Multiple records in scalar search!" if scalar(@result) > 1;
338 #should warn more vehemently if the search was on a primary key?
339 scalar(@result) ? ($result[0]) : ();
350 Returns the table name.
355 # cluck "warning: FS::Record::table depriciated; supply one in subclass!";
362 Returns the DBIx::DBSchema::Table object for the table.
368 my($table)=$self->table;
369 $dbdef->table($table);
372 =item get, getfield COLUMN
374 Returns the value of the column/field/key COLUMN.
379 my($self,$field) = @_;
380 # to avoid "Use of unitialized value" errors
381 if ( defined ( $self->{Hash}->{$field} ) ) {
382 $self->{Hash}->{$field};
392 =item set, setfield COLUMN, VALUE
394 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
399 my($self,$field,$value) = @_;
400 $self->{'Hash'}->{$field} = $value;
407 =item AUTLOADED METHODS
409 $record->column is a synonym for $record->get('column');
411 $record->column('value') is a synonym for $record->set('column','value');
418 my($field)=$AUTOLOAD;
420 if ( defined($value) ) {
421 confess "errant AUTOLOAD $field for $self (arg $value)"
422 unless $self->can('setfield');
423 $self->setfield($field,$value);
425 confess "errant AUTOLOAD $field for $self (no args)"
426 unless $self->can('getfield');
427 $self->getfield($field);
433 # my $field = $AUTOLOAD;
435 # if ( defined($_[1]) ) {
436 # $_[0]->setfield($field, $_[1]);
438 # $_[0]->getfield($field);
444 Returns a list of the column/value pairs, usually for assigning to a new hash.
446 To make a distinct duplicate of an FS::Record object, you can do:
448 $new = new FS::Record ( $old->table, { $old->hash } );
454 %{ $self->{'Hash'} };
459 Returns a reference to the column/value hash.
470 Inserts this record to the database. If there is an error, returns the error,
471 otherwise returns false.
478 my $error = $self->check;
479 return $error if $error;
481 #single-field unique keys are given a value if false
482 #(like MySQL's AUTO_INCREMENT)
483 foreach ( $self->dbdef_table->unique->singles ) {
484 $self->unique($_) unless $self->getfield($_);
486 #and also the primary key
487 my $primary_key = $self->dbdef_table->primary_key;
488 $self->unique($primary_key)
489 if $primary_key && ! $self->getfield($primary_key);
491 #false laziness w/delete
493 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
496 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
499 my $statement = "INSERT INTO ". $self->table. " ( ".
500 join( ', ', @fields ).
502 join( ', ', @values ).
505 warn "[debug]$me $statement\n" if $DEBUG;
506 my $sth = dbh->prepare($statement) or return dbh->errstr;
509 if ( defined $dbdef->table('h_'. $self->table) ) {
510 my $h_statement = $self->_h_statement('insert');
511 warn "[debug]$me $h_statement\n" if $DEBUG;
512 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
517 local $SIG{HUP} = 'IGNORE';
518 local $SIG{INT} = 'IGNORE';
519 local $SIG{QUIT} = 'IGNORE';
520 local $SIG{TERM} = 'IGNORE';
521 local $SIG{TSTP} = 'IGNORE';
522 local $SIG{PIPE} = 'IGNORE';
524 $sth->execute or return $sth->errstr;
525 $h_sth->execute or return $h_sth->errstr if $h_sth;
526 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
533 Depriciated (use insert instead).
538 cluck "warning: FS::Record::add depriciated!";
539 insert @_; #call method in this scope
544 Delete this record from the database. If there is an error, returns the error,
545 otherwise returns false.
552 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
554 $self->getfield($_) eq ''
555 #? "( $_ IS NULL OR $_ = \"\" )"
556 ? ( driver_name =~ /^Pg$/i
558 : "( $_ IS NULL OR $_ = \"\" )"
560 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
561 } ( $self->dbdef_table->primary_key )
562 ? ( $self->dbdef_table->primary_key)
565 warn "[debug]$me $statement\n" if $DEBUG;
566 my $sth = dbh->prepare($statement) or return dbh->errstr;
569 if ( defined $dbdef->table('h_'. $self->table) ) {
570 my $h_statement = $self->_h_statement('delete');
571 warn "[debug]$me $h_statement\n" if $DEBUG;
572 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
577 local $SIG{HUP} = 'IGNORE';
578 local $SIG{INT} = 'IGNORE';
579 local $SIG{QUIT} = 'IGNORE';
580 local $SIG{TERM} = 'IGNORE';
581 local $SIG{TSTP} = 'IGNORE';
582 local $SIG{PIPE} = 'IGNORE';
584 my $rc = $sth->execute or return $sth->errstr;
585 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
586 $h_sth->execute or return $h_sth->errstr if $h_sth;
587 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
589 #no need to needlessly destoy the data either (causes problems actually)
590 #undef $self; #no need to keep object!
597 Depriciated (use delete instead).
602 cluck "warning: FS::Record::del depriciated!";
603 &delete(@_); #call method in this scope
606 =item replace OLD_RECORD
608 Replace the OLD_RECORD with this one in the database. If there is an error,
609 returns the error, otherwise returns false.
614 my ( $new, $old ) = ( shift, shift );
615 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
617 return "Records not in same table!" unless $new->table eq $old->table;
619 my $primary_key = $old->dbdef_table->primary_key;
620 return "Can't change $primary_key"
622 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
624 my $error = $new->check;
625 return $error if $error;
627 my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
629 carp "[warning]$me $new -> replace $old: records identical";
633 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
635 "$_ = ". _quote($new->getfield($_),$old->table,$_)
640 $old->getfield($_) eq ''
641 #? "( $_ IS NULL OR $_ = \"\" )"
642 ? ( driver_name =~ /^Pg$/i
644 : "( $_ IS NULL OR $_ = \"\" )"
646 : "$_ = ". _quote($old->getfield($_),$old->table,$_)
647 } ( $primary_key ? ( $primary_key ) : $old->fields )
650 warn "[debug]$me $statement\n" if $DEBUG;
651 my $sth = dbh->prepare($statement) or return dbh->errstr;
654 if ( defined $dbdef->table('h_'. $old->table) ) {
655 my $h_old_statement = $old->_h_statement('replace_old');
656 warn "[debug]$me $h_old_statement\n" if $DEBUG;
657 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
663 if ( defined $dbdef->table('h_'. $new->table) ) {
664 my $h_new_statement = $new->_h_statement('replace_new');
665 warn "[debug]$me $h_new_statement\n" if $DEBUG;
666 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
671 local $SIG{HUP} = 'IGNORE';
672 local $SIG{INT} = 'IGNORE';
673 local $SIG{QUIT} = 'IGNORE';
674 local $SIG{TERM} = 'IGNORE';
675 local $SIG{TSTP} = 'IGNORE';
676 local $SIG{PIPE} = 'IGNORE';
678 my $rc = $sth->execute or return $sth->errstr;
679 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
680 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
681 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
682 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
690 Depriciated (use replace instead).
695 cluck "warning: FS::Record::rep depriciated!";
696 replace @_; #call method in this scope
701 Not yet implemented, croaks. Derived classes should provide a check method.
706 confess "FS::Record::check not implemented; supply one in subclass!";
710 my( $self, $action ) = @_;
713 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
716 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
718 "INSERT INTO h_". $self->table. " ( ".
719 join(', ', qw(history_date history_user history_action), @fields ).
721 join(', ', time, dbh->quote(getotaker()), dbh->quote($action), @values).
728 Replaces COLUMN in record with a unique number. Called by the B<add> method
729 on primary keys and single-field unique columns (see L<DBIx::DBSchema::Table>).
730 Returns the new value.
735 my($self,$field) = @_;
736 my($table)=$self->table;
738 croak("&FS::UID::checkruid failed") unless &checkruid;
740 croak "Unique called on field $field, but it is ",
741 $self->getfield($field),
743 if $self->getfield($field);
745 #warn "table $table is tainted" if is_tainted($table);
746 #warn "field $field is tainted" if is_tainted($field);
748 my($counter) = new File::CounterFile "$table.$field",0;
750 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
752 # my($counter) = new File::CounterFile "$user/$table.$field",0;
755 my($index)=$counter->inc;
757 while qsearchs($table,{$field=>$index}); #just in case
762 $self->setfield($field,$index);
766 =item ut_float COLUMN
768 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
769 null. If there is an error, returns the error, otherwise returns false.
774 my($self,$field)=@_ ;
775 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
776 $self->getfield($field) =~ /^(\d+)$/ ||
777 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
778 $self->getfield($field) =~ /^(\d+e\d+)$/)
779 or return "Illegal or empty (float) $field: ". $self->getfield($field);
780 $self->setfield($field,$1);
784 =item ut_number COLUMN
786 Check/untaint simple numeric data (whole numbers). May not be null. If there
787 is an error, returns the error, otherwise returns false.
793 $self->getfield($field) =~ /^(\d+)$/
794 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
795 $self->setfield($field,$1);
799 =item ut_numbern COLUMN
801 Check/untaint simple numeric data (whole numbers). May be null. If there is
802 an error, returns the error, otherwise returns false.
808 $self->getfield($field) =~ /^(\d*)$/
809 or return "Illegal (numeric) $field: ". $self->getfield($field);
810 $self->setfield($field,$1);
814 =item ut_money COLUMN
816 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
817 is an error, returns the error, otherwise returns false.
823 $self->setfield($field, 0) if $self->getfield($field) eq '';
824 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
825 or return "Illegal (money) $field: ". $self->getfield($field);
826 #$self->setfield($field, "$1$2$3" || 0);
827 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
833 Check/untaint text. Alphanumerics, spaces, and the following punctuation
834 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / =
835 May not be null. If there is an error, returns the error, otherwise returns
842 #warn "msgcat ". \&msgcat. "\n";
843 #warn "notexist ". \¬exist. "\n";
844 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
845 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]+)$/
846 or return gettext('illegal_or_empty_text'). " $field: ".
847 $self->getfield($field);
848 $self->setfield($field,$1);
852 =item ut_textn COLUMN
854 Check/untaint text. Alphanumerics, spaces, and the following punctuation
855 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
856 May be null. If there is an error, returns the error, otherwise returns false.
862 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]*)$/
863 or return gettext('illegal_text'). " $field: ". $self->getfield($field);
864 $self->setfield($field,$1);
868 =item ut_alpha COLUMN
870 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
871 an error, returns the error, otherwise returns false.
877 $self->getfield($field) =~ /^(\w+)$/
878 or return "Illegal or empty (alphanumeric) $field: ".
879 $self->getfield($field);
880 $self->setfield($field,$1);
884 =item ut_alpha COLUMN
886 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
887 error, returns the error, otherwise returns false.
893 $self->getfield($field) =~ /^(\w*)$/
894 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
895 $self->setfield($field,$1);
899 =item ut_phonen COLUMN [ COUNTRY ]
901 Check/untaint phone numbers. May be null. If there is an error, returns
902 the error, otherwise returns false.
904 Takes an optional two-letter ISO country code; without it or with unsupported
905 countries, ut_phonen simply calls ut_alphan.
910 my( $self, $field, $country ) = @_;
911 return $self->ut_alphan($field) unless defined $country;
912 my $phonen = $self->getfield($field);
913 if ( $phonen eq '' ) {
914 $self->setfield($field,'');
915 } elsif ( $country eq 'US' || $country eq 'CA' ) {
917 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
918 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
919 $phonen = "$1-$2-$3";
920 $phonen .= " x$4" if $4;
921 $self->setfield($field,$phonen);
923 warn "warning: don't know how to check phone numbers for country $country";
924 return $self->ut_textn($field);
931 Check/untaint ip addresses. IPv4 only for now.
936 my( $self, $field ) = @_;
937 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
938 or return "Illegal (IP address) $field: ". $self->getfield($field);
939 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
940 $self->setfield($field, "$1.$2.$3.$3");
946 Check/untaint ip addresses. IPv4 only for now. May be null.
951 my( $self, $field ) = @_;
952 if ( $self->getfield($field) =~ /^()$/ ) {
953 $self->setfield($field,'');
956 $self->ut_ip($field);
960 =item ut_domain COLUMN
962 Check/untaint host and domain names.
967 my( $self, $field ) = @_;
968 #$self->getfield($field) =~/^(\w+\.)*\w+$/
969 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
970 or return "Illegal (domain) $field: ". $self->getfield($field);
971 $self->setfield($field,$1);
977 Check/untaint proper names; allows alphanumerics, spaces and the following
985 my( $self, $field ) = @_;
986 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
987 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
988 $self->setfield($field,$1);
994 Check/untaint zip codes.
999 my( $self, $field, $country ) = @_;
1000 if ( $country eq 'US' ) {
1001 $self->getfield($field) =~ /\s*(\d{5}(\-\d{4})?)\s*$/
1002 or return gettext('illegal_zip'). " $field for country $country: ".
1003 $self->getfield($field);
1004 $self->setfield($field,$1);
1006 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
1007 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
1008 $self->setfield($field,$1);
1013 =item ut_country COLUMN
1015 Check/untaint country codes. Country names are changed to codes, if possible -
1016 see L<Locale::Country>.
1021 my( $self, $field ) = @_;
1022 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
1023 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
1024 && country2code($1) ) {
1025 $self->setfield($field,uc(country2code($1)));
1028 $self->getfield($field) =~ /^(\w\w)$/
1029 or return "Illegal (country) $field: ". $self->getfield($field);
1030 $self->setfield($field,uc($1));
1034 =item ut_anything COLUMN
1036 Untaints arbitrary data. Be careful.
1041 my( $self, $field ) = @_;
1042 $self->getfield($field) =~ /^(.*)$/s
1043 or return "Illegal $field: ". $self->getfield($field);
1044 $self->setfield($field,$1);
1048 =item ut_enum COLUMN CHOICES_ARRAYREF
1050 Check/untaint a column, supplying all possible choices, like the "enum" type.
1055 my( $self, $field, $choices ) = @_;
1056 foreach my $choice ( @$choices ) {
1057 if ( $self->getfield($field) eq $choice ) {
1058 $self->setfield($choice);
1062 return "Illegal (enum) field $field: ". $self->getfield($field);
1065 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1067 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
1068 on the column first.
1072 sub ut_foreign_key {
1073 my( $self, $field, $table, $foreign ) = @_;
1074 qsearchs($table, { $foreign => $self->getfield($field) })
1075 or return "Can't find $field ". $self->getfield($field).
1076 " in $table.$foreign";
1080 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1082 Like ut_foreign_key, except the null value is also allowed.
1086 sub ut_foreign_keyn {
1087 my( $self, $field, $table, $foreign ) = @_;
1088 $self->getfield($field)
1089 ? $self->ut_foreign_key($field, $table, $foreign)
1093 =item fields [ TABLE ]
1095 This can be used as both a subroutine and a method call. It returns a list
1096 of the columns in this record's table, or an explicitly specified table.
1097 (See L<DBIx::DBSchema::Table>).
1101 # Usage: @fields = fields($table);
1102 # @fields = $record->fields;
1104 my $something = shift;
1106 if ( ref($something) ) {
1107 $table = $something->table;
1109 $table = $something;
1111 #croak "Usage: \@fields = fields(\$table)\n or: \@fields = \$record->fields" unless $table;
1112 my($table_obj) = $dbdef->table($table);
1113 confess "Unknown table $table" unless $table_obj;
1114 $table_obj->columns;
1123 =item reload_dbdef([FILENAME])
1125 Load a database definition (see L<DBIx::DBSchema>), optionally from a
1126 non-default filename. This command is executed at startup unless
1127 I<$FS::Record::setup_hack> is true. Returns a DBIx::DBSchema object.
1132 my $file = shift || $dbdef_file;
1133 $dbdef = load DBIx::DBSchema $file
1134 or die "can't load database schema from $file";
1139 Returns the current database definition. See L<DBIx::DBSchema>.
1143 sub dbdef { $dbdef; }
1145 =item _quote VALUE, TABLE, COLUMN
1147 This is an internal function used to construct SQL statements. It returns
1148 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
1149 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
1154 my($value,$table,$field)=@_;
1156 if ( $value =~ /^\d+(\.\d+)?$/ &&
1157 # ! ( datatype($table,$field) =~ /^char/ )
1158 ! $dbdef->table($table)->column($field)->type =~ /(char|binary|text)$/i
1162 $dbh->quote($value);
1168 This is depriciated. Don't use it.
1170 It returns a hash-type list with the fields of this record's table set true.
1175 carp "warning: hfields is depriciated";
1178 foreach (fields($table)) {
1187 "$_: ". $self->getfield($_). "|"
1188 } (fields($self->table)) );
1191 sub DESTROY { return; }
1195 # #use Carp qw(cluck);
1196 # #cluck "DESTROYING $self";
1197 # warn "DESTROYING $self";
1201 # return ! eval { join('',@_), kill 0; 1; };
1208 This module should probably be renamed, since much of the functionality is
1209 of general use. It is not completely unlike Adapter::DBI (see below).
1211 Exported qsearch and qsearchs should be depriciated in favor of method calls
1212 (against an FS::Record object like the old search and searchs that qsearch
1213 and qsearchs were on top of.)
1215 The whole fields / hfields mess should be removed.
1217 The various WHERE clauses should be subroutined.
1219 table string should be depriciated in favor of DBIx::DBSchema::Table.
1221 No doubt we could benefit from a Tied hash. Documenting how exists / defined
1222 true maps to the database (and WHERE clauses) would also help.
1224 The ut_ methods should ask the dbdef for a default length.
1226 ut_sqltype (like ut_varchar) should all be defined
1228 A fallback check method should be provided which uses the dbdef.
1230 The ut_money method assumes money has two decimal digits.
1232 The Pg money kludge in the new method only strips `$'.
1234 The ut_phonen method only checks US-style phone numbers.
1236 The _quote function should probably use ut_float instead of a regex.
1238 All the subroutines probably should be methods, here or elsewhere.
1240 Probably should borrow/use some dbdef methods where appropriate (like sub
1243 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
1244 or allow it to be set. Working around it is ugly any way around - DBI should
1245 be fixed. (only affects RDBMS which return uppercase column names)
1247 ut_zip should take an optional country like ut_phone.
1251 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
1253 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.