X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fagent.pm;h=700ea061ee72fed187f1c9f55aa4460b8ef4e7de;hb=980c48cf66eebdf43fa4238aed16fdaa583cdcb2;hp=d291ca070c0c792014455911e8602827fa6d9fba;hpb=a77fb608130055ee1795fb6692acb0296ca69027;p=freeside.git diff --git a/FS/FS/agent.pm b/FS/FS/agent.pm index d291ca070..700ea061e 100644 --- a/FS/FS/agent.pm +++ b/FS/FS/agent.pm @@ -46,27 +46,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 @@ -127,6 +149,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; @@ -200,13 +223,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. @@ -216,15 +240,39 @@ an attempt will be made to select a gateway suited for the taxes paid on the invoice. The I and I options can be used to influence the choice -as well. Presently only 'CC' and 'ECHECK' methods are meaningful. +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} ) { + # still a kludge, but it gets the job done + # and the 'cardtype' semantics don't really apply to thirdparty + # gateways because we have to choose a gateway without ever + # seeing the card number + my $gatewaynum = + $conf->config('selfservice-payment_gateway', $self->agentnum); + my $gateway = FS::payment_gateway->by_key($gatewaynum) + if $gatewaynum; + + if ( $gateway ) { + return $gateway; + } elsif ( $options{'nofatal'} ) { + return ''; + } else { + die "no third-party gateway configured\n"; + } + } my $taxclass = ''; if ( $options{invnum} ) { @@ -246,13 +294,15 @@ sub payment_gateway { } #look for an agent gateway override first - my $cardtype; - if ( $options{method} && $options{method} eq 'CC' && $options{payinfo} ) { - $cardtype = cardtype($options{payinfo}); - } elsif ( $options{method} && $options{method} eq 'ECHECK' ) { - $cardtype = 'ACH'; - } else { - $cardtype = $options{method} || ''; + my $cardtype = ''; + if ( $options{method} ) { + if ( $options{method} eq 'CC' && $options{payinfo} ) { + $cardtype = cardtype($options{payinfo}); + } elsif ( $options{method} eq 'ECHECK' ) { + $cardtype = 'ACH'; + } else { + $cardtype = $options{method} + } } my $override = @@ -270,13 +320,12 @@ sub payment_gateway { taxclass => '', } ); my $payment_gateway; - my $conf = new FS::Conf; if ( $override ) { #use a payment gateway override $payment_gateway = $override->payment_gateway; $payment_gateway->gateway_namespace('Business::OnlinePayment') - unless $payment_gateway->gateway_name; + unless $payment_gateway->gateway_namespace; } else { #use the standard settings from the config @@ -328,6 +377,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 @@ -367,6 +433,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 @@ -576,6 +665,21 @@ 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]; +} =back