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 = Spreadsheet::ParseExcel::Workbook->new->Parse($filename);
1393 $parser = $excel->{Worksheet}[0]; #first sheet
1395 $count = $parser->{MaxRow} || $parser->{MinRow};
1399 die "Unknown file type $type\n";
1404 local $SIG{HUP} = 'IGNORE';
1405 local $SIG{INT} = 'IGNORE';
1406 local $SIG{QUIT} = 'IGNORE';
1407 local $SIG{TERM} = 'IGNORE';
1408 local $SIG{TSTP} = 'IGNORE';
1409 local $SIG{PIPE} = 'IGNORE';
1411 my $oldAutoCommit = $FS::UID::AutoCommit;
1412 local $FS::UID::AutoCommit = 0;
1417 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
1421 if ( $type eq 'csv' ) {
1423 last unless scalar(@buffer);
1424 $line = shift(@buffer);
1426 $parser->parse($line) or do {
1427 $dbh->rollback if $oldAutoCommit;
1428 return "can't parse: ". $parser->error_input();
1430 @columns = $parser->fields();
1432 } elsif ( $type eq 'xls' ) {
1434 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
1435 || ! $parser->{Cells}[$row];
1437 my @row = @{ $parser->{Cells}[$row] };
1438 @columns = map $_->{Val}, @row;
1441 #warn $z++. ": $_\n" for @columns;
1444 die "Unknown file type $type\n";
1447 my %hash = %$params;
1449 foreach my $field ( @fields ) {
1451 my $value = shift @columns;
1453 if ( ref($field) eq 'CODE' ) {
1454 &{$field}(\%hash, $value);
1456 $hash{$field} = $value if length($value);
1461 my $class = "FS::$table";
1463 my $record = $class->new( \%hash );
1465 my $error = $record->insert;
1468 $dbh->rollback if $oldAutoCommit;
1469 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
1474 if ( $job && time - $min_sec > $last ) { #progress bar
1475 $job->update_statustext( int(100 * $row / $count) );
1481 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
1483 return "Empty file!" unless $row;
1490 my( $self, $action, $time ) = @_;
1495 grep { defined($self->getfield($_)) && $self->getfield($_) ne "" }
1496 real_fields($self->table);
1499 # If we're encrypting then don't ever store the payinfo or CVV2 in the history....
1500 # You can see if it changed by the paymask...
1501 if ($conf && $conf->exists('encryption') ) {
1502 @fields = grep $_ ne 'payinfo' && $_ ne 'cvv2', @fields;
1504 my @values = map { _quote( $self->getfield($_), $self->table, $_) } @fields;
1506 "INSERT INTO h_". $self->table. " ( ".
1507 join(', ', qw(history_date history_user history_action), @fields ).
1509 join(', ', $time, dbh->quote(getotaker()), dbh->quote($action), @values).
1516 B<Warning>: External use is B<deprecated>.
1518 Replaces COLUMN in record with a unique number, using counters in the
1519 filesystem. Used by the B<insert> method on single-field unique columns
1520 (see L<DBIx::DBSchema::Table>) and also as a fallback for primary keys
1521 that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
1523 Returns the new value.
1528 my($self,$field) = @_;
1529 my($table)=$self->table;
1531 croak "Unique called on field $field, but it is ",
1532 $self->getfield($field),
1534 if $self->getfield($field);
1536 #warn "table $table is tainted" if is_tainted($table);
1537 #warn "field $field is tainted" if is_tainted($field);
1539 my($counter) = new File::CounterFile "$table.$field",0;
1541 # getotaker() =~ /^([\w\-]{1,16})$/ or die "Illegal CGI REMOTE_USER!";
1543 # my($counter) = new File::CounterFile "$user/$table.$field",0;
1546 my $index = $counter->inc;
1547 $index = $counter->inc while qsearchs($table, { $field=>$index } );
1549 $index =~ /^(\d*)$/;
1552 $self->setfield($field,$index);
1556 =item ut_float COLUMN
1558 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
1559 null. If there is an error, returns the error, otherwise returns false.
1564 my($self,$field)=@_ ;
1565 ($self->getfield($field) =~ /^\s*(\d+\.\d+)\s*$/ ||
1566 $self->getfield($field) =~ /^\s*(\d+)\s*$/ ||
1567 $self->getfield($field) =~ /^\s*(\d+\.\d+e\d+)\s*$/ ||
1568 $self->getfield($field) =~ /^\s*(\d+e\d+)\s*$/)
1569 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1570 $self->setfield($field,$1);
1573 =item ut_floatn COLUMN
1575 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1576 null. If there is an error, returns the error, otherwise returns false.
1580 #false laziness w/ut_ipn
1582 my( $self, $field ) = @_;
1583 if ( $self->getfield($field) =~ /^()$/ ) {
1584 $self->setfield($field,'');
1587 $self->ut_float($field);
1591 =item ut_sfloat COLUMN
1593 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10.
1594 May not be null. If there is an error, returns the error, otherwise returns
1600 my($self,$field)=@_ ;
1601 ($self->getfield($field) =~ /^\s*(-?\d+\.\d+)\s*$/ ||
1602 $self->getfield($field) =~ /^\s*(-?\d+)\s*$/ ||
1603 $self->getfield($field) =~ /^\s*(-?\d+\.\d+[eE]-?\d+)\s*$/ ||
1604 $self->getfield($field) =~ /^\s*(-?\d+[eE]-?\d+)\s*$/)
1605 or return "Illegal or empty (float) $field: ". $self->getfield($field);
1606 $self->setfield($field,$1);
1609 =item ut_sfloatn COLUMN
1611 Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be
1612 null. If there is an error, returns the error, otherwise returns false.
1617 my( $self, $field ) = @_;
1618 if ( $self->getfield($field) =~ /^()$/ ) {
1619 $self->setfield($field,'');
1622 $self->ut_sfloat($field);
1626 =item ut_snumber COLUMN
1628 Check/untaint signed numeric data (whole numbers). If there is an error,
1629 returns the error, otherwise returns false.
1634 my($self, $field) = @_;
1635 $self->getfield($field) =~ /^\s*(-?)\s*(\d+)\s*$/
1636 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1637 $self->setfield($field, "$1$2");
1641 =item ut_snumbern COLUMN
1643 Check/untaint signed numeric data (whole numbers). If there is an error,
1644 returns the error, otherwise returns false.
1649 my($self, $field) = @_;
1650 $self->getfield($field) =~ /^\s*(-?)\s*(\d*)\s*$/
1651 or return "Illegal (numeric) $field: ". $self->getfield($field);
1653 return "Illegal (numeric) $field: ". $self->getfield($field)
1656 $self->setfield($field, "$1$2");
1660 =item ut_number COLUMN
1662 Check/untaint simple numeric data (whole numbers). May not be null. If there
1663 is an error, returns the error, otherwise returns false.
1668 my($self,$field)=@_;
1669 $self->getfield($field) =~ /^\s*(\d+)\s*$/
1670 or return "Illegal or empty (numeric) $field: ". $self->getfield($field);
1671 $self->setfield($field,$1);
1675 =item ut_numbern COLUMN
1677 Check/untaint simple numeric data (whole numbers). May be null. If there is
1678 an error, returns the error, otherwise returns false.
1683 my($self,$field)=@_;
1684 $self->getfield($field) =~ /^\s*(\d*)\s*$/
1685 or return "Illegal (numeric) $field: ". $self->getfield($field);
1686 $self->setfield($field,$1);
1690 =item ut_money COLUMN
1692 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
1693 is an error, returns the error, otherwise returns false.
1698 my($self,$field)=@_;
1699 $self->setfield($field, 0) if $self->getfield($field) eq '';
1700 $self->getfield($field) =~ /^\s*(\-)?\s*(\d*)(\.\d{2})?\s*$/
1701 or return "Illegal (money) $field: ". $self->getfield($field);
1702 #$self->setfield($field, "$1$2$3" || 0);
1703 $self->setfield($field, ( ($1||''). ($2||''). ($3||'') ) || 0);
1707 =item ut_text COLUMN
1709 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1710 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? / = [ ]
1711 May not be null. If there is an error, returns the error, otherwise returns
1717 my($self,$field)=@_;
1718 #warn "msgcat ". \&msgcat. "\n";
1719 #warn "notexist ". \¬exist. "\n";
1720 #warn "AUTOLOAD ". \&AUTOLOAD. "\n";
1721 $self->getfield($field)
1722 =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]]+)$/
1723 or return gettext('illegal_or_empty_text'). " $field: ".
1724 $self->getfield($field);
1725 $self->setfield($field,$1);
1729 =item ut_textn COLUMN
1731 Check/untaint text. Alphanumerics, spaces, and the following punctuation
1732 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' " , . ? /
1733 May be null. If there is an error, returns the error, otherwise returns false.
1738 my($self,$field)=@_;
1739 $self->getfield($field)
1740 =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=\[\]]*)$/
1741 or return gettext('illegal_text'). " $field: ". $self->getfield($field);
1742 $self->setfield($field,$1);
1746 =item ut_alpha COLUMN
1748 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
1749 an error, returns the error, otherwise returns false.
1754 my($self,$field)=@_;
1755 $self->getfield($field) =~ /^(\w+)$/
1756 or return "Illegal or empty (alphanumeric) $field: ".
1757 $self->getfield($field);
1758 $self->setfield($field,$1);
1762 =item ut_alpha COLUMN
1764 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
1765 error, returns the error, otherwise returns false.
1770 my($self,$field)=@_;
1771 $self->getfield($field) =~ /^(\w*)$/
1772 or return "Illegal (alphanumeric) $field: ". $self->getfield($field);
1773 $self->setfield($field,$1);
1777 =item ut_alpha_lower COLUMN
1779 Check/untaint lowercase alphanumeric strings (no spaces). May not be null. If
1780 there is an error, returns the error, otherwise returns false.
1784 sub ut_alpha_lower {
1785 my($self,$field)=@_;
1786 $self->getfield($field) =~ /[[:upper:]]/
1787 and return "Uppercase characters are not permitted in $field";
1788 $self->ut_alpha($field);
1791 =item ut_phonen COLUMN [ COUNTRY ]
1793 Check/untaint phone numbers. May be null. If there is an error, returns
1794 the error, otherwise returns false.
1796 Takes an optional two-letter ISO country code; without it or with unsupported
1797 countries, ut_phonen simply calls ut_alphan.
1802 my( $self, $field, $country ) = @_;
1803 return $self->ut_alphan($field) unless defined $country;
1804 my $phonen = $self->getfield($field);
1805 if ( $phonen eq '' ) {
1806 $self->setfield($field,'');
1807 } elsif ( $country eq 'US' || $country eq 'CA' ) {
1809 $phonen = $conf->config('cust_main-default_areacode').$phonen
1810 if length($phonen)==7 && $conf->config('cust_main-default_areacode');
1811 $phonen =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
1812 or return gettext('illegal_phone'). " $field: ". $self->getfield($field);
1813 $phonen = "$1-$2-$3";
1814 $phonen .= " x$4" if $4;
1815 $self->setfield($field,$phonen);
1817 warn "warning: don't know how to check phone numbers for country $country";
1818 return $self->ut_textn($field);
1825 Check/untaint hexadecimal values.
1830 my($self, $field) = @_;
1831 $self->getfield($field) =~ /^([\da-fA-F]+)$/
1832 or return "Illegal (hex) $field: ". $self->getfield($field);
1833 $self->setfield($field, uc($1));
1837 =item ut_hexn COLUMN
1839 Check/untaint hexadecimal values. May be null.
1844 my($self, $field) = @_;
1845 $self->getfield($field) =~ /^([\da-fA-F]*)$/
1846 or return "Illegal (hex) $field: ". $self->getfield($field);
1847 $self->setfield($field, uc($1));
1852 Check/untaint ip addresses. IPv4 only for now.
1857 my( $self, $field ) = @_;
1858 $self->getfield($field) =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
1859 or return "Illegal (IP address) $field: ". $self->getfield($field);
1860 for ( $1, $2, $3, $4 ) { return "Illegal (IP address) $field" if $_ > 255; }
1861 $self->setfield($field, "$1.$2.$3.$4");
1867 Check/untaint ip addresses. IPv4 only for now. May be null.
1872 my( $self, $field ) = @_;
1873 if ( $self->getfield($field) =~ /^()$/ ) {
1874 $self->setfield($field,'');
1877 $self->ut_ip($field);
1881 =item ut_coord COLUMN [ LOWER [ UPPER ] ]
1883 Check/untaint coordinates.
1884 Accepts the following forms:
1894 The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous.
1895 The latter form (that is, the MMM are thousands of minutes) is
1896 assumed if the "MMM" is exactly three digits or two digits > 59.
1898 To be safe, just use the DDD.DDDDD form.
1900 If LOWER or UPPER are specified, then the coordinate is checked
1901 for lower and upper bounds, respectively.
1907 my ($self, $field) = (shift, shift);
1909 my $lower = shift if scalar(@_);
1910 my $upper = shift if scalar(@_);
1911 my $coord = $self->getfield($field);
1912 my $neg = $coord =~ s/^(-)//;
1914 my ($d, $m, $s) = (0, 0, 0);
1917 (($d) = ($coord =~ /^(\s*\d{1,3}(?:\.\d+)?)\s*$/)) ||
1918 (($d, $m) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2}(?:\.\d+))\s*$/)) ||
1919 (($d, $m, $s) = ($coord =~ /^(\s*\d{1,3})\s+(\d{1,2})\s+(\d{1,3})\s*$/))
1921 $s = (((($s =~ /^\d{3}$/) or $s > 59) ? ($s / 1000) : ($s / 60)) / 60);
1924 return "Invalid (coordinate with minutes > 59) $field: "
1925 . $self->getfield($field);
1928 $coord = ($neg ? -1 : 1) * sprintf('%.8f', $d + $m + $s);
1930 if (defined($lower) and ($coord < $lower)) {
1931 return "Invalid (coordinate < $lower) $field: "
1932 . $self->getfield($field);;
1935 if (defined($upper) and ($coord > $upper)) {
1936 return "Invalid (coordinate > $upper) $field: "
1937 . $self->getfield($field);;
1940 $self->setfield($field, $coord);
1944 return "Invalid (coordinate) $field: " . $self->getfield($field);
1948 =item ut_coordn COLUMN [ LOWER [ UPPER ] ]
1950 Same as ut_coord, except optionally null.
1956 my ($self, $field) = (shift, shift);
1958 if ($self->getfield($field) =~ /^$/) {
1961 return $self->ut_coord($field, @_);
1967 =item ut_domain COLUMN
1969 Check/untaint host and domain names.
1974 my( $self, $field ) = @_;
1975 #$self->getfield($field) =~/^(\w+\.)*\w+$/
1976 $self->getfield($field) =~/^(([\w\-]+\.)*\w+)$/
1977 or return "Illegal (domain) $field: ". $self->getfield($field);
1978 $self->setfield($field,$1);
1982 =item ut_name COLUMN
1984 Check/untaint proper names; allows alphanumerics, spaces and the following
1985 punctuation: , . - '
1992 my( $self, $field ) = @_;
1993 $self->getfield($field) =~ /^([\w \,\.\-\']+)$/
1994 or return gettext('illegal_name'). " $field: ". $self->getfield($field);
1995 $self->setfield($field,$1);
2001 Check/untaint zip codes.
2005 my @zip_reqd_countries = qw( AU CA US ); #CA, US implicit...
2008 my( $self, $field, $country ) = @_;
2010 if ( $country eq 'US' ) {
2012 $self->getfield($field) =~ /^\s*(\d{5}(\-\d{4})?)\s*$/
2013 or return gettext('illegal_zip'). " $field for country $country: ".
2014 $self->getfield($field);
2015 $self->setfield($field, $1);
2017 } elsif ( $country eq 'CA' ) {
2019 $self->getfield($field) =~ /^\s*([A-Z]\d[A-Z])\s*(\d[A-Z]\d)\s*$/i
2020 or return gettext('illegal_zip'). " $field for country $country: ".
2021 $self->getfield($field);
2022 $self->setfield($field, "$1 $2");
2026 if ( $self->getfield($field) =~ /^\s*$/
2027 && ( !$country || ! grep { $_ eq $country } @zip_reqd_countries )
2030 $self->setfield($field,'');
2032 $self->getfield($field) =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
2033 or return gettext('illegal_zip'). " $field: ". $self->getfield($field);
2034 $self->setfield($field,$1);
2042 =item ut_country COLUMN
2044 Check/untaint country codes. Country names are changed to codes, if possible -
2045 see L<Locale::Country>.
2050 my( $self, $field ) = @_;
2051 unless ( $self->getfield($field) =~ /^(\w\w)$/ ) {
2052 if ( $self->getfield($field) =~ /^([\w \,\.\(\)\']+)$/
2053 && country2code($1) ) {
2054 $self->setfield($field,uc(country2code($1)));
2057 $self->getfield($field) =~ /^(\w\w)$/
2058 or return "Illegal (country) $field: ". $self->getfield($field);
2059 $self->setfield($field,uc($1));
2063 =item ut_anything COLUMN
2065 Untaints arbitrary data. Be careful.
2070 my( $self, $field ) = @_;
2071 $self->getfield($field) =~ /^(.*)$/s
2072 or return "Illegal $field: ". $self->getfield($field);
2073 $self->setfield($field,$1);
2077 =item ut_enum COLUMN CHOICES_ARRAYREF
2079 Check/untaint a column, supplying all possible choices, like the "enum" type.
2084 my( $self, $field, $choices ) = @_;
2085 foreach my $choice ( @$choices ) {
2086 if ( $self->getfield($field) eq $choice ) {
2087 $self->setfield($choice);
2091 return "Illegal (enum) field $field: ". $self->getfield($field);
2094 =item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2096 Check/untaint a foreign column key. Call a regular ut_ method (like ut_number)
2097 on the column first.
2101 sub ut_foreign_key {
2102 my( $self, $field, $table, $foreign ) = @_;
2103 return '' if $no_check_foreign;
2104 qsearchs($table, { $foreign => $self->getfield($field) })
2105 or return "Can't find ". $self->table. ".$field ". $self->getfield($field).
2106 " in $table.$foreign";
2110 =item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
2112 Like ut_foreign_key, except the null value is also allowed.
2116 sub ut_foreign_keyn {
2117 my( $self, $field, $table, $foreign ) = @_;
2118 $self->getfield($field)
2119 ? $self->ut_foreign_key($field, $table, $foreign)
2123 =item ut_agentnum_acl
2125 Checks this column as an agentnum, taking into account the current users's
2130 sub ut_agentnum_acl {
2131 my( $self, $field, $null_acl ) = @_;
2133 my $error = $self->ut_foreign_keyn($field, 'agent', 'agentnum');
2134 return "Illegal agentnum: $error" if $error;
2136 my $curuser = $FS::CurrentUser::CurrentUser;
2138 if ( $self->$field() ) {
2140 return "Access denied"
2141 unless $curuser->agentnum($self->$field());
2145 return "Access denied"
2146 unless $curuser->access_right($null_acl);
2154 =item virtual_fields [ TABLE ]
2156 Returns a list of virtual fields defined for the table. This should not
2157 be exported, and should only be called as an instance or class method.
2161 sub virtual_fields {
2164 $table = $self->table or confess "virtual_fields called on non-table";
2166 confess "Unknown table $table" unless dbdef->table($table);
2168 return () unless dbdef->table('part_virtual_field');
2170 unless ( $virtual_fields_cache{$table} ) {
2171 my $query = 'SELECT name from part_virtual_field ' .
2172 "WHERE dbtable = '$table'";
2174 my $result = $dbh->selectcol_arrayref($query);
2175 confess "Error executing virtual fields query: $query: ". $dbh->errstr
2177 $virtual_fields_cache{$table} = $result;
2180 @{$virtual_fields_cache{$table}};
2185 =item fields [ TABLE ]
2187 This is a wrapper for real_fields and virtual_fields. Code that called
2188 fields before should probably continue to call fields.
2193 my $something = shift;
2195 if($something->isa('FS::Record')) {
2196 $table = $something->table;
2198 $table = $something;
2199 $something = "FS::$table";
2201 return (real_fields($table), $something->virtual_fields());
2204 =item pvf FIELD_NAME
2206 Returns the FS::part_virtual_field object corresponding to a field in the
2207 record (specified by FIELD_NAME).
2212 my ($self, $name) = (shift, shift);
2214 if(grep /^$name$/, $self->virtual_fields) {
2215 return qsearchs('part_virtual_field', { dbtable => $self->table,
2221 =item vfieldpart_hashref TABLE
2223 Returns a hashref of virtual field names and vfieldparts applicable to the given
2228 sub vfieldpart_hashref {
2230 my $table = $self->table;
2232 return {} unless dbdef->table('part_virtual_field');
2235 my $statement = "SELECT vfieldpart, name FROM part_virtual_field WHERE ".
2236 "dbtable = '$table'";
2237 my $sth = $dbh->prepare($statement);
2238 $sth->execute or croak "Execution of '$statement' failed: ".$dbh->errstr;
2239 return { map { $_->{name}, $_->{vfieldpart} }
2240 @{$sth->fetchall_arrayref({})} };
2244 =item encrypt($value)
2246 Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
2248 Returns the encrypted string.
2250 You should generally not have to worry about calling this, as the system handles this for you.
2255 my ($self, $value) = @_;
2258 if ($conf->exists('encryption')) {
2259 if ($self->is_encrypted($value)) {
2260 # Return the original value if it isn't plaintext.
2261 $encrypted = $value;
2264 if (ref($rsa_encrypt) =~ /::RSA/) { # We Can Encrypt
2265 # RSA doesn't like the empty string so let's pack it up
2266 # The database doesn't like the RSA data so uuencode it
2267 my $length = length($value)+1;
2268 $encrypted = pack("u*",$rsa_encrypt->encrypt(pack("Z$length",$value)));
2270 die ("You can't encrypt w/o a valid RSA engine - Check your installation or disable encryption");
2277 =item is_encrypted($value)
2279 Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
2285 my ($self, $value) = @_;
2286 # Possible Bug - Some work may be required here....
2288 if ($value =~ /^M/ && length($value) > 80) {
2295 =item decrypt($value)
2297 Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
2299 You should generally not have to worry about calling this, as the system handles this for you.
2304 my ($self,$value) = @_;
2305 my $decrypted = $value; # Will return the original value if it isn't encrypted or can't be decrypted.
2306 if ($conf->exists('encryption') && $self->is_encrypted($value)) {
2308 if (ref($rsa_decrypt) =~ /::RSA/) {
2309 my $encrypted = unpack ("u*", $value);
2310 $decrypted = unpack("Z*", eval{$rsa_decrypt->decrypt($encrypted)});
2311 if ($@) {warn "Decryption Failed"};
2319 #Initialize the Module
2320 $rsa_module = 'Crypt::OpenSSL::RSA'; # The Default
2322 if ($conf->exists('encryptionmodule') && $conf->config_binary('encryptionmodule') ne '') {
2323 $rsa_module = $conf->config('encryptionmodule');
2327 eval ("require $rsa_module"); # No need to import the namespace
2330 # Initialize Encryption
2331 if ($conf->exists('encryptionpublickey') && $conf->config_binary('encryptionpublickey') ne '') {
2332 my $public_key = join("\n",$conf->config('encryptionpublickey'));
2333 $rsa_encrypt = $rsa_module->new_public_key($public_key);
2336 # Intitalize Decryption
2337 if ($conf->exists('encryptionprivatekey') && $conf->config_binary('encryptionprivatekey') ne '') {
2338 my $private_key = join("\n",$conf->config('encryptionprivatekey'));
2339 $rsa_decrypt = $rsa_module->new_private_key($private_key);
2343 =item h_search ACTION
2345 Given an ACTION, either "insert", or "delete", returns the appropriate history
2346 record corresponding to this record, if any.
2351 my( $self, $action ) = @_;
2353 my $table = $self->table;
2356 my $primary_key = dbdef->table($table)->primary_key;
2359 'table' => "h_$table",
2360 'hashref' => { $primary_key => $self->$primary_key(),
2361 'history_action' => $action,
2369 Given an ACTION, either "insert", or "delete", returns the timestamp of the
2370 appropriate history record corresponding to this record, if any.
2375 my($self, $action) = @_;
2376 my $h = $self->h_search($action);
2377 $h ? $h->history_date : '';
2386 =item real_fields [ TABLE ]
2388 Returns a list of the real columns in the specified table. Called only by
2389 fields() and other subroutines elsewhere in FS::Record.
2396 my($table_obj) = dbdef->table($table);
2397 confess "Unknown table $table" unless $table_obj;
2398 $table_obj->columns;
2401 =item _quote VALUE, TABLE, COLUMN
2403 This is an internal function used to construct SQL statements. It returns
2404 VALUE DBI-quoted (see L<DBI/"quote">) unless VALUE is a number and the column
2405 type (see L<DBIx::DBSchema::Column>) does not end in `char' or `binary'.
2410 my($value, $table, $column) = @_;
2411 my $column_obj = dbdef->table($table)->column($column);
2412 my $column_type = $column_obj->type;
2413 my $nullable = $column_obj->null;
2415 warn " $table.$column: $value ($column_type".
2416 ( $nullable ? ' NULL' : ' NOT NULL' ).
2417 ")\n" if $DEBUG > 2;
2419 if ( $value eq '' && $nullable ) {
2421 } elsif ( $value eq '' && $column_type =~ /^(int|numeric)/ ) {
2422 cluck "WARNING: Attempting to set non-null integer $table.$column null; ".
2425 } elsif ( $value =~ /^\d+(\.\d+)?$/ &&
2426 ! $column_type =~ /(char|binary|text)$/i ) {
2435 This is deprecated. Don't use it.
2437 It returns a hash-type list with the fields of this record's table set true.
2442 carp "warning: hfields is deprecated";
2445 foreach (fields($table)) {
2454 "$_: ". $self->getfield($_). "|"
2455 } (fields($self->table)) );
2458 sub DESTROY { return; }
2462 # #use Carp qw(cluck);
2463 # #cluck "DESTROYING $self";
2464 # warn "DESTROYING $self";
2468 # return ! eval { join('',@_), kill 0; 1; };
2471 =item str2time_sql [ DRIVER_NAME ]
2473 Returns a function to convert to unix time based on database type, such as
2474 "EXTRACT( EPOCH FROM" for Pg or "UNIX_TIMESTAMP(" for mysql. See
2475 the str2time_sql_closing method to return a closing string rather than just
2476 using a closing parenthesis as previously suggested.
2478 You can pass an optional driver name such as "Pg", "mysql" or
2479 $dbh->{Driver}->{Name} to return a function for that database instead of
2480 the current database.
2485 my $driver = shift || driver_name;
2487 return 'UNIX_TIMESTAMP(' if $driver =~ /^mysql/i;
2488 return 'EXTRACT( EPOCH FROM ' if $driver =~ /^Pg/i;
2490 warn "warning: unknown database type $driver; guessing how to convert ".
2491 "dates to UNIX timestamps";
2492 return 'EXTRACT(EPOCH FROM ';
2496 =item str2time_sql_closing [ DRIVER_NAME ]
2498 Returns the closing suffix of a function to convert to unix time based on
2499 database type, such as ")::integer" for Pg or ")" for mysql.
2501 You can pass an optional driver name such as "Pg", "mysql" or
2502 $dbh->{Driver}->{Name} to return a function for that database instead of
2503 the current database.
2507 sub str2time_sql_closing {
2508 my $driver = shift || driver_name;
2510 return ' )::INTEGER ' if $driver =~ /^Pg/i;
2518 This module should probably be renamed, since much of the functionality is
2519 of general use. It is not completely unlike Adapter::DBI (see below).
2521 Exported qsearch and qsearchs should be deprecated in favor of method calls
2522 (against an FS::Record object like the old search and searchs that qsearch
2523 and qsearchs were on top of.)
2525 The whole fields / hfields mess should be removed.
2527 The various WHERE clauses should be subroutined.
2529 table string should be deprecated in favor of DBIx::DBSchema::Table.
2531 No doubt we could benefit from a Tied hash. Documenting how exists / defined
2532 true maps to the database (and WHERE clauses) would also help.
2534 The ut_ methods should ask the dbdef for a default length.
2536 ut_sqltype (like ut_varchar) should all be defined
2538 A fallback check method should be provided which uses the dbdef.
2540 The ut_money method assumes money has two decimal digits.
2542 The Pg money kludge in the new method only strips `$'.
2544 The ut_phonen method only checks US-style phone numbers.
2546 The _quote function should probably use ut_float instead of a regex.
2548 All the subroutines probably should be methods, here or elsewhere.
2550 Probably should borrow/use some dbdef methods where appropriate (like sub
2553 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
2554 or allow it to be set. Working around it is ugly any way around - DBI should
2555 be fixed. (only affects RDBMS which return uppercase column names)
2557 ut_zip should take an optional country like ut_phone.
2561 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
2563 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.