X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fagent.pm;h=c102e7be88b1b5106c6df005cc02dab8d476a7d7;hb=d8844f49839b56eac11ee931f730d6e47f1ef628;hp=9b322093b394eeab678433a7a6c5e1eeea6c1e15;hpb=63973c641c4be00765fa27e55c57cc5b9aa4da19;p=freeside.git diff --git a/FS/FS/agent.pm b/FS/FS/agent.pm index 9b322093b..c102e7be8 100644 --- a/FS/FS/agent.pm +++ b/FS/FS/agent.pm @@ -1,19 +1,17 @@ package FS::agent; +use base qw( FS::Commission_Mixin FS::m2m_Common FS::m2name_Common FS::Record ); use strict; use vars qw( @ISA ); -#use Crypt::YAPassGen; -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::reg_code; +use FS::agent_payment_gateway; use FS::TicketSystem; use FS::Conf; -@ISA = qw( FS::m2m_Common FS::Record ); - =head1 NAME FS::agent - Object methods for agent records @@ -46,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 + +primary key (assigned automatically for new agents) + +=item agent + +Text name of this agent + +=item typenum + +Agent type (see L) + +=item ticketing_queueid + +Ticketing Queue + +=item invoice_template + +Invoice template name + +=item agent_custnum + +Optional agent customer (see L) -=item agent - Text name of this agent +=item disabled -=item typenum - Agent type (see L) +Disabled flag, empty or 'Y' -=item ticketing_queueid - Ticketing Queue +=item prog -=item invoice_template - Invoice template name +Deprecated (never used) -=item agent_custnum - Optional agent customer (see L) +=item freq -=item disabled - Disabled flag, empty or 'Y' +Deprecated (never used) -=item prog - Deprecated (never used) +=item username -=item freq - Deprecated (never used) +(Deprecated) Username for the Agent interface -=item username - (Deprecated) Username for the Agent interface +=item _password -=item _password - (Deprecated) Password for the Agent interface +(Deprecated) Password for the Agent interface =back @@ -127,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; @@ -158,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 @@ -177,6 +191,24 @@ sub agent_cust_main { qsearchs( 'cust_main', { 'custnum' => $self->agent_custnum } ); } +=item agent_currency + +Returns the FS::agent_currency objects (see L), if any, for +this agent. + +=item agent_currency_hashref + +Returns a hash references of supported additional currencies for this agent. + +=cut + +sub agent_currency_hashref { + my $self = shift; + +{ map { $_->currency => 1 } + $self->agent_currency + }; +} + =item pkgpart_hashref Returns a hash reference. The keys of the hash are pkgparts. The value is @@ -200,13 +232,14 @@ 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, +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. @@ -221,10 +254,43 @@ as well. Presently only 'CC', 'ECHECK', and 'PAYPAL' methods are meaningful. 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, the defined self-service payment gateway will +be returned. + =cut sub payment_gateway { my ( $self, %options ) = @_; + + my $conf = new FS::Conf; + + if ( $options{thirdparty} ) { + + # allows PayPal to coexist with credit card gateways + my $is_paypal = { op => '!=', value => 'PayPal' }; + if ( uc($options{method}) eq 'PAYPAL' ) { + $is_paypal = '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 { + die "no third-party gateway configured\n"; + } + } my $taxclass = ''; if ( $options{invnum} ) { @@ -252,8 +318,6 @@ sub payment_gateway { $cardtype = cardtype($options{payinfo}); } elsif ( $options{method} eq 'ECHECK' ) { $cardtype = 'ACH'; - } elsif ( $options{method} eq 'PAYPAL' ) { - $cardtype = 'PayPal'; } else { $cardtype = $options{method} } @@ -274,7 +338,6 @@ sub payment_gateway { taxclass => '', } ); my $payment_gateway; - my $conf = new FS::Conf; if ( $override ) { #use a payment gateway override $payment_gateway = $override->payment_gateway; @@ -332,6 +395,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 @@ -371,6 +451,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 @@ -505,6 +608,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 @@ -580,6 +705,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