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 '' ) {
227 if ( driver_name =~ /^Pg$/i ) {
228 qq-( $_ IS NULL OR $_ = '' )-;
230 qq-( $_ IS NULL OR $_ = "" )-;
237 $statement .= " $extra_sql" if defined($extra_sql);
239 warn "[debug]$me $statement\n" if $DEBUG;
240 my $sth = $dbh->prepare($statement)
241 or croak "$dbh->errstr doing $statement";
246 grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
248 if ( $record->{$field} =~ /^\d+(\.\d+)?$/
249 && $dbdef->table($table)->column($field)->type =~ /(int)/i
251 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_INTEGER } );
253 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_VARCHAR } );
257 # $sth->execute( map $record->{$_},
258 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
259 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
261 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
263 $dbh->commit or croak $dbh->errstr if $FS::UID::AutoCommit;
265 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
266 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
267 #derivied class didn't override new method, so this optimization is safe
270 new_or_cached( "FS::$table", { %{$_} }, $cache )
271 } @{$sth->fetchall_arrayref( {} )};
274 new( "FS::$table", { %{$_} } )
275 } @{$sth->fetchall_arrayref( {} )};
278 warn "untested code (class FS::$table uses custom new method)";
280 eval 'FS::'. $table. '->new( { %{$_} } )';
281 } @{$sth->fetchall_arrayref( {} )};
284 cluck "warning: FS::$table not loaded; returning FS::Record objects";
286 FS::Record->new( $table, { %{$_} } );
287 } @{$sth->fetchall_arrayref( {} )};
292 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
294 Experimental JOINed search method. Using this method, you can execute a
295 single SELECT spanning multiple tables, and cache the results for subsequent
296 method calls. Interface will almost definately change in an incompatible
304 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
305 my $cache = FS::SearchCache->new( $ptable, $pkey );
308 grep { !$saw{$_->getfield($pkey)}++ }
309 qsearch($table, $record, $select, $extra_sql, $cache )
313 =item qsearchs TABLE, HASHREF
315 Same as qsearch, except that if more than one record matches, it B<carp>s but
316 returns the first. If this happens, you either made a logic error in asking
317 for a single item, or your data is corrupted.
321 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
322 my(@result) = qsearch(@_);
323 carp "warning: Multiple records in scalar search!" if scalar(@result) > 1;
324 #should warn more vehemently if the search was on a primary key?
325 scalar(@result) ? ($result[0]) : ();
336 Returns the table name.
341 # cluck "warning: FS::Record::table depriciated; supply one in subclass!";
348 Returns the DBIx::DBSchema::Table object for the table.
354 my($table)=$self->table;
355 $dbdef->table($table);
358 =item get, getfield COLUMN
360 Returns the value of the column/field/key COLUMN.
365 my($self,$field) = @_;
366 # to avoid "Use of unitialized value" errors
367 if ( defined ( $self->{Hash}->{$field} ) ) {
368 $self->{Hash}->{$field};
378 =item set, setfield COLUMN, VALUE
380 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
385 my($self,$field,$value) = @_;
386 $self->{'Hash'}->{$field} = $value;
393 =item AUTLOADED METHODS
395 $record->column is a synonym for $record->get('column');
397 $record->column('value') is a synonym for $record->set('column','value');
404 my($field)=$AUTOLOAD;
406 if ( defined($value) ) {
407 confess "errant AUTOLOAD $field for $self (arg $value)"
408 unless $self->can('setfield');
409 $self->setfield($field,$value);
411 confess "errant AUTOLOAD $field for $self (no args)"
412 unless $self->can('getfield');
413 $self->getfield($field);
419 # my $field = $AUTOLOAD;
421 # if ( defined($_[1]) ) {
422 # $_[0]->setfield($field, $_[1]);
424 # $_[0]->getfield($field);
430 Returns a list of the column/value pairs, usually for assigning to a new hash.
432 To make a distinct duplicate of an FS::Record object, you can do:
434 $new = new FS::Record ( $old->table, { $old->hash } );
440 %{ $self->{'Hash'} };
445 Returns a reference to the column/value hash.
456 Inserts this record to the database. If there is an error, returns the error,
457 otherwise returns false.
464 my $error = $self->check;
465 return $error if $error;
467 #single-field unique keys are given a value if false
468 #(like MySQL's AUTO_INCREMENT)
469 foreach ( $self->dbdef_table->unique->singles ) {
470 $self->unique($_) unless $self->getfield($_);
472 #and also the primary key
473 my $primary_key = $self->dbdef_table->primary_key;
474 $self->unique($primary_key)
475 if $primary_key && ! $self->getfield($primary_key);
477 #false laziness w/delete
479 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
482 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
485 my $statement = "INSERT INTO ". $self->table. " ( ".
486 join( ', ', @fields ).
488 join( ', ', @values ).
491 warn "[debug]$me $statement\n" if $DEBUG;
492 my $sth = dbh->prepare($statement) or return dbh->errstr;
495 if ( defined $dbdef->table('h_'. $self->table) ) {
496 my $h_statement = $self->_h_statement('insert');
497 warn "[debug]$me $h_statement\n" if $DEBUG;
498 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
503 local $SIG{HUP} = 'IGNORE';
504 local $SIG{INT} = 'IGNORE';
505 local $SIG{QUIT} = 'IGNORE';
506 local $SIG{TERM} = 'IGNORE';
507 local $SIG{TSTP} = 'IGNORE';
508 local $SIG{PIPE} = 'IGNORE';
510 $sth->execute or return $sth->errstr;
511 $h_sth->execute or return $h_sth->errstr if $h_sth;
512 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
519 Depriciated (use insert instead).
524 cluck "warning: FS::Record::add depriciated!";
525 insert @_; #call method in this scope
530 Delete this record from the database. If there is an error, returns the error,
531 otherwise returns false.
538 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
540 $self->getfield($_) eq ''
541 #? "( $_ IS NULL OR $_ = \"\" )"
542 ? ( driver_name =~ /^Pg$/i
544 : "( $_ IS NULL OR $_ = \"\" )"
546 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
547 } ( $self->dbdef_table->primary_key )
548 ? ( $self->dbdef_table->primary_key)
551 warn "[debug]$me $statement\n" if $DEBUG;
552 my $sth = dbh->prepare($statement) or return dbh->errstr;
555 if ( defined $dbdef->table('h_'. $self->table) ) {
556 my $h_statement = $self->_h_statement('delete');
557 warn "[debug]$me $h_statement\n" if $DEBUG;
558 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
563 local $SIG{HUP} = 'IGNORE';
564 local $SIG{INT} = 'IGNORE';
565 local $SIG{QUIT} = 'IGNORE';
566 local $SIG{TERM} = 'IGNORE';
567 local $SIG{TSTP} = 'IGNORE';
568 local $SIG{PIPE} = 'IGNORE';
570 my $rc = $sth->execute or return $sth->errstr;
571 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
572 $h_sth->execute or return $h_sth->errstr if $h_sth;
573 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
575 #no need to needlessly destoy the data either (causes problems actually)
576 #undef $self; #no need to keep object!
583 Depriciated (use delete instead).
588 cluck "warning: FS::Record::del depriciated!";
589 &delete(@_); #call method in this scope
592 =item replace OLD_RECORD
594 Replace the OLD_RECORD with this one in the database. If there is an error,
595 returns the error, otherwise returns false.
600 my ( $new, $old ) = ( shift, shift );
601 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
603 return "Records not in same table!" unless $new->table eq $old->table;
605 my $primary_key = $old->dbdef_table->primary_key;
606 return "Can't change $primary_key"
608 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
610 my $error = $new->check;
611 return $error if $error;
613 my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
615 carp "[warning]$me $new -> replace $old: records identical";
619 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
621 "$_ = ". _quote($new->getfield($_),$old->table,$_)
626 $old->getfield($_) eq ''
627 #? "( $_ IS NULL OR $_ = \"\" )"
628 ? ( driver_name =~ /^Pg$/i
630 : "( $_ IS NULL OR $_ = \"\" )"
632 : "$_ = ". _quote($old->getfield($_),$old->table,$_)
633 } ( $primary_key ? ( $primary_key ) : $old->fields )
636 warn "[debug]$me $statement\n" if $DEBUG;
637 my $sth = dbh->prepare($statement) or return dbh->errstr;
640 if ( defined $dbdef->table('h_'. $old->table) ) {
641 my $h_old_statement = $old->_h_statement('replace_old');
642 warn "[debug]$me $h_old_statement\n" if $DEBUG;
643 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
649 if ( defined $dbdef->table('h_'. $new->table) ) {
650 my $h_new_statement = $new->_h_statement('replace_new');
651 warn "[debug]$me $h_new_statement\n" if $DEBUG;
652 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
657 local $SIG{HUP} = 'IGNORE';
658 local $SIG{INT} = 'IGNORE';
659 local $SIG{QUIT} = 'IGNORE';
660 local $SIG{TERM} = 'IGNORE';
661 local $SIG{TSTP} = 'IGNORE';
662 local $SIG{PIPE} = 'IGNORE';
664 my $rc = $sth->execute or return $sth->errstr;
665 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
666 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
667 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
668 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
676 Depriciated (use replace instead).
681 cluck "warning: FS::Record::rep depriciated!";
682 replace @_; #call method in this scope
687 Not yet implemented, croaks. Derived classes should provide a check method.
692 confess "FS::Record::check not implemented; supply one in subclass!";
696 my( $self, $action ) = @_;
699 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
702 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
704 "INSERT INTO h_". $self->table. " ( ".
705 join(', ', qw(history_date history_user history_action), @fields ).
707 join(', ', time, dbh->quote(getotaker()), dbh->quote($action), @values).
714 Replaces COLUMN in record with a unique number. Called by the B<add> method
715 on primary keys and single-field unique columns (see L<DBIx::DBSchema::Table>).
716 Returns the new value.
721 my($self,$field) = @_;
722 my($table)=$self->table;
724 croak("&FS::UID::checkruid failed") unless &checkruid;
726 croak "Unique called on field $field, but it is ",
727 $self->getfield($field),
729 if $self->getfield($field);
731 #warn "table $table is tainted" if is_tainted($table);
732 #warn "field $field is tainted" if is_tainted($field);
734 my($counter) = new File::CounterFile "$table.$field",0;
736 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
738 # my($counter) = new File::CounterFile "$user/$table.$field",0;
741 my($index)=$counter->inc;
743 while qsearchs($table,{$field=>$index}); #just in case
748 $self->setfield($field,$index);
752 =item ut_float COLUMN
754 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
755 null. If there is an error, returns the error, otherwise returns false.
760 my($self,$field)=@_ ;
761 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
762 $self->getfield($field) =~ /^(\d+)$/ ||
763 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
764 $self->getfield($field) =~ /^(\d+e\d+)$/)
765 or return "Illegal or empty (float) $field: ". $self->getfield($field);
766 $self->setfield($field,$1);
770 =item ut_number COLUMN
772 Check/untaint simple numeric data (whole numbers). May not be null. If there
773 is an error, returns the error, otherwise returns false.
779 $self->getfield($field) =~ /^(\d+)$/
780 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
781 $self->setfield($field,$1);
785 =item ut_numbern COLUMN
787 Check/untaint simple numeric data (whole numbers). May be null. If there is
788 an error, returns the error, otherwise returns false.
794 $self->getfield($field) =~ /^(\d*)$/
795 or return "Illegal (numeric) $field: ". $self->getfield($field);
796 $self->setfield($field,$1);
800 =item ut_money COLUMN
802 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
803 is an error, returns the error, otherwise returns false.
809 $self->setfield($field, 0) if $self->getfield($field) eq '';
810 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
811 or return "Illegal (money) $field: ". $self->getfield($field);
812 #$self->setfield($field, "$1$2$3" || 0);
813 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
819 Check/untaint text. Alphanumerics, spaces, and the following punctuation
820 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
821 May not be null. If there is an error, returns the error, otherwise returns
828 #warn "msgcat ". \&msgcat. "\n";
829 #warn "notexist ". \¬exist. "\n";
830 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
831 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]+)$/
832 or return gettext('illegal_or_empty_text'). " $field: ".
833 $self->getfield($field);
834 $self->setfield($field,$1);
838 =item ut_textn COLUMN
840 Check/untaint text. Alphanumerics, spaces, and the following punctuation
841 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
842 May be null. If there is an error, returns the error, otherwise returns false.
848 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]*)$/
849 or return gettext('illegal_text'). " $field: ". $self->getfield($field);
850 $self->setfield($field,$1);
854 =item ut_alpha COLUMN
856 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
857 an error, returns the error, otherwise returns false.
863 $self->getfield($field) =~ /^(\w+)$/
864 or return "Illegal or empty (alphanumeric) $field: ".
865 $self->getfield($field);
866 $self->setfield($field,$1);
870 =item ut_alpha COLUMN
872 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
873 error, returns the error, otherwise returns false.
879 $self->getfield($field) =~ /^(\w*)$/
880 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
881 $self->setfield($field,$1);
885 =item ut_phonen COLUMN [ COUNTRY ]
887 Check/untaint phone numbers. May be null. If there is an error, returns
888 the error, otherwise returns false.
890 Takes an optional two-letter ISO country code; without it or with unsupported
891 countries, ut_phonen simply calls ut_alphan.
896 my( $self, $field, $country ) = @_;
897 return $self->ut_alphan($field) unless defined $country;
898 my $phonen = $self->getfield($field);
899 if ( $phonen eq '' ) {
900 $self->setfield($field,'');
901 } elsif ( $country eq 'US' || $country eq 'CA' ) {
903 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
904 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
905 $phonen = "$1-$2-$3";
906 $phonen .= " x$4" if $4;
907 $self->setfield($field,$phonen);
909 warn "warning: don't know how to check phone numbers for country $country";
910 return $self->ut_textn($field);
917 Check/untaint ip addresses. IPv4 only for now.
922 my( $self, $field ) = @_;
923 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
924 or return "Illegal (IP address) $field: ". $self->getfield($field);
925 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
926 $self->setfield($field, "$1.$2.$3.$3");
932 Check/untaint ip addresses. IPv4 only for now. May be null.
937 my( $self, $field ) = @_;
938 if ( $self->getfield($field) =~ /^()$/ ) {
939 $self->setfield($field,'');
942 $self->ut_ip($field);
946 =item ut_domain COLUMN
948 Check/untaint host and domain names.
953 my( $self, $field ) = @_;
954 #$self->getfield($field) =~/^(\w+\.)*\w+$/
955 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
956 or return "Illegal (domain) $field: ". $self->getfield($field);
957 $self->setfield($field,$1);
963 Check/untaint proper names; allows alphanumerics, spaces and the following
971 my( $self, $field ) = @_;
972 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
973 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
974 $self->setfield($field,$1);
980 Check/untaint zip codes.
985 my( $self, $field, $country ) = @_;
986 if ( $country eq 'US' ) {
987 $self->getfield($field) =~ /\s*(\d{5}(\-\d{4})?)\s*$/
988 or return gettext('illegal_zip'). " $field for country $country: ".
989 $self->getfield($field);
990 $self->setfield($field,$1);
992 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
993 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
994 $self->setfield($field,$1);
999 =item ut_country COLUMN
1001 Check/untaint country codes. Country names are changed to codes, if possible -
1002 see L<Locale::Country>.
1007 my( $self, $field ) = @_;
1008 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
1009 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
1010 && country2code($1) ) {
1011 $self->setfield($field,uc(country2code($1)));
1014 $self->getfield($field) =~ /^(\w\w)$/
1015 or return "Illegal (country) $field: ". $self->getfield($field);
1016 $self->setfield($field,uc($1));
1020 =item ut_anything COLUMN
1022 Untaints arbitrary data. Be careful.
1027 my( $self, $field ) = @_;
1028 $self->getfield($field) =~ /^(.*)$/s
1029 or return "Illegal $field: ". $self->getfield($field);
1030 $self->setfield($field,$1);
1034 =item ut_enum COLUMN CHOICES_ARRAYREF
1036 Check/untaint a column, supplying all possible choices, like the "enum" type.
1041 my( $self, $field, $choices ) = @_;
1042 foreach my $choice ( @$choices ) {
1043 if ( $self->getfield($field) eq $choice ) {
1044 $self->setfield($choice);
1048 return "Illegal (enum) field $field: ". $self->getfield($field);
1051 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1053 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
1054 on the column first.
1058 sub ut_foreign_key {
1059 my( $self, $field, $table, $foreign ) = @_;
1060 qsearchs($table, { $foreign => $self->getfield($field) })
1061 or return "Can't find $field ". $self->getfield($field).
1062 " in $table.$foreign";
1066 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1068 Like ut_foreign_key, except the null value is also allowed.
1072 sub ut_foreign_keyn {
1073 my( $self, $field, $table, $foreign ) = @_;
1074 $self->getfield($field)
1075 ? $self->ut_foreign_key($field, $table, $foreign)
1079 =item fields [ TABLE ]
1081 This can be used as both a subroutine and a method call. It returns a list
1082 of the columns in this record's table, or an explicitly specified table.
1083 (See L<DBIx::DBSchema::Table>).
1087 # Usage: @fields = fields($table);
1088 # @fields = $record->fields;
1090 my $something = shift;
1092 if ( ref($something) ) {
1093 $table = $something->table;
1095 $table = $something;
1097 #croak "Usage: \@fields = fields(\$table)\n or: \@fields = \$record->fields" unless $table;
1098 my($table_obj) = $dbdef->table($table);
1099 confess "Unknown table $table" unless $table_obj;
1100 $table_obj->columns;
1109 =item reload_dbdef([FILENAME])
1111 Load a database definition (see L<DBIx::DBSchema>), optionally from a
1112 non-default filename. This command is executed at startup unless
1113 I<$FS::Record::setup_hack> is true. Returns a DBIx::DBSchema object.
1118 my $file = shift || $dbdef_file;
1119 $dbdef = load DBIx::DBSchema $file
1120 or die "can't load database schema from $file";
1125 Returns the current database definition. See L<DBIx::DBSchema>.
1129 sub dbdef { $dbdef; }
1131 =item _quote VALUE, TABLE, COLUMN
1133 This is an internal function used to construct SQL statements. It returns
1134 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
1135 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
1140 my($value,$table,$field)=@_;
1142 if ( $value =~ /^\d+(\.\d+)?$/ &&
1143 # ! ( datatype($table,$field) =~ /^char/ )
1144 ! ( $dbdef->table($table)->column($field)->type =~ /(char|binary)$/i )
1148 $dbh->quote($value);
1154 This is depriciated. Don't use it.
1156 It returns a hash-type list with the fields of this record's table set true.
1161 carp "warning: hfields is depriciated";
1164 foreach (fields($table)) {
1173 "$_: ". $self->getfield($_). "|"
1174 } (fields($self->table)) );
1177 sub DESTROY { return; }
1181 # #use Carp qw(cluck);
1182 # #cluck "DESTROYING $self";
1183 # warn "DESTROYING $self";
1187 # return ! eval { join('',@_), kill 0; 1; };
1194 This module should probably be renamed, since much of the functionality is
1195 of general use. It is not completely unlike Adapter::DBI (see below).
1197 Exported qsearch and qsearchs should be depriciated in favor of method calls
1198 (against an FS::Record object like the old search and searchs that qsearch
1199 and qsearchs were on top of.)
1201 The whole fields / hfields mess should be removed.
1203 The various WHERE clauses should be subroutined.
1205 table string should be depriciated in favor of DBIx::DBSchema::Table.
1207 No doubt we could benefit from a Tied hash. Documenting how exists / defined
1208 true maps to the database (and WHERE clauses) would also help.
1210 The ut_ methods should ask the dbdef for a default length.
1212 ut_sqltype (like ut_varchar) should all be defined
1214 A fallback check method should be provided which uses the dbdef.
1216 The ut_money method assumes money has two decimal digits.
1218 The Pg money kludge in the new method only strips `$'.
1220 The ut_phonen method only checks US-style phone numbers.
1222 The _quote function should probably use ut_float instead of a regex.
1224 All the subroutines probably should be methods, here or elsewhere.
1226 Probably should borrow/use some dbdef methods where appropriate (like sub
1229 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
1230 or allow it to be set. Working around it is ugly any way around - DBI should
1231 be fixed. (only affects RDBMS which return uppercase column names)
1233 ut_zip should take an optional country like ut_phone.
1237 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
1239 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.