4 use vars qw($dbdef_file $dbdef $setup_hack $AUTOLOAD @ISA @EXPORT_OK $DEBUG);
5 use subs qw(reload_dbdef);
7 use Carp qw(carp cluck croak confess);
9 use FS::UID qw(dbh checkruid swapuid getotaker datasrc driver_name);
13 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef);
17 #ask FS::UID to run this stuff for us later
18 $FS::UID::callback{'FS::Record'} = sub {
19 $File::CounterFile::DEFAULT_DIR = "/usr/local/etc/freeside/counters.". datasrc;
20 $dbdef_file = "/usr/local/etc/freeside/dbdef.". datasrc;
21 &reload_dbdef unless $setup_hack; #$setup_hack needed now?
26 FS::Record - Database record objects
31 use FS::Record qw(dbh fields qsearch qsearchs dbdef);
33 $record = new FS::Record 'table', \%hash;
34 $record = new FS::Record 'table', { 'column' => 'value', ... };
36 $record = qsearchs FS::Record 'table', \%hash;
37 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
38 @records = qsearch FS::Record 'table', \%hash;
39 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
41 $table = $record->table;
42 $dbdef_table = $record->dbdef_table;
44 $value = $record->get('column');
45 $value = $record->getfield('column');
46 $value = $record->column;
48 $record->set( 'column' => 'value' );
49 $record->setfield( 'column' => 'value' );
50 $record->column('value');
52 %hash = $record->hash;
54 $hashref = $record->hashref;
56 $error = $record->insert;
57 #$error = $record->add; #depriciated
59 $error = $record->delete;
60 #$error = $record->del; #depriciated
62 $error = $new_record->replace($old_record);
63 #$error = $new_record->rep($old_record); #depriciated
65 $value = $record->unique('column');
67 $value = $record->ut_float('column');
68 $value = $record->ut_number('column');
69 $value = $record->ut_numbern('column');
70 $value = $record->ut_money('column');
71 $value = $record->ut_text('column');
72 $value = $record->ut_textn('column');
73 $value = $record->ut_alpha('column');
74 $value = $record->ut_alphan('column');
75 $value = $record->ut_phonen('column');
76 $value = $record->ut_anythingn('column');
78 $dbdef = reload_dbdef;
79 $dbdef = reload_dbdef "/non/standard/filename";
82 $quoted_value = _quote($value,'table','field');
85 $fields = hfields('table');
86 if ( $fields->{Field} ) { # etc.
88 @fields = fields 'table'; #as a subroutine
89 @fields = $record->fields; #as a method call
94 (Mostly) object-oriented interface to database records. Records are currently
95 implemented on top of DBI. FS::Record is intended as a base class for
96 table-specific classes to inherit from, i.e. FS::cust_main.
102 =item new [ TABLE, ] HASHREF
104 Creates a new record. It doesn't store it in the database, though. See
105 L<"insert"> for that.
107 Note that the object stores this hash reference, not a distinct copy of the
108 hash it points to. You can ask the object for a copy with the I<hash>
111 TABLE can only be omitted when a dervived class overrides the table method.
117 my $class = ref($proto) || $proto;
119 bless ($self, $class);
121 $self->{'Table'} = shift unless defined ( $self->table );
123 my $hashref = $self->{'Hash'} = shift;
125 foreach my $field ( $self->fields ) {
126 $hashref->{$field}='' unless defined $hashref->{$field};
127 #trim the '$' and ',' from money fields for Pg (belong HERE?)
128 #(what about Pg i18n?)
129 if ( driver_name eq 'Pg'
130 && $self->dbdef_table->column($field)->type eq 'money' ) {
131 ${$hashref}{$field} =~ s/^\$//;
132 ${$hashref}{$field} =~ s/\,//;
141 my $class = ref($proto) || $proto;
143 bless ($self, $class);
144 if ( defined $self->table ) {
145 cluck "create constructor is depriciated, use new!";
148 croak "FS::Record::create called (not from a subclass)!";
152 =item qsearch TABLE, HASHREF
154 Searches the database for all records matching (at least) the key/value pairs
155 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
156 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
162 my($table, $record) = @_;
165 my @fields = grep exists($record->{$_}), fields($table);
167 my $statement = "SELECT * FROM $table";
169 $statement .= " WHERE ". join(' AND ', map {
170 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
171 if ( driver_name eq 'Pg' ) {
174 qq-( $_ IS NULL OR $_ = "" )-;
182 warn $statement if $DEBUG;
183 my $sth = $dbh->prepare_cached($statement) or croak $dbh->errstr;
185 $sth->execute( map $record->{$_},
186 grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
187 ) or croak $dbh->errstr;
189 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
190 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
191 #derivied class didn't override new method, so this optimization is safe
193 new( "FS::$table", { %{$_} } )
194 } @{$sth->fetchall_arrayref( {} )};
196 warn "untested code (class FS::$table uses custom new method)";
198 eval 'FS::'. $table. '->new( { %{$_} } )';
199 } @{$sth->fetchall_arrayref( {} )};
202 cluck "warning: FS::$table not loaded; returning FS::Record objects";
204 FS::Record->new( $table, { %{$_} } );
205 } @{$sth->fetchall_arrayref( {} )};
210 =item qsearchs TABLE, HASHREF
212 Same as qsearch, except that if more than one record matches, it B<carp>s but
213 returns the first. If this happens, you either made a logic error in asking
214 for a single item, or your data is corrupted.
218 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
219 my(@result) = qsearch(@_);
220 carp "warning: Multiple records in scalar search!" if scalar(@result) > 1;
221 #should warn more vehemently if the search was on a primary key?
222 scalar(@result) ? ($result[0]) : ();
233 Returns the table name.
238 # cluck "warning: FS::Record::table depriciated; supply one in subclass!";
245 Returns the FS::dbdef_table object for the table.
251 my($table)=$self->table;
252 $dbdef->table($table);
255 =item get, getfield COLUMN
257 Returns the value of the column/field/key COLUMN.
262 my($self,$field) = @_;
263 # to avoid "Use of unitialized value" errors
264 if ( defined ( $self->{Hash}->{$field} ) ) {
265 $self->{Hash}->{$field};
275 =item set, setfield COLUMN, VALUE
277 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
282 my($self,$field,$value) = @_;
283 $self->{'Hash'}->{$field} = $value;
290 =item AUTLOADED METHODS
292 $record->column is a synonym for $record->get('column');
294 $record->column('value') is a synonym for $record->set('column','value');
300 my($field)=$AUTOLOAD;
302 if ( defined($value) ) {
303 $self->setfield($field,$value);
305 $self->getfield($field);
311 Returns a list of the column/value pairs, usually for assigning to a new hash.
313 To make a distinct duplicate of an FS::Record object, you can do:
315 $new = new FS::Record ( $old->table, { $old->hash } );
321 %{ $self->{'Hash'} };
326 Returns a reference to the column/value hash.
337 Inserts this record to the database. If there is an error, returns the error,
338 otherwise returns false.
345 my $error = $self->check;
346 return $error if $error;
348 #single-field unique keys are given a value if false
349 #(like MySQL's AUTO_INCREMENT)
350 foreach ( $self->dbdef_table->unique->singles ) {
351 $self->unique($_) unless $self->getfield($_);
353 #and also the primary key
354 my $primary_key = $self->dbdef_table->primary_key;
355 $self->unique($primary_key)
356 if $primary_key && ! $self->getfield($primary_key);
359 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
363 my $statement = "INSERT INTO ". $self->table. " ( ".
366 join(', ',map(_quote($self->getfield($_),$self->table,$_), @fields)).
369 my $sth = dbh->prepare($statement) or return dbh->errstr;
371 local $SIG{HUP} = 'IGNORE';
372 local $SIG{INT} = 'IGNORE';
373 local $SIG{QUIT} = 'IGNORE';
374 local $SIG{TERM} = 'IGNORE';
375 local $SIG{TSTP} = 'IGNORE';
376 local $SIG{PIPE} = 'IGNORE';
378 $sth->execute or return $sth->errstr;
385 Depriciated (use insert instead).
390 cluck "warning: FS::Record::add depriciated!";
391 insert @_; #call method in this scope
396 Delete this record from the database. If there is an error, returns the error,
397 otherwise returns false.
404 my($statement)="DELETE FROM ". $self->table. " WHERE ". join(' AND ',
406 $self->getfield($_) eq ''
407 #? "( $_ IS NULL OR $_ = \"\" )"
408 ? ( driver_name eq 'Pg'
410 : "( $_ IS NULL OR $_ = \"\" )"
412 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
413 } ( $self->dbdef_table->primary_key )
414 ? ( $self->dbdef_table->primary_key)
417 my $sth = dbh->prepare($statement) or return dbh->errstr;
419 local $SIG{HUP} = 'IGNORE';
420 local $SIG{INT} = 'IGNORE';
421 local $SIG{QUIT} = 'IGNORE';
422 local $SIG{TERM} = 'IGNORE';
423 local $SIG{TSTP} = 'IGNORE';
424 local $SIG{PIPE} = 'IGNORE';
426 my $rc = $sth->execute or return $sth->errstr;
427 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
429 undef $self; #no need to keep object!
436 Depriciated (use delete instead).
441 cluck "warning: FS::Record::del depriciated!";
442 &delete(@_); #call method in this scope
445 =item replace OLD_RECORD
447 Replace the OLD_RECORD with this one in the database. If there is an error,
448 returns the error, otherwise returns false.
453 my ( $new, $old ) = ( shift, shift );
455 my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
457 carp "warning: records identical";
461 return "Records not in same table!" unless $new->table eq $old->table;
463 my $primary_key = $old->dbdef_table->primary_key;
464 return "Can't change $primary_key"
466 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
468 my $error = $new->check;
469 return $error if $error;
471 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
473 "$_ = ". _quote($new->getfield($_),$old->table,$_)
478 $old->getfield($_) eq ''
479 #? "( $_ IS NULL OR $_ = \"\" )"
480 ? ( driver_name eq 'Pg'
482 : "( $_ IS NULL OR $_ = \"\" )"
484 : "$_ = ". _quote($old->getfield($_),$old->table,$_)
485 } ( $primary_key ? ( $primary_key ) : $old->fields )
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 my $rc = $sth->execute or return $sth->errstr;
498 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
506 Depriciated (use replace instead).
511 cluck "warning: FS::Record::rep depriciated!";
512 replace @_; #call method in this scope
517 Not yet implemented, croaks. Derived classes should provide a check method.
522 confess "FS::Record::check not implemented; supply one in subclass!";
527 Replaces COLUMN in record with a unique number. Called by the B<add> method
528 on primary keys and single-field unique columns (see L<FS::dbdef_table>).
529 Returns the new value.
534 my($self,$field) = @_;
535 my($table)=$self->table;
537 croak("&FS::UID::checkruid failed") unless &checkruid;
539 croak "Unique called on field $field, but it is ",
540 $self->getfield($field),
542 if $self->getfield($field);
544 #warn "table $table is tainted" if is_tainted($table);
545 #warn "field $field is tainted" if is_tainted($field);
548 my($counter) = new File::CounterFile "$table.$field",0;
550 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
552 # my($counter) = new File::CounterFile "$user/$table.$field",0;
555 my($index)=$counter->inc;
557 while qsearchs($table,{$field=>$index}); #just in case
563 $self->setfield($field,$index);
567 =item ut_float COLUMN
569 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
570 null. If there is an error, returns the error, otherwise returns false.
575 my($self,$field)=@_ ;
576 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
577 $self->getfield($field) =~ /^(\d+)$/ ||
578 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
579 $self->getfield($field) =~ /^(\d+e\d+)$/)
580 or return "Illegal or empty (float) $field: ". $self->getfield($field);
581 $self->setfield($field,$1);
585 =item ut_number COLUMN
587 Check/untaint simple numeric data (whole numbers). May not be null. If there
588 is an error, returns the error, otherwise returns false.
594 $self->getfield($field) =~ /^(\d+)$/
595 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
596 $self->setfield($field,$1);
600 =item ut_numbern COLUMN
602 Check/untaint simple numeric data (whole numbers). May be null. If there is
603 an error, returns the error, otherwise returns false.
609 $self->getfield($field) =~ /^(\d*)$/
610 or return "Illegal (numeric) $field: ". $self->getfield($field);
611 $self->setfield($field,$1);
615 =item ut_money COLUMN
617 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
618 is an error, returns the error, otherwise returns false.
624 $self->setfield($field, 0) if $self->getfield($field) eq '';
625 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
626 or return "Illegal (money) $field: ". $self->getfield($field);
627 #$self->setfield($field, "$1$2$3" || 0);
628 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
634 Check/untaint text. Alphanumerics, spaces, and the following punctuation
635 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
636 May not be null. If there is an error, returns the error, otherwise returns
643 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]+)$/
644 or return "Illegal or empty (text) $field: ". $self->getfield($field);
645 $self->setfield($field,$1);
649 =item ut_textn COLUMN
651 Check/untaint text. Alphanumerics, spaces, and the following punctuation
652 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
653 May be null. If there is an error, returns the error, otherwise returns false.
659 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]*)$/
660 or return "Illegal (text) $field: ". $self->getfield($field);
661 $self->setfield($field,$1);
665 =item ut_alpha COLUMN
667 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
668 an error, returns the error, otherwise returns false.
674 $self->getfield($field) =~ /^(\w+)$/
675 or return "Illegal or empty (alphanumeric) $field: ".
676 $self->getfield($field);
677 $self->setfield($field,$1);
681 =item ut_alpha COLUMN
683 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
684 error, returns the error, otherwise returns false.
690 $self->getfield($field) =~ /^(\w*)$/
691 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
692 $self->setfield($field,$1);
696 =item ut_phonen COLUMN [ COUNTRY ]
698 Check/untaint phone numbers. May be null. If there is an error, returns
699 the error, otherwise returns false.
701 Takes an optional two-letter ISO country code; without it or with unsupported
702 countries, ut_phonen simply calls ut_alphan.
707 my( $self, $field, $country ) = @_;
708 return $self->ut_alphan($field) unless defined $country;
709 my $phonen = $self->getfield($field);
710 if ( $phonen eq '' ) {
711 $self->setfield($field,'');
712 } elsif ( $country eq 'US' ) {
714 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
715 or return "Illegal (phone) $field: ". $self->getfield($field);
716 $phonen = "$1-$2-$3";
717 $phonen .= " x$4" if $4;
718 $self->setfield($field,$phonen);
720 warn "don't know how to check phone numbers for country $country";
721 return $self->ut_alphan($field);
726 =item ut_anything COLUMN
728 Untaints arbitrary data. Be careful.
734 $self->getfield($field) =~ /^(.*)$/
735 or return "Illegal $field: ". $self->getfield($field);
736 $self->setfield($field,$1);
740 =item fields [ TABLE ]
742 This can be used as both a subroutine and a method call. It returns a list
743 of the columns in this record's table, or an explicitly specified table.
744 (See L<FS::dbdef_table>).
748 # Usage: @fields = fields($table);
749 # @fields = $record->fields;
751 my $something = shift;
753 if ( ref($something) ) {
754 $table = $something->table;
758 #croak "Usage: \@fields = fields(\$table)\n or: \@fields = \$record->fields" unless $table;
759 my($table_obj) = $dbdef->table($table);
760 croak "Unknown table $table" unless $table_obj;
768 =item reload_dbdef([FILENAME])
770 Load a database definition (see L<FS::dbdef>), optionally from a non-default
771 filename. This command is executed at startup unless
772 I<$FS::Record::setup_hack> is true. Returns a FS::dbdef object.
777 my $file = shift || $dbdef_file;
778 $dbdef = load FS::dbdef ($file);
783 Returns the current database definition. See L<FS::dbdef>.
787 sub dbdef { $dbdef; }
789 =item _quote VALUE, TABLE, COLUMN
791 This is an internal function used to construct SQL statements. It returns
792 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
793 type (see L<FS::dbdef_column>) does not end in `char' or `binary'.
798 my($value,$table,$field)=@_;
800 if ( $value =~ /^\d+(\.\d+)?$/ &&
801 # ! ( datatype($table,$field) =~ /^char/ )
802 ! ( $dbdef->table($table)->column($field)->type =~ /(char|binary)$/i )
812 This is depriciated. Don't use it.
814 It returns a hash-type list with the fields of this record's table set true.
819 carp "warning: hfields is depriciated";
822 foreach (fields($table)) {
831 # "$_: ". $self->getfield($_). "|"
832 # } (fields($self->table)) );
837 # #use Carp qw(cluck);
838 # #cluck "DESTROYING $self";
839 # warn "DESTROYING $self";
843 # return ! eval { join('',@_), kill 0; 1; };
850 $Id: Record.pm,v 1.7 2000-06-27 12:15:37 ivan Exp $
854 This module should probably be renamed, since much of the functionality is
855 of general use. It is not completely unlike Adapter::DBI (see below).
857 Exported qsearch and qsearchs should be depriciated in favor of method calls
858 (against an FS::Record object like the old search and searchs that qsearch
859 and qsearchs were on top of.)
861 The whole fields / hfields mess should be removed.
863 The various WHERE clauses should be subroutined.
865 table string should be depriciated in favor of FS::dbdef_table.
867 No doubt we could benefit from a Tied hash. Documenting how exists / defined
868 true maps to the database (and WHERE clauses) would also help.
870 The ut_ methods should ask the dbdef for a default length.
872 ut_sqltype (like ut_varchar) should all be defined
874 A fallback check method should be provided which uses the dbdef.
876 The ut_money method assumes money has two decimal digits.
878 The Pg money kludge in the new method only strips `$'.
880 The ut_phonen method assumes US-style phone numbers.
882 The _quote function should probably use ut_float instead of a regex.
884 All the subroutines probably should be methods, here or elsewhere.
886 Probably should borrow/use some dbdef methods where appropriate (like sub
889 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
890 or allow it to be set. Working around it is ugly any way around - DBI should
891 be fixed. (only affects RDBMS which return uppercase column names)
895 L<FS::dbdef>, L<FS::UID>, L<DBI>
897 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.