6 use Business::CreditCard 0.28;
7 use FS::Record qw( dbh qsearch qsearchs );
15 @ISA = qw( FS::m2m_Common FS::Record );
19 FS::agent - Object methods for agent records
25 $record = new FS::agent \%hash;
26 $record = new FS::agent { 'column' => 'value' };
28 $error = $record->insert;
30 $error = $new_record->replace($old_record);
32 $error = $record->delete;
34 $error = $record->check;
36 $agent_type = $record->agent_type;
38 $hashref = $record->pkgpart_hashref;
39 #may purchase $pkgpart if $hashref->{$pkgpart};
43 An FS::agent object represents an agent. Every customer has an agent. Agents
44 can be used to track things like resellers or salespeople. FS::agent inherits
45 from FS::Record. The following fields are currently supported:
49 =item agentnum - primary key (assigned automatically for new agents)
51 =item agent - Text name of this agent
53 =item typenum - Agent type (see L<FS::agent_type>)
55 =item ticketing_queueid - Ticketing Queue
57 =item invoice_template - Invoice template name
59 =item agent_custnum - Optional agent customer (see L<FS::cust_main>)
61 =item disabled - Disabled flag, empty or 'Y'
63 =item prog - Deprecated (never used)
65 =item freq - Deprecated (never used)
67 =item username - (Deprecated) Username for the Agent interface
69 =item _password - (Deprecated) Password for the Agent interface
79 Creates a new agent. To add the agent to the database, see L<"insert">.
83 sub table { 'agent'; }
87 Adds this agent to the database. If there is an error, returns the error,
88 otherwise returns false.
92 Deletes this agent from the database. Only agents with no customers can be
93 deleted. If there is an error, returns the error, otherwise returns false.
100 return "Can't delete an agent with customers!"
101 if qsearch( 'cust_main', { 'agentnum' => $self->agentnum } );
103 $self->SUPER::delete;
106 =item replace OLD_RECORD
108 Replaces OLD_RECORD with this one in the database. If there is an error,
109 returns the error, otherwise returns false.
113 Checks all fields to make sure this is a valid agent. If there is an error,
114 returns the error, otherwise returns false. Called by the insert and replace
123 $self->ut_numbern('agentnum')
124 || $self->ut_text('agent')
125 || $self->ut_number('typenum')
126 || $self->ut_numbern('freq')
127 || $self->ut_textn('prog')
128 || $self->ut_textn('invoice_template')
129 || $self->ut_foreign_keyn('agent_custnum', 'cust_main', 'custnum' )
131 return $error if $error;
133 if ( $self->dbdef_table->column('disabled') ) {
134 $error = $self->ut_enum('disabled', [ '', 'Y' ] );
135 return $error if $error;
138 if ( $self->dbdef_table->column('username') ) {
139 $error = $self->ut_alphan('username');
140 return $error if $error;
141 if ( length($self->username) ) {
142 my $conflict = qsearchs('agent', { 'username' => $self->username } );
143 return 'duplicate agent username (with '. $conflict->agent. ')'
144 if $conflict && $conflict->agentnum != $self->agentnum;
145 $error = $self->ut_text('password'); # ut_text... arbitrary choice
147 $self->_password('');
151 return "Unknown typenum!"
152 unless $self->agent_type;
159 Returns the FS::agent_type object (see L<FS::agent_type>) for this agent.
165 qsearchs( 'agent_type', { 'typenum' => $self->typenum } );
168 =item agent_cust_main
170 Returns the FS::cust_main object (see L<FS::cust_main>), if any, for this
175 sub agent_cust_main {
177 qsearchs( 'cust_main', { 'custnum' => $self->agent_custnum } );
180 =item pkgpart_hashref
182 Returns a hash reference. The keys of the hash are pkgparts. The value is
183 true if this agent may purchase the specified package definition. See
188 sub pkgpart_hashref {
190 $self->agent_type->pkgpart_hashref;
193 =item ticketing_queue
195 Returns the queue name corresponding with the id from the I<ticketing_queueid>
196 field, or the empty string.
200 sub ticketing_queue {
202 FS::TicketSystem->queue($self->ticketing_queueid);
205 =item payment_gateway [ OPTION => VALUE, ... ]
207 Returns a payment gateway object (see L<FS::payment_gateway>) for this agent.
209 Currently available options are I<nofatal>, I<invnum>, I<method>, and I<payinfo>.
211 If I<nofatal> is set, and no gateway is available, then the empty string
212 will be returned instead of throwing a fatal exception.
214 If I<invnum> is set to the number of an invoice (see L<FS::cust_bill>) then
215 an attempt will be made to select a gateway suited for the taxes paid on
218 The I<method> and I<payinfo> options can be used to influence the choice
219 as well. Presently only 'CC', 'ECHECK', and 'PAYPAL' methods are meaningful.
221 When the I<method> is 'CC' then the card number in I<payinfo> can direct
222 this routine to route to a gateway suited for that type of card.
226 sub payment_gateway {
227 my ( $self, %options ) = @_;
230 if ( $options{invnum} ) {
232 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{invnum} } );
233 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
239 $cust_bill->cust_bill_pkg;
241 my @taxclasses = map $_->taxclass, @part_pkg;
243 $taxclass = $taxclasses[0]
244 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
245 #different taxclasses
248 #look for an agent gateway override first
250 if ( $options{method} ) {
251 if ( $options{method} eq 'CC' && $options{payinfo} ) {
252 $cardtype = cardtype($options{payinfo});
253 } elsif ( $options{method} eq 'ECHECK' ) {
255 } elsif ( $options{method} eq 'PAYPAL' ) {
256 $cardtype = 'PayPal';
258 $cardtype = $options{method}
263 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
264 cardtype => $cardtype,
265 taxclass => $taxclass, } )
266 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
268 taxclass => $taxclass, } )
269 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
270 cardtype => $cardtype,
272 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
277 my $conf = new FS::Conf;
278 if ( $override ) { #use a payment gateway override
280 $payment_gateway = $override->payment_gateway;
282 $payment_gateway->gateway_namespace('Business::OnlinePayment')
283 unless $payment_gateway->gateway_namespace;
285 } else { #use the standard settings from the config
287 # the standard settings from the config could be moved to a null agent
288 # agent_payment_gateway referenced payment_gateway
290 unless ( $conf->exists('business-onlinepayment') ) {
291 if ( $options{'nofatal'} ) {
294 die "Real-time processing not enabled\n";
299 my $bop_config = 'business-onlinepayment';
300 $bop_config .= '-ach'
301 if ( $options{method}
302 && $options{method} =~ /^(ECHECK|CHEK)$/
303 && $conf->exists($bop_config. '-ach')
305 my ( $processor, $login, $password, $action, @bop_options ) =
306 $conf->config($bop_config);
307 $action ||= 'normal authorization';
308 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
309 die "No real-time processor is enabled - ".
310 "did you set the business-onlinepayment configuration value?\n"
313 $payment_gateway = new FS::payment_gateway;
315 $payment_gateway->gateway_namespace( $conf->config('business-onlinepayment-namespace') ||
316 'Business::OnlinePayment');
317 $payment_gateway->gateway_module($processor);
318 $payment_gateway->gateway_username($login);
319 $payment_gateway->gateway_password($password);
320 $payment_gateway->gateway_action($action);
321 $payment_gateway->set('options', [ @bop_options ]);
325 unless ( $payment_gateway->gateway_namespace ) {
326 $payment_gateway->gateway_namespace(
327 scalar($conf->config('business-onlinepayment-namespace'))
328 || 'Business::OnlinePayment'
335 =item num_prospect_cust_main
337 Returns the number of prospects (customers with no packages ever ordered) for
342 sub num_prospect_cust_main {
343 shift->num_sql(FS::cust_main->prospect_sql);
347 my( $self, $sql ) = @_;
348 my $statement = "SELECT COUNT(*) FROM cust_main WHERE agentnum = ? AND $sql";
349 my $sth = dbh->prepare($statement) or die dbh->errstr." preparing $statement";
350 $sth->execute($self->agentnum) or die $sth->errstr. " executing $statement";
351 $sth->fetchrow_arrayref->[0];
354 =item prospect_cust_main
356 Returns the prospects (customers with no packages ever ordered) for this agent,
357 as cust_main objects.
361 sub prospect_cust_main {
362 shift->cust_main_sql(FS::cust_main->prospect_sql);
366 my( $self, $sql ) = @_;
367 qsearch( 'cust_main',
368 { 'agentnum' => $self->agentnum },
374 =item num_active_cust_main
376 Returns the number of active customers for this agent (customers with active
381 sub num_active_cust_main {
382 shift->num_sql(FS::cust_main->active_sql);
385 =item active_cust_main
387 Returns the active customers for this agent, as cust_main objects.
391 sub active_cust_main {
392 shift->cust_main_sql(FS::cust_main->active_sql);
395 =item num_inactive_cust_main
397 Returns the number of inactive customers for this agent (customers with no
398 active recurring packages, but otherwise unsuspended/uncancelled).
402 sub num_inactive_cust_main {
403 shift->num_sql(FS::cust_main->inactive_sql);
406 =item inactive_cust_main
408 Returns the inactive customers for this agent, as cust_main objects.
412 sub inactive_cust_main {
413 shift->cust_main_sql(FS::cust_main->inactive_sql);
417 =item num_susp_cust_main
419 Returns the number of suspended customers for this agent.
423 sub num_susp_cust_main {
424 shift->num_sql(FS::cust_main->susp_sql);
429 Returns the suspended customers for this agent, as cust_main objects.
434 shift->cust_main_sql(FS::cust_main->susp_sql);
437 =item num_cancel_cust_main
439 Returns the number of cancelled customer for this agent.
443 sub num_cancel_cust_main {
444 shift->num_sql(FS::cust_main->cancel_sql);
447 =item cancel_cust_main
449 Returns the cancelled customers for this agent, as cust_main objects.
453 sub cancel_cust_main {
454 shift->cust_main_sql(FS::cust_main->cancel_sql);
457 =item num_active_cust_pkg
459 Returns the number of active customer packages for this agent.
463 sub num_active_cust_pkg {
464 shift->num_pkg_sql(FS::cust_pkg->active_sql);
468 my( $self, $sql ) = @_;
470 "SELECT COUNT(*) FROM cust_pkg LEFT JOIN cust_main USING ( custnum )".
471 " WHERE agentnum = ? AND $sql";
472 my $sth = dbh->prepare($statement) or die dbh->errstr." preparing $statement";
473 $sth->execute($self->agentnum) or die $sth->errstr. "executing $statement";
474 $sth->fetchrow_arrayref->[0];
477 =item num_inactive_cust_pkg
479 Returns the number of inactive customer packages (one-time packages otherwise
480 unsuspended/uncancelled) for this agent.
484 sub num_inactive_cust_pkg {
485 shift->num_pkg_sql(FS::cust_pkg->inactive_sql);
488 =item num_susp_cust_pkg
490 Returns the number of suspended customer packages for this agent.
494 sub num_susp_cust_pkg {
495 shift->num_pkg_sql(FS::cust_pkg->susp_sql);
498 =item num_cancel_cust_pkg
500 Returns the number of cancelled customer packages for this agent.
504 sub num_cancel_cust_pkg {
505 shift->num_pkg_sql(FS::cust_pkg->cancel_sql);
508 =item generate_reg_codes NUM PKGPART_ARRAYREF
510 Generates the specified number of registration codes, allowing purchase of the
511 specified package definitions. Returns an array reference of the newly
512 generated codes, or a scalar error message.
516 #false laziness w/prepay_credit::generate
517 sub generate_reg_codes {
518 my( $self, $num, $pkgparts ) = @_;
520 my @codeset = ( 'A'..'Z' );
522 local $SIG{HUP} = 'IGNORE';
523 local $SIG{INT} = 'IGNORE';
524 local $SIG{QUIT} = 'IGNORE';
525 local $SIG{TERM} = 'IGNORE';
526 local $SIG{TSTP} = 'IGNORE';
527 local $SIG{PIPE} = 'IGNORE';
529 my $oldAutoCommit = $FS::UID::AutoCommit;
530 local $FS::UID::AutoCommit = 0;
535 my $reg_code = new FS::reg_code {
536 'agentnum' => $self->agentnum,
537 'code' => join('', map($codeset[int(rand $#codeset)], (0..7) ) ),
539 my $error = $reg_code->insert($pkgparts);
541 $dbh->rollback if $oldAutoCommit;
544 push @codes, $reg_code->code;
547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
555 Returns the number of unused registration codes for this agent.
561 my $sth = dbh->prepare(
562 "SELECT COUNT(*) FROM reg_code WHERE agentnum = ?"
563 ) or die dbh->errstr;
564 $sth->execute($self->agentnum) or die $sth->errstr;
565 $sth->fetchrow_arrayref->[0];
568 =item num_prepay_credit
570 Returns the number of unused prepaid cards for this agent.
574 sub num_prepay_credit {
576 my $sth = dbh->prepare(
577 "SELECT COUNT(*) FROM prepay_credit WHERE agentnum = ?"
578 ) or die dbh->errstr;
579 $sth->execute($self->agentnum) or die $sth->errstr;
580 $sth->fetchrow_arrayref->[0];
590 L<FS::Record>, L<FS::agent_type>, L<FS::cust_main>, L<FS::part_pkg>,
591 schema.html from the base documentation.