4 use vars qw($dbdef_file $dbdef $setup_hack $AUTOLOAD @ISA @EXPORT_OK);
5 use subs qw(reload_dbdef);
7 use Carp qw(carp cluck croak confess);
9 use FS::UID qw(dbh checkruid swapuid getotaker datasrc);
13 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef);
15 #ask FS::UID to run this stuff for us later
16 $FS::UID::callback{'FS::Record'} = sub {
17 $File::CounterFile::DEFAULT_DIR = "/usr/local/etc/freeside/counters.". datasrc;
18 $dbdef_file = "/usr/local/etc/freeside/dbdef.". datasrc;
19 &reload_dbdef unless $setup_hack; #$setup_hack needed now?
24 FS::Record - Database record objects
29 use FS::Record qw(dbh fields qsearch qsearchs dbdef);
31 $record = new FS::Record 'table', \%hash;
32 $record = new FS::Record 'table', { 'column' => 'value', ... };
34 $record = qsearchs FS::Record 'table', \%hash;
35 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
36 @records = qsearch FS::Record 'table', \%hash;
37 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
39 $table = $record->table;
40 $dbdef_table = $record->dbdef_table;
42 $value = $record->get('column');
43 $value = $record->getfield('column');
44 $value = $record->column;
46 $record->set( 'column' => 'value' );
47 $record->setfield( 'column' => 'value' );
48 $record->column('value');
50 %hash = $record->hash;
52 $hashref = $record->hashref;
54 $error = $record->insert;
55 #$error = $record->add; #depriciated
57 $error = $record->delete;
58 #$error = $record->del; #depriciated
60 $error = $new_record->replace($old_record);
61 #$error = $new_record->rep($old_record); #depriciated
63 $value = $record->unique('column');
65 $value = $record->ut_float('column');
66 $value = $record->ut_number('column');
67 $value = $record->ut_numbern('column');
68 $value = $record->ut_money('column');
69 $value = $record->ut_text('column');
70 $value = $record->ut_textn('column');
71 $value = $record->ut_alpha('column');
72 $value = $record->ut_alphan('column');
73 $value = $record->ut_phonen('column');
74 $value = $record->ut_anythingn('column');
76 $dbdef = reload_dbdef;
77 $dbdef = reload_dbdef "/non/standard/filename";
80 $quoted_value = _quote($value,'table','field');
83 $fields = hfields('table');
84 if ( $fields->{Field} ) { # etc.
86 @fields = fields 'table'; #as a subroutine
87 @fields = $record->fields; #as a method call
92 (Mostly) object-oriented interface to database records. Records are currently
93 implemented on top of DBI. FS::Record is intended as a base class for
94 table-specific classes to inherit from, i.e. FS::cust_main.
100 =item new [ TABLE, ] HASHREF
102 Creates a new record. It doesn't store it in the database, though. See
103 L<"insert"> for that.
105 Note that the object stores this hash reference, not a distinct copy of the
106 hash it points to. You can ask the object for a copy with the I<hash>
109 TABLE can only be omitted when a dervived class overrides the table method.
115 my $class = ref($proto) || $proto;
117 bless ($self, $class);
119 $self->{'Table'} = shift unless defined ( $self->table );
121 my $hashref = $self->{'Hash'} = shift;
123 foreach my $field ( $self->fields ) {
124 $hashref->{$field}='' unless defined $hashref->{$field};
125 #trim the '$' from money fields for Pg (belong HERE?)
126 #(what about Pg i18n?)
127 if ( datasrc =~ m/Pg/
128 && $self->dbdef_table->column($field)->type eq 'money' ) {
129 ${$hashref}{$field} =~ s/^\$//;
138 my $class = ref($proto) || $proto;
140 bless ($self, $class);
141 if ( defined $self->table ) {
142 cluck "create constructor is depriciated, use new!";
145 croak "FS::Record::create called (not from a subclass)!";
149 =item qsearch TABLE, HASHREF
151 Searches the database for all records matching (at least) the key/value pairs
152 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
153 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
159 my($table,$record) = @_;
162 my(@fields)=grep exists($record->{$_}), fields($table);
165 my($statement) = "SELECT * FROM $table". ( @fields
166 ? " WHERE ". join(' AND ',
169 ? "( $_ IS NULL OR $_ = \"\" )"
170 : "$_ = ". _quote($record->{$_},$table,$_)
174 $sth=$dbh->prepare($statement)
175 or croak $dbh->errstr; #is that a little too harsh? hmm.
177 if ( eval ' scalar(@FS::'. $table. '::ISA);' ) {
179 eval 'new FS::'. $table. ' ( $sth->fetchrow_hashref );';
180 } ( 1 .. $sth->execute );
182 cluck "qsearch: warning: FS::$table not loaded; returning generic FS::Record objects";
184 new FS::Record ($table,$sth->fetchrow_hashref);
185 } ( 1 .. $sth->execute );
190 =item qsearchs TABLE, HASHREF
192 Same as qsearch, except that if more than one record matches, it B<carp>s but
193 returns the first. If this happens, you either made a logic error in asking
194 for a single item, or your data is corrupted.
198 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
199 my(@result) = qsearch(@_);
200 carp "warning: Multiple records in scalar search!" if scalar(@result) > 1;
201 #should warn more vehemently if the search was on a primary key?
213 Returns the table name.
218 # cluck "warning: FS::Record::table depriciated; supply one in subclass!";
225 Returns the FS::dbdef_table object for the table.
231 my($table)=$self->table;
232 $dbdef->table($table);
235 =item get, getfield COLUMN
237 Returns the value of the column/field/key COLUMN.
242 my($self,$field) = @_;
243 # to avoid "Use of unitialized value" errors
244 if ( defined ( $self->{Hash}->{$field} ) ) {
245 $self->{Hash}->{$field};
255 =item set, setfield COLUMN, VALUE
257 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
262 my($self,$field,$value) = @_;
263 $self->{'Hash'}->{$field} = $value;
270 =item AUTLOADED METHODS
272 $record->column is a synonym for $record->get('column');
274 $record->column('value') is a synonym for $record->set('column','value');
280 my($field)=$AUTOLOAD;
282 if ( defined($value) ) {
283 $self->setfield($field,$value);
285 $self->getfield($field);
291 Returns a list of the column/value pairs, usually for assigning to a new hash.
293 To make a distinct duplicate of an FS::Record object, you can do:
295 $new = new FS::Record ( $old->table, { $old->hash } );
301 %{ $self->{'Hash'} };
306 Returns a reference to the column/value hash.
317 Inserts this record to the database. If there is an error, returns the error,
318 otherwise returns false.
325 my $error = $self->check;
326 return $error if $error;
328 #single-field unique keys are given a value if false
329 #(like MySQL's AUTO_INCREMENT)
330 foreach ( $self->dbdef_table->unique->singles ) {
331 $self->unique($_) unless $self->getfield($_);
333 #and also the primary key
334 my $primary_key = $self->dbdef_table->primary_key;
335 $self->unique($primary_key)
336 if $primary_key && ! $self->getfield($primary_key);
339 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
343 my $statement = "INSERT INTO ". $self->table. " ( ".
346 join(', ',map(_quote($self->getfield($_),$self->table,$_), @fields)).
349 my $sth = dbh->prepare($statement) or return dbh->errstr;
351 local $SIG{HUP} = 'IGNORE';
352 local $SIG{INT} = 'IGNORE';
353 local $SIG{QUIT} = 'IGNORE';
354 local $SIG{TERM} = 'IGNORE';
355 local $SIG{TSTP} = 'IGNORE';
356 local $SIG{PIPE} = 'IGNORE';
358 $sth->execute or return $sth->errstr;
365 Depriciated (use insert instead).
370 cluck "warning: FS::Record::add depriciated!";
371 insert @_; #call method in this scope
376 Delete this record from the database. If there is an error, returns the error,
377 otherwise returns false.
384 my($statement)="DELETE FROM ". $self->table. " WHERE ". join(' AND ',
386 $self->getfield($_) eq ''
387 ? "( $_ IS NULL OR $_ = \"\" )"
388 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
389 } ( $self->dbdef_table->primary_key )
390 ? ( $self->dbdef_table->primary_key)
393 my $sth = dbh->prepare($statement) or return dbh->errstr;
395 local $SIG{HUP} = 'IGNORE';
396 local $SIG{INT} = 'IGNORE';
397 local $SIG{QUIT} = 'IGNORE';
398 local $SIG{TERM} = 'IGNORE';
399 local $SIG{TSTP} = 'IGNORE';
400 local $SIG{PIPE} = 'IGNORE';
402 my $rc = $sth->execute or return $sth->errstr;
403 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
405 undef $self; #no need to keep object!
412 Depriciated (use delete instead).
417 cluck "warning: FS::Record::del depriciated!";
418 &delete(@_); #call method in this scope
421 =item replace OLD_RECORD
423 Replace the OLD_RECORD with this one in the database. If there is an error,
424 returns the error, otherwise returns false.
429 my ( $new, $old ) = ( shift, shift );
431 my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
433 carp "warning: records identical";
437 return "Records not in same table!" unless $new->table eq $old->table;
439 my $primary_key = $old->dbdef_table->primary_key;
440 return "Can't change $primary_key"
442 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
444 my $error = $new->check;
445 return $error if $error;
447 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
449 "$_ = ". _quote($new->getfield($_),$old->table,$_)
454 $old->getfield($_) eq ''
455 ? "( $_ IS NULL OR $_ = \"\" )"
456 : "$_ = ". _quote($old->getfield($_),$old->table,$_)
457 } ( $primary_key ? ( $primary_key ) : $old->fields )
460 my $sth = dbh->prepare($statement) or return dbh->errstr;
462 local $SIG{HUP} = 'IGNORE';
463 local $SIG{INT} = 'IGNORE';
464 local $SIG{QUIT} = 'IGNORE';
465 local $SIG{TERM} = 'IGNORE';
466 local $SIG{TSTP} = 'IGNORE';
467 local $SIG{PIPE} = 'IGNORE';
469 my $rc = $sth->execute or return $sth->errstr;
470 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
478 Depriciated (use replace instead).
483 cluck "warning: FS::Record::rep depriciated!";
484 replace @_; #call method in this scope
489 Not yet implemented, croaks. Derived classes should provide a check method.
494 croak "FS::Record::check not implemented; supply one in subclass!";
499 Replaces COLUMN in record with a unique number. Called by the B<add> method
500 on primary keys and single-field unique columns (see L<FS::dbdef_table>).
501 Returns the new value.
506 my($self,$field) = @_;
507 my($table)=$self->table;
509 croak("&FS::UID::checkruid failed") unless &checkruid;
511 croak "Unique called on field $field, but it is ",
512 $self->getfield($field),
514 if $self->getfield($field);
516 #warn "table $table is tainted" if is_tainted($table);
517 #warn "field $field is tainted" if is_tainted($field);
520 my($counter) = new File::CounterFile "$table.$field",0;
522 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
524 # my($counter) = new File::CounterFile "$user/$table.$field",0;
527 my($index)=$counter->inc;
529 while qsearchs($table,{$field=>$index}); #just in case
535 $self->setfield($field,$index);
539 =item ut_float COLUMN
541 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
542 null. If there is an error, returns the error, otherwise returns false.
547 my($self,$field)=@_ ;
548 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
549 $self->getfield($field) =~ /^(\d+)$/ ||
550 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
551 $self->getfield($field) =~ /^(\d+e\d+)$/)
552 or return "Illegal or empty (float) $field!";
553 $self->setfield($field,$1);
557 =item ut_number COLUMN
559 Check/untaint simple numeric data (whole numbers). May not be null. If there
560 is an error, returns the error, otherwise returns false.
566 $self->getfield($field) =~ /^(\d+)$/
567 or return "Illegal or empty (numeric) $field!";
568 $self->setfield($field,$1);
572 =item ut_numbern COLUMN
574 Check/untaint simple numeric data (whole numbers). May be null. If there is
575 an error, returns the error, otherwise returns false.
581 $self->getfield($field) =~ /^(\d*)$/
582 or return "Illegal (numeric) $field!";
583 $self->setfield($field,$1);
587 =item ut_money COLUMN
589 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
590 is an error, returns the error, otherwise returns false.
596 $self->setfield($field, 0) if $self->getfield($field) eq '';
597 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
598 or return "Illegal (money) $field!";
599 $self->setfield($field, "$1$2$3" || 0);
605 Check/untaint text. Alphanumerics, spaces, and the following punctuation
606 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
607 May not be null. If there is an error, returns the error, otherwise returns
614 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]+)$/
615 or return "Illegal or empty (text) $field";
616 $self->setfield($field,$1);
620 =item ut_textn COLUMN
622 Check/untaint text. Alphanumerics, spaces, and the following punctuation
623 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
624 May be null. If there is an error, returns the error, otherwise returns false.
630 $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]*)$/
631 or return "Illegal (text) $field";
632 $self->setfield($field,$1);
636 =item ut_alpha COLUMN
638 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
639 an error, returns the error, otherwise returns false.
645 $self->getfield($field) =~ /^(\w+)$/
646 or return "Illegal or empty (alphanumeric) $field!";
647 $self->setfield($field,$1);
651 =item ut_alpha COLUMN
653 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
654 error, returns the error, otherwise returns false.
660 $self->getfield($field) =~ /^(\w*)$/
661 or return "Illegal (alphanumeric) $field!";
662 $self->setfield($field,$1);
666 =item ut_phonen COLUMN
668 Check/untaint phone numbers. May be null. If there is an error, returns
669 the error, otherwise returns false.
675 my $phonen = $self->getfield($field);
676 if ( $phonen eq '' ) {
677 $self->setfield($field,'');
680 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
681 or return "Illegal (phone) $field!";
682 $phonen = "$1-$2-$3";
683 $phonen .= " x$4" if $4;
684 $self->setfield($field,$phonen);
689 =item ut_anything COLUMN
691 Untaints arbitrary data. Be careful.
697 $self->getfield($field) =~ /^(.*)$/ or return "Illegal $field!";
698 $self->setfield($field,$1);
702 =item fields [ TABLE ]
704 This can be used as both a subroutine and a method call. It returns a list
705 of the columns in this record's table, or an explicitly specified table.
706 (See L<dbdef_table>).
710 # Usage: @fields = fields($table);
711 # @fields = $record->fields;
713 my $something = shift;
715 if ( ref($something) ) {
716 $table = $something->table;
720 #croak "Usage: \@fields = fields(\$table)\n or: \@fields = \$record->fields" unless $table;
721 my($table_obj) = $dbdef->table($table);
722 croak "Unknown table $table" unless $table_obj;
730 =item reload_dbdef([FILENAME])
732 Load a database definition (see L<FS::dbdef>), optionally from a non-default
733 filename. This command is executed at startup unless
734 I<$FS::Record::setup_hack> is true. Returns a FS::dbdef object.
739 my $file = shift || $dbdef_file;
740 $dbdef = load FS::dbdef ($file);
745 Returns the current database definition. See L<FS::dbdef>.
749 sub dbdef { $dbdef; }
751 =item _quote VALUE, TABLE, COLUMN
753 This is an internal function used to construct SQL statements. It returns
754 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
755 type (see L<dbdef_column>) does not end in `char' or `binary'.
760 my($value,$table,$field)=@_;
762 if ( $value =~ /^\d+(\.\d+)?$/ &&
763 # ! ( datatype($table,$field) =~ /^char/ )
764 ! ( $dbdef->table($table)->column($field)->type =~ /(char|binary)$/i )
774 This is depriciated. Don't use it.
776 It returns a hash-type list with the fields of this record's table set true.
781 carp "warning: hfields is depriciated";
784 foreach (fields($table)) {
793 # "$_: ". $self->getfield($_). "|"
794 # } (fields($self->table)) );
799 # #use Carp qw(cluck);
800 # #cluck "DESTROYING $self";
801 # warn "DESTROYING $self";
805 # return ! eval { join('',@_), kill 0; 1; };
812 $Id: Record.pm,v 1.12 1999-01-25 12:26:06 ivan Exp $
816 This module should probably be renamed, since much of the functionality is
817 of general use. It is not completely unlike Adapter::DBI (see below).
819 Exported qsearch and qsearchs should be depriciated in favor of method calls
820 (against an FS::Record object like the old search and searchs that qsearch
821 and qsearchs were on top of.)
823 The whole fields / hfields mess should be removed.
825 The various WHERE clauses should be subroutined.
827 table string should be depriciated in favor of FS::dbdef_table.
829 No doubt we could benefit from a Tied hash. Documenting how exists / defined
830 true maps to the database (and WHERE clauses) would also help.
832 The ut_ methods should ask the dbdef for a default length.
834 ut_sqltype (like ut_varchar) should all be defined
836 A fallback check method should be provided whith uses the dbdef.
838 The ut_money method assumes money has two decimal digits.
840 The Pg money kludge in the new method only strips `$'.
842 The ut_phonen method assumes US-style phone numbers.
844 The _quote function should probably use ut_float instead of a regex.
846 All the subroutines probably should be methods, here or elsewhere.
848 Probably should borrow/use some dbdef methods where appropriate (like sub
853 L<FS::dbdef>, L<FS::UID>, L<DBI>
855 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.
859 ivan@voicenet.com 97-jun-2 - 9, 19, 25, 27, 30
862 ivan@sisd.com 97-nov-8 - 12
864 cleaned up, added autoloaded $self->any_field calls, moved DBI login stuff
866 ivan@sisd.com 97-nov-21-23
868 since AUTO_INCREMENT is MySQL specific, use my own unique number generator
870 ivan@sisd.com 97-dec-4
872 untaint $user in unique (web demo hack...bah)
873 make unique skip multiple-field unique's from dbdef
874 ivan@sisd.com 97-dec-11
876 merge with FS::Search, which after all was just alternate constructors for
877 FS::Record objects. Makes lots of things cleaner. :)
878 ivan@sisd.com 97-dec-13
880 use FS::dbdef::primary key in replace searches, hopefully for all practical
881 purposes the string/number problem in SQL statements should be gone?
883 ivan@sisd.com 98-jan-20
885 Put all SQL statments in $statment before we $sth=$dbh->prepare( them,
886 for debugging reasons (warn $statement) ivan@sisd.com 98-feb-19
888 (sigh)... use dbdef type (char, etc.) instead of a regex to decide
889 what to quote in _quote (more sillines...) SQL bites.
890 ivan@sisd.com 98-feb-20
892 more friendly error messages ivan@sisd.com 98-mar-13
894 Added import of datasrc from FS::UID to allow Pg6.3 to work
895 Added code to right-trim strings read from Pg6.3 databases
896 Modified 'add' to only insert fields that actually have data
897 Added ut_float to handle floating point numbers (for sales tax).
898 Pg6.3 does not have a "SHOW FIELDS" statement, so I faked it 8).
899 bmccane@maxbaud.net 98-apr-3
901 commented out Pg wrapper around `` Modified 'add' to only insert fields that
902 actually have data '' ivan@sisd.com 98-apr-16
904 dbdef usage changes ivan@sisd.com 98-jun-1
906 sub fields now asks dbdef, not database ivan@sisd.com 98-jun-2
908 added debugging method ->_dump ivan@sisd.com 98-jun-16
910 use FS::dbdef::primary key in delete searches as well as replace
911 searches (SQL still bites) ivan@sisd.com 98-jun-22
913 sub dbdef_table ivan@sisd.com 98-jun-28
915 removed Pg wrapper around `` Modified 'add' to only insert fields that
916 actually have data '' ivan@sisd.com 98-jul-14
918 sub fields croaks on errors ivan@sisd.com 98-jul-17
920 $rc eq '0E0' doesn't mean we couldn't delete for all rdbmss
921 ivan@sisd.com 98-jul-18
923 commented out code to right-trim strings read from Pg6.3 databases;
924 ChopBlanks is in UID.pm ivan@sisd.com 98-aug-16
926 added code (with Pg wrapper) to deal with Pg money fields
927 ivan@sisd.com 98-aug-18
929 added pod documentation ivan@sisd.com 98-sep-6
931 ut_phonen got ''; at the end ivan@sisd.com 98-sep-27
934 Revision 1.12 1999-01-25 12:26:06 ivan
935 yet more mod_perl stuff
937 Revision 1.11 1999/01/18 09:22:38 ivan
938 changes to track email addresses for email invoicing
940 Revision 1.10 1998/12/29 11:59:33 ivan
941 mostly properly OO, some work still to be done with svc_ stuff
943 Revision 1.9 1998/11/21 07:26:45 ivan
944 "Records identical" carp tells us it is just a warning.
946 Revision 1.8 1998/11/15 11:02:04 ivan
949 Revision 1.7 1998/11/15 10:56:31 ivan
950 qsearch gets sames "IS NULL" semantics as other WHERE clauses
952 Revision 1.6 1998/11/15 05:31:03 ivan
953 bugfix for new config layout
955 Revision 1.5 1998/11/13 09:56:51 ivan
956 change configuration file layout to support multiple distinct databases (with
957 own set of config files, export, etc.)
959 Revision 1.4 1998/11/10 07:45:25 ivan
962 Revision 1.2 1998/11/07 05:17:18 ivan
963 In sub new, Pg wrapper for money fields from dbdef (FS::Record::fields $table),
964 not keys of supplied hashref.