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( 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 ) = ( 0, 0 );
2075 my @precommit_hooks = ();
2077 foreach my $cust_pkg (
2078 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2081 #NO!! next if $cust_pkg->cancel;
2082 next if $cust_pkg->getfield('cancel');
2084 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2086 #? to avoid use of uninitialized value errors... ?
2087 $cust_pkg->setfield('bill', '')
2088 unless defined($cust_pkg->bill);
2090 #my $part_pkg = $cust_pkg->part_pkg;
2092 my $real_pkgpart = $cust_pkg->pkgpart;
2093 my %hash = $cust_pkg->hash;
2094 my $old_cust_pkg = new FS::cust_pkg \%hash;
2096 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2098 $cust_pkg->pkgpart($part_pkg->pkgpart);
2099 $cust_pkg->set($_, $hash{$_}) foreach qw( setup last_bill bill );
2111 if ( ! $cust_pkg->setup &&
2113 ( $conf->exists('disable_setup_suspended_pkgs') &&
2114 ! $cust_pkg->getfield('susp')
2115 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2117 || $options{'resetup'}
2120 warn " bill setup\n" if $DEBUG > 1;
2123 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2125 $dbh->rollback if $oldAutoCommit;
2126 return "$@ running calc_setup for $cust_pkg\n";
2129 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2131 $cust_pkg->setfield('setup', $time)
2132 unless $cust_pkg->setup;
2133 #do need it, but it won't get written to the db
2134 #|| $cust_pkg->pkgpart != $real_pkgpart;
2139 # bill recurring fee
2142 #XXX unit stuff here too
2146 if ( $part_pkg->getfield('freq') ne '0' &&
2147 ! $cust_pkg->getfield('susp') &&
2148 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2151 # XXX should this be a package event? probably. events are called
2152 # at collection time at the moment, though...
2153 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2154 if $part_pkg->can('reset_usage');
2155 #don't want to reset usage just cause we want a line item??
2156 #&& $part_pkg->pkgpart == $real_pkgpart;
2158 warn " bill recur\n" if $DEBUG > 1;
2161 # XXX shared with $recur_prog
2162 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2164 #over two params! lets at least switch to a hashref for the rest...
2165 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2167 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2169 $dbh->rollback if $oldAutoCommit;
2170 return "$@ running calc_recur for $cust_pkg\n";
2174 #change this bit to use Date::Manip? CAREFUL with timezones (see
2175 # mailing list archive)
2176 my ($sec,$min,$hour,$mday,$mon,$year) =
2177 (localtime($sdate) )[0,1,2,3,4,5];
2179 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2180 # only for figuring next bill date, nothing else, so, reset $sdate again
2182 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2183 $cust_pkg->last_bill($sdate);
2185 if ( $part_pkg->freq =~ /^\d+$/ ) {
2186 $mon += $part_pkg->freq;
2187 until ( $mon < 12 ) { $mon -= 12; $year++; }
2188 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2190 $mday += $weeks * 7;
2191 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2194 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2198 $dbh->rollback if $oldAutoCommit;
2199 return "unparsable frequency: ". $part_pkg->freq;
2201 $cust_pkg->setfield('bill',
2202 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2206 warn "\$setup is undefined" unless defined($setup);
2207 warn "\$recur is undefined" unless defined($recur);
2208 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2211 # If there's line items, create em cust_bill_pkg records
2212 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2217 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2218 # hmm.. and if just the options are modified in some weird price plan?
2220 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2223 my $error = $cust_pkg->replace( $old_cust_pkg,
2224 'options' => { $cust_pkg->options },
2226 if ( $error ) { #just in case
2227 $dbh->rollback if $oldAutoCommit;
2228 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2232 $setup = sprintf( "%.2f", $setup );
2233 $recur = sprintf( "%.2f", $recur );
2234 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2235 $dbh->rollback if $oldAutoCommit;
2236 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2238 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2239 $dbh->rollback if $oldAutoCommit;
2240 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2243 if ( $setup != 0 || $recur != 0 ) {
2245 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2247 my $cust_bill_pkg = new FS::cust_bill_pkg {
2248 'pkgnum' => $cust_pkg->pkgnum,
2250 'unitsetup' => $unitsetup,
2252 'unitrecur' => $unitrecur,
2253 'quantity' => $cust_pkg->quantity,
2255 'edate' => $cust_pkg->bill,
2256 'details' => \@details,
2258 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2259 unless $part_pkg->pkgpart == $real_pkgpart;
2260 push @cust_bill_pkg, $cust_bill_pkg;
2262 $total_setup += $setup;
2263 $total_recur += $recur;
2269 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2272 my @taxoverrides = $part_pkg->part_pkg_taxoverride;
2275 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2279 if ( $conf->exists('enable_taxproducts')
2280 && (scalar(@taxoverrides) || $part_pkg->taxproductnum )
2284 my @taxclassnums = ();
2285 my $geocode = $self->geocode('cch');
2287 if ( scalar( @taxoverrides ) ) {
2288 @taxclassnums = map { $_->taxclassnum } @taxoverrides;
2289 }elsif ( $part_pkg->taxproductnum ) {
2290 @taxclassnums = map { $_->taxclassnum }
2291 $part_pkg->part_pkg_taxrate('cch', $geocode);
2296 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2298 @taxes = qsearch({ 'table' => 'tax_rate',
2299 'hashref' => { 'geocode' => $geocode, },
2300 'extra_sql' => $extra_sql,
2302 if scalar(@taxclassnums);
2307 my %taxhash = map { $_ => $self->get("$prefix$_") }
2308 qw( state county country );
2310 $taxhash{'taxclass'} = $part_pkg->taxclass;
2312 @taxes = qsearch( 'cust_main_county', \%taxhash );
2315 $taxhash{'taxclass'} = '';
2316 @taxes = qsearch( 'cust_main_county', \%taxhash );
2319 #one more try at a whole-country tax rate
2321 $taxhash{$_} = '' foreach qw( state county );
2322 @taxes = qsearch( 'cust_main_county', \%taxhash );
2325 } #if $conf->exists('enable_taxproducts')
2327 # maybe eliminate this entirely, along with all the 0% records
2329 $dbh->rollback if $oldAutoCommit;
2331 if ( $conf->exists('enable_taxproducts') ) {
2333 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2334 join('/', ( map $self->get("$prefix$_"),
2337 $part_pkg->taxproduct_description,
2338 $part_pkg->pkgpart ). "\n";
2341 "fatal: can't find tax rate for state/county/country/taxclass ".
2342 join('/', ( map $self->get("$prefix$_"),
2343 qw(state county country)
2345 $part_pkg->taxclass ). "\n";
2350 foreach my $tax ( @taxes ) {
2351 my $taxname = ref( $tax ). ' '. $tax->taxnum;
2352 if ( exists( $taxlisthash{ $taxname } ) ) {
2353 push @{ $taxlisthash{ $taxname } }, $cust_bill_pkg;
2355 $taxlisthash{ $taxname } = [ $tax, $cust_bill_pkg ];
2360 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2362 } #if $setup != 0 || $recur != 0
2364 } #if $cust_pkg->modified
2366 } #foreach my $part_pkg
2368 } #foreach my $cust_pkg
2370 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2371 #but do commit any package date cycling that happened
2372 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2376 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2377 foreach my $tax ( keys %taxlisthash ) {
2378 my $tax_object = shift @{ $taxlisthash{$tax} };
2379 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2380 my $listref_or_error = $tax_object->taxline( @{ $taxlisthash{$tax} } );
2381 unless (ref($listref_or_error)) {
2382 $dbh->rollback if $oldAutoCommit;
2383 return $listref_or_error;
2385 unshift @{ $taxlisthash{$tax} }, $tax_object;
2387 warn "adding ". $listref_or_error->[1].
2388 " as ". $listref_or_error->[0]. "\n"
2390 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2391 if ( $taxname{ $listref_or_error->[0] } ) {
2392 push @{ $taxname{ $listref_or_error->[0] } }, $tax_object->taxname;
2394 $taxname{ $listref_or_error->[0] } = [ $tax_object->taxname ];
2399 #some taxes are taxed
2402 warn "finding taxed taxes...\n" if $DEBUG > 2;
2403 foreach my $tax ( keys %taxlisthash ) {
2404 my $tax_object = shift @{ $taxlisthash{$tax} };
2405 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
2407 next unless $tax_object->can('tax_on_tax');
2409 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
2410 my $totname = ref( $tot ). ' '. $tot->taxnum;
2412 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
2414 next unless exists( $taxlisthash{ $totname } ); # only increase
2416 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
2417 if ( exists( $totlisthash{ $totname } ) ) {
2418 push @{ $totlisthash{ $totname } }, $tax{ $tax_object->taxname };
2420 $totlisthash{ $totname } = [ $tot, $tax{ $tax_object->taxname } ];
2425 warn "having a look at taxed taxes...\n" if $DEBUG > 2;
2426 foreach my $tax ( keys %totlisthash ) {
2427 my $tax_object = shift @{ $totlisthash{$tax} };
2428 warn "found previously found taxed tax ". $tax_object->taxname. "\n"
2430 my $listref_or_error = $tax_object->taxline( @{ $totlisthash{$tax} } );
2431 unless (ref($listref_or_error)) {
2432 $dbh->rollback if $oldAutoCommit;
2433 return $listref_or_error;
2436 warn "adding taxed tax amount ". $listref_or_error->[1].
2437 " as ". $tax_object->taxname. "\n"
2439 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2442 #consolidate and create tax line items
2443 warn "consolidating and generating...\n" if $DEBUG > 2;
2444 foreach my $taxname ( keys %taxname ) {
2447 warn "adding $taxname\n" if $DEBUG > 1;
2448 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2449 $tax += $tax{$taxitem} unless $seen{$taxitem};
2450 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2454 $tax = sprintf('%.2f', $tax );
2455 $total_setup = sprintf('%.2f', $total_setup+$tax );
2457 push @cust_bill_pkg, new FS::cust_bill_pkg {
2463 'itemdesc' => $taxname,
2468 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2470 #create the new invoice
2471 my $cust_bill = new FS::cust_bill ( {
2472 'custnum' => $self->custnum,
2473 '_date' => ( $options{'invoice_time'} || $time ),
2474 'charged' => $charged,
2476 my $error = $cust_bill->insert;
2478 $dbh->rollback if $oldAutoCommit;
2479 return "can't create invoice for customer #". $self->custnum. ": $error";
2482 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2483 $cust_bill_pkg->invnum($cust_bill->invnum);
2484 my $error = $cust_bill_pkg->insert;
2486 $dbh->rollback if $oldAutoCommit;
2487 return "can't create invoice line item: $error";
2492 foreach my $hook ( @precommit_hooks ) {
2494 &{$hook}; #($self) ?
2497 $dbh->rollback if $oldAutoCommit;
2498 return "$@ running precommit hook $hook\n";
2502 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2506 =item collect OPTIONS
2508 (Attempt to) collect money for this customer's outstanding invoices (see
2509 L<FS::cust_bill>). Usually used after the bill method.
2511 Actions are now triggered by billing events; see L<FS::part_event> and the
2512 billing events web interface. Old-style invoice events (see
2513 L<FS::part_bill_event>) have been deprecated.
2515 If there is an error, returns the error, otherwise returns false.
2517 Options are passed as name-value pairs.
2519 Currently available options are:
2525 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.
2529 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2533 set true to surpress email card/ACH decline notices.
2537 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2541 allows for one time override of normal customer billing method
2545 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)
2553 my( $self, %options ) = @_;
2554 my $invoice_time = $options{'invoice_time'} || time;
2557 local $SIG{HUP} = 'IGNORE';
2558 local $SIG{INT} = 'IGNORE';
2559 local $SIG{QUIT} = 'IGNORE';
2560 local $SIG{TERM} = 'IGNORE';
2561 local $SIG{TSTP} = 'IGNORE';
2562 local $SIG{PIPE} = 'IGNORE';
2564 my $oldAutoCommit = $FS::UID::AutoCommit;
2565 local $FS::UID::AutoCommit = 0;
2568 $self->select_for_update; #mutex
2571 my $balance = $self->balance;
2572 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2575 if ( exists($options{'retry_card'}) ) {
2576 carp 'retry_card option passed to collect is deprecated; use retry';
2577 $options{'retry'} ||= $options{'retry_card'};
2579 if ( exists($options{'retry'}) && $options{'retry'} ) {
2580 my $error = $self->retry_realtime;
2582 $dbh->rollback if $oldAutoCommit;
2587 # false laziness w/pay_batch::import_results
2589 my $due_cust_event = $self->due_cust_event(
2590 'debug' => ( $options{'debug'} || 0 ),
2591 'time' => $invoice_time,
2592 'check_freq' => $options{'check_freq'},
2594 unless( ref($due_cust_event) ) {
2595 $dbh->rollback if $oldAutoCommit;
2596 return $due_cust_event;
2599 foreach my $cust_event ( @$due_cust_event ) {
2603 #re-eval event conditions (a previous event could have changed things)
2604 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2605 #don't leave stray "new/locked" records around
2606 my $error = $cust_event->delete;
2608 #gah, even with transactions
2609 $dbh->commit if $oldAutoCommit; #well.
2616 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2617 warn " running cust_event ". $cust_event->eventnum. "\n"
2621 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2622 if ( my $error = $cust_event->do_event() ) {
2623 #XXX wtf is this? figure out a proper dealio with return value
2625 # gah, even with transactions.
2626 $dbh->commit if $oldAutoCommit; #well.
2633 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2638 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2640 Inserts database records for and returns an ordered listref of new events due
2641 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2642 events are due, an empty listref is returned. If there is an error, returns a
2643 scalar error message.
2645 To actually run the events, call each event's test_condition method, and if
2646 still true, call the event's do_event method.
2648 Options are passed as a hashref or as a list of name-value pairs. Available
2655 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.
2659 "Current time" for the events.
2663 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)
2667 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2671 Explicitly pass the objects to be tested (typically used with eventtable).
2677 sub due_cust_event {
2679 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2682 #my $DEBUG = $opt{'debug'}
2683 local($DEBUG) = $opt{'debug'}
2684 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2686 warn "$me due_cust_event called with options ".
2687 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2690 $opt{'time'} ||= time;
2692 local $SIG{HUP} = 'IGNORE';
2693 local $SIG{INT} = 'IGNORE';
2694 local $SIG{QUIT} = 'IGNORE';
2695 local $SIG{TERM} = 'IGNORE';
2696 local $SIG{TSTP} = 'IGNORE';
2697 local $SIG{PIPE} = 'IGNORE';
2699 my $oldAutoCommit = $FS::UID::AutoCommit;
2700 local $FS::UID::AutoCommit = 0;
2703 $self->select_for_update; #mutex
2706 # 1: find possible events (initial search)
2709 my @cust_event = ();
2711 my @eventtable = $opt{'eventtable'}
2712 ? ( $opt{'eventtable'} )
2713 : FS::part_event->eventtables_runorder;
2715 foreach my $eventtable ( @eventtable ) {
2718 if ( $opt{'objects'} ) {
2720 @objects = @{ $opt{'objects'} };
2724 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2725 @objects = ( $eventtable eq 'cust_main' )
2727 : ( $self->$eventtable() );
2731 my @e_cust_event = ();
2733 my $cross = "CROSS JOIN $eventtable";
2734 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2735 unless $eventtable eq 'cust_main';
2737 foreach my $object ( @objects ) {
2739 #this first search uses the condition_sql magic for optimization.
2740 #the more possible events we can eliminate in this step the better
2742 my $cross_where = '';
2743 my $pkey = $object->primary_key;
2744 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2746 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2748 FS::part_event_condition->where_conditions_sql( $eventtable,
2749 'time'=>$opt{'time'}
2751 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2753 $extra_sql = "AND $extra_sql" if $extra_sql;
2755 #here is the agent virtualization
2756 $extra_sql .= " AND ( part_event.agentnum IS NULL
2757 OR part_event.agentnum = ". $self->agentnum. ' )';
2759 $extra_sql .= " $order";
2761 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2762 if $opt{'debug'} > 2;
2763 my @part_event = qsearch( {
2764 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2765 'select' => 'part_event.*',
2766 'table' => 'part_event',
2767 'addl_from' => "$cross $join",
2768 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2769 'eventtable' => $eventtable,
2772 'extra_sql' => "AND $cross_where $extra_sql",
2776 my $pkey = $object->primary_key;
2777 warn " ". scalar(@part_event).
2778 " possible events found for $eventtable ". $object->$pkey(). "\n";
2781 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2785 warn " ". scalar(@e_cust_event).
2786 " subtotal possible cust events found for $eventtable\n"
2789 push @cust_event, @e_cust_event;
2793 warn " ". scalar(@cust_event).
2794 " total possible cust events found in initial search\n"
2798 # 2: test conditions
2803 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2804 'stats_hashref' => \%unsat ),
2807 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2810 warn " invalid conditions not eliminated with condition_sql:\n".
2811 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2818 foreach my $cust_event ( @cust_event ) {
2820 my $error = $cust_event->insert();
2822 $dbh->rollback if $oldAutoCommit;
2828 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2834 warn " returning events: ". Dumper(@cust_event). "\n"
2841 =item retry_realtime
2843 Schedules realtime / batch credit card / electronic check / LEC billing
2844 events for for retry. Useful if card information has changed or manual
2845 retry is desired. The 'collect' method must be called to actually retry
2848 Implementation details: For either this customer, or for each of this
2849 customer's open invoices, changes the status of the first "done" (with
2850 statustext error) realtime processing event to "failed".
2854 sub retry_realtime {
2857 local $SIG{HUP} = 'IGNORE';
2858 local $SIG{INT} = 'IGNORE';
2859 local $SIG{QUIT} = 'IGNORE';
2860 local $SIG{TERM} = 'IGNORE';
2861 local $SIG{TSTP} = 'IGNORE';
2862 local $SIG{PIPE} = 'IGNORE';
2864 my $oldAutoCommit = $FS::UID::AutoCommit;
2865 local $FS::UID::AutoCommit = 0;
2868 #a little false laziness w/due_cust_event (not too bad, really)
2870 my $join = FS::part_event_condition->join_conditions_sql;
2871 my $order = FS::part_event_condition->order_conditions_sql;
2874 . join ( ' OR ' , map {
2875 "( part_event.eventtable = " . dbh->quote($_)
2876 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2877 } FS::part_event->eventtables)
2880 #here is the agent virtualization
2881 my $agent_virt = " ( part_event.agentnum IS NULL
2882 OR part_event.agentnum = ". $self->agentnum. ' )';
2884 #XXX this shouldn't be hardcoded, actions should declare it...
2885 my @realtime_events = qw(
2886 cust_bill_realtime_card
2887 cust_bill_realtime_check
2888 cust_bill_realtime_lec
2892 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2897 my @cust_event = qsearchs({
2898 'table' => 'cust_event',
2899 'select' => 'cust_event.*',
2900 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2901 'hashref' => { 'status' => 'done' },
2902 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2903 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2906 my %seen_invnum = ();
2907 foreach my $cust_event (@cust_event) {
2909 #max one for the customer, one for each open invoice
2910 my $cust_X = $cust_event->cust_X;
2911 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2915 or $cust_event->part_event->eventtable eq 'cust_bill'
2918 my $error = $cust_event->retry;
2920 $dbh->rollback if $oldAutoCommit;
2921 return "error scheduling event for retry: $error";
2926 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2931 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2933 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2934 via a Business::OnlinePayment realtime gateway. See
2935 L<http://420.am/business-onlinepayment> for supported gateways.
2937 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2939 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2941 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2942 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2943 if set, will override the value from the customer record.
2945 I<description> is a free-text field passed to the gateway. It defaults to
2946 "Internet services".
2948 If an I<invnum> is specified, this payment (if successful) is applied to the
2949 specified invoice. If you don't specify an I<invnum> you might want to
2950 call the B<apply_payments> method.
2952 I<quiet> can be set true to surpress email decline notices.
2954 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2955 resulting paynum, if any.
2957 I<payunique> is a unique identifier for this payment.
2959 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2964 my( $self, $method, $amount, %options ) = @_;
2966 warn "$me realtime_bop: $method $amount\n";
2967 warn " $_ => $options{$_}\n" foreach keys %options;
2970 $options{'description'} ||= 'Internet services';
2972 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
2974 eval "use Business::OnlinePayment";
2977 my $payinfo = exists($options{'payinfo'})
2978 ? $options{'payinfo'}
2981 my %method2payby = (
2988 # check for banned credit card/ACH
2991 my $ban = qsearchs('banned_pay', {
2992 'payby' => $method2payby{$method},
2993 'payinfo' => md5_base64($payinfo),
2995 return "Banned credit card" if $ban;
3002 if ( $options{'invnum'} ) {
3003 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3004 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3006 map { $_->part_pkg->taxclass }
3008 map { $_->cust_pkg }
3009 $cust_bill->cust_bill_pkg;
3010 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
3011 #different taxclasses
3012 $taxclass = $taxclasses[0];
3016 #look for an agent gateway override first
3018 if ( $method eq 'CC' ) {
3019 $cardtype = cardtype($payinfo);
3020 } elsif ( $method eq 'ECHECK' ) {
3023 $cardtype = $method;
3027 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3028 cardtype => $cardtype,
3029 taxclass => $taxclass, } )
3030 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3032 taxclass => $taxclass, } )
3033 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3034 cardtype => $cardtype,
3036 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3038 taxclass => '', } );
3040 my $payment_gateway = '';
3041 my( $processor, $login, $password, $action, @bop_options );
3042 if ( $override ) { #use a payment gateway override
3044 $payment_gateway = $override->payment_gateway;
3046 $processor = $payment_gateway->gateway_module;
3047 $login = $payment_gateway->gateway_username;
3048 $password = $payment_gateway->gateway_password;
3049 $action = $payment_gateway->gateway_action;
3050 @bop_options = $payment_gateway->options;
3052 } else { #use the standard settings from the config
3054 ( $processor, $login, $password, $action, @bop_options ) =
3055 $self->default_payment_gateway($method);
3063 my $address = exists($options{'address1'})
3064 ? $options{'address1'}
3066 my $address2 = exists($options{'address2'})
3067 ? $options{'address2'}
3069 $address .= ", ". $address2 if length($address2);
3071 my $o_payname = exists($options{'payname'})
3072 ? $options{'payname'}
3074 my($payname, $payfirst, $paylast);
3075 if ( $o_payname && $method ne 'ECHECK' ) {
3076 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3077 or return "Illegal payname $payname";
3078 ($payfirst, $paylast) = ($1, $2);
3080 $payfirst = $self->getfield('first');
3081 $paylast = $self->getfield('last');
3082 $payname = "$payfirst $paylast";
3085 my @invoicing_list = $self->invoicing_list_emailonly;
3086 if ( $conf->exists('emailinvoiceautoalways')
3087 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3088 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3089 push @invoicing_list, $self->all_emails;
3092 my $email = ($conf->exists('business-onlinepayment-email-override'))
3093 ? $conf->config('business-onlinepayment-email-override')
3094 : $invoicing_list[0];
3098 my $payip = exists($options{'payip'})
3101 $content{customer_ip} = $payip
3104 $content{invoice_number} = $options{'invnum'}
3105 if exists($options{'invnum'}) && length($options{'invnum'});
3107 $content{email_customer} =
3108 ( $conf->exists('business-onlinepayment-email_customer')
3109 || $conf->exists('business-onlinepayment-email-override') );
3112 if ( $method eq 'CC' ) {
3114 $content{card_number} = $payinfo;
3115 $paydate = exists($options{'paydate'})
3116 ? $options{'paydate'}
3118 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3119 $content{expiration} = "$2/$1";
3121 my $paycvv = exists($options{'paycvv'})
3122 ? $options{'paycvv'}
3124 $content{cvv2} = $paycvv
3127 my $paystart_month = exists($options{'paystart_month'})
3128 ? $options{'paystart_month'}
3129 : $self->paystart_month;
3131 my $paystart_year = exists($options{'paystart_year'})
3132 ? $options{'paystart_year'}
3133 : $self->paystart_year;
3135 $content{card_start} = "$paystart_month/$paystart_year"
3136 if $paystart_month && $paystart_year;
3138 my $payissue = exists($options{'payissue'})
3139 ? $options{'payissue'}
3141 $content{issue_number} = $payissue if $payissue;
3143 $content{recurring_billing} = 'YES'
3144 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3146 'payinfo' => $payinfo,
3148 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3150 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3154 } elsif ( $method eq 'ECHECK' ) {
3155 ( $content{account_number}, $content{routing_code} ) =
3156 split('@', $payinfo);
3157 $content{bank_name} = $o_payname;
3158 $content{bank_state} = exists($options{'paystate'})
3159 ? $options{'paystate'}
3160 : $self->getfield('paystate');
3161 $content{account_type} = exists($options{'paytype'})
3162 ? uc($options{'paytype'}) || 'CHECKING'
3163 : uc($self->getfield('paytype')) || 'CHECKING';
3164 $content{account_name} = $payname;
3165 $content{customer_org} = $self->company ? 'B' : 'I';
3166 $content{state_id} = exists($options{'stateid'})
3167 ? $options{'stateid'}
3168 : $self->getfield('stateid');
3169 $content{state_id_state} = exists($options{'stateid_state'})
3170 ? $options{'stateid_state'}
3171 : $self->getfield('stateid_state');
3172 $content{customer_ssn} = exists($options{'ss'})
3175 } elsif ( $method eq 'LEC' ) {
3176 $content{phone} = $payinfo;
3180 # run transaction(s)
3183 my $balance = exists( $options{'balance'} )
3184 ? $options{'balance'}
3187 $self->select_for_update; #mutex ... just until we get our pending record in
3189 #the checks here are intended to catch concurrent payments
3190 #double-form-submission prevention is taken care of in cust_pay_pending::check
3193 return "The customer's balance has changed; $method transaction aborted."
3194 if $self->balance < $balance;
3195 #&& $self->balance < $amount; #might as well anyway?
3197 #also check and make sure there aren't *other* pending payments for this cust
3199 my @pending = qsearch('cust_pay_pending', {
3200 'custnum' => $self->custnum,
3201 'status' => { op=>'!=', value=>'done' }
3203 return "A payment is already being processed for this customer (".
3204 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3205 "); $method transaction aborted."
3206 if scalar(@pending);
3208 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3210 my $cust_pay_pending = new FS::cust_pay_pending {
3211 'custnum' => $self->custnum,
3212 #'invnum' => $options{'invnum'},
3215 'payby' => $method2payby{$method},
3216 'payinfo' => $payinfo,
3217 'paydate' => $paydate,
3219 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3221 $cust_pay_pending->payunique( $options{payunique} )
3222 if defined($options{payunique}) && length($options{payunique});
3223 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3224 return $cpp_new_err if $cpp_new_err;
3226 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3228 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3229 $transaction->content(
3232 'password' => $password,
3233 'action' => $action1,
3234 'description' => $options{'description'},
3235 'amount' => $amount,
3236 #'invoice_number' => $options{'invnum'},
3237 'customer_id' => $self->custnum,
3238 'last_name' => $paylast,
3239 'first_name' => $payfirst,
3241 'address' => $address,
3242 'city' => ( exists($options{'city'})
3245 'state' => ( exists($options{'state'})
3248 'zip' => ( exists($options{'zip'})
3251 'country' => ( exists($options{'country'})
3252 ? $options{'country'}
3254 'referer' => 'http://cleanwhisker.420.am/',
3256 'phone' => $self->daytime || $self->night,
3260 $cust_pay_pending->status('pending');
3261 my $cpp_pending_err = $cust_pay_pending->replace;
3262 return $cpp_pending_err if $cpp_pending_err;
3265 my $BOP_TESTING = 0;
3266 my $BOP_TESTING_SUCCESS = 1;
3268 unless ( $BOP_TESTING ) {
3269 $transaction->submit();
3271 if ( $BOP_TESTING_SUCCESS ) {
3272 $transaction->is_success(1);
3273 $transaction->authorization('fake auth');
3275 $transaction->is_success(0);
3276 $transaction->error_message('fake failure');
3280 if ( $transaction->is_success() && $action2 ) {
3282 $cust_pay_pending->status('authorized');
3283 my $cpp_authorized_err = $cust_pay_pending->replace;
3284 return $cpp_authorized_err if $cpp_authorized_err;
3286 my $auth = $transaction->authorization;
3287 my $ordernum = $transaction->can('order_number')
3288 ? $transaction->order_number
3292 new Business::OnlinePayment( $processor, @bop_options );
3299 password => $password,
3300 order_number => $ordernum,
3302 authorization => $auth,
3303 description => $options{'description'},
3306 foreach my $field (qw( authorization_source_code returned_ACI
3307 transaction_identifier validation_code
3308 transaction_sequence_num local_transaction_date
3309 local_transaction_time AVS_result_code )) {
3310 $capture{$field} = $transaction->$field() if $transaction->can($field);
3313 $capture->content( %capture );
3317 unless ( $capture->is_success ) {
3318 my $e = "Authorization successful but capture failed, custnum #".
3319 $self->custnum. ': '. $capture->result_code.
3320 ": ". $capture->error_message;
3327 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3328 my $cpp_captured_err = $cust_pay_pending->replace;
3329 return $cpp_captured_err if $cpp_captured_err;
3332 # remove paycvv after initial transaction
3335 #false laziness w/misc/process/payment.cgi - check both to make sure working
3337 if ( defined $self->dbdef_table->column('paycvv')
3338 && length($self->paycvv)
3339 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3341 my $error = $self->remove_cvv;
3343 warn "WARNING: error removing cvv: $error\n";
3351 if ( $transaction->is_success() ) {
3354 if ( $payment_gateway ) { # agent override
3355 $paybatch = $payment_gateway->gatewaynum. '-';
3358 $paybatch .= "$processor:". $transaction->authorization;
3360 $paybatch .= ':'. $transaction->order_number
3361 if $transaction->can('order_number')
3362 && length($transaction->order_number);
3364 my $cust_pay = new FS::cust_pay ( {
3365 'custnum' => $self->custnum,
3366 'invnum' => $options{'invnum'},
3369 'payby' => $method2payby{$method},
3370 'payinfo' => $payinfo,
3371 'paybatch' => $paybatch,
3372 'paydate' => $paydate,
3374 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3375 $cust_pay->payunique( $options{payunique} )
3376 if defined($options{payunique}) && length($options{payunique});
3378 my $oldAutoCommit = $FS::UID::AutoCommit;
3379 local $FS::UID::AutoCommit = 0;
3382 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3384 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3387 $cust_pay->invnum(''); #try again with no specific invnum
3388 my $error2 = $cust_pay->insert( $options{'manual'} ?
3389 ( 'manual' => 1 ) : ()
3392 # gah. but at least we have a record of the state we had to abort in
3393 # from cust_pay_pending now.
3394 my $e = "WARNING: $method captured but payment not recorded - ".
3395 "error inserting payment ($processor): $error2".
3396 " (previously tried insert with invnum #$options{'invnum'}" .
3397 ": $error ) - pending payment saved as paypendingnum ".
3398 $cust_pay_pending->paypendingnum. "\n";
3404 if ( $options{'paynum_ref'} ) {
3405 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3408 $cust_pay_pending->status('done');
3409 $cust_pay_pending->statustext('captured');
3410 my $cpp_done_err = $cust_pay_pending->replace;
3412 if ( $cpp_done_err ) {
3414 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3415 my $e = "WARNING: $method captured but payment not recorded - ".
3416 "error updating status for paypendingnum ".
3417 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3423 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3424 return ''; #no error
3430 my $perror = "$processor error: ". $transaction->error_message;
3432 unless ( $transaction->error_message ) {
3435 if ( $transaction->can('response_page') ) {
3437 'page' => ( $transaction->can('response_page')
3438 ? $transaction->response_page
3441 'code' => ( $transaction->can('response_code')
3442 ? $transaction->response_code
3445 'headers' => ( $transaction->can('response_headers')
3446 ? $transaction->response_headers
3452 "No additional debugging information available for $processor";
3455 $perror .= "No error_message returned from $processor -- ".
3456 ( ref($t_response) ? Dumper($t_response) : $t_response );
3460 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3461 && $conf->exists('emaildecline')
3462 && grep { $_ ne 'POST' } $self->invoicing_list
3463 && ! grep { $transaction->error_message =~ /$_/ }
3464 $conf->config('emaildecline-exclude')
3466 my @templ = $conf->config('declinetemplate');
3467 my $template = new Text::Template (
3469 SOURCE => [ map "$_\n", @templ ],
3470 ) or return "($perror) can't create template: $Text::Template::ERROR";
3471 $template->compile()
3472 or return "($perror) can't compile template: $Text::Template::ERROR";
3474 my $templ_hash = { error => $transaction->error_message };
3476 my $error = send_email(
3477 'from' => $conf->config('invoice_from'),
3478 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3479 'subject' => 'Your payment could not be processed',
3480 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3483 $perror .= " (also received error sending decline notification: $error)"
3488 $cust_pay_pending->status('done');
3489 $cust_pay_pending->statustext("declined: $perror");
3490 my $cpp_done_err = $cust_pay_pending->replace;
3491 if ( $cpp_done_err ) {
3492 my $e = "WARNING: $method declined but pending payment not resolved - ".
3493 "error updating status for paypendingnum ".
3494 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3496 $perror = "$e ($perror)";
3509 my( $self, $method, $amount, %options ) = @_;
3511 if ( $options{'fake_failure'} ) {
3512 return "Error: No error; test failure requested with fake_failure";
3515 my %method2payby = (
3522 #if ( $payment_gateway ) { # agent override
3523 # $paybatch = $payment_gateway->gatewaynum. '-';
3526 #$paybatch .= "$processor:". $transaction->authorization;
3528 #$paybatch .= ':'. $transaction->order_number
3529 # if $transaction->can('order_number')
3530 # && length($transaction->order_number);
3532 my $paybatch = 'FakeProcessor:54:32';
3534 my $cust_pay = new FS::cust_pay ( {
3535 'custnum' => $self->custnum,
3536 'invnum' => $options{'invnum'},
3539 'payby' => $method2payby{$method},
3540 #'payinfo' => $payinfo,
3541 'payinfo' => '4111111111111111',
3542 'paybatch' => $paybatch,
3543 #'paydate' => $paydate,
3544 'paydate' => '2012-05-01',
3546 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3548 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3551 $cust_pay->invnum(''); #try again with no specific invnum
3552 my $error2 = $cust_pay->insert( $options{'manual'} ?
3553 ( 'manual' => 1 ) : ()
3556 # gah, even with transactions.
3557 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3558 "error inserting (fake!) payment: $error2".
3559 " (previously tried insert with invnum #$options{'invnum'}" .
3566 if ( $options{'paynum_ref'} ) {
3567 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3570 return ''; #no error
3574 =item default_payment_gateway
3578 sub default_payment_gateway {
3579 my( $self, $method ) = @_;
3581 die "Real-time processing not enabled\n"
3582 unless $conf->exists('business-onlinepayment');
3585 my $bop_config = 'business-onlinepayment';
3586 $bop_config .= '-ach'
3587 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3588 my ( $processor, $login, $password, $action, @bop_options ) =
3589 $conf->config($bop_config);
3590 $action ||= 'normal authorization';
3591 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3592 die "No real-time processor is enabled - ".
3593 "did you set the business-onlinepayment configuration value?\n"
3596 ( $processor, $login, $password, $action, @bop_options )
3601 Removes the I<paycvv> field from the database directly.
3603 If there is an error, returns the error, otherwise returns false.
3609 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3610 or return dbh->errstr;
3611 $sth->execute($self->custnum)
3612 or return $sth->errstr;
3617 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3619 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3620 via a Business::OnlinePayment realtime gateway. See
3621 L<http://420.am/business-onlinepayment> for supported gateways.
3623 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3625 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3627 Most gateways require a reference to an original payment transaction to refund,
3628 so you probably need to specify a I<paynum>.
3630 I<amount> defaults to the original amount of the payment if not specified.
3632 I<reason> specifies a reason for the refund.
3634 I<paydate> specifies the expiration date for a credit card overriding the
3635 value from the customer record or the payment record. Specified as yyyy-mm-dd
3637 Implementation note: If I<amount> is unspecified or equal to the amount of the
3638 orignal payment, first an attempt is made to "void" the transaction via
3639 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3640 the normal attempt is made to "refund" ("credit") the transaction via the
3641 gateway is attempted.
3643 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3644 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3645 #if set, will override the value from the customer record.
3647 #If an I<invnum> is specified, this payment (if successful) is applied to the
3648 #specified invoice. If you don't specify an I<invnum> you might want to
3649 #call the B<apply_payments> method.
3653 #some false laziness w/realtime_bop, not enough to make it worth merging
3654 #but some useful small subs should be pulled out
3655 sub realtime_refund_bop {
3656 my( $self, $method, %options ) = @_;
3658 warn "$me realtime_refund_bop: $method refund\n";
3659 warn " $_ => $options{$_}\n" foreach keys %options;
3662 eval "use Business::OnlinePayment";
3666 # look up the original payment and optionally a gateway for that payment
3670 my $amount = $options{'amount'};
3672 my( $processor, $login, $password, @bop_options ) ;
3673 my( $auth, $order_number ) = ( '', '', '' );
3675 if ( $options{'paynum'} ) {
3677 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3678 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3679 or return "Unknown paynum $options{'paynum'}";
3680 $amount ||= $cust_pay->paid;
3682 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3683 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3684 $cust_pay->paybatch;
3685 my $gatewaynum = '';
3686 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3688 if ( $gatewaynum ) { #gateway for the payment to be refunded
3690 my $payment_gateway =
3691 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3692 die "payment gateway $gatewaynum not found"
3693 unless $payment_gateway;
3695 $processor = $payment_gateway->gateway_module;
3696 $login = $payment_gateway->gateway_username;
3697 $password = $payment_gateway->gateway_password;
3698 @bop_options = $payment_gateway->options;
3700 } else { #try the default gateway
3702 my( $conf_processor, $unused_action );
3703 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3704 $self->default_payment_gateway($method);
3706 return "processor of payment $options{'paynum'} $processor does not".
3707 " match default processor $conf_processor"
3708 unless $processor eq $conf_processor;
3713 } else { # didn't specify a paynum, so look for agent gateway overrides
3714 # like a normal transaction
3717 if ( $method eq 'CC' ) {
3718 $cardtype = cardtype($self->payinfo);
3719 } elsif ( $method eq 'ECHECK' ) {
3722 $cardtype = $method;
3725 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3726 cardtype => $cardtype,
3728 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3730 taxclass => '', } );
3732 if ( $override ) { #use a payment gateway override
3734 my $payment_gateway = $override->payment_gateway;
3736 $processor = $payment_gateway->gateway_module;
3737 $login = $payment_gateway->gateway_username;
3738 $password = $payment_gateway->gateway_password;
3739 #$action = $payment_gateway->gateway_action;
3740 @bop_options = $payment_gateway->options;
3742 } else { #use the standard settings from the config
3745 ( $processor, $login, $password, $unused_action, @bop_options ) =
3746 $self->default_payment_gateway($method);
3751 return "neither amount nor paynum specified" unless $amount;
3756 'password' => $password,
3757 'order_number' => $order_number,
3758 'amount' => $amount,
3759 'referer' => 'http://cleanwhisker.420.am/',
3761 $content{authorization} = $auth
3762 if length($auth); #echeck/ACH transactions have an order # but no auth
3763 #(at least with authorize.net)
3765 my $disable_void_after;
3766 if ($conf->exists('disable_void_after')
3767 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3768 $disable_void_after = $1;
3771 #first try void if applicable
3772 if ( $cust_pay && $cust_pay->paid == $amount
3774 ( not defined($disable_void_after) )
3775 || ( time < ($cust_pay->_date + $disable_void_after ) )
3778 warn " attempting void\n" if $DEBUG > 1;
3779 my $void = new Business::OnlinePayment( $processor, @bop_options );
3780 $void->content( 'action' => 'void', %content );
3782 if ( $void->is_success ) {
3783 my $error = $cust_pay->void($options{'reason'});
3785 # gah, even with transactions.
3786 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3787 "error voiding payment: $error";
3791 warn " void successful\n" if $DEBUG > 1;
3796 warn " void unsuccessful, trying refund\n"
3800 my $address = $self->address1;
3801 $address .= ", ". $self->address2 if $self->address2;
3803 my($payname, $payfirst, $paylast);
3804 if ( $self->payname && $method ne 'ECHECK' ) {
3805 $payname = $self->payname;
3806 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3807 or return "Illegal payname $payname";
3808 ($payfirst, $paylast) = ($1, $2);
3810 $payfirst = $self->getfield('first');
3811 $paylast = $self->getfield('last');
3812 $payname = "$payfirst $paylast";
3815 my @invoicing_list = $self->invoicing_list_emailonly;
3816 if ( $conf->exists('emailinvoiceautoalways')
3817 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3818 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3819 push @invoicing_list, $self->all_emails;
3822 my $email = ($conf->exists('business-onlinepayment-email-override'))
3823 ? $conf->config('business-onlinepayment-email-override')
3824 : $invoicing_list[0];
3826 my $payip = exists($options{'payip'})
3829 $content{customer_ip} = $payip
3833 if ( $method eq 'CC' ) {
3836 $content{card_number} = $payinfo = $cust_pay->payinfo;
3837 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3838 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3839 ($content{expiration} = "$2/$1"); # where available
3841 $content{card_number} = $payinfo = $self->payinfo;
3842 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3843 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3844 $content{expiration} = "$2/$1";
3847 } elsif ( $method eq 'ECHECK' ) {
3850 $payinfo = $cust_pay->payinfo;
3852 $payinfo = $self->payinfo;
3854 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3855 $content{bank_name} = $self->payname;
3856 $content{account_type} = 'CHECKING';
3857 $content{account_name} = $payname;
3858 $content{customer_org} = $self->company ? 'B' : 'I';
3859 $content{customer_ssn} = $self->ss;
3860 } elsif ( $method eq 'LEC' ) {
3861 $content{phone} = $payinfo = $self->payinfo;
3865 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3866 my %sub_content = $refund->content(
3867 'action' => 'credit',
3868 'customer_id' => $self->custnum,
3869 'last_name' => $paylast,
3870 'first_name' => $payfirst,
3872 'address' => $address,
3873 'city' => $self->city,
3874 'state' => $self->state,
3875 'zip' => $self->zip,
3876 'country' => $self->country,
3878 'phone' => $self->daytime || $self->night,
3881 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3885 return "$processor error: ". $refund->error_message
3886 unless $refund->is_success();
3888 my %method2payby = (
3894 my $paybatch = "$processor:". $refund->authorization;
3895 $paybatch .= ':'. $refund->order_number
3896 if $refund->can('order_number') && $refund->order_number;
3898 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3899 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3900 last unless @cust_bill_pay;
3901 my $cust_bill_pay = pop @cust_bill_pay;
3902 my $error = $cust_bill_pay->delete;
3906 my $cust_refund = new FS::cust_refund ( {
3907 'custnum' => $self->custnum,
3908 'paynum' => $options{'paynum'},
3909 'refund' => $amount,
3911 'payby' => $method2payby{$method},
3912 'payinfo' => $payinfo,
3913 'paybatch' => $paybatch,
3914 'reason' => $options{'reason'} || 'card or ACH refund',
3916 my $error = $cust_refund->insert;
3918 $cust_refund->paynum(''); #try again with no specific paynum
3919 my $error2 = $cust_refund->insert;
3921 # gah, even with transactions.
3922 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3923 "error inserting refund ($processor): $error2".
3924 " (previously tried insert with paynum #$options{'paynum'}" .
3935 =item batch_card OPTION => VALUE...
3937 Adds a payment for this invoice to the pending credit card batch (see
3938 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3939 runs the payment using a realtime gateway.
3944 my ($self, %options) = @_;
3947 if (exists($options{amount})) {
3948 $amount = $options{amount};
3950 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3952 return '' unless $amount > 0;
3954 my $invnum = delete $options{invnum};
3955 my $payby = $options{invnum} || $self->payby; #dubious
3957 if ($options{'realtime'}) {
3958 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3964 my $oldAutoCommit = $FS::UID::AutoCommit;
3965 local $FS::UID::AutoCommit = 0;
3968 #this needs to handle mysql as well as Pg, like svc_acct.pm
3969 #(make it into a common function if folks need to do batching with mysql)
3970 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3971 or return "Cannot lock pay_batch: " . $dbh->errstr;
3975 'payby' => FS::payby->payby2payment($payby),
3978 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3980 unless ( $pay_batch ) {
3981 $pay_batch = new FS::pay_batch \%pay_batch;
3982 my $error = $pay_batch->insert;
3984 $dbh->rollback if $oldAutoCommit;
3985 die "error creating new batch: $error\n";
3989 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3990 'batchnum' => $pay_batch->batchnum,
3991 'custnum' => $self->custnum,
3994 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3996 $options{$_} = '' unless exists($options{$_});
3999 my $cust_pay_batch = new FS::cust_pay_batch ( {
4000 'batchnum' => $pay_batch->batchnum,
4001 'invnum' => $invnum || 0, # is there a better value?
4002 # this field should be
4004 # cust_bill_pay_batch now
4005 'custnum' => $self->custnum,
4006 'last' => $self->getfield('last'),
4007 'first' => $self->getfield('first'),
4008 'address1' => $options{address1} || $self->address1,
4009 'address2' => $options{address2} || $self->address2,
4010 'city' => $options{city} || $self->city,
4011 'state' => $options{state} || $self->state,
4012 'zip' => $options{zip} || $self->zip,
4013 'country' => $options{country} || $self->country,
4014 'payby' => $options{payby} || $self->payby,
4015 'payinfo' => $options{payinfo} || $self->payinfo,
4016 'exp' => $options{paydate} || $self->paydate,
4017 'payname' => $options{payname} || $self->payname,
4018 'amount' => $amount, # consolidating
4021 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
4022 if $old_cust_pay_batch;
4025 if ($old_cust_pay_batch) {
4026 $error = $cust_pay_batch->replace($old_cust_pay_batch)
4028 $error = $cust_pay_batch->insert;
4032 $dbh->rollback if $oldAutoCommit;
4036 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
4037 foreach my $cust_bill ($self->open_cust_bill) {
4038 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
4039 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
4040 'invnum' => $cust_bill->invnum,
4041 'paybatchnum' => $cust_pay_batch->paybatchnum,
4042 'amount' => $cust_bill->owed,
4045 if ($unapplied >= $cust_bill_pay_batch->amount){
4046 $unapplied -= $cust_bill_pay_batch->amount;
4049 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
4050 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
4052 $error = $cust_bill_pay_batch->insert;
4054 $dbh->rollback if $oldAutoCommit;
4059 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4065 Returns the total owed for this customer on all invoices
4066 (see L<FS::cust_bill/owed>).
4072 $self->total_owed_date(2145859200); #12/31/2037
4075 =item total_owed_date TIME
4077 Returns the total owed for this customer on all invoices with date earlier than
4078 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
4079 see L<Time::Local> and L<Date::Parse> for conversion functions.
4083 sub total_owed_date {
4087 foreach my $cust_bill (
4088 grep { $_->_date <= $time }
4089 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4091 $total_bill += $cust_bill->owed;
4093 sprintf( "%.2f", $total_bill );
4096 =item apply_payments_and_credits
4098 Applies unapplied payments and credits.
4100 In most cases, this new method should be used in place of sequential
4101 apply_payments and apply_credits methods.
4103 If there is an error, returns the error, otherwise returns false.
4107 sub apply_payments_and_credits {
4110 local $SIG{HUP} = 'IGNORE';
4111 local $SIG{INT} = 'IGNORE';
4112 local $SIG{QUIT} = 'IGNORE';
4113 local $SIG{TERM} = 'IGNORE';
4114 local $SIG{TSTP} = 'IGNORE';
4115 local $SIG{PIPE} = 'IGNORE';
4117 my $oldAutoCommit = $FS::UID::AutoCommit;
4118 local $FS::UID::AutoCommit = 0;
4121 $self->select_for_update; #mutex
4123 foreach my $cust_bill ( $self->open_cust_bill ) {
4124 my $error = $cust_bill->apply_payments_and_credits;
4126 $dbh->rollback if $oldAutoCommit;
4127 return "Error applying: $error";
4131 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4136 =item apply_credits OPTION => VALUE ...
4138 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4139 to outstanding invoice balances in chronological order (or reverse
4140 chronological order if the I<order> option is set to B<newest>) and returns the
4141 value of any remaining unapplied credits available for refund (see
4142 L<FS::cust_refund>).
4144 Dies if there is an error.
4152 local $SIG{HUP} = 'IGNORE';
4153 local $SIG{INT} = 'IGNORE';
4154 local $SIG{QUIT} = 'IGNORE';
4155 local $SIG{TERM} = 'IGNORE';
4156 local $SIG{TSTP} = 'IGNORE';
4157 local $SIG{PIPE} = 'IGNORE';
4159 my $oldAutoCommit = $FS::UID::AutoCommit;
4160 local $FS::UID::AutoCommit = 0;
4163 $self->select_for_update; #mutex
4165 unless ( $self->total_credited ) {
4166 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4170 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4171 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4173 my @invoices = $self->open_cust_bill;
4174 @invoices = sort { $b->_date <=> $a->_date } @invoices
4175 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4178 foreach my $cust_bill ( @invoices ) {
4181 if ( !defined($credit) || $credit->credited == 0) {
4182 $credit = pop @credits or last;
4185 if ($cust_bill->owed >= $credit->credited) {
4186 $amount=$credit->credited;
4188 $amount=$cust_bill->owed;
4191 my $cust_credit_bill = new FS::cust_credit_bill ( {
4192 'crednum' => $credit->crednum,
4193 'invnum' => $cust_bill->invnum,
4194 'amount' => $amount,
4196 my $error = $cust_credit_bill->insert;
4198 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4202 redo if ($cust_bill->owed > 0);
4206 my $total_credited = $self->total_credited;
4208 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4210 return $total_credited;
4213 =item apply_payments
4215 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4216 to outstanding invoice balances in chronological order.
4218 #and returns the value of any remaining unapplied payments.
4220 Dies if there is an error.
4224 sub apply_payments {
4227 local $SIG{HUP} = 'IGNORE';
4228 local $SIG{INT} = 'IGNORE';
4229 local $SIG{QUIT} = 'IGNORE';
4230 local $SIG{TERM} = 'IGNORE';
4231 local $SIG{TSTP} = 'IGNORE';
4232 local $SIG{PIPE} = 'IGNORE';
4234 my $oldAutoCommit = $FS::UID::AutoCommit;
4235 local $FS::UID::AutoCommit = 0;
4238 $self->select_for_update; #mutex
4242 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4243 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4245 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4246 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4250 foreach my $cust_bill ( @invoices ) {
4253 if ( !defined($payment) || $payment->unapplied == 0 ) {
4254 $payment = pop @payments or last;
4257 if ( $cust_bill->owed >= $payment->unapplied ) {
4258 $amount = $payment->unapplied;
4260 $amount = $cust_bill->owed;
4263 my $cust_bill_pay = new FS::cust_bill_pay ( {
4264 'paynum' => $payment->paynum,
4265 'invnum' => $cust_bill->invnum,
4266 'amount' => $amount,
4268 my $error = $cust_bill_pay->insert;
4270 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4274 redo if ( $cust_bill->owed > 0);
4278 my $total_unapplied_payments = $self->total_unapplied_payments;
4280 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4282 return $total_unapplied_payments;
4285 =item total_credited
4287 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4288 customer. See L<FS::cust_credit/credited>.
4292 sub total_credited {
4294 my $total_credit = 0;
4295 foreach my $cust_credit ( qsearch('cust_credit', {
4296 'custnum' => $self->custnum,
4298 $total_credit += $cust_credit->credited;
4300 sprintf( "%.2f", $total_credit );
4303 =item total_unapplied_payments
4305 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4306 See L<FS::cust_pay/unapplied>.
4310 sub total_unapplied_payments {
4312 my $total_unapplied = 0;
4313 foreach my $cust_pay ( qsearch('cust_pay', {
4314 'custnum' => $self->custnum,
4316 $total_unapplied += $cust_pay->unapplied;
4318 sprintf( "%.2f", $total_unapplied );
4321 =item total_unapplied_refunds
4323 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4324 customer. See L<FS::cust_refund/unapplied>.
4328 sub total_unapplied_refunds {
4330 my $total_unapplied = 0;
4331 foreach my $cust_refund ( qsearch('cust_refund', {
4332 'custnum' => $self->custnum,
4334 $total_unapplied += $cust_refund->unapplied;
4336 sprintf( "%.2f", $total_unapplied );
4341 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4342 total_credited minus total_unapplied_payments).
4350 + $self->total_unapplied_refunds
4351 - $self->total_credited
4352 - $self->total_unapplied_payments
4356 =item balance_date TIME
4358 Returns the balance for this customer, only considering invoices with date
4359 earlier than TIME (total_owed_date minus total_credited minus
4360 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4361 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4370 $self->total_owed_date($time)
4371 + $self->total_unapplied_refunds
4372 - $self->total_credited
4373 - $self->total_unapplied_payments
4377 =item in_transit_payments
4379 Returns the total of requests for payments for this customer pending in
4380 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4384 sub in_transit_payments {
4386 my $in_transit_payments = 0;
4387 foreach my $pay_batch ( qsearch('pay_batch', {
4390 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4391 'batchnum' => $pay_batch->batchnum,
4392 'custnum' => $self->custnum,
4394 $in_transit_payments += $cust_pay_batch->amount;
4397 sprintf( "%.2f", $in_transit_payments );
4400 =item paydate_monthyear
4402 Returns a two-element list consisting of the month and year of this customer's
4403 paydate (credit card expiration date for CARD customers)
4407 sub paydate_monthyear {
4409 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4411 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4418 =item invoicing_list [ ARRAYREF ]
4420 If an arguement is given, sets these email addresses as invoice recipients
4421 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4422 (except as warnings), so use check_invoicing_list first.
4424 Returns a list of email addresses (with svcnum entries expanded).
4426 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4427 check it without disturbing anything by passing nothing.
4429 This interface may change in the future.
4433 sub invoicing_list {
4434 my( $self, $arrayref ) = @_;
4437 my @cust_main_invoice;
4438 if ( $self->custnum ) {
4439 @cust_main_invoice =
4440 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4442 @cust_main_invoice = ();
4444 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4445 #warn $cust_main_invoice->destnum;
4446 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4447 #warn $cust_main_invoice->destnum;
4448 my $error = $cust_main_invoice->delete;
4449 warn $error if $error;
4452 if ( $self->custnum ) {
4453 @cust_main_invoice =
4454 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4456 @cust_main_invoice = ();
4458 my %seen = map { $_->address => 1 } @cust_main_invoice;
4459 foreach my $address ( @{$arrayref} ) {
4460 next if exists $seen{$address} && $seen{$address};
4461 $seen{$address} = 1;
4462 my $cust_main_invoice = new FS::cust_main_invoice ( {
4463 'custnum' => $self->custnum,
4466 my $error = $cust_main_invoice->insert;
4467 warn $error if $error;
4471 if ( $self->custnum ) {
4473 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4480 =item check_invoicing_list ARRAYREF
4482 Checks these arguements as valid input for the invoicing_list method. If there
4483 is an error, returns the error, otherwise returns false.
4487 sub check_invoicing_list {
4488 my( $self, $arrayref ) = @_;
4490 foreach my $address ( @$arrayref ) {
4492 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4493 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4496 my $cust_main_invoice = new FS::cust_main_invoice ( {
4497 'custnum' => $self->custnum,
4500 my $error = $self->custnum
4501 ? $cust_main_invoice->check
4502 : $cust_main_invoice->checkdest
4504 return $error if $error;
4508 return "Email address required"
4509 if $conf->exists('cust_main-require_invoicing_list_email')
4510 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4515 =item set_default_invoicing_list
4517 Sets the invoicing list to all accounts associated with this customer,
4518 overwriting any previous invoicing list.
4522 sub set_default_invoicing_list {
4524 $self->invoicing_list($self->all_emails);
4529 Returns the email addresses of all accounts provisioned for this customer.
4536 foreach my $cust_pkg ( $self->all_pkgs ) {
4537 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4539 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4540 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4542 $list{$_}=1 foreach map { $_->email } @svc_acct;
4547 =item invoicing_list_addpost
4549 Adds postal invoicing to this customer. If this customer is already configured
4550 to receive postal invoices, does nothing.
4554 sub invoicing_list_addpost {
4556 return if grep { $_ eq 'POST' } $self->invoicing_list;
4557 my @invoicing_list = $self->invoicing_list;
4558 push @invoicing_list, 'POST';
4559 $self->invoicing_list(\@invoicing_list);
4562 =item invoicing_list_emailonly
4564 Returns the list of email invoice recipients (invoicing_list without non-email
4565 destinations such as POST and FAX).
4569 sub invoicing_list_emailonly {
4571 warn "$me invoicing_list_emailonly called"
4573 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4576 =item invoicing_list_emailonly_scalar
4578 Returns the list of email invoice recipients (invoicing_list without non-email
4579 destinations such as POST and FAX) as a comma-separated scalar.
4583 sub invoicing_list_emailonly_scalar {
4585 warn "$me invoicing_list_emailonly_scalar called"
4587 join(', ', $self->invoicing_list_emailonly);
4590 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4592 Returns an array of customers referred by this customer (referral_custnum set
4593 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4594 customers referred by customers referred by this customer and so on, inclusive.
4595 The default behavior is DEPTH 1 (no recursion).
4599 sub referral_cust_main {
4601 my $depth = @_ ? shift : 1;
4602 my $exclude = @_ ? shift : {};
4605 map { $exclude->{$_->custnum}++; $_; }
4606 grep { ! $exclude->{ $_->custnum } }
4607 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4611 map { $_->referral_cust_main($depth-1, $exclude) }
4618 =item referral_cust_main_ncancelled
4620 Same as referral_cust_main, except only returns customers with uncancelled
4625 sub referral_cust_main_ncancelled {
4627 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4630 =item referral_cust_pkg [ DEPTH ]
4632 Like referral_cust_main, except returns a flat list of all unsuspended (and
4633 uncancelled) packages for each customer. The number of items in this list may
4634 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4638 sub referral_cust_pkg {
4640 my $depth = @_ ? shift : 1;
4642 map { $_->unsuspended_pkgs }
4643 grep { $_->unsuspended_pkgs }
4644 $self->referral_cust_main($depth);
4647 =item referring_cust_main
4649 Returns the single cust_main record for the customer who referred this customer
4650 (referral_custnum), or false.
4654 sub referring_cust_main {
4656 return '' unless $self->referral_custnum;
4657 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4660 =item credit AMOUNT, REASON
4662 Applies a credit to this customer. If there is an error, returns the error,
4663 otherwise returns false.
4668 my( $self, $amount, $reason, %options ) = @_;
4669 my $cust_credit = new FS::cust_credit {
4670 'custnum' => $self->custnum,
4671 'amount' => $amount,
4672 'reason' => $reason,
4674 $cust_credit->insert(%options);
4677 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4679 Creates a one-time charge for this customer. If there is an error, returns
4680 the error, otherwise returns false.
4686 my ( $amount, $quantity, $pkg, $comment, $taxclass, $additional, $classnum );
4687 if ( ref( $_[0] ) ) {
4688 $amount = $_[0]->{amount};
4689 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
4690 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4691 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4692 : '$'. sprintf("%.2f",$amount);
4693 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4694 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4695 $additional = $_[0]->{additional};
4699 $pkg = @_ ? shift : 'One-time charge';
4700 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4701 $taxclass = @_ ? shift : '';
4705 local $SIG{HUP} = 'IGNORE';
4706 local $SIG{INT} = 'IGNORE';
4707 local $SIG{QUIT} = 'IGNORE';
4708 local $SIG{TERM} = 'IGNORE';
4709 local $SIG{TSTP} = 'IGNORE';
4710 local $SIG{PIPE} = 'IGNORE';
4712 my $oldAutoCommit = $FS::UID::AutoCommit;
4713 local $FS::UID::AutoCommit = 0;
4716 my $part_pkg = new FS::part_pkg ( {
4718 'comment' => $comment,
4722 'classnum' => $classnum ? $classnum : '',
4723 'taxclass' => $taxclass,
4726 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4727 ( 0 .. @$additional - 1 )
4729 'additional_count' => scalar(@$additional),
4730 'setup_fee' => $amount,
4733 my $error = $part_pkg->insert( options => \%options );
4735 $dbh->rollback if $oldAutoCommit;
4739 my $pkgpart = $part_pkg->pkgpart;
4740 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4741 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4742 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4743 $error = $type_pkgs->insert;
4745 $dbh->rollback if $oldAutoCommit;
4750 my $cust_pkg = new FS::cust_pkg ( {
4751 'custnum' => $self->custnum,
4752 'pkgpart' => $pkgpart,
4753 'quantity' => $quantity,
4756 $error = $cust_pkg->insert;
4758 $dbh->rollback if $oldAutoCommit;
4762 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4769 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4775 sort { $a->_date <=> $b->_date }
4776 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4779 =item open_cust_bill
4781 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4786 sub open_cust_bill {
4788 grep { $_->owed > 0 } $self->cust_bill;
4793 Returns all the credits (see L<FS::cust_credit>) for this customer.
4799 sort { $a->_date <=> $b->_date }
4800 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4805 Returns all the payments (see L<FS::cust_pay>) for this customer.
4811 sort { $a->_date <=> $b->_date }
4812 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4817 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4823 sort { $a->_date <=> $b->_date }
4824 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4827 =item cust_pay_batch
4829 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4833 sub cust_pay_batch {
4835 sort { $a->_date <=> $b->_date }
4836 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4841 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4847 sort { $a->_date <=> $b->_date }
4848 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4853 Returns a name string for this customer, either "Company (Last, First)" or
4860 my $name = $self->contact;
4861 $name = $self->company. " ($name)" if $self->company;
4867 Returns a name string for this (service/shipping) contact, either
4868 "Company (Last, First)" or "Last, First".
4874 if ( $self->get('ship_last') ) {
4875 my $name = $self->ship_contact;
4876 $name = $self->ship_company. " ($name)" if $self->ship_company;
4885 Returns this customer's full (billing) contact name only, "Last, First"
4891 $self->get('last'). ', '. $self->first;
4896 Returns this customer's full (shipping) contact name only, "Last, First"
4902 $self->get('ship_last')
4903 ? $self->get('ship_last'). ', '. $self->ship_first
4909 Returns this customer's full country name
4915 code2country($self->country);
4918 =item geocode DATA_VENDOR
4920 Returns a value for the customer location as encoded by DATA_VENDOR.
4921 Currently this only makes sense for "CCH" as DATA_VENDOR.
4926 my ($self, $data_vendor) = (shift, shift); #always cch for now
4928 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
4932 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
4933 if $self->country eq 'US';
4935 #CCH specific location stuff
4936 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
4939 my $cust_tax_location =
4941 'table' => 'cust_tax_location',
4942 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
4943 'extra_sql' => $extra_sql,
4946 $geocode = $cust_tax_location->geocode
4947 if $cust_tax_location;
4956 Returns a status string for this customer, currently:
4960 =item prospect - No packages have ever been ordered
4962 =item active - One or more recurring packages is active
4964 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4966 =item suspended - All non-cancelled recurring packages are suspended
4968 =item cancelled - All recurring packages are cancelled
4974 sub status { shift->cust_status(@_); }
4978 for my $status (qw( prospect active inactive suspended cancelled )) {
4979 my $method = $status.'_sql';
4980 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4981 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4982 $sth->execute( ($self->custnum) x $numnum )
4983 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4984 return $status if $sth->fetchrow_arrayref->[0];
4988 =item ucfirst_cust_status
4990 =item ucfirst_status
4992 Returns the status with the first character capitalized.
4996 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4998 sub ucfirst_cust_status {
5000 ucfirst($self->cust_status);
5005 Returns a hex triplet color string for this customer's status.
5009 use vars qw(%statuscolor);
5010 tie my %statuscolor, 'Tie::IxHash',
5011 'prospect' => '7e0079', #'000000', #black? naw, purple
5012 'active' => '00CC00', #green
5013 'inactive' => '0000CC', #blue
5014 'suspended' => 'FF9900', #yellow
5015 'cancelled' => 'FF0000', #red
5018 sub statuscolor { shift->cust_statuscolor(@_); }
5020 sub cust_statuscolor {
5022 $statuscolor{$self->cust_status};
5027 Returns an array of hashes representing the customer's RT tickets.
5034 my $num = $conf->config('cust_main-max_tickets') || 10;
5037 unless ( $conf->config('ticket_system-custom_priority_field') ) {
5039 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
5043 foreach my $priority (
5044 $conf->config('ticket_system-custom_priority_field-values'), ''
5046 last if scalar(@tickets) >= $num;
5048 @{ FS::TicketSystem->customer_tickets( $self->custnum,
5049 $num - scalar(@tickets),
5058 # Return services representing svc_accts in customer support packages
5059 sub support_services {
5061 my %packages = map { $_ => 1 } $conf->config('support_packages');
5063 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
5064 grep { $_->part_svc->svcdb eq 'svc_acct' }
5065 map { $_->cust_svc }
5066 grep { exists $packages{ $_->pkgpart } }
5067 $self->ncancelled_pkgs;
5073 =head1 CLASS METHODS
5079 Class method that returns the list of possible status strings for customers
5080 (see L<the status method|/status>). For example:
5082 @statuses = FS::cust_main->statuses();
5087 #my $self = shift; #could be class...
5093 Returns an SQL expression identifying prospective cust_main records (customers
5094 with no packages ever ordered)
5098 use vars qw($select_count_pkgs);
5099 $select_count_pkgs =
5100 "SELECT COUNT(*) FROM cust_pkg
5101 WHERE cust_pkg.custnum = cust_main.custnum";
5103 sub select_count_pkgs_sql {
5107 sub prospect_sql { "
5108 0 = ( $select_count_pkgs )
5113 Returns an SQL expression identifying active cust_main records (customers with
5114 active recurring packages).
5119 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5125 Returns an SQL expression identifying inactive cust_main records (customers with
5126 no active recurring packages, but otherwise unsuspended/uncancelled).
5130 sub inactive_sql { "
5131 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5133 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5139 Returns an SQL expression identifying suspended cust_main records.
5144 sub suspended_sql { susp_sql(@_); }
5146 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5148 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5154 Returns an SQL expression identifying cancelled cust_main records.
5158 sub cancelled_sql { cancel_sql(@_); }
5161 my $recurring_sql = FS::cust_pkg->recurring_sql;
5162 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
5165 0 < ( $select_count_pkgs )
5166 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
5167 AND 0 = ( $select_count_pkgs AND $recurring_sql
5168 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5175 =item uncancelled_sql
5177 Returns an SQL expression identifying un-cancelled cust_main records.
5181 sub uncancelled_sql { uncancel_sql(@_); }
5182 sub uncancel_sql { "
5183 ( 0 < ( $select_count_pkgs
5184 AND ( cust_pkg.cancel IS NULL
5185 OR cust_pkg.cancel = 0
5188 OR 0 = ( $select_count_pkgs )
5194 Returns an SQL fragment to retreive the balance.
5199 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5200 WHERE cust_bill.custnum = cust_main.custnum )
5201 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5202 WHERE cust_pay.custnum = cust_main.custnum )
5203 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5204 WHERE cust_credit.custnum = cust_main.custnum )
5205 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5206 WHERE cust_refund.custnum = cust_main.custnum )
5209 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5211 Returns an SQL fragment to retreive the balance for this customer, only
5212 considering invoices with date earlier than START_TIME, and optionally not
5213 later than END_TIME (total_owed_date minus total_credited minus
5214 total_unapplied_payments).
5216 Times are specified as SQL fragments or numeric
5217 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5218 L<Date::Parse> for conversion functions. The empty string can be passed
5219 to disable that time constraint completely.
5221 Available options are:
5225 =item unapplied_date - set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
5227 =item total - set to true to remove all customer comparison clauses, for totals
5229 =item where - WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5231 =item join - JOIN clause (typically used with the total option)
5239 sub balance_date_sql {
5240 my( $class, $start, $end, %opt ) = @_;
5242 my $owed = FS::cust_bill->owed_sql;
5243 my $unapp_refund = FS::cust_refund->unapplied_sql;
5244 my $unapp_credit = FS::cust_credit->unapplied_sql;
5245 my $unapp_pay = FS::cust_pay->unapplied_sql;
5247 my $j = $opt{'join'} || '';
5249 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5250 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5251 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5252 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5254 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5255 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5256 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5257 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5262 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5264 Helper method for balance_date_sql; name (and usage) subject to change
5265 (suggestions welcome).
5267 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5268 cust_refund, cust_credit or cust_pay).
5270 If TABLE is "cust_bill" or the unapplied_date option is true, only
5271 considers records with date earlier than START_TIME, and optionally not
5272 later than END_TIME .
5276 sub _money_table_where {
5277 my( $class, $table, $start, $end, %opt ) = @_;
5280 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5281 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5282 push @where, "$table._date <= $start" if defined($start) && length($start);
5283 push @where, "$table._date > $end" if defined($end) && length($end);
5285 push @where, @{$opt{'where'}} if $opt{'where'};
5286 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5292 =item search_sql HASHREF
5296 Returns a qsearch hash expression to search for parameters specified in HREF.
5297 Valid parameters are
5305 =item cancelled_pkgs
5311 listref of start date, end date
5317 =item current_balance
5319 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
5323 =item flattened_pkgs
5332 my ($class, $params) = @_;
5343 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5345 "cust_main.agentnum = $1";
5352 #prospect active inactive suspended cancelled
5353 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
5354 my $method = $params->{'status'}. '_sql';
5355 #push @where, $class->$method();
5356 push @where, FS::cust_main->$method();
5360 # parse cancelled package checkbox
5365 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
5366 unless $params->{'cancelled_pkgs'};
5372 foreach my $field (qw( signupdate )) {
5374 next unless exists($params->{$field});
5376 my($beginning, $ending) = @{$params->{$field}};
5379 "cust_main.$field IS NOT NULL",
5380 "cust_main.$field >= $beginning",
5381 "cust_main.$field <= $ending";
5383 $orderby ||= "ORDER BY cust_main.$field";
5391 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
5393 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
5400 #my $balance_sql = $class->balance_sql();
5401 my $balance_sql = FS::cust_main->balance_sql();
5403 push @where, map { s/current_balance/$balance_sql/; $_ }
5404 @{ $params->{'current_balance'} };
5407 # setup queries, subs, etc. for the search
5410 $orderby ||= 'ORDER BY custnum';
5412 # here is the agent virtualization
5413 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
5415 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5417 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
5419 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
5421 my $select = join(', ',
5422 'cust_main.custnum',
5423 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
5426 my(@extra_headers) = ();
5427 my(@extra_fields) = ();
5429 if ($params->{'flattened_pkgs'}) {
5431 if ($dbh->{Driver}->{Name} eq 'Pg') {
5433 $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";
5435 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
5436 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
5437 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
5439 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
5440 "omitting packing information from report.";
5443 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";
5445 my $sth = dbh->prepare($header_query) or die dbh->errstr;
5446 $sth->execute() or die $sth->errstr;
5447 my $headerrow = $sth->fetchrow_arrayref;
5448 my $headercount = $headerrow ? $headerrow->[0] : 0;
5449 while($headercount) {
5450 unshift @extra_headers, "Package ". $headercount;
5451 unshift @extra_fields, eval q!sub {my $c = shift;
5452 my @a = split '\|', $c->magic;
5453 my $p = $a[!.--$headercount. q!];
5461 'table' => 'cust_main',
5462 'select' => $select,
5464 'extra_sql' => $extra_sql,
5465 'order_by' => $orderby,
5466 'count_query' => $count_query,
5467 'extra_headers' => \@extra_headers,
5468 'extra_fields' => \@extra_fields,
5473 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5475 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5476 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
5477 appropriate ship_ field is also searched).
5479 Additional options are the same as FS::Record::qsearch
5484 my( $self, $fuzzy, $hash, @opt) = @_;
5489 check_and_rebuild_fuzzyfiles();
5490 foreach my $field ( keys %$fuzzy ) {
5492 my $all = $self->all_X($field);
5493 next unless scalar(@$all);
5496 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5499 foreach ( keys %match ) {
5500 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5501 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5504 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5507 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5509 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5517 Returns a masked version of the named field
5522 my ($self,$field) = @_;
5526 'x'x(length($self->getfield($field))-4).
5527 substr($self->getfield($field), (length($self->getfield($field))-4));
5537 =item smart_search OPTION => VALUE ...
5539 Accepts the following options: I<search>, the string to search for. The string
5540 will be searched for as a customer number, phone number, name or company name,
5541 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5542 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5543 skip fuzzy matching when an exact match is found.
5545 Any additional options are treated as an additional qualifier on the search
5548 Returns a (possibly empty) array of FS::cust_main objects.
5555 #here is the agent virtualization
5556 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5560 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5561 my $search = delete $options{'search'};
5562 ( my $alphanum_search = $search ) =~ s/\W//g;
5564 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5566 #false laziness w/Record::ut_phone
5567 my $phonen = "$1-$2-$3";
5568 $phonen .= " x$4" if $4;
5570 push @cust_main, qsearch( {
5571 'table' => 'cust_main',
5572 'hashref' => { %options },
5573 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5575 join(' OR ', map "$_ = '$phonen'",
5576 qw( daytime night fax
5577 ship_daytime ship_night ship_fax )
5580 " AND $agentnums_sql", #agent virtualization
5583 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5584 #try looking for matches with extensions unless one was specified
5586 push @cust_main, qsearch( {
5587 'table' => 'cust_main',
5588 'hashref' => { %options },
5589 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5591 join(' OR ', map "$_ LIKE '$phonen\%'",
5593 ship_daytime ship_night )
5596 " AND $agentnums_sql", #agent virtualization
5601 # custnum search (also try agent_custid), with some tweaking options if your
5602 # legacy cust "numbers" have letters
5603 } elsif ( $search =~ /^\s*(\d+)\s*$/
5604 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
5605 && $search =~ /^\s*(\w\w?\d+)\s*$/
5610 push @cust_main, qsearch( {
5611 'table' => 'cust_main',
5612 'hashref' => { 'custnum' => $1, %options },
5613 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5616 push @cust_main, qsearch( {
5617 'table' => 'cust_main',
5618 'hashref' => { 'agent_custid' => $1, %options },
5619 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5622 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5624 my($company, $last, $first) = ( $1, $2, $3 );
5626 # "Company (Last, First)"
5627 #this is probably something a browser remembered,
5628 #so just do an exact search
5630 foreach my $prefix ( '', 'ship_' ) {
5631 push @cust_main, qsearch( {
5632 'table' => 'cust_main',
5633 'hashref' => { $prefix.'first' => $first,
5634 $prefix.'last' => $last,
5635 $prefix.'company' => $company,
5638 'extra_sql' => " AND $agentnums_sql",
5642 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5643 # try (ship_){last,company}
5647 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5648 # # full strings the browser remembers won't work
5649 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5651 use Lingua::EN::NameParse;
5652 my $NameParse = new Lingua::EN::NameParse(
5654 allow_reversed => 1,
5657 my($last, $first) = ( '', '' );
5658 #maybe disable this too and just rely on NameParse?
5659 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5661 ($last, $first) = ( $1, $2 );
5663 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5664 } elsif ( ! $NameParse->parse($value) ) {
5666 my %name = $NameParse->components;
5667 $first = $name{'given_name_1'};
5668 $last = $name{'surname_1'};
5672 if ( $first && $last ) {
5674 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5677 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5679 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5680 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5683 push @cust_main, qsearch( {
5684 'table' => 'cust_main',
5685 'hashref' => \%options,
5686 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5689 # or it just be something that was typed in... (try that in a sec)
5693 my $q_value = dbh->quote($value);
5696 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5697 $sql .= " ( LOWER(last) = $q_value
5698 OR LOWER(company) = $q_value
5699 OR LOWER(ship_last) = $q_value
5700 OR LOWER(ship_company) = $q_value
5703 push @cust_main, qsearch( {
5704 'table' => 'cust_main',
5705 'hashref' => \%options,
5706 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5709 #no exact match, trying substring/fuzzy
5710 #always do substring & fuzzy (unless they're explicity config'ed off)
5711 #getting complaints searches are not returning enough
5712 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5714 #still some false laziness w/search_sql (was search/cust_main.cgi)
5719 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5720 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5723 if ( $first && $last ) {
5726 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5727 'last' => { op=>'ILIKE', value=>"%$last%" },
5729 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5730 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5737 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5738 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5742 foreach my $hashref ( @hashrefs ) {
5744 push @cust_main, qsearch( {
5745 'table' => 'cust_main',
5746 'hashref' => { %$hashref,
5749 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5758 " AND $agentnums_sql", #extra_sql #agent virtualization
5761 if ( $first && $last ) {
5762 push @cust_main, FS::cust_main->fuzzy_search(
5763 { 'last' => $last, #fuzzy hashref
5764 'first' => $first }, #
5768 foreach my $field ( 'last', 'company' ) {
5770 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5775 #eliminate duplicates
5777 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5787 Accepts the following options: I<email>, the email address to search for. The
5788 email address will be searched for as an email invoice destination and as an
5791 #Any additional options are treated as an additional qualifier on the search
5792 #(i.e. I<agentnum>).
5794 Returns a (possibly empty) array of FS::cust_main objects (but usually just
5804 my $email = delete $options{'email'};
5806 #we're only being used by RT at the moment... no agent virtualization yet
5807 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5811 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
5813 my ( $user, $domain ) = ( $1, $2 );
5815 warn "$me smart_search: searching for $user in domain $domain"
5821 'table' => 'cust_main_invoice',
5822 'hashref' => { 'dest' => $email },
5829 map $_->cust_svc->cust_pkg,
5831 'table' => 'svc_acct',
5832 'hashref' => { 'username' => $user, },
5834 'AND ( SELECT domain FROM svc_domain
5835 WHERE svc_acct.domsvc = svc_domain.svcnum
5836 ) = '. dbh->quote($domain),
5842 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5844 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
5851 =item check_and_rebuild_fuzzyfiles
5855 use vars qw(@fuzzyfields);
5856 @fuzzyfields = ( 'last', 'first', 'company' );
5858 sub check_and_rebuild_fuzzyfiles {
5859 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5860 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5863 =item rebuild_fuzzyfiles
5867 sub rebuild_fuzzyfiles {
5869 use Fcntl qw(:flock);
5871 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5872 mkdir $dir, 0700 unless -d $dir;
5874 foreach my $fuzzy ( @fuzzyfields ) {
5876 open(LOCK,">>$dir/cust_main.$fuzzy")
5877 or die "can't open $dir/cust_main.$fuzzy: $!";
5879 or die "can't lock $dir/cust_main.$fuzzy: $!";
5881 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5882 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5884 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5885 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5886 " WHERE $field != '' AND $field IS NOT NULL");
5887 $sth->execute or die $sth->errstr;
5889 while ( my $row = $sth->fetchrow_arrayref ) {
5890 print CACHE $row->[0]. "\n";
5895 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5897 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5908 my( $self, $field ) = @_;
5909 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5910 open(CACHE,"<$dir/cust_main.$field")
5911 or die "can't open $dir/cust_main.$field: $!";
5912 my @array = map { chomp; $_; } <CACHE>;
5917 =item append_fuzzyfiles LASTNAME COMPANY
5921 sub append_fuzzyfiles {
5922 #my( $first, $last, $company ) = @_;
5924 &check_and_rebuild_fuzzyfiles;
5926 use Fcntl qw(:flock);
5928 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5930 foreach my $field (qw( first last company )) {
5935 open(CACHE,">>$dir/cust_main.$field")
5936 or die "can't open $dir/cust_main.$field: $!";
5937 flock(CACHE,LOCK_EX)
5938 or die "can't lock $dir/cust_main.$field: $!";
5940 print CACHE "$value\n";
5942 flock(CACHE,LOCK_UN)
5943 or die "can't unlock $dir/cust_main.$field: $!";
5958 #warn join('-',keys %$param);
5959 my $fh = $param->{filehandle};
5960 my $agentnum = $param->{agentnum};
5962 my $refnum = $param->{refnum};
5963 my $pkgpart = $param->{pkgpart};
5965 #my @fields = @{$param->{fields}};
5966 my $format = $param->{'format'};
5969 if ( $format eq 'simple' ) {
5970 @fields = qw( cust_pkg.setup dayphone first last
5971 address1 address2 city state zip comments );
5973 } elsif ( $format eq 'extended' ) {
5974 @fields = qw( agent_custid refnum
5975 last first address1 address2 city state zip country
5977 ship_last ship_first ship_address1 ship_address2
5978 ship_city ship_state ship_zip ship_country
5979 payinfo paycvv paydate
5982 svc_acct.username svc_acct._password
5985 } elsif ( $format eq 'extended-plus_company' ) {
5986 @fields = qw( agent_custid refnum
5987 last first company address1 address2 city state zip country
5989 ship_last ship_first ship_company ship_address1 ship_address2
5990 ship_city ship_state ship_zip ship_country
5991 payinfo paycvv paydate
5994 svc_acct.username svc_acct._password
5998 die "unknown format $format";
6001 eval "use Text::CSV_XS;";
6004 my $csv = new Text::CSV_XS;
6011 local $SIG{HUP} = 'IGNORE';
6012 local $SIG{INT} = 'IGNORE';
6013 local $SIG{QUIT} = 'IGNORE';
6014 local $SIG{TERM} = 'IGNORE';
6015 local $SIG{TSTP} = 'IGNORE';
6016 local $SIG{PIPE} = 'IGNORE';
6018 my $oldAutoCommit = $FS::UID::AutoCommit;
6019 local $FS::UID::AutoCommit = 0;
6022 #while ( $columns = $csv->getline($fh) ) {
6024 while ( defined($line=<$fh>) ) {
6026 $csv->parse($line) or do {
6027 $dbh->rollback if $oldAutoCommit;
6028 return "can't parse: ". $csv->error_input();
6031 my @columns = $csv->fields();
6032 #warn join('-',@columns);
6035 agentnum => $agentnum,
6037 country => $conf->config('countrydefault') || 'US',
6038 payby => $payby, #default
6039 paydate => '12/2037', #default
6041 my $billtime = time;
6042 my %cust_pkg = ( pkgpart => $pkgpart );
6044 foreach my $field ( @fields ) {
6046 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
6048 #$cust_pkg{$1} = str2time( shift @$columns );
6049 if ( $1 eq 'pkgpart' ) {
6050 $cust_pkg{$1} = shift @columns;
6051 } elsif ( $1 eq 'setup' ) {
6052 $billtime = str2time(shift @columns);
6054 $cust_pkg{$1} = str2time( shift @columns );
6057 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
6059 $svc_acct{$1} = shift @columns;
6063 #refnum interception
6064 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
6066 my $referral = $columns[0];
6067 my %hash = ( 'referral' => $referral,
6068 'agentnum' => $agentnum,
6072 my $part_referral = qsearchs('part_referral', \%hash )
6073 || new FS::part_referral \%hash;
6075 unless ( $part_referral->refnum ) {
6076 my $error = $part_referral->insert;
6078 $dbh->rollback if $oldAutoCommit;
6079 return "can't auto-insert advertising source: $referral: $error";
6083 $columns[0] = $part_referral->refnum;
6086 #$cust_main{$field} = shift @$columns;
6087 $cust_main{$field} = shift @columns;
6091 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
6093 my $invoicing_list = $cust_main{'invoicing_list'}
6094 ? [ delete $cust_main{'invoicing_list'} ]
6097 my $cust_main = new FS::cust_main ( \%cust_main );
6100 tie my %hash, 'Tie::RefHash'; #this part is important
6102 if ( $cust_pkg{'pkgpart'} ) {
6103 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
6106 if ( $svc_acct{'username'} ) {
6107 my $part_pkg = $cust_pkg->part_pkg;
6108 unless ( $part_pkg ) {
6109 $dbh->rollback if $oldAutoCommit;
6110 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
6112 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
6113 push @svc_acct, new FS::svc_acct ( \%svc_acct )
6116 $hash{$cust_pkg} = \@svc_acct;
6119 my $error = $cust_main->insert( \%hash, $invoicing_list );
6122 $dbh->rollback if $oldAutoCommit;
6123 return "can't insert customer for $line: $error";
6126 if ( $format eq 'simple' ) {
6128 #false laziness w/bill.cgi
6129 $error = $cust_main->bill( 'time' => $billtime );
6131 $dbh->rollback if $oldAutoCommit;
6132 return "can't bill customer for $line: $error";
6135 $error = $cust_main->apply_payments_and_credits;
6137 $dbh->rollback if $oldAutoCommit;
6138 return "can't bill customer for $line: $error";
6141 $error = $cust_main->collect();
6143 $dbh->rollback if $oldAutoCommit;
6144 return "can't collect customer for $line: $error";
6152 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6154 return "Empty file!" unless $imported;
6166 #warn join('-',keys %$param);
6167 my $fh = $param->{filehandle};
6168 my @fields = @{$param->{fields}};
6170 eval "use Text::CSV_XS;";
6173 my $csv = new Text::CSV_XS;
6180 local $SIG{HUP} = 'IGNORE';
6181 local $SIG{INT} = 'IGNORE';
6182 local $SIG{QUIT} = 'IGNORE';
6183 local $SIG{TERM} = 'IGNORE';
6184 local $SIG{TSTP} = 'IGNORE';
6185 local $SIG{PIPE} = 'IGNORE';
6187 my $oldAutoCommit = $FS::UID::AutoCommit;
6188 local $FS::UID::AutoCommit = 0;
6191 #while ( $columns = $csv->getline($fh) ) {
6193 while ( defined($line=<$fh>) ) {
6195 $csv->parse($line) or do {
6196 $dbh->rollback if $oldAutoCommit;
6197 return "can't parse: ". $csv->error_input();
6200 my @columns = $csv->fields();
6201 #warn join('-',@columns);
6204 foreach my $field ( @fields ) {
6205 $row{$field} = shift @columns;
6208 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
6209 unless ( $cust_main ) {
6210 $dbh->rollback if $oldAutoCommit;
6211 return "unknown custnum $row{'custnum'}";
6214 if ( $row{'amount'} > 0 ) {
6215 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
6217 $dbh->rollback if $oldAutoCommit;
6221 } elsif ( $row{'amount'} < 0 ) {
6222 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
6225 $dbh->rollback if $oldAutoCommit;
6235 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6237 return "Empty file!" unless $imported;
6243 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6245 Sends a templated email notification to the customer (see L<Text::Template>).
6247 OPTIONS is a hash and may include
6249 I<from> - the email sender (default is invoice_from)
6251 I<to> - comma-separated scalar or arrayref of recipients
6252 (default is invoicing_list)
6254 I<subject> - The subject line of the sent email notification
6255 (default is "Notice from company_name")
6257 I<extra_fields> - a hashref of name/value pairs which will be substituted
6260 The following variables are vavailable in the template.
6262 I<$first> - the customer first name
6263 I<$last> - the customer last name
6264 I<$company> - the customer company
6265 I<$payby> - a description of the method of payment for the customer
6266 # would be nice to use FS::payby::shortname
6267 I<$payinfo> - the account information used to collect for this customer
6268 I<$expdate> - the expiration of the customer payment in seconds from epoch
6273 my ($customer, $template, %options) = @_;
6275 return unless $conf->exists($template);
6277 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6278 $from = $options{from} if exists($options{from});
6280 my $to = join(',', $customer->invoicing_list_emailonly);
6281 $to = $options{to} if exists($options{to});
6283 my $subject = "Notice from " . $conf->config('company_name')
6284 if $conf->exists('company_name');
6285 $subject = $options{subject} if exists($options{subject});
6287 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6288 SOURCE => [ map "$_\n",
6289 $conf->config($template)]
6291 or die "can't create new Text::Template object: Text::Template::ERROR";
6292 $notify_template->compile()
6293 or die "can't compile template: Text::Template::ERROR";
6295 $FS::notify_template::_template::company_name = $conf->config('company_name');
6296 $FS::notify_template::_template::company_address =
6297 join("\n", $conf->config('company_address') ). "\n";
6299 my $paydate = $customer->paydate || '2037-12-31';
6300 $FS::notify_template::_template::first = $customer->first;
6301 $FS::notify_template::_template::last = $customer->last;
6302 $FS::notify_template::_template::company = $customer->company;
6303 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6304 my $payby = $customer->payby;
6305 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6306 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6308 #credit cards expire at the end of the month/year of their exp date
6309 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6310 $FS::notify_template::_template::payby = 'credit card';
6311 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6312 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6314 }elsif ($payby eq 'COMP') {
6315 $FS::notify_template::_template::payby = 'complimentary account';
6317 $FS::notify_template::_template::payby = 'current method';
6319 $FS::notify_template::_template::expdate = $expire_time;
6321 for (keys %{$options{extra_fields}}){
6323 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6326 send_email(from => $from,
6328 subject => $subject,
6329 body => $notify_template->fill_in( PACKAGE =>
6330 'FS::notify_template::_template' ),
6335 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6337 Generates a templated notification to the customer (see L<Text::Template>).
6339 OPTIONS is a hash and may include
6341 I<extra_fields> - a hashref of name/value pairs which will be substituted
6342 into the template. These values may override values mentioned below
6343 and those from the customer record.
6345 The following variables are available in the template instead of or in addition
6346 to the fields of the customer record.
6348 I<$payby> - a description of the method of payment for the customer
6349 # would be nice to use FS::payby::shortname
6350 I<$payinfo> - the masked account information used to collect for this customer
6351 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6352 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6356 sub generate_letter {
6357 my ($self, $template, %options) = @_;
6359 return unless $conf->exists($template);
6361 my $letter_template = new Text::Template
6363 SOURCE => [ map "$_\n", $conf->config($template)],
6364 DELIMITERS => [ '[@--', '--@]' ],
6366 or die "can't create new Text::Template object: Text::Template::ERROR";
6368 $letter_template->compile()
6369 or die "can't compile template: Text::Template::ERROR";
6371 my %letter_data = map { $_ => $self->$_ } $self->fields;
6372 $letter_data{payinfo} = $self->mask_payinfo;
6374 #my $paydate = $self->paydate || '2037-12-31';
6375 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6377 my $payby = $self->payby;
6378 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6379 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6381 #credit cards expire at the end of the month/year of their exp date
6382 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6383 $letter_data{payby} = 'credit card';
6384 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6385 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6387 }elsif ($payby eq 'COMP') {
6388 $letter_data{payby} = 'complimentary account';
6390 $letter_data{payby} = 'current method';
6392 $letter_data{expdate} = $expire_time;
6394 for (keys %{$options{extra_fields}}){
6395 $letter_data{$_} = $options{extra_fields}->{$_};
6398 unless(exists($letter_data{returnaddress})){
6399 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6400 $self->agent_template)
6402 if ( length($retadd) ) {
6403 $letter_data{returnaddress} = $retadd;
6404 } elsif ( grep /\S/, $conf->config('company_address') ) {
6405 $letter_data{returnaddress} =
6406 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6407 $conf->config('company_address')
6410 $letter_data{returnaddress} = '~';
6414 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6416 $letter_data{company_name} = $conf->config('company_name');
6418 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6419 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6423 ) or die "can't open temp file: $!\n";
6425 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6427 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6431 =item print_ps TEMPLATE
6433 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6439 my $file = $self->generate_letter(@_);
6440 FS::Misc::generate_ps($file);
6443 =item print TEMPLATE
6445 Prints the filled in template.
6447 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6451 sub queueable_print {
6454 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6455 or die "invalid customer number: " . $opt{custvnum};
6457 my $error = $self->print( $opt{template} );
6458 die $error if $error;
6462 my ($self, $template) = (shift, shift);
6463 do_print [ $self->print_ps($template) ];
6466 sub agent_template {
6468 $self->_agent_plandata('agent_templatename');
6471 sub agent_invoice_from {
6473 $self->_agent_plandata('agent_invoice_from');
6476 sub _agent_plandata {
6477 my( $self, $option ) = @_;
6479 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
6480 #agent-specific Conf
6482 use FS::part_event::Condition;
6484 my $agentnum = $self->agentnum;
6487 if ( driver_name =~ /^Pg/i ) {
6489 } elsif ( driver_name =~ /^mysql/i ) {
6492 die "don't know how to use regular expressions in ". driver_name. " databases";
6495 my $part_event_option =
6497 'select' => 'part_event_option.*',
6498 'table' => 'part_event_option',
6500 LEFT JOIN part_event USING ( eventpart )
6501 LEFT JOIN part_event_option AS peo_agentnum
6502 ON ( part_event.eventpart = peo_agentnum.eventpart
6503 AND peo_agentnum.optionname = 'agentnum'
6504 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
6506 LEFT JOIN part_event_option AS peo_cust_bill_age
6507 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
6508 AND peo_cust_bill_age.optionname = 'cust_bill_age'
6511 #'hashref' => { 'optionname' => $option },
6512 #'hashref' => { 'part_event_option.optionname' => $option },
6514 " WHERE part_event_option.optionname = ". dbh->quote($option).
6515 " AND action = 'cust_bill_send_agent' ".
6516 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
6517 " AND peo_agentnum.optionname = 'agentnum' ".
6518 " AND agentnum IS NULL OR agentnum = $agentnum ".
6520 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
6522 ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
6524 , part_event.weight".
6528 unless ( $part_event_option ) {
6529 return $self->agent->invoice_template || ''
6530 if $option eq 'agent_templatename';
6534 $part_event_option->optionvalue;
6539 ## actual sub, not a method, designed to be called from the queue.
6540 ## sets up the customer, and calls the bill_and_collect
6541 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6542 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6543 $cust_main->bill_and_collect(
6554 The delete method should possibly take an FS::cust_main object reference
6555 instead of a scalar customer number.
6557 Bill and collect options should probably be passed as references instead of a
6560 There should probably be a configuration file with a list of allowed credit
6563 No multiple currency support (probably a larger project than just this module).
6565 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6567 Birthdates rely on negative epoch values.
6569 The payby for card/check batches is broken. With mixed batching, bad
6572 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6576 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6577 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6578 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.