site_perl/Record.pm

   1 package FS::Record;
   2
   3 use strict;
   4 use vars qw($dbdef_file $dbdef $setup_hack $AUTOLOAD @ISA @EXPORT_OK);
   5 use subs qw(reload_dbdef);
   6 use Exporter;
   7 use Carp qw(carp cluck croak confess);
   8 use File::CounterFile;
   9 use FS::UID qw(dbh checkruid swapuid getotaker datasrc);
  10 use FS::dbdef;
  11
  12 @ISA = qw(Exporter);
  13 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef);
  14
  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?
  20 };
  21
  22 =head1 NAME
  23
  24 FS::Record - Database record objects
  25
  26 =head1 SYNOPSIS
  27
  28     use FS::Record;
  29     use FS::Record qw(dbh fields qsearch qsearchs dbdef);
  30
  31     $record = new FS::Record 'table', \%hash;
  32     $record = new FS::Record 'table', { 'column' => 'value', ... };
  33
  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', ... };
  38
  39     $table = $record->table;
  40     $dbdef_table = $record->dbdef_table;
  41
  42     $value = $record->get('column');
  43     $value = $record->getfield('column');
  44     $value = $record->column;
  45
  46     $record->set( 'column' => 'value' );
  47     $record->setfield( 'column' => 'value' );
  48     $record->column('value');
  49
  50     %hash = $record->hash;
  51
  52     $hashref = $record->hashref;
  53
  54     $error = $record->insert;
  55     #$error = $record->add; #depriciated
  56
  57     $error = $record->delete;
  58     #$error = $record->del; #depriciated
  59
  60     $error = $new_record->replace($old_record);
  61     #$error = $new_record->rep($old_record); #depriciated
  62
  63     $value = $record->unique('column');
  64
  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');
  75
  76     $dbdef = reload_dbdef;
  77     $dbdef = reload_dbdef "/non/standard/filename";
  78     $dbdef = dbdef;
  79
  80     $quoted_value = _quote($value,'table','field');
  81
  82     #depriciated
  83     $fields = hfields('table');
  84     if ( $fields->{Field} ) { # etc.
  85
  86     @fields = fields 'table'; #as a subroutine
  87     @fields = $record->fields; #as a method call
  88
  89
  90 =head1 DESCRIPTION
  91
  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.
  95
  96 =head1 CONSTRUCTORS
  97
  98 =over 4
  99
 100 =item new [ TABLE, ] HASHREF
 101
 102 Creates a new record.  It doesn't store it in the database, though.  See
 103 L<"insert"> for that.
 104
 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>
 107 method.
 108
 109 TABLE can only be omitted when a dervived class overrides the table method.
 110
 111 =cut
 112
 113 sub new {
 114   my $proto = shift;
 115   my $class = ref($proto) || $proto;
 116   my $self = {};
 117   bless ($self, $class);
 118
 119   $self->{'Table'} = shift unless defined ( $self->table );
 120
 121   my $hashref = $self->{'Hash'} = shift;
 122
 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/^\$//;
 130     }
 131   }
 132
 133   $self;
 134 }
 135
 136 sub create {
 137   my $proto = shift;
 138   my $class = ref($proto) || $proto;
 139   my $self = {};
 140   bless ($self, $class);
 141   if ( defined $self->table ) {
 142     cluck "create constructor is depriciated, use new!";
 143     $self->new(@_);
 144   } else {
 145     croak "FS::Record::create called (not from a subclass)!";
 146   }
 147 }
 148
 149 =item qsearch TABLE, HASHREF
 150
 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
 154 objects.
 155
 156 =cut
 157
 158 sub qsearch {
 159   my($table,$record) = @_;
 160   my($dbh) = dbh;
 161
 162   my(@fields)=grep exists($record->{$_}), fields($table);
 163
 164   my($sth);
 165   my($statement) = "SELECT * FROM $table". ( @fields
 166     ? " WHERE ". join(' AND ',
 167       map {
 168         $record->{$_} eq ''
 169           ? "$_ IS NULL"
 170           : "$_ = ". _quote($record->{$_},$table,$_)
 171       } @fields
 172     ) : ''
 173   );
 174   $sth=$dbh->prepare($statement)
 175     or croak $dbh->errstr; #is that a little too harsh?  hmm.
 176
 177   if ( eval ' scalar(@FS::'. $table. '::ISA);' ) {
 178     map {
 179       eval 'new FS::'. $table. ' ( $sth->fetchrow_hashref );';
 180     } ( 1 .. $sth->execute );
 181   } else {
 182     cluck "qsearch: warning: FS::$table not loaded; returning generic FS::Record objects";
 183     map {
 184       new FS::Record ($table,$sth->fetchrow_hashref);
 185     } ( 1 .. $sth->execute );
 186   }
 187
 188 }
 189
 190 =item qsearchs TABLE, HASHREF
 191
 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.
 195
 196 =cut
 197
 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?
 202   $result[0];
 203 }
 204
 205 =back
 206
 207 =head1 METHODS
 208
 209 =over 4
 210
 211 =item table
 212
 213 Returns the table name.
 214
 215 =cut
 216
 217 sub table {
 218 #  cluck "warning: FS::Record::table depriciated; supply one in subclass!";
 219   my $self = shift;
 220   $self -> {'Table'};
 221 }
 222
 223 =item dbdef_table
 224
 225 Returns the FS::dbdef_table object for the table.
 226
 227 =cut
 228
 229 sub dbdef_table {
 230   my($self)=@_;
 231   my($table)=$self->table;
 232   $dbdef->table($table);
 233 }
 234
 235 =item get, getfield COLUMN
 236
 237 Returns the value of the column/field/key COLUMN.
 238
 239 =cut
 240
 241 sub get {
 242   my($self,$field) = @_;
 243   # to avoid "Use of unitialized value" errors
 244   if ( defined ( $self->{Hash}->{$field} ) ) {
 245     $self->{Hash}->{$field};
 246   } else {
 247     '';
 248   }
 249 }
 250 sub getfield {
 251   my $self = shift;
 252   $self->get(@_);
 253 }
 254
 255 =item set, setfield COLUMN, VALUE
 256
 257 Sets the value of the column/field/key COLUMN to VALUE.  Returns VALUE.
 258
 259 =cut
 260
 261 sub set {
 262   my($self,$field,$value) = @_;
 263   $self->{'Hash'}->{$field} = $value;
 264 }
 265 sub setfield {
 266   my $self = shift;
 267   $self->set(@_);
 268 }
 269
 270 =item AUTLOADED METHODS
 271
 272 $record->column is a synonym for $record->get('column');
 273
 274 $record->column('value') is a synonym for $record->set('column','value');
 275
 276 =cut
 277
 278 sub AUTOLOAD {
 279   my($self,$value)=@_;
 280   my($field)=$AUTOLOAD;
 281   $field =~ s/.*://;
 282   if ( defined($value) ) {
 283     $self->setfield($field,$value);
 284   } else {
 285     $self->getfield($field);
 286   }
 287 }
 288
 289 =item hash
 290
 291 Returns a list of the column/value pairs, usually for assigning to a new hash.
 292
 293 To make a distinct duplicate of an FS::Record object, you can do:
 294
 295     $new = new FS::Record ( $old->table, { $old->hash } );
 296
 297 =cut
 298
 299 sub hash {
 300   my($self) = @_;
 301   %{ $self->{'Hash'} };
 302 }
 303
 304 =item hashref
 305
 306 Returns a reference to the column/value hash.
 307
 308 =cut
 309
 310 sub hashref {
 311   my($self) = @_;
 312   $self->{'Hash'};
 313 }
 314
 315 =item insert
 316
 317 Inserts this record to the database.  If there is an error, returns the error,
 318 otherwise returns false.
 319
 320 =cut
 321
 322 sub insert {
 323   my $self = shift;
 324
 325   my $error = $self->check;
 326   return $error if $error;
 327
 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($_);
 332   }
 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);
 337
 338   my @fields =
 339     grep defined($self->getfield($_)) && $self->getfield($_) ne "",
 340     $self->fields
 341   ;
 342
 343   my $statement = "INSERT INTO ". $self->table. " ( ".
 344       join(', ',@fields ).
 345     ") VALUES (".
 346       join(', ',map(_quote($self->getfield($_),$self->table,$_), @fields)).
 347     ")"
 348   ;
 349   my $sth = dbh->prepare($statement) or return dbh->errstr;
 350
 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
 357   $sth->execute or return $sth->errstr;
 358
 359   '';
 360 }
 361
 362 =item add
 363
 364 Depriciated (use insert instead).
 365
 366 =cut
 367
 368 sub add {
 369   cluck "warning: FS::Record::add depriciated!";
 370   insert @_; #call method in this scope
 371 }
 372
 373 =item delete
 374
 375 Delete this record from the database.  If there is an error, returns the error,
 376 otherwise returns false.
 377
 378 =cut
 379
 380 sub delete {
 381   my $self = shift;
 382
 383   my($statement)="DELETE FROM ". $self->table. " WHERE ". join(' AND ',
 384     map {
 385       $self->getfield($_) eq ''
 386         ? "$_ IS NULL"
 387         : "$_ = ". _quote($self->getfield($_),$self->table,$_)
 388     } ( $self->dbdef_table->primary_key )
 389           ? ( $self->dbdef_table->primary_key)
 390           : $self->fields
 391   );
 392   my $sth = dbh->prepare($statement) or return dbh->errstr;
 393
 394   local $SIG{HUP} = 'IGNORE';
 395   local $SIG{INT} = 'IGNORE';
 396   local $SIG{QUIT} = 'IGNORE';
 397   local $SIG{TERM} = 'IGNORE';
 398   local $SIG{TSTP} = 'IGNORE';
 399
 400   my $rc = $sth->execute or return $sth->errstr;
 401   #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
 402
 403   undef $self; #no need to keep object!
 404
 405   '';
 406 }
 407
 408 =item del
 409
 410 Depriciated (use delete instead).
 411
 412 =cut
 413
 414 sub del {
 415   cluck "warning: FS::Record::del depriciated!";
 416   &delete(@_); #call method in this scope
 417 }
 418
 419 =item replace OLD_RECORD
 420
 421 Replace the OLD_RECORD with this one in the database.  If there is an error,
 422 returns the error, otherwise returns false.
 423
 424 =cut
 425
 426 sub replace {
 427   my ( $new, $old ) = ( shift, shift );
 428
 429   my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
 430   unless ( @diff ) {
 431     carp "warning: records identical";
 432     return '';
 433   }
 434
 435   return "Records not in same table!" unless $new->table eq $old->table;
 436
 437   my $primary_key = $old->dbdef_table->primary_key;
 438   return "Can't change $primary_key"
 439     if $primary_key
 440        && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
 441
 442   my $error = $new->check;
 443   return $error if $error;
 444
 445   my $statement = "UPDATE ". $old->table. " SET ". join(', ',
 446     map {
 447       "$_ = ". _quote($new->getfield($_),$old->table,$_)
 448     } @diff
 449   ). ' WHERE '.
 450     join(' AND ',
 451       map {
 452         $old->getfield($_) eq ''
 453           ? "$_ IS NULL"
 454           : "$_ = ". _quote($old->getfield($_),$old->table,$_)
 455       } ( $primary_key ? ( $primary_key ) : $old->fields )
 456     )
 457   ;
 458   my $sth = dbh->prepare($statement) or return dbh->errstr;
 459
 460   local $SIG{HUP} = 'IGNORE';
 461   local $SIG{INT} = 'IGNORE';
 462   local $SIG{QUIT} = 'IGNORE';
 463   local $SIG{TERM} = 'IGNORE';
 464   local $SIG{TSTP} = 'IGNORE';
 465
 466   my $rc = $sth->execute or return $sth->errstr;
 467   #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
 468
 469   '';
 470
 471 }
 472
 473 =item rep
 474
 475 Depriciated (use replace instead).
 476
 477 =cut
 478
 479 sub rep {
 480   cluck "warning: FS::Record::rep depriciated!";
 481   replace @_; #call method in this scope
 482 }
 483
 484 =item check
 485
 486 Not yet implemented, croaks.  Derived classes should provide a check method.
 487
 488 =cut
 489
 490 sub check {
 491   croak "FS::Record::check not implemented; supply one in subclass!";
 492 }
 493
 494 =item unique COLUMN
 495
 496 Replaces COLUMN in record with a unique number.  Called by the B<add> method
 497 on primary keys and single-field unique columns (see L<FS::dbdef_table>).
 498 Returns the new value.
 499
 500 =cut
 501
 502 sub unique {
 503   my($self,$field) = @_;
 504   my($table)=$self->table;
 505
 506   croak("&FS::UID::checkruid failed") unless &checkruid;
 507
 508   croak "Unique called on field $field, but it is ",
 509         $self->getfield($field),
 510         ", not null!"
 511     if $self->getfield($field);
 512
 513   #warn "table $table is tainted" if is_tainted($table);
 514   #warn "field $field is tainted" if is_tainted($field);
 515
 516   &swapuid;
 517   my($counter) = new File::CounterFile "$table.$field",0;
 518 # hack for web demo
 519 #  getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
 520 #  my($user)=$1;
 521 #  my($counter) = new File::CounterFile "$user/$table.$field",0;
 522 # endhack
 523
 524   my($index)=$counter->inc;
 525   $index=$counter->inc
 526     while qsearchs($table,{$field=>$index}); #just in case
 527   &swapuid;
 528
 529   $index =~ /^(\d*)$/;
 530   $index=$1;
 531
 532   $self->setfield($field,$index);
 533
 534 }
 535
 536 =item ut_float COLUMN
 537
 538 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10.  May not be
 539 null.  If there is an error, returns the error, otherwise returns false.
 540
 541 =cut
 542
 543 sub ut_float {
 544   my($self,$field)=@_ ;
 545   ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
 546    $self->getfield($field) =~ /^(\d+)$/ ||
 547    $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
 548    $self->getfield($field) =~ /^(\d+e\d+)$/)
 549     or return "Illegal or empty (float) $field!";
 550   $self->setfield($field,$1);
 551   '';
 552 }
 553
 554 =item ut_number COLUMN
 555
 556 Check/untaint simple numeric data (whole numbers).  May not be null.  If there
 557 is an error, returns the error, otherwise returns false.
 558
 559 =cut
 560
 561 sub ut_number {
 562   my($self,$field)=@_;
 563   $self->getfield($field) =~ /^(\d+)$/
 564     or return "Illegal or empty (numeric) $field!";
 565   $self->setfield($field,$1);
 566   '';
 567 }
 568
 569 =item ut_numbern COLUMN
 570
 571 Check/untaint simple numeric data (whole numbers).  May be null.  If there is
 572 an error, returns the error, otherwise returns false.
 573
 574 =cut
 575
 576 sub ut_numbern {
 577   my($self,$field)=@_;
 578   $self->getfield($field) =~ /^(\d*)$/
 579     or return "Illegal (numeric) $field!";
 580   $self->setfield($field,$1);
 581   '';
 582 }
 583
 584 =item ut_money COLUMN
 585
 586 Check/untaint monetary numbers.  May be negative.  Set to 0 if null.  If there
 587 is an error, returns the error, otherwise returns false.
 588
 589 =cut
 590
 591 sub ut_money {
 592   my($self,$field)=@_;
 593   $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
 594     or return "Illegal (money) $field!";
 595   $self->setfield($field,"$1$2$3" || 0);
 596   '';
 597 }
 598
 599 =item ut_text COLUMN
 600
 601 Check/untaint text.  Alphanumerics, spaces, and the following punctuation
 602 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
 603 May not be null.  If there is an error, returns the error, otherwise returns
 604 false.
 605
 606 =cut
 607
 608 sub ut_text {
 609   my($self,$field)=@_;
 610   $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]+)$/
 611     or return "Illegal or empty (text) $field";
 612   $self->setfield($field,$1);
 613   '';
 614 }
 615
 616 =item ut_textn COLUMN
 617
 618 Check/untaint text.  Alphanumerics, spaces, and the following punctuation
 619 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
 620 May be null.  If there is an error, returns the error, otherwise returns false.
 621
 622 =cut
 623
 624 sub ut_textn {
 625   my($self,$field)=@_;
 626   $self->getfield($field) =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/]*)$/
 627     or return "Illegal (text) $field";
 628   $self->setfield($field,$1);
 629   '';
 630 }
 631
 632 =item ut_alpha COLUMN
 633
 634 Check/untaint alphanumeric strings (no spaces).  May not be null.  If there is
 635 an error, returns the error, otherwise returns false.
 636
 637 =cut
 638
 639 sub ut_alpha {
 640   my($self,$field)=@_;
 641   $self->getfield($field) =~ /^(\w+)$/
 642     or return "Illegal or empty (alphanumeric) $field!";
 643   $self->setfield($field,$1);
 644   '';
 645 }
 646
 647 =item ut_alpha COLUMN
 648
 649 Check/untaint alphanumeric strings (no spaces).  May be null.  If there is an
 650 error, returns the error, otherwise returns false.
 651
 652 =cut
 653
 654 sub ut_alphan {
 655   my($self,$field)=@_;
 656   $self->getfield($field) =~ /^(\w*)$/
 657     or return "Illegal (alphanumeric) $field!";
 658   $self->setfield($field,$1);
 659   '';
 660 }
 661
 662 =item ut_phonen COLUMN
 663
 664 Check/untaint phone numbers.  May be null.  If there is an error, returns
 665 the error, otherwise returns false.
 666
 667 =cut
 668
 669 sub ut_phonen {
 670   my($self,$field)=@_;
 671   my $phonen = $self->getfield($field);
 672   if ( $phonen eq '' ) {
 673     $self->setfield($field,'');
 674   } else {
 675     $phonen =~ s/\D//g;
 676     $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
 677       or return "Illegal (phone) $field!";
 678     $phonen = "$1-$2-$3";
 679     $phonen .= " x$4" if $4;
 680     $self->setfield($field,$phonen);
 681   }
 682   '';
 683 }
 684
 685 =item ut_anything COLUMN
 686
 687 Untaints arbitrary data.  Be careful.
 688
 689 =cut
 690
 691 sub ut_anything {
 692   my($self,$field)=@_;
 693   $self->getfield($field) =~ /^(.*)$/ or return "Illegal $field!";
 694   $self->setfield($field,$1);
 695   '';
 696 }
 697
 698 =item fields [ TABLE ]
 699
 700 This can be used as both a subroutine and a method call.  It returns a list
 701 of the columns in this record's table, or an explicitly specified table.
 702 (See L<dbdef_table>).
 703
 704 =cut
 705
 706 # Usage: @fields = fields($table);
 707 #        @fields = $record->fields;
 708 sub fields {
 709   my $something = shift;
 710   my $table;
 711   if ( ref($something) ) {
 712     $table = $something->table;
 713   } else {
 714     $table = $something;
 715   }
 716   #croak "Usage: \@fields = fields(\$table)\n   or: \@fields = \$record->fields" unless $table;
 717   my($table_obj) = $dbdef->table($table);
 718   croak "Unknown table $table" unless $table_obj;
 719   $table_obj->columns;
 720 }
 721
 722 =head1 SUBROUTINES
 723
 724 =over 4
 725
 726 =item reload_dbdef([FILENAME])
 727
 728 Load a database definition (see L<FS::dbdef>), optionally from a non-default
 729 filename.  This command is executed at startup unless
 730 I<$FS::Record::setup_hack> is true.  Returns a FS::dbdef object.
 731
 732 =cut
 733
 734 sub reload_dbdef {
 735   my $file = shift || $dbdef_file;
 736   $dbdef = load FS::dbdef ($file);
 737 }
 738
 739 =item dbdef
 740
 741 Returns the current database definition.  See L<FS::dbdef>.
 742
 743 =cut
 744
 745 sub dbdef { $dbdef; }
 746
 747 =item _quote VALUE, TABLE, COLUMN
 748
 749 This is an internal function used to construct SQL statements.  It returns
 750 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
 751 type (see L<dbdef_column>) does not end in `char' or `binary'.
 752
 753 =cut
 754
 755 sub _quote {
 756   my($value,$table,$field)=@_;
 757   my($dbh)=dbh;
 758   if ( $value =~ /^\d+(\.\d+)?$/ &&
 759 #       ! ( datatype($table,$field) =~ /^char/ )
 760        ! ( $dbdef->table($table)->column($field)->type =~ /(char|binary)$/i )
 761   ) {
 762     $value;
 763   } else {
 764     $dbh->quote($value);
 765   }
 766 }
 767
 768 =item hfields TABLE
 769
 770 This is depriciated.  Don't use it.
 771
 772 It returns a hash-type list with the fields of this record's table set true.
 773
 774 =cut
 775
 776 sub hfields {
 777   carp "warning: hfields is depriciated";
 778   my($table)=@_;
 779   my(%hash);
 780   foreach (fields($table)) {
 781     $hash{$_}=1;
 782   }
 783   \%hash;
 784 }
 785
 786 #sub _dump {
 787 #  my($self)=@_;
 788 #  join("\n", map {
 789 #    "$_: ". $self->getfield($_). "|"
 790 #  } (fields($self->table)) );
 791 #}
 792
 793 #sub DESTROY {
 794 #  my $self = shift;
 795 #  #use Carp qw(cluck);
 796 #  #cluck "DESTROYING $self";
 797 #  warn "DESTROYING $self";
 798 #}
 799
 800 #sub is_tainted {
 801 #             return ! eval { join('',@_), kill 0; 1; };
 802 #         }
 803
 804 =back
 805
 806 =head1 VERSION
 807
 808 $Id: Record.pm,v 1.10 1998-12-29 11:59:33 ivan Exp $
 809
 810 =head1 BUGS
 811
 812 This module should probably be renamed, since much of the functionality is
 813 of general use.  It is not completely unlike Adapter::DBI (see below).
 814
 815 Exported qsearch and qsearchs should be depriciated in favor of method calls
 816 (against an FS::Record object like the old search and searchs that qsearch
 817 and qsearchs were on top of.)
 818
 819 The whole fields / hfields mess should be removed.
 820
 821 The various WHERE clauses should be subroutined.
 822
 823 table string should be depriciated in favor of FS::dbdef_table.
 824
 825 No doubt we could benefit from a Tied hash.  Documenting how exists / defined
 826 true maps to the database (and WHERE clauses) would also help.
 827
 828 The ut_ methods should ask the dbdef for a default length.
 829
 830 ut_sqltype (like ut_varchar) should all be defined
 831
 832 A fallback check method should be provided whith uses the dbdef.
 833
 834 The ut_money method assumes money has two decimal digits.
 835
 836 The Pg money kludge in the new method only strips `$'.
 837
 838 The ut_phonen method assumes US-style phone numbers.
 839
 840 The _quote function should probably use ut_float instead of a regex.
 841
 842 All the subroutines probably should be methods, here or elsewhere.
 843
 844 Probably should borrow/use some dbdef methods where appropriate (like sub
 845 fields)
 846
 847 =head1 SEE ALSO
 848
 849 L<FS::dbdef>, L<FS::UID>, L<DBI>
 850
 851 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.
 852
 853 =head1 HISTORY
 854
 855 ivan@voicenet.com 97-jun-2 - 9, 19, 25, 27, 30
 856
 857 DBI version
 858 ivan@sisd.com 97-nov-8 - 12
 859
 860 cleaned up, added autoloaded $self->any_field calls, moved DBI login stuff
 861 to FS::UID
 862 ivan@sisd.com 97-nov-21-23
 863
 864 since AUTO_INCREMENT is MySQL specific, use my own unique number generator
 865 (again)
 866 ivan@sisd.com 97-dec-4
 867
 868 untaint $user in unique (web demo hack...bah)
 869 make unique skip multiple-field unique's from dbdef
 870 ivan@sisd.com 97-dec-11
 871
 872 merge with FS::Search, which after all was just alternate constructors for
 873 FS::Record objects.  Makes lots of things cleaner.  :)
 874 ivan@sisd.com 97-dec-13
 875
 876 use FS::dbdef::primary key in replace searches, hopefully for all practical
 877 purposes the string/number problem in SQL statements should be gone?
 878 (SQL bites)
 879 ivan@sisd.com 98-jan-20
 880
 881 Put all SQL statments in $statment before we $sth=$dbh->prepare( them,
 882 for debugging reasons (warn $statement) ivan@sisd.com 98-feb-19
 883
 884 (sigh)... use dbdef type (char, etc.) instead of a regex to decide
 885 what to quote in _quote (more sillines...)  SQL bites.
 886 ivan@sisd.com 98-feb-20
 887
 888 more friendly error messages ivan@sisd.com 98-mar-13
 889
 890 Added import of datasrc from FS::UID to allow Pg6.3 to work
 891 Added code to right-trim strings read from Pg6.3 databases
 892 Modified 'add' to only insert fields that actually have data
 893 Added ut_float to handle floating point numbers (for sales tax).
 894 Pg6.3 does not have a "SHOW FIELDS" statement, so I faked it 8).
 895         bmccane@maxbaud.net     98-apr-3
 896
 897 commented out Pg wrapper around `` Modified 'add' to only insert fields that
 898 actually have data '' ivan@sisd.com 98-apr-16
 899
 900 dbdef usage changes ivan@sisd.com 98-jun-1
 901
 902 sub fields now asks dbdef, not database ivan@sisd.com 98-jun-2
 903
 904 added debugging method ->_dump ivan@sisd.com 98-jun-16
 905
 906 use FS::dbdef::primary key in delete searches as well as replace
 907 searches (SQL still bites) ivan@sisd.com 98-jun-22
 908
 909 sub dbdef_table ivan@sisd.com 98-jun-28
 910
 911 removed Pg wrapper around `` Modified 'add' to only insert fields that
 912 actually have data '' ivan@sisd.com 98-jul-14
 913
 914 sub fields croaks on errors ivan@sisd.com 98-jul-17
 915
 916 $rc eq '0E0' doesn't mean we couldn't delete for all rdbmss
 917 ivan@sisd.com 98-jul-18
 918
 919 commented out code to right-trim strings read from Pg6.3 databases;
 920 ChopBlanks is in UID.pm ivan@sisd.com 98-aug-16
 921
 922 added code (with Pg wrapper) to deal with Pg money fields
 923 ivan@sisd.com 98-aug-18
 924
 925 added pod documentation ivan@sisd.com 98-sep-6
 926
 927 ut_phonen got ''; at the end ivan@sisd.com 98-sep-27
 928
 929 $Log: Record.pm,v $
 930 Revision 1.10  1998-12-29 11:59:33  ivan
 931 mostly properly OO, some work still to be done with svc_ stuff
 932
 933 Revision 1.9  1998/11/21 07:26:45  ivan
 934 "Records identical" carp tells us it is just a warning.
 935
 936 Revision 1.8  1998/11/15 11:02:04  ivan
 937 bugsquash
 938
 939 Revision 1.7  1998/11/15 10:56:31  ivan
 940 qsearch gets sames "IS NULL" semantics as other WHERE clauses
 941
 942 Revision 1.6  1998/11/15 05:31:03  ivan
 943 bugfix for new config layout
 944
 945 Revision 1.5  1998/11/13 09:56:51  ivan
 946 change configuration file layout to support multiple distinct databases (with
 947 own set of config files, export, etc.)
 948
 949 Revision 1.4  1998/11/10 07:45:25  ivan
 950 doc clarification
 951
 952 Revision 1.2  1998/11/07 05:17:18  ivan
 953 In sub new, Pg wrapper for money fields from dbdef (FS::Record::fields $table),
 954 not keys of supplied hashref.
 955
 956
 957 =cut
 958
 959 1;
 960