5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
6 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
7 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 use Scalar::Util qw( blessed );
12 use Time::Local qw(timelocal_nocheck);
15 use Digest::MD5 qw(md5_base64);
19 use String::Approx qw(amatch);
20 use Business::CreditCard 0.28;
23 use FS::UID qw( getotaker dbh driver_name );
24 use FS::Record qw( qsearchs qsearch dbdef );
25 use FS::Misc qw( generate_email send_email generate_ps do_print );
26 use FS::Msgcat qw(gettext);
30 use FS::cust_bill_pkg;
32 use FS::cust_pay_pending;
33 use FS::cust_pay_void;
34 use FS::cust_pay_batch;
37 use FS::part_referral;
38 use FS::cust_main_county;
40 use FS::cust_main_invoice;
41 use FS::cust_credit_bill;
42 use FS::cust_bill_pay;
43 use FS::prepay_credit;
47 use FS::part_event_condition;
50 use FS::payment_gateway;
51 use FS::agent_payment_gateway;
53 use FS::payinfo_Mixin;
56 @ISA = qw( FS::Record FS::payinfo_Mixin );
58 @EXPORT_OK = qw( smart_search );
60 $realtime_bop_decline_quiet = 0;
62 # 1 is mostly method/subroutine entry and options
63 # 2 traces progress of some operations
64 # 3 is even more information including possibly sensitive data
66 $me = '[FS::cust_main]';
70 $ignore_expired_card = 0;
72 @encrypted_fields = ('payinfo', 'paycvv');
73 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
75 #ask FS::UID to run this stuff for us later
76 #$FS::UID::callback{'FS::cust_main'} = sub {
77 install_callback FS::UID sub {
79 #yes, need it for stuff below (prolly should be cached)
84 my ( $hashref, $cache ) = @_;
85 if ( exists $hashref->{'pkgnum'} ) {
86 #@{ $self->{'_pkgnum'} } = ();
87 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
88 $self->{'_pkgnum'} = $subcache;
89 #push @{ $self->{'_pkgnum'} },
90 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
96 FS::cust_main - Object methods for cust_main records
102 $record = new FS::cust_main \%hash;
103 $record = new FS::cust_main { 'column' => 'value' };
105 $error = $record->insert;
107 $error = $new_record->replace($old_record);
109 $error = $record->delete;
111 $error = $record->check;
113 @cust_pkg = $record->all_pkgs;
115 @cust_pkg = $record->ncancelled_pkgs;
117 @cust_pkg = $record->suspended_pkgs;
119 $error = $record->bill;
120 $error = $record->bill %options;
121 $error = $record->bill 'time' => $time;
123 $error = $record->collect;
124 $error = $record->collect %options;
125 $error = $record->collect 'invoice_time' => $time,
130 An FS::cust_main object represents a customer. FS::cust_main inherits from
131 FS::Record. The following fields are currently supported:
135 =item custnum - primary key (assigned automatically for new customers)
137 =item agentnum - agent (see L<FS::agent>)
139 =item refnum - Advertising source (see L<FS::part_referral>)
145 =item ss - social security number (optional)
147 =item company - (optional)
151 =item address2 - (optional)
155 =item county - (optional, see L<FS::cust_main_county>)
157 =item state - (see L<FS::cust_main_county>)
161 =item country - (see L<FS::cust_main_county>)
163 =item daytime - phone (optional)
165 =item night - phone (optional)
167 =item fax - phone (optional)
169 =item ship_first - name
171 =item ship_last - name
173 =item ship_company - (optional)
177 =item ship_address2 - (optional)
181 =item ship_county - (optional, see L<FS::cust_main_county>)
183 =item ship_state - (see L<FS::cust_main_county>)
187 =item ship_country - (see L<FS::cust_main_county>)
189 =item ship_daytime - phone (optional)
191 =item ship_night - phone (optional)
193 =item ship_fax - phone (optional)
195 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
197 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
199 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
203 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
205 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
207 =item paystart_month - start date month (maestro/solo cards only)
209 =item paystart_year - start date year (maestro/solo cards only)
211 =item payissue - issue number (maestro/solo cards only)
213 =item payname - name on card or billing name
215 =item payip - IP address from which payment information was received
217 =item tax - tax exempt, empty or `Y'
219 =item otaker - order taker (assigned automatically, see L<FS::UID>)
221 =item comments - comments (optional)
223 =item referral_custnum - referring customer number
225 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
235 Creates a new customer. To add the customer to the database, see L<"insert">.
237 Note that this stores the hash reference, not a distinct copy of the hash it
238 points to. You can ask the object for a copy with the I<hash> method.
242 sub table { 'cust_main'; }
244 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
246 Adds this customer to the database. If there is an error, returns the error,
247 otherwise returns false.
249 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
250 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
251 are inserted atomicly, or the transaction is rolled back. Passing an empty
252 hash reference is equivalent to not supplying this parameter. There should be
253 a better explanation of this, but until then, here's an example:
256 tie %hash, 'Tie::RefHash'; #this part is important
258 $cust_pkg => [ $svc_acct ],
261 $cust_main->insert( \%hash );
263 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
264 be set as the invoicing list (see L<"invoicing_list">). Errors return as
265 expected and rollback the entire transaction; it is not necessary to call
266 check_invoicing_list first. The invoicing_list is set after the records in the
267 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
268 invoicing_list destination to the newly-created svc_acct. Here's an example:
270 $cust_main->insert( {}, [ $email, 'POST' ] );
272 Currently available options are: I<depend_jobnum> and I<noexport>.
274 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
275 on the supplied jobnum (they will not run until the specific job completes).
276 This can be used to defer provisioning until some action completes (such
277 as running the customer's credit card successfully).
279 The I<noexport> option is deprecated. If I<noexport> is set true, no
280 provisioning jobs (exports) are scheduled. (You can schedule them later with
281 the B<reexport> method.)
287 my $cust_pkgs = @_ ? shift : {};
288 my $invoicing_list = @_ ? shift : '';
290 warn "$me insert called with options ".
291 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
294 local $SIG{HUP} = 'IGNORE';
295 local $SIG{INT} = 'IGNORE';
296 local $SIG{QUIT} = 'IGNORE';
297 local $SIG{TERM} = 'IGNORE';
298 local $SIG{TSTP} = 'IGNORE';
299 local $SIG{PIPE} = 'IGNORE';
301 my $oldAutoCommit = $FS::UID::AutoCommit;
302 local $FS::UID::AutoCommit = 0;
305 my $prepay_identifier = '';
306 my( $amount, $seconds ) = ( 0, 0 );
308 if ( $self->payby eq 'PREPAY' ) {
310 $self->payby('BILL');
311 $prepay_identifier = $self->payinfo;
314 warn " looking up prepaid card $prepay_identifier\n"
317 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
319 $dbh->rollback if $oldAutoCommit;
320 #return "error applying prepaid card (transaction rolled back): $error";
324 $payby = 'PREP' if $amount;
326 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
329 $self->payby('BILL');
330 $amount = $self->paid;
334 warn " inserting $self\n"
337 $self->signupdate(time) unless $self->signupdate;
339 my $error = $self->SUPER::insert;
341 $dbh->rollback if $oldAutoCommit;
342 #return "inserting cust_main record (transaction rolled back): $error";
346 warn " setting invoicing list\n"
349 if ( $invoicing_list ) {
350 $error = $self->check_invoicing_list( $invoicing_list );
352 $dbh->rollback if $oldAutoCommit;
353 #return "checking invoicing_list (transaction rolled back): $error";
356 $self->invoicing_list( $invoicing_list );
359 if ( $conf->config('cust_main-skeleton_tables')
360 && $conf->config('cust_main-skeleton_custnum') ) {
362 warn " inserting skeleton records\n"
365 my $error = $self->start_copy_skel;
367 $dbh->rollback if $oldAutoCommit;
373 warn " ordering packages\n"
376 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
378 $dbh->rollback if $oldAutoCommit;
383 $dbh->rollback if $oldAutoCommit;
384 return "No svc_acct record to apply pre-paid time";
388 warn " inserting initial $payby payment of $amount\n"
390 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
392 $dbh->rollback if $oldAutoCommit;
393 return "inserting payment (transaction rolled back): $error";
397 unless ( $import || $skip_fuzzyfiles ) {
398 warn " queueing fuzzyfiles update\n"
400 $error = $self->queue_fuzzyfiles_update;
402 $dbh->rollback if $oldAutoCommit;
403 return "updating fuzzy search cache: $error";
407 warn " insert complete; committing transaction\n"
410 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
415 sub start_copy_skel {
418 #'mg_user_preference' => {},
419 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
420 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
421 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
422 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
423 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
426 _copy_skel( 'cust_main', #tablename
427 $conf->config('cust_main-skeleton_custnum'), #sourceid
428 $self->custnum, #destid
429 @tables, #child tables
433 #recursive subroutine, not a method
435 my( $table, $sourceid, $destid, %child_tables ) = @_;
438 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
439 ( $table, $primary_key ) = ( $1, $2 );
441 my $dbdef_table = dbdef->table($table);
442 $primary_key = $dbdef_table->primary_key
443 or return "$table has no primary key".
444 " (or do you need to run dbdef-create?)";
447 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
448 join (', ', keys %child_tables). "\n"
451 foreach my $child_table_def ( keys %child_tables ) {
455 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
456 ( $child_table, $child_pkey ) = ( $1, $2 );
458 $child_table = $child_table_def;
460 $child_pkey = dbdef->table($child_table)->primary_key;
461 # or return "$table has no primary key".
462 # " (or do you need to run dbdef-create?)\n";
466 if ( keys %{ $child_tables{$child_table_def} } ) {
468 return "$child_table has no primary key".
469 " (run dbdef-create or try specifying it?)\n"
472 #false laziness w/Record::insert and only works on Pg
473 #refactor the proper last-inserted-id stuff out of Record::insert if this
474 # ever gets use for anything besides a quick kludge for one customer
475 my $default = dbdef->table($child_table)->column($child_pkey)->default;
476 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
477 or return "can't parse $child_table.$child_pkey default value ".
478 " for sequence name: $default";
483 my @sel_columns = grep { $_ ne $primary_key }
484 dbdef->table($child_table)->columns;
485 my $sel_columns = join(', ', @sel_columns );
487 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
488 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
489 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
491 my $sel_st = "SELECT $sel_columns FROM $child_table".
492 " WHERE $primary_key = $sourceid";
495 my $sel_sth = dbh->prepare( $sel_st )
496 or return dbh->errstr;
498 $sel_sth->execute or return $sel_sth->errstr;
500 while ( my $row = $sel_sth->fetchrow_hashref ) {
502 warn " selected row: ".
503 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
507 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
508 my $ins_sth =dbh->prepare($statement)
509 or return dbh->errstr;
510 my @param = ( $destid, map $row->{$_}, @ins_columns );
511 warn " $statement: [ ". join(', ', @param). " ]\n"
513 $ins_sth->execute( @param )
514 or return $ins_sth->errstr;
516 #next unless keys %{ $child_tables{$child_table} };
517 next unless $sequence;
519 #another section of that laziness
520 my $seq_sql = "SELECT currval('$sequence')";
521 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
522 $seq_sth->execute or return $seq_sth->errstr;
523 my $insertid = $seq_sth->fetchrow_arrayref->[0];
525 # don't drink soap! recurse! recurse! okay!
527 _copy_skel( $child_table_def,
528 $row->{$child_pkey}, #sourceid
530 %{ $child_tables{$child_table_def} },
532 return $error if $error;
542 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
544 Like the insert method on an existing record, this method orders a package
545 and included services atomicaly. Pass a Tie::RefHash data structure to this
546 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
547 be a better explanation of this, but until then, here's an example:
550 tie %hash, 'Tie::RefHash'; #this part is important
552 $cust_pkg => [ $svc_acct ],
555 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
557 Services can be new, in which case they are inserted, or existing unaudited
558 services, in which case they are linked to the newly-created package.
560 Currently available options are: I<depend_jobnum> and I<noexport>.
562 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
563 on the supplied jobnum (they will not run until the specific job completes).
564 This can be used to defer provisioning until some action completes (such
565 as running the customer's credit card successfully).
567 The I<noexport> option is deprecated. If I<noexport> is set true, no
568 provisioning jobs (exports) are scheduled. (You can schedule them later with
569 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
570 on the cust_main object is not recommended, as existing services will also be
577 my $cust_pkgs = shift;
580 my %svc_options = ();
581 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
582 if exists $options{'depend_jobnum'};
583 warn "$me order_pkgs called with options ".
584 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
587 local $SIG{HUP} = 'IGNORE';
588 local $SIG{INT} = 'IGNORE';
589 local $SIG{QUIT} = 'IGNORE';
590 local $SIG{TERM} = 'IGNORE';
591 local $SIG{TSTP} = 'IGNORE';
592 local $SIG{PIPE} = 'IGNORE';
594 my $oldAutoCommit = $FS::UID::AutoCommit;
595 local $FS::UID::AutoCommit = 0;
598 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
600 foreach my $cust_pkg ( keys %$cust_pkgs ) {
601 $cust_pkg->custnum( $self->custnum );
602 my $error = $cust_pkg->insert;
604 $dbh->rollback if $oldAutoCommit;
605 return "inserting cust_pkg (transaction rolled back): $error";
607 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
608 if ( $svc_something->svcnum ) {
609 my $old_cust_svc = $svc_something->cust_svc;
610 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
611 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
612 $error = $new_cust_svc->replace($old_cust_svc);
614 $svc_something->pkgnum( $cust_pkg->pkgnum );
615 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
616 $svc_something->seconds( $svc_something->seconds + $$seconds );
619 $error = $svc_something->insert(%svc_options);
622 $dbh->rollback if $oldAutoCommit;
623 #return "inserting svc_ (transaction rolled back): $error";
629 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
633 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
635 Recharges this (existing) customer with the specified prepaid card (see
636 L<FS::prepay_credit>), specified either by I<identifier> or as an
637 FS::prepay_credit object. If there is an error, returns the error, otherwise
640 Optionally, four scalar references can be passed as well. They will have their
641 values filled in with the amount, number of seconds, and number of upload and
642 download bytes applied by this prepaid
647 sub recharge_prepay {
648 my( $self, $prepay_credit, $amountref, $secondsref,
649 $upbytesref, $downbytesref, $totalbytesref ) = @_;
651 local $SIG{HUP} = 'IGNORE';
652 local $SIG{INT} = 'IGNORE';
653 local $SIG{QUIT} = 'IGNORE';
654 local $SIG{TERM} = 'IGNORE';
655 local $SIG{TSTP} = 'IGNORE';
656 local $SIG{PIPE} = 'IGNORE';
658 my $oldAutoCommit = $FS::UID::AutoCommit;
659 local $FS::UID::AutoCommit = 0;
662 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
664 my $error = $self->get_prepay($prepay_credit, \$amount,
665 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
666 || $self->increment_seconds($seconds)
667 || $self->increment_upbytes($upbytes)
668 || $self->increment_downbytes($downbytes)
669 || $self->increment_totalbytes($totalbytes)
670 || $self->insert_cust_pay_prepay( $amount,
672 ? $prepay_credit->identifier
677 $dbh->rollback if $oldAutoCommit;
681 if ( defined($amountref) ) { $$amountref = $amount; }
682 if ( defined($secondsref) ) { $$secondsref = $seconds; }
683 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
684 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
685 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
687 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
692 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
694 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
695 specified either by I<identifier> or as an FS::prepay_credit object.
697 References to I<amount> and I<seconds> scalars should be passed as arguments
698 and will be incremented by the values of the prepaid card.
700 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
701 check or set this customer's I<agentnum>.
703 If there is an error, returns the error, otherwise returns false.
709 my( $self, $prepay_credit, $amountref, $secondsref,
710 $upref, $downref, $totalref) = @_;
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 unless ( ref($prepay_credit) ) {
725 my $identifier = $prepay_credit;
727 $prepay_credit = qsearchs(
729 { 'identifier' => $prepay_credit },
734 unless ( $prepay_credit ) {
735 $dbh->rollback if $oldAutoCommit;
736 return "Invalid prepaid card: ". $identifier;
741 if ( $prepay_credit->agentnum ) {
742 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
743 $dbh->rollback if $oldAutoCommit;
744 return "prepaid card not valid for agent ". $self->agentnum;
746 $self->agentnum($prepay_credit->agentnum);
749 my $error = $prepay_credit->delete;
751 $dbh->rollback if $oldAutoCommit;
752 return "removing prepay_credit (transaction rolled back): $error";
755 $$amountref += $prepay_credit->amount;
756 $$secondsref += $prepay_credit->seconds;
757 $$upref += $prepay_credit->upbytes;
758 $$downref += $prepay_credit->downbytes;
759 $$totalref += $prepay_credit->totalbytes;
761 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
766 =item increment_upbytes SECONDS
768 Updates this customer's single or primary account (see L<FS::svc_acct>) by
769 the specified number of upbytes. If there is an error, returns the error,
770 otherwise returns false.
774 sub increment_upbytes {
775 _increment_column( shift, 'upbytes', @_);
778 =item increment_downbytes SECONDS
780 Updates this customer's single or primary account (see L<FS::svc_acct>) by
781 the specified number of downbytes. If there is an error, returns the error,
782 otherwise returns false.
786 sub increment_downbytes {
787 _increment_column( shift, 'downbytes', @_);
790 =item increment_totalbytes SECONDS
792 Updates this customer's single or primary account (see L<FS::svc_acct>) by
793 the specified number of totalbytes. If there is an error, returns the error,
794 otherwise returns false.
798 sub increment_totalbytes {
799 _increment_column( shift, 'totalbytes', @_);
802 =item increment_seconds SECONDS
804 Updates this customer's single or primary account (see L<FS::svc_acct>) by
805 the specified number of seconds. If there is an error, returns the error,
806 otherwise returns false.
810 sub increment_seconds {
811 _increment_column( shift, 'seconds', @_);
814 =item _increment_column AMOUNT
816 Updates this customer's single or primary account (see L<FS::svc_acct>) by
817 the specified number of seconds or bytes. If there is an error, returns
818 the error, otherwise returns false.
822 sub _increment_column {
823 my( $self, $column, $amount ) = @_;
824 warn "$me increment_column called: $column, $amount\n"
827 return '' unless $amount;
829 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
830 $self->ncancelled_pkgs;
833 return 'No packages with primary or single services found'.
834 ' to apply pre-paid time';
835 } elsif ( scalar(@cust_pkg) > 1 ) {
836 #maybe have a way to specify the package/account?
837 return 'Multiple packages found to apply pre-paid time';
840 my $cust_pkg = $cust_pkg[0];
841 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
845 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
848 return 'No account found to apply pre-paid time';
849 } elsif ( scalar(@cust_svc) > 1 ) {
850 return 'Multiple accounts found to apply pre-paid time';
853 my $svc_acct = $cust_svc[0]->svc_x;
854 warn " found service svcnum ". $svc_acct->pkgnum.
855 ' ('. $svc_acct->email. ")\n"
858 $column = "increment_$column";
859 $svc_acct->$column($amount);
863 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
865 Inserts a prepayment in the specified amount for this customer. An optional
866 second argument can specify the prepayment identifier for tracking purposes.
867 If there is an error, returns the error, otherwise returns false.
871 sub insert_cust_pay_prepay {
872 shift->insert_cust_pay('PREP', @_);
875 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
877 Inserts a cash payment in the specified amount for this customer. An optional
878 second argument can specify the payment identifier for tracking purposes.
879 If there is an error, returns the error, otherwise returns false.
883 sub insert_cust_pay_cash {
884 shift->insert_cust_pay('CASH', @_);
887 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
889 Inserts a Western Union payment in the specified amount for this customer. An
890 optional second argument can specify the prepayment identifier for tracking
891 purposes. If there is an error, returns the error, otherwise returns false.
895 sub insert_cust_pay_west {
896 shift->insert_cust_pay('WEST', @_);
899 sub insert_cust_pay {
900 my( $self, $payby, $amount ) = splice(@_, 0, 3);
901 my $payinfo = scalar(@_) ? shift : '';
903 my $cust_pay = new FS::cust_pay {
904 'custnum' => $self->custnum,
905 'paid' => sprintf('%.2f', $amount),
906 #'_date' => #date the prepaid card was purchased???
908 'payinfo' => $payinfo,
916 This method is deprecated. See the I<depend_jobnum> option to the insert and
917 order_pkgs methods for a better way to defer provisioning.
919 Re-schedules all exports by calling the B<reexport> method of all associated
920 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
921 otherwise returns false.
928 carp "WARNING: FS::cust_main::reexport is deprectated; ".
929 "use the depend_jobnum option to insert or order_pkgs to delay export";
931 local $SIG{HUP} = 'IGNORE';
932 local $SIG{INT} = 'IGNORE';
933 local $SIG{QUIT} = 'IGNORE';
934 local $SIG{TERM} = 'IGNORE';
935 local $SIG{TSTP} = 'IGNORE';
936 local $SIG{PIPE} = 'IGNORE';
938 my $oldAutoCommit = $FS::UID::AutoCommit;
939 local $FS::UID::AutoCommit = 0;
942 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
943 my $error = $cust_pkg->reexport;
945 $dbh->rollback if $oldAutoCommit;
950 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
955 =item delete NEW_CUSTNUM
957 This deletes the customer. If there is an error, returns the error, otherwise
960 This will completely remove all traces of the customer record. This is not
961 what you want when a customer cancels service; for that, cancel all of the
962 customer's packages (see L</cancel>).
964 If the customer has any uncancelled packages, you need to pass a new (valid)
965 customer number for those packages to be transferred to. Cancelled packages
966 will be deleted. Did I mention that this is NOT what you want when a customer
967 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
969 You can't delete a customer with invoices (see L<FS::cust_bill>),
970 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
971 refunds (see L<FS::cust_refund>).
978 local $SIG{HUP} = 'IGNORE';
979 local $SIG{INT} = 'IGNORE';
980 local $SIG{QUIT} = 'IGNORE';
981 local $SIG{TERM} = 'IGNORE';
982 local $SIG{TSTP} = 'IGNORE';
983 local $SIG{PIPE} = 'IGNORE';
985 my $oldAutoCommit = $FS::UID::AutoCommit;
986 local $FS::UID::AutoCommit = 0;
989 if ( $self->cust_bill ) {
990 $dbh->rollback if $oldAutoCommit;
991 return "Can't delete a customer with invoices";
993 if ( $self->cust_credit ) {
994 $dbh->rollback if $oldAutoCommit;
995 return "Can't delete a customer with credits";
997 if ( $self->cust_pay ) {
998 $dbh->rollback if $oldAutoCommit;
999 return "Can't delete a customer with payments";
1001 if ( $self->cust_refund ) {
1002 $dbh->rollback if $oldAutoCommit;
1003 return "Can't delete a customer with refunds";
1006 my @cust_pkg = $self->ncancelled_pkgs;
1008 my $new_custnum = shift;
1009 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1010 $dbh->rollback if $oldAutoCommit;
1011 return "Invalid new customer number: $new_custnum";
1013 foreach my $cust_pkg ( @cust_pkg ) {
1014 my %hash = $cust_pkg->hash;
1015 $hash{'custnum'} = $new_custnum;
1016 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1017 my $error = $new_cust_pkg->replace($cust_pkg,
1018 options => { $cust_pkg->options },
1021 $dbh->rollback if $oldAutoCommit;
1026 my @cancelled_cust_pkg = $self->all_pkgs;
1027 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1028 my $error = $cust_pkg->delete;
1030 $dbh->rollback if $oldAutoCommit;
1035 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1036 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1038 my $error = $cust_main_invoice->delete;
1040 $dbh->rollback if $oldAutoCommit;
1045 my $error = $self->SUPER::delete;
1047 $dbh->rollback if $oldAutoCommit;
1051 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1056 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ]
1058 Replaces the OLD_RECORD with this one in the database. If there is an error,
1059 returns the error, otherwise returns false.
1061 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1062 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1063 expected and rollback the entire transaction; it is not necessary to call
1064 check_invoicing_list first. Here's an example:
1066 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1073 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1075 : $self->replace_old;
1079 warn "$me replace called\n"
1082 my $curuser = $FS::CurrentUser::CurrentUser;
1083 if ( $self->payby eq 'COMP'
1084 && $self->payby ne $old->payby
1085 && ! $curuser->access_right('Complimentary customer')
1088 return "You are not permitted to create complimentary accounts.";
1091 local($ignore_expired_card) = 1
1092 if $old->payby =~ /^(CARD|DCRD)$/
1093 && $self->payby =~ /^(CARD|DCRD)$/
1094 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1096 local $SIG{HUP} = 'IGNORE';
1097 local $SIG{INT} = 'IGNORE';
1098 local $SIG{QUIT} = 'IGNORE';
1099 local $SIG{TERM} = 'IGNORE';
1100 local $SIG{TSTP} = 'IGNORE';
1101 local $SIG{PIPE} = 'IGNORE';
1103 my $oldAutoCommit = $FS::UID::AutoCommit;
1104 local $FS::UID::AutoCommit = 0;
1107 my $error = $self->SUPER::replace($old);
1110 $dbh->rollback if $oldAutoCommit;
1114 if ( @param ) { # INVOICING_LIST_ARYREF
1115 my $invoicing_list = shift @param;
1116 $error = $self->check_invoicing_list( $invoicing_list );
1118 $dbh->rollback if $oldAutoCommit;
1121 $self->invoicing_list( $invoicing_list );
1124 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1125 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1126 # card/check/lec info has changed, want to retry realtime_ invoice events
1127 my $error = $self->retry_realtime;
1129 $dbh->rollback if $oldAutoCommit;
1134 unless ( $import || $skip_fuzzyfiles ) {
1135 $error = $self->queue_fuzzyfiles_update;
1137 $dbh->rollback if $oldAutoCommit;
1138 return "updating fuzzy search cache: $error";
1142 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1147 =item queue_fuzzyfiles_update
1149 Used by insert & replace to update the fuzzy search cache
1153 sub queue_fuzzyfiles_update {
1156 local $SIG{HUP} = 'IGNORE';
1157 local $SIG{INT} = 'IGNORE';
1158 local $SIG{QUIT} = 'IGNORE';
1159 local $SIG{TERM} = 'IGNORE';
1160 local $SIG{TSTP} = 'IGNORE';
1161 local $SIG{PIPE} = 'IGNORE';
1163 my $oldAutoCommit = $FS::UID::AutoCommit;
1164 local $FS::UID::AutoCommit = 0;
1167 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1168 my $error = $queue->insert( map $self->getfield($_),
1169 qw(first last company)
1172 $dbh->rollback if $oldAutoCommit;
1173 return "queueing job (transaction rolled back): $error";
1176 if ( $self->ship_last ) {
1177 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1178 $error = $queue->insert( map $self->getfield("ship_$_"),
1179 qw(first last company)
1182 $dbh->rollback if $oldAutoCommit;
1183 return "queueing job (transaction rolled back): $error";
1187 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1194 Checks all fields to make sure this is a valid customer record. If there is
1195 an error, returns the error, otherwise returns false. Called by the insert
1196 and replace methods.
1203 warn "$me check BEFORE: \n". $self->_dump
1207 $self->ut_numbern('custnum')
1208 || $self->ut_number('agentnum')
1209 || $self->ut_textn('agent_custid')
1210 || $self->ut_number('refnum')
1211 || $self->ut_name('last')
1212 || $self->ut_name('first')
1213 || $self->ut_snumbern('birthdate')
1214 || $self->ut_snumbern('signupdate')
1215 || $self->ut_textn('company')
1216 || $self->ut_text('address1')
1217 || $self->ut_textn('address2')
1218 || $self->ut_text('city')
1219 || $self->ut_textn('county')
1220 || $self->ut_textn('state')
1221 || $self->ut_country('country')
1222 || $self->ut_anything('comments')
1223 || $self->ut_numbern('referral_custnum')
1224 || $self->ut_textn('stateid')
1225 || $self->ut_textn('stateid_state')
1226 || $self->ut_textn('invoice_terms')
1228 #barf. need message catalogs. i18n. etc.
1229 $error .= "Please select an advertising source."
1230 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1231 return $error if $error;
1233 return "Unknown agent"
1234 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1236 return "Unknown refnum"
1237 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1239 return "Unknown referring custnum: ". $self->referral_custnum
1240 unless ! $self->referral_custnum
1241 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1243 if ( $self->ss eq '' ) {
1248 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1249 or return "Illegal social security number: ". $self->ss;
1250 $self->ss("$1-$2-$3");
1254 # bad idea to disable, causes billing to fail because of no tax rates later
1255 # unless ( $import ) {
1256 unless ( qsearch('cust_main_county', {
1257 'country' => $self->country,
1260 return "Unknown state/county/country: ".
1261 $self->state. "/". $self->county. "/". $self->country
1262 unless qsearch('cust_main_county',{
1263 'state' => $self->state,
1264 'county' => $self->county,
1265 'country' => $self->country,
1271 $self->ut_phonen('daytime', $self->country)
1272 || $self->ut_phonen('night', $self->country)
1273 || $self->ut_phonen('fax', $self->country)
1274 || $self->ut_zip('zip', $self->country)
1276 return $error if $error;
1278 if ( $conf->exists('cust_main-require_phone')
1279 && ! length($self->daytime) && ! length($self->night)
1282 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1284 : FS::Msgcat::_gettext('daytime');
1285 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1287 : FS::Msgcat::_gettext('night');
1289 return "$daytime_label or $night_label is required"
1293 if ( $self->has_ship_address
1294 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1295 $self->addr_fields )
1299 $self->ut_name('ship_last')
1300 || $self->ut_name('ship_first')
1301 || $self->ut_textn('ship_company')
1302 || $self->ut_text('ship_address1')
1303 || $self->ut_textn('ship_address2')
1304 || $self->ut_text('ship_city')
1305 || $self->ut_textn('ship_county')
1306 || $self->ut_textn('ship_state')
1307 || $self->ut_country('ship_country')
1309 return $error if $error;
1311 #false laziness with above
1312 unless ( qsearchs('cust_main_county', {
1313 'country' => $self->ship_country,
1316 return "Unknown ship_state/ship_county/ship_country: ".
1317 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1318 unless qsearch('cust_main_county',{
1319 'state' => $self->ship_state,
1320 'county' => $self->ship_county,
1321 'country' => $self->ship_country,
1327 $self->ut_phonen('ship_daytime', $self->ship_country)
1328 || $self->ut_phonen('ship_night', $self->ship_country)
1329 || $self->ut_phonen('ship_fax', $self->ship_country)
1330 || $self->ut_zip('ship_zip', $self->ship_country)
1332 return $error if $error;
1334 return "Unit # is required."
1335 if $self->ship_address2 =~ /^\s*$/
1336 && $conf->exists('cust_main-require_address2');
1338 } else { # ship_ info eq billing info, so don't store dup info in database
1340 $self->setfield("ship_$_", '')
1341 foreach $self->addr_fields;
1343 return "Unit # is required."
1344 if $self->address2 =~ /^\s*$/
1345 && $conf->exists('cust_main-require_address2');
1349 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1350 # or return "Illegal payby: ". $self->payby;
1352 FS::payby->can_payby($self->table, $self->payby)
1353 or return "Illegal payby: ". $self->payby;
1355 $error = $self->ut_numbern('paystart_month')
1356 || $self->ut_numbern('paystart_year')
1357 || $self->ut_numbern('payissue')
1358 || $self->ut_textn('paytype')
1360 return $error if $error;
1362 if ( $self->payip eq '' ) {
1365 $error = $self->ut_ip('payip');
1366 return $error if $error;
1369 # If it is encrypted and the private key is not availaible then we can't
1370 # check the credit card.
1372 my $check_payinfo = 1;
1374 if ($self->is_encrypted($self->payinfo)) {
1378 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1380 my $payinfo = $self->payinfo;
1381 $payinfo =~ s/\D//g;
1382 $payinfo =~ /^(\d{13,16})$/
1383 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1385 $self->payinfo($payinfo);
1387 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1389 return gettext('unknown_card_type')
1390 if cardtype($self->payinfo) eq "Unknown";
1392 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1394 return 'Banned credit card: banned on '.
1395 time2str('%a %h %o at %r', $ban->_date).
1396 ' by '. $ban->otaker.
1397 ' (ban# '. $ban->bannum. ')';
1400 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1401 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1402 $self->paycvv =~ /^(\d{4})$/
1403 or return "CVV2 (CID) for American Express cards is four digits.";
1406 $self->paycvv =~ /^(\d{3})$/
1407 or return "CVV2 (CVC2/CID) is three digits.";
1414 my $cardtype = cardtype($payinfo);
1415 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1417 return "Start date or issue number is required for $cardtype cards"
1418 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1420 return "Start month must be between 1 and 12"
1421 if $self->paystart_month
1422 and $self->paystart_month < 1 || $self->paystart_month > 12;
1424 return "Start year must be 1990 or later"
1425 if $self->paystart_year
1426 and $self->paystart_year < 1990;
1428 return "Issue number must be beween 1 and 99"
1430 and $self->payissue < 1 || $self->payissue > 99;
1433 $self->paystart_month('');
1434 $self->paystart_year('');
1435 $self->payissue('');
1438 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1440 my $payinfo = $self->payinfo;
1441 $payinfo =~ s/[^\d\@]//g;
1442 if ( $conf->exists('echeck-nonus') ) {
1443 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1444 $payinfo = "$1\@$2";
1446 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1447 $payinfo = "$1\@$2";
1449 $self->payinfo($payinfo);
1452 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1454 return 'Banned ACH account: banned on '.
1455 time2str('%a %h %o at %r', $ban->_date).
1456 ' by '. $ban->otaker.
1457 ' (ban# '. $ban->bannum. ')';
1460 } elsif ( $self->payby eq 'LECB' ) {
1462 my $payinfo = $self->payinfo;
1463 $payinfo =~ s/\D//g;
1464 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1466 $self->payinfo($payinfo);
1469 } elsif ( $self->payby eq 'BILL' ) {
1471 $error = $self->ut_textn('payinfo');
1472 return "Illegal P.O. number: ". $self->payinfo if $error;
1475 } elsif ( $self->payby eq 'COMP' ) {
1477 my $curuser = $FS::CurrentUser::CurrentUser;
1478 if ( ! $self->custnum
1479 && ! $curuser->access_right('Complimentary customer')
1482 return "You are not permitted to create complimentary accounts."
1485 $error = $self->ut_textn('payinfo');
1486 return "Illegal comp account issuer: ". $self->payinfo if $error;
1489 } elsif ( $self->payby eq 'PREPAY' ) {
1491 my $payinfo = $self->payinfo;
1492 $payinfo =~ s/\W//g; #anything else would just confuse things
1493 $self->payinfo($payinfo);
1494 $error = $self->ut_alpha('payinfo');
1495 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1496 return "Unknown prepayment identifier"
1497 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1502 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1503 return "Expiration date required"
1504 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1508 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1509 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1510 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1511 ( $m, $y ) = ( $3, "20$2" );
1513 return "Illegal expiration date: ". $self->paydate;
1515 $self->paydate("$y-$m-01");
1516 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1517 return gettext('expired_card')
1519 && !$ignore_expired_card
1520 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1523 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1524 ( ! $conf->exists('require_cardname')
1525 || $self->payby !~ /^(CARD|DCRD)$/ )
1527 $self->payname( $self->first. " ". $self->getfield('last') );
1529 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1530 or return gettext('illegal_name'). " payname: ". $self->payname;
1534 foreach my $flag (qw( tax spool_cdr )) {
1535 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1539 $self->otaker(getotaker) unless $self->otaker;
1541 warn "$me check AFTER: \n". $self->_dump
1544 $self->SUPER::check;
1549 Returns a list of fields which have ship_ duplicates.
1554 qw( last first company
1555 address1 address2 city county state zip country
1560 =item has_ship_address
1562 Returns true if this customer record has a separate shipping address.
1566 sub has_ship_address {
1568 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1573 Returns all packages (see L<FS::cust_pkg>) for this customer.
1580 return $self->num_pkgs unless wantarray;
1583 if ( $self->{'_pkgnum'} ) {
1584 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1586 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1589 sort sort_packages @cust_pkg;
1594 Synonym for B<all_pkgs>.
1599 shift->all_pkgs(@_);
1602 =item ncancelled_pkgs
1604 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1608 sub ncancelled_pkgs {
1611 return $self->num_ncancelled_pkgs unless wantarray;
1614 if ( $self->{'_pkgnum'} ) {
1616 warn "$me ncancelled_pkgs: returning cached objects"
1619 @cust_pkg = grep { ! $_->getfield('cancel') }
1620 values %{ $self->{'_pkgnum'}->cache };
1624 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1625 $self->custnum. "\n"
1629 qsearch( 'cust_pkg', {
1630 'custnum' => $self->custnum,
1634 qsearch( 'cust_pkg', {
1635 'custnum' => $self->custnum,
1640 sort sort_packages @cust_pkg;
1644 # This should be generalized to use config options to determine order.
1646 if ( $a->get('cancel') and $b->get('cancel') ) {
1647 $a->pkgnum <=> $b->pkgnum;
1648 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1649 return -1 if $b->get('cancel');
1650 return 1 if $a->get('cancel');
1653 $a->pkgnum <=> $b->pkgnum;
1657 =item suspended_pkgs
1659 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1663 sub suspended_pkgs {
1665 grep { $_->susp } $self->ncancelled_pkgs;
1668 =item unflagged_suspended_pkgs
1670 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1671 customer (thouse packages without the `manual_flag' set).
1675 sub unflagged_suspended_pkgs {
1677 return $self->suspended_pkgs
1678 unless dbdef->table('cust_pkg')->column('manual_flag');
1679 grep { ! $_->manual_flag } $self->suspended_pkgs;
1682 =item unsuspended_pkgs
1684 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1689 sub unsuspended_pkgs {
1691 grep { ! $_->susp } $self->ncancelled_pkgs;
1694 =item num_cancelled_pkgs
1696 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1701 sub num_cancelled_pkgs {
1702 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1705 sub num_ncancelled_pkgs {
1706 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1710 my( $self ) = shift;
1711 my $sql = scalar(@_) ? shift : '';
1712 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1713 my $sth = dbh->prepare(
1714 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1715 ) or die dbh->errstr;
1716 $sth->execute($self->custnum) or die $sth->errstr;
1717 $sth->fetchrow_arrayref->[0];
1722 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1723 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1724 on success or a list of errors.
1730 grep { $_->unsuspend } $self->suspended_pkgs;
1735 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1737 Returns a list: an empty list on success or a list of errors.
1743 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1746 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1748 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1749 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1750 of a list of pkgparts; the hashref has the following keys:
1754 =item pkgparts - listref of pkgparts
1756 =item (other options are passed to the suspend method)
1761 Returns a list: an empty list on success or a list of errors.
1765 sub suspend_if_pkgpart {
1767 my (@pkgparts, %opt);
1768 if (ref($_[0]) eq 'HASH'){
1769 @pkgparts = @{$_[0]{pkgparts}};
1774 grep { $_->suspend(%opt) }
1775 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1776 $self->unsuspended_pkgs;
1779 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1781 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1782 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1783 instead of a list of pkgparts; the hashref has the following keys:
1787 =item pkgparts - listref of pkgparts
1789 =item (other options are passed to the suspend method)
1793 Returns a list: an empty list on success or a list of errors.
1797 sub suspend_unless_pkgpart {
1799 my (@pkgparts, %opt);
1800 if (ref($_[0]) eq 'HASH'){
1801 @pkgparts = @{$_[0]{pkgparts}};
1806 grep { $_->suspend(%opt) }
1807 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1808 $self->unsuspended_pkgs;
1811 =item cancel [ OPTION => VALUE ... ]
1813 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1815 Available options are:
1819 =item quiet - can be set true to supress email cancellation notices.
1821 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
1823 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1827 Always returns a list: an empty list on success or a list of errors.
1832 my( $self, %opt ) = @_;
1834 warn "$me cancel called on customer ". $self->custnum. " with options ".
1835 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1838 return ( 'access denied' )
1839 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1841 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1843 #should try decryption (we might have the private key)
1844 # and if not maybe queue a job for the server that does?
1845 return ( "Can't (yet) ban encrypted credit cards" )
1846 if $self->is_encrypted($self->payinfo);
1848 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1849 my $error = $ban->insert;
1850 return ( $error ) if $error;
1854 my @pkgs = $self->ncancelled_pkgs;
1856 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1857 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1860 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1863 sub _banned_pay_hashref {
1874 'payby' => $payby2ban{$self->payby},
1875 'payinfo' => md5_base64($self->payinfo),
1876 #don't ever *search* on reason! #'reason' =>
1882 Returns all notes (see L<FS::cust_main_note>) for this customer.
1889 qsearch( 'cust_main_note',
1890 { 'custnum' => $self->custnum },
1892 'ORDER BY _DATE DESC'
1898 Returns the agent (see L<FS::agent>) for this customer.
1904 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1907 =item bill_and_collect
1909 Cancels and suspends any packages due, generates bills, applies payments and
1912 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1914 Options are passed as name-value pairs. Currently available options are:
1920 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:
1924 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1928 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.
1932 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1936 If set true, re-charges setup fees.
1940 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)
1946 sub bill_and_collect {
1947 my( $self, %options ) = @_;
1953 #$options{actual_time} not $options{time} because freeside-daily -d is for
1954 #pre-printing invoices
1955 my @cancel_pkgs = grep { $_->expire && $_->expire <= $options{actual_time} }
1956 $self->ncancelled_pkgs;
1958 foreach my $cust_pkg ( @cancel_pkgs ) {
1959 my $error = $cust_pkg->cancel;
1960 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1961 " for custnum ". $self->custnum. ": $error"
1969 #$options{actual_time} not $options{time} because freeside-daily -d is for
1970 #pre-printing invoices
1973 && ( ( $_->part_pkg->is_prepaid
1975 && $_->bill < $options{actual_time}
1978 && $_->adjourn <= $options{actual_time}
1982 $self->ncancelled_pkgs;
1984 foreach my $cust_pkg ( @susp_pkgs ) {
1985 my $error = $cust_pkg->suspend;
1986 warn "Error suspending package ". $cust_pkg->pkgnum.
1987 " for custnum ". $self->custnum. ": $error"
1995 my $error = $self->bill( %options );
1996 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1998 $self->apply_payments_and_credits;
2000 $error = $self->collect( %options );
2001 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2007 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2008 conjunction with the collect method by calling B<bill_and_collect>.
2010 If there is an error, returns the error, otherwise returns false.
2012 Options are passed as name-value pairs. Currently available options are:
2018 If set true, re-charges setup fees.
2022 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:
2026 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2030 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2032 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2036 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.
2043 my( $self, %options ) = @_;
2044 return '' if $self->payby eq 'COMP';
2045 warn "$me bill customer ". $self->custnum. "\n"
2048 my $time = $options{'time'} || time;
2051 local $SIG{HUP} = 'IGNORE';
2052 local $SIG{INT} = 'IGNORE';
2053 local $SIG{QUIT} = 'IGNORE';
2054 local $SIG{TERM} = 'IGNORE';
2055 local $SIG{TSTP} = 'IGNORE';
2056 local $SIG{PIPE} = 'IGNORE';
2058 my $oldAutoCommit = $FS::UID::AutoCommit;
2059 local $FS::UID::AutoCommit = 0;
2062 $self->select_for_update; #mutex
2064 my @cust_bill_pkg = ();
2067 # find the packages which are due for billing, find out how much they are
2068 # & generate invoice database.
2071 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2075 my @precommit_hooks = ();
2077 my @cust_pkgs = qsearch('cust_pkg', { 'custnum' => $self->custnum } );
2078 foreach my $cust_pkg (@cust_pkgs) {
2080 #NO!! next if $cust_pkg->cancel;
2081 next if $cust_pkg->getfield('cancel');
2083 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2085 #? to avoid use of uninitialized value errors... ?
2086 $cust_pkg->setfield('bill', '')
2087 unless defined($cust_pkg->bill);
2089 #my $part_pkg = $cust_pkg->part_pkg;
2091 my $real_pkgpart = $cust_pkg->pkgpart;
2092 my %hash = $cust_pkg->hash;
2093 my $old_cust_pkg = new FS::cust_pkg \%hash;
2095 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2097 $cust_pkg->pkgpart($part_pkg->pkgpart);
2098 $cust_pkg->set($_, $hash{$_}) foreach qw( setup last_bill bill );
2110 if ( ! $cust_pkg->setup &&
2112 ( $conf->exists('disable_setup_suspended_pkgs') &&
2113 ! $cust_pkg->getfield('susp')
2114 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2116 || $options{'resetup'}
2119 warn " bill setup\n" if $DEBUG > 1;
2122 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2124 $dbh->rollback if $oldAutoCommit;
2125 return "$@ running calc_setup for $cust_pkg\n";
2128 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2130 $cust_pkg->setfield('setup', $time)
2131 unless $cust_pkg->setup;
2132 #do need it, but it won't get written to the db
2133 #|| $cust_pkg->pkgpart != $real_pkgpart;
2138 # bill recurring fee
2141 #XXX unit stuff here too
2145 if ( $part_pkg->getfield('freq') ne '0' &&
2146 ! $cust_pkg->getfield('susp') &&
2147 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2150 # XXX should this be a package event? probably. events are called
2151 # at collection time at the moment, though...
2152 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2153 if $part_pkg->can('reset_usage');
2154 #don't want to reset usage just cause we want a line item??
2155 #&& $part_pkg->pkgpart == $real_pkgpart;
2157 warn " bill recur\n" if $DEBUG > 1;
2160 # XXX shared with $recur_prog
2161 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2163 #over two params! lets at least switch to a hashref for the rest...
2164 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2166 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2168 $dbh->rollback if $oldAutoCommit;
2169 return "$@ running calc_recur for $cust_pkg\n";
2173 #change this bit to use Date::Manip? CAREFUL with timezones (see
2174 # mailing list archive)
2175 my ($sec,$min,$hour,$mday,$mon,$year) =
2176 (localtime($sdate) )[0,1,2,3,4,5];
2178 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2179 # only for figuring next bill date, nothing else, so, reset $sdate again
2181 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2182 $cust_pkg->last_bill($sdate);
2184 if ( $part_pkg->freq =~ /^\d+$/ ) {
2185 $mon += $part_pkg->freq;
2186 until ( $mon < 12 ) { $mon -= 12; $year++; }
2187 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2189 $mday += $weeks * 7;
2190 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2193 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2197 $dbh->rollback if $oldAutoCommit;
2198 return "unparsable frequency: ". $part_pkg->freq;
2200 $cust_pkg->setfield('bill',
2201 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2205 warn "\$setup is undefined" unless defined($setup);
2206 warn "\$recur is undefined" unless defined($recur);
2207 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2210 # If there's line items, create em cust_bill_pkg records
2211 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2216 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2217 # hmm.. and if just the options are modified in some weird price plan?
2219 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2222 my $error = $cust_pkg->replace( $old_cust_pkg,
2223 'options' => { $cust_pkg->options },
2225 if ( $error ) { #just in case
2226 $dbh->rollback if $oldAutoCommit;
2227 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2231 $setup = sprintf( "%.2f", $setup );
2232 $recur = sprintf( "%.2f", $recur );
2233 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2234 $dbh->rollback if $oldAutoCommit;
2235 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2237 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2238 $dbh->rollback if $oldAutoCommit;
2239 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2242 if ( $setup != 0 || $recur != 0 ) {
2244 unless ($postal_charge) {
2245 $postal_charge = 1; # try only once
2246 my $postal_pkg = $self->charge_postal_fee();
2247 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2248 $dbh->rollback if $oldAutoCommit;
2249 return "can't charge postal invoice fee for customer ".
2250 $self->custnum. ": $postal_pkg";
2252 push @cust_pkgs, $postal_pkg if $postal_pkg;
2255 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2257 my $cust_bill_pkg = new FS::cust_bill_pkg {
2258 'pkgnum' => $cust_pkg->pkgnum,
2260 'unitsetup' => $unitsetup,
2262 'unitrecur' => $unitrecur,
2263 'quantity' => $cust_pkg->quantity,
2265 'edate' => $cust_pkg->bill,
2266 'details' => \@details,
2268 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2269 unless $part_pkg->pkgpart == $real_pkgpart;
2270 push @cust_bill_pkg, $cust_bill_pkg;
2272 $total_setup += $setup;
2273 $total_recur += $recur;
2279 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2282 my @taxoverrides = $part_pkg->part_pkg_taxoverride;
2285 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2289 if ( $conf->exists('enable_taxproducts')
2290 && (scalar(@taxoverrides) || $part_pkg->taxproductnum )
2294 my @taxclassnums = ();
2295 my $geocode = $self->geocode('cch');
2297 if ( scalar( @taxoverrides ) ) {
2298 @taxclassnums = map { $_->taxclassnum } @taxoverrides;
2299 }elsif ( $part_pkg->taxproductnum ) {
2300 @taxclassnums = map { $_->taxclassnum }
2301 $part_pkg->part_pkg_taxrate('cch', $geocode);
2306 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2308 @taxes = qsearch({ 'table' => 'tax_rate',
2309 'hashref' => { 'geocode' => $geocode, },
2310 'extra_sql' => $extra_sql,
2312 if scalar(@taxclassnums);
2317 my %taxhash = map { $_ => $self->get("$prefix$_") }
2318 qw( state county country );
2320 $taxhash{'taxclass'} = $part_pkg->taxclass;
2322 @taxes = qsearch( 'cust_main_county', \%taxhash );
2325 $taxhash{'taxclass'} = '';
2326 @taxes = qsearch( 'cust_main_county', \%taxhash );
2329 #one more try at a whole-country tax rate
2331 $taxhash{$_} = '' foreach qw( state county );
2332 @taxes = qsearch( 'cust_main_county', \%taxhash );
2335 } #if $conf->exists('enable_taxproducts')
2337 # maybe eliminate this entirely, along with all the 0% records
2339 $dbh->rollback if $oldAutoCommit;
2341 if ( $conf->exists('enable_taxproducts') ) {
2343 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2344 join('/', ( map $self->get("$prefix$_"),
2347 $part_pkg->taxproduct_description,
2348 $part_pkg->pkgpart ). "\n";
2351 "fatal: can't find tax rate for state/county/country/taxclass ".
2352 join('/', ( map $self->get("$prefix$_"),
2353 qw(state county country)
2355 $part_pkg->taxclass ). "\n";
2360 foreach my $tax ( @taxes ) {
2361 my $taxname = ref( $tax ). ' '. $tax->taxnum;
2362 if ( exists( $taxlisthash{ $taxname } ) ) {
2363 push @{ $taxlisthash{ $taxname } }, $cust_bill_pkg;
2365 $taxlisthash{ $taxname } = [ $tax, $cust_bill_pkg ];
2370 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2372 } #if $setup != 0 || $recur != 0
2374 } #if $cust_pkg->modified
2376 } #foreach my $part_pkg
2378 } #foreach my $cust_pkg
2380 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2381 #but do commit any package date cycling that happened
2382 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2386 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2387 foreach my $tax ( keys %taxlisthash ) {
2388 my $tax_object = shift @{ $taxlisthash{$tax} };
2389 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2390 my $listref_or_error = $tax_object->taxline( @{ $taxlisthash{$tax} } );
2391 unless (ref($listref_or_error)) {
2392 $dbh->rollback if $oldAutoCommit;
2393 return $listref_or_error;
2395 unshift @{ $taxlisthash{$tax} }, $tax_object;
2397 warn "adding ". $listref_or_error->[1].
2398 " as ". $listref_or_error->[0]. "\n"
2400 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2401 if ( $taxname{ $listref_or_error->[0] } ) {
2402 push @{ $taxname{ $listref_or_error->[0] } }, $tax_object->taxname;
2404 $taxname{ $listref_or_error->[0] } = [ $tax_object->taxname ];
2409 #some taxes are taxed
2412 warn "finding taxed taxes...\n" if $DEBUG > 2;
2413 foreach my $tax ( keys %taxlisthash ) {
2414 my $tax_object = shift @{ $taxlisthash{$tax} };
2415 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
2417 next unless $tax_object->can('tax_on_tax');
2419 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
2420 my $totname = ref( $tot ). ' '. $tot->taxnum;
2422 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
2424 next unless exists( $taxlisthash{ $totname } ); # only increase
2426 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
2427 if ( exists( $totlisthash{ $totname } ) ) {
2428 push @{ $totlisthash{ $totname } }, $tax{ $tax_object->taxname };
2430 $totlisthash{ $totname } = [ $tot, $tax{ $tax_object->taxname } ];
2435 warn "having a look at taxed taxes...\n" if $DEBUG > 2;
2436 foreach my $tax ( keys %totlisthash ) {
2437 my $tax_object = shift @{ $totlisthash{$tax} };
2438 warn "found previously found taxed tax ". $tax_object->taxname. "\n"
2440 my $listref_or_error = $tax_object->taxline( @{ $totlisthash{$tax} } );
2441 unless (ref($listref_or_error)) {
2442 $dbh->rollback if $oldAutoCommit;
2443 return $listref_or_error;
2446 warn "adding taxed tax amount ". $listref_or_error->[1].
2447 " as ". $tax_object->taxname. "\n"
2449 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2452 #consolidate and create tax line items
2453 warn "consolidating and generating...\n" if $DEBUG > 2;
2454 foreach my $taxname ( keys %taxname ) {
2457 warn "adding $taxname\n" if $DEBUG > 1;
2458 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2459 $tax += $tax{$taxitem} unless $seen{$taxitem};
2460 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2464 $tax = sprintf('%.2f', $tax );
2465 $total_setup = sprintf('%.2f', $total_setup+$tax );
2467 push @cust_bill_pkg, new FS::cust_bill_pkg {
2473 'itemdesc' => $taxname,
2478 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2480 #create the new invoice
2481 my $cust_bill = new FS::cust_bill ( {
2482 'custnum' => $self->custnum,
2483 '_date' => ( $options{'invoice_time'} || $time ),
2484 'charged' => $charged,
2486 my $error = $cust_bill->insert;
2488 $dbh->rollback if $oldAutoCommit;
2489 return "can't create invoice for customer #". $self->custnum. ": $error";
2492 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2493 $cust_bill_pkg->invnum($cust_bill->invnum);
2494 my $error = $cust_bill_pkg->insert;
2496 $dbh->rollback if $oldAutoCommit;
2497 return "can't create invoice line item: $error";
2502 foreach my $hook ( @precommit_hooks ) {
2504 &{$hook}; #($self) ?
2507 $dbh->rollback if $oldAutoCommit;
2508 return "$@ running precommit hook $hook\n";
2512 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2516 =item collect OPTIONS
2518 (Attempt to) collect money for this customer's outstanding invoices (see
2519 L<FS::cust_bill>). Usually used after the bill method.
2521 Actions are now triggered by billing events; see L<FS::part_event> and the
2522 billing events web interface. Old-style invoice events (see
2523 L<FS::part_bill_event>) have been deprecated.
2525 If there is an error, returns the error, otherwise returns false.
2527 Options are passed as name-value pairs.
2529 Currently available options are:
2535 Use this time when deciding when to print invoices and 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> for conversion functions.
2539 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2543 set true to surpress email card/ACH decline notices.
2547 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2551 allows for one time override of normal customer billing method
2555 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)
2563 my( $self, %options ) = @_;
2564 my $invoice_time = $options{'invoice_time'} || time;
2567 local $SIG{HUP} = 'IGNORE';
2568 local $SIG{INT} = 'IGNORE';
2569 local $SIG{QUIT} = 'IGNORE';
2570 local $SIG{TERM} = 'IGNORE';
2571 local $SIG{TSTP} = 'IGNORE';
2572 local $SIG{PIPE} = 'IGNORE';
2574 my $oldAutoCommit = $FS::UID::AutoCommit;
2575 local $FS::UID::AutoCommit = 0;
2578 $self->select_for_update; #mutex
2581 my $balance = $self->balance;
2582 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2585 if ( exists($options{'retry_card'}) ) {
2586 carp 'retry_card option passed to collect is deprecated; use retry';
2587 $options{'retry'} ||= $options{'retry_card'};
2589 if ( exists($options{'retry'}) && $options{'retry'} ) {
2590 my $error = $self->retry_realtime;
2592 $dbh->rollback if $oldAutoCommit;
2597 # false laziness w/pay_batch::import_results
2599 my $due_cust_event = $self->due_cust_event(
2600 'debug' => ( $options{'debug'} || 0 ),
2601 'time' => $invoice_time,
2602 'check_freq' => $options{'check_freq'},
2604 unless( ref($due_cust_event) ) {
2605 $dbh->rollback if $oldAutoCommit;
2606 return $due_cust_event;
2609 foreach my $cust_event ( @$due_cust_event ) {
2613 #re-eval event conditions (a previous event could have changed things)
2614 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2615 #don't leave stray "new/locked" records around
2616 my $error = $cust_event->delete;
2618 #gah, even with transactions
2619 $dbh->commit if $oldAutoCommit; #well.
2626 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2627 warn " running cust_event ". $cust_event->eventnum. "\n"
2631 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2632 if ( my $error = $cust_event->do_event() ) {
2633 #XXX wtf is this? figure out a proper dealio with return value
2635 # gah, even with transactions.
2636 $dbh->commit if $oldAutoCommit; #well.
2643 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2648 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2650 Inserts database records for and returns an ordered listref of new events due
2651 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2652 events are due, an empty listref is returned. If there is an error, returns a
2653 scalar error message.
2655 To actually run the events, call each event's test_condition method, and if
2656 still true, call the event's do_event method.
2658 Options are passed as a hashref or as a list of name-value pairs. Available
2665 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
2669 "Current time" for the events.
2673 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)
2677 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2681 Explicitly pass the objects to be tested (typically used with eventtable).
2687 sub due_cust_event {
2689 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2692 #my $DEBUG = $opt{'debug'}
2693 local($DEBUG) = $opt{'debug'}
2694 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2696 warn "$me due_cust_event called with options ".
2697 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2700 $opt{'time'} ||= time;
2702 local $SIG{HUP} = 'IGNORE';
2703 local $SIG{INT} = 'IGNORE';
2704 local $SIG{QUIT} = 'IGNORE';
2705 local $SIG{TERM} = 'IGNORE';
2706 local $SIG{TSTP} = 'IGNORE';
2707 local $SIG{PIPE} = 'IGNORE';
2709 my $oldAutoCommit = $FS::UID::AutoCommit;
2710 local $FS::UID::AutoCommit = 0;
2713 $self->select_for_update; #mutex
2716 # 1: find possible events (initial search)
2719 my @cust_event = ();
2721 my @eventtable = $opt{'eventtable'}
2722 ? ( $opt{'eventtable'} )
2723 : FS::part_event->eventtables_runorder;
2725 foreach my $eventtable ( @eventtable ) {
2728 if ( $opt{'objects'} ) {
2730 @objects = @{ $opt{'objects'} };
2734 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2735 @objects = ( $eventtable eq 'cust_main' )
2737 : ( $self->$eventtable() );
2741 my @e_cust_event = ();
2743 my $cross = "CROSS JOIN $eventtable";
2744 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2745 unless $eventtable eq 'cust_main';
2747 foreach my $object ( @objects ) {
2749 #this first search uses the condition_sql magic for optimization.
2750 #the more possible events we can eliminate in this step the better
2752 my $cross_where = '';
2753 my $pkey = $object->primary_key;
2754 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2756 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2758 FS::part_event_condition->where_conditions_sql( $eventtable,
2759 'time'=>$opt{'time'}
2761 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2763 $extra_sql = "AND $extra_sql" if $extra_sql;
2765 #here is the agent virtualization
2766 $extra_sql .= " AND ( part_event.agentnum IS NULL
2767 OR part_event.agentnum = ". $self->agentnum. ' )';
2769 $extra_sql .= " $order";
2771 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2772 if $opt{'debug'} > 2;
2773 my @part_event = qsearch( {
2774 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2775 'select' => 'part_event.*',
2776 'table' => 'part_event',
2777 'addl_from' => "$cross $join",
2778 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2779 'eventtable' => $eventtable,
2782 'extra_sql' => "AND $cross_where $extra_sql",
2786 my $pkey = $object->primary_key;
2787 warn " ". scalar(@part_event).
2788 " possible events found for $eventtable ". $object->$pkey(). "\n";
2791 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2795 warn " ". scalar(@e_cust_event).
2796 " subtotal possible cust events found for $eventtable\n"
2799 push @cust_event, @e_cust_event;
2803 warn " ". scalar(@cust_event).
2804 " total possible cust events found in initial search\n"
2808 # 2: test conditions
2813 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2814 'stats_hashref' => \%unsat ),
2817 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2820 warn " invalid conditions not eliminated with condition_sql:\n".
2821 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2828 foreach my $cust_event ( @cust_event ) {
2830 my $error = $cust_event->insert();
2832 $dbh->rollback if $oldAutoCommit;
2838 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2844 warn " returning events: ". Dumper(@cust_event). "\n"
2851 =item retry_realtime
2853 Schedules realtime / batch credit card / electronic check / LEC billing
2854 events for for retry. Useful if card information has changed or manual
2855 retry is desired. The 'collect' method must be called to actually retry
2858 Implementation details: For either this customer, or for each of this
2859 customer's open invoices, changes the status of the first "done" (with
2860 statustext error) realtime processing event to "failed".
2864 sub retry_realtime {
2867 local $SIG{HUP} = 'IGNORE';
2868 local $SIG{INT} = 'IGNORE';
2869 local $SIG{QUIT} = 'IGNORE';
2870 local $SIG{TERM} = 'IGNORE';
2871 local $SIG{TSTP} = 'IGNORE';
2872 local $SIG{PIPE} = 'IGNORE';
2874 my $oldAutoCommit = $FS::UID::AutoCommit;
2875 local $FS::UID::AutoCommit = 0;
2878 #a little false laziness w/due_cust_event (not too bad, really)
2880 my $join = FS::part_event_condition->join_conditions_sql;
2881 my $order = FS::part_event_condition->order_conditions_sql;
2884 . join ( ' OR ' , map {
2885 "( part_event.eventtable = " . dbh->quote($_)
2886 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2887 } FS::part_event->eventtables)
2890 #here is the agent virtualization
2891 my $agent_virt = " ( part_event.agentnum IS NULL
2892 OR part_event.agentnum = ". $self->agentnum. ' )';
2894 #XXX this shouldn't be hardcoded, actions should declare it...
2895 my @realtime_events = qw(
2896 cust_bill_realtime_card
2897 cust_bill_realtime_check
2898 cust_bill_realtime_lec
2902 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2907 my @cust_event = qsearchs({
2908 'table' => 'cust_event',
2909 'select' => 'cust_event.*',
2910 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2911 'hashref' => { 'status' => 'done' },
2912 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2913 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2916 my %seen_invnum = ();
2917 foreach my $cust_event (@cust_event) {
2919 #max one for the customer, one for each open invoice
2920 my $cust_X = $cust_event->cust_X;
2921 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2925 or $cust_event->part_event->eventtable eq 'cust_bill'
2928 my $error = $cust_event->retry;
2930 $dbh->rollback if $oldAutoCommit;
2931 return "error scheduling event for retry: $error";
2936 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2941 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2943 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2944 via a Business::OnlinePayment realtime gateway. See
2945 L<http://420.am/business-onlinepayment> for supported gateways.
2947 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2949 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2951 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2952 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2953 if set, will override the value from the customer record.
2955 I<description> is a free-text field passed to the gateway. It defaults to
2956 "Internet services".
2958 If an I<invnum> is specified, this payment (if successful) is applied to the
2959 specified invoice. If you don't specify an I<invnum> you might want to
2960 call the B<apply_payments> method.
2962 I<quiet> can be set true to surpress email decline notices.
2964 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2965 resulting paynum, if any.
2967 I<payunique> is a unique identifier for this payment.
2969 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2974 my( $self, $method, $amount, %options ) = @_;
2976 warn "$me realtime_bop: $method $amount\n";
2977 warn " $_ => $options{$_}\n" foreach keys %options;
2980 $options{'description'} ||= 'Internet services';
2982 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
2984 eval "use Business::OnlinePayment";
2987 my $payinfo = exists($options{'payinfo'})
2988 ? $options{'payinfo'}
2991 my %method2payby = (
2998 # check for banned credit card/ACH
3001 my $ban = qsearchs('banned_pay', {
3002 'payby' => $method2payby{$method},
3003 'payinfo' => md5_base64($payinfo),
3005 return "Banned credit card" if $ban;
3012 if ( $options{'invnum'} ) {
3013 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3014 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3016 map { $_->part_pkg->taxclass }
3018 map { $_->cust_pkg }
3019 $cust_bill->cust_bill_pkg;
3020 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
3021 #different taxclasses
3022 $taxclass = $taxclasses[0];
3026 #look for an agent gateway override first
3028 if ( $method eq 'CC' ) {
3029 $cardtype = cardtype($payinfo);
3030 } elsif ( $method eq 'ECHECK' ) {
3033 $cardtype = $method;
3037 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3038 cardtype => $cardtype,
3039 taxclass => $taxclass, } )
3040 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3042 taxclass => $taxclass, } )
3043 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3044 cardtype => $cardtype,
3046 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3048 taxclass => '', } );
3050 my $payment_gateway = '';
3051 my( $processor, $login, $password, $action, @bop_options );
3052 if ( $override ) { #use a payment gateway override
3054 $payment_gateway = $override->payment_gateway;
3056 $processor = $payment_gateway->gateway_module;
3057 $login = $payment_gateway->gateway_username;
3058 $password = $payment_gateway->gateway_password;
3059 $action = $payment_gateway->gateway_action;
3060 @bop_options = $payment_gateway->options;
3062 } else { #use the standard settings from the config
3064 ( $processor, $login, $password, $action, @bop_options ) =
3065 $self->default_payment_gateway($method);
3073 my $address = exists($options{'address1'})
3074 ? $options{'address1'}
3076 my $address2 = exists($options{'address2'})
3077 ? $options{'address2'}
3079 $address .= ", ". $address2 if length($address2);
3081 my $o_payname = exists($options{'payname'})
3082 ? $options{'payname'}
3084 my($payname, $payfirst, $paylast);
3085 if ( $o_payname && $method ne 'ECHECK' ) {
3086 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3087 or return "Illegal payname $payname";
3088 ($payfirst, $paylast) = ($1, $2);
3090 $payfirst = $self->getfield('first');
3091 $paylast = $self->getfield('last');
3092 $payname = "$payfirst $paylast";
3095 my @invoicing_list = $self->invoicing_list_emailonly;
3096 if ( $conf->exists('emailinvoiceautoalways')
3097 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3098 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3099 push @invoicing_list, $self->all_emails;
3102 my $email = ($conf->exists('business-onlinepayment-email-override'))
3103 ? $conf->config('business-onlinepayment-email-override')
3104 : $invoicing_list[0];
3108 my $payip = exists($options{'payip'})
3111 $content{customer_ip} = $payip
3114 $content{invoice_number} = $options{'invnum'}
3115 if exists($options{'invnum'}) && length($options{'invnum'});
3117 $content{email_customer} =
3118 ( $conf->exists('business-onlinepayment-email_customer')
3119 || $conf->exists('business-onlinepayment-email-override') );
3122 if ( $method eq 'CC' ) {
3124 $content{card_number} = $payinfo;
3125 $paydate = exists($options{'paydate'})
3126 ? $options{'paydate'}
3128 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3129 $content{expiration} = "$2/$1";
3131 my $paycvv = exists($options{'paycvv'})
3132 ? $options{'paycvv'}
3134 $content{cvv2} = $paycvv
3137 my $paystart_month = exists($options{'paystart_month'})
3138 ? $options{'paystart_month'}
3139 : $self->paystart_month;
3141 my $paystart_year = exists($options{'paystart_year'})
3142 ? $options{'paystart_year'}
3143 : $self->paystart_year;
3145 $content{card_start} = "$paystart_month/$paystart_year"
3146 if $paystart_month && $paystart_year;
3148 my $payissue = exists($options{'payissue'})
3149 ? $options{'payissue'}
3151 $content{issue_number} = $payissue if $payissue;
3153 $content{recurring_billing} = 'YES'
3154 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3156 'payinfo' => $payinfo,
3158 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3160 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3164 } elsif ( $method eq 'ECHECK' ) {
3165 ( $content{account_number}, $content{routing_code} ) =
3166 split('@', $payinfo);
3167 $content{bank_name} = $o_payname;
3168 $content{bank_state} = exists($options{'paystate'})
3169 ? $options{'paystate'}
3170 : $self->getfield('paystate');
3171 $content{account_type} = exists($options{'paytype'})
3172 ? uc($options{'paytype'}) || 'CHECKING'
3173 : uc($self->getfield('paytype')) || 'CHECKING';
3174 $content{account_name} = $payname;
3175 $content{customer_org} = $self->company ? 'B' : 'I';
3176 $content{state_id} = exists($options{'stateid'})
3177 ? $options{'stateid'}
3178 : $self->getfield('stateid');
3179 $content{state_id_state} = exists($options{'stateid_state'})
3180 ? $options{'stateid_state'}
3181 : $self->getfield('stateid_state');
3182 $content{customer_ssn} = exists($options{'ss'})
3185 } elsif ( $method eq 'LEC' ) {
3186 $content{phone} = $payinfo;
3190 # run transaction(s)
3193 my $balance = exists( $options{'balance'} )
3194 ? $options{'balance'}
3197 $self->select_for_update; #mutex ... just until we get our pending record in
3199 #the checks here are intended to catch concurrent payments
3200 #double-form-submission prevention is taken care of in cust_pay_pending::check
3203 return "The customer's balance has changed; $method transaction aborted."
3204 if $self->balance < $balance;
3205 #&& $self->balance < $amount; #might as well anyway?
3207 #also check and make sure there aren't *other* pending payments for this cust
3209 my @pending = qsearch('cust_pay_pending', {
3210 'custnum' => $self->custnum,
3211 'status' => { op=>'!=', value=>'done' }
3213 return "A payment is already being processed for this customer (".
3214 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3215 "); $method transaction aborted."
3216 if scalar(@pending);
3218 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3220 my $cust_pay_pending = new FS::cust_pay_pending {
3221 'custnum' => $self->custnum,
3222 #'invnum' => $options{'invnum'},
3225 'payby' => $method2payby{$method},
3226 'payinfo' => $payinfo,
3227 'paydate' => $paydate,
3229 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3231 $cust_pay_pending->payunique( $options{payunique} )
3232 if defined($options{payunique}) && length($options{payunique});
3233 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3234 return $cpp_new_err if $cpp_new_err;
3236 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3238 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3239 $transaction->content(
3242 'password' => $password,
3243 'action' => $action1,
3244 'description' => $options{'description'},
3245 'amount' => $amount,
3246 #'invoice_number' => $options{'invnum'},
3247 'customer_id' => $self->custnum,
3248 'last_name' => $paylast,
3249 'first_name' => $payfirst,
3251 'address' => $address,
3252 'city' => ( exists($options{'city'})
3255 'state' => ( exists($options{'state'})
3258 'zip' => ( exists($options{'zip'})
3261 'country' => ( exists($options{'country'})
3262 ? $options{'country'}
3264 'referer' => 'http://cleanwhisker.420.am/',
3266 'phone' => $self->daytime || $self->night,
3270 $cust_pay_pending->status('pending');
3271 my $cpp_pending_err = $cust_pay_pending->replace;
3272 return $cpp_pending_err if $cpp_pending_err;
3275 my $BOP_TESTING = 0;
3276 my $BOP_TESTING_SUCCESS = 1;
3278 unless ( $BOP_TESTING ) {
3279 $transaction->submit();
3281 if ( $BOP_TESTING_SUCCESS ) {
3282 $transaction->is_success(1);
3283 $transaction->authorization('fake auth');
3285 $transaction->is_success(0);
3286 $transaction->error_message('fake failure');
3290 if ( $transaction->is_success() && $action2 ) {
3292 $cust_pay_pending->status('authorized');
3293 my $cpp_authorized_err = $cust_pay_pending->replace;
3294 return $cpp_authorized_err if $cpp_authorized_err;
3296 my $auth = $transaction->authorization;
3297 my $ordernum = $transaction->can('order_number')
3298 ? $transaction->order_number
3302 new Business::OnlinePayment( $processor, @bop_options );
3309 password => $password,
3310 order_number => $ordernum,
3312 authorization => $auth,
3313 description => $options{'description'},
3316 foreach my $field (qw( authorization_source_code returned_ACI
3317 transaction_identifier validation_code
3318 transaction_sequence_num local_transaction_date
3319 local_transaction_time AVS_result_code )) {
3320 $capture{$field} = $transaction->$field() if $transaction->can($field);
3323 $capture->content( %capture );
3327 unless ( $capture->is_success ) {
3328 my $e = "Authorization successful but capture failed, custnum #".
3329 $self->custnum. ': '. $capture->result_code.
3330 ": ". $capture->error_message;
3337 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3338 my $cpp_captured_err = $cust_pay_pending->replace;
3339 return $cpp_captured_err if $cpp_captured_err;
3342 # remove paycvv after initial transaction
3345 #false laziness w/misc/process/payment.cgi - check both to make sure working
3347 if ( defined $self->dbdef_table->column('paycvv')
3348 && length($self->paycvv)
3349 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3351 my $error = $self->remove_cvv;
3353 warn "WARNING: error removing cvv: $error\n";
3361 if ( $transaction->is_success() ) {
3364 if ( $payment_gateway ) { # agent override
3365 $paybatch = $payment_gateway->gatewaynum. '-';
3368 $paybatch .= "$processor:". $transaction->authorization;
3370 $paybatch .= ':'. $transaction->order_number
3371 if $transaction->can('order_number')
3372 && length($transaction->order_number);
3374 my $cust_pay = new FS::cust_pay ( {
3375 'custnum' => $self->custnum,
3376 'invnum' => $options{'invnum'},
3379 'payby' => $method2payby{$method},
3380 'payinfo' => $payinfo,
3381 'paybatch' => $paybatch,
3382 'paydate' => $paydate,
3384 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3385 $cust_pay->payunique( $options{payunique} )
3386 if defined($options{payunique}) && length($options{payunique});
3388 my $oldAutoCommit = $FS::UID::AutoCommit;
3389 local $FS::UID::AutoCommit = 0;
3392 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3394 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3397 $cust_pay->invnum(''); #try again with no specific invnum
3398 my $error2 = $cust_pay->insert( $options{'manual'} ?
3399 ( 'manual' => 1 ) : ()
3402 # gah. but at least we have a record of the state we had to abort in
3403 # from cust_pay_pending now.
3404 my $e = "WARNING: $method captured but payment not recorded - ".
3405 "error inserting payment ($processor): $error2".
3406 " (previously tried insert with invnum #$options{'invnum'}" .
3407 ": $error ) - pending payment saved as paypendingnum ".
3408 $cust_pay_pending->paypendingnum. "\n";
3414 if ( $options{'paynum_ref'} ) {
3415 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3418 $cust_pay_pending->status('done');
3419 $cust_pay_pending->statustext('captured');
3420 my $cpp_done_err = $cust_pay_pending->replace;
3422 if ( $cpp_done_err ) {
3424 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3425 my $e = "WARNING: $method captured but payment not recorded - ".
3426 "error updating status for paypendingnum ".
3427 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3433 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3434 return ''; #no error
3440 my $perror = "$processor error: ". $transaction->error_message;
3442 unless ( $transaction->error_message ) {
3445 if ( $transaction->can('response_page') ) {
3447 'page' => ( $transaction->can('response_page')
3448 ? $transaction->response_page
3451 'code' => ( $transaction->can('response_code')
3452 ? $transaction->response_code
3455 'headers' => ( $transaction->can('response_headers')
3456 ? $transaction->response_headers
3462 "No additional debugging information available for $processor";
3465 $perror .= "No error_message returned from $processor -- ".
3466 ( ref($t_response) ? Dumper($t_response) : $t_response );
3470 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3471 && $conf->exists('emaildecline')
3472 && grep { $_ ne 'POST' } $self->invoicing_list
3473 && ! grep { $transaction->error_message =~ /$_/ }
3474 $conf->config('emaildecline-exclude')
3476 my @templ = $conf->config('declinetemplate');
3477 my $template = new Text::Template (
3479 SOURCE => [ map "$_\n", @templ ],
3480 ) or return "($perror) can't create template: $Text::Template::ERROR";
3481 $template->compile()
3482 or return "($perror) can't compile template: $Text::Template::ERROR";
3484 my $templ_hash = { error => $transaction->error_message };
3486 my $error = send_email(
3487 'from' => $conf->config('invoice_from'),
3488 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3489 'subject' => 'Your payment could not be processed',
3490 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3493 $perror .= " (also received error sending decline notification: $error)"
3498 $cust_pay_pending->status('done');
3499 $cust_pay_pending->statustext("declined: $perror");
3500 my $cpp_done_err = $cust_pay_pending->replace;
3501 if ( $cpp_done_err ) {
3502 my $e = "WARNING: $method declined but pending payment not resolved - ".
3503 "error updating status for paypendingnum ".
3504 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3506 $perror = "$e ($perror)";
3519 my( $self, $method, $amount, %options ) = @_;
3521 if ( $options{'fake_failure'} ) {
3522 return "Error: No error; test failure requested with fake_failure";
3525 my %method2payby = (
3532 #if ( $payment_gateway ) { # agent override
3533 # $paybatch = $payment_gateway->gatewaynum. '-';
3536 #$paybatch .= "$processor:". $transaction->authorization;
3538 #$paybatch .= ':'. $transaction->order_number
3539 # if $transaction->can('order_number')
3540 # && length($transaction->order_number);
3542 my $paybatch = 'FakeProcessor:54:32';
3544 my $cust_pay = new FS::cust_pay ( {
3545 'custnum' => $self->custnum,
3546 'invnum' => $options{'invnum'},
3549 'payby' => $method2payby{$method},
3550 #'payinfo' => $payinfo,
3551 'payinfo' => '4111111111111111',
3552 'paybatch' => $paybatch,
3553 #'paydate' => $paydate,
3554 'paydate' => '2012-05-01',
3556 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3558 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3561 $cust_pay->invnum(''); #try again with no specific invnum
3562 my $error2 = $cust_pay->insert( $options{'manual'} ?
3563 ( 'manual' => 1 ) : ()
3566 # gah, even with transactions.
3567 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3568 "error inserting (fake!) payment: $error2".
3569 " (previously tried insert with invnum #$options{'invnum'}" .
3576 if ( $options{'paynum_ref'} ) {
3577 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3580 return ''; #no error
3584 =item default_payment_gateway
3588 sub default_payment_gateway {
3589 my( $self, $method ) = @_;
3591 die "Real-time processing not enabled\n"
3592 unless $conf->exists('business-onlinepayment');
3595 my $bop_config = 'business-onlinepayment';
3596 $bop_config .= '-ach'
3597 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3598 my ( $processor, $login, $password, $action, @bop_options ) =
3599 $conf->config($bop_config);
3600 $action ||= 'normal authorization';
3601 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3602 die "No real-time processor is enabled - ".
3603 "did you set the business-onlinepayment configuration value?\n"
3606 ( $processor, $login, $password, $action, @bop_options )
3611 Removes the I<paycvv> field from the database directly.
3613 If there is an error, returns the error, otherwise returns false.
3619 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3620 or return dbh->errstr;
3621 $sth->execute($self->custnum)
3622 or return $sth->errstr;
3627 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3629 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3630 via a Business::OnlinePayment realtime gateway. See
3631 L<http://420.am/business-onlinepayment> for supported gateways.
3633 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3635 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3637 Most gateways require a reference to an original payment transaction to refund,
3638 so you probably need to specify a I<paynum>.
3640 I<amount> defaults to the original amount of the payment if not specified.
3642 I<reason> specifies a reason for the refund.
3644 I<paydate> specifies the expiration date for a credit card overriding the
3645 value from the customer record or the payment record. Specified as yyyy-mm-dd
3647 Implementation note: If I<amount> is unspecified or equal to the amount of the
3648 orignal payment, first an attempt is made to "void" the transaction via
3649 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3650 the normal attempt is made to "refund" ("credit") the transaction via the
3651 gateway is attempted.
3653 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3654 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3655 #if set, will override the value from the customer record.
3657 #If an I<invnum> is specified, this payment (if successful) is applied to the
3658 #specified invoice. If you don't specify an I<invnum> you might want to
3659 #call the B<apply_payments> method.
3663 #some false laziness w/realtime_bop, not enough to make it worth merging
3664 #but some useful small subs should be pulled out
3665 sub realtime_refund_bop {
3666 my( $self, $method, %options ) = @_;
3668 warn "$me realtime_refund_bop: $method refund\n";
3669 warn " $_ => $options{$_}\n" foreach keys %options;
3672 eval "use Business::OnlinePayment";
3676 # look up the original payment and optionally a gateway for that payment
3680 my $amount = $options{'amount'};
3682 my( $processor, $login, $password, @bop_options ) ;
3683 my( $auth, $order_number ) = ( '', '', '' );
3685 if ( $options{'paynum'} ) {
3687 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3688 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3689 or return "Unknown paynum $options{'paynum'}";
3690 $amount ||= $cust_pay->paid;
3692 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3693 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3694 $cust_pay->paybatch;
3695 my $gatewaynum = '';
3696 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3698 if ( $gatewaynum ) { #gateway for the payment to be refunded
3700 my $payment_gateway =
3701 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3702 die "payment gateway $gatewaynum not found"
3703 unless $payment_gateway;
3705 $processor = $payment_gateway->gateway_module;
3706 $login = $payment_gateway->gateway_username;
3707 $password = $payment_gateway->gateway_password;
3708 @bop_options = $payment_gateway->options;
3710 } else { #try the default gateway
3712 my( $conf_processor, $unused_action );
3713 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3714 $self->default_payment_gateway($method);
3716 return "processor of payment $options{'paynum'} $processor does not".
3717 " match default processor $conf_processor"
3718 unless $processor eq $conf_processor;
3723 } else { # didn't specify a paynum, so look for agent gateway overrides
3724 # like a normal transaction
3727 if ( $method eq 'CC' ) {
3728 $cardtype = cardtype($self->payinfo);
3729 } elsif ( $method eq 'ECHECK' ) {
3732 $cardtype = $method;
3735 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3736 cardtype => $cardtype,
3738 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3740 taxclass => '', } );
3742 if ( $override ) { #use a payment gateway override
3744 my $payment_gateway = $override->payment_gateway;
3746 $processor = $payment_gateway->gateway_module;
3747 $login = $payment_gateway->gateway_username;
3748 $password = $payment_gateway->gateway_password;
3749 #$action = $payment_gateway->gateway_action;
3750 @bop_options = $payment_gateway->options;
3752 } else { #use the standard settings from the config
3755 ( $processor, $login, $password, $unused_action, @bop_options ) =
3756 $self->default_payment_gateway($method);
3761 return "neither amount nor paynum specified" unless $amount;
3766 'password' => $password,
3767 'order_number' => $order_number,
3768 'amount' => $amount,
3769 'referer' => 'http://cleanwhisker.420.am/',
3771 $content{authorization} = $auth
3772 if length($auth); #echeck/ACH transactions have an order # but no auth
3773 #(at least with authorize.net)
3775 my $disable_void_after;
3776 if ($conf->exists('disable_void_after')
3777 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3778 $disable_void_after = $1;
3781 #first try void if applicable
3782 if ( $cust_pay && $cust_pay->paid == $amount
3784 ( not defined($disable_void_after) )
3785 || ( time < ($cust_pay->_date + $disable_void_after ) )
3788 warn " attempting void\n" if $DEBUG > 1;
3789 my $void = new Business::OnlinePayment( $processor, @bop_options );
3790 $void->content( 'action' => 'void', %content );
3792 if ( $void->is_success ) {
3793 my $error = $cust_pay->void($options{'reason'});
3795 # gah, even with transactions.
3796 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3797 "error voiding payment: $error";
3801 warn " void successful\n" if $DEBUG > 1;
3806 warn " void unsuccessful, trying refund\n"
3810 my $address = $self->address1;
3811 $address .= ", ". $self->address2 if $self->address2;
3813 my($payname, $payfirst, $paylast);
3814 if ( $self->payname && $method ne 'ECHECK' ) {
3815 $payname = $self->payname;
3816 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3817 or return "Illegal payname $payname";
3818 ($payfirst, $paylast) = ($1, $2);
3820 $payfirst = $self->getfield('first');
3821 $paylast = $self->getfield('last');
3822 $payname = "$payfirst $paylast";
3825 my @invoicing_list = $self->invoicing_list_emailonly;
3826 if ( $conf->exists('emailinvoiceautoalways')
3827 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3828 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3829 push @invoicing_list, $self->all_emails;
3832 my $email = ($conf->exists('business-onlinepayment-email-override'))
3833 ? $conf->config('business-onlinepayment-email-override')
3834 : $invoicing_list[0];
3836 my $payip = exists($options{'payip'})
3839 $content{customer_ip} = $payip
3843 if ( $method eq 'CC' ) {
3846 $content{card_number} = $payinfo = $cust_pay->payinfo;
3847 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3848 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3849 ($content{expiration} = "$2/$1"); # where available
3851 $content{card_number} = $payinfo = $self->payinfo;
3852 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3853 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3854 $content{expiration} = "$2/$1";
3857 } elsif ( $method eq 'ECHECK' ) {
3860 $payinfo = $cust_pay->payinfo;
3862 $payinfo = $self->payinfo;
3864 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3865 $content{bank_name} = $self->payname;
3866 $content{account_type} = 'CHECKING';
3867 $content{account_name} = $payname;
3868 $content{customer_org} = $self->company ? 'B' : 'I';
3869 $content{customer_ssn} = $self->ss;
3870 } elsif ( $method eq 'LEC' ) {
3871 $content{phone} = $payinfo = $self->payinfo;
3875 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3876 my %sub_content = $refund->content(
3877 'action' => 'credit',
3878 'customer_id' => $self->custnum,
3879 'last_name' => $paylast,
3880 'first_name' => $payfirst,
3882 'address' => $address,
3883 'city' => $self->city,
3884 'state' => $self->state,
3885 'zip' => $self->zip,
3886 'country' => $self->country,
3888 'phone' => $self->daytime || $self->night,
3891 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3895 return "$processor error: ". $refund->error_message
3896 unless $refund->is_success();
3898 my %method2payby = (
3904 my $paybatch = "$processor:". $refund->authorization;
3905 $paybatch .= ':'. $refund->order_number
3906 if $refund->can('order_number') && $refund->order_number;
3908 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3909 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3910 last unless @cust_bill_pay;
3911 my $cust_bill_pay = pop @cust_bill_pay;
3912 my $error = $cust_bill_pay->delete;
3916 my $cust_refund = new FS::cust_refund ( {
3917 'custnum' => $self->custnum,
3918 'paynum' => $options{'paynum'},
3919 'refund' => $amount,
3921 'payby' => $method2payby{$method},
3922 'payinfo' => $payinfo,
3923 'paybatch' => $paybatch,
3924 'reason' => $options{'reason'} || 'card or ACH refund',
3926 my $error = $cust_refund->insert;
3928 $cust_refund->paynum(''); #try again with no specific paynum
3929 my $error2 = $cust_refund->insert;
3931 # gah, even with transactions.
3932 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3933 "error inserting refund ($processor): $error2".
3934 " (previously tried insert with paynum #$options{'paynum'}" .
3945 =item batch_card OPTION => VALUE...
3947 Adds a payment for this invoice to the pending credit card batch (see
3948 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3949 runs the payment using a realtime gateway.
3954 my ($self, %options) = @_;
3957 if (exists($options{amount})) {
3958 $amount = $options{amount};
3960 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3962 return '' unless $amount > 0;
3964 my $invnum = delete $options{invnum};
3965 my $payby = $options{invnum} || $self->payby; #dubious
3967 if ($options{'realtime'}) {
3968 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3974 my $oldAutoCommit = $FS::UID::AutoCommit;
3975 local $FS::UID::AutoCommit = 0;
3978 #this needs to handle mysql as well as Pg, like svc_acct.pm
3979 #(make it into a common function if folks need to do batching with mysql)
3980 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3981 or return "Cannot lock pay_batch: " . $dbh->errstr;
3985 'payby' => FS::payby->payby2payment($payby),
3988 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3990 unless ( $pay_batch ) {
3991 $pay_batch = new FS::pay_batch \%pay_batch;
3992 my $error = $pay_batch->insert;
3994 $dbh->rollback if $oldAutoCommit;
3995 die "error creating new batch: $error\n";
3999 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
4000 'batchnum' => $pay_batch->batchnum,
4001 'custnum' => $self->custnum,
4004 foreach (qw( address1 address2 city state zip country payby payinfo paydate
4006 $options{$_} = '' unless exists($options{$_});
4009 my $cust_pay_batch = new FS::cust_pay_batch ( {
4010 'batchnum' => $pay_batch->batchnum,
4011 'invnum' => $invnum || 0, # is there a better value?
4012 # this field should be
4014 # cust_bill_pay_batch now
4015 'custnum' => $self->custnum,
4016 'last' => $self->getfield('last'),
4017 'first' => $self->getfield('first'),
4018 'address1' => $options{address1} || $self->address1,
4019 'address2' => $options{address2} || $self->address2,
4020 'city' => $options{city} || $self->city,
4021 'state' => $options{state} || $self->state,
4022 'zip' => $options{zip} || $self->zip,
4023 'country' => $options{country} || $self->country,
4024 'payby' => $options{payby} || $self->payby,
4025 'payinfo' => $options{payinfo} || $self->payinfo,
4026 'exp' => $options{paydate} || $self->paydate,
4027 'payname' => $options{payname} || $self->payname,
4028 'amount' => $amount, # consolidating
4031 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
4032 if $old_cust_pay_batch;
4035 if ($old_cust_pay_batch) {
4036 $error = $cust_pay_batch->replace($old_cust_pay_batch)
4038 $error = $cust_pay_batch->insert;
4042 $dbh->rollback if $oldAutoCommit;
4046 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
4047 foreach my $cust_bill ($self->open_cust_bill) {
4048 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
4049 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
4050 'invnum' => $cust_bill->invnum,
4051 'paybatchnum' => $cust_pay_batch->paybatchnum,
4052 'amount' => $cust_bill->owed,
4055 if ($unapplied >= $cust_bill_pay_batch->amount){
4056 $unapplied -= $cust_bill_pay_batch->amount;
4059 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
4060 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
4062 $error = $cust_bill_pay_batch->insert;
4064 $dbh->rollback if $oldAutoCommit;
4069 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4075 Returns the total owed for this customer on all invoices
4076 (see L<FS::cust_bill/owed>).
4082 $self->total_owed_date(2145859200); #12/31/2037
4085 =item total_owed_date TIME
4087 Returns the total owed for this customer on all invoices with date earlier than
4088 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
4089 see L<Time::Local> and L<Date::Parse> for conversion functions.
4093 sub total_owed_date {
4097 foreach my $cust_bill (
4098 grep { $_->_date <= $time }
4099 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4101 $total_bill += $cust_bill->owed;
4103 sprintf( "%.2f", $total_bill );
4106 =item apply_payments_and_credits
4108 Applies unapplied payments and credits.
4110 In most cases, this new method should be used in place of sequential
4111 apply_payments and apply_credits methods.
4113 If there is an error, returns the error, otherwise returns false.
4117 sub apply_payments_and_credits {
4120 local $SIG{HUP} = 'IGNORE';
4121 local $SIG{INT} = 'IGNORE';
4122 local $SIG{QUIT} = 'IGNORE';
4123 local $SIG{TERM} = 'IGNORE';
4124 local $SIG{TSTP} = 'IGNORE';
4125 local $SIG{PIPE} = 'IGNORE';
4127 my $oldAutoCommit = $FS::UID::AutoCommit;
4128 local $FS::UID::AutoCommit = 0;
4131 $self->select_for_update; #mutex
4133 foreach my $cust_bill ( $self->open_cust_bill ) {
4134 my $error = $cust_bill->apply_payments_and_credits;
4136 $dbh->rollback if $oldAutoCommit;
4137 return "Error applying: $error";
4141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4146 =item apply_credits OPTION => VALUE ...
4148 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4149 to outstanding invoice balances in chronological order (or reverse
4150 chronological order if the I<order> option is set to B<newest>) and returns the
4151 value of any remaining unapplied credits available for refund (see
4152 L<FS::cust_refund>).
4154 Dies if there is an error.
4162 local $SIG{HUP} = 'IGNORE';
4163 local $SIG{INT} = 'IGNORE';
4164 local $SIG{QUIT} = 'IGNORE';
4165 local $SIG{TERM} = 'IGNORE';
4166 local $SIG{TSTP} = 'IGNORE';
4167 local $SIG{PIPE} = 'IGNORE';
4169 my $oldAutoCommit = $FS::UID::AutoCommit;
4170 local $FS::UID::AutoCommit = 0;
4173 $self->select_for_update; #mutex
4175 unless ( $self->total_credited ) {
4176 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4180 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4181 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4183 my @invoices = $self->open_cust_bill;
4184 @invoices = sort { $b->_date <=> $a->_date } @invoices
4185 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4188 foreach my $cust_bill ( @invoices ) {
4191 if ( !defined($credit) || $credit->credited == 0) {
4192 $credit = pop @credits or last;
4195 if ($cust_bill->owed >= $credit->credited) {
4196 $amount=$credit->credited;
4198 $amount=$cust_bill->owed;
4201 my $cust_credit_bill = new FS::cust_credit_bill ( {
4202 'crednum' => $credit->crednum,
4203 'invnum' => $cust_bill->invnum,
4204 'amount' => $amount,
4206 my $error = $cust_credit_bill->insert;
4208 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4212 redo if ($cust_bill->owed > 0);
4216 my $total_credited = $self->total_credited;
4218 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4220 return $total_credited;
4223 =item apply_payments
4225 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4226 to outstanding invoice balances in chronological order.
4228 #and returns the value of any remaining unapplied payments.
4230 Dies if there is an error.
4234 sub apply_payments {
4237 local $SIG{HUP} = 'IGNORE';
4238 local $SIG{INT} = 'IGNORE';
4239 local $SIG{QUIT} = 'IGNORE';
4240 local $SIG{TERM} = 'IGNORE';
4241 local $SIG{TSTP} = 'IGNORE';
4242 local $SIG{PIPE} = 'IGNORE';
4244 my $oldAutoCommit = $FS::UID::AutoCommit;
4245 local $FS::UID::AutoCommit = 0;
4248 $self->select_for_update; #mutex
4252 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4253 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4255 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4256 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4260 foreach my $cust_bill ( @invoices ) {
4263 if ( !defined($payment) || $payment->unapplied == 0 ) {
4264 $payment = pop @payments or last;
4267 if ( $cust_bill->owed >= $payment->unapplied ) {
4268 $amount = $payment->unapplied;
4270 $amount = $cust_bill->owed;
4273 my $cust_bill_pay = new FS::cust_bill_pay ( {
4274 'paynum' => $payment->paynum,
4275 'invnum' => $cust_bill->invnum,
4276 'amount' => $amount,
4278 my $error = $cust_bill_pay->insert;
4280 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4284 redo if ( $cust_bill->owed > 0);
4288 my $total_unapplied_payments = $self->total_unapplied_payments;
4290 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4292 return $total_unapplied_payments;
4295 =item total_credited
4297 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4298 customer. See L<FS::cust_credit/credited>.
4302 sub total_credited {
4304 my $total_credit = 0;
4305 foreach my $cust_credit ( qsearch('cust_credit', {
4306 'custnum' => $self->custnum,
4308 $total_credit += $cust_credit->credited;
4310 sprintf( "%.2f", $total_credit );
4313 =item total_unapplied_payments
4315 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4316 See L<FS::cust_pay/unapplied>.
4320 sub total_unapplied_payments {
4322 my $total_unapplied = 0;
4323 foreach my $cust_pay ( qsearch('cust_pay', {
4324 'custnum' => $self->custnum,
4326 $total_unapplied += $cust_pay->unapplied;
4328 sprintf( "%.2f", $total_unapplied );
4331 =item total_unapplied_refunds
4333 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4334 customer. See L<FS::cust_refund/unapplied>.
4338 sub total_unapplied_refunds {
4340 my $total_unapplied = 0;
4341 foreach my $cust_refund ( qsearch('cust_refund', {
4342 'custnum' => $self->custnum,
4344 $total_unapplied += $cust_refund->unapplied;
4346 sprintf( "%.2f", $total_unapplied );
4351 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4352 total_credited minus total_unapplied_payments).
4360 + $self->total_unapplied_refunds
4361 - $self->total_credited
4362 - $self->total_unapplied_payments
4366 =item balance_date TIME
4368 Returns the balance for this customer, only considering invoices with date
4369 earlier than TIME (total_owed_date minus total_credited minus
4370 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4371 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4380 $self->total_owed_date($time)
4381 + $self->total_unapplied_refunds
4382 - $self->total_credited
4383 - $self->total_unapplied_payments
4387 =item in_transit_payments
4389 Returns the total of requests for payments for this customer pending in
4390 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4394 sub in_transit_payments {
4396 my $in_transit_payments = 0;
4397 foreach my $pay_batch ( qsearch('pay_batch', {
4400 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4401 'batchnum' => $pay_batch->batchnum,
4402 'custnum' => $self->custnum,
4404 $in_transit_payments += $cust_pay_batch->amount;
4407 sprintf( "%.2f", $in_transit_payments );
4410 =item paydate_monthyear
4412 Returns a two-element list consisting of the month and year of this customer's
4413 paydate (credit card expiration date for CARD customers)
4417 sub paydate_monthyear {
4419 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4421 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4428 =item invoicing_list [ ARRAYREF ]
4430 If an arguement is given, sets these email addresses as invoice recipients
4431 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4432 (except as warnings), so use check_invoicing_list first.
4434 Returns a list of email addresses (with svcnum entries expanded).
4436 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4437 check it without disturbing anything by passing nothing.
4439 This interface may change in the future.
4443 sub invoicing_list {
4444 my( $self, $arrayref ) = @_;
4447 my @cust_main_invoice;
4448 if ( $self->custnum ) {
4449 @cust_main_invoice =
4450 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4452 @cust_main_invoice = ();
4454 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4455 #warn $cust_main_invoice->destnum;
4456 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4457 #warn $cust_main_invoice->destnum;
4458 my $error = $cust_main_invoice->delete;
4459 warn $error if $error;
4462 if ( $self->custnum ) {
4463 @cust_main_invoice =
4464 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4466 @cust_main_invoice = ();
4468 my %seen = map { $_->address => 1 } @cust_main_invoice;
4469 foreach my $address ( @{$arrayref} ) {
4470 next if exists $seen{$address} && $seen{$address};
4471 $seen{$address} = 1;
4472 my $cust_main_invoice = new FS::cust_main_invoice ( {
4473 'custnum' => $self->custnum,
4476 my $error = $cust_main_invoice->insert;
4477 warn $error if $error;
4481 if ( $self->custnum ) {
4483 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4490 =item check_invoicing_list ARRAYREF
4492 Checks these arguements as valid input for the invoicing_list method. If there
4493 is an error, returns the error, otherwise returns false.
4497 sub check_invoicing_list {
4498 my( $self, $arrayref ) = @_;
4500 foreach my $address ( @$arrayref ) {
4502 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4503 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4506 my $cust_main_invoice = new FS::cust_main_invoice ( {
4507 'custnum' => $self->custnum,
4510 my $error = $self->custnum
4511 ? $cust_main_invoice->check
4512 : $cust_main_invoice->checkdest
4514 return $error if $error;
4518 return "Email address required"
4519 if $conf->exists('cust_main-require_invoicing_list_email')
4520 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4525 =item set_default_invoicing_list
4527 Sets the invoicing list to all accounts associated with this customer,
4528 overwriting any previous invoicing list.
4532 sub set_default_invoicing_list {
4534 $self->invoicing_list($self->all_emails);
4539 Returns the email addresses of all accounts provisioned for this customer.
4546 foreach my $cust_pkg ( $self->all_pkgs ) {
4547 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4549 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4550 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4552 $list{$_}=1 foreach map { $_->email } @svc_acct;
4557 =item invoicing_list_addpost
4559 Adds postal invoicing to this customer. If this customer is already configured
4560 to receive postal invoices, does nothing.
4564 sub invoicing_list_addpost {
4566 return if grep { $_ eq 'POST' } $self->invoicing_list;
4567 my @invoicing_list = $self->invoicing_list;
4568 push @invoicing_list, 'POST';
4569 $self->invoicing_list(\@invoicing_list);
4572 =item invoicing_list_emailonly
4574 Returns the list of email invoice recipients (invoicing_list without non-email
4575 destinations such as POST and FAX).
4579 sub invoicing_list_emailonly {
4581 warn "$me invoicing_list_emailonly called"
4583 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4586 =item invoicing_list_emailonly_scalar
4588 Returns the list of email invoice recipients (invoicing_list without non-email
4589 destinations such as POST and FAX) as a comma-separated scalar.
4593 sub invoicing_list_emailonly_scalar {
4595 warn "$me invoicing_list_emailonly_scalar called"
4597 join(', ', $self->invoicing_list_emailonly);
4600 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4602 Returns an array of customers referred by this customer (referral_custnum set
4603 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4604 customers referred by customers referred by this customer and so on, inclusive.
4605 The default behavior is DEPTH 1 (no recursion).
4609 sub referral_cust_main {
4611 my $depth = @_ ? shift : 1;
4612 my $exclude = @_ ? shift : {};
4615 map { $exclude->{$_->custnum}++; $_; }
4616 grep { ! $exclude->{ $_->custnum } }
4617 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4621 map { $_->referral_cust_main($depth-1, $exclude) }
4628 =item referral_cust_main_ncancelled
4630 Same as referral_cust_main, except only returns customers with uncancelled
4635 sub referral_cust_main_ncancelled {
4637 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4640 =item referral_cust_pkg [ DEPTH ]
4642 Like referral_cust_main, except returns a flat list of all unsuspended (and
4643 uncancelled) packages for each customer. The number of items in this list may
4644 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4648 sub referral_cust_pkg {
4650 my $depth = @_ ? shift : 1;
4652 map { $_->unsuspended_pkgs }
4653 grep { $_->unsuspended_pkgs }
4654 $self->referral_cust_main($depth);
4657 =item referring_cust_main
4659 Returns the single cust_main record for the customer who referred this customer
4660 (referral_custnum), or false.
4664 sub referring_cust_main {
4666 return '' unless $self->referral_custnum;
4667 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4670 =item credit AMOUNT, REASON
4672 Applies a credit to this customer. If there is an error, returns the error,
4673 otherwise returns false.
4678 my( $self, $amount, $reason, %options ) = @_;
4679 my $cust_credit = new FS::cust_credit {
4680 'custnum' => $self->custnum,
4681 'amount' => $amount,
4682 'reason' => $reason,
4684 $cust_credit->insert(%options);
4687 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4689 Creates a one-time charge for this customer. If there is an error, returns
4690 the error, otherwise returns false.
4696 my ( $amount, $quantity, $pkg, $comment, $taxclass, $additional, $classnum );
4697 if ( ref( $_[0] ) ) {
4698 $amount = $_[0]->{amount};
4699 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
4700 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4701 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4702 : '$'. sprintf("%.2f",$amount);
4703 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4704 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4705 $additional = $_[0]->{additional};
4709 $pkg = @_ ? shift : 'One-time charge';
4710 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4711 $taxclass = @_ ? shift : '';
4715 local $SIG{HUP} = 'IGNORE';
4716 local $SIG{INT} = 'IGNORE';
4717 local $SIG{QUIT} = 'IGNORE';
4718 local $SIG{TERM} = 'IGNORE';
4719 local $SIG{TSTP} = 'IGNORE';
4720 local $SIG{PIPE} = 'IGNORE';
4722 my $oldAutoCommit = $FS::UID::AutoCommit;
4723 local $FS::UID::AutoCommit = 0;
4726 my $part_pkg = new FS::part_pkg ( {
4728 'comment' => $comment,
4732 'classnum' => $classnum ? $classnum : '',
4733 'taxclass' => $taxclass,
4736 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4737 ( 0 .. @$additional - 1 )
4739 'additional_count' => scalar(@$additional),
4740 'setup_fee' => $amount,
4743 my $error = $part_pkg->insert( options => \%options );
4745 $dbh->rollback if $oldAutoCommit;
4749 my $pkgpart = $part_pkg->pkgpart;
4750 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4751 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4752 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4753 $error = $type_pkgs->insert;
4755 $dbh->rollback if $oldAutoCommit;
4760 my $cust_pkg = new FS::cust_pkg ( {
4761 'custnum' => $self->custnum,
4762 'pkgpart' => $pkgpart,
4763 'quantity' => $quantity,
4766 $error = $cust_pkg->insert;
4768 $dbh->rollback if $oldAutoCommit;
4772 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4777 #=item charge_postal_fee
4779 #Applies a one time charge this customer. If there is an error,
4780 #returns the error, returns the cust_pkg charge object or false
4781 #if there was no charge.
4785 # This should be a customer event. For that to work requires that bill
4786 # also be a customer event.
4788 sub charge_postal_fee {
4791 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
4792 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
4794 my $cust_pkg = new FS::cust_pkg ( {
4795 'custnum' => $self->custnum,
4796 'pkgpart' => $pkgpart,
4800 my $error = $cust_pkg->insert;
4801 $error ? $error : $cust_pkg;
4806 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4812 sort { $a->_date <=> $b->_date }
4813 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4816 =item open_cust_bill
4818 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4823 sub open_cust_bill {
4825 grep { $_->owed > 0 } $self->cust_bill;
4830 Returns all the credits (see L<FS::cust_credit>) for this customer.
4836 sort { $a->_date <=> $b->_date }
4837 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4842 Returns all the payments (see L<FS::cust_pay>) for this customer.
4848 sort { $a->_date <=> $b->_date }
4849 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4854 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4860 sort { $a->_date <=> $b->_date }
4861 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4864 =item cust_pay_batch
4866 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4870 sub cust_pay_batch {
4872 sort { $a->_date <=> $b->_date }
4873 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4878 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4884 sort { $a->_date <=> $b->_date }
4885 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4890 Returns a name string for this customer, either "Company (Last, First)" or
4897 my $name = $self->contact;
4898 $name = $self->company. " ($name)" if $self->company;
4904 Returns a name string for this (service/shipping) contact, either
4905 "Company (Last, First)" or "Last, First".
4911 if ( $self->get('ship_last') ) {
4912 my $name = $self->ship_contact;
4913 $name = $self->ship_company. " ($name)" if $self->ship_company;
4922 Returns this customer's full (billing) contact name only, "Last, First"
4928 $self->get('last'). ', '. $self->first;
4933 Returns this customer's full (shipping) contact name only, "Last, First"
4939 $self->get('ship_last')
4940 ? $self->get('ship_last'). ', '. $self->ship_first
4946 Returns this customer's full country name
4952 code2country($self->country);
4955 =item geocode DATA_VENDOR
4957 Returns a value for the customer location as encoded by DATA_VENDOR.
4958 Currently this only makes sense for "CCH" as DATA_VENDOR.
4963 my ($self, $data_vendor) = (shift, shift); #always cch for now
4965 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
4969 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
4970 if $self->country eq 'US';
4972 #CCH specific location stuff
4973 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
4976 my $cust_tax_location =
4978 'table' => 'cust_tax_location',
4979 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
4980 'extra_sql' => $extra_sql,
4983 $geocode = $cust_tax_location->geocode
4984 if $cust_tax_location;
4993 Returns a status string for this customer, currently:
4997 =item prospect - No packages have ever been ordered
4999 =item active - One or more recurring packages is active
5001 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
5003 =item suspended - All non-cancelled recurring packages are suspended
5005 =item cancelled - All recurring packages are cancelled
5011 sub status { shift->cust_status(@_); }
5015 for my $status (qw( prospect active inactive suspended cancelled )) {
5016 my $method = $status.'_sql';
5017 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
5018 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
5019 $sth->execute( ($self->custnum) x $numnum )
5020 or die "Error executing 'SELECT $sql': ". $sth->errstr;
5021 return $status if $sth->fetchrow_arrayref->[0];
5025 =item ucfirst_cust_status
5027 =item ucfirst_status
5029 Returns the status with the first character capitalized.
5033 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
5035 sub ucfirst_cust_status {
5037 ucfirst($self->cust_status);
5042 Returns a hex triplet color string for this customer's status.
5046 use vars qw(%statuscolor);
5047 tie %statuscolor, 'Tie::IxHash',
5048 'prospect' => '7e0079', #'000000', #black? naw, purple
5049 'active' => '00CC00', #green
5050 'inactive' => '0000CC', #blue
5051 'suspended' => 'FF9900', #yellow
5052 'cancelled' => 'FF0000', #red
5055 sub statuscolor { shift->cust_statuscolor(@_); }
5057 sub cust_statuscolor {
5059 $statuscolor{$self->cust_status};
5064 Returns an array of hashes representing the customer's RT tickets.
5071 my $num = $conf->config('cust_main-max_tickets') || 10;
5074 unless ( $conf->config('ticket_system-custom_priority_field') ) {
5076 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
5080 foreach my $priority (
5081 $conf->config('ticket_system-custom_priority_field-values'), ''
5083 last if scalar(@tickets) >= $num;
5085 @{ FS::TicketSystem->customer_tickets( $self->custnum,
5086 $num - scalar(@tickets),
5095 # Return services representing svc_accts in customer support packages
5096 sub support_services {
5098 my %packages = map { $_ => 1 } $conf->config('support_packages');
5100 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
5101 grep { $_->part_svc->svcdb eq 'svc_acct' }
5102 map { $_->cust_svc }
5103 grep { exists $packages{ $_->pkgpart } }
5104 $self->ncancelled_pkgs;
5110 =head1 CLASS METHODS
5116 Class method that returns the list of possible status strings for customers
5117 (see L<the status method|/status>). For example:
5119 @statuses = FS::cust_main->statuses();
5124 #my $self = shift; #could be class...
5130 Returns an SQL expression identifying prospective cust_main records (customers
5131 with no packages ever ordered)
5135 use vars qw($select_count_pkgs);
5136 $select_count_pkgs =
5137 "SELECT COUNT(*) FROM cust_pkg
5138 WHERE cust_pkg.custnum = cust_main.custnum";
5140 sub select_count_pkgs_sql {
5144 sub prospect_sql { "
5145 0 = ( $select_count_pkgs )
5150 Returns an SQL expression identifying active cust_main records (customers with
5151 active recurring packages).
5156 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5162 Returns an SQL expression identifying inactive cust_main records (customers with
5163 no active recurring packages, but otherwise unsuspended/uncancelled).
5167 sub inactive_sql { "
5168 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5170 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5176 Returns an SQL expression identifying suspended cust_main records.
5181 sub suspended_sql { susp_sql(@_); }
5183 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5185 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5191 Returns an SQL expression identifying cancelled cust_main records.
5195 sub cancelled_sql { cancel_sql(@_); }
5198 my $recurring_sql = FS::cust_pkg->recurring_sql;
5199 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
5202 0 < ( $select_count_pkgs )
5203 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
5204 AND 0 = ( $select_count_pkgs AND $recurring_sql
5205 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5207 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5213 =item uncancelled_sql
5215 Returns an SQL expression identifying un-cancelled cust_main records.
5219 sub uncancelled_sql { uncancel_sql(@_); }
5220 sub uncancel_sql { "
5221 ( 0 < ( $select_count_pkgs
5222 AND ( cust_pkg.cancel IS NULL
5223 OR cust_pkg.cancel = 0
5226 OR 0 = ( $select_count_pkgs )
5232 Returns an SQL fragment to retreive the balance.
5237 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5238 WHERE cust_bill.custnum = cust_main.custnum )
5239 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5240 WHERE cust_pay.custnum = cust_main.custnum )
5241 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5242 WHERE cust_credit.custnum = cust_main.custnum )
5243 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5244 WHERE cust_refund.custnum = cust_main.custnum )
5247 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5249 Returns an SQL fragment to retreive the balance for this customer, only
5250 considering invoices with date earlier than START_TIME, and optionally not
5251 later than END_TIME (total_owed_date minus total_credited minus
5252 total_unapplied_payments).
5254 Times are specified as SQL fragments or numeric
5255 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5256 L<Date::Parse> for conversion functions. The empty string can be passed
5257 to disable that time constraint completely.
5259 Available options are:
5263 =item unapplied_date
5265 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 (or is it?), probably a bad idea for event triggering)
5270 set to true to remove all customer comparison clauses, for totals
5275 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5280 JOIN clause (typically used with the total option)
5286 sub balance_date_sql {
5287 my( $class, $start, $end, %opt ) = @_;
5289 my $owed = FS::cust_bill->owed_sql;
5290 my $unapp_refund = FS::cust_refund->unapplied_sql;
5291 my $unapp_credit = FS::cust_credit->unapplied_sql;
5292 my $unapp_pay = FS::cust_pay->unapplied_sql;
5294 my $j = $opt{'join'} || '';
5296 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5297 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5298 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5299 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5301 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5302 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5303 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5304 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5309 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5311 Helper method for balance_date_sql; name (and usage) subject to change
5312 (suggestions welcome).
5314 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5315 cust_refund, cust_credit or cust_pay).
5317 If TABLE is "cust_bill" or the unapplied_date option is true, only
5318 considers records with date earlier than START_TIME, and optionally not
5319 later than END_TIME .
5323 sub _money_table_where {
5324 my( $class, $table, $start, $end, %opt ) = @_;
5327 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5328 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5329 push @where, "$table._date <= $start" if defined($start) && length($start);
5330 push @where, "$table._date > $end" if defined($end) && length($end);
5332 push @where, @{$opt{'where'}} if $opt{'where'};
5333 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5339 =item search_sql HASHREF
5343 Returns a qsearch hash expression to search for parameters specified in HREF.
5344 Valid parameters are
5352 =item cancelled_pkgs
5358 listref of start date, end date
5364 =item current_balance
5366 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
5370 =item flattened_pkgs
5379 my ($class, $params) = @_;
5390 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5392 "cust_main.agentnum = $1";
5399 #prospect active inactive suspended cancelled
5400 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
5401 my $method = $params->{'status'}. '_sql';
5402 #push @where, $class->$method();
5403 push @where, FS::cust_main->$method();
5407 # parse cancelled package checkbox
5412 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
5413 unless $params->{'cancelled_pkgs'};
5419 foreach my $field (qw( signupdate )) {
5421 next unless exists($params->{$field});
5423 my($beginning, $ending) = @{$params->{$field}};
5426 "cust_main.$field IS NOT NULL",
5427 "cust_main.$field >= $beginning",
5428 "cust_main.$field <= $ending";
5430 $orderby ||= "ORDER BY cust_main.$field";
5438 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
5440 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
5447 #my $balance_sql = $class->balance_sql();
5448 my $balance_sql = FS::cust_main->balance_sql();
5450 push @where, map { s/current_balance/$balance_sql/; $_ }
5451 @{ $params->{'current_balance'} };
5454 # setup queries, subs, etc. for the search
5457 $orderby ||= 'ORDER BY custnum';
5459 # here is the agent virtualization
5460 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
5462 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5464 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
5466 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
5468 my $select = join(', ',
5469 'cust_main.custnum',
5470 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
5473 my(@extra_headers) = ();
5474 my(@extra_fields) = ();
5476 if ($params->{'flattened_pkgs'}) {
5478 if ($dbh->{Driver}->{Name} eq 'Pg') {
5480 $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";
5482 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
5483 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
5484 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
5486 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
5487 "omitting packing information from report.";
5490 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";
5492 my $sth = dbh->prepare($header_query) or die dbh->errstr;
5493 $sth->execute() or die $sth->errstr;
5494 my $headerrow = $sth->fetchrow_arrayref;
5495 my $headercount = $headerrow ? $headerrow->[0] : 0;
5496 while($headercount) {
5497 unshift @extra_headers, "Package ". $headercount;
5498 unshift @extra_fields, eval q!sub {my $c = shift;
5499 my @a = split '\|', $c->magic;
5500 my $p = $a[!.--$headercount. q!];
5508 'table' => 'cust_main',
5509 'select' => $select,
5511 'extra_sql' => $extra_sql,
5512 'order_by' => $orderby,
5513 'count_query' => $count_query,
5514 'extra_headers' => \@extra_headers,
5515 'extra_fields' => \@extra_fields,
5520 =item email_search_sql HASHREF
5524 Emails a notice to the specified customers.
5526 Valid parameters are those of the L<search_sql> method, plus the following:
5548 Optional job queue job for status updates.
5552 Returns an error message, or false for success.
5554 If an error occurs during any email, stops the enture send and returns that
5555 error. Presumably if you're getting SMTP errors aborting is better than
5556 retrying everything.
5560 sub email_search_sql {
5561 my($class, $params) = @_;
5563 my $from = delete $params->{from};
5564 my $subject = delete $params->{subject};
5565 my $html_body = delete $params->{html_body};
5566 my $text_body = delete $params->{text_body};
5568 my $job = delete $params->{'job'};
5570 my $sql_query = $class->search_sql($params);
5572 my $count_query = delete($sql_query->{'count_query'});
5573 my $count_sth = dbh->prepare($count_query)
5574 or die "Error preparing $count_query: ". dbh->errstr;
5576 or die "Error executing $count_query: ". $count_sth->errstr;
5577 my $count_arrayref = $count_sth->fetchrow_arrayref;
5578 my $num_cust = $count_arrayref->[0];
5580 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
5581 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
5584 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
5586 #eventually order+limit magic to reduce memory use?
5587 foreach my $cust_main ( qsearch($sql_query) ) {
5589 my $to = $cust_main->invoicing_list_emailonly_scalar;
5592 my $error = send_email(
5596 'subject' => $subject,
5597 'html_body' => $html_body,
5598 'text_body' => $text_body,
5601 return $error if $error;
5603 if ( $job ) { #progressbar foo
5605 if ( time - $min_sec > $last ) {
5606 my $error = $job->update_statustext(
5607 int( 100 * $num / $num_cust )
5609 die $error if $error;
5619 use Storable qw(thaw);
5622 sub process_email_search_sql {
5624 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
5626 my $param = thaw(decode_base64(shift));
5627 warn Dumper($param) if $DEBUG;
5629 $param->{'job'} = $job;
5631 my $error = FS::cust_main->email_search_sql( $param );
5632 die $error if $error;
5636 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5638 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5639 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
5640 appropriate ship_ field is also searched).
5642 Additional options are the same as FS::Record::qsearch
5647 my( $self, $fuzzy, $hash, @opt) = @_;
5652 check_and_rebuild_fuzzyfiles();
5653 foreach my $field ( keys %$fuzzy ) {
5655 my $all = $self->all_X($field);
5656 next unless scalar(@$all);
5659 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5662 foreach ( keys %match ) {
5663 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5664 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5667 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5670 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5672 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5680 Returns a masked version of the named field
5685 my ($self,$field) = @_;
5689 'x'x(length($self->getfield($field))-4).
5690 substr($self->getfield($field), (length($self->getfield($field))-4));
5700 =item smart_search OPTION => VALUE ...
5702 Accepts the following options: I<search>, the string to search for. The string
5703 will be searched for as a customer number, phone number, name or company name,
5704 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5705 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5706 skip fuzzy matching when an exact match is found.
5708 Any additional options are treated as an additional qualifier on the search
5711 Returns a (possibly empty) array of FS::cust_main objects.
5718 #here is the agent virtualization
5719 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5723 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5724 my $search = delete $options{'search'};
5725 ( my $alphanum_search = $search ) =~ s/\W//g;
5727 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5729 #false laziness w/Record::ut_phone
5730 my $phonen = "$1-$2-$3";
5731 $phonen .= " x$4" if $4;
5733 push @cust_main, qsearch( {
5734 'table' => 'cust_main',
5735 'hashref' => { %options },
5736 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5738 join(' OR ', map "$_ = '$phonen'",
5739 qw( daytime night fax
5740 ship_daytime ship_night ship_fax )
5743 " AND $agentnums_sql", #agent virtualization
5746 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5747 #try looking for matches with extensions unless one was specified
5749 push @cust_main, qsearch( {
5750 'table' => 'cust_main',
5751 'hashref' => { %options },
5752 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5754 join(' OR ', map "$_ LIKE '$phonen\%'",
5756 ship_daytime ship_night )
5759 " AND $agentnums_sql", #agent virtualization
5764 # custnum search (also try agent_custid), with some tweaking options if your
5765 # legacy cust "numbers" have letters
5766 } elsif ( $search =~ /^\s*(\d+)\s*$/
5767 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
5768 && $search =~ /^\s*(\w\w?\d+)\s*$/
5773 push @cust_main, qsearch( {
5774 'table' => 'cust_main',
5775 'hashref' => { 'custnum' => $1, %options },
5776 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5779 push @cust_main, qsearch( {
5780 'table' => 'cust_main',
5781 'hashref' => { 'agent_custid' => $1, %options },
5782 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5785 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5787 my($company, $last, $first) = ( $1, $2, $3 );
5789 # "Company (Last, First)"
5790 #this is probably something a browser remembered,
5791 #so just do an exact search
5793 foreach my $prefix ( '', 'ship_' ) {
5794 push @cust_main, qsearch( {
5795 'table' => 'cust_main',
5796 'hashref' => { $prefix.'first' => $first,
5797 $prefix.'last' => $last,
5798 $prefix.'company' => $company,
5801 'extra_sql' => " AND $agentnums_sql",
5805 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5806 # try (ship_){last,company}
5810 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5811 # # full strings the browser remembers won't work
5812 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5814 use Lingua::EN::NameParse;
5815 my $NameParse = new Lingua::EN::NameParse(
5817 allow_reversed => 1,
5820 my($last, $first) = ( '', '' );
5821 #maybe disable this too and just rely on NameParse?
5822 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5824 ($last, $first) = ( $1, $2 );
5826 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5827 } elsif ( ! $NameParse->parse($value) ) {
5829 my %name = $NameParse->components;
5830 $first = $name{'given_name_1'};
5831 $last = $name{'surname_1'};
5835 if ( $first && $last ) {
5837 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5840 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5842 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5843 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5846 push @cust_main, qsearch( {
5847 'table' => 'cust_main',
5848 'hashref' => \%options,
5849 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5852 # or it just be something that was typed in... (try that in a sec)
5856 my $q_value = dbh->quote($value);
5859 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5860 $sql .= " ( LOWER(last) = $q_value
5861 OR LOWER(company) = $q_value
5862 OR LOWER(ship_last) = $q_value
5863 OR LOWER(ship_company) = $q_value
5866 push @cust_main, qsearch( {
5867 'table' => 'cust_main',
5868 'hashref' => \%options,
5869 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5872 #no exact match, trying substring/fuzzy
5873 #always do substring & fuzzy (unless they're explicity config'ed off)
5874 #getting complaints searches are not returning enough
5875 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5877 #still some false laziness w/search_sql (was search/cust_main.cgi)
5882 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5883 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5886 if ( $first && $last ) {
5889 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5890 'last' => { op=>'ILIKE', value=>"%$last%" },
5892 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5893 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5900 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5901 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5905 foreach my $hashref ( @hashrefs ) {
5907 push @cust_main, qsearch( {
5908 'table' => 'cust_main',
5909 'hashref' => { %$hashref,
5912 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5921 " AND $agentnums_sql", #extra_sql #agent virtualization
5924 if ( $first && $last ) {
5925 push @cust_main, FS::cust_main->fuzzy_search(
5926 { 'last' => $last, #fuzzy hashref
5927 'first' => $first }, #
5931 foreach my $field ( 'last', 'company' ) {
5933 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5938 #eliminate duplicates
5940 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5950 Accepts the following options: I<email>, the email address to search for. The
5951 email address will be searched for as an email invoice destination and as an
5954 #Any additional options are treated as an additional qualifier on the search
5955 #(i.e. I<agentnum>).
5957 Returns a (possibly empty) array of FS::cust_main objects (but usually just
5967 my $email = delete $options{'email'};
5969 #we're only being used by RT at the moment... no agent virtualization yet
5970 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5974 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
5976 my ( $user, $domain ) = ( $1, $2 );
5978 warn "$me smart_search: searching for $user in domain $domain"
5984 'table' => 'cust_main_invoice',
5985 'hashref' => { 'dest' => $email },
5992 map $_->cust_svc->cust_pkg,
5994 'table' => 'svc_acct',
5995 'hashref' => { 'username' => $user, },
5997 'AND ( SELECT domain FROM svc_domain
5998 WHERE svc_acct.domsvc = svc_domain.svcnum
5999 ) = '. dbh->quote($domain),
6005 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
6007 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
6014 =item check_and_rebuild_fuzzyfiles
6018 use vars qw(@fuzzyfields);
6019 @fuzzyfields = ( 'last', 'first', 'company' );
6021 sub check_and_rebuild_fuzzyfiles {
6022 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6023 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
6026 =item rebuild_fuzzyfiles
6030 sub rebuild_fuzzyfiles {
6032 use Fcntl qw(:flock);
6034 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6035 mkdir $dir, 0700 unless -d $dir;
6037 foreach my $fuzzy ( @fuzzyfields ) {
6039 open(LOCK,">>$dir/cust_main.$fuzzy")
6040 or die "can't open $dir/cust_main.$fuzzy: $!";
6042 or die "can't lock $dir/cust_main.$fuzzy: $!";
6044 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
6045 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
6047 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
6048 my $sth = dbh->prepare("SELECT $field FROM cust_main".
6049 " WHERE $field != '' AND $field IS NOT NULL");
6050 $sth->execute or die $sth->errstr;
6052 while ( my $row = $sth->fetchrow_arrayref ) {
6053 print CACHE $row->[0]. "\n";
6058 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
6060 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
6071 my( $self, $field ) = @_;
6072 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6073 open(CACHE,"<$dir/cust_main.$field")
6074 or die "can't open $dir/cust_main.$field: $!";
6075 my @array = map { chomp; $_; } <CACHE>;
6080 =item append_fuzzyfiles LASTNAME COMPANY
6084 sub append_fuzzyfiles {
6085 #my( $first, $last, $company ) = @_;
6087 &check_and_rebuild_fuzzyfiles;
6089 use Fcntl qw(:flock);
6091 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6093 foreach my $field (qw( first last company )) {
6098 open(CACHE,">>$dir/cust_main.$field")
6099 or die "can't open $dir/cust_main.$field: $!";
6100 flock(CACHE,LOCK_EX)
6101 or die "can't lock $dir/cust_main.$field: $!";
6103 print CACHE "$value\n";
6105 flock(CACHE,LOCK_UN)
6106 or die "can't unlock $dir/cust_main.$field: $!";
6121 #warn join('-',keys %$param);
6122 my $fh = $param->{filehandle};
6123 my $agentnum = $param->{agentnum};
6125 my $refnum = $param->{refnum};
6126 my $pkgpart = $param->{pkgpart};
6128 #my @fields = @{$param->{fields}};
6129 my $format = $param->{'format'};
6132 if ( $format eq 'simple' ) {
6133 @fields = qw( cust_pkg.setup dayphone first last
6134 address1 address2 city state zip comments );
6136 } elsif ( $format eq 'extended' ) {
6137 @fields = qw( agent_custid refnum
6138 last first address1 address2 city state zip country
6140 ship_last ship_first ship_address1 ship_address2
6141 ship_city ship_state ship_zip ship_country
6142 payinfo paycvv paydate
6145 svc_acct.username svc_acct._password
6148 } elsif ( $format eq 'extended-plus_company' ) {
6149 @fields = qw( agent_custid refnum
6150 last first company address1 address2 city state zip country
6152 ship_last ship_first ship_company ship_address1 ship_address2
6153 ship_city ship_state ship_zip ship_country
6154 payinfo paycvv paydate
6157 svc_acct.username svc_acct._password
6161 die "unknown format $format";
6164 eval "use Text::CSV_XS;";
6167 my $csv = new Text::CSV_XS;
6174 local $SIG{HUP} = 'IGNORE';
6175 local $SIG{INT} = 'IGNORE';
6176 local $SIG{QUIT} = 'IGNORE';
6177 local $SIG{TERM} = 'IGNORE';
6178 local $SIG{TSTP} = 'IGNORE';
6179 local $SIG{PIPE} = 'IGNORE';
6181 my $oldAutoCommit = $FS::UID::AutoCommit;
6182 local $FS::UID::AutoCommit = 0;
6185 #while ( $columns = $csv->getline($fh) ) {
6187 while ( defined($line=<$fh>) ) {
6189 $csv->parse($line) or do {
6190 $dbh->rollback if $oldAutoCommit;
6191 return "can't parse: ". $csv->error_input();
6194 my @columns = $csv->fields();
6195 #warn join('-',@columns);
6198 agentnum => $agentnum,
6200 country => $conf->config('countrydefault') || 'US',
6201 payby => $payby, #default
6202 paydate => '12/2037', #default
6204 my $billtime = time;
6205 my %cust_pkg = ( pkgpart => $pkgpart );
6207 foreach my $field ( @fields ) {
6209 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
6211 #$cust_pkg{$1} = str2time( shift @$columns );
6212 if ( $1 eq 'pkgpart' ) {
6213 $cust_pkg{$1} = shift @columns;
6214 } elsif ( $1 eq 'setup' ) {
6215 $billtime = str2time(shift @columns);
6217 $cust_pkg{$1} = str2time( shift @columns );
6220 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
6222 $svc_acct{$1} = shift @columns;
6226 #refnum interception
6227 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
6229 my $referral = $columns[0];
6230 my %hash = ( 'referral' => $referral,
6231 'agentnum' => $agentnum,
6235 my $part_referral = qsearchs('part_referral', \%hash )
6236 || new FS::part_referral \%hash;
6238 unless ( $part_referral->refnum ) {
6239 my $error = $part_referral->insert;
6241 $dbh->rollback if $oldAutoCommit;
6242 return "can't auto-insert advertising source: $referral: $error";
6246 $columns[0] = $part_referral->refnum;
6249 #$cust_main{$field} = shift @$columns;
6250 $cust_main{$field} = shift @columns;
6254 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
6256 my $invoicing_list = $cust_main{'invoicing_list'}
6257 ? [ delete $cust_main{'invoicing_list'} ]
6260 my $cust_main = new FS::cust_main ( \%cust_main );
6263 tie my %hash, 'Tie::RefHash'; #this part is important
6265 if ( $cust_pkg{'pkgpart'} ) {
6266 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
6269 if ( $svc_acct{'username'} ) {
6270 my $part_pkg = $cust_pkg->part_pkg;
6271 unless ( $part_pkg ) {
6272 $dbh->rollback if $oldAutoCommit;
6273 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
6275 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
6276 push @svc_acct, new FS::svc_acct ( \%svc_acct )
6279 $hash{$cust_pkg} = \@svc_acct;
6282 my $error = $cust_main->insert( \%hash, $invoicing_list );
6285 $dbh->rollback if $oldAutoCommit;
6286 return "can't insert customer for $line: $error";
6289 if ( $format eq 'simple' ) {
6291 #false laziness w/bill.cgi
6292 $error = $cust_main->bill( 'time' => $billtime );
6294 $dbh->rollback if $oldAutoCommit;
6295 return "can't bill customer for $line: $error";
6298 $error = $cust_main->apply_payments_and_credits;
6300 $dbh->rollback if $oldAutoCommit;
6301 return "can't bill customer for $line: $error";
6304 $error = $cust_main->collect();
6306 $dbh->rollback if $oldAutoCommit;
6307 return "can't collect customer for $line: $error";
6315 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6317 return "Empty file!" unless $imported;
6329 #warn join('-',keys %$param);
6330 my $fh = $param->{filehandle};
6331 my @fields = @{$param->{fields}};
6333 eval "use Text::CSV_XS;";
6336 my $csv = new Text::CSV_XS;
6343 local $SIG{HUP} = 'IGNORE';
6344 local $SIG{INT} = 'IGNORE';
6345 local $SIG{QUIT} = 'IGNORE';
6346 local $SIG{TERM} = 'IGNORE';
6347 local $SIG{TSTP} = 'IGNORE';
6348 local $SIG{PIPE} = 'IGNORE';
6350 my $oldAutoCommit = $FS::UID::AutoCommit;
6351 local $FS::UID::AutoCommit = 0;
6354 #while ( $columns = $csv->getline($fh) ) {
6356 while ( defined($line=<$fh>) ) {
6358 $csv->parse($line) or do {
6359 $dbh->rollback if $oldAutoCommit;
6360 return "can't parse: ". $csv->error_input();
6363 my @columns = $csv->fields();
6364 #warn join('-',@columns);
6367 foreach my $field ( @fields ) {
6368 $row{$field} = shift @columns;
6371 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
6372 unless ( $cust_main ) {
6373 $dbh->rollback if $oldAutoCommit;
6374 return "unknown custnum $row{'custnum'}";
6377 if ( $row{'amount'} > 0 ) {
6378 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
6380 $dbh->rollback if $oldAutoCommit;
6384 } elsif ( $row{'amount'} < 0 ) {
6385 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
6388 $dbh->rollback if $oldAutoCommit;
6398 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6400 return "Empty file!" unless $imported;
6406 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6408 Sends a templated email notification to the customer (see L<Text::Template>).
6410 OPTIONS is a hash and may include
6412 I<from> - the email sender (default is invoice_from)
6414 I<to> - comma-separated scalar or arrayref of recipients
6415 (default is invoicing_list)
6417 I<subject> - The subject line of the sent email notification
6418 (default is "Notice from company_name")
6420 I<extra_fields> - a hashref of name/value pairs which will be substituted
6423 The following variables are vavailable in the template.
6425 I<$first> - the customer first name
6426 I<$last> - the customer last name
6427 I<$company> - the customer company
6428 I<$payby> - a description of the method of payment for the customer
6429 # would be nice to use FS::payby::shortname
6430 I<$payinfo> - the account information used to collect for this customer
6431 I<$expdate> - the expiration of the customer payment in seconds from epoch
6436 my ($customer, $template, %options) = @_;
6438 return unless $conf->exists($template);
6440 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6441 $from = $options{from} if exists($options{from});
6443 my $to = join(',', $customer->invoicing_list_emailonly);
6444 $to = $options{to} if exists($options{to});
6446 my $subject = "Notice from " . $conf->config('company_name')
6447 if $conf->exists('company_name');
6448 $subject = $options{subject} if exists($options{subject});
6450 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6451 SOURCE => [ map "$_\n",
6452 $conf->config($template)]
6454 or die "can't create new Text::Template object: Text::Template::ERROR";
6455 $notify_template->compile()
6456 or die "can't compile template: Text::Template::ERROR";
6458 $FS::notify_template::_template::company_name = $conf->config('company_name');
6459 $FS::notify_template::_template::company_address =
6460 join("\n", $conf->config('company_address') ). "\n";
6462 my $paydate = $customer->paydate || '2037-12-31';
6463 $FS::notify_template::_template::first = $customer->first;
6464 $FS::notify_template::_template::last = $customer->last;
6465 $FS::notify_template::_template::company = $customer->company;
6466 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6467 my $payby = $customer->payby;
6468 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6469 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6471 #credit cards expire at the end of the month/year of their exp date
6472 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6473 $FS::notify_template::_template::payby = 'credit card';
6474 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6475 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6477 }elsif ($payby eq 'COMP') {
6478 $FS::notify_template::_template::payby = 'complimentary account';
6480 $FS::notify_template::_template::payby = 'current method';
6482 $FS::notify_template::_template::expdate = $expire_time;
6484 for (keys %{$options{extra_fields}}){
6486 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6489 send_email(from => $from,
6491 subject => $subject,
6492 body => $notify_template->fill_in( PACKAGE =>
6493 'FS::notify_template::_template' ),
6498 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6500 Generates a templated notification to the customer (see L<Text::Template>).
6502 OPTIONS is a hash and may include
6504 I<extra_fields> - a hashref of name/value pairs which will be substituted
6505 into the template. These values may override values mentioned below
6506 and those from the customer record.
6508 The following variables are available in the template instead of or in addition
6509 to the fields of the customer record.
6511 I<$payby> - a description of the method of payment for the customer
6512 # would be nice to use FS::payby::shortname
6513 I<$payinfo> - the masked account information used to collect for this customer
6514 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6515 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6519 sub generate_letter {
6520 my ($self, $template, %options) = @_;
6522 return unless $conf->exists($template);
6524 my $letter_template = new Text::Template
6526 SOURCE => [ map "$_\n", $conf->config($template)],
6527 DELIMITERS => [ '[@--', '--@]' ],
6529 or die "can't create new Text::Template object: Text::Template::ERROR";
6531 $letter_template->compile()
6532 or die "can't compile template: Text::Template::ERROR";
6534 my %letter_data = map { $_ => $self->$_ } $self->fields;
6535 $letter_data{payinfo} = $self->mask_payinfo;
6537 #my $paydate = $self->paydate || '2037-12-31';
6538 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6540 my $payby = $self->payby;
6541 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6542 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6544 #credit cards expire at the end of the month/year of their exp date
6545 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6546 $letter_data{payby} = 'credit card';
6547 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6548 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6550 }elsif ($payby eq 'COMP') {
6551 $letter_data{payby} = 'complimentary account';
6553 $letter_data{payby} = 'current method';
6555 $letter_data{expdate} = $expire_time;
6557 for (keys %{$options{extra_fields}}){
6558 $letter_data{$_} = $options{extra_fields}->{$_};
6561 unless(exists($letter_data{returnaddress})){
6562 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6563 $self->agent_template)
6565 if ( length($retadd) ) {
6566 $letter_data{returnaddress} = $retadd;
6567 } elsif ( grep /\S/, $conf->config('company_address') ) {
6568 $letter_data{returnaddress} =
6569 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6570 $conf->config('company_address')
6573 $letter_data{returnaddress} = '~';
6577 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6579 $letter_data{company_name} = $conf->config('company_name');
6581 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6582 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6586 ) or die "can't open temp file: $!\n";
6588 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6590 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6594 =item print_ps TEMPLATE
6596 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6602 my $file = $self->generate_letter(@_);
6603 FS::Misc::generate_ps($file);
6606 =item print TEMPLATE
6608 Prints the filled in template.
6610 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6614 sub queueable_print {
6617 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6618 or die "invalid customer number: " . $opt{custvnum};
6620 my $error = $self->print( $opt{template} );
6621 die $error if $error;
6625 my ($self, $template) = (shift, shift);
6626 do_print [ $self->print_ps($template) ];
6629 sub agent_template {
6631 $self->_agent_plandata('agent_templatename');
6634 sub agent_invoice_from {
6636 $self->_agent_plandata('agent_invoice_from');
6639 sub _agent_plandata {
6640 my( $self, $option ) = @_;
6642 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
6643 #agent-specific Conf
6645 use FS::part_event::Condition;
6647 my $agentnum = $self->agentnum;
6650 if ( driver_name =~ /^Pg/i ) {
6652 } elsif ( driver_name =~ /^mysql/i ) {
6655 die "don't know how to use regular expressions in ". driver_name. " databases";
6658 my $part_event_option =
6660 'select' => 'part_event_option.*',
6661 'table' => 'part_event_option',
6663 LEFT JOIN part_event USING ( eventpart )
6664 LEFT JOIN part_event_option AS peo_agentnum
6665 ON ( part_event.eventpart = peo_agentnum.eventpart
6666 AND peo_agentnum.optionname = 'agentnum'
6667 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
6669 LEFT JOIN part_event_option AS peo_cust_bill_age
6670 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
6671 AND peo_cust_bill_age.optionname = 'cust_bill_age'
6674 #'hashref' => { 'optionname' => $option },
6675 #'hashref' => { 'part_event_option.optionname' => $option },
6677 " WHERE part_event_option.optionname = ". dbh->quote($option).
6678 " AND action = 'cust_bill_send_agent' ".
6679 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
6680 " AND peo_agentnum.optionname = 'agentnum' ".
6681 " AND agentnum IS NULL OR agentnum = $agentnum ".
6683 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
6685 ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
6687 , part_event.weight".
6691 unless ( $part_event_option ) {
6692 return $self->agent->invoice_template || ''
6693 if $option eq 'agent_templatename';
6697 $part_event_option->optionvalue;
6702 ## actual sub, not a method, designed to be called from the queue.
6703 ## sets up the customer, and calls the bill_and_collect
6704 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6705 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6706 $cust_main->bill_and_collect(
6717 The delete method should possibly take an FS::cust_main object reference
6718 instead of a scalar customer number.
6720 Bill and collect options should probably be passed as references instead of a
6723 There should probably be a configuration file with a list of allowed credit
6726 No multiple currency support (probably a larger project than just this module).
6728 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6730 Birthdates rely on negative epoch values.
6732 The payby for card/check batches is broken. With mixed batching, bad
6735 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6739 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6740 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6741 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.