2 use base qw( FS::Commission_Mixin FS::m2m_Common FS::m2name_Common FS::Record );
6 use Business::CreditCard 0.35;
7 use FS::Record qw( dbh qsearch qsearchs );
11 use FS::agent_payment_gateway;
12 use FS::payment_gateway;
18 FS::agent - Object methods for agent records
24 $record = new FS::agent \%hash;
25 $record = new FS::agent { 'column' => 'value' };
27 $error = $record->insert;
29 $error = $new_record->replace($old_record);
31 $error = $record->delete;
33 $error = $record->check;
35 $agent_type = $record->agent_type;
37 $hashref = $record->pkgpart_hashref;
38 #may purchase $pkgpart if $hashref->{$pkgpart};
42 An FS::agent object represents an agent. Every customer has an agent. Agents
43 can be used to track things like resellers or salespeople. FS::agent inherits
44 from FS::Record. The following fields are currently supported:
50 primary key (assigned automatically for new agents)
54 Text name of this agent
58 Agent type (see L<FS::agent_type>)
60 =item ticketing_queueid
64 =item invoice_template
70 Optional agent customer (see L<FS::cust_main>)
74 Disabled flag, empty or 'Y'
78 Deprecated (never used)
82 Deprecated (never used)
86 (Deprecated) Username for the Agent interface
90 (Deprecated) Password for the Agent interface
100 Creates a new agent. To add the agent to the database, see L<"insert">.
104 sub table { 'agent'; }
108 Adds this agent to the database. If there is an error, returns the error,
109 otherwise returns false.
113 Deletes this agent from the database. Only agents with no customers can be
114 deleted. If there is an error, returns the error, otherwise returns false.
121 return "Can't delete an agent with customers!"
122 if qsearch( 'cust_main', { 'agentnum' => $self->agentnum } );
124 $self->SUPER::delete;
127 =item replace OLD_RECORD
129 Replaces OLD_RECORD with this one in the database. If there is an error,
130 returns the error, otherwise returns false.
134 Checks all fields to make sure this is a valid agent. If there is an error,
135 returns the error, otherwise returns false. Called by the insert and replace
144 $self->ut_numbern('agentnum')
145 || $self->ut_text('agent')
146 || $self->ut_number('typenum')
147 || $self->ut_numbern('freq')
148 || $self->ut_textn('prog')
149 || $self->ut_textn('invoice_template')
150 || $self->ut_foreign_keyn('agent_custnum', 'cust_main', 'custnum' )
151 || $self->ut_numbern('ticketing_queueid')
153 return $error if $error;
155 if ( $self->dbdef_table->column('disabled') ) {
156 $error = $self->ut_enum('disabled', [ '', 'Y' ] );
157 return $error if $error;
160 if ( $self->dbdef_table->column('username') ) {
161 $error = $self->ut_alphan('username');
162 return $error if $error;
163 if ( length($self->username) ) {
164 my $conflict = qsearchs('agent', { 'username' => $self->username } );
165 return 'duplicate agent username (with '. $conflict->agent. ')'
166 if $conflict && $conflict->agentnum != $self->agentnum;
167 $error = $self->ut_text('password'); # ut_text... arbitrary choice
169 $self->_password('');
173 return "Unknown typenum!"
174 unless $self->agent_type;
181 Returns the FS::agent_type object (see L<FS::agent_type>) for this agent.
183 =item agent_cust_main
185 Returns the FS::cust_main object (see L<FS::cust_main>), if any, for this
190 sub agent_cust_main {
192 qsearchs( 'cust_main', { 'custnum' => $self->agent_custnum } );
197 Returns the FS::agent_currency objects (see L<FS::agent_currency>), if any, for
200 =item agent_currency_hashref
202 Returns a hash references of supported additional currencies for this agent.
206 sub agent_currency_hashref {
208 +{ map { $_->currency => 1 }
209 $self->agent_currency
213 =item pkgpart_hashref
215 Returns a hash reference. The keys of the hash are pkgparts. The value is
216 true if this agent may purchase the specified package definition. See
221 sub pkgpart_hashref {
223 $self->agent_type->pkgpart_hashref;
226 =item ticketing_queue
228 Returns the queue name corresponding with the id from the I<ticketing_queueid>
229 field, or the empty string.
233 sub ticketing_queue {
235 FS::TicketSystem->queue($self->ticketing_queueid);
238 =item payment_gateway [ OPTION => VALUE, ... ]
240 Returns a payment gateway object (see L<FS::payment_gateway>) for this agent.
242 Currently available options are I<nofatal>, I<method>, I<thirdparty> and I<conf>.
244 If I<nofatal> is set, and no gateway is available, then the empty string
245 will be returned instead of throwing a fatal exception.
247 The I<method> option can be used to influence the choice
248 as well. Presently only CHEK/ECHECK and PAYPAL methods are meaningful.
250 If I<method> is CHEK/ECHECK and the default gateway is being returned,
251 the business-onlinepayment-ach gateway will be returned if available.
253 If I<thirdparty> is set and the I<method> is PAYPAL, the defined paypal
254 gateway will be returned.
256 Exisisting I<$conf> may be passed for efficiency.
260 # opts invnum/payinfo for cardtype/taxclass overrides no longer supported
261 # any future overrides added here need to be reconciled with the tokenization process
263 sub payment_gateway {
264 my ( $self, %options ) = @_;
266 $options{'conf'} ||= new FS::Conf;
267 my $conf = $options{'conf'};
269 if ( $options{thirdparty} ) {
271 # allows PayPal to coexist with credit card gateways
272 my $is_paypal = { op => '!=', value => 'PayPal' };
273 if ( uc($options{method}) eq 'PAYPAL' ) {
274 $is_paypal = 'PayPal';
277 my $gateway = qsearchs({
278 table => 'payment_gateway',
279 addl_from => ' JOIN agent_payment_gateway USING (gatewaynum) ',
281 gateway_namespace => 'Business::OnlineThirdPartyPayment',
282 gateway_module => $is_paypal,
285 extra_sql => ' AND agentnum = '.$self->agentnum,
290 } elsif ( $options{'nofatal'} ) {
293 die "no third-party gateway configured\n";
298 if ( $options{method} eq 'ECHECK' ) { $cardtype = 'ACH'; }
301 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
302 cardtype => $cardtype, } )
303 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum } );
305 my $payment_gateway = FS::payment_gateway->by_key_or_default(
306 gatewaynum => $override ? $override->gatewaynum : '',
315 Returns all L<FS::invoice_mode> objects that are valid for this agent (i.e.
316 those with this agentnum or null agentnum).
323 table => 'invoice_mode',
324 hashref => { agentnum => $self->agentnum },
325 extra_sql => ' OR agentnum IS NULL',
326 order_by => ' ORDER BY modename',
330 =item num_prospect_cust_main
332 Returns the number of prospects (customers with no packages ever ordered) for
337 sub num_prospect_cust_main {
338 shift->num_sql(FS::cust_main->prospect_sql);
342 my( $self, $sql ) = @_;
343 my $statement = "SELECT COUNT(*) FROM cust_main WHERE agentnum = ? AND $sql";
344 my $sth = dbh->prepare($statement) or die dbh->errstr." preparing $statement";
345 $sth->execute($self->agentnum) or die $sth->errstr. " executing $statement";
346 $sth->fetchrow_arrayref->[0];
349 =item prospect_cust_main
351 Returns the prospects (customers with no packages ever ordered) for this agent,
352 as cust_main objects.
356 sub prospect_cust_main {
357 shift->cust_main_sql(FS::cust_main->prospect_sql);
361 my( $self, $sql ) = @_;
362 qsearch( 'cust_main',
363 { 'agentnum' => $self->agentnum },
369 =item num_ordered_cust_main
371 Returns the number of ordered customers for this agent (customers with packages
372 ordered, but not yet billed).
376 sub num_ordered_cust_main {
377 shift->num_sql(FS::cust_main->ordered_sql);
380 =item ordered_cust_main
382 Returns the ordered customers for this agent (customers with packages ordered,
383 but not yet billed), as cust_main objects.
387 sub ordered_cust_main {
388 shift->cust_main_sql(FS::cust_main->ordered_sql);
392 =item num_active_cust_main
394 Returns the number of active customers for this agent (customers with active
399 sub num_active_cust_main {
400 shift->num_sql(FS::cust_main->active_sql);
403 =item active_cust_main
405 Returns the active customers for this agent, as cust_main objects.
409 sub active_cust_main {
410 shift->cust_main_sql(FS::cust_main->active_sql);
413 =item num_inactive_cust_main
415 Returns the number of inactive customers for this agent (customers with no
416 active recurring packages, but otherwise unsuspended/uncancelled).
420 sub num_inactive_cust_main {
421 shift->num_sql(FS::cust_main->inactive_sql);
424 =item inactive_cust_main
426 Returns the inactive customers for this agent, as cust_main objects.
430 sub inactive_cust_main {
431 shift->cust_main_sql(FS::cust_main->inactive_sql);
435 =item num_susp_cust_main
437 Returns the number of suspended customers for this agent.
441 sub num_susp_cust_main {
442 shift->num_sql(FS::cust_main->susp_sql);
447 Returns the suspended customers for this agent, as cust_main objects.
452 shift->cust_main_sql(FS::cust_main->susp_sql);
455 =item num_cancel_cust_main
457 Returns the number of cancelled customer for this agent.
461 sub num_cancel_cust_main {
462 shift->num_sql(FS::cust_main->cancel_sql);
465 =item cancel_cust_main
467 Returns the cancelled customers for this agent, as cust_main objects.
471 sub cancel_cust_main {
472 shift->cust_main_sql(FS::cust_main->cancel_sql);
475 =item num_active_cust_pkg
477 Returns the number of active customer packages for this agent.
481 sub num_active_cust_pkg {
482 shift->num_pkg_sql(FS::cust_pkg->active_sql);
486 my( $self, $sql ) = @_;
488 "SELECT COUNT(*) FROM cust_pkg LEFT JOIN cust_main USING ( custnum )".
489 " WHERE agentnum = ? AND $sql";
490 my $sth = dbh->prepare($statement) or die dbh->errstr." preparing $statement";
491 $sth->execute($self->agentnum) or die $sth->errstr. "executing $statement";
492 $sth->fetchrow_arrayref->[0];
495 =item num_inactive_cust_pkg
497 Returns the number of inactive customer packages (one-time packages otherwise
498 unsuspended/uncancelled) for this agent.
502 sub num_inactive_cust_pkg {
503 shift->num_pkg_sql(FS::cust_pkg->inactive_sql);
506 =item num_susp_cust_pkg
508 Returns the number of suspended customer packages for this agent.
512 sub num_susp_cust_pkg {
513 shift->num_pkg_sql(FS::cust_pkg->susp_sql);
516 =item num_cancel_cust_pkg
518 Returns the number of cancelled customer packages for this agent.
522 sub num_cancel_cust_pkg {
523 shift->num_pkg_sql(FS::cust_pkg->cancel_sql);
526 =item num_on_hold_cust_pkg
528 Returns the number of inactive customer packages (one-time packages otherwise
529 unsuspended/uncancelled) for this agent.
533 sub num_on_hold_cust_pkg {
534 shift->num_pkg_sql(FS::cust_pkg->on_hold_sql);
537 =item num_not_yet_billed_cust_pkg
539 Returns the number of inactive customer packages (one-time packages otherwise
540 unsuspended/uncancelled) for this agent.
544 sub num_not_yet_billed_cust_pkg {
545 shift->num_pkg_sql(FS::cust_pkg->not_yet_billed_sql);
548 =item generate_reg_codes NUM PKGPART_ARRAYREF
550 Generates the specified number of registration codes, allowing purchase of the
551 specified package definitions. Returns an array reference of the newly
552 generated codes, or a scalar error message.
556 #false laziness w/prepay_credit::generate
557 sub generate_reg_codes {
558 my( $self, $num, $pkgparts ) = @_;
560 my @codeset = ( 'A'..'Z' );
562 local $SIG{HUP} = 'IGNORE';
563 local $SIG{INT} = 'IGNORE';
564 local $SIG{QUIT} = 'IGNORE';
565 local $SIG{TERM} = 'IGNORE';
566 local $SIG{TSTP} = 'IGNORE';
567 local $SIG{PIPE} = 'IGNORE';
569 my $oldAutoCommit = $FS::UID::AutoCommit;
570 local $FS::UID::AutoCommit = 0;
575 my $reg_code = new FS::reg_code {
576 'agentnum' => $self->agentnum,
577 'code' => join('', map($codeset[int(rand $#codeset)], (0..7) ) ),
579 my $error = $reg_code->insert($pkgparts);
581 $dbh->rollback if $oldAutoCommit;
584 push @codes, $reg_code->code;
587 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
595 Returns the number of unused registration codes for this agent.
601 my $sth = dbh->prepare(
602 "SELECT COUNT(*) FROM reg_code WHERE agentnum = ?"
603 ) or die dbh->errstr;
604 $sth->execute($self->agentnum) or die $sth->errstr;
605 $sth->fetchrow_arrayref->[0];
608 =item num_prepay_credit
610 Returns the number of unused prepaid cards for this agent.
614 sub num_prepay_credit {
616 my $sth = dbh->prepare(
617 "SELECT COUNT(*) FROM prepay_credit WHERE agentnum = ?"
618 ) or die dbh->errstr;
619 $sth->execute($self->agentnum) or die $sth->errstr;
620 $sth->fetchrow_arrayref->[0];
625 Returns the number of non-disabled sales people for this agent.
631 my $sth = dbh->prepare(
632 "SELECT COUNT(*) FROM sales WHERE agentnum = ?
633 AND ( disabled = '' OR disabled IS NULL )"
634 ) or die dbh->errstr;
635 $sth->execute($self->agentnum) or die $sth->errstr;
636 $sth->fetchrow_arrayref->[0];
639 sub commission_where {
641 'cust_credit.commission_agentnum = ' . $self->agentnum;
646 'cust_main.agentnum = ' . $self->agentnum;
655 L<FS::Record>, L<FS::agent_type>, L<FS::cust_main>, L<FS::part_pkg>,
656 schema.html from the base documentation.