X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcontact.pm;h=148fa6157f01c02f87457b9b0088479cb90eb70c;hb=9813252ec987e72242efa564c7a927b111f9222a;hp=d3ab4118a9fec3acdca0575ba46caf65a86e8022;hpb=63a268637b2d51a8766412617724b9436439deb6;p=freeside.git diff --git a/FS/FS/contact.pm b/FS/FS/contact.pm index d3ab4118a..148fa6157 100644 --- a/FS/FS/contact.pm +++ b/FS/FS/contact.pm @@ -1,11 +1,22 @@ package FS::contact; +use base qw( FS::Password_Mixin + FS::Record ); use strict; -use base qw( FS::Record ); -use FS::Record qw( qsearch qsearchs ); +use vars qw( $skip_fuzzyfiles ); +use Scalar::Util qw( blessed ); +use FS::Record qw( qsearch qsearchs dbh ); use FS::prospect_main; use FS::cust_main; +use FS::contact_class; use FS::cust_location; +use FS::contact_phone; +use FS::contact_email; +use FS::queue; +use FS::cust_pkg; +use FS::phone_type; #for cgi_contact_fields + +$skip_fuzzyfiles = 0; =head1 NAME @@ -28,8 +39,9 @@ FS::contact - Object methods for contact records =head1 DESCRIPTION -An FS::contact object represents an example. FS::contact inherits from -FS::Record. The following fields are currently supported: +An FS::contact object represents an specific contact person for a prospect or +customer. FS::contact inherits from FS::Record. The following fields are +currently supported: =over 4 @@ -65,6 +77,16 @@ title comment +=item selfservice_access + +empty or Y + +=item _password + +=item _password_encoding + +empty or bcrypt + =item disabled disabled @@ -78,15 +100,13 @@ disabled =item new HASHREF -Creates a new example. To add the example to the database, see L<"insert">. +Creates a new contact. To add the contact to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. =cut -# the new method can be inherited from FS::Record, if a table method is defined - sub table { 'contact'; } =item insert @@ -96,7 +116,85 @@ otherwise returns false. =cut -# the insert method can be inherited from FS::Record +sub insert { + my $self = shift; + + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + my $error = $self->SUPER::insert; + $error ||= $self->insert_password_history; + + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + foreach my $pf ( grep { /^phonetypenum(\d+)$/ && $self->get($_) =~ /\S/ } + keys %{ $self->hashref } ) { + $pf =~ /^phonetypenum(\d+)$/ or die "wtf (daily, the)"; + my $phonetypenum = $1; + + my $contact_phone = new FS::contact_phone { + 'contactnum' => $self->contactnum, + 'phonetypenum' => $phonetypenum, + _parse_phonestring( $self->get($pf) ), + }; + $error = $contact_phone->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + if ( $self->get('emailaddress') =~ /\S/ ) { + + foreach my $email ( split(/\s*,\s*/, $self->get('emailaddress') ) ) { + + my $contact_email = new FS::contact_email { + 'contactnum' => $self->contactnum, + 'emailaddress' => $email, + }; + $error = $contact_email->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + } + + } + + unless ( $skip_fuzzyfiles ) { #unless ( $import || $skip_fuzzyfiles ) { + #warn " queueing fuzzyfiles update\n" + # if $DEBUG > 1; + $error = $self->queue_fuzzyfiles_update; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "updating fuzzy search cache: $error"; + } + } + + if ( $self->selfservice_access && ! length($self->_password) ) { + my $error = $self->send_reset_email( queue=>1 ); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + ''; + +} =item delete @@ -104,7 +202,48 @@ Delete this record from the database. =cut -# the delete method can be inherited from FS::Record +sub delete { + my $self = shift; + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + foreach my $cust_pkg ( $self->cust_pkg ) { + $cust_pkg->contactnum(''); + my $error = $cust_pkg->replace; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + foreach my $object ( $self->contact_phone, $self->contact_email ) { + my $error = $object->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + my $error = $self->delete_password_history + || $self->SUPER::delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; + +} =item replace OLD_RECORD @@ -113,31 +252,228 @@ returns the error, otherwise returns false. =cut -# the replace method can be inherited from FS::Record +sub replace { + my $self = shift; + + my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') ) + ? shift + : $self->replace_old; + + $self->$_( $self->$_ || $old->$_ ) for qw( _password _password_encoding ); + + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + my $error = $self->SUPER::replace($old); + if ( $old->_password ne $self->_password ) { + $error ||= $self->insert_password_history; + } + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + foreach my $pf ( grep { /^phonetypenum(\d+)$/ } + keys %{ $self->hashref } ) { + $pf =~ /^phonetypenum(\d+)$/ or die "wtf (daily, the)"; + my $phonetypenum = $1; + + my %cp = ( 'contactnum' => $self->contactnum, + 'phonetypenum' => $phonetypenum, + ); + my $contact_phone = qsearchs('contact_phone', \%cp); + + my $pv = $self->get($pf); + $pv =~ s/\s//g; + + #if new value is empty, delete old entry + if (!$pv) { + if ($contact_phone) { + $error = $contact_phone->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + next; + } + + $contact_phone ||= new FS::contact_phone \%cp; + + my %cpd = _parse_phonestring( $pv ); + $contact_phone->set( $_ => $cpd{$_} ) foreach keys %cpd; + + my $method = $contact_phone->contactphonenum ? 'replace' : 'insert'; + + $error = $contact_phone->$method; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + if ( defined($self->hashref->{'emailaddress'}) ) { + + #ineffecient but whatever, how many email addresses can there be? + + foreach my $contact_email ( $self->contact_email ) { + my $error = $contact_email->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + foreach my $email ( split(/\s*,\s*/, $self->get('emailaddress') ) ) { + + my $contact_email = new FS::contact_email { + 'contactnum' => $self->contactnum, + 'emailaddress' => $email, + }; + $error = $contact_email->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + } + + } + + unless ( $skip_fuzzyfiles ) { #unless ( $import || $skip_fuzzyfiles ) { + #warn " queueing fuzzyfiles update\n" + # if $DEBUG > 1; + $error = $self->queue_fuzzyfiles_update; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "updating fuzzy search cache: $error"; + } + } + + if ( ( $old->selfservice_access eq '' && $self->selfservice_access + && ! $self->_password + ) + || $self->_resend() + ) + { + my $error = $self->send_reset_email( queue=>1 ); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + ''; + +} + +=item _parse_phonestring PHONENUMBER_STRING + +Subroutine, takes a string and returns a list (suitable for assigning to a hash) +with keys 'countrycode', 'phonenum' and 'extension' + +(Should probably be moved to contact_phone.pm, hence the initial underscore.) + +=cut + +sub _parse_phonestring { + my $value = shift; + + my($countrycode, $extension) = ('1', ''); + + #countrycode + if ( $value =~ s/^\s*\+\s*(\d+)// ) { + $countrycode = $1; + } else { + $value =~ s/^\s*1//; + } + #extension + if ( $value =~ s/\s*(ext|x)\s*(\d+)\s*$//i ) { + $extension = $2; + } + + ( 'countrycode' => $countrycode, + 'phonenum' => $value, + 'extension' => $extension, + ); +} + +=item queue_fuzzyfiles_update + +Used by insert & replace to update the fuzzy search cache + +=cut + +use FS::cust_main::Search; +sub queue_fuzzyfiles_update { + my $self = shift; + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + foreach my $field ( 'first', 'last' ) { + my $queue = new FS::queue { + 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield' + }; + my @args = "contact.$field", $self->get($field); + my $error = $queue->insert( @args ); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "queueing job (transaction rolled back): $error"; + } + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; + +} =item check -Checks all fields to make sure this is a valid example. If there is +Checks all fields to make sure this is a valid contact. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. =cut -# the check method should currently be supplied - FS::Record contains some -# data checking routines - sub check { my $self = shift; + if ( $self->selfservice_access eq 'R' ) { + $self->selfservice_access('Y'); + $self->_resend('Y'); + } + my $error = $self->ut_numbern('contactnum') || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum') - || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum') + || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum') || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum') - || $self->ut_textn('last') - || $self->ut_textn('first') + || $self->ut_foreign_keyn('classnum', 'contact_class', 'classnum') + || $self->ut_namen('last') + || $self->ut_namen('first') || $self->ut_textn('title') || $self->ut_textn('comment') + || $self->ut_enum('selfservice_access', [ '', 'Y' ]) + || $self->ut_textn('_password') + || $self->ut_enum('_password_encoding', [ '', 'bcrypt']) || $self->ut_enum('disabled', [ '', 'Y' ]) ; return $error if $error; @@ -151,6 +487,13 @@ sub check { $self->SUPER::check; } +=item line + +Returns a formatted string representing this contact, including name, title and +comment. + +=cut + sub line { my $self = shift; my $data = $self->first. ' '. $self->last; @@ -161,12 +504,261 @@ sub line { $data; } +sub cust_location { + my $self = shift; + return '' unless $self->locationnum; + qsearchs('cust_location', { 'locationnum' => $self->locationnum } ); +} + +sub contact_class { + my $self = shift; + return '' unless $self->classnum; + qsearchs('contact_class', { 'classnum' => $self->classnum } ); +} + +=item firstlast + +Returns a formatted string representing this contact, with just the name. + +=cut + +sub firstlast { + my $self = shift; + $self->first . ' ' . $self->last; +} + +=item contact_classname + +Returns the name of this contact's class (see L). + +=cut + +sub contact_classname { + my $self = shift; + my $contact_class = $self->contact_class or return ''; + $contact_class->classname; +} + +sub contact_phone { + my $self = shift; + qsearch('contact_phone', { 'contactnum' => $self->contactnum } ); +} + +sub contact_email { + my $self = shift; + qsearch('contact_email', { 'contactnum' => $self->contactnum } ); +} + +sub cust_main { + my $self = shift; + qsearchs('cust_main', { 'custnum' => $self->custnum } ); +} + +sub cust_pkg { + my $self = shift; + qsearch('cust_pkg', { 'contactnum' => $self->contactnum } ); +} + +=item by_selfservice_email EMAILADDRESS + +Alternate search constructor (class method). Given an email address, +returns the contact for that address, or the empty string if no contact +has that email address. + +=cut + +sub by_selfservice_email { + my($class, $email) = @_; + + my $contact_email = qsearchs({ + 'table' => 'contact_email', + 'addl_from' => ' LEFT JOIN contact USING ( contactnum ) ', + 'hashref' => { 'emailaddress' => $email, }, + 'extra_sql' => " AND selfservice_access = 'Y' ". + " AND ( disabled IS NULL OR disabled = '' )", + }) or return ''; + + $contact_email->contact; + +} + +#these three functions are very much false laziness w/FS/FS/Auth/internal.pm +# and should maybe be libraried in some way for other password needs + +use Crypt::Eksblowfish::Bcrypt qw( bcrypt_hash en_base64 de_base64); + +sub authenticate_password { + my($self, $check_password) = @_; + + if ( $self->_password_encoding eq 'bcrypt' ) { + + my( $cost, $salt, $hash ) = split(',', $self->_password); + + my $check_hash = en_base64( bcrypt_hash( { key_nul => 1, + cost => $cost, + salt => de_base64($salt), + }, + $check_password + ) + ); + + $hash eq $check_hash; + + } else { + + return 0 if $self->_password eq ''; + + $self->_password eq $check_password; + + } + +} + +=item change_password NEW_PASSWORD + +Changes the contact's selfservice access password to NEW_PASSWORD. This does +not check password policy rules (see C) and will return +an error only if editing the record fails for some reason. + +If NEW_PASSWORD is the same as the existing password, this does nothing. + +=cut + +sub change_password { + my($self, $new_password) = @_; + + # do nothing if the password is unchanged + return if $self->authenticate_password($new_password); + + $self->change_password_fields( $new_password ); + + $self->replace; + +} + +sub change_password_fields { + my($self, $new_password) = @_; + + $self->_password_encoding('bcrypt'); + + my $cost = 8; + + my $salt = pack( 'C*', map int(rand(256)), 1..16 ); + + my $hash = bcrypt_hash( { key_nul => 1, + cost => $cost, + salt => $salt, + }, + $new_password, + ); + + $self->_password( + join(',', $cost, en_base64($salt), en_base64($hash) ) + ); + +} + +# end of false laziness w/FS/FS/Auth/internal.pm + + +#false laziness w/ClientAPI/MyAccount/reset_passwd +use Digest::SHA qw(sha512_hex); +use FS::Conf; +use FS::ClientAPI_SessionCache; +sub send_reset_email { + my( $self, %opt ) = @_; + + my @contact_email = $self->contact_email or return ''; + + my $reset_session = { + 'contactnum' => $self->contactnum, + 'svcnum' => $opt{'svcnum'}, + }; + + + my $conf = new FS::Conf; + my $timeout = + ($conf->config('selfservice-password_reset_hours') || 24 ). ' hours'; + + my $reset_session_id; + do { + $reset_session_id = sha512_hex(time(). {}. rand(). $$) + } until ( ! defined $self->myaccount_cache->get("reset_passwd_$reset_session_id") ); + #just in case + + $self->myaccount_cache->set( "reset_passwd_$reset_session_id", $reset_session, $timeout ); + + #email it + + my $conf = new FS::Conf; + + my $cust_main = $self->cust_main + or die "no customer"; #reset a password for a prospect contact? someday + + my $msgnum = $conf->config('selfservice-password_reset_msgnum', $cust_main->agentnum); + #die "selfservice-password_reset_msgnum unset" unless $msgnum; + return { 'error' => "selfservice-password_reset_msgnum unset" } unless $msgnum; + my $msg_template = qsearchs('msg_template', { msgnum => $msgnum } ); + my %msg_template = ( + 'to' => join(',', map $_->emailaddress, @contact_email ), + 'cust_main' => $cust_main, + 'object' => $self, + 'substitutions' => { 'session_id' => $reset_session_id } + ); + + if ( $opt{'queue'} ) { #or should queueing just be the default? + + my $queue = new FS::queue { + 'job' => 'FS::Misc::process_send_email', + 'custnum' => $cust_main->custnum, + }; + $queue->insert( $msg_template->prepare( %msg_template ) ); + + } else { + + $msg_template->send( %msg_template ); + + } + +} + +use vars qw( $myaccount_cache ); +sub myaccount_cache { + #my $class = shift; + $myaccount_cache ||= new FS::ClientAPI_SessionCache( { + 'namespace' => 'FS::ClientAPI::MyAccount', + } ); +} + +=item cgi_contact_fields + +Returns a list reference containing the set of contact fields used in the web +interface for one-line editing (i.e. excluding contactnum, prospectnum, custnum +and locationnum, as well as password fields, but including fields for +contact_email and contact_phone records.) + +=cut + +sub cgi_contact_fields { + #my $class = shift; + + my @contact_fields = qw( + classnum first last title comment emailaddress selfservice_access + ); + + push @contact_fields, 'phonetypenum'. $_->phonetypenum + foreach qsearch({table=>'phone_type', order_by=>'weight'}); + + \@contact_fields; + +} + +use FS::phone_type; + =back =head1 BUGS -The author forgot to customize this manpage. - =head1 SEE ALSO L, schema.html from the base documentation.