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<invnum>, I<method>, and I<payinfo>.
211 If I<invnum> is set to the number of an invoice (see L<FS::cust_bill>) then
212 an attempt will be made to select a gateway suited for the taxes paid on
215 The I<method> and I<payinfo> options can be used to influence the choice
216 as well. Presently only 'CC' and 'ECHECK' methods are meaningful.
218 When the I<method> is 'CC' then the card number in I<payinfo> can direct
219 this routine to route to a gateway suited for that type of card.
223 sub payment_gateway {
224 my ( $self, %options ) = @_;
227 if ( $options{invnum} ) {
228 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{invnum} } );
229 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
231 map { $_->part_pkg->taxclass }
234 $cust_bill->cust_bill_pkg;
235 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
236 #different taxclasses $taxclass = $taxclasses[0];
240 #look for an agent gateway override first
242 if ( $options{method} && $options{method} eq 'CC' ) {
243 $cardtype = cardtype($options{payinfo});
244 } elsif ( $options{method} && $options{method} eq 'ECHECK' ) {
247 $cardtype = $options{method} || '';
251 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
252 cardtype => $cardtype,
253 taxclass => $taxclass, } )
254 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
256 taxclass => $taxclass, } )
257 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
258 cardtype => $cardtype,
260 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
264 my $payment_gateway = new FS::payment_gateway;
265 if ( $override ) { #use a payment gateway override
267 $payment_gateway = $override->payment_gateway;
269 } else { #use the standard settings from the config
270 # the standard settings from the config could be moved to a null agent
271 # agent_payment_gateway referenced payment_gateway
273 my $conf = new FS::Conf;
274 die "Real-time processing not enabled\n"
275 unless $conf->exists('business-onlinepayment');
278 my $bop_config = 'business-onlinepayment';
279 $bop_config .= '-ach'
280 if ( $options{method}
281 && $options{method} =~ /^(ECHECK|CHEK)$/
282 && $conf->exists($bop_config. '-ach')
284 my ( $processor, $login, $password, $action, @bop_options ) =
285 $conf->config($bop_config);
286 $action ||= 'normal authorization';
287 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
288 die "No real-time processor is enabled - ".
289 "did you set the business-onlinepayment configuration value?\n"
292 $payment_gateway->gateway_namespace( $conf->config('business-onlinepayment-namespace') ||
293 'Business::OnlinePayment');
294 $payment_gateway->gateway_module($processor);
295 $payment_gateway->gateway_username($login);
296 $payment_gateway->gateway_password($password);
297 $payment_gateway->gateway_action($action);
298 $payment_gateway->set('options', [ @bop_options ]);
305 =item num_prospect_cust_main
307 Returns the number of prospects (customers with no packages ever ordered) for
312 sub num_prospect_cust_main {
313 shift->num_sql(FS::cust_main->prospect_sql);
317 my( $self, $sql ) = @_;
318 my $statement = "SELECT COUNT(*) FROM cust_main WHERE agentnum = ? AND $sql";
319 my $sth = dbh->prepare($statement) or die dbh->errstr." preparing $statement";
320 $sth->execute($self->agentnum) or die $sth->errstr. " executing $statement";
321 $sth->fetchrow_arrayref->[0];
324 =item prospect_cust_main
326 Returns the prospects (customers with no packages ever ordered) for this agent,
327 as cust_main objects.
331 sub prospect_cust_main {
332 shift->cust_main_sql(FS::cust_main->prospect_sql);
336 my( $self, $sql ) = @_;
337 qsearch( 'cust_main',
338 { 'agentnum' => $self->agentnum },
344 =item num_active_cust_main
346 Returns the number of active customers for this agent (customers with active
351 sub num_active_cust_main {
352 shift->num_sql(FS::cust_main->active_sql);
355 =item active_cust_main
357 Returns the active customers for this agent, as cust_main objects.
361 sub active_cust_main {
362 shift->cust_main_sql(FS::cust_main->active_sql);
365 =item num_inactive_cust_main
367 Returns the number of inactive customers for this agent (customers with no
368 active recurring packages, but otherwise unsuspended/uncancelled).
372 sub num_inactive_cust_main {
373 shift->num_sql(FS::cust_main->inactive_sql);
376 =item inactive_cust_main
378 Returns the inactive customers for this agent, as cust_main objects.
382 sub inactive_cust_main {
383 shift->cust_main_sql(FS::cust_main->inactive_sql);
387 =item num_susp_cust_main
389 Returns the number of suspended customers for this agent.
393 sub num_susp_cust_main {
394 shift->num_sql(FS::cust_main->susp_sql);
399 Returns the suspended customers for this agent, as cust_main objects.
404 shift->cust_main_sql(FS::cust_main->susp_sql);
407 =item num_cancel_cust_main
409 Returns the number of cancelled customer for this agent.
413 sub num_cancel_cust_main {
414 shift->num_sql(FS::cust_main->cancel_sql);
417 =item cancel_cust_main
419 Returns the cancelled customers for this agent, as cust_main objects.
423 sub cancel_cust_main {
424 shift->cust_main_sql(FS::cust_main->cancel_sql);
427 =item num_active_cust_pkg
429 Returns the number of active customer packages for this agent.
433 sub num_active_cust_pkg {
434 shift->num_pkg_sql(FS::cust_pkg->active_sql);
438 my( $self, $sql ) = @_;
440 "SELECT COUNT(*) FROM cust_pkg LEFT JOIN cust_main USING ( custnum )".
441 " WHERE agentnum = ? AND $sql";
442 my $sth = dbh->prepare($statement) or die dbh->errstr." preparing $statement";
443 $sth->execute($self->agentnum) or die $sth->errstr. "executing $statement";
444 $sth->fetchrow_arrayref->[0];
447 =item num_inactive_cust_pkg
449 Returns the number of inactive customer packages (one-time packages otherwise
450 unsuspended/uncancelled) for this agent.
454 sub num_inactive_cust_pkg {
455 shift->num_pkg_sql(FS::cust_pkg->inactive_sql);
458 =item num_susp_cust_pkg
460 Returns the number of suspended customer packages for this agent.
464 sub num_susp_cust_pkg {
465 shift->num_pkg_sql(FS::cust_pkg->susp_sql);
468 =item num_cancel_cust_pkg
470 Returns the number of cancelled customer packages for this agent.
474 sub num_cancel_cust_pkg {
475 shift->num_pkg_sql(FS::cust_pkg->cancel_sql);
478 =item generate_reg_codes NUM PKGPART_ARRAYREF
480 Generates the specified number of registration codes, allowing purchase of the
481 specified package definitions. Returns an array reference of the newly
482 generated codes, or a scalar error message.
486 #false laziness w/prepay_credit::generate
487 sub generate_reg_codes {
488 my( $self, $num, $pkgparts ) = @_;
490 my @codeset = ( 'A'..'Z' );
492 local $SIG{HUP} = 'IGNORE';
493 local $SIG{INT} = 'IGNORE';
494 local $SIG{QUIT} = 'IGNORE';
495 local $SIG{TERM} = 'IGNORE';
496 local $SIG{TSTP} = 'IGNORE';
497 local $SIG{PIPE} = 'IGNORE';
499 my $oldAutoCommit = $FS::UID::AutoCommit;
500 local $FS::UID::AutoCommit = 0;
505 my $reg_code = new FS::reg_code {
506 'agentnum' => $self->agentnum,
507 'code' => join('', map($codeset[int(rand $#codeset)], (0..7) ) ),
509 my $error = $reg_code->insert($pkgparts);
511 $dbh->rollback if $oldAutoCommit;
514 push @codes, $reg_code->code;
517 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
525 Returns the number of unused registration codes for this agent.
531 my $sth = dbh->prepare(
532 "SELECT COUNT(*) FROM reg_code WHERE agentnum = ?"
533 ) or die dbh->errstr;
534 $sth->execute($self->agentnum) or die $sth->errstr;
535 $sth->fetchrow_arrayref->[0];
538 =item num_prepay_credit
540 Returns the number of unused prepaid cards for this agent.
544 sub num_prepay_credit {
546 my $sth = dbh->prepare(
547 "SELECT COUNT(*) FROM prepay_credit WHERE agentnum = ?"
548 ) or die dbh->errstr;
549 $sth->execute($self->agentnum) or die $sth->errstr;
550 $sth->fetchrow_arrayref->[0];
560 L<FS::Record>, L<FS::agent_type>, L<FS::cust_main>, L<FS::part_pkg>,
561 schema.html from the base documentation.