4 use vars qw( $AUTOLOAD @ISA @EXPORT_OK $DEBUG
7 $nowarn_identical $no_update_diff $no_check_foreign
10 use Carp qw(carp cluck croak confess);
11 use Scalar::Util qw( blessed );
12 use File::CounterFile;
15 use File::Slurp qw( slurp );
16 use DBI qw(:sql_types);
17 use DBIx::DBSchema 0.33;
18 use FS::UID qw(dbh getotaker datasrc driver_name);
20 use FS::Schema qw(dbdef);
22 use FS::Msgcat qw(gettext);
23 #use FS::Conf; #dependency loop bs, in install_callback below instead
25 use FS::part_virtual_field;
31 #export dbdef for now... everything else expects to find it here
32 @EXPORT_OK = qw(dbh fields hfields qsearch qsearchs dbdef jsearch
33 str2time_sql str2time_sql_closing );
38 $nowarn_identical = 0;
40 $no_check_foreign = 0;
47 FS::UID->install_callback( sub {
50 $conf = FS::Conf->new;
51 $File::CounterFile::DEFAULT_DIR = $conf->base_dir . "/counters.". datasrc;
57 FS::Record - Database record objects
62 use FS::Record qw(dbh fields qsearch qsearchs);
64 $record = new FS::Record 'table', \%hash;
65 $record = new FS::Record 'table', { 'column' => 'value', ... };
67 $record = qsearchs FS::Record 'table', \%hash;
68 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
69 @records = qsearch FS::Record 'table', \%hash;
70 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };
72 $table = $record->table;
73 $dbdef_table = $record->dbdef_table;
75 $value = $record->get('column');
76 $value = $record->getfield('column');
77 $value = $record->column;
79 $record->set( 'column' => 'value' );
80 $record->setfield( 'column' => 'value' );
81 $record->column('value');
83 %hash = $record->hash;
85 $hashref = $record->hashref;
87 $error = $record->insert;
89 $error = $record->delete;
91 $error = $new_record->replace($old_record);
93 # external use deprecated - handled by the database (at least for Pg, mysql)
94 $value = $record->unique('column');
96 $error = $record->ut_float('column');
97 $error = $record->ut_floatn('column');
98 $error = $record->ut_number('column');
99 $error = $record->ut_numbern('column');
100 $error = $record->ut_snumber('column');
101 $error = $record->ut_snumbern('column');
102 $error = $record->ut_money('column');
103 $error = $record->ut_text('column');
104 $error = $record->ut_textn('column');
105 $error = $record->ut_alpha('column');
106 $error = $record->ut_alphan('column');
107 $error = $record->ut_phonen('column');
108 $error = $record->ut_anything('column');
109 $error = $record->ut_name('column');
111 $quoted_value = _quote($value,'table','field');
114 $fields = hfields('table');
115 if ( $fields->{Field} ) { # etc.
117 @fields = fields 'table'; #as a subroutine
118 @fields = $record->fields; #as a method call
123 (Mostly) object-oriented interface to database records. Records are currently
124 implemented on top of DBI. FS::Record is intended as a base class for
125 table-specific classes to inherit from, i.e. FS::cust_main.
131 =item new [ TABLE, ] HASHREF
133 Creates a new record. It doesn't store it in the database, though. See
134 L<"insert"> for that.
136 Note that the object stores this hash reference, not a distinct copy of the
137 hash it points to. You can ask the object for a copy with the I<hash>
140 TABLE can only be omitted when a dervived class overrides the table method.
146 my $class = ref($proto) || $proto;
148 bless ($self, $class);
150 unless ( defined ( $self->table ) ) {
151 $self->{'Table'} = shift;
152 carp "warning: FS::Record::new called with table name ". $self->{'Table'};
155 $self->{'Hash'} = shift;
157 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
158 $self->{'Hash'}{$field}='';
161 $self->_rebless if $self->can('_rebless');
163 $self->{'modified'} = 0;
165 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
172 my $class = ref($proto) || $proto;
174 bless ($self, $class);
176 $self->{'Table'} = shift unless defined ( $self->table );
178 my $hashref = $self->{'Hash'} = shift;
180 if ( defined( $cache->cache->{$hashref->{$cache->key}} ) ) {
181 my $obj = $cache->cache->{$hashref->{$cache->key}};
182 $obj->_cache($hashref, $cache) if $obj->can('_cache');
185 $cache->cache->{$hashref->{$cache->key}} = $self->new($hashref, $cache);
192 my $class = ref($proto) || $proto;
194 bless ($self, $class);
195 if ( defined $self->table ) {
196 cluck "create constructor is deprecated, use new!";
199 croak "FS::Record::create called (not from a subclass)!";
203 =item qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
205 Searches the database for all records matching (at least) the key/value pairs
206 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
207 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
210 The preferred usage is to pass a hash reference of named parameters:
212 my @records = qsearch( {
213 'table' => 'table_name',
214 'hashref' => { 'field' => 'value'
215 'field' => { 'op' => '<',
220 #these are optional...
222 'extra_sql' => 'AND field ',
223 'order_by' => 'ORDER BY something',
224 #'cache_obj' => '', #optional
225 'addl_from' => 'LEFT JOIN othtable USING ( field )',
230 Much code still uses old-style positional parameters, this is also probably
231 fine in the common case where there are only two parameters:
233 my @records = qsearch( 'table', { 'field' => 'value' } );
235 ###oops, argh, FS::Record::new only lets us create database fields.
236 #Normal behaviour if SELECT is not specified is `*', as in
237 #C<SELECT * FROM table WHERE ...>. However, there is an experimental new
238 #feature where you can specify SELECT - remember, the objects returned,
239 #although blessed into the appropriate `FS::TABLE' package, will only have the
240 #fields you specify. This might have unwanted results if you then go calling
241 #regular FS::TABLE methods
246 my %TYPE = (); #for debugging
249 my($stable, $record, $select, $extra_sql, $order_by, $cache, $addl_from );
251 if ( ref($_[0]) ) { #hashref for now, eventually maybe accept a list too
253 $stable = $opt->{'table'} or die "table name is required";
254 $record = $opt->{'hashref'} || {};
255 $select = $opt->{'select'} || '*';
256 $extra_sql = $opt->{'extra_sql'} || '';
257 $order_by = $opt->{'order_by'} || '';
258 $cache = $opt->{'cache_obj'} || '';
259 $addl_from = $opt->{'addl_from'} || '';
260 $debug = $opt->{'debug'} || '';
262 ($stable, $record, $select, $extra_sql, $cache, $addl_from ) = @_;
266 #$stable =~ /^([\w\_]+)$/ or die "Illegal table: $table";
268 $stable =~ /^([\w\s\(\)\.\,\=]+)$/ or die "Illegal table: $stable";
272 my $table = $cache ? $cache->table : $stable;
273 my $dbdef_table = dbdef->table($table)
274 or die "No schema for table $table found - ".
275 "do you need to run freeside-upgrade?";
276 my $pkey = $dbdef_table->primary_key;
278 my @real_fields = grep exists($record->{$_}), real_fields($table);
280 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
281 @virtual_fields = grep exists($record->{$_}), "FS::$table"->virtual_fields;
283 cluck "warning: FS::$table not loaded; virtual fields not searchable";
284 @virtual_fields = ();
287 my $statement = "SELECT $select FROM $stable";
288 $statement .= " $addl_from" if $addl_from;
289 if ( @real_fields or @virtual_fields ) {
290 $statement .= ' WHERE '. join(' AND ',
291 get_real_fields($table, $record, \@real_fields) ,
292 get_virtual_fields($table, $pkey, $record, \@virtual_fields),
296 $statement .= " $extra_sql" if defined($extra_sql);
297 $statement .= " $order_by" if defined($order_by);
299 warn "[debug]$me $statement\n" if $DEBUG > 1 || $debug;
300 my $sth = $dbh->prepare($statement)
301 or croak "$dbh->errstr doing $statement";
306 grep defined( $record->{$_} ) && $record->{$_} ne '', @real_fields
309 my $value = $record->{$field};
310 $value = $value->{'value'} if ref($value);
311 my $type = dbdef->table($table)->column($field)->type;
313 my $TYPE = SQL_VARCHAR;
314 if ( $type =~ /(int|(big)?serial)/i && $value =~ /^\d+(\.\d+)?$/ ) {
317 #DBD::Pg 1.49: Cannot bind ... unknown sql_type 6 with SQL_FLOAT
318 } elsif ( ( $type =~ /(numeric)/i && $value =~ /^[+-]?\d+(\.\d+)?$/)
319 || ( $type =~ /(real|float4)/i
320 && $value =~ /[-+]?\d*\.?\d+([eE][-+]?\d+)?/
328 %TYPE = map { &{"DBI::$_"}() => $_ } @{ $DBI::EXPORT_TAGS{sql_types} }
330 warn " bind_param $bind (for field $field), $value, TYPE $TYPE{$TYPE}\n";
333 $sth->bind_param($bind++, $value, { TYPE => $TYPE } );
337 # $sth->execute( map $record->{$_},
338 # grep defined( $record->{$_} ) && $record->{$_} ne '', @fields
339 # ) or croak "Error executing \"$statement\": ". $sth->errstr;
341 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
343 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
344 @virtual_fields = "FS::$table"->virtual_fields;
346 cluck "warning: FS::$table not loaded; virtual fields not returned either";
347 @virtual_fields = ();
351 tie %result, "Tie::IxHash";
352 my @stuff = @{ $sth->fetchall_arrayref( {} ) };
353 if ( $pkey && scalar(@stuff) && $stuff[0]->{$pkey} ) {
354 %result = map { $_->{$pkey}, $_ } @stuff;
356 @result{@stuff} = @stuff;
361 if ( keys(%result) and @virtual_fields ) {
363 "SELECT virtual_field.recnum, part_virtual_field.name, ".
364 "virtual_field.value ".
365 "FROM part_virtual_field JOIN virtual_field USING (vfieldpart) ".
366 "WHERE part_virtual_field.dbtable = '$table' AND ".
367 "virtual_field.recnum IN (".
368 join(',', keys(%result)). ") AND part_virtual_field.name IN ('".
369 join(q!', '!, @virtual_fields) . "')";
370 warn "[debug]$me $statement\n" if $DEBUG > 1;
371 $sth = $dbh->prepare($statement) or croak "$dbh->errstr doing $statement";
372 $sth->execute or croak "Error executing \"$statement\": ". $sth->errstr;
374 foreach (@{ $sth->fetchall_arrayref({}) }) {
375 my $recnum = $_->{recnum};
376 my $name = $_->{name};
377 my $value = $_->{value};
378 if (exists($result{$recnum})) {
379 $result{$recnum}->{$name} = $value;
384 if ( eval 'scalar(@FS::'. $table. '::ISA);' ) {
385 if ( eval 'FS::'. $table. '->can(\'new\')' eq \&new ) {
386 #derivied class didn't override new method, so this optimization is safe
389 new_or_cached( "FS::$table", { %{$_} }, $cache )
393 new( "FS::$table", { %{$_} } )
397 #okay, its been tested
398 # warn "untested code (class FS::$table uses custom new method)";
400 eval 'FS::'. $table. '->new( { %{$_} } )';
404 # Check for encrypted fields and decrypt them.
405 ## only in the local copy, not the cached object
406 if ( $conf && $conf->exists('encryption') # $conf doesn't exist when doing
407 # the initial search for
409 && eval 'defined(@FS::'. $table . '::encrypted_fields)') {
410 foreach my $record (@return) {
411 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
412 # Set it directly... This may cause a problem in the future...
413 $record->setfield($field, $record->decrypt($record->getfield($field)));
418 cluck "warning: FS::$table not loaded; returning FS::Record objects";
420 FS::Record->new( $table, { %{$_} } );
426 ## makes this easier to read
428 sub get_virtual_fields {
432 my $virtual_fields = shift;
438 if ( ref($record->{$_}) ) {
439 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
440 if ( uc($op) eq 'ILIKE' ) {
442 $record->{$_}{'value'} = lc($record->{$_}{'value'});
443 $column = "LOWER($_)";
445 $record->{$_} = $record->{$_}{'value'};
448 # ... EXISTS ( SELECT name, value FROM part_virtual_field
450 # ON part_virtual_field.vfieldpart = virtual_field.vfieldpart
451 # WHERE recnum = svc_acct.svcnum
452 # AND (name, value) = ('egad', 'brain') )
454 my $value = $record->{$_};
458 $subq = ($value ? 'EXISTS ' : 'NOT EXISTS ') .
459 "( SELECT part_virtual_field.name, virtual_field.value ".
460 "FROM part_virtual_field JOIN virtual_field ".
461 "ON part_virtual_field.vfieldpart = virtual_field.vfieldpart ".
462 "WHERE virtual_field.recnum = ${table}.${pkey} ".
463 "AND part_virtual_field.name = '${column}'".
465 " AND virtual_field.value ${op} '${value}'"
469 } @{ $virtual_fields } ) ;
472 sub get_real_fields {
475 my $real_fields = shift;
477 ## this huge map was previously inline, just broke it out to help read the qsearch method, should be optimized for readability
483 if ( ref($record->{$_}) ) {
484 $op = $record->{$_}{'op'} if $record->{$_}{'op'};
485 #$op = 'LIKE' if $op =~ /^ILIKE$/i && driver_name ne 'Pg';
486 if ( uc($op) eq 'ILIKE' ) {
488 $record->{$_}{'value'} = lc($record->{$_}{'value'});
489 $column = "LOWER($_)";
491 $record->{$_} = $record->{$_}{'value'}
494 if ( ! defined( $record->{$_} ) || $record->{$_} eq '' ) {
496 if ( driver_name eq 'Pg' ) {
497 my $type = dbdef->table($table)->column($column)->type;
498 if ( $type =~ /(int|(big)?serial)/i ) {
499 qq-( $column IS NULL )-;
501 qq-( $column IS NULL OR $column = '' )-;
504 qq-( $column IS NULL OR $column = "" )-;
506 } elsif ( $op eq '!=' ) {
507 if ( driver_name eq 'Pg' ) {
508 my $type = dbdef->table($table)->column($column)->type;
509 if ( $type =~ /(int|(big)?serial)/i ) {
510 qq-( $column IS NOT NULL )-;
512 qq-( $column IS NOT NULL AND $column != '' )-;
515 qq-( $column IS NOT NULL AND $column != "" )-;
518 if ( driver_name eq 'Pg' ) {
519 qq-( $column $op '' )-;
521 qq-( $column $op "" )-;
527 } @{ $real_fields } );
530 =item by_key PRIMARY_KEY_VALUE
532 This is a class method that returns the record with the given primary key
533 value. This method is only useful in FS::Record subclasses. For example:
535 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1
539 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );
544 my ($class, $pkey_value) = @_;
546 my $table = $class->table
547 or croak "No table for $class found";
549 my $dbdef_table = dbdef->table($table)
550 or die "No schema for table $table found - ".
551 "do you need to create it or run dbdef-create?";
552 my $pkey = $dbdef_table->primary_key
553 or die "No primary key for table $table";
555 return qsearchs($table, { $pkey => $pkey_value });
558 =item jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
560 Experimental JOINed search method. Using this method, you can execute a
561 single SELECT spanning multiple tables, and cache the results for subsequent
562 method calls. Interface will almost definately change in an incompatible
570 my($table, $record, $select, $extra_sql, $ptable, $pkey ) = @_;
571 my $cache = FS::SearchCache->new( $ptable, $pkey );
574 grep { !$saw{$_->getfield($pkey)}++ }
575 qsearch($table, $record, $select, $extra_sql, $cache )
579 =item qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
581 Same as qsearch, except that if more than one record matches, it B<carp>s but
582 returns the first. If this happens, you either made a logic error in asking
583 for a single item, or your data is corrupted.
587 sub qsearchs { # $result_record = &FS::Record:qsearchs('table',\%hash);
589 my(@result) = qsearch(@_);
590 cluck "warning: Multiple records in scalar search ($table)"
591 if scalar(@result) > 1;
592 #should warn more vehemently if the search was on a primary key?
593 scalar(@result) ? ($result[0]) : ();
604 Returns the table name.
609 # cluck "warning: FS::Record::table deprecated; supply one in subclass!";
616 Returns the DBIx::DBSchema::Table object for the table.
622 my($table)=$self->table;
623 dbdef->table($table);
628 Returns the primary key for the table.
634 my $pkey = $self->dbdef_table->primary_key;
637 =item get, getfield COLUMN
639 Returns the value of the column/field/key COLUMN.
644 my($self,$field) = @_;
645 # to avoid "Use of unitialized value" errors
646 if ( defined ( $self->{Hash}->{$field} ) ) {
647 $self->{Hash}->{$field};
657 =item set, setfield COLUMN, VALUE
659 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
664 my($self,$field,$value) = @_;
665 $self->{'modified'} = 1;
666 $self->{'Hash'}->{$field} = $value;
673 =item AUTLOADED METHODS
675 $record->column is a synonym for $record->get('column');
677 $record->column('value') is a synonym for $record->set('column','value');
684 my($field)=$AUTOLOAD;
686 if ( defined($value) ) {
687 confess "errant AUTOLOAD $field for $self (arg $value)"
688 unless blessed($self) && $self->can('setfield');
689 $self->setfield($field,$value);
691 confess "errant AUTOLOAD $field for $self (no args)"
692 unless blessed($self) && $self->can('getfield');
693 $self->getfield($field);
699 # my $field = $AUTOLOAD;
701 # if ( defined($_[1]) ) {
702 # $_[0]->setfield($field, $_[1]);
704 # $_[0]->getfield($field);
710 Returns a list of the column/value pairs, usually for assigning to a new hash.
712 To make a distinct duplicate of an FS::Record object, you can do:
714 $new = new FS::Record ( $old->table, { $old->hash } );
720 confess $self. ' -> hash: Hash attribute is undefined'
721 unless defined($self->{'Hash'});
722 %{ $self->{'Hash'} };
727 Returns a reference to the column/value hash. This may be deprecated in the
728 future; if there's a reason you can't just use the autoloaded or get/set
740 Returns true if any of this object's values have been modified with set (or via
741 an autoloaded method). Doesn't yet recognize when you retreive a hashref and
751 =item select_for_update
753 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
758 sub select_for_update {
760 my $primary_key = $self->primary_key;
763 'table' => $self->table,
764 'hashref' => { $primary_key => $self->$primary_key() },
765 'extra_sql' => 'FOR UPDATE',
771 Inserts this record to the database. If there is an error, returns the error,
772 otherwise returns false.
780 warn "$self -> insert" if $DEBUG;
782 my $error = $self->check;
783 return $error if $error;
785 #single-field unique keys are given a value if false
786 #(like MySQL's AUTO_INCREMENT or Pg SERIAL)
787 foreach ( $self->dbdef_table->unique_singles) {
788 $self->unique($_) unless $self->getfield($_);
791 #and also the primary key, if the database isn't going to
792 my $primary_key = $self->dbdef_table->primary_key;
794 if ( $primary_key ) {
795 my $col = $self->dbdef_table->column($primary_key);
798 uc($col->type) =~ /^(BIG)?SERIAL\d?/
799 || ( driver_name eq 'Pg'
800 && defined($col->default)
801 && $col->default =~ /^nextval\(/i
803 || ( driver_name eq 'mysql'
804 && defined($col->local)
805 && $col->local =~ /AUTO_INCREMENT/i
807 $self->unique($primary_key) unless $self->getfield($primary_key) || $db_seq;
810 my $table = $self->table;
812 # Encrypt before the database
813 if ( defined(eval '@FS::'. $table . '::encrypted_fields')
814 && scalar( eval '@FS::'. $table . '::encrypted_fields')
815 && $conf->exists('encryption')
817 foreach my $field (eval '@FS::'. $table . '::encrypted_fields') {
818 $self->{'saved'} = $self->getfield($field);
819 $self->setfield($field, $self->encrypt($self->getfield($field)));
823 #false laziness w/delete
825 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
828 my @values = map { _quote( $self->getfield($_), $table, $_) } @real_fields;
831 my $statement = "INSERT INTO $table ";
832 if ( @real_fields ) {
835 join( ', ', @real_fields ).
837 join( ', ', @values ).
841 $statement .= 'DEFAULT VALUES';
843 warn "[debug]$me $statement\n" if $DEBUG > 1;
844 my $sth = dbh->prepare($statement) or return dbh->errstr;
846 local $SIG{HUP} = 'IGNORE';
847 local $SIG{INT} = 'IGNORE';
848 local $SIG{QUIT} = 'IGNORE';
849 local $SIG{TERM} = 'IGNORE';
850 local $SIG{TSTP} = 'IGNORE';
851 local $SIG{PIPE} = 'IGNORE';
853 $sth->execute or return $sth->errstr;
855 # get inserted id from the database, if applicable & needed
856 if ( $db_seq && ! $self->getfield($primary_key) ) {
857 warn "[debug]$me retreiving sequence from database\n" if $DEBUG;
861 if ( driver_name eq 'Pg' ) {
863 #my $oid = $sth->{'pg_oid_status'};
864 #my $i_sql = "SELECT $primary_key FROM $table WHERE oid = ?";
866 my $default = $self->dbdef_table->column($primary_key)->default;
867 unless ( $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i ) {
868 dbh->rollback if $FS::UID::AutoCommit;
869 return "can't parse $table.$primary_key default value".
870 " for sequence name: $default";
874 my $i_sql = "SELECT currval('$sequence')";
875 my $i_sth = dbh->prepare($i_sql) or do {
876 dbh->rollback if $FS::UID::AutoCommit;
879 $i_sth->execute() or do { #$i_sth->execute($oid)
880 dbh->rollback if $FS::UID::AutoCommit;
881 return $i_sth->errstr;
883 $insertid = $i_sth->fetchrow_arrayref->[0];
885 } elsif ( driver_name eq 'mysql' ) {
887 $insertid = dbh->{'mysql_insertid'};
888 # work around mysql_insertid being null some of the time, ala RT :/
889 unless ( $insertid ) {
890 warn "WARNING: DBD::mysql didn't return mysql_insertid; ".
891 "using SELECT LAST_INSERT_ID();";
892 my $i_sql = "SELECT LAST_INSERT_ID()";
893 my $i_sth = dbh->prepare($i_sql) or do {
894 dbh->rollback if $FS::UID::AutoCommit;
897 $i_sth->execute or do {
898 dbh->rollback if $FS::UID::AutoCommit;
899 return $i_sth->errstr;
901 $insertid = $i_sth->fetchrow_arrayref->[0];
906 dbh->rollback if $FS::UID::AutoCommit;
907 return "don't know how to retreive inserted ids from ". driver_name.
908 ", try using counterfiles (maybe run dbdef-create?)";
912 $self->setfield($primary_key, $insertid);
917 grep defined($self->getfield($_)) && $self->getfield($_) ne "",
918 $self->virtual_fields;
919 if (@virtual_fields) {
920 my %v_values = map { $_, $self->getfield($_) } @virtual_fields;
922 my $vfieldpart = $self->vfieldpart_hashref;
924 my $v_statement = "INSERT INTO virtual_field(recnum, vfieldpart, value) ".
927 my $v_sth = dbh->prepare($v_statement) or do {
928 dbh->rollback if $FS::UID::AutoCommit;
932 foreach (keys(%v_values)) {
933 $v_sth->execute($self->getfield($primary_key),
937 dbh->rollback if $FS::UID::AutoCommit;
938 return $v_sth->errstr;
945 if ( defined dbdef->table('h_'. $table) ) {
946 my $h_statement = $self->_h_statement('insert');
947 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
948 $h_sth = dbh->prepare($h_statement) or do {
949 dbh->rollback if $FS::UID::AutoCommit;
955 $h_sth->execute or return $h_sth->errstr if $h_sth;
957 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
959 # Now that it has been saved, reset the encrypted fields so that $new
961 foreach my $field (keys %{$saved}) {
962 $self->setfield($field, $saved->{$field});
970 Depriciated (use insert instead).
975 cluck "warning: FS::Record::add deprecated!";
976 insert @_; #call method in this scope
981 Delete this record from the database. If there is an error, returns the error,
982 otherwise returns false.
989 my $statement = "DELETE FROM ". $self->table. " WHERE ". join(' AND ',
991 $self->getfield($_) eq ''
992 #? "( $_ IS NULL OR $_ = \"\" )"
993 ? ( driver_name eq 'Pg'
995 : "( $_ IS NULL OR $_ = \"\" )"
997 : "$_ = ". _quote($self->getfield($_),$self->table,$_)
998 } ( $self->dbdef_table->primary_key )
999 ? ( $self->dbdef_table->primary_key)
1000 : real_fields($self->table)
1002 warn "[debug]$me $statement\n" if $DEBUG > 1;
1003 my $sth = dbh->prepare($statement) or return dbh->errstr;
1006 if ( defined dbdef->table('h_'. $self->table) ) {
1007 my $h_statement = $self->_h_statement('delete');
1008 warn "[debug]$me $h_statement\n" if $DEBUG > 2;
1009 $h_sth = dbh->prepare($h_statement) or return dbh->errstr;
1014 my $primary_key = $self->dbdef_table->primary_key;
1017 my $vfp = $self->vfieldpart_hashref;
1018 foreach($self->virtual_fields) {
1019 next if $self->getfield($_) eq '';
1020 unless(@del_vfields) {
1021 my $st = "DELETE FROM virtual_field WHERE recnum = ? AND vfieldpart = ?";
1022 $v_sth = dbh->prepare($st) or return dbh->errstr;
1024 push @del_vfields, $_;
1027 local $SIG{HUP} = 'IGNORE';
1028 local $SIG{INT} = 'IGNORE';
1029 local $SIG{QUIT} = 'IGNORE';
1030 local $SIG{TERM} = 'IGNORE';
1031 local $SIG{TSTP} = 'IGNORE';
1032 local $SIG{PIPE} = 'IGNORE';
1034 my $rc = $sth->execute or return $sth->errstr;
1035 #not portable #return "Record not found, statement:\n$statement" if $rc eq "0E0";
1036 $h_sth->execute or return $h_sth->errstr if $h_sth;
1037 $v_sth->execute($self->getfield($primary_key), $vfp->{$_})
1038 or return $v_sth->errstr
1039 foreach (@del_vfields);
1041 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1043 #no need to needlessly destoy the data either (causes problems actually)
1044 #undef $self; #no need to keep object!
1051 Depriciated (use delete instead).
1056 cluck "warning: FS::Record::del deprecated!";
1057 &delete(@_); #call method in this scope
1060 =item replace OLD_RECORD
1062 Replace the OLD_RECORD with this one in the database. If there is an error,
1063 returns the error, otherwise returns false.
1068 my ($new, $old) = (shift, shift);
1070 $old = $new->replace_old unless defined($old);
1072 warn "[debug]$me $new ->replace $old\n" if $DEBUG;
1074 if ( $new->can('replace_check') ) {
1075 my $error = $new->replace_check($old);
1076 return $error if $error;
1079 return "Records not in same table!" unless $new->table eq $old->table;
1081 my $primary_key = $old->dbdef_table->primary_key;
1082 return "Can't change primary key $primary_key ".
1083 'from '. $old->getfield($primary_key).
1084 ' to ' . $new->getfield($primary_key)
1086 && ( $old->getfield($primary_key) ne $new->getfield($primary_key) );
1088 my $error = $new->check;
1089 return $error if $error;
1091 # Encrypt for replace
1093 if ($conf->exists('encryption') && defined(eval '@FS::'. $new->table . '::encrypted_fields')) {
1094 foreach my $field (eval '@FS::'. $new->table . '::encrypted_fields') {
1095 $saved->{$field} = $new->getfield($field);
1096 $new->setfield($field, $new->encrypt($new->getfield($field)));
1100 #my @diff = grep $new->getfield($_) ne $old->getfield($_), $old->fields;
1101 my %diff = map { ($new->getfield($_) ne $old->getfield($_))
1102 ? ($_, $new->getfield($_)) : () } $old->fields;
1104 unless (keys(%diff) || $no_update_diff ) {
1105 carp "[warning]$me $new -> replace $old: records identical"
1106 unless $nowarn_identical;
1110 my $statement = "UPDATE ". $old->table. " SET ". join(', ',
1112 "$_ = ". _quote($new->getfield($_),$old->table,$_)
1113 } real_fields($old->table)
1118 if ( $old->getfield($_) eq '' ) {
1120 #false laziness w/qsearch
1121 if ( driver_name eq 'Pg' ) {
1122 my $type = $old->dbdef_table->column($_)->type;
1123 if ( $type =~ /(int|(big)?serial)/i ) {
1126 qq-( $_ IS NULL OR $_ = '' )-;
1129 qq-( $_ IS NULL OR $_ = "" )-;
1133 "$_ = ". _quote($old->getfield($_),$old->table,$_);
1136 } ( $primary_key ? ( $primary_key ) : real_fields($old->table) )
1139 warn "[debug]$me $statement\n" if $DEBUG > 1;
1140 my $sth = dbh->prepare($statement) or return dbh->errstr;
1143 if ( defined dbdef->table('h_'. $old->table) ) {
1144 my $h_old_statement = $old->_h_statement('replace_old');
1145 warn "[debug]$me $h_old_statement\n" if $DEBUG > 2;
1146 $h_old_sth = dbh->prepare($h_old_statement) or return dbh->errstr;
1152 if ( defined dbdef->table('h_'. $new->table) ) {
1153 my $h_new_statement = $new->_h_statement('replace_new');
1154 warn "[debug]$me $h_new_statement\n" if $DEBUG > 2;
1155 $h_new_sth = dbh->prepare($h_new_statement) or return dbh->errstr;
1160 # For virtual fields we have three cases with different SQL
1161 # statements: add, replace, delete
1165 my (@add_vfields, @rep_vfields, @del_vfields);
1166 my $vfp = $old->vfieldpart_hashref;
1167 foreach(grep { exists($diff{$_}) } $new->virtual_fields) {
1168 if($diff{$_} eq '') {
1170 unless(@del_vfields) {
1171 my $st = "DELETE FROM virtual_field WHERE recnum = ? ".
1172 "AND vfieldpart = ?";
1173 warn "[debug]$me $st\n" if $DEBUG > 2;
1174 $v_del_sth = dbh->prepare($st) or return dbh->errstr;
1176 push @del_vfields, $_;
1177 } elsif($old->getfield($_) eq '') {
1179 unless(@add_vfields) {
1180 my $st = "INSERT INTO virtual_field (value, recnum, vfieldpart) ".
1182 warn "[debug]$me $st\n" if $DEBUG > 2;
1183 $v_add_sth = dbh->prepare($st) or return dbh->errstr;
1185 push @add_vfields, $_;
1188 unless(@rep_vfields) {
1189 my $st = "UPDATE virtual_field SET value = ? ".
1190 "WHERE recnum = ? AND vfieldpart = ?";
1191 warn "[debug]$me $st\n" if $DEBUG > 2;
1192 $v_rep_sth = dbh->prepare($st) or return dbh->errstr;
1194 push @rep_vfields, $_;
1198 local $SIG{HUP} = 'IGNORE';
1199 local $SIG{INT} = 'IGNORE';
1200 local $SIG{QUIT} = 'IGNORE';
1201 local $SIG{TERM} = 'IGNORE';
1202 local $SIG{TSTP} = 'IGNORE';
1203 local $SIG{PIPE} = 'IGNORE';
1205 my $rc = $sth->execute or return $sth->errstr;
1206 #not portable #return "Record not found (or records identical)." if $rc eq "0E0";
1207 $h_old_sth->execute or return $h_old_sth->errstr if $h_old_sth;
1208 $h_new_sth->execute or return $h_new_sth->errstr if $h_new_sth;
1210 $v_del_sth->execute($old->getfield($primary_key),
1212 or return $v_del_sth->errstr
1213 foreach(@del_vfields);
1215 $v_add_sth->execute($new->getfield($_),
1216 $old->getfield($primary_key),
1218 or return $v_add_sth->errstr
1219 foreach(@add_vfields);
1221 $v_rep_sth->execute($new->getfield($_),
1222 $old->getfield($primary_key),
1224 or return $v_rep_sth->errstr
1225 foreach(@rep_vfields);
1227 dbh->commit or croak dbh->errstr if $FS::UID::AutoCommit;
1229 # Now that it has been saved, reset the encrypted fields so that $new
1230 # can still be used.
1231 foreach my $field (keys %{$saved}) {
1232 $new->setfield($field, $saved->{$field});
1240 my( $self ) = shift;
1241 warn "[$me] replace called with no arguments; autoloading old record\n"
1244 my $primary_key = $self->dbdef_table->primary_key;
1245 if ( $primary_key ) {
1246 $self->by_key( $self->$primary_key() ) #this is what's returned
1247 or croak "can't find ". $self->table. ".$primary_key ".
1248 $self->$primary_key();
1250 croak $self->table. " has no primary key; pass old record as argument";
1257 Depriciated (use replace instead).
1262 cluck "warning: FS::Record::rep deprecated!";
1263 replace @_; #call method in this scope
1268 Checks virtual fields (using check_blocks). Subclasses should still provide
1269 a check method to validate real fields, foreign keys, etc., and call this
1270 method via $self->SUPER::check.
1272 (FIXME: Should this method try to make sure that it I<is> being called from
1273 a subclass's check method, to keep the current semantics as far as possible?)
1278 #confess "FS::Record::check not implemented; supply one in subclass!";
1281 foreach my $field ($self->virtual_fields) {
1282 for ($self->getfield($field)) {
1283 # See notes on check_block in FS::part_virtual_field.
1284 eval $self->pvf($field)->check_block;
1286 #this is bad, probably want to follow the stack backtrace up and see
1288 my $err = "Fatal error checking $field for $self";
1290 return "$err (see log for backtrace): $@";
1293 $self->setfield($field, $_);
1299 =item batch_import PARAM_HASHREF
1301 Class method for batch imports. Available params:
1307 FS::queue object, will be updated with progress
1313 use Storable qw(thaw);
1316 sub process_batch_import {
1317 my($job, $opt) = ( shift, shift );
1319 my $table = $opt->{table};
1320 my @pass_params = @{ $opt->{params} };
1321 my %formats = %{ $opt->{formats} };
1323 my $param = thaw(decode_base64(shift));
1324 warn Dumper($param) if $DEBUG;
1326 my $files = $param->{'uploaded_files'}
1327 or die "No files provided.\n";
1329 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
1331 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
1332 my $file = $dir. $files{'file'};
1335 if ( $file =~ /\.(\w+)$/i ) {
1339 warn "can't parse file type from filename $file; defaulting to CSV";
1344 FS::Record::batch_import( {
1346 formats => \%formats,
1350 format => $param->{format},
1351 params => { map { $_ => $param->{$_} } @pass_params },
1356 die "$error\n" if $error;
1362 my $table = $param->{table};
1363 my $formats = $param->{formats};
1364 my $params = $param->{params};
1366 my $job = $param->{job};
1368 my $filename = $param->{file};
1369 my $type = $param->{type} || 'csv';
1371 my $format = $param->{'format'};
1373 die "unknown format $format" unless exists $formats->{ $format };
1374 my @fields = @{ $formats->{ $format } };
1379 if ( $type eq 'csv' ) {
1381 $parser = new Text::CSV_XS;
1383 @buffer = split(/\r?\n/, slurp($filename) );
1384 $count = scalar(@buffer);
1386 } elsif ( $type eq 'xls' ) {
1388 eval "use Spreadsheet::ParseExcel;";
1391 my $excel = new Spreadsheet::ParseExcel::Workbook->Parse($filename);
1392 $parser = $excel->{Worksheet}[0]; #first sheet
1394 $count = $parser->{MaxRow} || $parser->{MinRow};
1398 die "Unknown file type $type\n";
1403 local $SIG{HUP} = 'IGNORE';
1404 local $SIG{INT} = 'IGNORE';
1405 local $SIG{QUIT} = 'IGNORE';
1406 local $SIG{TERM} = 'IGNORE';
1407 local $SIG{TSTP} = 'IGNORE';
1408 local $SIG{PIPE} = 'IGNORE';
1410 my $oldAutoCommit = $FS::UID::AutoCommit;
1411 local $FS::UID::AutoCommit = 0;
1416 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1420 if ( $type eq 'csv' ) {
1422 last unless scalar(@buffer);
1423 $line = shift(@buffer);
1425 $parser->parse($line) or do {
1426 $dbh->rollback if $oldAutoCommit;
1427 return "can't parse: ". $parser->error_input();
1429 @columns = $parser->fields();
1431 } elsif ( $type eq 'xls' ) {
1433 last if $row > ($parser->{MaxRow} || $parser->{MinRow});
1435 my @row = @{ $parser->{Cells}[$row] };
1436 @columns = map $_->{Val}, @row;
1439 #warn $z++. ": $_\n" for @columns;
1442 die "Unknown file type $type\n";
1445 my %hash = %$params;
1447 foreach my $field ( @fields ) {
1449 my $value = shift @columns;
1451 if ( ref($field) eq 'CODE' ) {
1452 &{$field}(\%hash, $value);
1454 $hash{$field} = $value if length($value);
1459 my $class = "FS::$table";
1461 my $record = $class->new( \%hash );
1463 my $error = $record->insert;
1466 $dbh->rollback if $oldAutoCommit;
1467 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1472 if ( $job && time - $min_sec > $last ) { #progress bar
1473 $job->update_statustext( int(100 * $row / $count) );
1479 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1481 return "Empty file!" unless $row;
1488 my( $self, $action, $time ) = @_;
1493 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1494 real_fields($self->table);
1497 # If we're encrypting then don't ever store the payinfo or CVV2 in the history....
1498 # You can see if it changed by the paymask...
1499 if ($conf && $conf->exists('encryption') ) {
1500 @fields = grep $_ ne 'payinfo' && $_ ne 'cvv2', @fields;
1502 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1504 "INSERT INTO h_". $self->table. " ( ".
1505 join(', ', qw(history_date history_user history_action), @fields ).
1507 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1514 B<Warning>: External use is B<deprecated>.
1516 Replaces COLUMN in record with a unique number, using counters in the
1517 filesystem. Used by the B<insert> method on single-field unique columns
1518 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1519 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1521 Returns the new value.
1526 my($self,$field) = @_;
1527 my($table)=$self->table;
1529 croak "Unique called on field $field, but it is ",
1530 $self->getfield($field),
1532 if $self->getfield($field);
1534 #warn "table $table is tainted" if is_tainted($table);
1535 #warn "field $field is tainted" if is_tainted($field);
1537 my($counter) = new File::CounterFile "$table.$field",0;
1539 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1541 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1544 my $index = $counter->inc;
1545 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1547 $index =~ /^(\d*)$/;
1550 $self->setfield($field,$index);
1554 =item ut_float COLUMN
1556 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1557 null. If there is an error, returns the error, otherwise returns false.
1562 my($self,$field)=@_ ;
1563 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
1564 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
1565 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
1566 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
1567 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1568 $self->setfield($field,$1);
1571 =item ut_floatn COLUMN
1573 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1574 null. If there is an error, returns the error, otherwise returns false.
1578 #false laziness w/ut_ipn
1580 my( $self, $field ) = @_;
1581 if ( $self->getfield($field) =~ /^()$/ ) {
1582 $self->setfield($field,'');
1585 $self->ut_float($field);
1589 =item ut_sfloat COLUMN
1591 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
1592 May not be null. If there is an error, returns the error, otherwise returns
1598 my($self,$field)=@_ ;
1599 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
1600 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
1601 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
1602 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
1603 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1604 $self->setfield($field,$1);
1607 =item ut_sfloatn COLUMN
1609 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1610 null. If there is an error, returns the error, otherwise returns false.
1615 my( $self, $field ) = @_;
1616 if ( $self->getfield($field) =~ /^()$/ ) {
1617 $self->setfield($field,'');
1620 $self->ut_sfloat($field);
1624 =item ut_snumber COLUMN
1626 Check/untaint signed numeric data (whole numbers). If there is an error,
1627 returns the error, otherwise returns false.
1632 my($self, $field) = @_;
1633 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
1634 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1635 $self->setfield($field, "$1$2");
1639 =item ut_snumbern COLUMN
1641 Check/untaint signed numeric data (whole numbers). If there is an error,
1642 returns the error, otherwise returns false.
1647 my($self, $field) = @_;
1648 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
1649 or return "Illegal (numeric) $field: ". $self->getfield($field);
1651 return "Illegal (numeric) $field: ". $self->getfield($field)
1654 $self->setfield($field, "$1$2");
1658 =item ut_number COLUMN
1660 Check/untaint simple numeric data (whole numbers). May not be null. If there
1661 is an error, returns the error, otherwise returns false.
1666 my($self,$field)=@_;
1667 $self->getfield($field) =~ /^\s*(\d+)\s*$/
1668 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1669 $self->setfield($field,$1);
1673 =item ut_numbern COLUMN
1675 Check/untaint simple numeric data (whole numbers). May be null. If there is
1676 an error, returns the error, otherwise returns false.
1681 my($self,$field)=@_;
1682 $self->getfield($field) =~ /^\s*(\d*)\s*$/
1683 or return "Illegal (numeric) $field: ". $self->getfield($field);
1684 $self->setfield($field,$1);
1688 =item ut_money COLUMN
1690 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
1691 is an error, returns the error, otherwise returns false.
1696 my($self,$field)=@_;
1697 $self->setfield($field, 0) if $self->getfield($field) eq '';
1698 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
1699 or return "Illegal (money) $field: ". $self->getfield($field);
1700 #$self->setfield($field, "$1$2$3" || 0);
1701 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
1705 =item ut_text COLUMN
1707 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1708 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ]
1709 May not be null. If there is an error, returns the error, otherwise returns
1715 my($self,$field)=@_;
1716 #warn "msgcat ". \&msgcat. "\n";
1717 #warn "notexist ". \¬exist. "\n";
1718 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
1719 $self->getfield($field)
1720 =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]]+)$/
1721 or return gettext('illegal_or_empty_text'). " $field: ".
1722 $self->getfield($field);
1723 $self->setfield($field,$1);
1727 =item ut_textn COLUMN
1729 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1730 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
1731 May be null. If there is an error, returns the error, otherwise returns false.
1736 my($self,$field)=@_;
1737 $self->getfield($field)
1738 =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]]*)$/
1739 or return gettext('illegal_text'). " $field: ". $self->getfield($field);
1740 $self->setfield($field,$1);
1744 =item ut_alpha COLUMN
1746 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
1747 an error, returns the error, otherwise returns false.
1752 my($self,$field)=@_;
1753 $self->getfield($field) =~ /^(\w+)$/
1754 or return "Illegal or empty (alphanumeric) $field: ".
1755 $self->getfield($field);
1756 $self->setfield($field,$1);
1760 =item ut_alpha COLUMN
1762 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
1763 error, returns the error, otherwise returns false.
1768 my($self,$field)=@_;
1769 $self->getfield($field) =~ /^(\w*)$/
1770 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
1771 $self->setfield($field,$1);
1775 =item ut_alpha_lower COLUMN
1777 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
1778 there is an error, returns the error, otherwise returns false.
1782 sub ut_alpha_lower {
1783 my($self,$field)=@_;
1784 $self->getfield($field) =~ /[[:upper:]]/
1785 and return "Uppercase characters are not permitted in $field";
1786 $self->ut_alpha($field);
1789 =item ut_phonen COLUMN [ COUNTRY ]
1791 Check/untaint phone numbers. May be null. If there is an error, returns
1792 the error, otherwise returns false.
1794 Takes an optional two-letter ISO country code; without it or with unsupported
1795 countries, ut_phonen simply calls ut_alphan.
1800 my( $self, $field, $country ) = @_;
1801 return $self->ut_alphan($field) unless defined $country;
1802 my $phonen = $self->getfield($field);
1803 if ( $phonen eq '' ) {
1804 $self->setfield($field,'');
1805 } elsif ( $country eq 'US' || $country eq 'CA' ) {
1807 $phonen = $conf->config('cust_main-default_areacode').$phonen
1808 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
1809 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
1810 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
1811 $phonen = "$1-$2-$3";
1812 $phonen .= " x$4" if $4;
1813 $self->setfield($field,$phonen);
1815 warn "warning: don't know how to check phone numbers for country $country";
1816 return $self->ut_textn($field);
1823 Check/untaint hexadecimal values.
1828 my($self, $field) = @_;
1829 $self->getfield($field) =~ /^([\da-fA-F]+)$/
1830 or return "Illegal (hex) $field: ". $self->getfield($field);
1831 $self->setfield($field, uc($1));
1835 =item ut_hexn COLUMN
1837 Check/untaint hexadecimal values. May be null.
1842 my($self, $field) = @_;
1843 $self->getfield($field) =~ /^([\da-fA-F]*)$/
1844 or return "Illegal (hex) $field: ". $self->getfield($field);
1845 $self->setfield($field, uc($1));
1850 Check/untaint ip addresses. IPv4 only for now.
1855 my( $self, $field ) = @_;
1856 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
1857 or return "Illegal (IP address) $field: ". $self->getfield($field);
1858 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
1859 $self->setfield($field, "$1.$2.$3.$4");
1865 Check/untaint ip addresses. IPv4 only for now. May be null.
1870 my( $self, $field ) = @_;
1871 if ( $self->getfield($field) =~ /^()$/ ) {
1872 $self->setfield($field,'');
1875 $self->ut_ip($field);
1879 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
1881 Check/untaint coordinates.
1882 Accepts the following forms:
1892 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
1893 The latter form (that is, the MMM are thousands of minutes) is
1894 assumed if the "MMM" is exactly three digits or two digits > 59.
1896 To be safe, just use the DDD.DDDDD form.
1898 If LOWER or UPPER are specified, then the coordinate is checked
1899 for lower and upper bounds, respectively.
1905 my ($self, $field) = (shift, shift);
1907 my $lower = shift if scalar(@_);
1908 my $upper = shift if scalar(@_);
1909 my $coord = $self->getfield($field);
1910 my $neg = $coord =~ s/^(-)//;
1912 my ($d, $m, $s) = (0, 0, 0);
1915 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
1916 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
1917 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
1919 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
1922 return "Invalid (coordinate with minutes > 59) $field: "
1923 . $self->getfield($field);
1926 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
1928 if (defined($lower) and ($coord < $lower)) {
1929 return "Invalid (coordinate < $lower) $field: "
1930 . $self->getfield($field);;
1933 if (defined($upper) and ($coord > $upper)) {
1934 return "Invalid (coordinate > $upper) $field: "
1935 . $self->getfield($field);;
1938 $self->setfield($field, $coord);
1942 return "Invalid (coordinate) $field: " . $self->getfield($field);
1946 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
1948 Same as ut_coord, except optionally null.
1954 my ($self, $field) = (shift, shift);
1956 if ($self->getfield($field) =~ /^$/) {
1959 return $self->ut_coord($field, @_);
1965 =item ut_domain COLUMN
1967 Check/untaint host and domain names.
1972 my( $self, $field ) = @_;
1973 #$self->getfield($field) =~/^(\w+\.)*\w+$/
1974 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
1975 or return "Illegal (domain) $field: ". $self->getfield($field);
1976 $self->setfield($field,$1);
1980 =item ut_name COLUMN
1982 Check/untaint proper names; allows alphanumerics, spaces and the following
1983 punctuation: , . - '
1990 my( $self, $field ) = @_;
1991 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
1992 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
1993 $self->setfield($field,$1);
1999 Check/untaint zip codes.
2003 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2006 my( $self, $field, $country ) = @_;
2008 if ( $country eq 'US' ) {
2010 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2011 or return gettext('illegal_zip'). " $field for country $country: ".
2012 $self->getfield($field);
2013 $self->setfield($field, $1);
2015 } elsif ( $country eq 'CA' ) {
2017 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2018 or return gettext('illegal_zip'). " $field for country $country: ".
2019 $self->getfield($field);
2020 $self->setfield($field, "$1 $2");
2024 if ( $self->getfield($field) =~ /^\s*$/
2025 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2028 $self->setfield($field,'');
2030 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
2031 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2032 $self->setfield($field,$1);
2040 =item ut_country COLUMN
2042 Check/untaint country codes. Country names are changed to codes, if possible -
2043 see L<Locale::Country>.
2048 my( $self, $field ) = @_;
2049 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2050 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2051 && country2code($1) ) {
2052 $self->setfield($field,uc(country2code($1)));
2055 $self->getfield($field) =~ /^(\w\w)$/
2056 or return "Illegal (country) $field: ". $self->getfield($field);
2057 $self->setfield($field,uc($1));
2061 =item ut_anything COLUMN
2063 Untaints arbitrary data. Be careful.
2068 my( $self, $field ) = @_;
2069 $self->getfield($field) =~ /^(.*)$/s
2070 or return "Illegal $field: ". $self->getfield($field);
2071 $self->setfield($field,$1);
2075 =item ut_enum COLUMN CHOICES_ARRAYREF
2077 Check/untaint a column, supplying all possible choices, like the "enum" type.
2082 my( $self, $field, $choices ) = @_;
2083 foreach my $choice ( @$choices ) {
2084 if ( $self->getfield($field) eq $choice ) {
2085 $self->setfield($choice);
2089 return "Illegal (enum) field $field: ". $self->getfield($field);
2092 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2094 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2095 on the column first.
2099 sub ut_foreign_key {
2100 my( $self, $field, $table, $foreign ) = @_;
2101 return '' if $no_check_foreign;
2102 qsearchs($table, { $foreign => $self->getfield($field) })
2103 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2104 " in $table.$foreign";
2108 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2110 Like ut_foreign_key, except the null value is also allowed.
2114 sub ut_foreign_keyn {
2115 my( $self, $field, $table, $foreign ) = @_;
2116 $self->getfield($field)
2117 ? $self->ut_foreign_key($field, $table, $foreign)
2121 =item ut_agentnum_acl
2123 Checks this column as an agentnum, taking into account the current users's
2128 sub ut_agentnum_acl {
2129 my( $self, $field, $null_acl ) = @_;
2131 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2132 return "Illegal agentnum: $error" if $error;
2134 my $curuser = $FS::CurrentUser::CurrentUser;
2136 if ( $self->$field() ) {
2138 return "Access denied"
2139 unless $curuser->agentnum($self->$field());
2143 return "Access denied"
2144 unless $curuser->access_right($null_acl);
2152 =item virtual_fields [ TABLE ]
2154 Returns a list of virtual fields defined for the table. This should not
2155 be exported, and should only be called as an instance or class method.
2159 sub virtual_fields {
2162 $table = $self->table or confess "virtual_fields called on non-table";
2164 confess "Unknown table $table" unless dbdef->table($table);
2166 return () unless dbdef->table('part_virtual_field');
2168 unless ( $virtual_fields_cache{$table} ) {
2169 my $query = 'SELECT name from part_virtual_field ' .
2170 "WHERE dbtable = '$table'";
2172 my $result = $dbh->selectcol_arrayref($query);
2173 confess "Error executing virtual fields query: $query: ". $dbh->errstr
2175 $virtual_fields_cache{$table} = $result;
2178 @{$virtual_fields_cache{$table}};
2183 =item fields [ TABLE ]
2185 This is a wrapper for real_fields and virtual_fields. Code that called
2186 fields before should probably continue to call fields.
2191 my $something = shift;
2193 if($something->isa('FS::Record')) {
2194 $table = $something->table;
2196 $table = $something;
2197 $something = "FS::$table";
2199 return (real_fields($table), $something->virtual_fields());
2202 =item pvf FIELD_NAME
2204 Returns the FS::part_virtual_field object corresponding to a field in the
2205 record (specified by FIELD_NAME).
2210 my ($self, $name) = (shift, shift);
2212 if(grep /^$name$/, $self->virtual_fields) {
2213 return qsearchs('part_virtual_field', { dbtable => $self->table,
2219 =item vfieldpart_hashref TABLE
2221 Returns a hashref of virtual field names and vfieldparts applicable to the given
2226 sub vfieldpart_hashref {
2228 my $table = $self->table;
2230 return {} unless dbdef->table('part_virtual_field');
2233 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
2234 "dbtable = '$table'";
2235 my $sth = $dbh->prepare($statement);
2236 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
2237 return { map { $_->{name}, $_->{vfieldpart} }
2238 @{$sth->fetchall_arrayref({})} };
2242 =item encrypt($value)
2244 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2246 Returns the encrypted string.
2248 You should generally not have to worry about calling this, as the system handles this for you.
2253 my ($self, $value) = @_;
2256 if ($conf->exists('encryption')) {
2257 if ($self->is_encrypted($value)) {
2258 # Return the original value if it isn't plaintext.
2259 $encrypted = $value;
2262 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2263 # RSA doesn't like the empty string so let's pack it up
2264 # The database doesn't like the RSA data so uuencode it
2265 my $length = length($value)+1;
2266 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2268 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2275 =item is_encrypted($value)
2277 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2283 my ($self, $value) = @_;
2284 # Possible Bug - Some work may be required here....
2286 if ($value =~ /^M/ && length($value) > 80) {
2293 =item decrypt($value)
2295 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2297 You should generally not have to worry about calling this, as the system handles this for you.
2302 my ($self,$value) = @_;
2303 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2304 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2306 if (ref($rsa_decrypt) =~ /::RSA/) {
2307 my $encrypted = unpack ("u*", $value);
2308 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2309 if ($@) {warn "Decryption Failed"};
2317 #Initialize the Module
2318 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2320 if ($conf->exists('encryptionmodule') && $conf->config_binary('encryptionmodule') ne '') {
2321 $rsa_module = $conf->config('encryptionmodule');
2325 eval ("require $rsa_module"); # No need to import the namespace
2328 # Initialize Encryption
2329 if ($conf->exists('encryptionpublickey') && $conf->config_binary('encryptionpublickey') ne '') {
2330 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2331 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2334 # Intitalize Decryption
2335 if ($conf->exists('encryptionprivatekey') && $conf->config_binary('encryptionprivatekey') ne '') {
2336 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2337 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2341 =item h_search ACTION
2343 Given an ACTION, either "insert", or "delete", returns the appropriate history
2344 record corresponding to this record, if any.
2349 my( $self, $action ) = @_;
2351 my $table = $self->table;
2354 my $primary_key = dbdef->table($table)->primary_key;
2357 'table' => "h_$table",
2358 'hashref' => { $primary_key => $self->$primary_key(),
2359 'history_action' => $action,
2367 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2368 appropriate history record corresponding to this record, if any.
2373 my($self, $action) = @_;
2374 my $h = $self->h_search($action);
2375 $h ? $h->history_date : '';
2384 =item real_fields [ TABLE ]
2386 Returns a list of the real columns in the specified table. Called only by
2387 fields() and other subroutines elsewhere in FS::Record.
2394 my($table_obj) = dbdef->table($table);
2395 confess "Unknown table $table" unless $table_obj;
2396 $table_obj->columns;
2399 =item _quote VALUE, TABLE, COLUMN
2401 This is an internal function used to construct SQL statements. It returns
2402 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2403 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2408 my($value, $table, $column) = @_;
2409 my $column_obj = dbdef->table($table)->column($column);
2410 my $column_type = $column_obj->type;
2411 my $nullable = $column_obj->null;
2413 warn " $table.$column: $value ($column_type".
2414 ( $nullable ? ' NULL' : ' NOT NULL' ).
2415 ")\n" if $DEBUG > 2;
2417 if ( $value eq '' && $nullable ) {
2419 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2420 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2423 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2424 ! $column_type =~ /(char|binary|text)$/i ) {
2433 This is deprecated. Don't use it.
2435 It returns a hash-type list with the fields of this record's table set true.
2440 carp "warning: hfields is deprecated";
2443 foreach (fields($table)) {
2452 "$_: ". $self->getfield($_). "|"
2453 } (fields($self->table)) );
2456 sub DESTROY { return; }
2460 # #use Carp qw(cluck);
2461 # #cluck "DESTROYING $self";
2462 # warn "DESTROYING $self";
2466 # return ! eval { join('',@_), kill 0; 1; };
2469 =item str2time_sql [ DRIVER_NAME ]
2471 Returns a function to convert to unix time based on database type, such as
2472 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
2473 the str2time_sql_closing method to return a closing string rather than just
2474 using a closing parenthesis as previously suggested.
2476 You can pass an optional driver name such as "Pg", "mysql" or
2477 $dbh->{Driver}->{Name} to return a function for that database instead of
2478 the current database.
2483 my $driver = shift || driver_name;
2485 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
2486 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
2488 warn "warning: unknown database type $driver; guessing how to convert ".
2489 "dates to UNIX timestamps";
2490 return 'EXTRACT(EPOCH FROM ';
2494 =item str2time_sql_closing [ DRIVER_NAME ]
2496 Returns the closing suffix of a function to convert to unix time based on
2497 database type, such as ")::integer" for Pg or ")" for mysql.
2499 You can pass an optional driver name such as "Pg", "mysql" or
2500 $dbh->{Driver}->{Name} to return a function for that database instead of
2501 the current database.
2505 sub str2time_sql_closing {
2506 my $driver = shift || driver_name;
2508 return ' )::INTEGER ' if $driver =~ /^Pg/i;
2516 This module should probably be renamed, since much of the functionality is
2517 of general use. It is not completely unlike Adapter::DBI (see below).
2519 Exported qsearch and qsearchs should be deprecated in favor of method calls
2520 (against an FS::Record object like the old search and searchs that qsearch
2521 and qsearchs were on top of.)
2523 The whole fields / hfields mess should be removed.
2525 The various WHERE clauses should be subroutined.
2527 table string should be deprecated in favor of DBIx::DBSchema::Table.
2529 No doubt we could benefit from a Tied hash. Documenting how exists / defined
2530 true maps to the database (and WHERE clauses) would also help.
2532 The ut_ methods should ask the dbdef for a default length.
2534 ut_sqltype (like ut_varchar) should all be defined
2536 A fallback check method should be provided which uses the dbdef.
2538 The ut_money method assumes money has two decimal digits.
2540 The Pg money kludge in the new method only strips `$'.
2542 The ut_phonen method only checks US-style phone numbers.
2544 The _quote function should probably use ut_float instead of a regex.
2546 All the subroutines probably should be methods, here or elsewhere.
2548 Probably should borrow/use some dbdef methods where appropriate (like sub
2551 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
2552 or allow it to be set. Working around it is ugly any way around - DBI should
2553 be fixed. (only affects RDBMS which return uppercase column names)
2555 ut_zip should take an optional country like ut_phone.
2559 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
2561 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.