X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fagent.pm;h=4ad878d4306302141d8455bc58e36058b880170b;hp=0cd07ef15b4984aebc1cb903ca6992351c668242;hb=674cb2d9d7105f4cc2871539b2e9f7088cdaa750;hpb=5c0cfcb8dec7c4f3a7aecea4c550ffb4bfb774c3 diff --git a/FS/FS/agent.pm b/FS/FS/agent.pm index 0cd07ef15..4ad878d43 100644 --- a/FS/FS/agent.pm +++ b/FS/FS/agent.pm @@ -1,5 +1,5 @@ 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 ); @@ -7,9 +7,8 @@ use Business::CreditCard 0.28; 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,7 +232,7 @@ field, or the empty string. sub ticketing_queue { my $self = shift; FS::TicketSystem->queue($self->ticketing_queueid); -}; +} =item payment_gateway [ OPTION => VALUE, ... ] @@ -263,8 +271,27 @@ sub payment_gateway { # seeing the card number my $gatewaynum = $conf->config('selfservice-payment_gateway', $self->agentnum); - my $gateway = FS::payment_gateway->by_key($gatewaynum) - if $gatewaynum; + my $gateway; + $gateway = FS::payment_gateway->by_key($gatewaynum) if $gatewaynum; + return $gateway if $gateway; + + # a little less kludgey than the above, and allows PayPal to coexist + # with credit card gateways + my $is_paypal = { op => '!=', value => 'PayPal' }; + if ( uc($options{method}) eq 'PAYPAL' ) { + $is_paypal = 'PayPal'; + } + + $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; @@ -378,6 +405,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 @@ -417,6 +461,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 @@ -551,6 +618,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 @@ -642,6 +731,16 @@ sub num_sales { $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 =head1 BUGS