4 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf
6 $import $ignore_expired_card
7 $skip_fuzzyfiles @fuzzyfields
10 use vars qw( $realtime_bop_decline_quiet ); #ugh
15 eval "use Time::Local;";
16 die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
17 if $] < 5.006 && !defined($Time::Local::VERSION);
18 #eval "use Time::Local qw(timelocal timelocal_nocheck);";
19 eval "use Time::Local qw(timelocal_nocheck);";
21 use Digest::MD5 qw(md5_base64);
25 use File::Slurp qw( slurp );
26 use File::Temp qw( tempfile );
27 use String::Approx qw(amatch);
28 use Business::CreditCard 0.28;
31 use FS::UID qw( getotaker dbh driver_name );
32 use FS::Record qw( qsearchs qsearch dbdef );
33 use FS::Misc qw( generate_email send_email generate_ps do_print );
34 use FS::Msgcat qw(gettext);
39 use FS::cust_bill_pkg;
41 use FS::cust_pay_pending;
42 use FS::cust_pay_void;
45 use FS::part_referral;
46 use FS::cust_main_county;
48 use FS::cust_main_invoice;
49 use FS::cust_credit_bill;
50 use FS::cust_bill_pay;
51 use FS::prepay_credit;
54 use FS::part_bill_event qw(due_events);
55 use FS::cust_bill_event;
56 use FS::cust_tax_exempt;
57 use FS::cust_tax_exempt_pkg;
59 use FS::payment_gateway;
60 use FS::agent_payment_gateway;
62 use FS::payinfo_Mixin;
64 @ISA = qw( FS::Record FS::payinfo_Mixin );
66 @EXPORT_OK = qw( smart_search );
68 $realtime_bop_decline_quiet = 0;
70 # 1 is mostly method/subroutine entry and options
71 # 2 traces progress of some operations
72 # 3 is even more information including possibly sensitive data
74 $me = '[FS::cust_main]';
77 $ignore_expired_card = 0;
80 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
82 @encrypted_fields = ('payinfo', 'paycvv');
83 sub nohistory_fields { ('paycvv'); }
85 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
87 #ask FS::UID to run this stuff for us later
88 #$FS::UID::callback{'FS::cust_main'} = sub {
89 install_callback FS::UID sub {
91 #yes, need it for stuff below (prolly should be cached)
96 my ( $hashref, $cache ) = @_;
97 if ( exists $hashref->{'pkgnum'} ) {
98 #@{ $self->{'_pkgnum'} } = ();
99 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
100 $self->{'_pkgnum'} = $subcache;
101 #push @{ $self->{'_pkgnum'} },
102 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
108 FS::cust_main - Object methods for cust_main records
114 $record = new FS::cust_main \%hash;
115 $record = new FS::cust_main { 'column' => 'value' };
117 $error = $record->insert;
119 $error = $new_record->replace($old_record);
121 $error = $record->delete;
123 $error = $record->check;
125 @cust_pkg = $record->all_pkgs;
127 @cust_pkg = $record->ncancelled_pkgs;
129 @cust_pkg = $record->suspended_pkgs;
131 $error = $record->bill;
132 $error = $record->bill %options;
133 $error = $record->bill 'time' => $time;
135 $error = $record->collect;
136 $error = $record->collect %options;
137 $error = $record->collect 'invoice_time' => $time,
142 An FS::cust_main object represents a customer. FS::cust_main inherits from
143 FS::Record. The following fields are currently supported:
147 =item custnum - primary key (assigned automatically for new customers)
149 =item agentnum - agent (see L<FS::agent>)
151 =item refnum - Advertising source (see L<FS::part_referral>)
157 =item ss - social security number (optional)
159 =item company - (optional)
163 =item address2 - (optional)
167 =item county - (optional, see L<FS::cust_main_county>)
169 =item state - (see L<FS::cust_main_county>)
173 =item country - (see L<FS::cust_main_county>)
175 =item daytime - phone (optional)
177 =item night - phone (optional)
179 =item fax - phone (optional)
181 =item ship_first - name
183 =item ship_last - name
185 =item ship_company - (optional)
189 =item ship_address2 - (optional)
193 =item ship_county - (optional, see L<FS::cust_main_county>)
195 =item ship_state - (see L<FS::cust_main_county>)
199 =item ship_country - (see L<FS::cust_main_county>)
201 =item ship_daytime - phone (optional)
203 =item ship_night - phone (optional)
205 =item ship_fax - phone (optional)
207 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
209 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
211 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
215 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
217 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
219 =item paystart_month - start date month (maestro/solo cards only)
221 =item paystart_year - start date year (maestro/solo cards only)
223 =item payissue - issue number (maestro/solo cards only)
225 =item payname - name on card or billing name
227 =item payip - IP address from which payment information was received
229 =item tax - tax exempt, empty or `Y'
231 =item otaker - order taker (assigned automatically, see L<FS::UID>)
233 =item comments - comments (optional)
235 =item referral_custnum - referring customer number
237 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
239 =item dundate - a suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
249 Creates a new customer. To add the customer to the database, see L<"insert">.
251 Note that this stores the hash reference, not a distinct copy of the hash it
252 points to. You can ask the object for a copy with the I<hash> method.
256 sub table { 'cust_main'; }
258 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
260 Adds this customer to the database. If there is an error, returns the error,
261 otherwise returns false.
263 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
264 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
265 are inserted atomicly, or the transaction is rolled back. Passing an empty
266 hash reference is equivalent to not supplying this parameter. There should be
267 a better explanation of this, but until then, here's an example:
270 tie %hash, 'Tie::RefHash'; #this part is important
272 $cust_pkg => [ $svc_acct ],
275 $cust_main->insert( \%hash );
277 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
278 be set as the invoicing list (see L<"invoicing_list">). Errors return as
279 expected and rollback the entire transaction; it is not necessary to call
280 check_invoicing_list first. The invoicing_list is set after the records in the
281 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
282 invoicing_list destination to the newly-created svc_acct. Here's an example:
284 $cust_main->insert( {}, [ $email, 'POST' ] );
286 Currently available options are: I<depend_jobnum> and I<noexport>.
288 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
289 on the supplied jobnum (they will not run until the specific job completes).
290 This can be used to defer provisioning until some action completes (such
291 as running the customer's credit card successfully).
293 The I<noexport> option is deprecated. If I<noexport> is set true, no
294 provisioning jobs (exports) are scheduled. (You can schedule them later with
295 the B<reexport> method.)
301 my $cust_pkgs = @_ ? shift : {};
302 my $invoicing_list = @_ ? shift : '';
304 warn "$me insert called with options ".
305 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
308 local $SIG{HUP} = 'IGNORE';
309 local $SIG{INT} = 'IGNORE';
310 local $SIG{QUIT} = 'IGNORE';
311 local $SIG{TERM} = 'IGNORE';
312 local $SIG{TSTP} = 'IGNORE';
313 local $SIG{PIPE} = 'IGNORE';
315 my $oldAutoCommit = $FS::UID::AutoCommit;
316 local $FS::UID::AutoCommit = 0;
319 my $prepay_identifier = '';
320 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
322 if ( $self->payby eq 'PREPAY' ) {
324 $self->payby('BILL');
325 $prepay_identifier = $self->payinfo;
328 warn " looking up prepaid card $prepay_identifier\n"
331 my $error = $self->get_prepay( $prepay_identifier,
332 'amount_ref' => \$amount,
333 'seconds_ref' => \$seconds,
334 'upbytes_ref' => \$upbytes,
335 'downbytes_ref' => \$downbytes,
336 'totalbytes_ref' => \$totalbytes,
339 $dbh->rollback if $oldAutoCommit;
340 #return "error applying prepaid card (transaction rolled back): $error";
344 $payby = 'PREP' if $amount;
346 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
349 $self->payby('BILL');
350 $amount = $self->paid;
354 warn " inserting $self\n"
357 $self->signupdate(time) unless $self->signupdate;
359 my $error = $self->SUPER::insert;
361 $dbh->rollback if $oldAutoCommit;
362 #return "inserting cust_main record (transaction rolled back): $error";
366 warn " setting invoicing list\n"
369 if ( $invoicing_list ) {
370 $error = $self->check_invoicing_list( $invoicing_list );
372 $dbh->rollback if $oldAutoCommit;
373 #return "checking invoicing_list (transaction rolled back): $error";
376 $self->invoicing_list( $invoicing_list );
379 if ( $conf->config('cust_main-skeleton_tables')
380 && $conf->config('cust_main-skeleton_custnum') ) {
382 warn " inserting skeleton records\n"
385 my $error = $self->start_copy_skel;
387 $dbh->rollback if $oldAutoCommit;
393 warn " ordering packages\n"
396 $error = $self->order_pkgs( $cust_pkgs,
398 'seconds_ref' => \$seconds,
399 'upbytes_ref' => \$upbytes,
400 'downbytes_ref' => \$downbytes,
401 'totalbytes_ref' => \$totalbytes,
404 $dbh->rollback if $oldAutoCommit;
409 $dbh->rollback if $oldAutoCommit;
410 return "No svc_acct record to apply pre-paid time";
412 if ( $upbytes || $downbytes || $totalbytes ) {
413 $dbh->rollback if $oldAutoCommit;
414 return "No svc_acct record to apply pre-paid data";
418 warn " inserting initial $payby payment of $amount\n"
420 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
422 $dbh->rollback if $oldAutoCommit;
423 return "inserting payment (transaction rolled back): $error";
427 unless ( $import || $skip_fuzzyfiles ) {
428 warn " queueing fuzzyfiles update\n"
430 $error = $self->queue_fuzzyfiles_update;
432 $dbh->rollback if $oldAutoCommit;
433 return "updating fuzzy search cache: $error";
437 warn " insert complete; committing transaction\n"
440 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
445 sub start_copy_skel {
448 #'mg_user_preference' => {},
449 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
450 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
451 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
452 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
453 my @tables = eval($conf->config_binary('cust_main-skeleton_tables'));
456 _copy_skel( 'cust_main', #tablename
457 $conf->config('cust_main-skeleton_custnum'), #sourceid
458 $self->custnum, #destid
459 @tables, #child tables
463 #recursive subroutine, not a method
465 my( $table, $sourceid, $destid, %child_tables ) = @_;
468 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
469 ( $table, $primary_key ) = ( $1, $2 );
471 my $dbdef_table = dbdef->table($table);
472 $primary_key = $dbdef_table->primary_key
473 or return "$table has no primary key".
474 " (or do you need to run dbdef-create?)";
477 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
478 join (', ', keys %child_tables). "\n"
481 foreach my $child_table_def ( keys %child_tables ) {
485 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
486 ( $child_table, $child_pkey ) = ( $1, $2 );
488 $child_table = $child_table_def;
490 $child_pkey = dbdef->table($child_table)->primary_key;
491 # or return "$table has no primary key".
492 # " (or do you need to run dbdef-create?)\n";
496 if ( keys %{ $child_tables{$child_table_def} } ) {
498 return "$child_table has no primary key".
499 " (run dbdef-create or try specifying it?)\n"
502 #false laziness w/Record::insert and only works on Pg
503 #refactor the proper last-inserted-id stuff out of Record::insert if this
504 # ever gets use for anything besides a quick kludge for one customer
505 my $default = dbdef->table($child_table)->column($child_pkey)->default;
506 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
507 or return "can't parse $child_table.$child_pkey default value ".
508 " for sequence name: $default";
513 my @sel_columns = grep { $_ ne $primary_key }
514 dbdef->table($child_table)->columns;
515 my $sel_columns = join(', ', @sel_columns );
517 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
518 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
519 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
521 my $sel_st = "SELECT $sel_columns FROM $child_table".
522 " WHERE $primary_key = $sourceid";
525 my $sel_sth = dbh->prepare( $sel_st )
526 or return dbh->errstr;
528 $sel_sth->execute or return $sel_sth->errstr;
530 while ( my $row = $sel_sth->fetchrow_hashref ) {
532 warn " selected row: ".
533 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
537 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
538 my $ins_sth =dbh->prepare($statement)
539 or return dbh->errstr;
540 my @param = ( $destid, map $row->{$_}, @ins_columns );
541 warn " $statement: [ ". join(', ', @param). " ]\n"
543 $ins_sth->execute( @param )
544 or return $ins_sth->errstr;
546 #next unless keys %{ $child_tables{$child_table} };
547 next unless $sequence;
549 #another section of that laziness
550 my $seq_sql = "SELECT currval('$sequence')";
551 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
552 $seq_sth->execute or return $seq_sth->errstr;
553 my $insertid = $seq_sth->fetchrow_arrayref->[0];
555 # don't drink soap! recurse! recurse! okay!
557 _copy_skel( $child_table_def,
558 $row->{$child_pkey}, #sourceid
560 %{ $child_tables{$child_table_def} },
562 return $error if $error;
572 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
573 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
575 Like the insert method on an existing record, this method orders a package
576 and included services atomicaly. Pass a Tie::RefHash data structure to this
577 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
578 be a better explanation of this, but until then, here's an example:
581 tie %hash, 'Tie::RefHash'; #this part is important
583 $cust_pkg => [ $svc_acct ],
586 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
588 Services can be new, in which case they are inserted, or existing unaudited
589 services, in which case they are linked to the newly-created package.
591 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
592 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
594 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
595 on the supplied jobnum (they will not run until the specific job completes).
596 This can be used to defer provisioning until some action completes (such
597 as running the customer's credit card successfully).
599 The I<noexport> option is deprecated. If I<noexport> is set true, no
600 provisioning jobs (exports) are scheduled. (You can schedule them later with
601 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
602 on the cust_main object is not recommended, as existing services will also be
605 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
606 provided, the scalars (provided by references) will be incremented by the
607 values of the prepaid card.`
613 my $cust_pkgs = shift;
614 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
616 $seconds_ref ||= $options{'seconds_ref'};
618 my %svc_options = ();
619 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
620 if exists $options{'depend_jobnum'};
621 warn "$me order_pkgs called with options ".
622 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
625 local $SIG{HUP} = 'IGNORE';
626 local $SIG{INT} = 'IGNORE';
627 local $SIG{QUIT} = 'IGNORE';
628 local $SIG{TERM} = 'IGNORE';
629 local $SIG{TSTP} = 'IGNORE';
630 local $SIG{PIPE} = 'IGNORE';
632 my $oldAutoCommit = $FS::UID::AutoCommit;
633 local $FS::UID::AutoCommit = 0;
636 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
638 foreach my $cust_pkg ( keys %$cust_pkgs ) {
639 $cust_pkg->custnum( $self->custnum );
640 my $error = $cust_pkg->insert;
642 $dbh->rollback if $oldAutoCommit;
643 return "inserting cust_pkg (transaction rolled back): $error";
645 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
646 if ( $svc_something->svcnum ) {
647 my $old_cust_svc = $svc_something->cust_svc;
648 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
649 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
650 $error = $new_cust_svc->replace($old_cust_svc);
652 $svc_something->pkgnum( $cust_pkg->pkgnum );
653 if ( $svc_something->isa('FS::svc_acct') ) {
654 foreach ( grep { $options{$_.'_ref'} && ${ $options{$_.'_ref'} } }
655 qw( seconds upbytes downbytes totalbytes )
657 $svc_something->$_( $svc_something->$_() + ${$options{$_.'_ref'}} );
658 ${ $options{$_.'_ref'} } = 0;
661 $error = $svc_something->insert(%svc_options);
664 $dbh->rollback if $oldAutoCommit;
665 #return "inserting svc_ (transaction rolled back): $error";
671 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
675 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
677 Recharges this (existing) customer with the specified prepaid card (see
678 L<FS::prepay_credit>), specified either by I<identifier> or as an
679 FS::prepay_credit object. If there is an error, returns the error, otherwise
682 Optionally, five scalar references can be passed as well. They will have their
683 values filled in with the amount, number of seconds, and number of upload,
684 download, and total bytes applied by this prepaid card.
688 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
689 #the only place that uses these args
690 sub recharge_prepay {
691 my( $self, $prepay_credit, $amountref, $secondsref,
692 $upbytesref, $downbytesref, $totalbytesref ) = @_;
694 local $SIG{HUP} = 'IGNORE';
695 local $SIG{INT} = 'IGNORE';
696 local $SIG{QUIT} = 'IGNORE';
697 local $SIG{TERM} = 'IGNORE';
698 local $SIG{TSTP} = 'IGNORE';
699 local $SIG{PIPE} = 'IGNORE';
701 my $oldAutoCommit = $FS::UID::AutoCommit;
702 local $FS::UID::AutoCommit = 0;
705 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
707 my $error = $self->get_prepay( $prepay_credit,
708 'amount_ref' => \$amount,
709 'seconds_ref' => \$seconds,
710 'upbytes_ref' => \$upbytes,
711 'downbytes_ref' => \$downbytes,
712 'totalbytes_ref' => \$totalbytes,
714 || $self->increment_seconds($seconds)
715 || $self->increment_upbytes($upbytes)
716 || $self->increment_downbytes($downbytes)
717 || $self->increment_totalbytes($totalbytes)
718 || $self->insert_cust_pay_prepay( $amount,
720 ? $prepay_credit->identifier
725 $dbh->rollback if $oldAutoCommit;
729 if ( defined($amountref) ) { $$amountref = $amount; }
730 if ( defined($secondsref) ) { $$secondsref = $seconds; }
731 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
732 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
733 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
735 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
740 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
742 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
743 specified either by I<identifier> or as an FS::prepay_credit object.
745 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
746 incremented by the values of the prepaid card.
748 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
749 check or set this customer's I<agentnum>.
751 If there is an error, returns the error, otherwise returns false.
757 my( $self, $prepay_credit, %opt ) = @_;
759 local $SIG{HUP} = 'IGNORE';
760 local $SIG{INT} = 'IGNORE';
761 local $SIG{QUIT} = 'IGNORE';
762 local $SIG{TERM} = 'IGNORE';
763 local $SIG{TSTP} = 'IGNORE';
764 local $SIG{PIPE} = 'IGNORE';
766 my $oldAutoCommit = $FS::UID::AutoCommit;
767 local $FS::UID::AutoCommit = 0;
770 unless ( ref($prepay_credit) ) {
772 my $identifier = $prepay_credit;
774 $prepay_credit = qsearchs(
776 { 'identifier' => $prepay_credit },
781 unless ( $prepay_credit ) {
782 $dbh->rollback if $oldAutoCommit;
783 return "Invalid prepaid card: ". $identifier;
788 if ( $prepay_credit->agentnum ) {
789 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
790 $dbh->rollback if $oldAutoCommit;
791 return "prepaid card not valid for agent ". $self->agentnum;
793 $self->agentnum($prepay_credit->agentnum);
796 my $error = $prepay_credit->delete;
798 $dbh->rollback if $oldAutoCommit;
799 return "removing prepay_credit (transaction rolled back): $error";
802 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
803 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
805 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
810 =item increment_upbytes SECONDS
812 Updates this customer's single or primary account (see L<FS::svc_acct>) by
813 the specified number of upbytes. If there is an error, returns the error,
814 otherwise returns false.
818 sub increment_upbytes {
819 _increment_column( shift, 'upbytes', @_);
822 =item increment_downbytes SECONDS
824 Updates this customer's single or primary account (see L<FS::svc_acct>) by
825 the specified number of downbytes. If there is an error, returns the error,
826 otherwise returns false.
830 sub increment_downbytes {
831 _increment_column( shift, 'downbytes', @_);
834 =item increment_totalbytes SECONDS
836 Updates this customer's single or primary account (see L<FS::svc_acct>) by
837 the specified number of totalbytes. If there is an error, returns the error,
838 otherwise returns false.
842 sub increment_totalbytes {
843 _increment_column( shift, 'totalbytes', @_);
846 =item increment_seconds SECONDS
848 Updates this customer's single or primary account (see L<FS::svc_acct>) by
849 the specified number of seconds. If there is an error, returns the error,
850 otherwise returns false.
854 sub increment_seconds {
855 _increment_column( shift, 'seconds', @_);
858 =item _increment_column AMOUNT
860 Updates this customer's single or primary account (see L<FS::svc_acct>) by
861 the specified number of seconds or bytes. If there is an error, returns
862 the error, otherwise returns false.
866 sub _increment_column {
867 my( $self, $column, $amount ) = @_;
868 warn "$me increment_column called: $column, $amount\n"
871 return '' unless $amount;
873 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
874 $self->ncancelled_pkgs;
877 return 'No packages with primary or single services found'.
878 ' to apply pre-paid time';
879 } elsif ( scalar(@cust_pkg) > 1 ) {
880 #maybe have a way to specify the package/account?
881 return 'Multiple packages found to apply pre-paid time';
884 my $cust_pkg = $cust_pkg[0];
885 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
889 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
892 return 'No account found to apply pre-paid time';
893 } elsif ( scalar(@cust_svc) > 1 ) {
894 return 'Multiple accounts found to apply pre-paid time';
897 my $svc_acct = $cust_svc[0]->svc_x;
898 warn " found service svcnum ". $svc_acct->pkgnum.
899 ' ('. $svc_acct->email. ")\n"
902 $column = "increment_$column";
903 $svc_acct->$column($amount);
907 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
909 Inserts a prepayment in the specified amount for this customer. An optional
910 second argument can specify the prepayment identifier for tracking purposes.
911 If there is an error, returns the error, otherwise returns false.
915 sub insert_cust_pay_prepay {
916 shift->insert_cust_pay('PREP', @_);
919 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
921 Inserts a cash payment in the specified amount for this customer. An optional
922 second argument can specify the payment identifier for tracking purposes.
923 If there is an error, returns the error, otherwise returns false.
927 sub insert_cust_pay_cash {
928 shift->insert_cust_pay('CASH', @_);
931 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
933 Inserts a Western Union payment in the specified amount for this customer. An
934 optional second argument can specify the prepayment identifier for tracking
935 purposes. If there is an error, returns the error, otherwise returns false.
939 sub insert_cust_pay_west {
940 shift->insert_cust_pay('WEST', @_);
943 sub insert_cust_pay {
944 my( $self, $payby, $amount ) = splice(@_, 0, 3);
945 my $payinfo = scalar(@_) ? shift : '';
947 my $cust_pay = new FS::cust_pay {
948 'custnum' => $self->custnum,
949 'paid' => sprintf('%.2f', $amount),
950 #'_date' => #date the prepaid card was purchased???
952 'payinfo' => $payinfo,
960 This method is deprecated. See the I<depend_jobnum> option to the insert and
961 order_pkgs methods for a better way to defer provisioning.
963 Re-schedules all exports by calling the B<reexport> method of all associated
964 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
965 otherwise returns false.
972 carp "WARNING: FS::cust_main::reexport is deprectated; ".
973 "use the depend_jobnum option to insert or order_pkgs to delay export";
975 local $SIG{HUP} = 'IGNORE';
976 local $SIG{INT} = 'IGNORE';
977 local $SIG{QUIT} = 'IGNORE';
978 local $SIG{TERM} = 'IGNORE';
979 local $SIG{TSTP} = 'IGNORE';
980 local $SIG{PIPE} = 'IGNORE';
982 my $oldAutoCommit = $FS::UID::AutoCommit;
983 local $FS::UID::AutoCommit = 0;
986 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
987 my $error = $cust_pkg->reexport;
989 $dbh->rollback if $oldAutoCommit;
994 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
999 =item delete NEW_CUSTNUM
1001 This deletes the customer. If there is an error, returns the error, otherwise
1004 This will completely remove all traces of the customer record. This is not
1005 what you want when a customer cancels service; for that, cancel all of the
1006 customer's packages (see L</cancel>).
1008 If the customer has any uncancelled packages, you need to pass a new (valid)
1009 customer number for those packages to be transferred to. Cancelled packages
1010 will be deleted. Did I mention that this is NOT what you want when a customer
1011 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1013 You can't delete a customer with invoices (see L<FS::cust_bill>),
1014 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1015 refunds (see L<FS::cust_refund>).
1022 local $SIG{HUP} = 'IGNORE';
1023 local $SIG{INT} = 'IGNORE';
1024 local $SIG{QUIT} = 'IGNORE';
1025 local $SIG{TERM} = 'IGNORE';
1026 local $SIG{TSTP} = 'IGNORE';
1027 local $SIG{PIPE} = 'IGNORE';
1029 my $oldAutoCommit = $FS::UID::AutoCommit;
1030 local $FS::UID::AutoCommit = 0;
1033 if ( $self->cust_bill ) {
1034 $dbh->rollback if $oldAutoCommit;
1035 return "Can't delete a customer with invoices";
1037 if ( $self->cust_credit ) {
1038 $dbh->rollback if $oldAutoCommit;
1039 return "Can't delete a customer with credits";
1041 if ( $self->cust_pay ) {
1042 $dbh->rollback if $oldAutoCommit;
1043 return "Can't delete a customer with payments";
1045 if ( $self->cust_refund ) {
1046 $dbh->rollback if $oldAutoCommit;
1047 return "Can't delete a customer with refunds";
1050 my @cust_pkg = $self->ncancelled_pkgs;
1052 my $new_custnum = shift;
1053 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1054 $dbh->rollback if $oldAutoCommit;
1055 return "Invalid new customer number: $new_custnum";
1057 foreach my $cust_pkg ( @cust_pkg ) {
1058 my %hash = $cust_pkg->hash;
1059 $hash{'custnum'} = $new_custnum;
1060 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1061 my $error = $new_cust_pkg->replace($cust_pkg,
1062 options => { $cust_pkg->options },
1065 $dbh->rollback if $oldAutoCommit;
1070 my @cancelled_cust_pkg = $self->all_pkgs;
1071 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1072 my $error = $cust_pkg->delete;
1074 $dbh->rollback if $oldAutoCommit;
1079 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1080 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1082 my $error = $cust_main_invoice->delete;
1084 $dbh->rollback if $oldAutoCommit;
1089 my $error = $self->SUPER::delete;
1091 $dbh->rollback if $oldAutoCommit;
1095 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1100 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1102 Replaces the OLD_RECORD with this one in the database. If there is an error,
1103 returns the error, otherwise returns false.
1105 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1106 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1107 expected and rollback the entire transaction; it is not necessary to call
1108 check_invoicing_list first. Here's an example:
1110 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1118 warn "$me replace called\n"
1121 local $SIG{HUP} = 'IGNORE';
1122 local $SIG{INT} = 'IGNORE';
1123 local $SIG{QUIT} = 'IGNORE';
1124 local $SIG{TERM} = 'IGNORE';
1125 local $SIG{TSTP} = 'IGNORE';
1126 local $SIG{PIPE} = 'IGNORE';
1128 # We absolutely have to have an old vs. new record to make this work.
1129 if (!defined($old)) {
1130 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1133 my $curuser = $FS::CurrentUser::CurrentUser;
1134 if ( $self->payby eq 'COMP'
1135 && $self->payby ne $old->payby
1136 && ! $curuser->access_right('Complimentary customer')
1139 return "You are not permitted to create complimentary accounts.";
1142 local($ignore_expired_card) = 1
1143 if $old->payby =~ /^(CARD|DCRD)$/
1144 && $self->payby =~ /^(CARD|DCRD)$/
1145 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1147 my $oldAutoCommit = $FS::UID::AutoCommit;
1148 local $FS::UID::AutoCommit = 0;
1151 my $error = $self->SUPER::replace($old);
1154 $dbh->rollback if $oldAutoCommit;
1158 if ( @param ) { # INVOICING_LIST_ARYREF
1159 my $invoicing_list = shift @param;
1160 $error = $self->check_invoicing_list( $invoicing_list );
1162 $dbh->rollback if $oldAutoCommit;
1165 $self->invoicing_list( $invoicing_list );
1168 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1169 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1170 # card/check/lec info has changed, want to retry realtime_ invoice events
1171 my $error = $self->retry_realtime;
1173 $dbh->rollback if $oldAutoCommit;
1178 unless ( $import || $skip_fuzzyfiles ) {
1179 $error = $self->queue_fuzzyfiles_update;
1181 $dbh->rollback if $oldAutoCommit;
1182 return "updating fuzzy search cache: $error";
1186 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1191 =item queue_fuzzyfiles_update
1193 Used by insert & replace to update the fuzzy search cache
1197 sub queue_fuzzyfiles_update {
1200 local $SIG{HUP} = 'IGNORE';
1201 local $SIG{INT} = 'IGNORE';
1202 local $SIG{QUIT} = 'IGNORE';
1203 local $SIG{TERM} = 'IGNORE';
1204 local $SIG{TSTP} = 'IGNORE';
1205 local $SIG{PIPE} = 'IGNORE';
1207 my $oldAutoCommit = $FS::UID::AutoCommit;
1208 local $FS::UID::AutoCommit = 0;
1211 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1212 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1214 $dbh->rollback if $oldAutoCommit;
1215 return "queueing job (transaction rolled back): $error";
1218 if ( $self->ship_last ) {
1219 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1220 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1222 $dbh->rollback if $oldAutoCommit;
1223 return "queueing job (transaction rolled back): $error";
1227 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1234 Checks all fields to make sure this is a valid customer record. If there is
1235 an error, returns the error, otherwise returns false. Called by the insert
1236 and replace methods.
1243 warn "$me check BEFORE: \n". $self->_dump
1247 $self->ut_numbern('custnum')
1248 || $self->ut_number('agentnum')
1249 || $self->ut_textn('agent_custid')
1250 || $self->ut_number('refnum')
1251 || $self->ut_textn('custbatch')
1252 || $self->ut_name('last')
1253 || $self->ut_name('first')
1254 || $self->ut_snumbern('birthdate')
1255 || $self->ut_snumbern('signupdate')
1256 || $self->ut_textn('company')
1257 || $self->ut_text('address1')
1258 || $self->ut_textn('address2')
1259 || $self->ut_text('city')
1260 || $self->ut_textn('county')
1261 || $self->ut_textn('state')
1262 || $self->ut_country('country')
1263 || $self->ut_anything('comments')
1264 || $self->ut_numbern('referral_custnum')
1265 || $self->ut_textn('stateid')
1266 || $self->ut_textn('stateid_state')
1268 #barf. need message catalogs. i18n. etc.
1269 $error .= "Please select an advertising source."
1270 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1271 return $error if $error;
1273 return "Unknown agent"
1274 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1276 return "Unknown refnum"
1277 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1279 return "Unknown referring custnum: ". $self->referral_custnum
1280 unless ! $self->referral_custnum
1281 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1283 if ( $self->ss eq '' ) {
1288 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1289 or return "Illegal social security number: ". $self->ss;
1290 $self->ss("$1-$2-$3");
1294 # bad idea to disable, causes billing to fail because of no tax rates later
1295 # unless ( $import ) {
1296 unless ( qsearch('cust_main_county', {
1297 'country' => $self->country,
1300 return "Unknown state/county/country: ".
1301 $self->state. "/". $self->county. "/". $self->country
1302 unless qsearch('cust_main_county',{
1303 'state' => $self->state,
1304 'county' => $self->county,
1305 'country' => $self->country,
1311 $self->ut_phonen('daytime', $self->country)
1312 || $self->ut_phonen('night', $self->country)
1313 || $self->ut_phonen('fax', $self->country)
1314 || $self->ut_zip('zip', $self->country)
1316 return $error if $error;
1318 if ( $conf->exists('cust_main-require_phone')
1319 && ! length($self->daytime) && ! length($self->night)
1322 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1324 : FS::Msgcat::_gettext('daytime');
1325 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1327 : FS::Msgcat::_gettext('night');
1329 return "$daytime_label or $night_label is required"
1333 if ( $self->has_ship_address
1334 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1335 $self->addr_fields )
1339 $self->ut_name('ship_last')
1340 || $self->ut_name('ship_first')
1341 || $self->ut_textn('ship_company')
1342 || $self->ut_text('ship_address1')
1343 || $self->ut_textn('ship_address2')
1344 || $self->ut_text('ship_city')
1345 || $self->ut_textn('ship_county')
1346 || $self->ut_textn('ship_state')
1347 || $self->ut_country('ship_country')
1349 return $error if $error;
1351 #false laziness with above
1352 unless ( qsearchs('cust_main_county', {
1353 'country' => $self->ship_country,
1356 return "Unknown ship_state/ship_county/ship_country: ".
1357 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1358 unless qsearch('cust_main_county',{
1359 'state' => $self->ship_state,
1360 'county' => $self->ship_county,
1361 'country' => $self->ship_country,
1367 $self->ut_phonen('ship_daytime', $self->ship_country)
1368 || $self->ut_phonen('ship_night', $self->ship_country)
1369 || $self->ut_phonen('ship_fax', $self->ship_country)
1370 || $self->ut_zip('ship_zip', $self->ship_country)
1372 return $error if $error;
1374 return "Unit # is required."
1375 if $self->ship_address2 =~ /^\s*$/
1376 && $conf->exists('cust_main-require_address2');
1378 } else { # ship_ info eq billing info, so don't store dup info in database
1380 $self->setfield("ship_$_", '')
1381 foreach $self->addr_fields;
1383 return "Unit # is required."
1384 if $self->address2 =~ /^\s*$/
1385 && $conf->exists('cust_main-require_address2');
1389 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1390 # or return "Illegal payby: ". $self->payby;
1392 FS::payby->can_payby($self->table, $self->payby)
1393 or return "Illegal payby: ". $self->payby;
1395 $error = $self->ut_numbern('paystart_month')
1396 || $self->ut_numbern('paystart_year')
1397 || $self->ut_numbern('payissue')
1398 || $self->ut_textn('paytype')
1400 return $error if $error;
1402 if ( $self->payip eq '' ) {
1405 $error = $self->ut_ip('payip');
1406 return $error if $error;
1409 # If it is encrypted and the private key is not availaible then we can't
1410 # check the credit card.
1412 my $check_payinfo = 1;
1414 if ($self->is_encrypted($self->payinfo)) {
1418 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1420 my $payinfo = $self->payinfo;
1421 $payinfo =~ s/\D//g;
1422 $payinfo =~ /^(\d{13,16})$/
1423 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1425 $self->payinfo($payinfo);
1427 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1429 return gettext('unknown_card_type')
1430 if cardtype($self->payinfo) eq "Unknown";
1432 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1434 return 'Banned credit card: banned on '.
1435 time2str('%a %h %o at %r', $ban->_date).
1436 ' by '. $ban->otaker.
1437 ' (ban# '. $ban->bannum. ')';
1440 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1441 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1442 $self->paycvv =~ /^(\d{4})$/
1443 or return "CVV2 (CID) for American Express cards is four digits.";
1446 $self->paycvv =~ /^(\d{3})$/
1447 or return "CVV2 (CVC2/CID) is three digits.";
1454 my $cardtype = cardtype($payinfo);
1455 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1457 return "Start date or issue number is required for $cardtype cards"
1458 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1460 return "Start month must be between 1 and 12"
1461 if $self->paystart_month
1462 and $self->paystart_month < 1 || $self->paystart_month > 12;
1464 return "Start year must be 1990 or later"
1465 if $self->paystart_year
1466 and $self->paystart_year < 1990;
1468 return "Issue number must be beween 1 and 99"
1470 and $self->payissue < 1 || $self->payissue > 99;
1473 $self->paystart_month('');
1474 $self->paystart_year('');
1475 $self->payissue('');
1478 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1480 my $payinfo = $self->payinfo;
1481 $payinfo =~ s/[^\d\@]//g;
1482 if ( $conf->exists('echeck-nonus') ) {
1483 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1484 $payinfo = "$1\@$2";
1486 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1487 $payinfo = "$1\@$2";
1489 $self->payinfo($payinfo);
1492 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1494 return 'Banned ACH account: banned on '.
1495 time2str('%a %h %o at %r', $ban->_date).
1496 ' by '. $ban->otaker.
1497 ' (ban# '. $ban->bannum. ')';
1500 } elsif ( $self->payby eq 'LECB' ) {
1502 my $payinfo = $self->payinfo;
1503 $payinfo =~ s/\D//g;
1504 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1506 $self->payinfo($payinfo);
1509 } elsif ( $self->payby eq 'BILL' ) {
1511 $error = $self->ut_textn('payinfo');
1512 return "Illegal P.O. number: ". $self->payinfo if $error;
1515 } elsif ( $self->payby eq 'COMP' ) {
1517 my $curuser = $FS::CurrentUser::CurrentUser;
1518 if ( ! $self->custnum
1519 && ! $curuser->access_right('Complimentary customer')
1522 return "You are not permitted to create complimentary accounts."
1525 $error = $self->ut_textn('payinfo');
1526 return "Illegal comp account issuer: ". $self->payinfo if $error;
1529 } elsif ( $self->payby eq 'PREPAY' ) {
1531 my $payinfo = $self->payinfo;
1532 $payinfo =~ s/\W//g; #anything else would just confuse things
1533 $self->payinfo($payinfo);
1534 $error = $self->ut_alpha('payinfo');
1535 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1536 return "Unknown prepayment identifier"
1537 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1542 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1543 return "Expiration date required"
1544 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1548 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1549 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1550 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1551 ( $m, $y ) = ( $3, "20$2" );
1553 return "Illegal expiration date: ". $self->paydate;
1555 $self->paydate("$y-$m-01");
1556 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1557 return gettext('expired_card')
1559 && !$ignore_expired_card
1560 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1563 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1564 ( ! $conf->exists('require_cardname')
1565 || $self->payby !~ /^(CARD|DCRD)$/ )
1567 $self->payname( $self->first. " ". $self->getfield('last') );
1569 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1570 or return gettext('illegal_name'). " payname: ". $self->payname;
1574 foreach my $flag (qw( tax spool_cdr archived )) {
1575 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1579 $self->otaker(getotaker) unless $self->otaker;
1581 warn "$me check AFTER: \n". $self->_dump
1584 $self->SUPER::check;
1589 Returns a list of fields which have ship_ duplicates.
1594 qw( last first company
1595 address1 address2 city county state zip country
1600 =item has_ship_address
1602 Returns true if this customer record has a separate shipping address.
1606 sub has_ship_address {
1608 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1613 Returns all packages (see L<FS::cust_pkg>) for this customer.
1620 return $self->num_pkgs unless wantarray;
1623 if ( $self->{'_pkgnum'} ) {
1624 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1626 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1629 sort sort_packages @cust_pkg;
1632 =item ncancelled_pkgs
1634 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1638 sub ncancelled_pkgs {
1641 return $self->num_ncancelled_pkgs unless wantarray;
1644 if ( $self->{'_pkgnum'} ) {
1646 @cust_pkg = grep { ! $_->getfield('cancel') }
1647 values %{ $self->{'_pkgnum'}->cache };
1652 qsearch( 'cust_pkg', {
1653 'custnum' => $self->custnum,
1657 qsearch( 'cust_pkg', {
1658 'custnum' => $self->custnum,
1663 sort sort_packages @cust_pkg;
1667 # This should be generalized to use config options to determine order.
1670 if ( $a->get('cancel') xor $b->get('cancel') ) {
1671 return -1 if $b->get('cancel');
1672 return 1 if $a->get('cancel');
1673 #shouldn't get here...
1676 my @a_cust_svc = $a->cust_svc;
1677 my @b_cust_svc = $b->cust_svc;
1678 return 0 if !scalar(@a_cust_svc) && !scalar(@b_cust_svc);
1679 return -1 if scalar(@a_cust_svc) && !scalar(@b_cust_svc);
1680 return 1 if !scalar(@a_cust_svc) && scalar(@b_cust_svc);
1681 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
1686 =item suspended_pkgs
1688 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1692 sub suspended_pkgs {
1694 grep { $_->susp } $self->ncancelled_pkgs;
1697 =item unflagged_suspended_pkgs
1699 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1700 customer (thouse packages without the `manual_flag' set).
1704 sub unflagged_suspended_pkgs {
1706 return $self->suspended_pkgs
1707 unless dbdef->table('cust_pkg')->column('manual_flag');
1708 grep { ! $_->manual_flag } $self->suspended_pkgs;
1711 =item unsuspended_pkgs
1713 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1718 sub unsuspended_pkgs {
1720 grep { ! $_->susp } $self->ncancelled_pkgs;
1723 =item num_cancelled_pkgs
1725 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1730 sub num_cancelled_pkgs {
1731 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1734 sub num_ncancelled_pkgs {
1735 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1739 my( $self ) = shift;
1740 my $sql = scalar(@_) ? shift : '';
1741 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1742 my $sth = dbh->prepare(
1743 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1744 ) or die dbh->errstr;
1745 $sth->execute($self->custnum) or die $sth->errstr;
1746 $sth->fetchrow_arrayref->[0];
1751 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1752 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1753 on success or a list of errors.
1759 grep { $_->unsuspend } $self->suspended_pkgs;
1764 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1766 Returns a list: an empty list on success or a list of errors.
1772 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1775 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1777 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1778 PKGPARTs (see L<FS::part_pkg>).
1780 Returns a list: an empty list on success or a list of errors.
1784 sub suspend_if_pkgpart {
1786 my (@pkgparts, %opt);
1787 if (ref($_[0]) eq 'HASH'){
1788 @pkgparts = @{$_[0]{pkgparts}};
1793 grep { $_->suspend(%opt) }
1794 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1795 $self->unsuspended_pkgs;
1798 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1800 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1801 listed PKGPARTs (see L<FS::part_pkg>).
1803 Returns a list: an empty list on success or a list of errors.
1807 sub suspend_unless_pkgpart {
1809 my (@pkgparts, %opt);
1810 if (ref($_[0]) eq 'HASH'){
1811 @pkgparts = @{$_[0]{pkgparts}};
1816 grep { $_->suspend(%opt) }
1817 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1818 $self->unsuspended_pkgs;
1821 =item cancel [ OPTION => VALUE ... ]
1823 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1825 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1827 I<quiet> can be set true to supress email cancellation notices.
1829 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1831 I<ban> can be set true to ban this customer's credit card or ACH information,
1834 Always returns a list: an empty list on success or a list of errors.
1842 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1844 #should try decryption (we might have the private key)
1845 # and if not maybe queue a job for the server that does?
1846 return ( "Can't (yet) ban encrypted credit cards" )
1847 if $self->is_encrypted($self->payinfo);
1849 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1850 my $error = $ban->insert;
1851 return ( $error ) if $error;
1855 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1858 sub _banned_pay_hashref {
1869 'payby' => $payby2ban{$self->payby},
1870 'payinfo' => md5_base64($self->payinfo),
1871 #don't ever *search* on reason! #'reason' =>
1877 Returns all notes (see L<FS::cust_main_note>) for this customer.
1884 qsearch( 'cust_main_note',
1885 { 'custnum' => $self->custnum },
1887 'ORDER BY _DATE DESC'
1893 Returns the agent (see L<FS::agent>) for this customer.
1899 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1902 =item bill_and_collect
1904 Cancels and suspends any packages due, generates bills, applies payments and
1907 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1909 Options are passed as name-value pairs. Currently available options are:
1915 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
1919 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1923 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
1927 If set true, re-charges setup fees.
1931 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1937 sub bill_and_collect {
1938 my( $self, %options ) = @_;
1940 #$options{actual_time} not $options{time} because freeside-daily -d is for
1941 #pre-printing invoices
1942 $self->cancel_expired_pkgs( $options{actual_time} );
1943 $self->suspend_adjourned_pkgs( $options{actual_time} );
1945 my $error = $self->bill( %options );
1946 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1948 $self->apply_payments_and_credits;
1950 unless ( $conf->exists('cancelled_cust-noevents')
1951 && ! $self->num_ncancelled_pkgs
1954 $error = $self->collect( %options );
1955 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1961 sub cancel_expired_pkgs {
1962 my ( $self, $time ) = @_;
1964 my @cancel_pkgs = grep { $_->expire && $_->expire <= $time }
1965 $self->ncancelled_pkgs;
1967 foreach my $cust_pkg ( @cancel_pkgs ) {
1968 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
1969 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
1970 'reason_otaker' => $cpr->otaker
1974 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1975 " for custnum ". $self->custnum. ": $error"
1981 sub suspend_adjourned_pkgs {
1982 my ( $self, $time ) = @_;
1986 && ( ( $_->part_pkg->is_prepaid
1991 && $_->adjourn <= $time
1995 $self->ncancelled_pkgs;
1997 foreach my $cust_pkg ( @susp_pkgs ) {
1998 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
1999 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2000 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2001 'reason_otaker' => $cpr->otaker
2006 warn "Error suspending package ". $cust_pkg->pkgnum.
2007 " for custnum ". $self->custnum. ": $error"
2015 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2016 conjunction with the collect method.
2018 If there is an error, returns the error, otherwise returns false.
2020 Options are passed as name-value pairs. Currently available options are:
2024 =item resetup - if set true, re-charges setup fees.
2026 =item time - bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
2030 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2032 =item invoice_time - used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
2039 my( $self, %options ) = @_;
2040 return '' if $self->payby eq 'COMP';
2041 warn "$me bill customer ". $self->custnum. "\n"
2044 my $time = $options{'time'} || time;
2049 local $SIG{HUP} = 'IGNORE';
2050 local $SIG{INT} = 'IGNORE';
2051 local $SIG{QUIT} = 'IGNORE';
2052 local $SIG{TERM} = 'IGNORE';
2053 local $SIG{TSTP} = 'IGNORE';
2054 local $SIG{PIPE} = 'IGNORE';
2056 my $oldAutoCommit = $FS::UID::AutoCommit;
2057 local $FS::UID::AutoCommit = 0;
2060 $self->select_for_update; #mutex
2062 #create a new invoice
2063 #(we'll remove it later if it doesn't actually need to be generated [contains
2064 # no line items] and we're inside a transaciton so nothing else will see it)
2065 my $cust_bill = new FS::cust_bill ( {
2066 'custnum' => $self->custnum,
2067 '_date' => ( $options{'invoice_time'} || $time ),
2068 #'charged' => $charged,
2071 $error = $cust_bill->insert;
2073 $dbh->rollback if $oldAutoCommit;
2074 return "can't create invoice for customer #". $self->custnum. ": $error";
2076 my $invnum = $cust_bill->invnum;
2079 # find the packages which are due for billing, find out how much they are
2080 # & generate invoice database.
2083 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2085 my @precommit_hooks = ();
2087 my @cust_pkgs = qsearch('cust_pkg', { 'custnum' => $self->custnum } );
2088 foreach my $cust_pkg (@cust_pkgs) {
2090 #NO!! next if $cust_pkg->cancel;
2091 next if $cust_pkg->getfield('cancel');
2093 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2095 #? to avoid use of uninitialized value errors... ?
2096 $cust_pkg->setfield('bill', '')
2097 unless defined($cust_pkg->bill);
2099 my $part_pkg = $cust_pkg->part_pkg;
2101 my %hash = $cust_pkg->hash;
2102 my $old_cust_pkg = new FS::cust_pkg \%hash;
2112 if ( ! $cust_pkg->setup &&
2114 ( $conf->exists('disable_setup_suspended_pkgs') &&
2115 ! $cust_pkg->getfield('susp')
2116 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2118 || $options{'resetup'}
2121 warn " bill setup\n" if $DEBUG > 1;
2123 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2125 $dbh->rollback if $oldAutoCommit;
2126 return "$@ running calc_setup for $cust_pkg\n";
2129 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2131 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2135 # bill recurring fee
2138 #XXX unit stuff here too
2142 if ( $part_pkg->getfield('freq') ne '0' &&
2143 ! $cust_pkg->getfield('susp') &&
2144 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2147 # XXX should this be a package event? probably. events are called
2148 # at collection time at the moment, though...
2149 if ( $part_pkg->can('reset_usage') ) {
2150 warn " resetting usage counters" if $DEBUG > 1;
2151 $part_pkg->reset_usage($cust_pkg);
2154 warn " bill recur\n" if $DEBUG > 1;
2156 # XXX shared with $recur_prog
2157 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2159 #over two params! lets at least switch to a hashref for the rest...
2160 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2162 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2164 $dbh->rollback if $oldAutoCommit;
2165 return "$@ running calc_recur for $cust_pkg\n";
2168 #change this bit to use Date::Manip? CAREFUL with timezones (see
2169 # mailing list archive)
2170 my ($sec,$min,$hour,$mday,$mon,$year) =
2171 (localtime($sdate) )[0,1,2,3,4,5];
2173 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2174 # only for figuring next bill date, nothing else, so, reset $sdate again
2176 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2177 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2178 $cust_pkg->last_bill($sdate);
2180 if ( $part_pkg->freq =~ /^\d+$/ ) {
2181 $mon += $part_pkg->freq;
2182 until ( $mon < 12 ) { $mon -= 12; $year++; }
2183 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2185 $mday += $weeks * 7;
2186 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2189 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2193 $dbh->rollback if $oldAutoCommit;
2194 return "unparsable frequency: ". $part_pkg->freq;
2196 $cust_pkg->setfield('bill',
2197 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2200 warn "\$setup is undefined" unless defined($setup);
2201 warn "\$recur is undefined" unless defined($recur);
2202 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2205 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2208 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
2210 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2213 $error=$cust_pkg->replace($old_cust_pkg,
2214 options => { $cust_pkg->options },
2216 if ( $error ) { #just in case
2217 $dbh->rollback if $oldAutoCommit;
2218 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2221 $setup = sprintf( "%.2f", $setup );
2222 $recur = sprintf( "%.2f", $recur );
2223 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2224 $dbh->rollback if $oldAutoCommit;
2225 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2227 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2228 $dbh->rollback if $oldAutoCommit;
2229 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2232 if ( $setup != 0 || $recur != 0 ) {
2234 # Only create a postal charge if:
2235 # - this package has a recurring fee OR postal charges are enabled for non-recurring fees
2236 # - AND there isn't already a postal charge for this invoice.
2237 if ( (!$postal_charge) &&
2238 ( !$conf->exists('postal_invoice-recurring_only') ||
2241 $postal_charge = 1; # try only once
2242 my $postal_pkg = $self->charge_postal_fee();
2243 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2244 $dbh->rollback if $oldAutoCommit;
2245 return "can't charge postal invoice fee for customer ".
2246 $self->custnum. ": $postal_pkg";
2248 if ( $postal_pkg ) {
2249 push @cust_pkgs, $postal_pkg;
2253 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2256 push @details, map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2258 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2259 'invnum' => $invnum,
2260 'pkgnum' => $cust_pkg->pkgnum,
2262 'unitsetup' => $unitsetup,
2264 'unitrecur' => $unitrecur,
2265 'quantity' => $cust_pkg->quantity,
2266 'details' => \@details,
2269 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2270 $cust_bill_pkg->sdate( $hash{last_bill} );
2271 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2272 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2273 $cust_bill_pkg->sdate( $sdate );
2274 $cust_bill_pkg->edate( $cust_pkg->bill );
2277 $error = $cust_bill_pkg->insert;
2279 $dbh->rollback if $oldAutoCommit;
2280 return "can't create invoice line item for invoice #$invnum: $error";
2282 $total_setup += $setup;
2283 $total_recur += $recur;
2289 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2292 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2295 my %taxhash = map { $_ => $self->get("$prefix$_") }
2296 qw( state county country );
2298 $taxhash{'taxclass'} = $part_pkg->taxclass;
2300 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2303 $taxhash{'taxclass'} = '';
2304 @taxes = qsearch( 'cust_main_county', \%taxhash );
2307 #one more try at a whole-country tax rate
2309 $taxhash{$_} = '' foreach qw( state county );
2310 @taxes = qsearch( 'cust_main_county', \%taxhash );
2313 # maybe eliminate this entirely, along with all the 0% records
2315 $dbh->rollback if $oldAutoCommit;
2317 "fatal: can't find tax rate for state/county/country/taxclass ".
2318 join('/', ( map $self->get("$prefix$_"),
2319 qw(state county country)
2321 $part_pkg->taxclass ). "\n";
2324 foreach my $tax ( @taxes ) {
2326 my $taxable_charged = 0;
2327 $taxable_charged += $setup
2328 unless $part_pkg->setuptax =~ /^Y$/i
2329 || $tax->setuptax =~ /^Y$/i;
2330 $taxable_charged += $recur
2331 unless $part_pkg->recurtax =~ /^Y$/i
2332 || $tax->recurtax =~ /^Y$/i;
2333 next unless $taxable_charged;
2335 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2336 #my ($mon,$year) = (localtime($sdate) )[4,5];
2337 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2339 my $freq = $part_pkg->freq || 1;
2340 if ( $freq !~ /(\d+)$/ ) {
2341 $dbh->rollback if $oldAutoCommit;
2342 return "daily/weekly package definitions not (yet?)".
2343 " compatible with monthly tax exemptions";
2345 my $taxable_per_month =
2346 sprintf("%.2f", $taxable_charged / $freq );
2348 #call the whole thing off if this customer has any old
2349 #exemption records...
2350 my @cust_tax_exempt =
2351 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2352 if ( @cust_tax_exempt ) {
2353 $dbh->rollback if $oldAutoCommit;
2355 'this customer still has old-style tax exemption records; '.
2356 'run bin/fs-migrate-cust_tax_exempt?';
2359 foreach my $which_month ( 1 .. $freq ) {
2361 #maintain the new exemption table now
2364 FROM cust_tax_exempt_pkg
2365 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2366 LEFT JOIN cust_bill USING ( invnum )
2372 my $sth = dbh->prepare($sql) or do {
2373 $dbh->rollback if $oldAutoCommit;
2374 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2382 $dbh->rollback if $oldAutoCommit;
2383 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2385 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2387 my $remaining_exemption =
2388 $tax->exempt_amount - $existing_exemption;
2389 if ( $remaining_exemption > 0 ) {
2390 my $addl = $remaining_exemption > $taxable_per_month
2391 ? $taxable_per_month
2392 : $remaining_exemption;
2393 $taxable_charged -= $addl;
2395 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2396 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2397 'taxnum' => $tax->taxnum,
2398 'year' => 1900+$year,
2400 'amount' => sprintf("%.2f", $addl ),
2402 $error = $cust_tax_exempt_pkg->insert;
2404 $dbh->rollback if $oldAutoCommit;
2405 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2407 } # if $remaining_exemption > 0
2411 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2412 until ( $mon < 13 ) { $mon -= 12; $year++; }
2414 } #foreach $which_month
2416 } #if $tax->exempt_amount
2418 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2420 #$tax += $taxable_charged * $cust_main_county->tax / 100
2421 $tax{ $tax->taxname || 'Tax' } +=
2422 $taxable_charged * $tax->tax / 100
2424 } #foreach my $tax ( @taxes )
2426 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2428 } #if $setup != 0 || $recur != 0
2430 } #if $cust_pkg->modified
2432 } #foreach my $cust_pkg
2434 unless ( $cust_bill->cust_bill_pkg ) {
2435 $cust_bill->delete; #don't create an invoice w/o line items
2436 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2440 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2442 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2443 my $tax = sprintf("%.2f", $tax{$taxname} );
2444 $charged = sprintf( "%.2f", $charged+$tax );
2446 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2447 'invnum' => $invnum,
2453 'itemdesc' => $taxname,
2455 $error = $cust_bill_pkg->insert;
2457 $dbh->rollback if $oldAutoCommit;
2458 return "can't create invoice line item for invoice #$invnum: $error";
2460 $total_setup += $tax;
2464 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2465 $error = $cust_bill->replace;
2467 $dbh->rollback if $oldAutoCommit;
2468 return "can't update charged for invoice #$invnum: $error";
2471 foreach my $hook ( @precommit_hooks ) {
2473 &{$hook}; #($self) ?
2476 $dbh->rollback if $oldAutoCommit;
2477 return "$@ running precommit hook $hook\n";
2481 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2485 =item collect OPTIONS
2487 (Attempt to) collect money for this customer's outstanding invoices (see
2488 L<FS::cust_bill>). Usually used after the bill method.
2490 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2491 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2492 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2494 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2495 and the invoice events web interface.
2497 If there is an error, returns the error, otherwise returns false.
2499 Options are passed as name-value pairs.
2501 Currently available options are:
2503 invoice_time - Use this time when deciding when to print invoices and
2504 late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse>
2505 for conversion functions.
2507 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2510 quiet - set true to surpress email card/ACH decline notices.
2512 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2515 payby - allows for one time override of normal customer billing method
2520 my( $self, %options ) = @_;
2521 my $invoice_time = $options{'invoice_time'} || time;
2524 local $SIG{HUP} = 'IGNORE';
2525 local $SIG{INT} = 'IGNORE';
2526 local $SIG{QUIT} = 'IGNORE';
2527 local $SIG{TERM} = 'IGNORE';
2528 local $SIG{TSTP} = 'IGNORE';
2529 local $SIG{PIPE} = 'IGNORE';
2531 my $oldAutoCommit = $FS::UID::AutoCommit;
2532 local $FS::UID::AutoCommit = 0;
2535 $self->select_for_update; #mutex
2537 my $balance = $self->balance;
2538 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2540 unless ( $balance > 0 ) { #redundant?????
2541 $dbh->rollback if $oldAutoCommit; #hmm
2545 if ( exists($options{'retry_card'}) ) {
2546 carp 'retry_card option passed to collect is deprecated; use retry';
2547 $options{'retry'} ||= $options{'retry_card'};
2549 if ( exists($options{'retry'}) && $options{'retry'} ) {
2550 my $error = $self->retry_realtime;
2552 $dbh->rollback if $oldAutoCommit;
2558 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2559 $extra_sql = " AND freq = '1m' ";
2561 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2564 foreach my $cust_bill ( $self->open_cust_bill ) {
2566 # don't try to charge for the same invoice if it's already in a batch
2567 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2569 last if $self->balance <= 0;
2571 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2574 foreach my $part_bill_event ( due_events ( $cust_bill,
2575 exists($options{'payby'})
2581 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2582 || $self->balance <= 0; # or if balance<=0
2585 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2586 warn " do_event " . $cust_bill . " ". (%options) . "\n"
2589 if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2590 # gah, even with transactions.
2591 $dbh->commit if $oldAutoCommit; #well.
2600 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2605 =item retry_realtime
2607 Schedules realtime / batch credit card / electronic check / LEC billing
2608 events for for retry. Useful if card information has changed or manual
2609 retry is desired. The 'collect' method must be called to actually retry
2612 Implementation details: For each of this customer's open invoices, changes
2613 the status of the first "done" (with statustext error) realtime processing
2618 sub retry_realtime {
2621 local $SIG{HUP} = 'IGNORE';
2622 local $SIG{INT} = 'IGNORE';
2623 local $SIG{QUIT} = 'IGNORE';
2624 local $SIG{TERM} = 'IGNORE';
2625 local $SIG{TSTP} = 'IGNORE';
2626 local $SIG{PIPE} = 'IGNORE';
2628 my $oldAutoCommit = $FS::UID::AutoCommit;
2629 local $FS::UID::AutoCommit = 0;
2632 foreach my $cust_bill (
2633 grep { $_->cust_bill_event }
2634 $self->open_cust_bill
2636 my @cust_bill_event =
2637 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2639 #$_->part_bill_event->plan eq 'realtime-card'
2640 $_->part_bill_event->eventcode =~
2641 /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2642 && $_->status eq 'done'
2645 $cust_bill->cust_bill_event;
2646 next unless @cust_bill_event;
2647 my $error = $cust_bill_event[0]->retry;
2649 $dbh->rollback if $oldAutoCommit;
2650 return "error scheduling invoice event for retry: $error";
2655 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2660 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2662 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2663 via a Business::OnlinePayment realtime gateway. See
2664 L<http://420.am/business-onlinepayment> for supported gateways.
2666 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2668 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2670 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2671 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2672 if set, will override the value from the customer record.
2674 I<description> is a free-text field passed to the gateway. It defaults to
2675 the value defined by the business-onlinepayment-description configuration
2676 option, or "Internet services" if that is unset.
2678 If an I<invnum> is specified, this payment (if successful) is applied to the
2679 specified invoice. If you don't specify an I<invnum> you might want to
2680 call the B<apply_payments> method or set the I<apply> option.
2682 I<apply> can be set to true to apply a resulting payment.
2684 I<quiet> can be set true to surpress email decline notices.
2686 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2687 resulting paynum, if any.
2689 I<payunique> is a unique identifier for this payment.
2691 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2700 my($method, $amount);
2702 if (ref($_[0]) eq 'HASH') {
2703 %options = %{$_[0]};
2704 $method = $options{method};
2705 $amount = $options{amount};
2707 ( $method, $amount ) = ( shift, shift );
2711 warn "$me realtime_bop: $method $amount\n";
2712 warn " $_ => $options{$_}\n" foreach keys %options;
2715 unless ( $options{'description'} ) {
2716 if ( $conf->exists('business-onlinepayment-description') ) {
2717 my $dtempl = $conf->config('business-onlinepayment-description');
2719 my $agent = $self->agent->agent;
2721 $options{'description'} = eval qq("$dtempl");
2723 $options{'description'} = 'Internet services';
2727 eval "use Business::OnlinePayment";
2730 my $payinfo = exists($options{'payinfo'})
2731 ? $options{'payinfo'}
2734 my %method2payby = (
2741 # set taxclass and trans_is_recur based on invnum if there is one
2745 my $trans_is_recur = 0;
2746 if ( $options{'invnum'} ) {
2748 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2749 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2752 map { $_->part_pkg }
2754 map { $_->cust_pkg }
2755 $cust_bill->cust_bill_pkg;
2757 my @taxclasses = map $_->taxclass, @part_pkg;
2758 $taxclass = $taxclasses[0]
2759 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
2760 #different taxclasses
2762 if grep { $_->freq ne '0' } @part_pkg;
2770 #look for an agent gateway override first
2772 if ( $method eq 'CC' ) {
2773 $cardtype = cardtype($payinfo);
2774 } elsif ( $method eq 'ECHECK' ) {
2777 $cardtype = $method;
2781 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2782 cardtype => $cardtype,
2783 taxclass => $taxclass, } )
2784 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2786 taxclass => $taxclass, } )
2787 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2788 cardtype => $cardtype,
2790 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2792 taxclass => '', } );
2794 my $payment_gateway = '';
2795 my( $processor, $login, $password, $action, @bop_options );
2796 if ( $override ) { #use a payment gateway override
2798 $payment_gateway = $override->payment_gateway;
2800 $processor = $payment_gateway->gateway_module;
2801 $login = $payment_gateway->gateway_username;
2802 $password = $payment_gateway->gateway_password;
2803 $action = $payment_gateway->gateway_action;
2804 @bop_options = $payment_gateway->options;
2806 } else { #use the standard settings from the config
2808 ( $processor, $login, $password, $action, @bop_options ) =
2809 $self->default_payment_gateway($method);
2817 my $address = exists($options{'address1'})
2818 ? $options{'address1'}
2820 my $address2 = exists($options{'address2'})
2821 ? $options{'address2'}
2823 $address .= ", ". $address2 if length($address2);
2825 my $o_payname = exists($options{'payname'})
2826 ? $options{'payname'}
2828 my($payname, $payfirst, $paylast);
2829 if ( $o_payname && $method ne 'ECHECK' ) {
2830 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2831 or return "Illegal payname $payname";
2832 ($payfirst, $paylast) = ($1, $2);
2834 $payfirst = $self->getfield('first');
2835 $paylast = $self->getfield('last');
2836 $payname = "$payfirst $paylast";
2839 my @invoicing_list = $self->invoicing_list_emailonly;
2840 if ( $conf->exists('emailinvoiceautoalways')
2841 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2842 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2843 push @invoicing_list, $self->all_emails;
2846 my $email = ($conf->exists('business-onlinepayment-email-override'))
2847 ? $conf->config('business-onlinepayment-email-override')
2848 : $invoicing_list[0];
2852 my $payip = exists($options{'payip'})
2855 $content{customer_ip} = $payip
2858 $content{invoice_number} = $options{'invnum'}
2859 if exists($options{'invnum'}) && length($options{'invnum'});
2861 $content{email_customer} =
2862 ( $conf->exists('business-onlinepayment-email_customer')
2863 || $conf->exists('business-onlinepayment-email-override') );
2866 if ( $method eq 'CC' ) {
2868 $content{card_number} = $payinfo;
2869 $paydate = exists($options{'paydate'})
2870 ? $options{'paydate'}
2872 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2873 $content{expiration} = "$2/$1";
2875 my $paycvv = exists($options{'paycvv'})
2876 ? $options{'paycvv'}
2878 $content{cvv2} = $paycvv
2881 my $paystart_month = exists($options{'paystart_month'})
2882 ? $options{'paystart_month'}
2883 : $self->paystart_month;
2885 my $paystart_year = exists($options{'paystart_year'})
2886 ? $options{'paystart_year'}
2887 : $self->paystart_year;
2889 $content{card_start} = "$paystart_month/$paystart_year"
2890 if $paystart_month && $paystart_year;
2892 my $payissue = exists($options{'payissue'})
2893 ? $options{'payissue'}
2895 $content{issue_number} = $payissue if $payissue;
2897 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
2898 'trans_is_recur' => $trans_is_recur,
2902 $content{recurring_billing} = 'YES';
2903 $content{acct_code} = 'rebill'
2904 if $conf->exists('credit_card-recurring_billing_acct_code');
2907 } elsif ( $method eq 'ECHECK' ) {
2908 ( $content{account_number}, $content{routing_code} ) =
2909 split('@', $payinfo);
2910 $content{bank_name} = $o_payname;
2911 $content{bank_state} = exists($options{'paystate'})
2912 ? $options{'paystate'}
2913 : $self->getfield('paystate');
2914 $content{account_type} = exists($options{'paytype'})
2915 ? uc($options{'paytype'}) || 'CHECKING'
2916 : uc($self->getfield('paytype')) || 'CHECKING';
2917 $content{account_name} = $payname;
2918 $content{customer_org} = $self->company ? 'B' : 'I';
2919 $content{state_id} = exists($options{'stateid'})
2920 ? $options{'stateid'}
2921 : $self->getfield('stateid');
2922 $content{state_id_state} = exists($options{'stateid_state'})
2923 ? $options{'stateid_state'}
2924 : $self->getfield('stateid_state');
2925 $content{customer_ssn} = exists($options{'ss'})
2928 } elsif ( $method eq 'LEC' ) {
2929 $content{phone} = $payinfo;
2933 # run transaction(s)
2936 my $balance = exists( $options{'balance'} )
2937 ? $options{'balance'}
2940 $self->select_for_update; #mutex ... just until we get our pending record in
2942 #the checks here are intended to catch concurrent payments
2943 #double-form-submission prevention is taken care of in cust_pay_pending::check
2946 return "The customer's balance has changed; $method transaction aborted."
2947 if $self->balance < $balance;
2948 #&& $self->balance < $amount; #might as well anyway?
2950 #also check and make sure there aren't *other* pending payments for this cust
2952 my @pending = qsearch('cust_pay_pending', {
2953 'custnum' => $self->custnum,
2954 'status' => { op=>'!=', value=>'done' }
2956 return "A payment is already being processed for this customer (".
2957 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
2958 "); $method transaction aborted."
2959 if scalar(@pending);
2961 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
2963 my $cust_pay_pending = new FS::cust_pay_pending {
2964 'custnum' => $self->custnum,
2965 #'invnum' => $options{'invnum'},
2968 'payby' => $method2payby{$method},
2969 'payinfo' => $payinfo,
2970 'paydate' => $paydate,
2971 'recurring_billing' => $content{recurring_billing},
2973 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
2975 $cust_pay_pending->payunique( $options{payunique} )
2976 if defined($options{payunique}) && length($options{payunique});
2977 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
2978 return $cpp_new_err if $cpp_new_err;
2980 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2982 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2983 $transaction->content(
2986 'password' => $password,
2987 'action' => $action1,
2988 'description' => $options{'description'},
2989 'amount' => $amount,
2990 #'invoice_number' => $options{'invnum'},
2991 'customer_id' => $self->custnum,
2992 'last_name' => $paylast,
2993 'first_name' => $payfirst,
2995 'address' => $address,
2996 'city' => ( exists($options{'city'})
2999 'state' => ( exists($options{'state'})
3002 'zip' => ( exists($options{'zip'})
3005 'country' => ( exists($options{'country'})
3006 ? $options{'country'}
3008 'referer' => 'http://cleanwhisker.420.am/',
3010 'phone' => $self->daytime || $self->night,
3014 $cust_pay_pending->status('pending');
3015 my $cpp_pending_err = $cust_pay_pending->replace;
3016 return $cpp_pending_err if $cpp_pending_err;
3018 $transaction->submit();
3020 if ( $transaction->is_success() && $action2 ) {
3022 $cust_pay_pending->status('authorized');
3023 my $cpp_authorized_err = $cust_pay_pending->replace;
3024 return $cpp_authorized_err if $cpp_authorized_err;
3026 my $auth = $transaction->authorization;
3027 my $ordernum = $transaction->can('order_number')
3028 ? $transaction->order_number
3032 new Business::OnlinePayment( $processor, @bop_options );
3039 password => $password,
3040 order_number => $ordernum,
3042 authorization => $auth,
3043 description => $options{'description'},
3046 foreach my $field (qw( authorization_source_code returned_ACI
3047 transaction_identifier validation_code
3048 transaction_sequence_num local_transaction_date
3049 local_transaction_time AVS_result_code )) {
3050 $capture{$field} = $transaction->$field() if $transaction->can($field);
3053 $capture->content( %capture );
3057 unless ( $capture->is_success ) {
3058 my $e = "Authorization successful but capture failed, custnum #".
3059 $self->custnum. ': '. $capture->result_code.
3060 ": ". $capture->error_message;
3067 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3068 my $cpp_captured_err = $cust_pay_pending->replace;
3069 return $cpp_captured_err if $cpp_captured_err;
3072 # remove paycvv after initial transaction
3075 #false laziness w/misc/process/payment.cgi - check both to make sure working
3077 if ( defined $self->dbdef_table->column('paycvv')
3078 && length($self->paycvv)
3079 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3081 my $error = $self->remove_cvv;
3083 warn "WARNING: error removing cvv: $error\n";
3091 if ( $transaction->is_success() ) {
3094 if ( $payment_gateway ) { # agent override
3095 $paybatch = $payment_gateway->gatewaynum. '-';
3098 $paybatch .= "$processor:". $transaction->authorization;
3100 $paybatch .= ':'. $transaction->order_number
3101 if $transaction->can('order_number')
3102 && length($transaction->order_number);
3104 my $cust_pay = new FS::cust_pay ( {
3105 'custnum' => $self->custnum,
3106 'invnum' => $options{'invnum'},
3109 'payby' => $method2payby{$method},
3110 'payinfo' => $payinfo,
3111 'paybatch' => $paybatch,
3112 'paydate' => $paydate,
3114 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3115 $cust_pay->payunique( $options{payunique} )
3116 if defined($options{payunique}) && length($options{payunique});
3118 my $oldAutoCommit = $FS::UID::AutoCommit;
3119 local $FS::UID::AutoCommit = 0;
3122 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3124 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3127 $cust_pay->invnum(''); #try again with no specific invnum
3128 my $error2 = $cust_pay->insert( $options{'manual'} ?
3129 ( 'manual' => 1 ) : ()
3132 # gah. but at least we have a record of the state we had to abort in
3133 # from cust_pay_pending now.
3134 my $e = "WARNING: $method captured but payment not recorded - ".
3135 "error inserting payment ($processor): $error2".
3136 " (previously tried insert with invnum #$options{'invnum'}" .
3137 ": $error ) - pending payment saved as paypendingnum ".
3138 $cust_pay_pending->paypendingnum. "\n";
3144 if ( $options{'paynum_ref'} ) {
3145 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3148 $cust_pay_pending->status('done');
3149 $cust_pay_pending->statustext('captured');
3150 my $cpp_done_err = $cust_pay_pending->replace;
3152 if ( $cpp_done_err ) {
3154 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3155 my $e = "WARNING: $method captured but payment not recorded - ".
3156 "error updating status for paypendingnum ".
3157 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3163 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3165 if ( $options{'apply'} ) {
3166 my $apply_error = $self->apply_payments_and_credits;
3167 if ( $apply_error ) {
3168 warn "WARNING: error applying payment: $apply_error\n";
3169 #but we still should return no error cause the payment otherwise went
3174 return ''; #no error
3180 my $perror = "$processor error: ". $transaction->error_message;
3182 unless ( $transaction->error_message ) {
3185 #this should be normalized :/
3187 # bad, ad-hoc B:OP:PayflowPro "transaction_response" BS
3188 if ( $transaction->can('param')
3189 && $transaction->param('transaction_response') ) {
3190 $t_response = $transaction->param('transaction_response')
3192 # slightly better, ad-hoc B:OP:TransactionCentral without "param"
3193 } elsif ( $transaction->can('response_page') ) {
3195 'page' => ( $transaction->can('response_page')
3196 ? $transaction->response_page
3199 'code' => ( $transaction->can('response_code')
3200 ? $transaction->response_code
3203 'headers' => ( $transaction->can('response_headers')
3204 ? $transaction->response_headers
3210 "No additional debugging information available for $processor";
3213 $perror .= "No error_message returned from $processor -- ".
3214 ( ref($t_response) ? Dumper($t_response) : $t_response );
3218 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3219 && $conf->exists('emaildecline')
3220 && grep { $_ ne 'POST' } $self->invoicing_list
3221 && ! grep { $transaction->error_message =~ /$_/ }
3222 $conf->config('emaildecline-exclude')
3224 my @templ = $conf->config('declinetemplate');
3225 my $template = new Text::Template (
3227 SOURCE => [ map "$_\n", @templ ],
3228 ) or return "($perror) can't create template: $Text::Template::ERROR";
3229 $template->compile()
3230 or return "($perror) can't compile template: $Text::Template::ERROR";
3232 my $templ_hash = { error => $transaction->error_message };
3234 my $error = send_email(
3235 'from' => $conf->config('invoice_from'),
3236 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3237 'subject' => 'Your payment could not be processed',
3238 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3241 $perror .= " (also received error sending decline notification: $error)"
3246 $cust_pay_pending->status('done');
3247 $cust_pay_pending->statustext("declined: $perror");
3248 my $cpp_done_err = $cust_pay_pending->replace;
3249 if ( $cpp_done_err ) {
3250 my $e = "WARNING: $method declined but pending payment not resolved - ".
3251 "error updating status for paypendingnum ".
3252 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3254 $perror = "$e ($perror)";
3262 =item default_payment_gateway
3266 sub default_payment_gateway {
3267 my( $self, $method ) = @_;
3269 die "Real-time processing not enabled\n"
3270 unless $conf->exists('business-onlinepayment');
3273 my $bop_config = 'business-onlinepayment';
3274 $bop_config .= '-ach'
3275 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3276 my ( $processor, $login, $password, $action, @bop_options ) =
3277 $conf->config($bop_config);
3278 $action ||= 'normal authorization';
3279 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3280 die "No real-time processor is enabled - ".
3281 "did you set the business-onlinepayment configuration value?\n"
3284 ( $processor, $login, $password, $action, @bop_options )
3289 Removes the I<paycvv> field from the database directly.
3291 If there is an error, returns the error, otherwise returns false.
3297 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3298 or return dbh->errstr;
3299 $sth->execute($self->custnum)
3300 or return $sth->errstr;
3305 sub _bop_recurring_billing {
3306 my( $self, %opt ) = @_;
3308 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
3310 if ( defined($method) && $method eq 'transaction_is_recur' ) {
3312 return 1 if $opt{'trans_is_recur'};
3316 my %hash = ( 'custnum' => $self->custnum,
3321 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
3322 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
3333 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3335 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3336 via a Business::OnlinePayment realtime gateway. See
3337 L<http://420.am/business-onlinepayment> for supported gateways.
3339 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3341 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3343 Most gateways require a reference to an original payment transaction to refund,
3344 so you probably need to specify a I<paynum>.
3346 I<amount> defaults to the original amount of the payment if not specified.
3348 I<reason> specifies a reason for the refund.
3350 I<paydate> specifies the expiration date for a credit card overriding the
3351 value from the customer record or the payment record. Specified as yyyy-mm-dd
3353 Implementation note: If I<amount> is unspecified or equal to the amount of the
3354 orignal payment, first an attempt is made to "void" the transaction via
3355 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3356 the normal attempt is made to "refund" ("credit") the transaction via the
3357 gateway is attempted.
3359 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3360 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3361 #if set, will override the value from the customer record.
3363 #If an I<invnum> is specified, this payment (if successful) is applied to the
3364 #specified invoice. If you don't specify an I<invnum> you might want to
3365 #call the B<apply_payments> method.
3369 #some false laziness w/realtime_bop, not enough to make it worth merging
3370 #but some useful small subs should be pulled out
3371 sub realtime_refund_bop {
3372 my( $self, $method, %options ) = @_;
3374 warn "$me realtime_refund_bop: $method refund\n";
3375 warn " $_ => $options{$_}\n" foreach keys %options;
3378 eval "use Business::OnlinePayment";
3382 # look up the original payment and optionally a gateway for that payment
3386 my $amount = $options{'amount'};
3388 my( $processor, $login, $password, @bop_options ) ;
3389 my( $auth, $order_number ) = ( '', '', '' );
3391 if ( $options{'paynum'} ) {
3393 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3394 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3395 or return "Unknown paynum $options{'paynum'}";
3396 $amount ||= $cust_pay->paid;
3398 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3399 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3400 $cust_pay->paybatch;
3401 my $gatewaynum = '';
3402 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3404 if ( $gatewaynum ) { #gateway for the payment to be refunded
3406 my $payment_gateway =
3407 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3408 die "payment gateway $gatewaynum not found"
3409 unless $payment_gateway;
3411 $processor = $payment_gateway->gateway_module;
3412 $login = $payment_gateway->gateway_username;
3413 $password = $payment_gateway->gateway_password;
3414 @bop_options = $payment_gateway->options;
3416 } else { #try the default gateway
3418 my( $conf_processor, $unused_action );
3419 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3420 $self->default_payment_gateway($method);
3422 return "processor of payment $options{'paynum'} $processor does not".
3423 " match default processor $conf_processor"
3424 unless $processor eq $conf_processor;
3429 } else { # didn't specify a paynum, so look for agent gateway overrides
3430 # like a normal transaction
3433 if ( $method eq 'CC' ) {
3434 $cardtype = cardtype($self->payinfo);
3435 } elsif ( $method eq 'ECHECK' ) {
3438 $cardtype = $method;
3441 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3442 cardtype => $cardtype,
3444 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3446 taxclass => '', } );
3448 if ( $override ) { #use a payment gateway override
3450 my $payment_gateway = $override->payment_gateway;
3452 $processor = $payment_gateway->gateway_module;
3453 $login = $payment_gateway->gateway_username;
3454 $password = $payment_gateway->gateway_password;
3455 #$action = $payment_gateway->gateway_action;
3456 @bop_options = $payment_gateway->options;
3458 } else { #use the standard settings from the config
3461 ( $processor, $login, $password, $unused_action, @bop_options ) =
3462 $self->default_payment_gateway($method);
3467 return "neither amount nor paynum specified" unless $amount;
3472 'password' => $password,
3473 'order_number' => $order_number,
3474 'amount' => $amount,
3475 'referer' => 'http://cleanwhisker.420.am/',
3477 $content{authorization} = $auth
3478 if length($auth); #echeck/ACH transactions have an order # but no auth
3479 #(at least with authorize.net)
3481 my $disable_void_after;
3482 if ($conf->exists('disable_void_after')
3483 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3484 $disable_void_after = $1;
3487 #first try void if applicable
3488 if ( $cust_pay && $cust_pay->paid == $amount
3490 ( not defined($disable_void_after) )
3491 || ( time < ($cust_pay->_date + $disable_void_after ) )
3494 warn " attempting void\n" if $DEBUG > 1;
3495 my $void = new Business::OnlinePayment( $processor, @bop_options );
3496 $void->content( 'action' => 'void', %content );
3498 if ( $void->is_success ) {
3499 my $error = $cust_pay->void($options{'reason'});
3501 # gah, even with transactions.
3502 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3503 "error voiding payment: $error";
3507 warn " void successful\n" if $DEBUG > 1;
3512 warn " void unsuccessful, trying refund\n"
3516 my $address = $self->address1;
3517 $address .= ", ". $self->address2 if $self->address2;
3519 my($payname, $payfirst, $paylast);
3520 if ( $self->payname && $method ne 'ECHECK' ) {
3521 $payname = $self->payname;
3522 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3523 or return "Illegal payname $payname";
3524 ($payfirst, $paylast) = ($1, $2);
3526 $payfirst = $self->getfield('first');
3527 $paylast = $self->getfield('last');
3528 $payname = "$payfirst $paylast";
3531 my @invoicing_list = $self->invoicing_list_emailonly;
3532 if ( $conf->exists('emailinvoiceautoalways')
3533 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3534 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3535 push @invoicing_list, $self->all_emails;
3538 my $email = ($conf->exists('business-onlinepayment-email-override'))
3539 ? $conf->config('business-onlinepayment-email-override')
3540 : $invoicing_list[0];
3542 my $payip = exists($options{'payip'})
3545 $content{customer_ip} = $payip
3549 if ( $method eq 'CC' ) {
3552 $content{card_number} = $payinfo = $cust_pay->payinfo;
3553 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3554 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3555 ($content{expiration} = "$2/$1"); # where available
3557 $content{card_number} = $payinfo = $self->payinfo;
3558 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3559 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3560 $content{expiration} = "$2/$1";
3563 } elsif ( $method eq 'ECHECK' ) {
3566 $payinfo = $cust_pay->payinfo;
3568 $payinfo = $self->payinfo;
3570 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3571 $content{bank_name} = $self->payname;
3572 $content{account_type} = 'CHECKING';
3573 $content{account_name} = $payname;
3574 $content{customer_org} = $self->company ? 'B' : 'I';
3575 $content{customer_ssn} = $self->ss;
3576 } elsif ( $method eq 'LEC' ) {
3577 $content{phone} = $payinfo = $self->payinfo;
3581 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3582 my %sub_content = $refund->content(
3583 'action' => 'credit',
3584 'customer_id' => $self->custnum,
3585 'last_name' => $paylast,
3586 'first_name' => $payfirst,
3588 'address' => $address,
3589 'city' => $self->city,
3590 'state' => $self->state,
3591 'zip' => $self->zip,
3592 'country' => $self->country,
3594 'phone' => $self->daytime || $self->night,
3597 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3601 return "$processor error: ". $refund->error_message
3602 unless $refund->is_success();
3604 my %method2payby = (
3610 my $paybatch = "$processor:". $refund->authorization;
3611 $paybatch .= ':'. $refund->order_number
3612 if $refund->can('order_number') && $refund->order_number;
3614 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3615 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3616 last unless @cust_bill_pay;
3617 my $cust_bill_pay = pop @cust_bill_pay;
3618 my $error = $cust_bill_pay->delete;
3622 my $cust_refund = new FS::cust_refund ( {
3623 'custnum' => $self->custnum,
3624 'paynum' => $options{'paynum'},
3625 'refund' => $amount,
3627 'payby' => $method2payby{$method},
3628 'payinfo' => $payinfo,
3629 'paybatch' => $paybatch,
3630 'reason' => $options{'reason'} || 'card or ACH refund',
3632 my $error = $cust_refund->insert;
3634 $cust_refund->paynum(''); #try again with no specific paynum
3635 my $error2 = $cust_refund->insert;
3637 # gah, even with transactions.
3638 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3639 "error inserting refund ($processor): $error2".
3640 " (previously tried insert with paynum #$options{'paynum'}" .
3651 =item realtime_collect [ OPTION => VALUE ... ]
3653 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3654 via a Business::OnlinePayment realtime gateway. See
3655 L<http://420.am/business-onlinepayment> for supported gateways.
3657 If there is an error, returns the error, otherwise returns false.
3659 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3661 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
3662 then it is deduced from the customer record.
3664 If no I<amount> is specified, then the customer balance is used.
3666 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3667 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3668 if set, will override the value from the customer record.
3670 I<description> is a free-text field passed to the gateway. It defaults to
3671 the value defined by the business-onlinepayment-description configuration
3672 option, or "Internet services" if that is unset.
3674 If an I<invnum> is specified, this payment (if successful) is applied to the
3675 specified invoice. If you don't specify an I<invnum> you might want to
3676 call the B<apply_payments> method or set the I<apply> option.
3678 I<apply> can be set to true to apply a resulting payment.
3680 I<quiet> can be set true to surpress email decline notices.
3682 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3683 resulting paynum, if any.
3685 I<payunique> is a unique identifier for this payment.
3687 I<depend_jobnum> allows payment capture to unlock export jobs
3691 sub realtime_collect {
3692 my( $self, %options ) = @_;
3695 warn "$me realtime_collect:\n";
3696 warn " $_ => $options{$_}\n" foreach keys %options;
3699 $options{amount} = $self->balance unless exists( $options{amount} );
3700 $options{method} = FS::payby->payby2bop($self->payby)
3701 unless exists( $options{method} );
3703 return $self->realtime_bop({%options});
3707 =item batch_card OPTION => VALUE...
3709 Adds a payment for this invoice to the pending credit card batch (see
3710 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3711 runs the payment using a realtime gateway.
3716 my ($self, %options) = @_;
3719 if (exists($options{amount})) {
3720 $amount = $options{amount};
3722 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3724 return '' unless $amount > 0;
3726 my $invnum = delete $options{invnum};
3727 my $payby = $options{invnum} || $self->payby; #dubious
3729 if ($options{'realtime'}) {
3730 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3736 my $oldAutoCommit = $FS::UID::AutoCommit;
3737 local $FS::UID::AutoCommit = 0;
3740 #this needs to handle mysql as well as Pg, like svc_acct.pm
3741 #(make it into a common function if folks need to do batching with mysql)
3742 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3743 or return "Cannot lock pay_batch: " . $dbh->errstr;
3747 'payby' => FS::payby->payby2payment($payby),
3750 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3752 unless ( $pay_batch ) {
3753 $pay_batch = new FS::pay_batch \%pay_batch;
3754 my $error = $pay_batch->insert;
3756 $dbh->rollback if $oldAutoCommit;
3757 die "error creating new batch: $error\n";
3761 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3762 'batchnum' => $pay_batch->batchnum,
3763 'custnum' => $self->custnum,
3766 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3768 $options{$_} = '' unless exists($options{$_});
3771 my $cust_pay_batch = new FS::cust_pay_batch ( {
3772 'batchnum' => $pay_batch->batchnum,
3773 'invnum' => $invnum || 0, # is there a better value?
3774 # this field should be
3776 # cust_bill_pay_batch now
3777 'custnum' => $self->custnum,
3778 'last' => $self->getfield('last'),
3779 'first' => $self->getfield('first'),
3780 'address1' => $options{address1} || $self->address1,
3781 'address2' => $options{address2} || $self->address2,
3782 'city' => $options{city} || $self->city,
3783 'state' => $options{state} || $self->state,
3784 'zip' => $options{zip} || $self->zip,
3785 'country' => $options{country} || $self->country,
3786 'payby' => $options{payby} || $self->payby,
3787 'payinfo' => $options{payinfo} || $self->payinfo,
3788 'exp' => $options{paydate} || $self->paydate,
3789 'payname' => $options{payname} || $self->payname,
3790 'amount' => $amount, # consolidating
3793 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3794 if $old_cust_pay_batch;
3797 if ($old_cust_pay_batch) {
3798 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3800 $error = $cust_pay_batch->insert;
3804 $dbh->rollback if $oldAutoCommit;
3808 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3809 foreach my $cust_bill ($self->open_cust_bill) {
3810 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3811 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3812 'invnum' => $cust_bill->invnum,
3813 'paybatchnum' => $cust_pay_batch->paybatchnum,
3814 'amount' => $cust_bill->owed,
3817 if ($unapplied >= $cust_bill_pay_batch->amount){
3818 $unapplied -= $cust_bill_pay_batch->amount;
3821 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3822 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3824 $error = $cust_bill_pay_batch->insert;
3826 $dbh->rollback if $oldAutoCommit;
3831 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3837 Returns the total owed for this customer on all invoices
3838 (see L<FS::cust_bill/owed>).
3844 $self->total_owed_date(2145859200); #12/31/2037
3847 =item total_owed_date TIME
3849 Returns the total owed for this customer on all invoices with date earlier than
3850 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3851 see L<Time::Local> and L<Date::Parse> for conversion functions.
3855 sub total_owed_date {
3859 foreach my $cust_bill (
3860 grep { $_->_date <= $time }
3861 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3863 $total_bill += $cust_bill->owed;
3865 sprintf( "%.2f", $total_bill );
3868 =item apply_payments_and_credits
3870 Applies unapplied payments and credits.
3872 In most cases, this new method should be used in place of sequential
3873 apply_payments and apply_credits methods.
3875 If there is an error, returns the error, otherwise returns false.
3879 sub apply_payments_and_credits {
3882 local $SIG{HUP} = 'IGNORE';
3883 local $SIG{INT} = 'IGNORE';
3884 local $SIG{QUIT} = 'IGNORE';
3885 local $SIG{TERM} = 'IGNORE';
3886 local $SIG{TSTP} = 'IGNORE';
3887 local $SIG{PIPE} = 'IGNORE';
3889 my $oldAutoCommit = $FS::UID::AutoCommit;
3890 local $FS::UID::AutoCommit = 0;
3893 $self->select_for_update; #mutex
3895 foreach my $cust_bill ( $self->open_cust_bill ) {
3896 my $error = $cust_bill->apply_payments_and_credits;
3898 $dbh->rollback if $oldAutoCommit;
3899 return "Error applying: $error";
3903 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3908 =item apply_credits OPTION => VALUE ...
3910 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3911 to outstanding invoice balances in chronological order (or reverse
3912 chronological order if the I<order> option is set to B<newest>) and returns the
3913 value of any remaining unapplied credits available for refund (see
3914 L<FS::cust_refund>).
3916 Dies if there is an error.
3924 local $SIG{HUP} = 'IGNORE';
3925 local $SIG{INT} = 'IGNORE';
3926 local $SIG{QUIT} = 'IGNORE';
3927 local $SIG{TERM} = 'IGNORE';
3928 local $SIG{TSTP} = 'IGNORE';
3929 local $SIG{PIPE} = 'IGNORE';
3931 my $oldAutoCommit = $FS::UID::AutoCommit;
3932 local $FS::UID::AutoCommit = 0;
3935 $self->select_for_update; #mutex
3937 unless ( $self->total_credited ) {
3938 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3942 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3943 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3945 my @invoices = $self->open_cust_bill;
3946 @invoices = sort { $b->_date <=> $a->_date } @invoices
3947 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3950 foreach my $cust_bill ( @invoices ) {
3953 if ( !defined($credit) || $credit->credited == 0) {
3954 $credit = pop @credits or last;
3957 if ($cust_bill->owed >= $credit->credited) {
3958 $amount=$credit->credited;
3960 $amount=$cust_bill->owed;
3963 my $cust_credit_bill = new FS::cust_credit_bill ( {
3964 'crednum' => $credit->crednum,
3965 'invnum' => $cust_bill->invnum,
3966 'amount' => $amount,
3968 my $error = $cust_credit_bill->insert;
3970 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3974 redo if ($cust_bill->owed > 0);
3978 my $total_credited = $self->total_credited;
3980 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3982 return $total_credited;
3985 =item apply_payments
3987 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3988 to outstanding invoice balances in chronological order.
3990 #and returns the value of any remaining unapplied payments.
3992 Dies if there is an error.
3996 sub apply_payments {
3999 local $SIG{HUP} = 'IGNORE';
4000 local $SIG{INT} = 'IGNORE';
4001 local $SIG{QUIT} = 'IGNORE';
4002 local $SIG{TERM} = 'IGNORE';
4003 local $SIG{TSTP} = 'IGNORE';
4004 local $SIG{PIPE} = 'IGNORE';
4006 my $oldAutoCommit = $FS::UID::AutoCommit;
4007 local $FS::UID::AutoCommit = 0;
4010 $self->select_for_update; #mutex
4014 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4015 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4017 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4018 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4022 foreach my $cust_bill ( @invoices ) {
4025 if ( !defined($payment) || $payment->unapplied == 0 ) {
4026 $payment = pop @payments or last;
4029 if ( $cust_bill->owed >= $payment->unapplied ) {
4030 $amount = $payment->unapplied;
4032 $amount = $cust_bill->owed;
4035 my $cust_bill_pay = new FS::cust_bill_pay ( {
4036 'paynum' => $payment->paynum,
4037 'invnum' => $cust_bill->invnum,
4038 'amount' => $amount,
4040 my $error = $cust_bill_pay->insert;
4042 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4046 redo if ( $cust_bill->owed > 0);
4050 my $total_unapplied_payments = $self->total_unapplied_payments;
4052 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4054 return $total_unapplied_payments;
4057 =item total_credited
4059 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4060 customer. See L<FS::cust_credit/credited>.
4064 sub total_credited {
4066 my $total_credit = 0;
4067 foreach my $cust_credit ( qsearch('cust_credit', {
4068 'custnum' => $self->custnum,
4070 $total_credit += $cust_credit->credited;
4072 sprintf( "%.2f", $total_credit );
4075 =item total_unapplied_payments
4077 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4078 See L<FS::cust_pay/unapplied>.
4082 sub total_unapplied_payments {
4084 my $total_unapplied = 0;
4085 foreach my $cust_pay ( qsearch('cust_pay', {
4086 'custnum' => $self->custnum,
4088 $total_unapplied += $cust_pay->unapplied;
4090 sprintf( "%.2f", $total_unapplied );
4093 =item total_unapplied_refunds
4095 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4096 customer. See L<FS::cust_refund/unapplied>.
4100 sub total_unapplied_refunds {
4102 my $total_unapplied = 0;
4103 foreach my $cust_refund ( qsearch('cust_refund', {
4104 'custnum' => $self->custnum,
4106 $total_unapplied += $cust_refund->unapplied;
4108 sprintf( "%.2f", $total_unapplied );
4113 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4114 total_credited minus total_unapplied_payments).
4122 + $self->total_unapplied_refunds
4123 - $self->total_credited
4124 - $self->total_unapplied_payments
4128 =item balance_date TIME
4130 Returns the balance for this customer, only considering invoices with date
4131 earlier than TIME (total_owed_date minus total_credited minus
4132 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4133 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4142 $self->total_owed_date($time)
4143 + $self->total_unapplied_refunds
4144 - $self->total_credited
4145 - $self->total_unapplied_payments
4149 =item in_transit_payments
4151 Returns the total of requests for payments for this customer pending in
4152 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4156 sub in_transit_payments {
4158 my $in_transit_payments = 0;
4159 foreach my $pay_batch ( qsearch('pay_batch', {
4162 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4163 'batchnum' => $pay_batch->batchnum,
4164 'custnum' => $self->custnum,
4166 $in_transit_payments += $cust_pay_batch->amount;
4169 sprintf( "%.2f", $in_transit_payments );
4172 =item paydate_monthyear
4174 Returns a two-element list consisting of the month and year of this customer's
4175 paydate (credit card expiration date for CARD customers)
4179 sub paydate_monthyear {
4181 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4183 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4190 =item invoicing_list [ ARRAYREF ]
4192 If an arguement is given, sets these email addresses as invoice recipients
4193 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4194 (except as warnings), so use check_invoicing_list first.
4196 Returns a list of email addresses (with svcnum entries expanded).
4198 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4199 check it without disturbing anything by passing nothing.
4201 This interface may change in the future.
4205 sub invoicing_list {
4206 my( $self, $arrayref ) = @_;
4209 my @cust_main_invoice;
4210 if ( $self->custnum ) {
4211 @cust_main_invoice =
4212 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4214 @cust_main_invoice = ();
4216 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4217 #warn $cust_main_invoice->destnum;
4218 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4219 #warn $cust_main_invoice->destnum;
4220 my $error = $cust_main_invoice->delete;
4221 warn $error if $error;
4224 if ( $self->custnum ) {
4225 @cust_main_invoice =
4226 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4228 @cust_main_invoice = ();
4230 my %seen = map { $_->address => 1 } @cust_main_invoice;
4231 foreach my $address ( @{$arrayref} ) {
4232 next if exists $seen{$address} && $seen{$address};
4233 $seen{$address} = 1;
4234 my $cust_main_invoice = new FS::cust_main_invoice ( {
4235 'custnum' => $self->custnum,
4238 my $error = $cust_main_invoice->insert;
4239 warn $error if $error;
4243 if ( $self->custnum ) {
4245 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4252 =item check_invoicing_list ARRAYREF
4254 Checks these arguements as valid input for the invoicing_list method. If there
4255 is an error, returns the error, otherwise returns false.
4259 sub check_invoicing_list {
4260 my( $self, $arrayref ) = @_;
4262 foreach my $address ( @$arrayref ) {
4264 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4265 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4268 my $cust_main_invoice = new FS::cust_main_invoice ( {
4269 'custnum' => $self->custnum,
4272 my $error = $self->custnum
4273 ? $cust_main_invoice->check
4274 : $cust_main_invoice->checkdest
4276 return $error if $error;
4280 return "Email address required"
4281 if $conf->exists('cust_main-require_invoicing_list_email')
4282 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4287 =item set_default_invoicing_list
4289 Sets the invoicing list to all accounts associated with this customer,
4290 overwriting any previous invoicing list.
4294 sub set_default_invoicing_list {
4296 $self->invoicing_list($self->all_emails);
4301 Returns the email addresses of all accounts provisioned for this customer.
4308 foreach my $cust_pkg ( $self->all_pkgs ) {
4309 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4311 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4312 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4314 $list{$_}=1 foreach map { $_->email } @svc_acct;
4319 =item invoicing_list_addpost
4321 Adds postal invoicing to this customer. If this customer is already configured
4322 to receive postal invoices, does nothing.
4326 sub invoicing_list_addpost {
4328 return if grep { $_ eq 'POST' } $self->invoicing_list;
4329 my @invoicing_list = $self->invoicing_list;
4330 push @invoicing_list, 'POST';
4331 $self->invoicing_list(\@invoicing_list);
4334 =item invoicing_list_emailonly
4336 Returns the list of email invoice recipients (invoicing_list without non-email
4337 destinations such as POST and FAX).
4341 sub invoicing_list_emailonly {
4343 warn "$me invoicing_list_emailonly called"
4345 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4348 =item invoicing_list_emailonly_scalar
4350 Returns the list of email invoice recipients (invoicing_list without non-email
4351 destinations such as POST and FAX) as a comma-separated scalar.
4355 sub invoicing_list_emailonly_scalar {
4357 warn "$me invoicing_list_emailonly_scalar called"
4359 join(', ', $self->invoicing_list_emailonly);
4362 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4364 Returns an array of customers referred by this customer (referral_custnum set
4365 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4366 customers referred by customers referred by this customer and so on, inclusive.
4367 The default behavior is DEPTH 1 (no recursion).
4371 sub referral_cust_main {
4373 my $depth = @_ ? shift : 1;
4374 my $exclude = @_ ? shift : {};
4377 map { $exclude->{$_->custnum}++; $_; }
4378 grep { ! $exclude->{ $_->custnum } }
4379 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4383 map { $_->referral_cust_main($depth-1, $exclude) }
4390 =item referral_cust_main_ncancelled
4392 Same as referral_cust_main, except only returns customers with uncancelled
4397 sub referral_cust_main_ncancelled {
4399 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4402 =item referral_cust_pkg [ DEPTH ]
4404 Like referral_cust_main, except returns a flat list of all unsuspended (and
4405 uncancelled) packages for each customer. The number of items in this list may
4406 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4410 sub referral_cust_pkg {
4412 my $depth = @_ ? shift : 1;
4414 map { $_->unsuspended_pkgs }
4415 grep { $_->unsuspended_pkgs }
4416 $self->referral_cust_main($depth);
4419 =item referring_cust_main
4421 Returns the single cust_main record for the customer who referred this customer
4422 (referral_custnum), or false.
4426 sub referring_cust_main {
4428 return '' unless $self->referral_custnum;
4429 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4432 =item credit AMOUNT, REASON
4434 Applies a credit to this customer. If there is an error, returns the error,
4435 otherwise returns false.
4440 my( $self, $amount, $reason, %options ) = @_;
4441 my $cust_credit = new FS::cust_credit {
4442 'custnum' => $self->custnum,
4443 'amount' => $amount,
4444 'reason' => $reason,
4446 $cust_credit->insert(%options);
4449 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4451 Creates a one-time charge for this customer. If there is an error, returns
4452 the error, otherwise returns false.
4458 my ( $amount, $quantity, $pkg, $comment, $taxclass, $additional, $classnum );
4459 if ( ref( $_[0] ) ) {
4460 $amount = $_[0]->{amount};
4461 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
4462 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4463 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4464 : '$'. sprintf("%.2f",$amount);
4465 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4466 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4467 $additional = $_[0]->{additional};
4471 $pkg = @_ ? shift : 'One-time charge';
4472 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4473 $taxclass = @_ ? shift : '';
4477 local $SIG{HUP} = 'IGNORE';
4478 local $SIG{INT} = 'IGNORE';
4479 local $SIG{QUIT} = 'IGNORE';
4480 local $SIG{TERM} = 'IGNORE';
4481 local $SIG{TSTP} = 'IGNORE';
4482 local $SIG{PIPE} = 'IGNORE';
4484 my $oldAutoCommit = $FS::UID::AutoCommit;
4485 local $FS::UID::AutoCommit = 0;
4488 my $part_pkg = new FS::part_pkg ( {
4490 'comment' => $comment,
4494 'classnum' => $classnum ? $classnum : '',
4495 'taxclass' => $taxclass,
4498 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4499 ( 0 .. @$additional - 1 )
4501 'additional_count' => scalar(@$additional),
4502 'setup_fee' => $amount,
4505 my $error = $part_pkg->insert( options => \%options );
4507 $dbh->rollback if $oldAutoCommit;
4511 my $pkgpart = $part_pkg->pkgpart;
4512 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4513 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4514 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4515 $error = $type_pkgs->insert;
4517 $dbh->rollback if $oldAutoCommit;
4522 my $cust_pkg = new FS::cust_pkg ( {
4523 'custnum' => $self->custnum,
4524 'pkgpart' => $pkgpart,
4525 'quantity' => $quantity,
4528 $error = $cust_pkg->insert;
4530 $dbh->rollback if $oldAutoCommit;
4534 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4539 #=item charge_postal_fee
4541 #Applies a one time charge this customer. If there is an error,
4542 #returns the error, returns the cust_pkg charge object or false
4543 #if there was no charge.
4547 # This should be a customer event. For that to work requires that bill
4548 # also be a customer event.
4550 sub charge_postal_fee {
4553 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
4554 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
4556 my $cust_pkg = new FS::cust_pkg ( {
4557 'custnum' => $self->custnum,
4558 'pkgpart' => $pkgpart,
4562 my $error = $cust_pkg->insert;
4563 $error ? $error : $cust_pkg;
4568 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4574 sort { $a->_date <=> $b->_date }
4575 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4578 =item open_cust_bill
4580 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4585 sub open_cust_bill {
4587 grep { $_->owed > 0 } $self->cust_bill;
4592 Returns all the credits (see L<FS::cust_credit>) for this customer.
4598 sort { $a->_date <=> $b->_date }
4599 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4604 Returns all the payments (see L<FS::cust_pay>) for this customer.
4610 sort { $a->_date <=> $b->_date }
4611 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4616 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4622 sort { $a->_date <=> $b->_date }
4623 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4629 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4635 sort { $a->_date <=> $b->_date }
4636 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4641 Returns a name string for this customer, either "Company (Last, First)" or
4648 my $name = $self->contact;
4649 $name = $self->company. " ($name)" if $self->company;
4655 Returns a name string for this (service/shipping) contact, either
4656 "Company (Last, First)" or "Last, First".
4662 if ( $self->get('ship_last') ) {
4663 my $name = $self->ship_contact;
4664 $name = $self->ship_company. " ($name)" if $self->ship_company;
4673 Returns a name string for this customer, either "Company" or "First Last".
4679 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4682 =item ship_name_short
4684 Returns a name string for this (service/shipping) contact, either "Company"
4689 sub ship_name_short {
4691 if ( $self->get('ship_last') ) {
4692 $self->ship_company !~ /^\s*$/
4693 ? $self->ship_company
4694 : $self->ship_contact_firstlast;
4696 $self->name_company_or_firstlast;
4702 Returns this customer's full (billing) contact name only, "Last, First"
4708 $self->get('last'). ', '. $self->first;
4713 Returns this customer's full (shipping) contact name only, "Last, First"
4719 $self->get('ship_last')
4720 ? $self->get('ship_last'). ', '. $self->ship_first
4724 =item contact_firstlast
4726 Returns this customers full (billing) contact name only, "First Last".
4730 sub contact_firstlast {
4732 $self->first. ' '. $self->get('last');
4735 =item ship_contact_firstlast
4737 Returns this customer's full (shipping) contact name only, "First Last".
4741 sub ship_contact_firstlast {
4743 $self->get('ship_last')
4744 ? $self->first. ' '. $self->get('ship_last')
4745 : $self->contact_firstlast;
4750 Returns this customer's full country name
4756 code2country($self->country);
4763 Returns a status string for this customer, currently:
4767 =item prospect - No packages have ever been ordered
4769 =item active - One or more recurring packages is active
4771 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4773 =item suspended - All non-cancelled recurring packages are suspended
4775 =item cancelled - All recurring packages are cancelled
4781 sub status { shift->cust_status(@_); }
4785 for my $status (qw( prospect active inactive suspended cancelled )) {
4786 my $method = $status.'_sql';
4787 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4788 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4789 $sth->execute( ($self->custnum) x $numnum )
4790 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4791 return $status if $sth->fetchrow_arrayref->[0];
4795 =item ucfirst_cust_status
4797 =item ucfirst_status
4799 Returns the status with the first character capitalized.
4803 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4805 sub ucfirst_cust_status {
4807 ucfirst($self->cust_status);
4812 Returns a hex triplet color string for this customer's status.
4816 use vars qw(%statuscolor);
4817 tie %statuscolor, 'Tie::IxHash',
4818 'prospect' => '7e0079', #'000000', #black? naw, purple
4819 'active' => '00CC00', #green
4820 'inactive' => '0000CC', #blue
4821 'suspended' => 'FF9900', #yellow
4822 'cancelled' => 'FF0000', #red
4825 sub statuscolor { shift->cust_statuscolor(@_); }
4827 sub cust_statuscolor {
4829 $statuscolor{$self->cust_status};
4834 =head1 CLASS METHODS
4840 Class method that returns the list of possible status strings for customers
4841 (see L<the status method|/status>). For example:
4843 @statuses = FS::cust_main->statuses();
4848 #my $self = shift; #could be class...
4854 Returns an SQL expression identifying prospective cust_main records (customers
4855 with no packages ever ordered)
4859 use vars qw($select_count_pkgs);
4860 $select_count_pkgs =
4861 "SELECT COUNT(*) FROM cust_pkg
4862 WHERE cust_pkg.custnum = cust_main.custnum";
4864 sub select_count_pkgs_sql {
4868 sub prospect_sql { "
4869 0 = ( $select_count_pkgs )
4874 Returns an SQL expression identifying active cust_main records (customers with
4875 active recurring packages).
4880 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4886 Returns an SQL expression identifying inactive cust_main records (customers with
4887 no active recurring packages, but otherwise unsuspended/uncancelled).
4891 sub inactive_sql { "
4892 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4894 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4900 Returns an SQL expression identifying suspended cust_main records.
4905 sub suspended_sql { susp_sql(@_); }
4907 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4909 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4915 Returns an SQL expression identifying cancelled cust_main records.
4919 sub cancelled_sql { cancel_sql(@_); }
4922 my $recurring_sql = FS::cust_pkg->recurring_sql;
4923 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
4926 0 < ( $select_count_pkgs )
4927 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
4928 AND 0 = ( $select_count_pkgs AND $recurring_sql
4929 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4931 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4937 =item uncancelled_sql
4939 Returns an SQL expression identifying un-cancelled cust_main records.
4943 sub uncancelled_sql { uncancel_sql(@_); }
4944 sub uncancel_sql { "
4945 ( 0 < ( $select_count_pkgs
4946 AND ( cust_pkg.cancel IS NULL
4947 OR cust_pkg.cancel = 0
4950 OR 0 = ( $select_count_pkgs )
4956 Returns an SQL fragment to retreive the balance.
4961 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4962 WHERE cust_bill.custnum = cust_main.custnum )
4963 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4964 WHERE cust_pay.custnum = cust_main.custnum )
4965 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4966 WHERE cust_credit.custnum = cust_main.custnum )
4967 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4968 WHERE cust_refund.custnum = cust_main.custnum )
4971 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4973 Returns an SQL fragment to retreive the balance for this customer, only
4974 considering invoices with date earlier than START_TIME, and optionally not
4975 later than END_TIME (total_owed_date minus total_credited minus
4976 total_unapplied_payments).
4978 Times are specified as SQL fragments or numeric
4979 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4980 L<Date::Parse> for conversion functions. The empty string can be passed
4981 to disable that time constraint completely.
4983 Available options are:
4987 =item unapplied_date - set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
4989 =item total - set to true to remove all customer comparison clauses, for totals
4991 =item where - WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4993 =item join - JOIN clause (typically used with the total option)
5001 sub balance_date_sql {
5002 my( $class, $start, $end, %opt ) = @_;
5004 my $owed = FS::cust_bill->owed_sql;
5005 my $unapp_refund = FS::cust_refund->unapplied_sql;
5006 my $unapp_credit = FS::cust_credit->unapplied_sql;
5007 my $unapp_pay = FS::cust_pay->unapplied_sql;
5009 my $j = $opt{'join'} || '';
5011 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5012 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5013 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5014 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5016 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5017 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5018 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5019 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5024 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5026 Helper method for balance_date_sql; name (and usage) subject to change
5027 (suggestions welcome).
5029 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5030 cust_refund, cust_credit or cust_pay).
5032 If TABLE is "cust_bill" or the unapplied_date option is true, only
5033 considers records with date earlier than START_TIME, and optionally not
5034 later than END_TIME .
5038 sub _money_table_where {
5039 my( $class, $table, $start, $end, %opt ) = @_;
5042 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5043 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5044 push @where, "$table._date <= $start" if defined($start) && length($start);
5045 push @where, "$table._date > $end" if defined($end) && length($end);
5047 push @where, @{$opt{'where'}} if $opt{'where'};
5048 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5054 =item search_sql HASHREF
5058 Returns a qsearch hash expression to search for parameters specified in HREF.
5059 Valid parameters are
5067 =item cancelled_pkgs
5073 listref of start date, end date
5079 =item current_balance
5081 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
5085 =item flattened_pkgs
5094 my ($class, $params) = @_;
5105 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5107 "cust_main.agentnum = $1";
5114 #prospect active inactive suspended cancelled
5115 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
5116 my $method = $params->{'status'}. '_sql';
5117 #push @where, $class->$method();
5118 push @where, FS::cust_main->$method();
5122 # parse cancelled package checkbox
5127 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
5128 unless $params->{'cancelled_pkgs'};
5134 foreach my $field (qw( signupdate )) {
5136 next unless exists($params->{$field});
5138 my($beginning, $ending) = @{$params->{$field}};
5141 "cust_main.$field IS NOT NULL",
5142 "cust_main.$field >= $beginning",
5143 "cust_main.$field <= $ending";
5145 $orderby ||= "ORDER BY cust_main.$field";
5153 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
5155 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
5162 #my $balance_sql = $class->balance_sql();
5163 my $balance_sql = FS::cust_main->balance_sql();
5165 push @where, map { s/current_balance/$balance_sql/; $_ }
5166 @{ $params->{'current_balance'} };
5172 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5174 "cust_main.custbatch = '$1'";
5178 # setup queries, subs, etc. for the search
5181 $orderby ||= 'ORDER BY custnum';
5183 # here is the agent virtualization
5184 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
5186 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5188 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
5190 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
5192 my $select = join(', ',
5193 'cust_main.custnum',
5194 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
5197 my(@extra_headers) = ();
5198 my(@extra_fields) = ();
5200 if ($params->{'flattened_pkgs'}) {
5202 if ($dbh->{Driver}->{Name} eq 'Pg') {
5204 $select .= ", array_to_string(array(select pkg from cust_pkg left join part_pkg using ( pkgpart ) where cust_main.custnum = cust_pkg.custnum $pkgwhere),'|') as magic";
5206 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
5207 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
5208 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
5210 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
5211 "omitting packing information from report.";
5214 my $header_query = "SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count FROM cust_main $addl_from $extra_sql $pkgwhere group by cust_main.custnum order by count desc limit 1";
5216 my $sth = dbh->prepare($header_query) or die dbh->errstr;
5217 $sth->execute() or die $sth->errstr;
5218 my $headerrow = $sth->fetchrow_arrayref;
5219 my $headercount = $headerrow ? $headerrow->[0] : 0;
5220 while($headercount) {
5221 unshift @extra_headers, "Package ". $headercount;
5222 unshift @extra_fields, eval q!sub {my $c = shift;
5223 my @a = split '\|', $c->magic;
5224 my $p = $a[!.--$headercount. q!];
5232 'table' => 'cust_main',
5233 'select' => $select,
5235 'extra_sql' => $extra_sql,
5236 'order_by' => $orderby,
5237 'count_query' => $count_query,
5238 'extra_headers' => \@extra_headers,
5239 'extra_fields' => \@extra_fields,
5244 =item email_search_sql HASHREF
5248 Emails a notice to the specified customers.
5250 Valid parameters are those of the L<search_sql> method, plus the following:
5272 Optional job queue job for status updates.
5276 Returns an error message, or false for success.
5278 If an error occurs during any email, stops the enture send and returns that
5279 error. Presumably if you're getting SMTP errors aborting is better than
5280 retrying everything.
5284 sub email_search_sql {
5285 my($class, $params) = @_;
5287 my $from = delete $params->{from};
5288 my $subject = delete $params->{subject};
5289 my $html_body = delete $params->{html_body};
5290 my $text_body = delete $params->{text_body};
5292 my $job = delete $params->{'job'};
5294 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
5295 unless ref($params->{'payby'});
5297 my $sql_query = $class->search_sql($params);
5299 my $count_query = delete($sql_query->{'count_query'});
5300 my $count_sth = dbh->prepare($count_query)
5301 or die "Error preparing $count_query: ". dbh->errstr;
5303 or die "Error executing $count_query: ". $count_sth->errstr;
5304 my $count_arrayref = $count_sth->fetchrow_arrayref;
5305 my $num_cust = $count_arrayref->[0];
5307 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
5308 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
5311 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
5313 #eventually order+limit magic to reduce memory use?
5314 foreach my $cust_main ( qsearch($sql_query) ) {
5316 my $to = $cust_main->invoicing_list_emailonly_scalar;
5319 my $error = send_email(
5323 'subject' => $subject,
5324 'html_body' => $html_body,
5325 'text_body' => $text_body,
5328 return $error if $error;
5330 if ( $job ) { #progressbar foo
5332 if ( time - $min_sec > $last ) {
5333 my $error = $job->update_statustext(
5334 int( 100 * $num / $num_cust )
5336 die $error if $error;
5346 use Storable qw(thaw);
5349 sub process_email_search_sql {
5351 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
5353 my $param = thaw(decode_base64(shift));
5354 warn Dumper($param) if $DEBUG;
5356 $param->{'job'} = $job;
5358 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
5359 unless ref($param->{'payby'});
5361 my $error = FS::cust_main->email_search_sql( $param );
5362 die $error if $error;
5366 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5368 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5369 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
5370 specified (the appropriate ship_ field is also searched).
5372 Additional options are the same as FS::Record::qsearch
5377 my( $self, $fuzzy, $hash, @opt) = @_;
5382 check_and_rebuild_fuzzyfiles();
5383 foreach my $field ( keys %$fuzzy ) {
5385 my $all = $self->all_X($field);
5386 next unless scalar(@$all);
5389 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5392 foreach ( keys %match ) {
5393 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5394 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5397 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5400 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5402 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5410 Returns a masked version of the named field
5415 my ($self, $field) = @_;
5419 'x'x(length($self->getfield($field))-4).
5420 substr($self->getfield($field), (length($self->getfield($field))-4));
5430 =item smart_search OPTION => VALUE ...
5432 Accepts the following options: I<search>, the string to search for. The string
5433 will be searched for as a customer number, phone number, name or company name,
5434 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5435 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5436 skip fuzzy matching when an exact match is found.
5438 Any additional options are treated as an additional qualifier on the search
5441 Returns a (possibly empty) array of FS::cust_main objects.
5448 #here is the agent virtualization
5449 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5453 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5454 my $search = delete $options{'search'};
5455 ( my $alphanum_search = $search ) =~ s/\W//g;
5457 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5459 #false laziness w/Record::ut_phone
5460 my $phonen = "$1-$2-$3";
5461 $phonen .= " x$4" if $4;
5463 push @cust_main, qsearch( {
5464 'table' => 'cust_main',
5465 'hashref' => { %options },
5466 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5468 join(' OR ', map "$_ = '$phonen'",
5469 qw( daytime night fax
5470 ship_daytime ship_night ship_fax )
5473 " AND $agentnums_sql", #agent virtualization
5476 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5477 #try looking for matches with extensions unless one was specified
5479 push @cust_main, qsearch( {
5480 'table' => 'cust_main',
5481 'hashref' => { %options },
5482 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5484 join(' OR ', map "$_ LIKE '$phonen\%'",
5486 ship_daytime ship_night )
5489 " AND $agentnums_sql", #agent virtualization
5494 # custnum search (also try agent_custid), with some tweaking options if your
5495 # legacy cust "numbers" have letters
5496 } elsif ( $search =~ /^\s*(\d+)\s*$/
5497 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
5498 && $search =~ /^\s*(\w\w?\d+)\s*$/
5500 || ( $conf->exists('address1-search' )
5501 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
5508 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
5509 push @cust_main, qsearch( {
5510 'table' => 'cust_main',
5511 'hashref' => { 'custnum' => $num, %options },
5512 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5516 push @cust_main, qsearch( {
5517 'table' => 'cust_main',
5518 'hashref' => { 'agent_custid' => $num, %options },
5519 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5522 if ( $conf->exists('address1-search') ) {
5523 my $len = length($num);
5525 foreach my $prefix ( '', 'ship_' ) {
5526 push @cust_main, qsearch( {
5527 'table' => 'cust_main',
5528 'hashref' => { %options, },
5530 ( keys(%options) ? ' AND ' : ' WHERE ' ).
5531 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
5532 " AND $agentnums_sql",
5537 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5539 my($company, $last, $first) = ( $1, $2, $3 );
5541 # "Company (Last, First)"
5542 #this is probably something a browser remembered,
5543 #so just do an exact (but case-insensitive) search
5545 foreach my $prefix ( '', 'ship_' ) {
5546 push @cust_main, qsearch( {
5547 'table' => 'cust_main',
5548 'hashref' => { $prefix.'first' => $first,
5549 $prefix.'last' => $last,
5550 $prefix.'company' => $company,
5553 'extra_sql' => " AND $agentnums_sql",
5557 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5558 # try (ship_){last,company}
5562 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5563 # # full strings the browser remembers won't work
5564 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5566 use Lingua::EN::NameParse;
5567 my $NameParse = new Lingua::EN::NameParse(
5569 allow_reversed => 1,
5572 my($last, $first) = ( '', '' );
5573 #maybe disable this too and just rely on NameParse?
5574 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5576 ($last, $first) = ( $1, $2 );
5578 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5579 } elsif ( ! $NameParse->parse($value) ) {
5581 my %name = $NameParse->components;
5582 $first = $name{'given_name_1'};
5583 $last = $name{'surname_1'};
5587 if ( $first && $last ) {
5589 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5592 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5594 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5595 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5598 push @cust_main, qsearch( {
5599 'table' => 'cust_main',
5600 'hashref' => \%options,
5601 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5604 # or it just be something that was typed in... (try that in a sec)
5608 my $q_value = dbh->quote($value);
5611 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5612 $sql .= " ( LOWER(last) = $q_value
5613 OR LOWER(company) = $q_value
5614 OR LOWER(ship_last) = $q_value
5615 OR LOWER(ship_company) = $q_value
5617 $sql .= " OR LOWER(address1) = $q_value
5618 OR LOWER(ship_address1) = $q_value
5620 if $conf->exists('address1-search');
5623 push @cust_main, qsearch( {
5624 'table' => 'cust_main',
5625 'hashref' => \%options,
5626 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5629 #always do substring & fuzzy,
5630 #getting complains searches are not returning enough
5631 unless ( @cust_main && $skip_fuzzy ) { #no exact match, trying substring/fuzzy
5633 #still some false laziness w/search_sql (was search/cust_main.cgi)
5638 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5639 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5642 if ( $first && $last ) {
5645 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5646 'last' => { op=>'ILIKE', value=>"%$last%" },
5648 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5649 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5656 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5657 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5661 if ( $conf->exists('address1-search') ) {
5663 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
5664 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
5668 foreach my $hashref ( @hashrefs ) {
5670 push @cust_main, qsearch( {
5671 'table' => 'cust_main',
5672 'hashref' => { %$hashref,
5675 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5684 " AND $agentnums_sql", #extra_sql #agent virtualization
5687 if ( $first && $last ) {
5688 push @cust_main, FS::cust_main->fuzzy_search(
5689 { 'last' => $last, #fuzzy hashref
5690 'first' => $first }, #
5694 foreach my $field ( 'last', 'company' ) {
5696 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5698 if ( $conf->exists('address1-search') ) {
5700 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
5707 #eliminate duplicates
5709 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5717 Accepts the following options: I<email>, the email address to search for. The
5718 email address will be searched for as an email invoice destination and as an
5721 #Any additional options are treated as an additional qualifier on the search
5722 #(i.e. I<agentnum>).
5724 Returns a (possibly empty) array of FS::cust_main objects (but usually just
5734 my $email = delete $options{'email'};
5736 #we're only being used by RT at the moment... no agent virtualization yet
5737 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5741 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
5743 my ( $user, $domain ) = ( $1, $2 );
5745 warn "$me smart_search: searching for $user in domain $domain"
5751 'table' => 'cust_main_invoice',
5752 'hashref' => { 'dest' => $email },
5759 map $_->cust_svc->cust_pkg,
5761 'table' => 'svc_acct',
5762 'hashref' => { 'username' => $user, },
5764 'AND ( SELECT domain FROM svc_domain
5765 WHERE svc_acct.domsvc = svc_domain.svcnum
5766 ) = '. dbh->quote($domain),
5772 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5774 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
5781 =item check_and_rebuild_fuzzyfiles
5785 sub check_and_rebuild_fuzzyfiles {
5786 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
5787 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5790 =item rebuild_fuzzyfiles
5794 sub rebuild_fuzzyfiles {
5796 use Fcntl qw(:flock);
5798 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
5799 mkdir $dir, 0700 unless -d $dir;
5801 foreach my $fuzzy ( @fuzzyfields ) {
5803 open(LOCK,">>$dir/cust_main.$fuzzy")
5804 or die "can't open $dir/cust_main.$fuzzy: $!";
5806 or die "can't lock $dir/cust_main.$fuzzy: $!";
5808 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5809 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5811 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5812 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5813 " WHERE $field != '' AND $field IS NOT NULL");
5814 $sth->execute or die $sth->errstr;
5816 while ( my $row = $sth->fetchrow_arrayref ) {
5817 print CACHE $row->[0]. "\n";
5822 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5824 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5835 my( $self, $field ) = @_;
5836 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
5837 open(CACHE,"<$dir/cust_main.$field")
5838 or die "can't open $dir/cust_main.$field: $!";
5839 my @array = map { chomp; $_; } <CACHE>;
5844 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
5848 sub append_fuzzyfiles {
5849 #my( $first, $last, $company ) = @_;
5851 &check_and_rebuild_fuzzyfiles;
5853 use Fcntl qw(:flock);
5855 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
5857 foreach my $field (@fuzzyfields) {
5862 open(CACHE,">>$dir/cust_main.$field")
5863 or die "can't open $dir/cust_main.$field: $!";
5864 flock(CACHE,LOCK_EX)
5865 or die "can't lock $dir/cust_main.$field: $!";
5867 print CACHE "$value\n";
5869 flock(CACHE,LOCK_UN)
5870 or die "can't unlock $dir/cust_main.$field: $!";
5879 =item process_batch_import
5881 Load a batch import as a queued JSRPC job
5885 use Storable qw(thaw);
5888 sub process_batch_import {
5891 my $param = thaw(decode_base64(shift));
5892 warn Dumper($param) if $DEBUG;
5894 my $files = $param->{'uploaded_files'}
5895 or die "No files provided.\n";
5897 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
5899 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
5900 my $file = $dir. $files{'file'};
5903 if ( $file =~ /\.(\w+)$/i ) {
5907 warn "can't parse file type from filename $file; defaulting to CSV";
5912 FS::cust_main::batch_import( {
5916 custbatch => $param->{custbatch},
5917 agentnum => $param->{'agentnum'},
5918 refnum => $param->{'refnum'},
5919 pkgpart => $param->{'pkgpart'},
5920 #'fields' => [qw( cust_pkg.setup dayphone first last address1 address2
5921 # city state zip comments )],
5922 'format' => $param->{'format'},
5927 die "$error\n" if $error;
5935 #some false laziness w/cdr.pm now
5939 my $job = $param->{job};
5941 my $filename = $param->{file};
5942 my $type = $param->{type} || 'csv';
5944 my $custbatch = $param->{custbatch};
5946 my $agentnum = $param->{agentnum};
5947 my $refnum = $param->{refnum};
5948 my $pkgpart = $param->{pkgpart};
5950 my $format = $param->{'format'};
5954 if ( $format eq 'simple' ) {
5955 @fields = qw( cust_pkg.setup dayphone first last
5956 address1 address2 city state zip comments );
5958 } elsif ( $format eq 'extended' ) {
5959 @fields = qw( agent_custid refnum
5960 last first address1 address2 city state zip country
5962 ship_last ship_first ship_address1 ship_address2
5963 ship_city ship_state ship_zip ship_country
5964 payinfo paycvv paydate
5967 svc_acct.username svc_acct._password
5970 } elsif ( $format eq 'extended-plus_company' ) {
5971 @fields = qw( agent_custid refnum
5972 last first company address1 address2 city state zip country
5974 ship_last ship_first ship_company ship_address1 ship_address2
5975 ship_city ship_state ship_zip ship_country
5976 payinfo paycvv paydate
5979 svc_acct.username svc_acct._password
5983 die "unknown format $format";
5989 if ( $type eq 'csv' ) {
5991 eval "use Text::CSV_XS;";
5994 $parser = new Text::CSV_XS;
5996 @buffer = split(/\r?\n/, slurp($filename) );
5997 $count = scalar(@buffer);
5999 } elsif ( $type eq 'xls' ) {
6001 eval "use Spreadsheet::ParseExcel;";
6004 my $excel = new Spreadsheet::ParseExcel::Workbook->Parse($filename);
6005 $parser = $excel->{Worksheet}[0]; #first sheet
6007 $count = $parser->{MaxRow} || $parser->{MinRow};
6011 die "Unknown file type $type\n";
6016 local $SIG{HUP} = 'IGNORE';
6017 local $SIG{INT} = 'IGNORE';
6018 local $SIG{QUIT} = 'IGNORE';
6019 local $SIG{TERM} = 'IGNORE';
6020 local $SIG{TSTP} = 'IGNORE';
6021 local $SIG{PIPE} = 'IGNORE';
6023 my $oldAutoCommit = $FS::UID::AutoCommit;
6024 local $FS::UID::AutoCommit = 0;
6029 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
6033 if ( $type eq 'csv' ) {
6035 last unless scalar(@buffer);
6036 $line = shift(@buffer);
6038 $parser->parse($line) or do {
6039 $dbh->rollback if $oldAutoCommit;
6040 return "can't parse: ". $parser->error_input();
6042 @columns = $parser->fields();
6044 } elsif ( $type eq 'xls' ) {
6046 last if $row > ($parser->{MaxRow} || $parser->{MinRow});
6048 my @row = @{ $parser->{Cells}[$row] };
6049 @columns = map $_->{Val}, @row;
6052 #warn $z++. ": $_\n" for @columns;
6055 die "Unknown file type $type\n";
6058 #warn join('-',@columns);
6061 custbatch => $custbatch,
6062 agentnum => $agentnum,
6064 country => $conf->config('countrydefault') || 'US',
6065 payby => $payby, #default
6066 paydate => '12/2037', #default
6068 my $billtime = time;
6069 my %cust_pkg = ( pkgpart => $pkgpart );
6071 foreach my $field ( @fields ) {
6073 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
6075 #$cust_pkg{$1} = str2time( shift @$columns );
6076 if ( $1 eq 'pkgpart' ) {
6077 $cust_pkg{$1} = shift @columns;
6078 } elsif ( $1 eq 'setup' ) {
6079 $billtime = str2time(shift @columns);
6081 $cust_pkg{$1} = str2time( shift @columns );
6084 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
6086 $svc_acct{$1} = shift @columns;
6090 #refnum interception
6091 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
6093 my $referral = $columns[0];
6094 my %hash = ( 'referral' => $referral,
6095 'agentnum' => $agentnum,
6099 my $part_referral = qsearchs('part_referral', \%hash )
6100 || new FS::part_referral \%hash;
6102 unless ( $part_referral->refnum ) {
6103 my $error = $part_referral->insert;
6105 $dbh->rollback if $oldAutoCommit;
6106 return "can't auto-insert advertising source: $referral: $error";
6110 $columns[0] = $part_referral->refnum;
6113 my $value = shift @columns;
6114 $cust_main{$field} = $value if length($value);
6118 $cust_main{'payby'} = 'CARD'
6119 if defined $cust_main{'payinfo'}
6120 && length $cust_main{'payinfo'};
6122 my $invoicing_list = $cust_main{'invoicing_list'}
6123 ? [ delete $cust_main{'invoicing_list'} ]
6126 my $cust_main = new FS::cust_main ( \%cust_main );
6129 tie my %hash, 'Tie::RefHash'; #this part is important
6131 if ( $cust_pkg{'pkgpart'} ) {
6132 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
6135 if ( $svc_acct{'username'} ) {
6136 my $part_pkg = $cust_pkg->part_pkg;
6137 unless ( $part_pkg ) {
6138 $dbh->rollback if $oldAutoCommit;
6139 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
6141 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
6142 push @svc_acct, new FS::svc_acct ( \%svc_acct )
6145 $hash{$cust_pkg} = \@svc_acct;
6148 my $error = $cust_main->insert( \%hash, $invoicing_list );
6151 $dbh->rollback if $oldAutoCommit;
6152 return "can't insert customer". ( $line ? " for $line" : '' ). ": $error";
6155 if ( $format eq 'simple' ) {
6157 #false laziness w/bill.cgi
6158 $error = $cust_main->bill( 'time' => $billtime );
6160 $dbh->rollback if $oldAutoCommit;
6161 return "can't bill customer for $line: $error";
6164 $error = $cust_main->apply_payments_and_credits;
6166 $dbh->rollback if $oldAutoCommit;
6167 return "can't bill customer for $line: $error";
6170 $error = $cust_main->collect();
6172 $dbh->rollback if $oldAutoCommit;
6173 return "can't collect customer for $line: $error";
6180 if ( $job && time - $min_sec > $last ) { #progress bar
6181 $job->update_statustext( int(100 * $row / $count) );
6187 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
6189 return "Empty file!" unless $row;
6201 #warn join('-',keys %$param);
6202 my $fh = $param->{filehandle};
6203 my @fields = @{$param->{fields}};
6205 eval "use Text::CSV_XS;";
6208 my $csv = new Text::CSV_XS;
6215 local $SIG{HUP} = 'IGNORE';
6216 local $SIG{INT} = 'IGNORE';
6217 local $SIG{QUIT} = 'IGNORE';
6218 local $SIG{TERM} = 'IGNORE';
6219 local $SIG{TSTP} = 'IGNORE';
6220 local $SIG{PIPE} = 'IGNORE';
6222 my $oldAutoCommit = $FS::UID::AutoCommit;
6223 local $FS::UID::AutoCommit = 0;
6226 #while ( $columns = $csv->getline($fh) ) {
6228 while ( defined($line=<$fh>) ) {
6230 $csv->parse($line) or do {
6231 $dbh->rollback if $oldAutoCommit;
6232 return "can't parse: ". $csv->error_input();
6235 my @columns = $csv->fields();
6236 #warn join('-',@columns);
6239 foreach my $field ( @fields ) {
6240 $row{$field} = shift @columns;
6243 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
6244 unless ( $cust_main ) {
6245 $dbh->rollback if $oldAutoCommit;
6246 return "unknown custnum $row{'custnum'}";
6249 if ( $row{'amount'} > 0 ) {
6250 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
6252 $dbh->rollback if $oldAutoCommit;
6256 } elsif ( $row{'amount'} < 0 ) {
6257 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
6260 $dbh->rollback if $oldAutoCommit;
6270 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6272 return "Empty file!" unless $imported;
6278 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6280 Sends a templated email notification to the customer (see L<Text::Template>).
6282 OPTIONS is a hash and may include
6284 I<from> - the email sender (default is invoice_from)
6286 I<to> - comma-separated scalar or arrayref of recipients
6287 (default is invoicing_list)
6289 I<subject> - The subject line of the sent email notification
6290 (default is "Notice from company_name")
6292 I<extra_fields> - a hashref of name/value pairs which will be substituted
6295 The following variables are vavailable in the template.
6297 I<$first> - the customer first name
6298 I<$last> - the customer last name
6299 I<$company> - the customer company
6300 I<$payby> - a description of the method of payment for the customer
6301 # would be nice to use FS::payby::shortname
6302 I<$payinfo> - the account information used to collect for this customer
6303 I<$expdate> - the expiration of the customer payment in seconds from epoch
6308 my ($customer, $template, %options) = @_;
6310 return unless $conf->exists($template);
6312 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6313 $from = $options{from} if exists($options{from});
6315 my $to = join(',', $customer->invoicing_list_emailonly);
6316 $to = $options{to} if exists($options{to});
6318 my $subject = "Notice from " . $conf->config('company_name')
6319 if $conf->exists('company_name');
6320 $subject = $options{subject} if exists($options{subject});
6322 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6323 SOURCE => [ map "$_\n",
6324 $conf->config($template)]
6326 or die "can't create new Text::Template object: Text::Template::ERROR";
6327 $notify_template->compile()
6328 or die "can't compile template: Text::Template::ERROR";
6330 my $paydate = $customer->paydate || '2037-12-31';
6331 $FS::notify_template::_template::first = $customer->first;
6332 $FS::notify_template::_template::last = $customer->last;
6333 $FS::notify_template::_template::company = $customer->company;
6334 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6335 my $payby = $customer->payby;
6336 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6337 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6339 #credit cards expire at the end of the month/year of their exp date
6340 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6341 $FS::notify_template::_template::payby = 'credit card';
6342 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6343 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6345 }elsif ($payby eq 'COMP') {
6346 $FS::notify_template::_template::payby = 'complimentary account';
6348 $FS::notify_template::_template::payby = 'current method';
6350 $FS::notify_template::_template::expdate = $expire_time;
6352 for (keys %{$options{extra_fields}}){
6354 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6357 send_email(from => $from,
6359 subject => $subject,
6360 body => $notify_template->fill_in( PACKAGE =>
6361 'FS::notify_template::_template' ),
6366 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6368 Generates a templated notification to the customer (see L<Text::Template>).
6370 OPTIONS is a hash and may include
6372 I<extra_fields> - a hashref of name/value pairs which will be substituted
6373 into the template. These values may override values mentioned below
6374 and those from the customer record.
6376 The following variables are available in the template instead of or in addition
6377 to the fields of the customer record.
6379 I<$payby> - a description of the method of payment for the customer
6380 # would be nice to use FS::payby::shortname
6381 I<$payinfo> - the masked account information used to collect for this customer
6382 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6383 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
6387 sub generate_letter {
6388 my ($self, $template, %options) = @_;
6390 return unless $conf->exists($template);
6392 my $letter_template = new Text::Template
6394 SOURCE => [ map "$_\n", $conf->config($template)],
6395 DELIMITERS => [ '[@--', '--@]' ],
6397 or die "can't create new Text::Template object: Text::Template::ERROR";
6399 $letter_template->compile()
6400 or die "can't compile template: Text::Template::ERROR";
6402 my %letter_data = map { $_ => $self->$_ } $self->fields;
6403 $letter_data{payinfo} = $self->mask_payinfo;
6405 my $paydate = $self->paydate || '2037-12-31';
6406 my $payby = $self->payby;
6407 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6408 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6410 #credit cards expire at the end of the month/year of their exp date
6411 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6412 $letter_data{payby} = 'credit card';
6413 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6414 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6416 }elsif ($payby eq 'COMP') {
6417 $letter_data{payby} = 'complimentary account';
6419 $letter_data{payby} = 'current method';
6421 $letter_data{expdate} = $expire_time;
6423 for (keys %{$options{extra_fields}}){
6424 $letter_data{$_} = $options{extra_fields}->{$_};
6427 unless(exists($letter_data{returnaddress})){
6428 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6429 $self->_agent_template)
6432 $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
6435 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6437 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6438 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6442 ) or die "can't open temp file: $!\n";
6444 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6446 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6450 =item print_ps TEMPLATE
6452 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6458 my $file = $self->generate_letter(@_);
6459 FS::Misc::generate_ps($file);
6462 =item print TEMPLATE
6464 Prints the filled in template.
6466 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6470 sub queueable_print {
6473 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6474 or die "invalid customer number: " . $opt{custvnum};
6476 my $error = $self->print( $opt{template} );
6477 die $error if $error;
6481 my ($self, $template) = (shift, shift);
6482 do_print [ $self->print_ps($template) ];
6485 sub agent_template {
6487 $self->_agent_plandata('agent_templatename');
6490 sub agent_invoice_from {
6492 $self->_agent_plandata('agent_invoice_from');
6495 sub _agent_plandata {
6496 my( $self, $option ) = @_;
6499 if ( driver_name =~ /^Pg/i ) {
6501 } elsif ( driver_name =~ /^mysql/i ) {
6504 die "don't know how to use regular expressions in ". driver_name. " databases";
6507 my $part_bill_event = qsearchs( 'part_bill_event',
6509 'payby' => $self->payby,
6510 'plan' => 'send_agent',
6511 'plandata' => { 'op' => $regexp,
6512 'value' => "(^|\n)agentnum ".
6520 'ORDER BY seconds LIMIT 1'
6523 return '' unless $part_bill_event;
6525 if ( $part_bill_event->plandata =~ /^$option (.*)$/m ) {
6528 warn "can't parse part_bill_event eventpart#". $part_bill_event->eventpart.
6529 " plandata for $option";
6536 ## actual sub, not a method, designed to be called from the queue.
6537 ## sets up the customer, and calls the bill_and_collect
6538 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6539 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6540 $cust_main->bill_and_collect(
6545 sub _upgrade_data { #class method
6546 my ($class, %opts) = @_;
6548 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
6549 my $sth = dbh->prepare($sql) or die dbh->errstr;
6550 $sth->execute or die $sth->errstr;
6560 The delete method should possibly take an FS::cust_main object reference
6561 instead of a scalar customer number.
6563 Bill and collect options should probably be passed as references instead of a
6566 There should probably be a configuration file with a list of allowed credit
6569 No multiple currency support (probably a larger project than just this module).
6571 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6573 Birthdates rely on negative epoch values.
6575 The payby for card/check batches is broken. With mixed batching, bad
6580 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6581 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6582 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.