X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fagent.pm;h=8aa78c2b7daefa49b74ab38faab8b051a024ad65;hp=109343aa383ce6bbdfc91551eb97bda949d9df21;hb=e41cafbe7616c4f046c6161999d4577f1c918311;hpb=e96a2a6fd3a8885b0fb035ecc55bdf50dbe5a4aa diff --git a/FS/FS/agent.pm b/FS/FS/agent.pm index 109343aa3..8aa78c2b7 100644 --- a/FS/FS/agent.pm +++ b/FS/FS/agent.pm @@ -1,15 +1,14 @@ package FS::agent; -use base qw( FS::m2m_Common FS::m2name_Common FS::Record ); +use base qw( FS::Commission_Mixin FS::m2m_Common FS::m2name_Common FS::Record ); use strict; use vars qw( @ISA ); -use Business::CreditCard 0.28; +use Business::CreditCard 0.35; use FS::Record qw( dbh qsearch qsearchs ); use FS::cust_main; use FS::cust_pkg; -use FS::agent_type; -use FS::agent_currency; use FS::reg_code; +use FS::agent_payment_gateway; use FS::TicketSystem; use FS::Conf; @@ -45,27 +44,49 @@ from FS::Record. The following fields are currently supported: =over 4 -=item agentnum - primary key (assigned automatically for new agents) +=item agentnum -=item agent - Text name of this agent +primary key (assigned automatically for new agents) -=item typenum - Agent type (see L) +=item agent -=item ticketing_queueid - Ticketing Queue +Text name of this agent -=item invoice_template - Invoice template name +=item typenum -=item agent_custnum - Optional agent customer (see L) +Agent type (see L) -=item disabled - Disabled flag, empty or 'Y' +=item ticketing_queueid -=item prog - Deprecated (never used) +Ticketing Queue -=item freq - Deprecated (never used) +=item invoice_template -=item username - (Deprecated) Username for the Agent interface +Invoice template name -=item _password - (Deprecated) Password for the Agent interface +=item agent_custnum + +Optional agent customer (see L) + +=item disabled + +Disabled flag, empty or 'Y' + +=item prog + +Deprecated (never used) + +=item freq + +Deprecated (never used) + +=item username + +(Deprecated) Username for the Agent interface + +=item _password + +(Deprecated) Password for the Agent interface =back @@ -126,6 +147,7 @@ sub check { || $self->ut_textn('prog') || $self->ut_textn('invoice_template') || $self->ut_foreign_keyn('agent_custnum', 'cust_main', 'custnum' ) + || $self->ut_numbern('ticketing_queueid') ; return $error if $error; @@ -157,13 +179,6 @@ sub check { Returns the FS::agent_type object (see L) for this agent. -=cut - -sub agent_type { - my $self = shift; - qsearchs( 'agent_type', { 'typenum' => $self->typenum } ); -} - =item agent_cust_main Returns the FS::cust_main object (see L), if any, for this @@ -181,13 +196,6 @@ sub agent_cust_main { Returns the FS::agent_currency objects (see L), if any, for this agent. -=cut - -sub agent_currency { - my $self = shift; - qsearch('agent_currency', { 'agentnum' => $self->agentnum } ); -} - =item agent_currency_hashref Returns a hash references of supported additional currencies for this agent. @@ -224,81 +232,84 @@ field, or the empty string. sub ticketing_queue { my $self = shift; FS::TicketSystem->queue($self->ticketing_queueid); -}; +} =item payment_gateway [ OPTION => VALUE, ... ] Returns a payment gateway object (see L) for this agent. -Currently available options are I, I, I, and I. +Currently available options are I, I, I, + and I. If I is set, and no gateway is available, then the empty string will be returned instead of throwing a fatal exception. -If I is set to the number of an invoice (see L) then -an attempt will be made to select a gateway suited for the taxes paid on -the invoice. +The I option can be used to influence the choice +as well. Presently only CHEK/ECHECK and PAYPAL methods are meaningful. -The I and I options can be used to influence the choice -as well. Presently only 'CC', 'ECHECK', and 'PAYPAL' methods are meaningful. +If I is CHEK/ECHECK and the default gateway is being returned, +the business-onlinepayment-ach gateway will be returned if available. -When the I is 'CC' then the card number in I can direct -this routine to route to a gateway suited for that type of card. +If I is set and the I is PAYPAL, the defined paypal +gateway will be returned. -=cut +If I exists, then either the specified gateway or the +default gateway will be returned. Agent overrides are ignored, and this can +safely be called as a class method if this option is specified. Not +compatible with I. -sub payment_gateway { - my ( $self, %options ) = @_; +Exsisting I<$conf> may be passed for efficiency. - my $taxclass = ''; - if ( $options{invnum} ) { +=cut - my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{invnum} } ); - die "invnum ". $options{'invnum'}. " not found" unless $cust_bill; +# opts invnum/payinfo for cardtype/taxclass overrides no longer supported +# any future overrides added here need to be reconciled with the tokenization process - my @part_pkg = - map { $_->part_pkg } - grep { $_ } - map { $_->cust_pkg } - $cust_bill->cust_bill_pkg; +sub payment_gateway { + my ( $self, %options ) = @_; + + my $conf = $options{'conf'}; + $conf ||= new FS::Conf; - my @taxclasses = map $_->taxclass, @part_pkg; + if ( $options{thirdparty} ) { - $taxclass = $taxclasses[0] - unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are - #different taxclasses - } + # allows PayPal to coexist with credit card gateways + my $is_paypal = { op => '!=', value => 'PayPal' }; + if ( uc($options{method}) eq 'PAYPAL' ) { + $is_paypal = 'PayPal'; + } - #look for an agent gateway override first - my $cardtype = ''; - if ( $options{method} ) { - if ( $options{method} eq 'CC' && $options{payinfo} ) { - $cardtype = cardtype($options{payinfo}); - } elsif ( $options{method} eq 'ECHECK' ) { - $cardtype = 'ACH'; - } elsif ( $options{method} eq 'PAYPAL' ) { - $cardtype = 'PayPal'; + my $gateway = qsearchs({ + table => 'payment_gateway', + addl_from => ' JOIN agent_payment_gateway USING (gatewaynum) ', + hashref => { + gateway_namespace => 'Business::OnlineThirdPartyPayment', + gateway_module => $is_paypal, + disabled => '', + }, + extra_sql => ' AND agentnum = '.$self->agentnum, + }); + + if ( $gateway ) { + return $gateway; + } elsif ( $options{'nofatal'} ) { + return ''; } else { - $cardtype = $options{method} + die "no third-party gateway configured\n"; } } - my $override = - qsearchs('agent_payment_gateway', { agentnum => $self->agentnum, - cardtype => $cardtype, - taxclass => $taxclass, } ) - || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum, - cardtype => '', - taxclass => $taxclass, } ) - || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum, - cardtype => $cardtype, - taxclass => '', } ) - || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum, - cardtype => '', - taxclass => '', } ); - - my $payment_gateway; - my $conf = new FS::Conf; + my ($override, $payment_gateway); + if (exists $options{'load_gatewaynum'}) { # no agent overrides if this opt is in use + if ($options{'load_gatewaynum'}) { + $payment_gateway = qsearchs('payment_gateway', { gatewaynumnum => $options{'load_gatewaynum'} } ); + # always fatal + die "Could not load payment gateway ".$options{'load_gatewaynum'} unless $payment_gateway; + } # else use default, loaded below + } else { + $override = qsearchs('agent_payment_gateway', { agentnum => $self->agentnum } ); + } + if ( $override ) { #use a payment gateway override $payment_gateway = $override->payment_gateway; @@ -306,11 +317,13 @@ sub payment_gateway { $payment_gateway->gateway_namespace('Business::OnlinePayment') unless $payment_gateway->gateway_namespace; - } else { #use the standard settings from the config + } elsif (!$payment_gateway) { #use the standard settings from the config # the standard settings from the config could be moved to a null agent # agent_payment_gateway referenced payment_gateway + # remember, this block might be run as a class method if false load_gatewaynum exists + unless ( $conf->exists('business-onlinepayment') ) { if ( $options{'nofatal'} ) { return ''; @@ -356,6 +369,23 @@ sub payment_gateway { $payment_gateway; } +=item invoice_modes + +Returns all L objects that are valid for this agent (i.e. +those with this agentnum or null agentnum). + +=cut + +sub invoice_modes { + my $self = shift; + qsearch( { + table => 'invoice_mode', + hashref => { agentnum => $self->agentnum }, + extra_sql => ' OR agentnum IS NULL', + order_by => ' ORDER BY modename', + } ); +} + =item num_prospect_cust_main Returns the number of prospects (customers with no packages ever ordered) for @@ -395,6 +425,29 @@ sub cust_main_sql { ); } +=item num_ordered_cust_main + +Returns the number of ordered customers for this agent (customers with packages +ordered, but not yet billed). + +=cut + +sub num_ordered_cust_main { + shift->num_sql(FS::cust_main->ordered_sql); +} + +=item ordered_cust_main + +Returns the ordered customers for this agent (customers with packages ordered, +but not yet billed), as cust_main objects. + +=cut + +sub ordered_cust_main { + shift->cust_main_sql(FS::cust_main->ordered_sql); +} + + =item num_active_cust_main Returns the number of active customers for this agent (customers with active @@ -529,6 +582,28 @@ sub num_cancel_cust_pkg { shift->num_pkg_sql(FS::cust_pkg->cancel_sql); } +=item num_on_hold_cust_pkg + +Returns the number of inactive customer packages (one-time packages otherwise +unsuspended/uncancelled) for this agent. + +=cut + +sub num_on_hold_cust_pkg { + shift->num_pkg_sql(FS::cust_pkg->on_hold_sql); +} + +=item num_not_yet_billed_cust_pkg + +Returns the number of inactive customer packages (one-time packages otherwise +unsuspended/uncancelled) for this agent. + +=cut + +sub num_not_yet_billed_cust_pkg { + shift->num_pkg_sql(FS::cust_pkg->not_yet_billed_sql); +} + =item generate_reg_codes NUM PKGPART_ARRAYREF Generates the specified number of registration codes, allowing purchase of the @@ -604,6 +679,31 @@ sub num_prepay_credit { $sth->fetchrow_arrayref->[0]; } +=item num_sales + +Returns the number of non-disabled sales people for this agent. + +=cut + +sub num_sales { + my $self = shift; + my $sth = dbh->prepare( + "SELECT COUNT(*) FROM sales WHERE agentnum = ? + AND ( disabled = '' OR disabled IS NULL )" + ) or die dbh->errstr; + $sth->execute($self->agentnum) or die $sth->errstr; + $sth->fetchrow_arrayref->[0]; +} + +sub commission_where { + my $self = shift; + 'cust_credit.commission_agentnum = ' . $self->agentnum; +} + +sub sales_where { + my $self = shift; + 'cust_main.agentnum = ' . $self->agentnum; +} =back