4 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
6 %virtual_fields_cache $nowarn_identical );
8 use Carp qw(carp cluck croak confess);
11 use DBI qw(:sql_types);
12 use DBIx::DBSchema 0.25;
13 use FS::UID qw(dbh getotaker datasrc driver_name);
15 use FS::Schema qw(dbdef);
17 use FS::Msgcat qw(gettext);
20 use FS::part_virtual_field;
26 #export dbdef for now... everything else expects to find it here
27 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef jsearch);
32 $nowarn_identical = 0;
39 FS::UID->install_callback( sub {
41 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
47 FS::Record - Database record objects
52 use FS::Record qw(dbh fields qsearch qsearchs);
54 $record = new FS::Record 'table', \%hash;
55 $record = new FS::Record 'table', { 'column' => 'value', ... };
57 $record = qsearchs FS::Record 'table', \%hash;
58 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
59 @records = qsearch FS::Record 'table', \%hash;
60 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
62 $table = $record->table;
63 $dbdef_table = $record->dbdef_table;
65 $value = $record->get('column');
66 $value = $record->getfield('column');
67 $value = $record->column;
69 $record->set( 'column' => 'value' );
70 $record->setfield( 'column' => 'value' );
71 $record->column('value');
73 %hash = $record->hash;
75 $hashref = $record->hashref;
77 $error = $record->insert;
79 $error = $record->delete;
81 $error = $new_record->replace($old_record);
83 # external use deprecated - handled by the database (at least for Pg, mysql)
84 $value = $record->unique('column');
86 $error = $record->ut_float('column');
87 $error = $record->ut_floatn('column');
88 $error = $record->ut_number('column');
89 $error = $record->ut_numbern('column');
90 $error = $record->ut_snumber('column');
91 $error = $record->ut_snumbern('column');
92 $error = $record->ut_money('column');
93 $error = $record->ut_text('column');
94 $error = $record->ut_textn('column');
95 $error = $record->ut_alpha('column');
96 $error = $record->ut_alphan('column');
97 $error = $record->ut_phonen('column');
98 $error = $record->ut_anything('column');
99 $error = $record->ut_name('column');
101 $quoted_value = _quote($value,'table','field');
104 $fields = hfields('table');
105 if ( $fields->{Field} ) { # etc.
107 @fields = fields 'table'; #as a subroutine
108 @fields = $record->fields; #as a method call
113 (Mostly) object-oriented interface to database records. Records are currently
114 implemented on top of DBI. FS::Record is intended as a base class for
115 table-specific classes to inherit from, i.e. FS::cust_main.
121 =item new [ TABLE, ] HASHREF
123 Creates a new record. It doesn't store it in the database, though. See
124 L<"insert"> for that.
126 Note that the object stores this hash reference, not a distinct copy of the
127 hash it points to. You can ask the object for a copy with the I<hash>
130 TABLE can only be omitted when a dervived class overrides the table method.
136 my $class = ref($proto) || $proto;
138 bless ($self, $class);
140 unless ( defined ( $self->table ) ) {
141 $self->{'Table'} = shift;
142 carp "warning: FS::Record::new called with table name ". $self->{'Table'};
145 $self->{'Hash'} = shift;
147 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
148 $self->{'Hash'}{$field}='';
151 $self->_rebless if $self->can('_rebless');
153 $self->{'modified'} = 0;
155 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
162 my $class = ref($proto) || $proto;
164 bless ($self, $class);
166 $self->{'Table'} = shift unless defined ( $self->table );
168 my $hashref = $self->{'Hash'} = shift;
170 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
171 my $obj = $cache->cache->{$hashref->{$cache->key}};
172 $obj->_cache($hashref, $cache) if $obj->can('_cache');
175 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
182 my $class = ref($proto) || $proto;
184 bless ($self, $class);
185 if ( defined $self->table ) {
186 cluck "create constructor is deprecated, use new!";
189 croak "FS::Record::create called (not from a subclass)!";
193 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
195 Searches the database for all records matching (at least) the key/value pairs
196 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
197 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
200 The preferred usage is to pass a hash reference of named parameters:
202 my @records = qsearch( {
203 'table' => 'table_name',
204 'hashref' => { 'field' => 'value'
205 'field' => { 'op' => '<',
210 #these are optional...
212 'extra_sql' => 'AND field ',
213 #'cache_obj' => '', #optional
214 'addl_from' => 'LEFT JOIN othtable USING ( field )',
218 Much code still uses old-style positional parameters, this is also probably
219 fine in the common case where there are only two parameters:
221 my @records = qsearch( 'table', { 'field' => 'value' } );
223 ###oops, argh, FS::Record::new only lets us create database fields.
224 #Normal behaviour if SELECT is not specified is `*', as in
225 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
226 #feature where you can specify SELECT - remember, the objects returned,
227 #although blessed into the appropriate `FS::TABLE' package, will only have the
228 #fields you specify. This might have unwanted results if you then go calling
229 #regular FS::TABLE methods
235 my($stable, $record, $select, $extra_sql, $cache, $addl_from );
236 if ( ref($_[0]) ) { #hashref for now, eventually maybe accept a list too
238 $stable = $opt->{'table'} or die "table name is required";
239 $record = $opt->{'hashref'} || {};
240 $select = $opt->{'select'} || '*';
241 $extra_sql = $opt->{'extra_sql'} || '';
242 $cache = $opt->{'cache_obj'} || '';
243 $addl_from = $opt->{'addl_from'} || '';
245 ($stable, $record, $select, $extra_sql, $cache, $addl_from ) = @_;
249 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
251 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
255 my $table = $cache ? $cache->table : $stable;
256 my $dbdef_table = dbdef->table($table)
257 or die "No schema for table $table found - ".
258 "do you need to run freeside-upgrade?";
259 my $pkey = $dbdef_table->primary_key;
261 my @real_fields = grep exists($record->{$_}), real_fields($table);
263 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
264 @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
266 cluck "warning: FS::$table not loaded; virtual fields not searchable";
267 @virtual_fields = ();
270 my $statement = "SELECT $select FROM $stable";
271 $statement .= " $addl_from" if $addl_from;
272 if ( @real_fields or @virtual_fields ) {
273 $statement .= ' WHERE '. join(' AND ',
278 if ( ref($record->{$_}) ) {
279 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
280 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
281 if ( uc($op) eq 'ILIKE' ) {
283 $record->{$_}{'value'} = lc($record->{$_}{'value'});
284 $column = "LOWER($_)";
286 $record->{$_} = $record->{$_}{'value'}
289 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
291 if ( driver_name eq 'Pg' ) {
292 my $type = dbdef->table($table)->column($column)->type;
293 if ( $type =~ /(int|(big)?serial)/i ) {
294 qq-( $column IS NULL )-;
296 qq-( $column IS NULL OR $column = '' )-;
299 qq-( $column IS NULL OR $column = "" )-;
301 } elsif ( $op eq '!=' ) {
302 if ( driver_name eq 'Pg' ) {
303 my $type = dbdef->table($table)->column($column)->type;
304 if ( $type =~ /(int|(big)?serial)/i ) {
305 qq-( $column IS NOT NULL )-;
307 qq-( $column IS NOT NULL AND $column != '' )-;
310 qq-( $column IS NOT NULL AND $column != "" )-;
313 if ( driver_name eq 'Pg' ) {
314 qq-( $column $op '' )-;
316 qq-( $column $op "" )-;
326 if ( ref($record->{$_}) ) {
327 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
328 if ( uc($op) eq 'ILIKE' ) {
330 $record->{$_}{'value'} = lc($record->{$_}{'value'});
331 $column = "LOWER($_)";
333 $record->{$_} = $record->{$_}{'value'};
336 # ... EXISTS ( SELECT name, value FROM part_virtual_field
338 # ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
339 # WHERE recnum = svc_acct.svcnum
340 # AND (name, value) = ('egad', 'brain') )
342 my $value = $record->{$_};
346 $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
347 "( SELECT part_virtual_field.name, virtual_field.value ".
348 "FROM part_virtual_field JOIN virtual_field ".
349 "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
350 "WHERE virtual_field.recnum = ${table}.${pkey} ".
351 "AND part_virtual_field.name = '${column}'".
353 " AND virtual_field.value ${op} '${value}'"
357 } @virtual_fields ) );
361 $statement .= " $extra_sql" if defined($extra_sql);
363 warn "[debug]$me $statement\n" if $DEBUG > 1;
364 my $sth = $dbh->prepare($statement)
365 or croak "$dbh->errstr doing $statement";
370 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
372 if ( $record->{$field} =~ /^\d+(\.\d+)?$/
373 && dbdef->table($table)->column($field)->type =~ /(int|(big)?serial)/i
375 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_INTEGER } );
377 $sth->bind_param($bind++, $record->{$field}, { TYPE => SQL_VARCHAR } );
381 # $sth->execute( map $record->{$_},
382 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
383 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
385 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
387 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
388 @virtual_fields = "FS::$table"->virtual_fields;
390 cluck "warning: FS::$table not loaded; virtual fields not returned either";
391 @virtual_fields = ();
395 tie %result, "Tie::IxHash";
396 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
397 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
398 %result = map { $_->{$pkey}, $_ } @stuff;
400 @result{@stuff} = @stuff;
405 if ( keys(%result) and @virtual_fields ) {
407 "SELECT virtual_field.recnum, part_virtual_field.name, ".
408 "virtual_field.value ".
409 "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
410 "WHERE part_virtual_field.dbtable = '$table' AND ".
411 "virtual_field.recnum IN (".
412 join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
413 join(q!', '!, @virtual_fields) . "')";
414 warn "[debug]$me $statement\n" if $DEBUG > 1;
415 $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
416 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
418 foreach (@{ $sth->fetchall_arrayref({}) }) {
419 my $recnum = $_->{recnum};
420 my $name = $_->{name};
421 my $value = $_->{value};
422 if (exists($result{$recnum})) {
423 $result{$recnum}->{$name} = $value;
428 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
429 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
430 #derivied class didn't override new method, so this optimization is safe
433 new_or_cached( "FS::$table", { %{$_} }, $cache )
437 new( "FS::$table", { %{$_} } )
441 #okay, its been tested
442 # warn "untested code (class FS::$table uses custom new method)";
444 eval 'FS::'. $table. '->new( { %{$_} } )';
448 # Check for encrypted fields and decrypt them.
449 ## only in the local copy, not the cached object
450 if ( $conf && $conf->exists('encryption') # $conf doesn't exist when doing
451 # the initial search for
453 && eval 'defined(@FS::'. $table . '::encrypted_fields)') {
454 foreach my $record (@return) {
455 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
456 # Set it directly... This may cause a problem in the future...
457 $record->setfield($field, $record->decrypt($record->getfield($field)));
462 cluck "warning: FS::$table not loaded; returning FS::Record objects";
464 FS::Record->new( $table, { %{$_} } );
470 =item by_key PRIMARY_KEY_VALUE
472 This is a class method that returns the record with the given primary key
473 value. This method is only useful in FS::Record subclasses. For example:
475 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
479 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
484 my ($class, $pkey_value) = @_;
486 my $table = $class->table
487 or croak "No table for $class found";
489 my $dbdef_table = dbdef->table($table)
490 or die "No schema for table $table found - ".
491 "do you need to create it or run dbdef-create?";
492 my $pkey = $dbdef_table->primary_key
493 or die "No primary key for table $table";
495 return qsearchs($table, { $pkey => $pkey_value });
498 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
500 Experimental JOINed search method. Using this method, you can execute a
501 single SELECT spanning multiple tables, and cache the results for subsequent
502 method calls. Interface will almost definately change in an incompatible
510 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
511 my $cache = FS::SearchCache->new( $ptable, $pkey );
514 grep { !$saw{$_->getfield($pkey)}++ }
515 qsearch($table, $record, $select, $extra_sql, $cache )
519 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
521 Same as qsearch, except that if more than one record matches, it B<carp>s but
522 returns the first. If this happens, you either made a logic error in asking
523 for a single item, or your data is corrupted.
527 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
529 my(@result) = qsearch(@_);
530 cluck "warning: Multiple records in scalar search ($table)"
531 if scalar(@result) > 1;
532 #should warn more vehemently if the search was on a primary key?
533 scalar(@result) ? ($result[0]) : ();
544 Returns the table name.
549 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
556 Returns the DBIx::DBSchema::Table object for the table.
562 my($table)=$self->table;
563 dbdef->table($table);
566 =item get, getfield COLUMN
568 Returns the value of the column/field/key COLUMN.
573 my($self,$field) = @_;
574 # to avoid "Use of unitialized value" errors
575 if ( defined ( $self->{Hash}->{$field} ) ) {
576 $self->{Hash}->{$field};
586 =item set, setfield COLUMN, VALUE
588 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
593 my($self,$field,$value) = @_;
594 $self->{'modified'} = 1;
595 $self->{'Hash'}->{$field} = $value;
602 =item AUTLOADED METHODS
604 $record->column is a synonym for $record->get('column');
606 $record->column('value') is a synonym for $record->set('column','value');
613 my($field)=$AUTOLOAD;
615 if ( defined($value) ) {
616 confess "errant AUTOLOAD $field for $self (arg $value)"
617 unless ref($self) && $self->can('setfield');
618 $self->setfield($field,$value);
620 confess "errant AUTOLOAD $field for $self (no args)"
621 unless ref($self) && $self->can('getfield');
622 $self->getfield($field);
628 # my $field = $AUTOLOAD;
630 # if ( defined($_[1]) ) {
631 # $_[0]->setfield($field, $_[1]);
633 # $_[0]->getfield($field);
639 Returns a list of the column/value pairs, usually for assigning to a new hash.
641 To make a distinct duplicate of an FS::Record object, you can do:
643 $new = new FS::Record ( $old->table, { $old->hash } );
649 confess $self. ' -> hash: Hash attribute is undefined'
650 unless defined($self->{'Hash'});
651 %{ $self->{'Hash'} };
656 Returns a reference to the column/value hash. This may be deprecated in the
657 future; if there's a reason you can't just use the autoloaded or get/set
669 Returns true if any of this object's values have been modified with set (or via
670 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
682 Inserts this record to the database. If there is an error, returns the error,
683 otherwise returns false.
691 my $error = $self->check;
692 return $error if $error;
694 #single-field unique keys are given a value if false
695 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
696 foreach ( $self->dbdef_table->unique->singles ) {
697 $self->unique($_) unless $self->getfield($_);
700 #and also the primary key, if the database isn't going to
701 my $primary_key = $self->dbdef_table->primary_key;
703 if ( $primary_key ) {
704 my $col = $self->dbdef_table->column($primary_key);
707 uc($col->type) =~ /^(BIG)?SERIAL\d?/
708 || ( driver_name eq 'Pg'
709 && defined($col->default)
710 && $col->default =~ /^nextval\(/i
712 || ( driver_name eq 'mysql'
713 && defined($col->local)
714 && $col->local =~ /AUTO_INCREMENT/i
716 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
719 my $table = $self->table;
722 # Encrypt before the database
723 if ($conf->exists('encryption') && defined(eval '@FS::'. $table . '::encrypted_fields')) {
724 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
725 $self->{'saved'} = $self->getfield($field);
726 $self->setfield($field, $self->encrypt($self->getfield($field)));
731 #false laziness w/delete
733 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
736 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
739 my $statement = "INSERT INTO $table ";
740 if ( @real_fields ) {
743 join( ', ', @real_fields ).
745 join( ', ', @values ).
749 $statement .= 'DEFAULT VALUES';
751 warn "[debug]$me $statement\n" if $DEBUG > 1;
752 my $sth = dbh->prepare($statement) or return dbh->errstr;
754 local $SIG{HUP} = 'IGNORE';
755 local $SIG{INT} = 'IGNORE';
756 local $SIG{QUIT} = 'IGNORE';
757 local $SIG{TERM} = 'IGNORE';
758 local $SIG{TSTP} = 'IGNORE';
759 local $SIG{PIPE} = 'IGNORE';
761 $sth->execute or return $sth->errstr;
763 # get inserted id from the database, if applicable & needed
764 if ( $db_seq && ! $self->getfield($primary_key) ) {
765 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
769 if ( driver_name eq 'Pg' ) {
771 #my $oid = $sth->{'pg_oid_status'};
772 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
774 my $default = $self->dbdef_table->column($primary_key)->default;
775 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
776 dbh->rollback if $FS::UID::AutoCommit;
777 return "can't parse $table.$primary_key default value".
778 " for sequence name: $default";
782 my $i_sql = "SELECT currval('$sequence')";
783 my $i_sth = dbh->prepare($i_sql) or do {
784 dbh->rollback if $FS::UID::AutoCommit;
787 #$i_sth->execute($oid) or do {
788 $i_sth->execute() or do {
789 dbh->rollback if $FS::UID::AutoCommit;
790 return $i_sth->errstr;
792 $insertid = $i_sth->fetchrow_arrayref->[0];
794 } elsif ( driver_name eq 'mysql' ) {
796 $insertid = dbh->{'mysql_insertid'};
797 # work around mysql_insertid being null some of the time, ala RT :/
798 unless ( $insertid ) {
799 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
800 "using SELECT LAST_INSERT_ID();";
801 my $i_sql = "SELECT LAST_INSERT_ID()";
802 my $i_sth = dbh->prepare($i_sql) or do {
803 dbh->rollback if $FS::UID::AutoCommit;
806 $i_sth->execute or do {
807 dbh->rollback if $FS::UID::AutoCommit;
808 return $i_sth->errstr;
810 $insertid = $i_sth->fetchrow_arrayref->[0];
815 dbh->rollback if $FS::UID::AutoCommit;
816 return "don't know how to retreive inserted ids from ". driver_name.
817 ", try using counterfiles (maybe run dbdef-create?)";
821 $self->setfield($primary_key, $insertid);
826 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
827 $self->virtual_fields;
828 if (@virtual_fields) {
829 my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
831 my $vfieldpart = $self->vfieldpart_hashref;
833 my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
836 my $v_sth = dbh->prepare($v_statement) or do {
837 dbh->rollback if $FS::UID::AutoCommit;
841 foreach (keys(%v_values)) {
842 $v_sth->execute($self->getfield($primary_key),
846 dbh->rollback if $FS::UID::AutoCommit;
847 return $v_sth->errstr;
854 if ( defined dbdef->table('h_'. $table) ) {
855 my $h_statement = $self->_h_statement('insert');
856 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
857 $h_sth = dbh->prepare($h_statement) or do {
858 dbh->rollback if $FS::UID::AutoCommit;
864 $h_sth->execute or return $h_sth->errstr if $h_sth;
866 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
868 # Now that it has been saved, reset the encrypted fields so that $new
870 foreach my $field (keys %{$saved}) {
871 $self->setfield($field, $saved->{$field});
879 Depriciated (use insert instead).
884 cluck "warning: FS::Record::add deprecated!";
885 insert @_; #call method in this scope
890 Delete this record from the database. If there is an error, returns the error,
891 otherwise returns false.
898 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
900 $self->getfield($_) eq ''
901 #? "( $_ IS NULL OR $_ = \"\" )"
902 ? ( driver_name eq 'Pg'
904 : "( $_ IS NULL OR $_ = \"\" )"
906 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
907 } ( $self->dbdef_table->primary_key )
908 ? ( $self->dbdef_table->primary_key)
909 : real_fields($self->table)
911 warn "[debug]$me $statement\n" if $DEBUG > 1;
912 my $sth = dbh->prepare($statement) or return dbh->errstr;
915 if ( defined dbdef->table('h_'. $self->table) ) {
916 my $h_statement = $self->_h_statement('delete');
917 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
918 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
923 my $primary_key = $self->dbdef_table->primary_key;
926 my $vfp = $self->vfieldpart_hashref;
927 foreach($self->virtual_fields) {
928 next if $self->getfield($_) eq '';
929 unless(@del_vfields) {
930 my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
931 $v_sth = dbh->prepare($st) or return dbh->errstr;
933 push @del_vfields, $_;
936 local $SIG{HUP} = 'IGNORE';
937 local $SIG{INT} = 'IGNORE';
938 local $SIG{QUIT} = 'IGNORE';
939 local $SIG{TERM} = 'IGNORE';
940 local $SIG{TSTP} = 'IGNORE';
941 local $SIG{PIPE} = 'IGNORE';
943 my $rc = $sth->execute or return $sth->errstr;
944 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
945 $h_sth->execute or return $h_sth->errstr if $h_sth;
946 $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
947 or return $v_sth->errstr
948 foreach (@del_vfields);
950 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
952 #no need to needlessly destoy the data either (causes problems actually)
953 #undef $self; #no need to keep object!
960 Depriciated (use delete instead).
965 cluck "warning: FS::Record::del deprecated!";
966 &delete(@_); #call method in this scope
969 =item replace OLD_RECORD
971 Replace the OLD_RECORD with this one in the database. If there is an error,
972 returns the error, otherwise returns false.
977 my ($new, $old) = (shift, shift);
979 $old = $new->replace_old unless defined($old);
981 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
983 if ( $new->can('replace_check') ) {
984 my $error = $new->replace_check($old);
985 return $error if $error;
988 return "Records not in same table!" unless $new->table eq $old->table;
990 my $primary_key = $old->dbdef_table->primary_key;
991 return "Can't change primary key $primary_key ".
992 'from '. $old->getfield($primary_key).
993 ' to ' . $new->getfield($primary_key)
995 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
997 my $error = $new->check;
998 return $error if $error;
1000 # Encrypt for replace
1001 my $conf = new FS::Conf;
1003 if ($conf->exists('encryption') && defined(eval '@FS::'. $new->table . '::encrypted_fields')) {
1004 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1005 $saved->{$field} = $new->getfield($field);
1006 $new->setfield($field, $new->encrypt($new->getfield($field)));
1010 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1011 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1012 ? ($_, $new->getfield($_)) : () } $old->fields;
1014 unless ( keys(%diff) ) {
1015 carp "[warning]$me $new -> replace $old: records identical"
1016 unless $nowarn_identical;
1020 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1022 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1023 } real_fields($old->table)
1028 if ( $old->getfield($_) eq '' ) {
1030 #false laziness w/qsearch
1031 if ( driver_name eq 'Pg' ) {
1032 my $type = $old->dbdef_table->column($_)->type;
1033 if ( $type =~ /(int|(big)?serial)/i ) {
1036 qq-( $_ IS NULL OR $_ = '' )-;
1039 qq-( $_ IS NULL OR $_ = "" )-;
1043 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1046 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1049 warn "[debug]$me $statement\n" if $DEBUG > 1;
1050 my $sth = dbh->prepare($statement) or return dbh->errstr;
1053 if ( defined dbdef->table('h_'. $old->table) ) {
1054 my $h_old_statement = $old->_h_statement('replace_old');
1055 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1056 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1062 if ( defined dbdef->table('h_'. $new->table) ) {
1063 my $h_new_statement = $new->_h_statement('replace_new');
1064 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1065 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1070 # For virtual fields we have three cases with different SQL
1071 # statements: add, replace, delete
1075 my (@add_vfields, @rep_vfields, @del_vfields);
1076 my $vfp = $old->vfieldpart_hashref;
1077 foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
1078 if($diff{$_} eq '') {
1080 unless(@del_vfields) {
1081 my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
1082 "AND vfieldpart = ?";
1083 warn "[debug]$me $st\n" if $DEBUG > 2;
1084 $v_del_sth = dbh->prepare($st) or return dbh->errstr;
1086 push @del_vfields, $_;
1087 } elsif($old->getfield($_) eq '') {
1089 unless(@add_vfields) {
1090 my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
1092 warn "[debug]$me $st\n" if $DEBUG > 2;
1093 $v_add_sth = dbh->prepare($st) or return dbh->errstr;
1095 push @add_vfields, $_;
1098 unless(@rep_vfields) {
1099 my $st = "UPDATE virtual_field SET value = ? ".
1100 "WHERE recnum = ? AND vfieldpart = ?";
1101 warn "[debug]$me $st\n" if $DEBUG > 2;
1102 $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
1104 push @rep_vfields, $_;
1108 local $SIG{HUP} = 'IGNORE';
1109 local $SIG{INT} = 'IGNORE';
1110 local $SIG{QUIT} = 'IGNORE';
1111 local $SIG{TERM} = 'IGNORE';
1112 local $SIG{TSTP} = 'IGNORE';
1113 local $SIG{PIPE} = 'IGNORE';
1115 my $rc = $sth->execute or return $sth->errstr;
1116 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1117 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1118 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1120 $v_del_sth->execute($old->getfield($primary_key),
1122 or return $v_del_sth->errstr
1123 foreach(@del_vfields);
1125 $v_add_sth->execute($new->getfield($_),
1126 $old->getfield($primary_key),
1128 or return $v_add_sth->errstr
1129 foreach(@add_vfields);
1131 $v_rep_sth->execute($new->getfield($_),
1132 $old->getfield($primary_key),
1134 or return $v_rep_sth->errstr
1135 foreach(@rep_vfields);
1137 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1139 # Now that it has been saved, reset the encrypted fields so that $new
1140 # can still be used.
1141 foreach my $field (keys %{$saved}) {
1142 $new->setfield($field, $saved->{$field});
1150 my( $self ) = shift;
1151 warn "[$me] replace called with no arguments; autoloading old record\n"
1154 my $primary_key = $self->dbdef_table->primary_key;
1155 if ( $primary_key ) {
1156 $self->by_key( $self->$primary_key() ) #this is what's returned
1157 or croak "can't find ". $self->table. ".$primary_key ".
1158 $self->$primary_key();
1160 croak $self->table. " has no primary key; pass old record as argument";
1167 Depriciated (use replace instead).
1172 cluck "warning: FS::Record::rep deprecated!";
1173 replace @_; #call method in this scope
1178 Checks virtual fields (using check_blocks). Subclasses should still provide
1179 a check method to validate real fields, foreign keys, etc., and call this
1180 method via $self->SUPER::check.
1182 (FIXME: Should this method try to make sure that it I<is> being called from
1183 a subclass's check method, to keep the current semantics as far as possible?)
1188 #confess "FS::Record::check not implemented; supply one in subclass!";
1191 foreach my $field ($self->virtual_fields) {
1192 for ($self->getfield($field)) {
1193 # See notes on check_block in FS::part_virtual_field.
1194 eval $self->pvf($field)->check_block;
1196 #this is bad, probably want to follow the stack backtrace up and see
1198 my $err = "Fatal error checking $field for $self";
1200 return "$err (see log for backtrace): $@";
1203 $self->setfield($field, $_);
1210 my( $self, $action, $time ) = @_;
1215 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1216 real_fields($self->table);
1219 # If we're encrypting then don't ever store the payinfo or CVV2 in the history....
1220 # You can see if it changed by the paymask...
1221 if ($conf->exists('encryption') ) {
1222 @fields = grep $_ ne 'payinfo' && $_ ne 'cvv2', @fields;
1224 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1226 "INSERT INTO h_". $self->table. " ( ".
1227 join(', ', qw(history_date history_user history_action), @fields ).
1229 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1236 B<Warning>: External use is B<deprecated>.
1238 Replaces COLUMN in record with a unique number, using counters in the
1239 filesystem. Used by the B<insert> method on single-field unique columns
1240 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1241 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1243 Returns the new value.
1248 my($self,$field) = @_;
1249 my($table)=$self->table;
1251 croak "Unique called on field $field, but it is ",
1252 $self->getfield($field),
1254 if $self->getfield($field);
1256 #warn "table $table is tainted" if is_tainted($table);
1257 #warn "field $field is tainted" if is_tainted($field);
1259 my($counter) = new File::CounterFile "$table.$field",0;
1261 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1263 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1266 my $index = $counter->inc;
1267 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1269 $index =~ /^(\d*)$/;
1272 $self->setfield($field,$index);
1276 =item ut_float COLUMN
1278 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1279 null. If there is an error, returns the error, otherwise returns false.
1284 my($self,$field)=@_ ;
1285 ($self->getfield($field) =~ /^(\d+\.\d+)$/ ||
1286 $self->getfield($field) =~ /^(\d+)$/ ||
1287 $self->getfield($field) =~ /^(\d+\.\d+e\d+)$/ ||
1288 $self->getfield($field) =~ /^(\d+e\d+)$/)
1289 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1290 $self->setfield($field,$1);
1293 =item ut_floatn COLUMN
1295 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1296 null. If there is an error, returns the error, otherwise returns false.
1301 my($self,$field)=@_ ;
1302 ($self->getfield($field) =~ /^(\d*)$/ ||
1303 $self->getfield($field) =~ /^(-?\d+\.\d+)$/ ||
1304 $self->getfield($field) =~ /^(-?\d+)$/ ||
1305 $self->getfield($field) =~ /^(-?\d+\.\d+e\d+)$/ ||
1306 $self->getfield($field) =~ /^(-?\d+e\d+)$/)
1307 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1308 $self->setfield($field,$1);
1311 =item ut_floatn COLUMN
1313 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1314 null. If there is an error, returns the error, otherwise returns false.
1318 #false laziness w/ut_ipn
1320 my( $self, $field ) = @_;
1321 if ( $self->getfield($field) =~ /^()$/ ) {
1322 $self->setfield($field,'');
1325 $self->ut_float($field);
1329 =item ut_snumber COLUMN
1331 Check/untaint signed numeric data (whole numbers). If there is an error,
1332 returns the error, otherwise returns false.
1337 my($self, $field) = @_;
1338 $self->getfield($field) =~ /^(-?)\s*(\d+)$/
1339 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1340 $self->setfield($field, "$1$2");
1344 =item ut_snumbern COLUMN
1346 Check/untaint signed numeric data (whole numbers). If there is an error,
1347 returns the error, otherwise returns false.
1352 my($self, $field) = @_;
1353 $self->getfield($field) =~ /^(-?)\s*(\d*)$/
1354 or return "Illegal (numeric) $field: ". $self->getfield($field);
1356 return "Illegal (numeric) $field: ". $self->getfield($field)
1359 $self->setfield($field, "$1$2");
1363 =item ut_number COLUMN
1365 Check/untaint simple numeric data (whole numbers). May not be null. If there
1366 is an error, returns the error, otherwise returns false.
1371 my($self,$field)=@_;
1372 $self->getfield($field) =~ /^(\d+)$/
1373 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1374 $self->setfield($field,$1);
1378 =item ut_numbern COLUMN
1380 Check/untaint simple numeric data (whole numbers). May be null. If there is
1381 an error, returns the error, otherwise returns false.
1386 my($self,$field)=@_;
1387 $self->getfield($field) =~ /^(\d*)$/
1388 or return "Illegal (numeric) $field: ". $self->getfield($field);
1389 $self->setfield($field,$1);
1393 =item ut_money COLUMN
1395 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
1396 is an error, returns the error, otherwise returns false.
1401 my($self,$field)=@_;
1402 $self->setfield($field, 0) if $self->getfield($field) eq '';
1403 $self->getfield($field) =~ /^(\-)? ?(\d*)(\.\d{2})?$/
1404 or return "Illegal (money) $field: ". $self->getfield($field);
1405 #$self->setfield($field, "$1$2$3" || 0);
1406 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
1410 =item ut_text COLUMN
1412 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1413 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ]
1414 May not be null. If there is an error, returns the error, otherwise returns
1420 my($self,$field)=@_;
1421 #warn "msgcat ". \&msgcat. "\n";
1422 #warn "notexist ". \¬exist. "\n";
1423 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
1424 $self->getfield($field)
1425 =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]]+)$/
1426 or return gettext('illegal_or_empty_text'). " $field: ".
1427 $self->getfield($field);
1428 $self->setfield($field,$1);
1432 =item ut_textn COLUMN
1434 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1435 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
1436 May be null. If there is an error, returns the error, otherwise returns false.
1441 my($self,$field)=@_;
1442 $self->getfield($field)
1443 =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]]*)$/
1444 or return gettext('illegal_text'). " $field: ". $self->getfield($field);
1445 $self->setfield($field,$1);
1449 =item ut_alpha COLUMN
1451 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
1452 an error, returns the error, otherwise returns false.
1457 my($self,$field)=@_;
1458 $self->getfield($field) =~ /^(\w+)$/
1459 or return "Illegal or empty (alphanumeric) $field: ".
1460 $self->getfield($field);
1461 $self->setfield($field,$1);
1465 =item ut_alpha COLUMN
1467 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
1468 error, returns the error, otherwise returns false.
1473 my($self,$field)=@_;
1474 $self->getfield($field) =~ /^(\w*)$/
1475 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
1476 $self->setfield($field,$1);
1480 =item ut_phonen COLUMN [ COUNTRY ]
1482 Check/untaint phone numbers. May be null. If there is an error, returns
1483 the error, otherwise returns false.
1485 Takes an optional two-letter ISO country code; without it or with unsupported
1486 countries, ut_phonen simply calls ut_alphan.
1491 my( $self, $field, $country ) = @_;
1492 return $self->ut_alphan($field) unless defined $country;
1493 my $phonen = $self->getfield($field);
1494 if ( $phonen eq '' ) {
1495 $self->setfield($field,'');
1496 } elsif ( $country eq 'US' || $country eq 'CA' ) {
1498 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
1499 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
1500 $phonen = "$1-$2-$3";
1501 $phonen .= " x$4" if $4;
1502 $self->setfield($field,$phonen);
1504 warn "warning: don't know how to check phone numbers for country $country";
1505 return $self->ut_textn($field);
1512 Check/untaint hexadecimal values.
1517 my($self, $field) = @_;
1518 $self->getfield($field) =~ /^([\da-fA-F]+)$/
1519 or return "Illegal (hex) $field: ". $self->getfield($field);
1520 $self->setfield($field, uc($1));
1524 =item ut_hexn COLUMN
1526 Check/untaint hexadecimal values. May be null.
1531 my($self, $field) = @_;
1532 $self->getfield($field) =~ /^([\da-fA-F]*)$/
1533 or return "Illegal (hex) $field: ". $self->getfield($field);
1534 $self->setfield($field, uc($1));
1539 Check/untaint ip addresses. IPv4 only for now.
1544 my( $self, $field ) = @_;
1545 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
1546 or return "Illegal (IP address) $field: ". $self->getfield($field);
1547 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
1548 $self->setfield($field, "$1.$2.$3.$4");
1554 Check/untaint ip addresses. IPv4 only for now. May be null.
1559 my( $self, $field ) = @_;
1560 if ( $self->getfield($field) =~ /^()$/ ) {
1561 $self->setfield($field,'');
1564 $self->ut_ip($field);
1568 =item ut_domain COLUMN
1570 Check/untaint host and domain names.
1575 my( $self, $field ) = @_;
1576 #$self->getfield($field) =~/^(\w+\.)*\w+$/
1577 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
1578 or return "Illegal (domain) $field: ". $self->getfield($field);
1579 $self->setfield($field,$1);
1583 =item ut_name COLUMN
1585 Check/untaint proper names; allows alphanumerics, spaces and the following
1586 punctuation: , . - '
1593 my( $self, $field ) = @_;
1594 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
1595 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
1596 $self->setfield($field,$1);
1602 Check/untaint zip codes.
1606 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
1609 my( $self, $field, $country ) = @_;
1611 if ( $country eq 'US' ) {
1613 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
1614 or return gettext('illegal_zip'). " $field for country $country: ".
1615 $self->getfield($field);
1616 $self->setfield($field, $1);
1618 } elsif ( $country eq 'CA' ) {
1620 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
1621 or return gettext('illegal_zip'). " $field for country $country: ".
1622 $self->getfield($field);
1623 $self->setfield($field, "$1 $2");
1627 if ( $self->getfield($field) =~ /^\s*$/
1628 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
1631 $self->setfield($field,'');
1633 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
1634 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
1635 $self->setfield($field,$1);
1643 =item ut_country COLUMN
1645 Check/untaint country codes. Country names are changed to codes, if possible -
1646 see L<Locale::Country>.
1651 my( $self, $field ) = @_;
1652 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
1653 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
1654 && country2code($1) ) {
1655 $self->setfield($field,uc(country2code($1)));
1658 $self->getfield($field) =~ /^(\w\w)$/
1659 or return "Illegal (country) $field: ". $self->getfield($field);
1660 $self->setfield($field,uc($1));
1664 =item ut_anything COLUMN
1666 Untaints arbitrary data. Be careful.
1671 my( $self, $field ) = @_;
1672 $self->getfield($field) =~ /^(.*)$/s
1673 or return "Illegal $field: ". $self->getfield($field);
1674 $self->setfield($field,$1);
1678 =item ut_enum COLUMN CHOICES_ARRAYREF
1680 Check/untaint a column, supplying all possible choices, like the "enum" type.
1685 my( $self, $field, $choices ) = @_;
1686 foreach my $choice ( @$choices ) {
1687 if ( $self->getfield($field) eq $choice ) {
1688 $self->setfield($choice);
1692 return "Illegal (enum) field $field: ". $self->getfield($field);
1695 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1697 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
1698 on the column first.
1702 sub ut_foreign_key {
1703 my( $self, $field, $table, $foreign ) = @_;
1704 qsearchs($table, { $foreign => $self->getfield($field) })
1705 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
1706 " in $table.$foreign";
1710 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
1712 Like ut_foreign_key, except the null value is also allowed.
1716 sub ut_foreign_keyn {
1717 my( $self, $field, $table, $foreign ) = @_;
1718 $self->getfield($field)
1719 ? $self->ut_foreign_key($field, $table, $foreign)
1723 =item ut_agentnum_acl
1725 Checks this column as an agentnum, taking into account the current users's
1730 sub ut_agentnum_acl {
1731 my( $self, $field, $null_acl ) = @_;
1733 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
1734 return "Illegal agentnum: $error" if $error;
1736 my $curuser = $FS::CurrentUser::CurrentUser;
1738 if ( $self->$field() ) {
1740 return "Access deined"
1741 unless $curuser->agentnum($self->$field());
1745 return "Access denied"
1746 unless $curuser->access_right($null_acl);
1754 =item virtual_fields [ TABLE ]
1756 Returns a list of virtual fields defined for the table. This should not
1757 be exported, and should only be called as an instance or class method.
1761 sub virtual_fields {
1764 $table = $self->table or confess "virtual_fields called on non-table";
1766 confess "Unknown table $table" unless dbdef->table($table);
1768 return () unless dbdef->table('part_virtual_field');
1770 unless ( $virtual_fields_cache{$table} ) {
1771 my $query = 'SELECT name from part_virtual_field ' .
1772 "WHERE dbtable = '$table'";
1774 my $result = $dbh->selectcol_arrayref($query);
1775 confess "Error executing virtual fields query: $query: ". $dbh->errstr
1777 $virtual_fields_cache{$table} = $result;
1780 @{$virtual_fields_cache{$table}};
1785 =item fields [ TABLE ]
1787 This is a wrapper for real_fields and virtual_fields. Code that called
1788 fields before should probably continue to call fields.
1793 my $something = shift;
1795 if($something->isa('FS::Record')) {
1796 $table = $something->table;
1798 $table = $something;
1799 $something = "FS::$table";
1801 return (real_fields($table), $something->virtual_fields());
1806 =item pvf FIELD_NAME
1808 Returns the FS::part_virtual_field object corresponding to a field in the
1809 record (specified by FIELD_NAME).
1814 my ($self, $name) = (shift, shift);
1816 if(grep /^$name$/, $self->virtual_fields) {
1817 return qsearchs('part_virtual_field', { dbtable => $self->table,
1827 =item real_fields [ TABLE ]
1829 Returns a list of the real columns in the specified table. Called only by
1830 fields() and other subroutines elsewhere in FS::Record.
1837 my($table_obj) = dbdef->table($table);
1838 confess "Unknown table $table" unless $table_obj;
1839 $table_obj->columns;
1842 =item _quote VALUE, TABLE, COLUMN
1844 This is an internal function used to construct SQL statements. It returns
1845 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
1846 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
1851 my($value, $table, $column) = @_;
1852 my $column_obj = dbdef->table($table)->column($column);
1853 my $column_type = $column_obj->type;
1854 my $nullable = $column_obj->null;
1856 warn " $table.$column: $value ($column_type".
1857 ( $nullable ? ' NULL' : ' NOT NULL' ).
1858 ")\n" if $DEBUG > 2;
1860 if ( $value eq '' && $nullable ) {
1862 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
1863 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
1866 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
1867 ! $column_type =~ /(char|binary|text)$/i ) {
1874 =item vfieldpart_hashref TABLE
1876 Returns a hashref of virtual field names and vfieldparts applicable to the given
1881 sub vfieldpart_hashref {
1883 my $table = $self->table;
1885 return {} unless dbdef->table('part_virtual_field');
1888 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
1889 "dbtable = '$table'";
1890 my $sth = $dbh->prepare($statement);
1891 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
1892 return { map { $_->{name}, $_->{vfieldpart} }
1893 @{$sth->fetchall_arrayref({})} };
1900 This is deprecated. Don't use it.
1902 It returns a hash-type list with the fields of this record's table set true.
1907 carp "warning: hfields is deprecated";
1910 foreach (fields($table)) {
1919 "$_: ". $self->getfield($_). "|"
1920 } (fields($self->table)) );
1923 =item encrypt($value)
1925 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
1927 Returns the encrypted string.
1929 You should generally not have to worry about calling this, as the system handles this for you.
1935 my ($self, $value) = @_;
1938 my $conf = new FS::Conf;
1939 if ($conf->exists('encryption')) {
1940 if ($self->is_encrypted($value)) {
1941 # Return the original value if it isn't plaintext.
1942 $encrypted = $value;
1945 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
1946 # RSA doesn't like the empty string so let's pack it up
1947 # The database doesn't like the RSA data so uuencode it
1948 my $length = length($value)+1;
1949 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
1951 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
1958 =item is_encrypted($value)
1960 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
1966 my ($self, $value) = @_;
1967 # Possible Bug - Some work may be required here....
1969 if ($value =~ /^M/ && length($value) > 80) {
1976 =item decrypt($value)
1978 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
1980 You should generally not have to worry about calling this, as the system handles this for you.
1985 my ($self,$value) = @_;
1986 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
1987 my $conf = new FS::Conf;
1988 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
1990 if (ref($rsa_decrypt) =~ /::RSA/) {
1991 my $encrypted = unpack ("u*", $value);
1992 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
1993 if ($@) {warn "Decryption Failed"};
2001 #Initialize the Module
2002 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2004 my $conf = new FS::Conf;
2005 if ($conf->exists('encryptionmodule') && $conf->config('encryptionmodule') ne '') {
2006 $rsa_module = $conf->config('encryptionmodule');
2010 eval ("require $rsa_module"); # No need to import the namespace
2013 # Initialize Encryption
2014 if ($conf->exists('encryptionpublickey') && $conf->config('encryptionpublickey') ne '') {
2015 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2016 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2019 # Intitalize Decryption
2020 if ($conf->exists('encryptionprivatekey') && $conf->config('encryptionprivatekey') ne '') {
2021 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2022 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2026 sub DESTROY { return; }
2030 # #use Carp qw(cluck);
2031 # #cluck "DESTROYING $self";
2032 # warn "DESTROYING $self";
2036 # return ! eval { join('',@_), kill 0; 1; };
2043 This module should probably be renamed, since much of the functionality is
2044 of general use. It is not completely unlike Adapter::DBI (see below).
2046 Exported qsearch and qsearchs should be deprecated in favor of method calls
2047 (against an FS::Record object like the old search and searchs that qsearch
2048 and qsearchs were on top of.)
2050 The whole fields / hfields mess should be removed.
2052 The various WHERE clauses should be subroutined.
2054 table string should be deprecated in favor of DBIx::DBSchema::Table.
2056 No doubt we could benefit from a Tied hash. Documenting how exists / defined
2057 true maps to the database (and WHERE clauses) would also help.
2059 The ut_ methods should ask the dbdef for a default length.
2061 ut_sqltype (like ut_varchar) should all be defined
2063 A fallback check method should be provided which uses the dbdef.
2065 The ut_money method assumes money has two decimal digits.
2067 The Pg money kludge in the new method only strips `$'.
2069 The ut_phonen method only checks US-style phone numbers.
2071 The _quote function should probably use ut_float instead of a regex.
2073 All the subroutines probably should be methods, here or elsewhere.
2075 Probably should borrow/use some dbdef methods where appropriate (like sub
2078 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
2079 or allow it to be set. Working around it is ugly any way around - DBI should
2080 be fixed. (only affects RDBMS which return uppercase column names)
2082 ut_zip should take an optional country like ut_phone.
2086 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
2088 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.