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);
18 use File::Temp qw( tempfile );
19 use String::Approx qw(amatch);
20 use Business::CreditCard 0.28;
22 use FS::UID qw( getotaker dbh driver_name );
23 use FS::Record qw( qsearchs qsearch dbdef );
24 use FS::Misc qw( generate_email send_email generate_ps do_print );
25 use FS::Msgcat qw(gettext);
29 use FS::cust_bill_pkg;
30 use FS::cust_bill_pkg_display;
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_tax_location;
41 use FS::part_pkg_taxrate;
43 use FS::cust_main_invoice;
44 use FS::cust_credit_bill;
45 use FS::cust_bill_pay;
46 use FS::prepay_credit;
50 use FS::part_event_condition;
53 use FS::payment_gateway;
54 use FS::agent_payment_gateway;
56 use FS::payinfo_Mixin;
59 @ISA = qw( FS::payinfo_Mixin FS::Record );
61 @EXPORT_OK = qw( smart_search );
63 $realtime_bop_decline_quiet = 0;
65 # 1 is mostly method/subroutine entry and options
66 # 2 traces progress of some operations
67 # 3 is even more information including possibly sensitive data
69 $me = '[FS::cust_main]';
73 $ignore_expired_card = 0;
75 @encrypted_fields = ('payinfo', 'paycvv');
76 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
78 #ask FS::UID to run this stuff for us later
79 #$FS::UID::callback{'FS::cust_main'} = sub {
80 install_callback FS::UID sub {
82 #yes, need it for stuff below (prolly should be cached)
87 my ( $hashref, $cache ) = @_;
88 if ( exists $hashref->{'pkgnum'} ) {
89 #@{ $self->{'_pkgnum'} } = ();
90 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
91 $self->{'_pkgnum'} = $subcache;
92 #push @{ $self->{'_pkgnum'} },
93 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
99 FS::cust_main - Object methods for cust_main records
105 $record = new FS::cust_main \%hash;
106 $record = new FS::cust_main { 'column' => 'value' };
108 $error = $record->insert;
110 $error = $new_record->replace($old_record);
112 $error = $record->delete;
114 $error = $record->check;
116 @cust_pkg = $record->all_pkgs;
118 @cust_pkg = $record->ncancelled_pkgs;
120 @cust_pkg = $record->suspended_pkgs;
122 $error = $record->bill;
123 $error = $record->bill %options;
124 $error = $record->bill 'time' => $time;
126 $error = $record->collect;
127 $error = $record->collect %options;
128 $error = $record->collect 'invoice_time' => $time,
133 An FS::cust_main object represents a customer. FS::cust_main inherits from
134 FS::Record. The following fields are currently supported:
138 =item custnum - primary key (assigned automatically for new customers)
140 =item agentnum - agent (see L<FS::agent>)
142 =item refnum - Advertising source (see L<FS::part_referral>)
148 =item ss - social security number (optional)
150 =item company - (optional)
154 =item address2 - (optional)
158 =item county - (optional, see L<FS::cust_main_county>)
160 =item state - (see L<FS::cust_main_county>)
164 =item country - (see L<FS::cust_main_county>)
166 =item daytime - phone (optional)
168 =item night - phone (optional)
170 =item fax - phone (optional)
172 =item ship_first - name
174 =item ship_last - name
176 =item ship_company - (optional)
180 =item ship_address2 - (optional)
184 =item ship_county - (optional, see L<FS::cust_main_county>)
186 =item ship_state - (see L<FS::cust_main_county>)
190 =item ship_country - (see L<FS::cust_main_county>)
192 =item ship_daytime - phone (optional)
194 =item ship_night - phone (optional)
196 =item ship_fax - phone (optional)
198 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
200 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
202 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
206 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
208 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
210 =item paystart_month - start date month (maestro/solo cards only)
212 =item paystart_year - start date year (maestro/solo cards only)
214 =item payissue - issue number (maestro/solo cards only)
216 =item payname - name on card or billing name
218 =item payip - IP address from which payment information was received
220 =item tax - tax exempt, empty or `Y'
222 =item otaker - order taker (assigned automatically, see L<FS::UID>)
224 =item comments - comments (optional)
226 =item referral_custnum - referring customer number
228 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
230 =item dundate - a suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
232 =item squelch_cdr - Discourage individual CDR printing, empty or `Y'
242 Creates a new customer. To add the customer to the database, see L<"insert">.
244 Note that this stores the hash reference, not a distinct copy of the hash it
245 points to. You can ask the object for a copy with the I<hash> method.
249 sub table { 'cust_main'; }
251 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
253 Adds this customer to the database. If there is an error, returns the error,
254 otherwise returns false.
256 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
257 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
258 are inserted atomicly, or the transaction is rolled back. Passing an empty
259 hash reference is equivalent to not supplying this parameter. There should be
260 a better explanation of this, but until then, here's an example:
263 tie %hash, 'Tie::RefHash'; #this part is important
265 $cust_pkg => [ $svc_acct ],
268 $cust_main->insert( \%hash );
270 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
271 be set as the invoicing list (see L<"invoicing_list">). Errors return as
272 expected and rollback the entire transaction; it is not necessary to call
273 check_invoicing_list first. The invoicing_list is set after the records in the
274 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
275 invoicing_list destination to the newly-created svc_acct. Here's an example:
277 $cust_main->insert( {}, [ $email, 'POST' ] );
279 Currently available options are: I<depend_jobnum> and I<noexport>.
281 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
282 on the supplied jobnum (they will not run until the specific job completes).
283 This can be used to defer provisioning until some action completes (such
284 as running the customer's credit card successfully).
286 The I<noexport> option is deprecated. If I<noexport> is set true, no
287 provisioning jobs (exports) are scheduled. (You can schedule them later with
288 the B<reexport> method.)
294 my $cust_pkgs = @_ ? shift : {};
295 my $invoicing_list = @_ ? shift : '';
297 warn "$me insert called with options ".
298 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
301 local $SIG{HUP} = 'IGNORE';
302 local $SIG{INT} = 'IGNORE';
303 local $SIG{QUIT} = 'IGNORE';
304 local $SIG{TERM} = 'IGNORE';
305 local $SIG{TSTP} = 'IGNORE';
306 local $SIG{PIPE} = 'IGNORE';
308 my $oldAutoCommit = $FS::UID::AutoCommit;
309 local $FS::UID::AutoCommit = 0;
312 my $prepay_identifier = '';
313 my( $amount, $seconds ) = ( 0, 0 );
315 if ( $self->payby eq 'PREPAY' ) {
317 $self->payby('BILL');
318 $prepay_identifier = $self->payinfo;
321 warn " looking up prepaid card $prepay_identifier\n"
324 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
326 $dbh->rollback if $oldAutoCommit;
327 #return "error applying prepaid card (transaction rolled back): $error";
331 $payby = 'PREP' if $amount;
333 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
336 $self->payby('BILL');
337 $amount = $self->paid;
341 warn " inserting $self\n"
344 $self->signupdate(time) unless $self->signupdate;
346 $self->auto_agent_custid()
347 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
349 my $error = $self->SUPER::insert;
351 $dbh->rollback if $oldAutoCommit;
352 #return "inserting cust_main record (transaction rolled back): $error";
356 warn " setting invoicing list\n"
359 if ( $invoicing_list ) {
360 $error = $self->check_invoicing_list( $invoicing_list );
362 $dbh->rollback if $oldAutoCommit;
363 #return "checking invoicing_list (transaction rolled back): $error";
366 $self->invoicing_list( $invoicing_list );
369 if ( $conf->config('cust_main-skeleton_tables')
370 && $conf->config('cust_main-skeleton_custnum') ) {
372 warn " inserting skeleton records\n"
375 my $error = $self->start_copy_skel;
377 $dbh->rollback if $oldAutoCommit;
383 warn " ordering packages\n"
386 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
388 $dbh->rollback if $oldAutoCommit;
393 $dbh->rollback if $oldAutoCommit;
394 return "No svc_acct record to apply pre-paid time";
398 warn " inserting initial $payby payment of $amount\n"
400 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
402 $dbh->rollback if $oldAutoCommit;
403 return "inserting payment (transaction rolled back): $error";
407 unless ( $import || $skip_fuzzyfiles ) {
408 warn " queueing fuzzyfiles update\n"
410 $error = $self->queue_fuzzyfiles_update;
412 $dbh->rollback if $oldAutoCommit;
413 return "updating fuzzy search cache: $error";
417 warn " insert complete; committing transaction\n"
420 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
425 use File::CounterFile;
426 sub auto_agent_custid {
429 my $format = $conf->config('cust_main-auto_agent_custid');
431 if ( $format eq '1YMMXXXXXXXX' ) {
433 my $counter = new File::CounterFile 'cust_main.agent_custid';
436 my $ym = 100000000000 + time2str('%y%m00000000', time);
437 if ( $ym > $counter->value ) {
438 $counter->{'value'} = $agent_custid = $ym;
439 $counter->{'updated'} = 1;
441 $agent_custid = $counter->inc;
447 die "Unknown cust_main-auto_agent_custid format: $format";
450 $self->agent_custid($agent_custid);
454 sub start_copy_skel {
457 #'mg_user_preference' => {},
458 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
459 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
460 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
461 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
462 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
465 _copy_skel( 'cust_main', #tablename
466 $conf->config('cust_main-skeleton_custnum'), #sourceid
467 $self->custnum, #destid
468 @tables, #child tables
472 #recursive subroutine, not a method
474 my( $table, $sourceid, $destid, %child_tables ) = @_;
477 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
478 ( $table, $primary_key ) = ( $1, $2 );
480 my $dbdef_table = dbdef->table($table);
481 $primary_key = $dbdef_table->primary_key
482 or return "$table has no primary key".
483 " (or do you need to run dbdef-create?)";
486 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
487 join (', ', keys %child_tables). "\n"
490 foreach my $child_table_def ( keys %child_tables ) {
494 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
495 ( $child_table, $child_pkey ) = ( $1, $2 );
497 $child_table = $child_table_def;
499 $child_pkey = dbdef->table($child_table)->primary_key;
500 # or return "$table has no primary key".
501 # " (or do you need to run dbdef-create?)\n";
505 if ( keys %{ $child_tables{$child_table_def} } ) {
507 return "$child_table has no primary key".
508 " (run dbdef-create or try specifying it?)\n"
511 #false laziness w/Record::insert and only works on Pg
512 #refactor the proper last-inserted-id stuff out of Record::insert if this
513 # ever gets use for anything besides a quick kludge for one customer
514 my $default = dbdef->table($child_table)->column($child_pkey)->default;
515 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
516 or return "can't parse $child_table.$child_pkey default value ".
517 " for sequence name: $default";
522 my @sel_columns = grep { $_ ne $primary_key }
523 dbdef->table($child_table)->columns;
524 my $sel_columns = join(', ', @sel_columns );
526 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
527 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
528 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
530 my $sel_st = "SELECT $sel_columns FROM $child_table".
531 " WHERE $primary_key = $sourceid";
534 my $sel_sth = dbh->prepare( $sel_st )
535 or return dbh->errstr;
537 $sel_sth->execute or return $sel_sth->errstr;
539 while ( my $row = $sel_sth->fetchrow_hashref ) {
541 warn " selected row: ".
542 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
546 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
547 my $ins_sth =dbh->prepare($statement)
548 or return dbh->errstr;
549 my @param = ( $destid, map $row->{$_}, @ins_columns );
550 warn " $statement: [ ". join(', ', @param). " ]\n"
552 $ins_sth->execute( @param )
553 or return $ins_sth->errstr;
555 #next unless keys %{ $child_tables{$child_table} };
556 next unless $sequence;
558 #another section of that laziness
559 my $seq_sql = "SELECT currval('$sequence')";
560 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
561 $seq_sth->execute or return $seq_sth->errstr;
562 my $insertid = $seq_sth->fetchrow_arrayref->[0];
564 # don't drink soap! recurse! recurse! okay!
566 _copy_skel( $child_table_def,
567 $row->{$child_pkey}, #sourceid
569 %{ $child_tables{$child_table_def} },
571 return $error if $error;
581 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
583 Like the insert method on an existing record, this method orders a package
584 and included services atomicaly. Pass a Tie::RefHash data structure to this
585 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
586 be a better explanation of this, but until then, here's an example:
589 tie %hash, 'Tie::RefHash'; #this part is important
591 $cust_pkg => [ $svc_acct ],
594 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
596 Services can be new, in which case they are inserted, or existing unaudited
597 services, in which case they are linked to the newly-created package.
599 Currently available options are: I<depend_jobnum> and I<noexport>.
601 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
602 on the supplied jobnum (they will not run until the specific job completes).
603 This can be used to defer provisioning until some action completes (such
604 as running the customer's credit card successfully).
606 The I<noexport> option is deprecated. If I<noexport> is set true, no
607 provisioning jobs (exports) are scheduled. (You can schedule them later with
608 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
609 on the cust_main object is not recommended, as existing services will also be
616 my $cust_pkgs = shift;
619 my %svc_options = ();
620 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
621 if exists $options{'depend_jobnum'};
622 warn "$me order_pkgs called with options ".
623 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
626 local $SIG{HUP} = 'IGNORE';
627 local $SIG{INT} = 'IGNORE';
628 local $SIG{QUIT} = 'IGNORE';
629 local $SIG{TERM} = 'IGNORE';
630 local $SIG{TSTP} = 'IGNORE';
631 local $SIG{PIPE} = 'IGNORE';
633 my $oldAutoCommit = $FS::UID::AutoCommit;
634 local $FS::UID::AutoCommit = 0;
637 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
639 foreach my $cust_pkg ( keys %$cust_pkgs ) {
640 $cust_pkg->custnum( $self->custnum );
641 my $error = $cust_pkg->insert;
643 $dbh->rollback if $oldAutoCommit;
644 return "inserting cust_pkg (transaction rolled back): $error";
646 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
647 if ( $svc_something->svcnum ) {
648 my $old_cust_svc = $svc_something->cust_svc;
649 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
650 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
651 $error = $new_cust_svc->replace($old_cust_svc);
653 $svc_something->pkgnum( $cust_pkg->pkgnum );
654 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
655 $svc_something->seconds( $svc_something->seconds + $$seconds );
658 $error = $svc_something->insert(%svc_options);
661 $dbh->rollback if $oldAutoCommit;
662 #return "inserting svc_ (transaction rolled back): $error";
668 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
672 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
674 Recharges this (existing) customer with the specified prepaid card (see
675 L<FS::prepay_credit>), specified either by I<identifier> or as an
676 FS::prepay_credit object. If there is an error, returns the error, otherwise
679 Optionally, four scalar references can be passed as well. They will have their
680 values filled in with the amount, number of seconds, and number of upload and
681 download bytes applied by this prepaid
686 sub recharge_prepay {
687 my( $self, $prepay_credit, $amountref, $secondsref,
688 $upbytesref, $downbytesref, $totalbytesref ) = @_;
690 local $SIG{HUP} = 'IGNORE';
691 local $SIG{INT} = 'IGNORE';
692 local $SIG{QUIT} = 'IGNORE';
693 local $SIG{TERM} = 'IGNORE';
694 local $SIG{TSTP} = 'IGNORE';
695 local $SIG{PIPE} = 'IGNORE';
697 my $oldAutoCommit = $FS::UID::AutoCommit;
698 local $FS::UID::AutoCommit = 0;
701 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
703 my $error = $self->get_prepay($prepay_credit, \$amount,
704 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
705 || $self->increment_seconds($seconds)
706 || $self->increment_upbytes($upbytes)
707 || $self->increment_downbytes($downbytes)
708 || $self->increment_totalbytes($totalbytes)
709 || $self->insert_cust_pay_prepay( $amount,
711 ? $prepay_credit->identifier
716 $dbh->rollback if $oldAutoCommit;
720 if ( defined($amountref) ) { $$amountref = $amount; }
721 if ( defined($secondsref) ) { $$secondsref = $seconds; }
722 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
723 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
724 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
726 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
731 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
733 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
734 specified either by I<identifier> or as an FS::prepay_credit object.
736 References to I<amount> and I<seconds> scalars should be passed as arguments
737 and will be incremented by the values of the prepaid card.
739 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
740 check or set this customer's I<agentnum>.
742 If there is an error, returns the error, otherwise returns false.
748 my( $self, $prepay_credit, $amountref, $secondsref,
749 $upref, $downref, $totalref) = @_;
751 local $SIG{HUP} = 'IGNORE';
752 local $SIG{INT} = 'IGNORE';
753 local $SIG{QUIT} = 'IGNORE';
754 local $SIG{TERM} = 'IGNORE';
755 local $SIG{TSTP} = 'IGNORE';
756 local $SIG{PIPE} = 'IGNORE';
758 my $oldAutoCommit = $FS::UID::AutoCommit;
759 local $FS::UID::AutoCommit = 0;
762 unless ( ref($prepay_credit) ) {
764 my $identifier = $prepay_credit;
766 $prepay_credit = qsearchs(
768 { 'identifier' => $prepay_credit },
773 unless ( $prepay_credit ) {
774 $dbh->rollback if $oldAutoCommit;
775 return "Invalid prepaid card: ". $identifier;
780 if ( $prepay_credit->agentnum ) {
781 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
782 $dbh->rollback if $oldAutoCommit;
783 return "prepaid card not valid for agent ". $self->agentnum;
785 $self->agentnum($prepay_credit->agentnum);
788 my $error = $prepay_credit->delete;
790 $dbh->rollback if $oldAutoCommit;
791 return "removing prepay_credit (transaction rolled back): $error";
794 $$amountref += $prepay_credit->amount;
795 $$secondsref += $prepay_credit->seconds;
796 $$upref += $prepay_credit->upbytes;
797 $$downref += $prepay_credit->downbytes;
798 $$totalref += $prepay_credit->totalbytes;
800 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
805 =item increment_upbytes SECONDS
807 Updates this customer's single or primary account (see L<FS::svc_acct>) by
808 the specified number of upbytes. If there is an error, returns the error,
809 otherwise returns false.
813 sub increment_upbytes {
814 _increment_column( shift, 'upbytes', @_);
817 =item increment_downbytes SECONDS
819 Updates this customer's single or primary account (see L<FS::svc_acct>) by
820 the specified number of downbytes. If there is an error, returns the error,
821 otherwise returns false.
825 sub increment_downbytes {
826 _increment_column( shift, 'downbytes', @_);
829 =item increment_totalbytes SECONDS
831 Updates this customer's single or primary account (see L<FS::svc_acct>) by
832 the specified number of totalbytes. If there is an error, returns the error,
833 otherwise returns false.
837 sub increment_totalbytes {
838 _increment_column( shift, 'totalbytes', @_);
841 =item increment_seconds SECONDS
843 Updates this customer's single or primary account (see L<FS::svc_acct>) by
844 the specified number of seconds. If there is an error, returns the error,
845 otherwise returns false.
849 sub increment_seconds {
850 _increment_column( shift, 'seconds', @_);
853 =item _increment_column AMOUNT
855 Updates this customer's single or primary account (see L<FS::svc_acct>) by
856 the specified number of seconds or bytes. If there is an error, returns
857 the error, otherwise returns false.
861 sub _increment_column {
862 my( $self, $column, $amount ) = @_;
863 warn "$me increment_column called: $column, $amount\n"
866 return '' unless $amount;
868 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
869 $self->ncancelled_pkgs;
872 return 'No packages with primary or single services found'.
873 ' to apply pre-paid time';
874 } elsif ( scalar(@cust_pkg) > 1 ) {
875 #maybe have a way to specify the package/account?
876 return 'Multiple packages found to apply pre-paid time';
879 my $cust_pkg = $cust_pkg[0];
880 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
884 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
887 return 'No account found to apply pre-paid time';
888 } elsif ( scalar(@cust_svc) > 1 ) {
889 return 'Multiple accounts found to apply pre-paid time';
892 my $svc_acct = $cust_svc[0]->svc_x;
893 warn " found service svcnum ". $svc_acct->pkgnum.
894 ' ('. $svc_acct->email. ")\n"
897 $column = "increment_$column";
898 $svc_acct->$column($amount);
902 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
904 Inserts a prepayment in the specified amount for this customer. An optional
905 second argument can specify the prepayment identifier for tracking purposes.
906 If there is an error, returns the error, otherwise returns false.
910 sub insert_cust_pay_prepay {
911 shift->insert_cust_pay('PREP', @_);
914 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
916 Inserts a cash payment in the specified amount for this customer. An optional
917 second argument can specify the payment identifier for tracking purposes.
918 If there is an error, returns the error, otherwise returns false.
922 sub insert_cust_pay_cash {
923 shift->insert_cust_pay('CASH', @_);
926 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
928 Inserts a Western Union payment in the specified amount for this customer. An
929 optional second argument can specify the prepayment identifier for tracking
930 purposes. If there is an error, returns the error, otherwise returns false.
934 sub insert_cust_pay_west {
935 shift->insert_cust_pay('WEST', @_);
938 sub insert_cust_pay {
939 my( $self, $payby, $amount ) = splice(@_, 0, 3);
940 my $payinfo = scalar(@_) ? shift : '';
942 my $cust_pay = new FS::cust_pay {
943 'custnum' => $self->custnum,
944 'paid' => sprintf('%.2f', $amount),
945 #'_date' => #date the prepaid card was purchased???
947 'payinfo' => $payinfo,
955 This method is deprecated. See the I<depend_jobnum> option to the insert and
956 order_pkgs methods for a better way to defer provisioning.
958 Re-schedules all exports by calling the B<reexport> method of all associated
959 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
960 otherwise returns false.
967 carp "WARNING: FS::cust_main::reexport is deprectated; ".
968 "use the depend_jobnum option to insert or order_pkgs to delay export";
970 local $SIG{HUP} = 'IGNORE';
971 local $SIG{INT} = 'IGNORE';
972 local $SIG{QUIT} = 'IGNORE';
973 local $SIG{TERM} = 'IGNORE';
974 local $SIG{TSTP} = 'IGNORE';
975 local $SIG{PIPE} = 'IGNORE';
977 my $oldAutoCommit = $FS::UID::AutoCommit;
978 local $FS::UID::AutoCommit = 0;
981 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
982 my $error = $cust_pkg->reexport;
984 $dbh->rollback if $oldAutoCommit;
989 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
994 =item delete NEW_CUSTNUM
996 This deletes the customer. If there is an error, returns the error, otherwise
999 This will completely remove all traces of the customer record. This is not
1000 what you want when a customer cancels service; for that, cancel all of the
1001 customer's packages (see L</cancel>).
1003 If the customer has any uncancelled packages, you need to pass a new (valid)
1004 customer number for those packages to be transferred to. Cancelled packages
1005 will be deleted. Did I mention that this is NOT what you want when a customer
1006 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1008 You can't delete a customer with invoices (see L<FS::cust_bill>),
1009 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1010 refunds (see L<FS::cust_refund>).
1017 local $SIG{HUP} = 'IGNORE';
1018 local $SIG{INT} = 'IGNORE';
1019 local $SIG{QUIT} = 'IGNORE';
1020 local $SIG{TERM} = 'IGNORE';
1021 local $SIG{TSTP} = 'IGNORE';
1022 local $SIG{PIPE} = 'IGNORE';
1024 my $oldAutoCommit = $FS::UID::AutoCommit;
1025 local $FS::UID::AutoCommit = 0;
1028 if ( $self->cust_bill ) {
1029 $dbh->rollback if $oldAutoCommit;
1030 return "Can't delete a customer with invoices";
1032 if ( $self->cust_credit ) {
1033 $dbh->rollback if $oldAutoCommit;
1034 return "Can't delete a customer with credits";
1036 if ( $self->cust_pay ) {
1037 $dbh->rollback if $oldAutoCommit;
1038 return "Can't delete a customer with payments";
1040 if ( $self->cust_refund ) {
1041 $dbh->rollback if $oldAutoCommit;
1042 return "Can't delete a customer with refunds";
1045 my @cust_pkg = $self->ncancelled_pkgs;
1047 my $new_custnum = shift;
1048 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1049 $dbh->rollback if $oldAutoCommit;
1050 return "Invalid new customer number: $new_custnum";
1052 foreach my $cust_pkg ( @cust_pkg ) {
1053 my %hash = $cust_pkg->hash;
1054 $hash{'custnum'} = $new_custnum;
1055 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1056 my $error = $new_cust_pkg->replace($cust_pkg,
1057 options => { $cust_pkg->options },
1060 $dbh->rollback if $oldAutoCommit;
1065 my @cancelled_cust_pkg = $self->all_pkgs;
1066 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1067 my $error = $cust_pkg->delete;
1069 $dbh->rollback if $oldAutoCommit;
1074 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1075 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1077 my $error = $cust_main_invoice->delete;
1079 $dbh->rollback if $oldAutoCommit;
1084 my $error = $self->SUPER::delete;
1086 $dbh->rollback if $oldAutoCommit;
1090 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1095 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ]
1097 Replaces the OLD_RECORD with this one in the database. If there is an error,
1098 returns the error, otherwise returns false.
1100 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1101 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1102 expected and rollback the entire transaction; it is not necessary to call
1103 check_invoicing_list first. Here's an example:
1105 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1112 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1114 : $self->replace_old;
1118 warn "$me replace called\n"
1121 my $curuser = $FS::CurrentUser::CurrentUser;
1122 if ( $self->payby eq 'COMP'
1123 && $self->payby ne $old->payby
1124 && ! $curuser->access_right('Complimentary customer')
1127 return "You are not permitted to create complimentary accounts.";
1130 local($ignore_expired_card) = 1
1131 if $old->payby =~ /^(CARD|DCRD)$/
1132 && $self->payby =~ /^(CARD|DCRD)$/
1133 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1135 local $SIG{HUP} = 'IGNORE';
1136 local $SIG{INT} = 'IGNORE';
1137 local $SIG{QUIT} = 'IGNORE';
1138 local $SIG{TERM} = 'IGNORE';
1139 local $SIG{TSTP} = 'IGNORE';
1140 local $SIG{PIPE} = 'IGNORE';
1142 my $oldAutoCommit = $FS::UID::AutoCommit;
1143 local $FS::UID::AutoCommit = 0;
1146 my $error = $self->SUPER::replace($old);
1149 $dbh->rollback if $oldAutoCommit;
1153 if ( @param ) { # INVOICING_LIST_ARYREF
1154 my $invoicing_list = shift @param;
1155 $error = $self->check_invoicing_list( $invoicing_list );
1157 $dbh->rollback if $oldAutoCommit;
1160 $self->invoicing_list( $invoicing_list );
1163 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1164 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1165 # card/check/lec info has changed, want to retry realtime_ invoice events
1166 my $error = $self->retry_realtime;
1168 $dbh->rollback if $oldAutoCommit;
1173 unless ( $import || $skip_fuzzyfiles ) {
1174 $error = $self->queue_fuzzyfiles_update;
1176 $dbh->rollback if $oldAutoCommit;
1177 return "updating fuzzy search cache: $error";
1181 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1186 =item queue_fuzzyfiles_update
1188 Used by insert & replace to update the fuzzy search cache
1192 sub queue_fuzzyfiles_update {
1195 local $SIG{HUP} = 'IGNORE';
1196 local $SIG{INT} = 'IGNORE';
1197 local $SIG{QUIT} = 'IGNORE';
1198 local $SIG{TERM} = 'IGNORE';
1199 local $SIG{TSTP} = 'IGNORE';
1200 local $SIG{PIPE} = 'IGNORE';
1202 my $oldAutoCommit = $FS::UID::AutoCommit;
1203 local $FS::UID::AutoCommit = 0;
1206 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1207 my $error = $queue->insert( map $self->getfield($_),
1208 qw(first last company)
1211 $dbh->rollback if $oldAutoCommit;
1212 return "queueing job (transaction rolled back): $error";
1215 if ( $self->ship_last ) {
1216 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1217 $error = $queue->insert( map $self->getfield("ship_$_"),
1218 qw(first last company)
1221 $dbh->rollback if $oldAutoCommit;
1222 return "queueing job (transaction rolled back): $error";
1226 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1233 Checks all fields to make sure this is a valid customer record. If there is
1234 an error, returns the error, otherwise returns false. Called by the insert
1235 and replace methods.
1242 warn "$me check BEFORE: \n". $self->_dump
1246 $self->ut_numbern('custnum')
1247 || $self->ut_number('agentnum')
1248 || $self->ut_textn('agent_custid')
1249 || $self->ut_number('refnum')
1250 || $self->ut_textn('custbatch')
1251 || $self->ut_name('last')
1252 || $self->ut_name('first')
1253 || $self->ut_snumbern('birthdate')
1254 || $self->ut_snumbern('signupdate')
1255 || $self->ut_textn('company')
1256 || $self->ut_text('address1')
1257 || $self->ut_textn('address2')
1258 || $self->ut_text('city')
1259 || $self->ut_textn('county')
1260 || $self->ut_textn('state')
1261 || $self->ut_country('country')
1262 || $self->ut_anything('comments')
1263 || $self->ut_numbern('referral_custnum')
1264 || $self->ut_textn('stateid')
1265 || $self->ut_textn('stateid_state')
1266 || $self->ut_textn('invoice_terms')
1267 || $self->ut_alphan('geocode')
1270 #barf. need message catalogs. i18n. etc.
1271 $error .= "Please select an advertising source."
1272 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1273 return $error if $error;
1275 return "Unknown agent"
1276 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1278 return "Unknown refnum"
1279 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1281 return "Unknown referring custnum: ". $self->referral_custnum
1282 unless ! $self->referral_custnum
1283 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1285 if ( $self->ss eq '' ) {
1290 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1291 or return "Illegal social security number: ". $self->ss;
1292 $self->ss("$1-$2-$3");
1296 # bad idea to disable, causes billing to fail because of no tax rates later
1297 # unless ( $import ) {
1298 unless ( qsearch('cust_main_county', {
1299 'country' => $self->country,
1302 return "Unknown state/county/country: ".
1303 $self->state. "/". $self->county. "/". $self->country
1304 unless qsearch('cust_main_county',{
1305 'state' => $self->state,
1306 'county' => $self->county,
1307 'country' => $self->country,
1313 $self->ut_phonen('daytime', $self->country)
1314 || $self->ut_phonen('night', $self->country)
1315 || $self->ut_phonen('fax', $self->country)
1316 || $self->ut_zip('zip', $self->country)
1318 return $error if $error;
1320 if ( $conf->exists('cust_main-require_phone')
1321 && ! length($self->daytime) && ! length($self->night)
1324 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1326 : FS::Msgcat::_gettext('daytime');
1327 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1329 : FS::Msgcat::_gettext('night');
1331 return "$daytime_label or $night_label is required"
1335 if ( $self->has_ship_address
1336 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1337 $self->addr_fields )
1341 $self->ut_name('ship_last')
1342 || $self->ut_name('ship_first')
1343 || $self->ut_textn('ship_company')
1344 || $self->ut_text('ship_address1')
1345 || $self->ut_textn('ship_address2')
1346 || $self->ut_text('ship_city')
1347 || $self->ut_textn('ship_county')
1348 || $self->ut_textn('ship_state')
1349 || $self->ut_country('ship_country')
1351 return $error if $error;
1353 #false laziness with above
1354 unless ( qsearchs('cust_main_county', {
1355 'country' => $self->ship_country,
1358 return "Unknown ship_state/ship_county/ship_country: ".
1359 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1360 unless qsearch('cust_main_county',{
1361 'state' => $self->ship_state,
1362 'county' => $self->ship_county,
1363 'country' => $self->ship_country,
1369 $self->ut_phonen('ship_daytime', $self->ship_country)
1370 || $self->ut_phonen('ship_night', $self->ship_country)
1371 || $self->ut_phonen('ship_fax', $self->ship_country)
1372 || $self->ut_zip('ship_zip', $self->ship_country)
1374 return $error if $error;
1376 return "Unit # is required."
1377 if $self->ship_address2 =~ /^\s*$/
1378 && $conf->exists('cust_main-require_address2');
1380 } else { # ship_ info eq billing info, so don't store dup info in database
1382 $self->setfield("ship_$_", '')
1383 foreach $self->addr_fields;
1385 return "Unit # is required."
1386 if $self->address2 =~ /^\s*$/
1387 && $conf->exists('cust_main-require_address2');
1391 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1392 # or return "Illegal payby: ". $self->payby;
1394 FS::payby->can_payby($self->table, $self->payby)
1395 or return "Illegal payby: ". $self->payby;
1397 $error = $self->ut_numbern('paystart_month')
1398 || $self->ut_numbern('paystart_year')
1399 || $self->ut_numbern('payissue')
1400 || $self->ut_textn('paytype')
1402 return $error if $error;
1404 if ( $self->payip eq '' ) {
1407 $error = $self->ut_ip('payip');
1408 return $error if $error;
1411 # If it is encrypted and the private key is not availaible then we can't
1412 # check the credit card.
1414 my $check_payinfo = 1;
1416 if ($self->is_encrypted($self->payinfo)) {
1420 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1422 my $payinfo = $self->payinfo;
1423 $payinfo =~ s/\D//g;
1424 $payinfo =~ /^(\d{13,16})$/
1425 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1427 $self->payinfo($payinfo);
1429 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1431 return gettext('unknown_card_type')
1432 if cardtype($self->payinfo) eq "Unknown";
1434 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1436 return 'Banned credit card: banned on '.
1437 time2str('%a %h %o at %r', $ban->_date).
1438 ' by '. $ban->otaker.
1439 ' (ban# '. $ban->bannum. ')';
1442 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1443 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1444 $self->paycvv =~ /^(\d{4})$/
1445 or return "CVV2 (CID) for American Express cards is four digits.";
1448 $self->paycvv =~ /^(\d{3})$/
1449 or return "CVV2 (CVC2/CID) is three digits.";
1456 my $cardtype = cardtype($payinfo);
1457 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1459 return "Start date or issue number is required for $cardtype cards"
1460 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1462 return "Start month must be between 1 and 12"
1463 if $self->paystart_month
1464 and $self->paystart_month < 1 || $self->paystart_month > 12;
1466 return "Start year must be 1990 or later"
1467 if $self->paystart_year
1468 and $self->paystart_year < 1990;
1470 return "Issue number must be beween 1 and 99"
1472 and $self->payissue < 1 || $self->payissue > 99;
1475 $self->paystart_month('');
1476 $self->paystart_year('');
1477 $self->payissue('');
1480 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1482 my $payinfo = $self->payinfo;
1483 $payinfo =~ s/[^\d\@]//g;
1484 if ( $conf->exists('echeck-nonus') ) {
1485 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1486 $payinfo = "$1\@$2";
1488 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1489 $payinfo = "$1\@$2";
1491 $self->payinfo($payinfo);
1494 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1496 return 'Banned ACH account: banned on '.
1497 time2str('%a %h %o at %r', $ban->_date).
1498 ' by '. $ban->otaker.
1499 ' (ban# '. $ban->bannum. ')';
1502 } elsif ( $self->payby eq 'LECB' ) {
1504 my $payinfo = $self->payinfo;
1505 $payinfo =~ s/\D//g;
1506 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1508 $self->payinfo($payinfo);
1511 } elsif ( $self->payby eq 'BILL' ) {
1513 $error = $self->ut_textn('payinfo');
1514 return "Illegal P.O. number: ". $self->payinfo if $error;
1517 } elsif ( $self->payby eq 'COMP' ) {
1519 my $curuser = $FS::CurrentUser::CurrentUser;
1520 if ( ! $self->custnum
1521 && ! $curuser->access_right('Complimentary customer')
1524 return "You are not permitted to create complimentary accounts."
1527 $error = $self->ut_textn('payinfo');
1528 return "Illegal comp account issuer: ". $self->payinfo if $error;
1531 } elsif ( $self->payby eq 'PREPAY' ) {
1533 my $payinfo = $self->payinfo;
1534 $payinfo =~ s/\W//g; #anything else would just confuse things
1535 $self->payinfo($payinfo);
1536 $error = $self->ut_alpha('payinfo');
1537 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1538 return "Unknown prepayment identifier"
1539 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1544 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1545 return "Expiration date required"
1546 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1550 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1551 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1552 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1553 ( $m, $y ) = ( $3, "20$2" );
1555 return "Illegal expiration date: ". $self->paydate;
1557 $self->paydate("$y-$m-01");
1558 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1559 return gettext('expired_card')
1561 && !$ignore_expired_card
1562 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1565 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1566 ( ! $conf->exists('require_cardname')
1567 || $self->payby !~ /^(CARD|DCRD)$/ )
1569 $self->payname( $self->first. " ". $self->getfield('last') );
1571 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1572 or return gettext('illegal_name'). " payname: ". $self->payname;
1576 foreach my $flag (qw( tax spool_cdr squelch_cdr )) {
1577 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1581 $self->otaker(getotaker) unless $self->otaker;
1583 warn "$me check AFTER: \n". $self->_dump
1586 $self->SUPER::check;
1591 Returns a list of fields which have ship_ duplicates.
1596 qw( last first company
1597 address1 address2 city county state zip country
1602 =item has_ship_address
1604 Returns true if this customer record has a separate shipping address.
1608 sub has_ship_address {
1610 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1615 Returns all packages (see L<FS::cust_pkg>) for this customer.
1622 return $self->num_pkgs unless wantarray;
1625 if ( $self->{'_pkgnum'} ) {
1626 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1628 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1631 sort sort_packages @cust_pkg;
1636 Synonym for B<all_pkgs>.
1641 shift->all_pkgs(@_);
1644 =item ncancelled_pkgs
1646 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1650 sub ncancelled_pkgs {
1653 return $self->num_ncancelled_pkgs unless wantarray;
1656 if ( $self->{'_pkgnum'} ) {
1658 warn "$me ncancelled_pkgs: returning cached objects"
1661 @cust_pkg = grep { ! $_->getfield('cancel') }
1662 values %{ $self->{'_pkgnum'}->cache };
1666 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1667 $self->custnum. "\n"
1671 qsearch( 'cust_pkg', {
1672 'custnum' => $self->custnum,
1676 qsearch( 'cust_pkg', {
1677 'custnum' => $self->custnum,
1682 sort sort_packages @cust_pkg;
1686 # This should be generalized to use config options to determine order.
1688 if ( $a->get('cancel') and $b->get('cancel') ) {
1689 $a->pkgnum <=> $b->pkgnum;
1690 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1691 return -1 if $b->get('cancel');
1692 return 1 if $a->get('cancel');
1695 $a->pkgnum <=> $b->pkgnum;
1699 =item suspended_pkgs
1701 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1705 sub suspended_pkgs {
1707 grep { $_->susp } $self->ncancelled_pkgs;
1710 =item unflagged_suspended_pkgs
1712 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1713 customer (thouse packages without the `manual_flag' set).
1717 sub unflagged_suspended_pkgs {
1719 return $self->suspended_pkgs
1720 unless dbdef->table('cust_pkg')->column('manual_flag');
1721 grep { ! $_->manual_flag } $self->suspended_pkgs;
1724 =item unsuspended_pkgs
1726 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1731 sub unsuspended_pkgs {
1733 grep { ! $_->susp } $self->ncancelled_pkgs;
1736 =item num_cancelled_pkgs
1738 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1743 sub num_cancelled_pkgs {
1744 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1747 sub num_ncancelled_pkgs {
1748 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1752 my( $self ) = shift;
1753 my $sql = scalar(@_) ? shift : '';
1754 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1755 my $sth = dbh->prepare(
1756 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1757 ) or die dbh->errstr;
1758 $sth->execute($self->custnum) or die $sth->errstr;
1759 $sth->fetchrow_arrayref->[0];
1764 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1765 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1766 on success or a list of errors.
1772 grep { $_->unsuspend } $self->suspended_pkgs;
1777 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1779 Returns a list: an empty list on success or a list of errors.
1785 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1788 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1790 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1791 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1792 of a list of pkgparts; the hashref has the following keys:
1796 =item pkgparts - listref of pkgparts
1798 =item (other options are passed to the suspend method)
1803 Returns a list: an empty list on success or a list of errors.
1807 sub suspend_if_pkgpart {
1809 my (@pkgparts, %opt);
1810 if (ref($_[0]) eq 'HASH'){
1811 @pkgparts = @{$_[0]{pkgparts}};
1816 grep { $_->suspend(%opt) }
1817 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1818 $self->unsuspended_pkgs;
1821 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1823 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1824 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1825 instead of a list of pkgparts; the hashref has the following keys:
1829 =item pkgparts - listref of pkgparts
1831 =item (other options are passed to the suspend method)
1835 Returns a list: an empty list on success or a list of errors.
1839 sub suspend_unless_pkgpart {
1841 my (@pkgparts, %opt);
1842 if (ref($_[0]) eq 'HASH'){
1843 @pkgparts = @{$_[0]{pkgparts}};
1848 grep { $_->suspend(%opt) }
1849 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1850 $self->unsuspended_pkgs;
1853 =item cancel [ OPTION => VALUE ... ]
1855 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1857 Available options are:
1861 =item quiet - can be set true to supress email cancellation notices.
1863 =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.
1865 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1869 Always returns a list: an empty list on success or a list of errors.
1874 my( $self, %opt ) = @_;
1876 warn "$me cancel called on customer ". $self->custnum. " with options ".
1877 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1880 return ( 'access denied' )
1881 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1883 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1885 #should try decryption (we might have the private key)
1886 # and if not maybe queue a job for the server that does?
1887 return ( "Can't (yet) ban encrypted credit cards" )
1888 if $self->is_encrypted($self->payinfo);
1890 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1891 my $error = $ban->insert;
1892 return ( $error ) if $error;
1896 my @pkgs = $self->ncancelled_pkgs;
1898 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1899 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1902 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1905 sub _banned_pay_hashref {
1916 'payby' => $payby2ban{$self->payby},
1917 'payinfo' => md5_base64($self->payinfo),
1918 #don't ever *search* on reason! #'reason' =>
1924 Returns all notes (see L<FS::cust_main_note>) for this customer.
1931 qsearch( 'cust_main_note',
1932 { 'custnum' => $self->custnum },
1934 'ORDER BY _DATE DESC'
1940 Returns the agent (see L<FS::agent>) for this customer.
1946 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1949 =item bill_and_collect
1951 Cancels and suspends any packages due, generates bills, applies payments and
1954 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1956 Options are passed as name-value pairs. Currently available options are:
1962 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:
1966 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1970 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.
1974 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1978 If set true, re-charges setup fees.
1982 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)
1988 sub bill_and_collect {
1989 my( $self, %options ) = @_;
1995 #$options{actual_time} not $options{time} because freeside-daily -d is for
1996 #pre-printing invoices
1997 my @cancel_pkgs = grep { $_->expire && $_->expire <= $options{actual_time} }
1998 $self->ncancelled_pkgs;
2000 foreach my $cust_pkg ( @cancel_pkgs ) {
2001 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2002 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2003 'reason_otaker' => $cpr->otaker
2007 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2008 " for custnum ". $self->custnum. ": $error"
2016 #$options{actual_time} not $options{time} because freeside-daily -d is for
2017 #pre-printing invoices
2020 && ( ( $_->part_pkg->is_prepaid
2022 && $_->bill < $options{actual_time}
2025 && $_->adjourn <= $options{actual_time}
2029 $self->ncancelled_pkgs;
2031 foreach my $cust_pkg ( @susp_pkgs ) {
2032 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2033 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2034 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2035 'reason_otaker' => $cpr->otaker
2040 warn "Error suspending package ". $cust_pkg->pkgnum.
2041 " for custnum ". $self->custnum. ": $error"
2049 my $error = $self->bill( %options );
2050 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2052 $self->apply_payments_and_credits;
2054 $error = $self->collect( %options );
2055 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2061 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2062 conjunction with the collect method by calling B<bill_and_collect>.
2064 If there is an error, returns the error, otherwise returns false.
2066 Options are passed as name-value pairs. Currently available options are:
2072 If set true, re-charges setup fees.
2076 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:
2080 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2084 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2086 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2090 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.
2097 my( $self, %options ) = @_;
2098 return '' if $self->payby eq 'COMP';
2099 warn "$me bill customer ". $self->custnum. "\n"
2102 my $time = $options{'time'} || time;
2105 local $SIG{HUP} = 'IGNORE';
2106 local $SIG{INT} = 'IGNORE';
2107 local $SIG{QUIT} = 'IGNORE';
2108 local $SIG{TERM} = 'IGNORE';
2109 local $SIG{TSTP} = 'IGNORE';
2110 local $SIG{PIPE} = 'IGNORE';
2112 my $oldAutoCommit = $FS::UID::AutoCommit;
2113 local $FS::UID::AutoCommit = 0;
2116 $self->select_for_update; #mutex
2118 my @cust_bill_pkg = ();
2121 # find the packages which are due for billing, find out how much they are
2122 # & generate invoice database.
2125 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2129 my @precommit_hooks = ();
2131 my @cust_pkgs = qsearch('cust_pkg', { 'custnum' => $self->custnum } );
2132 foreach my $cust_pkg (@cust_pkgs) {
2134 #NO!! next if $cust_pkg->cancel;
2135 next if $cust_pkg->getfield('cancel');
2137 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2139 #? to avoid use of uninitialized value errors... ?
2140 $cust_pkg->setfield('bill', '')
2141 unless defined($cust_pkg->bill);
2143 #my $part_pkg = $cust_pkg->part_pkg;
2145 my $real_pkgpart = $cust_pkg->pkgpart;
2146 my %hash = $cust_pkg->hash;
2148 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2150 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2153 $self->_make_lines( 'part_pkg' => $part_pkg,
2154 'cust_pkg' => $cust_pkg,
2155 'precommit_hooks' => \@precommit_hooks,
2156 'line_items' => \@cust_bill_pkg,
2157 'setup' => \$total_setup,
2158 'recur' => \$total_recur,
2159 'tax_matrix' => \%taxlisthash,
2161 'options' => \%options,
2164 $dbh->rollback if $oldAutoCommit;
2168 } #foreach my $part_pkg
2170 } #foreach my $cust_pkg
2172 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2173 #but do commit any package date cycling that happened
2174 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2178 my $postal_pkg = $self->charge_postal_fee();
2179 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2180 $dbh->rollback if $oldAutoCommit;
2181 return "can't charge postal invoice fee for customer ".
2182 $self->custnum. ": $postal_pkg";
2185 ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2186 !$conf->exists('postal_invoice-recurring_only')
2190 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2192 $self->_make_lines( 'part_pkg' => $part_pkg,
2193 'cust_pkg' => $postal_pkg,
2194 'precommit_hooks' => \@precommit_hooks,
2195 'line_items' => \@cust_bill_pkg,
2196 'setup' => \$total_setup,
2197 'recur' => \$total_recur,
2198 'tax_matrix' => \%taxlisthash,
2200 'options' => \%options,
2203 $dbh->rollback if $oldAutoCommit;
2209 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2210 foreach my $tax ( keys %taxlisthash ) {
2211 my $tax_object = shift @{ $taxlisthash{$tax} };
2212 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2213 my $listref_or_error = $tax_object->taxline( @{ $taxlisthash{$tax} } );
2214 unless (ref($listref_or_error)) {
2215 $dbh->rollback if $oldAutoCommit;
2216 return $listref_or_error;
2218 unshift @{ $taxlisthash{$tax} }, $tax_object;
2220 warn "adding ". $listref_or_error->[1].
2221 " as ". $listref_or_error->[0]. "\n"
2223 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2224 if ( $taxname{ $listref_or_error->[0] } ) {
2225 push @{ $taxname{ $listref_or_error->[0] } }, $tax_object->taxname;
2227 $taxname{ $listref_or_error->[0] } = [ $tax_object->taxname ];
2232 #some taxes are taxed
2235 warn "finding taxed taxes...\n" if $DEBUG > 2;
2236 foreach my $tax ( keys %taxlisthash ) {
2237 my $tax_object = shift @{ $taxlisthash{$tax} };
2238 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
2240 next unless $tax_object->can('tax_on_tax');
2242 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
2243 my $totname = ref( $tot ). ' '. $tot->taxnum;
2245 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
2247 next unless exists( $taxlisthash{ $totname } ); # only increase
2249 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
2250 if ( exists( $totlisthash{ $totname } ) ) {
2251 push @{ $totlisthash{ $totname } }, $tax{ $tax_object->taxname };
2253 $totlisthash{ $totname } = [ $tot, $tax{ $tax_object->taxname } ];
2258 warn "having a look at taxed taxes...\n" if $DEBUG > 2;
2259 foreach my $tax ( keys %totlisthash ) {
2260 my $tax_object = shift @{ $totlisthash{$tax} };
2261 warn "found previously found taxed tax ". $tax_object->taxname. "\n"
2263 my $listref_or_error = $tax_object->taxline( @{ $totlisthash{$tax} } );
2264 unless (ref($listref_or_error)) {
2265 $dbh->rollback if $oldAutoCommit;
2266 return $listref_or_error;
2269 warn "adding taxed tax amount ". $listref_or_error->[1].
2270 " as ". $tax_object->taxname. "\n"
2272 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2275 #consolidate and create tax line items
2276 warn "consolidating and generating...\n" if $DEBUG > 2;
2277 foreach my $taxname ( keys %taxname ) {
2280 warn "adding $taxname\n" if $DEBUG > 1;
2281 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2282 $tax += $tax{$taxitem} unless $seen{$taxitem};
2283 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2287 $tax = sprintf('%.2f', $tax );
2288 $total_setup = sprintf('%.2f', $total_setup+$tax );
2290 push @cust_bill_pkg, new FS::cust_bill_pkg {
2296 'itemdesc' => $taxname,
2301 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2303 #create the new invoice
2304 my $cust_bill = new FS::cust_bill ( {
2305 'custnum' => $self->custnum,
2306 '_date' => ( $options{'invoice_time'} || $time ),
2307 'charged' => $charged,
2309 my $error = $cust_bill->insert;
2311 $dbh->rollback if $oldAutoCommit;
2312 return "can't create invoice for customer #". $self->custnum. ": $error";
2315 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2316 $cust_bill_pkg->invnum($cust_bill->invnum);
2317 my $error = $cust_bill_pkg->insert;
2319 $dbh->rollback if $oldAutoCommit;
2320 return "can't create invoice line item: $error";
2325 foreach my $hook ( @precommit_hooks ) {
2327 &{$hook}; #($self) ?
2330 $dbh->rollback if $oldAutoCommit;
2331 return "$@ running precommit hook $hook\n";
2335 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2341 my ($self, %params) = @_;
2343 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2344 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2345 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2346 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2347 my $total_setup = $params{setup} or die "no setup accumulator specified";
2348 my $total_recur = $params{recur} or die "no recur accumulator specified";
2349 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2350 my $time = $params{'time'} or die "no time specified";
2351 my (%options) = %{$params{options}}; #hmmm only for 'resetup'
2354 my $real_pkgpart = $cust_pkg->pkgpart;
2355 my %hash = $cust_pkg->hash;
2356 my $old_cust_pkg = new FS::cust_pkg \%hash;
2362 $cust_pkg->pkgpart($part_pkg->pkgpart);
2370 if ( ! $cust_pkg->setup &&
2372 ( $conf->exists('disable_setup_suspended_pkgs') &&
2373 ! $cust_pkg->getfield('susp')
2374 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2376 || $options{'resetup'}
2379 warn " bill setup\n" if $DEBUG > 1;
2382 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2383 return "$@ running calc_setup for $cust_pkg\n"
2386 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2388 $cust_pkg->setfield('setup', $time)
2389 unless $cust_pkg->setup;
2390 #do need it, but it won't get written to the db
2391 #|| $cust_pkg->pkgpart != $real_pkgpart;
2396 # bill recurring fee
2399 #XXX unit stuff here too
2403 if ( ! $cust_pkg->getfield('susp') and
2404 ( $part_pkg->getfield('freq') ne '0' &&
2405 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2407 || ( $part_pkg->plan eq 'voip_cdr'
2408 && $part_pkg->option('bill_every_call')
2412 # XXX should this be a package event? probably. events are called
2413 # at collection time at the moment, though...
2414 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2415 if $part_pkg->can('reset_usage');
2416 #don't want to reset usage just cause we want a line item??
2417 #&& $part_pkg->pkgpart == $real_pkgpart;
2419 warn " bill recur\n" if $DEBUG > 1;
2422 # XXX shared with $recur_prog
2423 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2425 #over two params! lets at least switch to a hashref for the rest...
2426 my $increment_next_bill = ( $part_pkg->freq ne '0'
2427 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2429 my %param = ( 'precommit_hooks' => $precommit_hooks,
2430 'increment_next_bill' => $increment_next_bill,
2433 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2434 return "$@ running calc_recur for $cust_pkg\n"
2437 if ( $increment_next_bill ) {
2439 #change this bit to use Date::Manip? CAREFUL with timezones (see
2440 # mailing list archive)
2441 my ($sec,$min,$hour,$mday,$mon,$year) =
2442 (localtime($sdate) )[0,1,2,3,4,5];
2444 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2445 # only for figuring next bill date, nothing else, so, reset $sdate again
2447 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2448 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2449 $cust_pkg->last_bill($sdate);
2451 if ( $part_pkg->freq =~ /^\d+$/ ) {
2452 $mon += $part_pkg->freq;
2453 until ( $mon < 12 ) { $mon -= 12; $year++; }
2454 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2456 $mday += $weeks * 7;
2457 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2460 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2464 return "unparsable frequency: ". $part_pkg->freq;
2466 $cust_pkg->setfield('bill',
2467 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2473 warn "\$setup is undefined" unless defined($setup);
2474 warn "\$recur is undefined" unless defined($recur);
2475 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2478 # If there's line items, create em cust_bill_pkg records
2479 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2484 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2485 # hmm.. and if just the options are modified in some weird price plan?
2487 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2490 my $error = $cust_pkg->replace( $old_cust_pkg,
2491 'options' => { $cust_pkg->options },
2493 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2494 if $error; #just in case
2497 $setup = sprintf( "%.2f", $setup );
2498 $recur = sprintf( "%.2f", $recur );
2499 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2500 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2502 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2503 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2506 if ( $setup != 0 || $recur != 0 ) {
2508 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2511 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2513 warn " adding customer package invoice detail: $_\n"
2514 foreach @cust_pkg_detail;
2516 push @details, @cust_pkg_detail;
2518 my $cust_bill_pkg = new FS::cust_bill_pkg {
2519 'pkgnum' => $cust_pkg->pkgnum,
2521 'unitsetup' => $unitsetup,
2523 'unitrecur' => $unitrecur,
2524 'quantity' => $cust_pkg->quantity,
2525 'details' => \@details,
2528 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2529 $cust_bill_pkg->sdate( $hash{last_bill} );
2530 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2531 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2532 $cust_bill_pkg->sdate( $sdate );
2533 $cust_bill_pkg->edate( $cust_pkg->bill );
2536 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2537 unless $part_pkg->pkgpart == $real_pkgpart;
2539 $$total_setup += $setup;
2540 $$total_recur += $recur;
2547 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg);
2548 return $error if $error;
2550 push @$cust_bill_pkgs, $cust_bill_pkg;
2552 } #if $setup != 0 || $recur != 0
2562 my $part_pkg = shift;
2563 my $taxlisthash = shift;
2564 my $cust_bill_pkg = shift;
2565 my $cust_pkg = shift;
2567 my %cust_bill_pkg = ();
2571 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2576 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
2577 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
2578 push @classes, 'setup' if $cust_bill_pkg->setup;
2579 push @classes, 'recur' if $cust_bill_pkg->recur;
2581 if ( $conf->exists('enable_taxproducts')
2582 && (scalar($part_pkg->part_pkg_taxoverride) || $part_pkg->has_taxproduct)
2583 && ( $self->tax !~ /Y/i && $self->payby ne 'COMP' )
2587 foreach my $class (@classes) {
2588 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $prefix );
2589 return $err_or_ref unless ref($err_or_ref);
2590 $taxes{$class} = $err_or_ref;
2593 unless (exists $taxes{''}) {
2594 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $prefix );
2595 return $err_or_ref unless ref($err_or_ref);
2596 $taxes{''} = $err_or_ref;
2599 } elsif ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
2601 my %taxhash = map { $_ => $self->get("$prefix$_") }
2602 qw( state county country );
2604 $taxhash{'taxclass'} = $part_pkg->taxclass;
2606 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2609 $taxhash{'taxclass'} = '';
2610 @taxes = qsearch( 'cust_main_county', \%taxhash );
2613 #one more try at a whole-country tax rate
2615 $taxhash{$_} = '' foreach qw( state county );
2616 @taxes = qsearch( 'cust_main_county', \%taxhash );
2619 $taxes{''} = [ @taxes ];
2620 $taxes{'setup'} = [ @taxes ];
2621 $taxes{'recur'} = [ @taxes ];
2622 $taxes{$_} = [ @taxes ] foreach (@classes);
2624 # maybe eliminate this entirely, along with all the 0% records
2627 "fatal: can't find tax rate for state/county/country/taxclass ".
2628 join('/', ( map $self->get("$prefix$_"),
2629 qw(state county country)
2631 $part_pkg->taxclass ). "\n";
2634 } #if $conf->exists('enable_taxproducts') ...
2637 if ( $conf->exists('separate_usage') ) {
2638 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
2639 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
2640 push @display, new FS::cust_bill_pkg_display { type => 'S' };
2641 push @display, new FS::cust_bill_pkg_display { type => 'R' };
2642 push @display, new FS::cust_bill_pkg_display { type => 'U',
2645 if ($section && $summary) {
2646 $display[2]->post_total('Y');
2647 push @display, new FS::cust_bill_pkg_display { type => 'U',
2652 $cust_bill_pkg->set('display', \@display);
2654 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
2655 foreach my $key (keys %tax_cust_bill_pkg) {
2656 my @taxes = @{ $taxes{$key} || [] };
2657 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
2659 foreach my $tax ( @taxes ) {
2660 my $taxname = ref( $tax ). ' '. $tax->taxnum;
2661 if ( exists( $taxlisthash->{ $taxname } ) ) {
2662 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
2664 $taxlisthash->{ $taxname } = [ $tax, $tax_cust_bill_pkg ];
2674 my $part_pkg = shift;
2679 my $geocode = $self->geocode('cch');
2681 my @taxclassnums = map { $_->taxclassnum }
2682 $part_pkg->part_pkg_taxoverride($class);
2684 unless (@taxclassnums) {
2685 @taxclassnums = map { $_->taxclassnum }
2686 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
2688 warn "Found taxclassnum values of ". join(',', @taxclassnums)
2693 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2695 @taxes = qsearch({ 'table' => 'tax_rate',
2696 'hashref' => { 'geocode' => $geocode, },
2697 'extra_sql' => $extra_sql,
2699 if scalar(@taxclassnums);
2701 # maybe eliminate this entirely, along with all the 0% records
2704 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2705 join('/', ( map $self->get("$prefix$_"),
2708 $part_pkg->taxproduct_description,
2709 $part_pkg->pkgpart ). "\n";
2712 warn "Found taxes ".
2713 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
2720 =item collect OPTIONS
2722 (Attempt to) collect money for this customer's outstanding invoices (see
2723 L<FS::cust_bill>). Usually used after the bill method.
2725 Actions are now triggered by billing events; see L<FS::part_event> and the
2726 billing events web interface. Old-style invoice events (see
2727 L<FS::part_bill_event>) have been deprecated.
2729 If there is an error, returns the error, otherwise returns false.
2731 Options are passed as name-value pairs.
2733 Currently available options are:
2739 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.
2743 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2747 set true to surpress email card/ACH decline notices.
2751 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2755 allows for one time override of normal customer billing method
2759 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)
2767 my( $self, %options ) = @_;
2768 my $invoice_time = $options{'invoice_time'} || time;
2771 local $SIG{HUP} = 'IGNORE';
2772 local $SIG{INT} = 'IGNORE';
2773 local $SIG{QUIT} = 'IGNORE';
2774 local $SIG{TERM} = 'IGNORE';
2775 local $SIG{TSTP} = 'IGNORE';
2776 local $SIG{PIPE} = 'IGNORE';
2778 my $oldAutoCommit = $FS::UID::AutoCommit;
2779 local $FS::UID::AutoCommit = 0;
2782 $self->select_for_update; #mutex
2785 my $balance = $self->balance;
2786 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2789 if ( exists($options{'retry_card'}) ) {
2790 carp 'retry_card option passed to collect is deprecated; use retry';
2791 $options{'retry'} ||= $options{'retry_card'};
2793 if ( exists($options{'retry'}) && $options{'retry'} ) {
2794 my $error = $self->retry_realtime;
2796 $dbh->rollback if $oldAutoCommit;
2801 # false laziness w/pay_batch::import_results
2803 my $due_cust_event = $self->due_cust_event(
2804 'debug' => ( $options{'debug'} || 0 ),
2805 'time' => $invoice_time,
2806 'check_freq' => $options{'check_freq'},
2808 unless( ref($due_cust_event) ) {
2809 $dbh->rollback if $oldAutoCommit;
2810 return $due_cust_event;
2813 foreach my $cust_event ( @$due_cust_event ) {
2817 #re-eval event conditions (a previous event could have changed things)
2818 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2819 #don't leave stray "new/locked" records around
2820 my $error = $cust_event->delete;
2822 #gah, even with transactions
2823 $dbh->commit if $oldAutoCommit; #well.
2830 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2831 warn " running cust_event ". $cust_event->eventnum. "\n"
2835 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2836 if ( my $error = $cust_event->do_event() ) {
2837 #XXX wtf is this? figure out a proper dealio with return value
2839 # gah, even with transactions.
2840 $dbh->commit if $oldAutoCommit; #well.
2847 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2852 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2854 Inserts database records for and returns an ordered listref of new events due
2855 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2856 events are due, an empty listref is returned. If there is an error, returns a
2857 scalar error message.
2859 To actually run the events, call each event's test_condition method, and if
2860 still true, call the event's do_event method.
2862 Options are passed as a hashref or as a list of name-value pairs. Available
2869 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.
2873 "Current time" for the events.
2877 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)
2881 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2885 Explicitly pass the objects to be tested (typically used with eventtable).
2891 sub due_cust_event {
2893 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2896 #my $DEBUG = $opt{'debug'}
2897 local($DEBUG) = $opt{'debug'}
2898 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2900 warn "$me due_cust_event called with options ".
2901 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2904 $opt{'time'} ||= time;
2906 local $SIG{HUP} = 'IGNORE';
2907 local $SIG{INT} = 'IGNORE';
2908 local $SIG{QUIT} = 'IGNORE';
2909 local $SIG{TERM} = 'IGNORE';
2910 local $SIG{TSTP} = 'IGNORE';
2911 local $SIG{PIPE} = 'IGNORE';
2913 my $oldAutoCommit = $FS::UID::AutoCommit;
2914 local $FS::UID::AutoCommit = 0;
2917 $self->select_for_update; #mutex
2920 # 1: find possible events (initial search)
2923 my @cust_event = ();
2925 my @eventtable = $opt{'eventtable'}
2926 ? ( $opt{'eventtable'} )
2927 : FS::part_event->eventtables_runorder;
2929 foreach my $eventtable ( @eventtable ) {
2932 if ( $opt{'objects'} ) {
2934 @objects = @{ $opt{'objects'} };
2938 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2939 @objects = ( $eventtable eq 'cust_main' )
2941 : ( $self->$eventtable() );
2945 my @e_cust_event = ();
2947 my $cross = "CROSS JOIN $eventtable";
2948 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2949 unless $eventtable eq 'cust_main';
2951 foreach my $object ( @objects ) {
2953 #this first search uses the condition_sql magic for optimization.
2954 #the more possible events we can eliminate in this step the better
2956 my $cross_where = '';
2957 my $pkey = $object->primary_key;
2958 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2960 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2962 FS::part_event_condition->where_conditions_sql( $eventtable,
2963 'time'=>$opt{'time'}
2965 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2967 $extra_sql = "AND $extra_sql" if $extra_sql;
2969 #here is the agent virtualization
2970 $extra_sql .= " AND ( part_event.agentnum IS NULL
2971 OR part_event.agentnum = ". $self->agentnum. ' )';
2973 $extra_sql .= " $order";
2975 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2976 if $opt{'debug'} > 2;
2977 my @part_event = qsearch( {
2978 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2979 'select' => 'part_event.*',
2980 'table' => 'part_event',
2981 'addl_from' => "$cross $join",
2982 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2983 'eventtable' => $eventtable,
2986 'extra_sql' => "AND $cross_where $extra_sql",
2990 my $pkey = $object->primary_key;
2991 warn " ". scalar(@part_event).
2992 " possible events found for $eventtable ". $object->$pkey(). "\n";
2995 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2999 warn " ". scalar(@e_cust_event).
3000 " subtotal possible cust events found for $eventtable\n"
3003 push @cust_event, @e_cust_event;
3007 warn " ". scalar(@cust_event).
3008 " total possible cust events found in initial search\n"
3012 # 2: test conditions
3017 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3018 'stats_hashref' => \%unsat ),
3021 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3024 warn " invalid conditions not eliminated with condition_sql:\n".
3025 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3032 unless( $opt{testonly} ) {
3033 foreach my $cust_event ( @cust_event ) {
3035 my $error = $cust_event->insert();
3037 $dbh->rollback if $oldAutoCommit;
3044 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3050 warn " returning events: ". Dumper(@cust_event). "\n"
3057 =item retry_realtime
3059 Schedules realtime / batch credit card / electronic check / LEC billing
3060 events for for retry. Useful if card information has changed or manual
3061 retry is desired. The 'collect' method must be called to actually retry
3064 Implementation details: For either this customer, or for each of this
3065 customer's open invoices, changes the status of the first "done" (with
3066 statustext error) realtime processing event to "failed".
3070 sub retry_realtime {
3073 local $SIG{HUP} = 'IGNORE';
3074 local $SIG{INT} = 'IGNORE';
3075 local $SIG{QUIT} = 'IGNORE';
3076 local $SIG{TERM} = 'IGNORE';
3077 local $SIG{TSTP} = 'IGNORE';
3078 local $SIG{PIPE} = 'IGNORE';
3080 my $oldAutoCommit = $FS::UID::AutoCommit;
3081 local $FS::UID::AutoCommit = 0;
3084 #a little false laziness w/due_cust_event (not too bad, really)
3086 my $join = FS::part_event_condition->join_conditions_sql;
3087 my $order = FS::part_event_condition->order_conditions_sql;
3090 . join ( ' OR ' , map {
3091 "( part_event.eventtable = " . dbh->quote($_)
3092 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3093 } FS::part_event->eventtables)
3096 #here is the agent virtualization
3097 my $agent_virt = " ( part_event.agentnum IS NULL
3098 OR part_event.agentnum = ". $self->agentnum. ' )';
3100 #XXX this shouldn't be hardcoded, actions should declare it...
3101 my @realtime_events = qw(
3102 cust_bill_realtime_card
3103 cust_bill_realtime_check
3104 cust_bill_realtime_lec
3108 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3113 my @cust_event = qsearchs({
3114 'table' => 'cust_event',
3115 'select' => 'cust_event.*',
3116 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3117 'hashref' => { 'status' => 'done' },
3118 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3119 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3122 my %seen_invnum = ();
3123 foreach my $cust_event (@cust_event) {
3125 #max one for the customer, one for each open invoice
3126 my $cust_X = $cust_event->cust_X;
3127 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3131 or $cust_event->part_event->eventtable eq 'cust_bill'
3134 my $error = $cust_event->retry;
3136 $dbh->rollback if $oldAutoCommit;
3137 return "error scheduling event for retry: $error";
3142 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3147 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3149 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3150 via a Business::OnlinePayment realtime gateway. See
3151 L<http://420.am/business-onlinepayment> for supported gateways.
3153 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3155 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3157 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3158 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3159 if set, will override the value from the customer record.
3161 I<description> is a free-text field passed to the gateway. It defaults to
3162 "Internet services".
3164 If an I<invnum> is specified, this payment (if successful) is applied to the
3165 specified invoice. If you don't specify an I<invnum> you might want to
3166 call the B<apply_payments> method.
3168 I<quiet> can be set true to surpress email decline notices.
3170 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3171 resulting paynum, if any.
3173 I<payunique> is a unique identifier for this payment.
3175 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3180 my( $self, $method, $amount, %options ) = @_;
3182 warn "$me realtime_bop: $method $amount\n";
3183 warn " $_ => $options{$_}\n" foreach keys %options;
3186 $options{'description'} ||= 'Internet services';
3188 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3190 eval "use Business::OnlinePayment";
3193 my $payinfo = exists($options{'payinfo'})
3194 ? $options{'payinfo'}
3197 my %method2payby = (
3204 # check for banned credit card/ACH
3207 my $ban = qsearchs('banned_pay', {
3208 'payby' => $method2payby{$method},
3209 'payinfo' => md5_base64($payinfo),
3211 return "Banned credit card" if $ban;
3218 if ( $options{'invnum'} ) {
3219 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3220 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3222 map { $_->part_pkg->taxclass }
3224 map { $_->cust_pkg }
3225 $cust_bill->cust_bill_pkg;
3226 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
3227 #different taxclasses
3228 $taxclass = $taxclasses[0];
3232 #look for an agent gateway override first
3234 if ( $method eq 'CC' ) {
3235 $cardtype = cardtype($payinfo);
3236 } elsif ( $method eq 'ECHECK' ) {
3239 $cardtype = $method;
3243 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3244 cardtype => $cardtype,
3245 taxclass => $taxclass, } )
3246 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3248 taxclass => $taxclass, } )
3249 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3250 cardtype => $cardtype,
3252 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3254 taxclass => '', } );
3256 my $payment_gateway = '';
3257 my( $processor, $login, $password, $action, @bop_options );
3258 if ( $override ) { #use a payment gateway override
3260 $payment_gateway = $override->payment_gateway;
3262 $processor = $payment_gateway->gateway_module;
3263 $login = $payment_gateway->gateway_username;
3264 $password = $payment_gateway->gateway_password;
3265 $action = $payment_gateway->gateway_action;
3266 @bop_options = $payment_gateway->options;
3268 } else { #use the standard settings from the config
3270 ( $processor, $login, $password, $action, @bop_options ) =
3271 $self->default_payment_gateway($method);
3279 my $address = exists($options{'address1'})
3280 ? $options{'address1'}
3282 my $address2 = exists($options{'address2'})
3283 ? $options{'address2'}
3285 $address .= ", ". $address2 if length($address2);
3287 my $o_payname = exists($options{'payname'})
3288 ? $options{'payname'}
3290 my($payname, $payfirst, $paylast);
3291 if ( $o_payname && $method ne 'ECHECK' ) {
3292 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3293 or return "Illegal payname $payname";
3294 ($payfirst, $paylast) = ($1, $2);
3296 $payfirst = $self->getfield('first');
3297 $paylast = $self->getfield('last');
3298 $payname = "$payfirst $paylast";
3301 my @invoicing_list = $self->invoicing_list_emailonly;
3302 if ( $conf->exists('emailinvoiceautoalways')
3303 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3304 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3305 push @invoicing_list, $self->all_emails;
3308 my $email = ($conf->exists('business-onlinepayment-email-override'))
3309 ? $conf->config('business-onlinepayment-email-override')
3310 : $invoicing_list[0];
3314 my $payip = exists($options{'payip'})
3317 $content{customer_ip} = $payip
3320 $content{invoice_number} = $options{'invnum'}
3321 if exists($options{'invnum'}) && length($options{'invnum'});
3323 $content{email_customer} =
3324 ( $conf->exists('business-onlinepayment-email_customer')
3325 || $conf->exists('business-onlinepayment-email-override') );
3328 if ( $method eq 'CC' ) {
3330 $content{card_number} = $payinfo;
3331 $paydate = exists($options{'paydate'})
3332 ? $options{'paydate'}
3334 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3335 $content{expiration} = "$2/$1";
3337 my $paycvv = exists($options{'paycvv'})
3338 ? $options{'paycvv'}
3340 $content{cvv2} = $paycvv
3343 my $paystart_month = exists($options{'paystart_month'})
3344 ? $options{'paystart_month'}
3345 : $self->paystart_month;
3347 my $paystart_year = exists($options{'paystart_year'})
3348 ? $options{'paystart_year'}
3349 : $self->paystart_year;
3351 $content{card_start} = "$paystart_month/$paystart_year"
3352 if $paystart_month && $paystart_year;
3354 my $payissue = exists($options{'payissue'})
3355 ? $options{'payissue'}
3357 $content{issue_number} = $payissue if $payissue;
3359 $content{recurring_billing} = 'YES'
3360 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3362 'payinfo' => $payinfo,
3364 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3366 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3370 } elsif ( $method eq 'ECHECK' ) {
3371 ( $content{account_number}, $content{routing_code} ) =
3372 split('@', $payinfo);
3373 $content{bank_name} = $o_payname;
3374 $content{bank_state} = exists($options{'paystate'})
3375 ? $options{'paystate'}
3376 : $self->getfield('paystate');
3377 $content{account_type} = exists($options{'paytype'})
3378 ? uc($options{'paytype'}) || 'CHECKING'
3379 : uc($self->getfield('paytype')) || 'CHECKING';
3380 $content{account_name} = $payname;
3381 $content{customer_org} = $self->company ? 'B' : 'I';
3382 $content{state_id} = exists($options{'stateid'})
3383 ? $options{'stateid'}
3384 : $self->getfield('stateid');
3385 $content{state_id_state} = exists($options{'stateid_state'})
3386 ? $options{'stateid_state'}
3387 : $self->getfield('stateid_state');
3388 $content{customer_ssn} = exists($options{'ss'})
3391 } elsif ( $method eq 'LEC' ) {
3392 $content{phone} = $payinfo;
3396 # run transaction(s)
3399 my $balance = exists( $options{'balance'} )
3400 ? $options{'balance'}
3403 $self->select_for_update; #mutex ... just until we get our pending record in
3405 #the checks here are intended to catch concurrent payments
3406 #double-form-submission prevention is taken care of in cust_pay_pending::check
3409 return "The customer's balance has changed; $method transaction aborted."
3410 if $self->balance < $balance;
3411 #&& $self->balance < $amount; #might as well anyway?
3413 #also check and make sure there aren't *other* pending payments for this cust
3415 my @pending = qsearch('cust_pay_pending', {
3416 'custnum' => $self->custnum,
3417 'status' => { op=>'!=', value=>'done' }
3419 return "A payment is already being processed for this customer (".
3420 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3421 "); $method transaction aborted."
3422 if scalar(@pending);
3424 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3426 my $cust_pay_pending = new FS::cust_pay_pending {
3427 'custnum' => $self->custnum,
3428 #'invnum' => $options{'invnum'},
3431 'payby' => $method2payby{$method},
3432 'payinfo' => $payinfo,
3433 'paydate' => $paydate,
3435 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3437 $cust_pay_pending->payunique( $options{payunique} )
3438 if defined($options{payunique}) && length($options{payunique});
3439 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3440 return $cpp_new_err if $cpp_new_err;
3442 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3444 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3445 $transaction->content(
3448 'password' => $password,
3449 'action' => $action1,
3450 'description' => $options{'description'},
3451 'amount' => $amount,
3452 #'invoice_number' => $options{'invnum'},
3453 'customer_id' => $self->custnum,
3454 'last_name' => $paylast,
3455 'first_name' => $payfirst,
3457 'address' => $address,
3458 'city' => ( exists($options{'city'})
3461 'state' => ( exists($options{'state'})
3464 'zip' => ( exists($options{'zip'})
3467 'country' => ( exists($options{'country'})
3468 ? $options{'country'}
3470 'referer' => 'http://cleanwhisker.420.am/',
3472 'phone' => $self->daytime || $self->night,
3476 $cust_pay_pending->status('pending');
3477 my $cpp_pending_err = $cust_pay_pending->replace;
3478 return $cpp_pending_err if $cpp_pending_err;
3481 my $BOP_TESTING = 0;
3482 my $BOP_TESTING_SUCCESS = 1;
3484 unless ( $BOP_TESTING ) {
3485 $transaction->submit();
3487 if ( $BOP_TESTING_SUCCESS ) {
3488 $transaction->is_success(1);
3489 $transaction->authorization('fake auth');
3491 $transaction->is_success(0);
3492 $transaction->error_message('fake failure');
3496 if ( $transaction->is_success() && $action2 ) {
3498 $cust_pay_pending->status('authorized');
3499 my $cpp_authorized_err = $cust_pay_pending->replace;
3500 return $cpp_authorized_err if $cpp_authorized_err;
3502 my $auth = $transaction->authorization;
3503 my $ordernum = $transaction->can('order_number')
3504 ? $transaction->order_number
3508 new Business::OnlinePayment( $processor, @bop_options );
3515 password => $password,
3516 order_number => $ordernum,
3518 authorization => $auth,
3519 description => $options{'description'},
3522 foreach my $field (qw( authorization_source_code returned_ACI
3523 transaction_identifier validation_code
3524 transaction_sequence_num local_transaction_date
3525 local_transaction_time AVS_result_code )) {
3526 $capture{$field} = $transaction->$field() if $transaction->can($field);
3529 $capture->content( %capture );
3533 unless ( $capture->is_success ) {
3534 my $e = "Authorization successful but capture failed, custnum #".
3535 $self->custnum. ': '. $capture->result_code.
3536 ": ". $capture->error_message;
3543 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3544 my $cpp_captured_err = $cust_pay_pending->replace;
3545 return $cpp_captured_err if $cpp_captured_err;
3548 # remove paycvv after initial transaction
3551 #false laziness w/misc/process/payment.cgi - check both to make sure working
3553 if ( defined $self->dbdef_table->column('paycvv')
3554 && length($self->paycvv)
3555 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3557 my $error = $self->remove_cvv;
3559 warn "WARNING: error removing cvv: $error\n";
3567 if ( $transaction->is_success() ) {
3570 if ( $payment_gateway ) { # agent override
3571 $paybatch = $payment_gateway->gatewaynum. '-';
3574 $paybatch .= "$processor:". $transaction->authorization;
3576 $paybatch .= ':'. $transaction->order_number
3577 if $transaction->can('order_number')
3578 && length($transaction->order_number);
3580 my $cust_pay = new FS::cust_pay ( {
3581 'custnum' => $self->custnum,
3582 'invnum' => $options{'invnum'},
3585 'payby' => $method2payby{$method},
3586 'payinfo' => $payinfo,
3587 'paybatch' => $paybatch,
3588 'paydate' => $paydate,
3590 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3591 $cust_pay->payunique( $options{payunique} )
3592 if defined($options{payunique}) && length($options{payunique});
3594 my $oldAutoCommit = $FS::UID::AutoCommit;
3595 local $FS::UID::AutoCommit = 0;
3598 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3600 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3603 $cust_pay->invnum(''); #try again with no specific invnum
3604 my $error2 = $cust_pay->insert( $options{'manual'} ?
3605 ( 'manual' => 1 ) : ()
3608 # gah. but at least we have a record of the state we had to abort in
3609 # from cust_pay_pending now.
3610 my $e = "WARNING: $method captured but payment not recorded - ".
3611 "error inserting payment ($processor): $error2".
3612 " (previously tried insert with invnum #$options{'invnum'}" .
3613 ": $error ) - pending payment saved as paypendingnum ".
3614 $cust_pay_pending->paypendingnum. "\n";
3620 if ( $options{'paynum_ref'} ) {
3621 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3624 $cust_pay_pending->status('done');
3625 $cust_pay_pending->statustext('captured');
3626 my $cpp_done_err = $cust_pay_pending->replace;
3628 if ( $cpp_done_err ) {
3630 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3631 my $e = "WARNING: $method captured but payment not recorded - ".
3632 "error updating status for paypendingnum ".
3633 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3639 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3640 return ''; #no error
3646 my $perror = "$processor error: ". $transaction->error_message;
3648 unless ( $transaction->error_message ) {
3651 if ( $transaction->can('response_page') ) {
3653 'page' => ( $transaction->can('response_page')
3654 ? $transaction->response_page
3657 'code' => ( $transaction->can('response_code')
3658 ? $transaction->response_code
3661 'headers' => ( $transaction->can('response_headers')
3662 ? $transaction->response_headers
3668 "No additional debugging information available for $processor";
3671 $perror .= "No error_message returned from $processor -- ".
3672 ( ref($t_response) ? Dumper($t_response) : $t_response );
3676 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3677 && $conf->exists('emaildecline')
3678 && grep { $_ ne 'POST' } $self->invoicing_list
3679 && ! grep { $transaction->error_message =~ /$_/ }
3680 $conf->config('emaildecline-exclude')
3682 my @templ = $conf->config('declinetemplate');
3683 my $template = new Text::Template (
3685 SOURCE => [ map "$_\n", @templ ],
3686 ) or return "($perror) can't create template: $Text::Template::ERROR";
3687 $template->compile()
3688 or return "($perror) can't compile template: $Text::Template::ERROR";
3690 my $templ_hash = { error => $transaction->error_message };
3692 my $error = send_email(
3693 'from' => $conf->config('invoice_from'),
3694 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3695 'subject' => 'Your payment could not be processed',
3696 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3699 $perror .= " (also received error sending decline notification: $error)"
3704 $cust_pay_pending->status('done');
3705 $cust_pay_pending->statustext("declined: $perror");
3706 my $cpp_done_err = $cust_pay_pending->replace;
3707 if ( $cpp_done_err ) {
3708 my $e = "WARNING: $method declined but pending payment not resolved - ".
3709 "error updating status for paypendingnum ".
3710 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3712 $perror = "$e ($perror)";
3725 my( $self, $method, $amount, %options ) = @_;
3727 if ( $options{'fake_failure'} ) {
3728 return "Error: No error; test failure requested with fake_failure";
3731 my %method2payby = (
3738 #if ( $payment_gateway ) { # agent override
3739 # $paybatch = $payment_gateway->gatewaynum. '-';
3742 #$paybatch .= "$processor:". $transaction->authorization;
3744 #$paybatch .= ':'. $transaction->order_number
3745 # if $transaction->can('order_number')
3746 # && length($transaction->order_number);
3748 my $paybatch = 'FakeProcessor:54:32';
3750 my $cust_pay = new FS::cust_pay ( {
3751 'custnum' => $self->custnum,
3752 'invnum' => $options{'invnum'},
3755 'payby' => $method2payby{$method},
3756 #'payinfo' => $payinfo,
3757 'payinfo' => '4111111111111111',
3758 'paybatch' => $paybatch,
3759 #'paydate' => $paydate,
3760 'paydate' => '2012-05-01',
3762 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3764 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3767 $cust_pay->invnum(''); #try again with no specific invnum
3768 my $error2 = $cust_pay->insert( $options{'manual'} ?
3769 ( 'manual' => 1 ) : ()
3772 # gah, even with transactions.
3773 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3774 "error inserting (fake!) payment: $error2".
3775 " (previously tried insert with invnum #$options{'invnum'}" .
3782 if ( $options{'paynum_ref'} ) {
3783 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3786 return ''; #no error
3790 =item default_payment_gateway
3794 sub default_payment_gateway {
3795 my( $self, $method ) = @_;
3797 die "Real-time processing not enabled\n"
3798 unless $conf->exists('business-onlinepayment');
3801 my $bop_config = 'business-onlinepayment';
3802 $bop_config .= '-ach'
3803 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3804 my ( $processor, $login, $password, $action, @bop_options ) =
3805 $conf->config($bop_config);
3806 $action ||= 'normal authorization';
3807 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3808 die "No real-time processor is enabled - ".
3809 "did you set the business-onlinepayment configuration value?\n"
3812 ( $processor, $login, $password, $action, @bop_options )
3817 Removes the I<paycvv> field from the database directly.
3819 If there is an error, returns the error, otherwise returns false.
3825 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3826 or return dbh->errstr;
3827 $sth->execute($self->custnum)
3828 or return $sth->errstr;
3833 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3835 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3836 via a Business::OnlinePayment realtime gateway. See
3837 L<http://420.am/business-onlinepayment> for supported gateways.
3839 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3841 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3843 Most gateways require a reference to an original payment transaction to refund,
3844 so you probably need to specify a I<paynum>.
3846 I<amount> defaults to the original amount of the payment if not specified.
3848 I<reason> specifies a reason for the refund.
3850 I<paydate> specifies the expiration date for a credit card overriding the
3851 value from the customer record or the payment record. Specified as yyyy-mm-dd
3853 Implementation note: If I<amount> is unspecified or equal to the amount of the
3854 orignal payment, first an attempt is made to "void" the transaction via
3855 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3856 the normal attempt is made to "refund" ("credit") the transaction via the
3857 gateway is attempted.
3859 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3860 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3861 #if set, will override the value from the customer record.
3863 #If an I<invnum> is specified, this payment (if successful) is applied to the
3864 #specified invoice. If you don't specify an I<invnum> you might want to
3865 #call the B<apply_payments> method.
3869 #some false laziness w/realtime_bop, not enough to make it worth merging
3870 #but some useful small subs should be pulled out
3871 sub realtime_refund_bop {
3872 my( $self, $method, %options ) = @_;
3874 warn "$me realtime_refund_bop: $method refund\n";
3875 warn " $_ => $options{$_}\n" foreach keys %options;
3878 eval "use Business::OnlinePayment";
3882 # look up the original payment and optionally a gateway for that payment
3886 my $amount = $options{'amount'};
3888 my( $processor, $login, $password, @bop_options ) ;
3889 my( $auth, $order_number ) = ( '', '', '' );
3891 if ( $options{'paynum'} ) {
3893 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3894 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3895 or return "Unknown paynum $options{'paynum'}";
3896 $amount ||= $cust_pay->paid;
3898 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3899 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3900 $cust_pay->paybatch;
3901 my $gatewaynum = '';
3902 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3904 if ( $gatewaynum ) { #gateway for the payment to be refunded
3906 my $payment_gateway =
3907 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3908 die "payment gateway $gatewaynum not found"
3909 unless $payment_gateway;
3911 $processor = $payment_gateway->gateway_module;
3912 $login = $payment_gateway->gateway_username;
3913 $password = $payment_gateway->gateway_password;
3914 @bop_options = $payment_gateway->options;
3916 } else { #try the default gateway
3918 my( $conf_processor, $unused_action );
3919 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3920 $self->default_payment_gateway($method);
3922 return "processor of payment $options{'paynum'} $processor does not".
3923 " match default processor $conf_processor"
3924 unless $processor eq $conf_processor;
3929 } else { # didn't specify a paynum, so look for agent gateway overrides
3930 # like a normal transaction
3933 if ( $method eq 'CC' ) {
3934 $cardtype = cardtype($self->payinfo);
3935 } elsif ( $method eq 'ECHECK' ) {
3938 $cardtype = $method;
3941 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3942 cardtype => $cardtype,
3944 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3946 taxclass => '', } );
3948 if ( $override ) { #use a payment gateway override
3950 my $payment_gateway = $override->payment_gateway;
3952 $processor = $payment_gateway->gateway_module;
3953 $login = $payment_gateway->gateway_username;
3954 $password = $payment_gateway->gateway_password;
3955 #$action = $payment_gateway->gateway_action;
3956 @bop_options = $payment_gateway->options;
3958 } else { #use the standard settings from the config
3961 ( $processor, $login, $password, $unused_action, @bop_options ) =
3962 $self->default_payment_gateway($method);
3967 return "neither amount nor paynum specified" unless $amount;
3972 'password' => $password,
3973 'order_number' => $order_number,
3974 'amount' => $amount,
3975 'referer' => 'http://cleanwhisker.420.am/',
3977 $content{authorization} = $auth
3978 if length($auth); #echeck/ACH transactions have an order # but no auth
3979 #(at least with authorize.net)
3981 my $disable_void_after;
3982 if ($conf->exists('disable_void_after')
3983 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3984 $disable_void_after = $1;
3987 #first try void if applicable
3988 if ( $cust_pay && $cust_pay->paid == $amount
3990 ( not defined($disable_void_after) )
3991 || ( time < ($cust_pay->_date + $disable_void_after ) )
3994 warn " attempting void\n" if $DEBUG > 1;
3995 my $void = new Business::OnlinePayment( $processor, @bop_options );
3996 $void->content( 'action' => 'void', %content );
3998 if ( $void->is_success ) {
3999 my $error = $cust_pay->void($options{'reason'});
4001 # gah, even with transactions.
4002 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4003 "error voiding payment: $error";
4007 warn " void successful\n" if $DEBUG > 1;
4012 warn " void unsuccessful, trying refund\n"
4016 my $address = $self->address1;
4017 $address .= ", ". $self->address2 if $self->address2;
4019 my($payname, $payfirst, $paylast);
4020 if ( $self->payname && $method ne 'ECHECK' ) {
4021 $payname = $self->payname;
4022 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4023 or return "Illegal payname $payname";
4024 ($payfirst, $paylast) = ($1, $2);
4026 $payfirst = $self->getfield('first');
4027 $paylast = $self->getfield('last');
4028 $payname = "$payfirst $paylast";
4031 my @invoicing_list = $self->invoicing_list_emailonly;
4032 if ( $conf->exists('emailinvoiceautoalways')
4033 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4034 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4035 push @invoicing_list, $self->all_emails;
4038 my $email = ($conf->exists('business-onlinepayment-email-override'))
4039 ? $conf->config('business-onlinepayment-email-override')
4040 : $invoicing_list[0];
4042 my $payip = exists($options{'payip'})
4045 $content{customer_ip} = $payip
4049 if ( $method eq 'CC' ) {
4052 $content{card_number} = $payinfo = $cust_pay->payinfo;
4053 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4054 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4055 ($content{expiration} = "$2/$1"); # where available
4057 $content{card_number} = $payinfo = $self->payinfo;
4058 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4059 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4060 $content{expiration} = "$2/$1";
4063 } elsif ( $method eq 'ECHECK' ) {
4066 $payinfo = $cust_pay->payinfo;
4068 $payinfo = $self->payinfo;
4070 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4071 $content{bank_name} = $self->payname;
4072 $content{account_type} = 'CHECKING';
4073 $content{account_name} = $payname;
4074 $content{customer_org} = $self->company ? 'B' : 'I';
4075 $content{customer_ssn} = $self->ss;
4076 } elsif ( $method eq 'LEC' ) {
4077 $content{phone} = $payinfo = $self->payinfo;
4081 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4082 my %sub_content = $refund->content(
4083 'action' => 'credit',
4084 'customer_id' => $self->custnum,
4085 'last_name' => $paylast,
4086 'first_name' => $payfirst,
4088 'address' => $address,
4089 'city' => $self->city,
4090 'state' => $self->state,
4091 'zip' => $self->zip,
4092 'country' => $self->country,
4094 'phone' => $self->daytime || $self->night,
4097 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4101 return "$processor error: ". $refund->error_message
4102 unless $refund->is_success();
4104 my %method2payby = (
4110 my $paybatch = "$processor:". $refund->authorization;
4111 $paybatch .= ':'. $refund->order_number
4112 if $refund->can('order_number') && $refund->order_number;
4114 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4115 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4116 last unless @cust_bill_pay;
4117 my $cust_bill_pay = pop @cust_bill_pay;
4118 my $error = $cust_bill_pay->delete;
4122 my $cust_refund = new FS::cust_refund ( {
4123 'custnum' => $self->custnum,
4124 'paynum' => $options{'paynum'},
4125 'refund' => $amount,
4127 'payby' => $method2payby{$method},
4128 'payinfo' => $payinfo,
4129 'paybatch' => $paybatch,
4130 'reason' => $options{'reason'} || 'card or ACH refund',
4132 my $error = $cust_refund->insert;
4134 $cust_refund->paynum(''); #try again with no specific paynum
4135 my $error2 = $cust_refund->insert;
4137 # gah, even with transactions.
4138 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4139 "error inserting refund ($processor): $error2".
4140 " (previously tried insert with paynum #$options{'paynum'}" .
4151 =item batch_card OPTION => VALUE...
4153 Adds a payment for this invoice to the pending credit card batch (see
4154 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
4155 runs the payment using a realtime gateway.
4160 my ($self, %options) = @_;
4163 if (exists($options{amount})) {
4164 $amount = $options{amount};
4166 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
4168 return '' unless $amount > 0;
4170 my $invnum = delete $options{invnum};
4171 my $payby = $options{invnum} || $self->payby; #dubious
4173 if ($options{'realtime'}) {
4174 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
4180 my $oldAutoCommit = $FS::UID::AutoCommit;
4181 local $FS::UID::AutoCommit = 0;
4184 #this needs to handle mysql as well as Pg, like svc_acct.pm
4185 #(make it into a common function if folks need to do batching with mysql)
4186 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
4187 or return "Cannot lock pay_batch: " . $dbh->errstr;
4191 'payby' => FS::payby->payby2payment($payby),
4194 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
4196 unless ( $pay_batch ) {
4197 $pay_batch = new FS::pay_batch \%pay_batch;
4198 my $error = $pay_batch->insert;
4200 $dbh->rollback if $oldAutoCommit;
4201 die "error creating new batch: $error\n";
4205 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
4206 'batchnum' => $pay_batch->batchnum,
4207 'custnum' => $self->custnum,
4210 foreach (qw( address1 address2 city state zip country payby payinfo paydate
4212 $options{$_} = '' unless exists($options{$_});
4215 my $cust_pay_batch = new FS::cust_pay_batch ( {
4216 'batchnum' => $pay_batch->batchnum,
4217 'invnum' => $invnum || 0, # is there a better value?
4218 # this field should be
4220 # cust_bill_pay_batch now
4221 'custnum' => $self->custnum,
4222 'last' => $self->getfield('last'),
4223 'first' => $self->getfield('first'),
4224 'address1' => $options{address1} || $self->address1,
4225 'address2' => $options{address2} || $self->address2,
4226 'city' => $options{city} || $self->city,
4227 'state' => $options{state} || $self->state,
4228 'zip' => $options{zip} || $self->zip,
4229 'country' => $options{country} || $self->country,
4230 'payby' => $options{payby} || $self->payby,
4231 'payinfo' => $options{payinfo} || $self->payinfo,
4232 'exp' => $options{paydate} || $self->paydate,
4233 'payname' => $options{payname} || $self->payname,
4234 'amount' => $amount, # consolidating
4237 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
4238 if $old_cust_pay_batch;
4241 if ($old_cust_pay_batch) {
4242 $error = $cust_pay_batch->replace($old_cust_pay_batch)
4244 $error = $cust_pay_batch->insert;
4248 $dbh->rollback if $oldAutoCommit;
4252 my $unapplied = $self->total_unapplied_credits
4253 + $self->total_unapplied_payments
4254 + $self->in_transit_payments;
4255 foreach my $cust_bill ($self->open_cust_bill) {
4256 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
4257 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
4258 'invnum' => $cust_bill->invnum,
4259 'paybatchnum' => $cust_pay_batch->paybatchnum,
4260 'amount' => $cust_bill->owed,
4263 if ($unapplied >= $cust_bill_pay_batch->amount){
4264 $unapplied -= $cust_bill_pay_batch->amount;
4267 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
4268 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
4270 $error = $cust_bill_pay_batch->insert;
4272 $dbh->rollback if $oldAutoCommit;
4277 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4281 =item apply_payments_and_credits
4283 Applies unapplied payments and credits.
4285 In most cases, this new method should be used in place of sequential
4286 apply_payments and apply_credits methods.
4288 If there is an error, returns the error, otherwise returns false.
4292 sub apply_payments_and_credits {
4295 local $SIG{HUP} = 'IGNORE';
4296 local $SIG{INT} = 'IGNORE';
4297 local $SIG{QUIT} = 'IGNORE';
4298 local $SIG{TERM} = 'IGNORE';
4299 local $SIG{TSTP} = 'IGNORE';
4300 local $SIG{PIPE} = 'IGNORE';
4302 my $oldAutoCommit = $FS::UID::AutoCommit;
4303 local $FS::UID::AutoCommit = 0;
4306 $self->select_for_update; #mutex
4308 foreach my $cust_bill ( $self->open_cust_bill ) {
4309 my $error = $cust_bill->apply_payments_and_credits;
4311 $dbh->rollback if $oldAutoCommit;
4312 return "Error applying: $error";
4316 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4321 =item apply_credits OPTION => VALUE ...
4323 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4324 to outstanding invoice balances in chronological order (or reverse
4325 chronological order if the I<order> option is set to B<newest>) and returns the
4326 value of any remaining unapplied credits available for refund (see
4327 L<FS::cust_refund>).
4329 Dies if there is an error.
4337 local $SIG{HUP} = 'IGNORE';
4338 local $SIG{INT} = 'IGNORE';
4339 local $SIG{QUIT} = 'IGNORE';
4340 local $SIG{TERM} = 'IGNORE';
4341 local $SIG{TSTP} = 'IGNORE';
4342 local $SIG{PIPE} = 'IGNORE';
4344 my $oldAutoCommit = $FS::UID::AutoCommit;
4345 local $FS::UID::AutoCommit = 0;
4348 $self->select_for_update; #mutex
4350 unless ( $self->total_unapplied_credits ) {
4351 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4355 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4356 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4358 my @invoices = $self->open_cust_bill;
4359 @invoices = sort { $b->_date <=> $a->_date } @invoices
4360 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4363 foreach my $cust_bill ( @invoices ) {
4366 if ( !defined($credit) || $credit->credited == 0) {
4367 $credit = pop @credits or last;
4370 if ($cust_bill->owed >= $credit->credited) {
4371 $amount=$credit->credited;
4373 $amount=$cust_bill->owed;
4376 my $cust_credit_bill = new FS::cust_credit_bill ( {
4377 'crednum' => $credit->crednum,
4378 'invnum' => $cust_bill->invnum,
4379 'amount' => $amount,
4381 my $error = $cust_credit_bill->insert;
4383 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4387 redo if ($cust_bill->owed > 0);
4391 my $total_unapplied_credits = $self->total_unapplied_credits;
4393 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4395 return $total_unapplied_credits;
4398 =item apply_payments
4400 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4401 to outstanding invoice balances in chronological order.
4403 #and returns the value of any remaining unapplied payments.
4405 Dies if there is an error.
4409 sub apply_payments {
4412 local $SIG{HUP} = 'IGNORE';
4413 local $SIG{INT} = 'IGNORE';
4414 local $SIG{QUIT} = 'IGNORE';
4415 local $SIG{TERM} = 'IGNORE';
4416 local $SIG{TSTP} = 'IGNORE';
4417 local $SIG{PIPE} = 'IGNORE';
4419 my $oldAutoCommit = $FS::UID::AutoCommit;
4420 local $FS::UID::AutoCommit = 0;
4423 $self->select_for_update; #mutex
4427 my @payments = sort { $b->_date <=> $a->_date }
4428 grep { $_->unapplied > 0 }
4431 my @invoices = sort { $a->_date <=> $b->_date}
4432 grep { $_->owed > 0 }
4437 foreach my $cust_bill ( @invoices ) {
4440 if ( !defined($payment) || $payment->unapplied == 0 ) {
4441 $payment = pop @payments or last;
4444 if ( $cust_bill->owed >= $payment->unapplied ) {
4445 $amount = $payment->unapplied;
4447 $amount = $cust_bill->owed;
4450 my $cust_bill_pay = new FS::cust_bill_pay ( {
4451 'paynum' => $payment->paynum,
4452 'invnum' => $cust_bill->invnum,
4453 'amount' => $amount,
4455 my $error = $cust_bill_pay->insert;
4457 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4461 redo if ( $cust_bill->owed > 0);
4465 my $total_unapplied_payments = $self->total_unapplied_payments;
4467 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4469 return $total_unapplied_payments;
4474 Returns the total owed for this customer on all invoices
4475 (see L<FS::cust_bill/owed>).
4481 $self->total_owed_date(2145859200); #12/31/2037
4484 =item total_owed_date TIME
4486 Returns the total owed for this customer on all invoices with date earlier than
4487 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
4488 see L<Time::Local> and L<Date::Parse> for conversion functions.
4492 sub total_owed_date {
4496 foreach my $cust_bill (
4497 grep { $_->_date <= $time }
4498 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4500 $total_bill += $cust_bill->owed;
4502 sprintf( "%.2f", $total_bill );
4507 Returns the total amount of all payments.
4514 $total += $_->paid foreach $self->cust_pay;
4515 sprintf( "%.2f", $total );
4518 =item total_unapplied_credits
4520 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4521 customer. See L<FS::cust_credit/credited>.
4523 =item total_credited
4525 Old name for total_unapplied_credits. Don't use.
4529 sub total_credited {
4530 #carp "total_credited deprecated, use total_unapplied_credits";
4531 shift->total_unapplied_credits(@_);
4534 sub total_unapplied_credits {
4536 my $total_credit = 0;
4537 $total_credit += $_->credited foreach $self->cust_credit;
4538 sprintf( "%.2f", $total_credit );
4541 =item total_unapplied_payments
4543 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4544 See L<FS::cust_pay/unapplied>.
4548 sub total_unapplied_payments {
4550 my $total_unapplied = 0;
4551 $total_unapplied += $_->unapplied foreach $self->cust_pay;
4552 sprintf( "%.2f", $total_unapplied );
4555 =item total_unapplied_refunds
4557 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4558 customer. See L<FS::cust_refund/unapplied>.
4562 sub total_unapplied_refunds {
4564 my $total_unapplied = 0;
4565 $total_unapplied += $_->unapplied foreach $self->cust_refund;
4566 sprintf( "%.2f", $total_unapplied );
4571 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4572 total_unapplied_credits minus total_unapplied_payments).
4580 + $self->total_unapplied_refunds
4581 - $self->total_unapplied_credits
4582 - $self->total_unapplied_payments
4586 =item balance_date TIME
4588 Returns the balance for this customer, only considering invoices with date
4589 earlier than TIME (total_owed_date minus total_credited minus
4590 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4591 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4600 $self->total_owed_date($time)
4601 + $self->total_unapplied_refunds
4602 - $self->total_unapplied_credits
4603 - $self->total_unapplied_payments
4607 =item in_transit_payments
4609 Returns the total of requests for payments for this customer pending in
4610 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4614 sub in_transit_payments {
4616 my $in_transit_payments = 0;
4617 foreach my $pay_batch ( qsearch('pay_batch', {
4620 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4621 'batchnum' => $pay_batch->batchnum,
4622 'custnum' => $self->custnum,
4624 $in_transit_payments += $cust_pay_batch->amount;
4627 sprintf( "%.2f", $in_transit_payments );
4630 =item paydate_monthyear
4632 Returns a two-element list consisting of the month and year of this customer's
4633 paydate (credit card expiration date for CARD customers)
4637 sub paydate_monthyear {
4639 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4641 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4648 =item invoicing_list [ ARRAYREF ]
4650 If an arguement is given, sets these email addresses as invoice recipients
4651 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4652 (except as warnings), so use check_invoicing_list first.
4654 Returns a list of email addresses (with svcnum entries expanded).
4656 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4657 check it without disturbing anything by passing nothing.
4659 This interface may change in the future.
4663 sub invoicing_list {
4664 my( $self, $arrayref ) = @_;
4667 my @cust_main_invoice;
4668 if ( $self->custnum ) {
4669 @cust_main_invoice =
4670 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4672 @cust_main_invoice = ();
4674 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4675 #warn $cust_main_invoice->destnum;
4676 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4677 #warn $cust_main_invoice->destnum;
4678 my $error = $cust_main_invoice->delete;
4679 warn $error if $error;
4682 if ( $self->custnum ) {
4683 @cust_main_invoice =
4684 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4686 @cust_main_invoice = ();
4688 my %seen = map { $_->address => 1 } @cust_main_invoice;
4689 foreach my $address ( @{$arrayref} ) {
4690 next if exists $seen{$address} && $seen{$address};
4691 $seen{$address} = 1;
4692 my $cust_main_invoice = new FS::cust_main_invoice ( {
4693 'custnum' => $self->custnum,
4696 my $error = $cust_main_invoice->insert;
4697 warn $error if $error;
4701 if ( $self->custnum ) {
4703 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4710 =item check_invoicing_list ARRAYREF
4712 Checks these arguements as valid input for the invoicing_list method. If there
4713 is an error, returns the error, otherwise returns false.
4717 sub check_invoicing_list {
4718 my( $self, $arrayref ) = @_;
4720 foreach my $address ( @$arrayref ) {
4722 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4723 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4726 my $cust_main_invoice = new FS::cust_main_invoice ( {
4727 'custnum' => $self->custnum,
4730 my $error = $self->custnum
4731 ? $cust_main_invoice->check
4732 : $cust_main_invoice->checkdest
4734 return $error if $error;
4738 return "Email address required"
4739 if $conf->exists('cust_main-require_invoicing_list_email')
4740 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4745 =item set_default_invoicing_list
4747 Sets the invoicing list to all accounts associated with this customer,
4748 overwriting any previous invoicing list.
4752 sub set_default_invoicing_list {
4754 $self->invoicing_list($self->all_emails);
4759 Returns the email addresses of all accounts provisioned for this customer.
4766 foreach my $cust_pkg ( $self->all_pkgs ) {
4767 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4769 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4770 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4772 $list{$_}=1 foreach map { $_->email } @svc_acct;
4777 =item invoicing_list_addpost
4779 Adds postal invoicing to this customer. If this customer is already configured
4780 to receive postal invoices, does nothing.
4784 sub invoicing_list_addpost {
4786 return if grep { $_ eq 'POST' } $self->invoicing_list;
4787 my @invoicing_list = $self->invoicing_list;
4788 push @invoicing_list, 'POST';
4789 $self->invoicing_list(\@invoicing_list);
4792 =item invoicing_list_emailonly
4794 Returns the list of email invoice recipients (invoicing_list without non-email
4795 destinations such as POST and FAX).
4799 sub invoicing_list_emailonly {
4801 warn "$me invoicing_list_emailonly called"
4803 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4806 =item invoicing_list_emailonly_scalar
4808 Returns the list of email invoice recipients (invoicing_list without non-email
4809 destinations such as POST and FAX) as a comma-separated scalar.
4813 sub invoicing_list_emailonly_scalar {
4815 warn "$me invoicing_list_emailonly_scalar called"
4817 join(', ', $self->invoicing_list_emailonly);
4820 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4822 Returns an array of customers referred by this customer (referral_custnum set
4823 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4824 customers referred by customers referred by this customer and so on, inclusive.
4825 The default behavior is DEPTH 1 (no recursion).
4829 sub referral_cust_main {
4831 my $depth = @_ ? shift : 1;
4832 my $exclude = @_ ? shift : {};
4835 map { $exclude->{$_->custnum}++; $_; }
4836 grep { ! $exclude->{ $_->custnum } }
4837 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4841 map { $_->referral_cust_main($depth-1, $exclude) }
4848 =item referral_cust_main_ncancelled
4850 Same as referral_cust_main, except only returns customers with uncancelled
4855 sub referral_cust_main_ncancelled {
4857 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4860 =item referral_cust_pkg [ DEPTH ]
4862 Like referral_cust_main, except returns a flat list of all unsuspended (and
4863 uncancelled) packages for each customer. The number of items in this list may
4864 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4868 sub referral_cust_pkg {
4870 my $depth = @_ ? shift : 1;
4872 map { $_->unsuspended_pkgs }
4873 grep { $_->unsuspended_pkgs }
4874 $self->referral_cust_main($depth);
4877 =item referring_cust_main
4879 Returns the single cust_main record for the customer who referred this customer
4880 (referral_custnum), or false.
4884 sub referring_cust_main {
4886 return '' unless $self->referral_custnum;
4887 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4890 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
4892 Applies a credit to this customer. If there is an error, returns the error,
4893 otherwise returns false.
4895 REASON can be a text string, an FS::reason object, or a scalar reference to
4896 a reasonnum. If a text string, it will be automatically inserted as a new
4897 reason, and a 'reason_type' option must be passed to indicate the
4898 FS::reason_type for the new reason.
4900 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
4902 Any other options are passed to FS::cust_credit::insert.
4907 my( $self, $amount, $reason, %options ) = @_;
4909 my $cust_credit = new FS::cust_credit {
4910 'custnum' => $self->custnum,
4911 'amount' => $amount,
4914 if ( ref($reason) ) {
4916 if ( ref($reason) eq 'SCALAR' ) {
4917 $cust_credit->reasonnum( $$reason );
4919 $cust_credit->reasonnum( $reason->reasonnum );
4923 $cust_credit->set('reason', $reason)
4926 $cust_credit->addlinfo( delete $options{'addlinfo'} )
4927 if exists($options{'addlinfo'});
4929 $cust_credit->insert(%options);
4933 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4935 Creates a one-time charge for this customer. If there is an error, returns
4936 the error, otherwise returns false.
4942 my ( $amount, $quantity, $pkg, $comment, $taxclass, $additional, $classnum );
4943 my ( $taxproduct, $override );
4944 if ( ref( $_[0] ) ) {
4945 $amount = $_[0]->{amount};
4946 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
4947 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4948 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4949 : '$'. sprintf("%.2f",$amount);
4950 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4951 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4952 $additional = $_[0]->{additional};
4953 $taxproduct = $_[0]->{taxproductnum};
4954 $override = { '' => $_[0]->{tax_override} };
4958 $pkg = @_ ? shift : 'One-time charge';
4959 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4960 $taxclass = @_ ? shift : '';
4964 local $SIG{HUP} = 'IGNORE';
4965 local $SIG{INT} = 'IGNORE';
4966 local $SIG{QUIT} = 'IGNORE';
4967 local $SIG{TERM} = 'IGNORE';
4968 local $SIG{TSTP} = 'IGNORE';
4969 local $SIG{PIPE} = 'IGNORE';
4971 my $oldAutoCommit = $FS::UID::AutoCommit;
4972 local $FS::UID::AutoCommit = 0;
4975 my $part_pkg = new FS::part_pkg ( {
4977 'comment' => $comment,
4981 'classnum' => $classnum ? $classnum : '',
4982 'taxclass' => $taxclass,
4983 'taxproductnum' => $taxproduct,
4986 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4987 ( 0 .. @$additional - 1 )
4989 'additional_count' => scalar(@$additional),
4990 'setup_fee' => $amount,
4993 my $error = $part_pkg->insert( options => \%options,
4994 tax_overrides => $override,
4997 $dbh->rollback if $oldAutoCommit;
5001 my $pkgpart = $part_pkg->pkgpart;
5002 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
5003 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
5004 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
5005 $error = $type_pkgs->insert;
5007 $dbh->rollback if $oldAutoCommit;
5012 my $cust_pkg = new FS::cust_pkg ( {
5013 'custnum' => $self->custnum,
5014 'pkgpart' => $pkgpart,
5015 'quantity' => $quantity,
5018 $error = $cust_pkg->insert;
5020 $dbh->rollback if $oldAutoCommit;
5024 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5029 #=item charge_postal_fee
5031 #Applies a one time charge this customer. If there is an error,
5032 #returns the error, returns the cust_pkg charge object or false
5033 #if there was no charge.
5037 # This should be a customer event. For that to work requires that bill
5038 # also be a customer event.
5040 sub charge_postal_fee {
5043 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
5044 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
5046 my $cust_pkg = new FS::cust_pkg ( {
5047 'custnum' => $self->custnum,
5048 'pkgpart' => $pkgpart,
5052 my $error = $cust_pkg->insert;
5053 $error ? $error : $cust_pkg;
5058 Returns all the invoices (see L<FS::cust_bill>) for this customer.
5064 sort { $a->_date <=> $b->_date }
5065 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
5068 =item open_cust_bill
5070 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
5075 sub open_cust_bill {
5077 grep { $_->owed > 0 } $self->cust_bill;
5082 Returns all the credits (see L<FS::cust_credit>) for this customer.
5088 sort { $a->_date <=> $b->_date }
5089 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
5094 Returns all the payments (see L<FS::cust_pay>) for this customer.
5100 sort { $a->_date <=> $b->_date }
5101 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
5106 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
5112 sort { $a->_date <=> $b->_date }
5113 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
5116 =item cust_pay_batch
5118 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
5122 sub cust_pay_batch {
5124 sort { $a->_date <=> $b->_date }
5125 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
5130 Returns all the refunds (see L<FS::cust_refund>) for this customer.
5136 sort { $a->_date <=> $b->_date }
5137 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
5140 =item display_custnum
5142 Returns the displayed customer number for this customer: agent_custid if
5143 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
5147 sub display_custnum {
5149 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
5150 return $self->agent_custid;
5152 return $self->custnum;
5158 Returns a name string for this customer, either "Company (Last, First)" or
5165 my $name = $self->contact;
5166 $name = $self->company. " ($name)" if $self->company;
5172 Returns a name string for this (service/shipping) contact, either
5173 "Company (Last, First)" or "Last, First".
5179 if ( $self->get('ship_last') ) {
5180 my $name = $self->ship_contact;
5181 $name = $self->ship_company. " ($name)" if $self->ship_company;
5190 Returns this customer's full (billing) contact name only, "Last, First"
5196 $self->get('last'). ', '. $self->first;
5201 Returns this customer's full (shipping) contact name only, "Last, First"
5207 $self->get('ship_last')
5208 ? $self->get('ship_last'). ', '. $self->ship_first
5214 Returns this customer's full country name
5220 code2country($self->country);
5223 =item geocode DATA_VENDOR
5225 Returns a value for the customer location as encoded by DATA_VENDOR.
5226 Currently this only makes sense for "CCH" as DATA_VENDOR.
5231 my ($self, $data_vendor) = (shift, shift); #always cch for now
5233 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
5234 return $geocode if $geocode;
5236 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
5240 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
5241 if $self->country eq 'US';
5243 #CCH specific location stuff
5244 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
5246 my @cust_tax_location =
5248 'table' => 'cust_tax_location',
5249 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
5250 'extra_sql' => $extra_sql,
5251 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
5254 $geocode = $cust_tax_location[0]->geocode
5255 if scalar(@cust_tax_location);
5264 Returns a status string for this customer, currently:
5268 =item prospect - No packages have ever been ordered
5270 =item active - One or more recurring packages is active
5272 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
5274 =item suspended - All non-cancelled recurring packages are suspended
5276 =item cancelled - All recurring packages are cancelled
5282 sub status { shift->cust_status(@_); }
5286 for my $status (qw( prospect active inactive suspended cancelled )) {
5287 my $method = $status.'_sql';
5288 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
5289 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
5290 $sth->execute( ($self->custnum) x $numnum )
5291 or die "Error executing 'SELECT $sql': ". $sth->errstr;
5292 return $status if $sth->fetchrow_arrayref->[0];
5296 =item ucfirst_cust_status
5298 =item ucfirst_status
5300 Returns the status with the first character capitalized.
5304 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
5306 sub ucfirst_cust_status {
5308 ucfirst($self->cust_status);
5313 Returns a hex triplet color string for this customer's status.
5317 use vars qw(%statuscolor);
5318 tie %statuscolor, 'Tie::IxHash',
5319 'prospect' => '7e0079', #'000000', #black? naw, purple
5320 'active' => '00CC00', #green
5321 'inactive' => '0000CC', #blue
5322 'suspended' => 'FF9900', #yellow
5323 'cancelled' => 'FF0000', #red
5326 sub statuscolor { shift->cust_statuscolor(@_); }
5328 sub cust_statuscolor {
5330 $statuscolor{$self->cust_status};
5335 Returns an array of hashes representing the customer's RT tickets.
5342 my $num = $conf->config('cust_main-max_tickets') || 10;
5345 unless ( $conf->config('ticket_system-custom_priority_field') ) {
5347 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
5351 foreach my $priority (
5352 $conf->config('ticket_system-custom_priority_field-values'), ''
5354 last if scalar(@tickets) >= $num;
5356 @{ FS::TicketSystem->customer_tickets( $self->custnum,
5357 $num - scalar(@tickets),
5366 # Return services representing svc_accts in customer support packages
5367 sub support_services {
5369 my %packages = map { $_ => 1 } $conf->config('support_packages');
5371 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
5372 grep { $_->part_svc->svcdb eq 'svc_acct' }
5373 map { $_->cust_svc }
5374 grep { exists $packages{ $_->pkgpart } }
5375 $self->ncancelled_pkgs;
5381 =head1 CLASS METHODS
5387 Class method that returns the list of possible status strings for customers
5388 (see L<the status method|/status>). For example:
5390 @statuses = FS::cust_main->statuses();
5395 #my $self = shift; #could be class...
5401 Returns an SQL expression identifying prospective cust_main records (customers
5402 with no packages ever ordered)
5406 use vars qw($select_count_pkgs);
5407 $select_count_pkgs =
5408 "SELECT COUNT(*) FROM cust_pkg
5409 WHERE cust_pkg.custnum = cust_main.custnum";
5411 sub select_count_pkgs_sql {
5415 sub prospect_sql { "
5416 0 = ( $select_count_pkgs )
5421 Returns an SQL expression identifying active cust_main records (customers with
5422 active recurring packages).
5427 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5433 Returns an SQL expression identifying inactive cust_main records (customers with
5434 no active recurring packages, but otherwise unsuspended/uncancelled).
5438 sub inactive_sql { "
5439 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5441 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5447 Returns an SQL expression identifying suspended cust_main records.
5452 sub suspended_sql { susp_sql(@_); }
5454 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5456 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5462 Returns an SQL expression identifying cancelled cust_main records.
5466 sub cancelled_sql { cancel_sql(@_); }
5469 my $recurring_sql = FS::cust_pkg->recurring_sql;
5470 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
5473 0 < ( $select_count_pkgs )
5474 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
5475 AND 0 = ( $select_count_pkgs AND $recurring_sql
5476 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5478 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5484 =item uncancelled_sql
5486 Returns an SQL expression identifying un-cancelled cust_main records.
5490 sub uncancelled_sql { uncancel_sql(@_); }
5491 sub uncancel_sql { "
5492 ( 0 < ( $select_count_pkgs
5493 AND ( cust_pkg.cancel IS NULL
5494 OR cust_pkg.cancel = 0
5497 OR 0 = ( $select_count_pkgs )
5503 Returns an SQL fragment to retreive the balance.
5508 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5509 WHERE cust_bill.custnum = cust_main.custnum )
5510 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5511 WHERE cust_pay.custnum = cust_main.custnum )
5512 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5513 WHERE cust_credit.custnum = cust_main.custnum )
5514 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5515 WHERE cust_refund.custnum = cust_main.custnum )
5518 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5520 Returns an SQL fragment to retreive the balance for this customer, only
5521 considering invoices with date earlier than START_TIME, and optionally not
5522 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5523 total_unapplied_payments).
5525 Times are specified as SQL fragments or numeric
5526 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5527 L<Date::Parse> for conversion functions. The empty string can be passed
5528 to disable that time constraint completely.
5530 Available options are:
5534 =item unapplied_date
5536 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)
5541 set to true to remove all customer comparison clauses, for totals
5546 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5551 JOIN clause (typically used with the total option)
5557 sub balance_date_sql {
5558 my( $class, $start, $end, %opt ) = @_;
5560 my $owed = FS::cust_bill->owed_sql;
5561 my $unapp_refund = FS::cust_refund->unapplied_sql;
5562 my $unapp_credit = FS::cust_credit->unapplied_sql;
5563 my $unapp_pay = FS::cust_pay->unapplied_sql;
5565 my $j = $opt{'join'} || '';
5567 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5568 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5569 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5570 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5572 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5573 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5574 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5575 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5580 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5582 Helper method for balance_date_sql; name (and usage) subject to change
5583 (suggestions welcome).
5585 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5586 cust_refund, cust_credit or cust_pay).
5588 If TABLE is "cust_bill" or the unapplied_date option is true, only
5589 considers records with date earlier than START_TIME, and optionally not
5590 later than END_TIME .
5594 sub _money_table_where {
5595 my( $class, $table, $start, $end, %opt ) = @_;
5598 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5599 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5600 push @where, "$table._date <= $start" if defined($start) && length($start);
5601 push @where, "$table._date > $end" if defined($end) && length($end);
5603 push @where, @{$opt{'where'}} if $opt{'where'};
5604 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5610 =item search_sql HASHREF
5614 Returns a qsearch hash expression to search for parameters specified in HREF.
5615 Valid parameters are
5623 =item cancelled_pkgs
5629 listref of start date, end date
5635 =item current_balance
5637 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
5641 =item flattened_pkgs
5650 my ($class, $params) = @_;
5661 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5663 "cust_main.agentnum = $1";
5670 #prospect active inactive suspended cancelled
5671 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
5672 my $method = $params->{'status'}. '_sql';
5673 #push @where, $class->$method();
5674 push @where, FS::cust_main->$method();
5678 # parse cancelled package checkbox
5683 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
5684 unless $params->{'cancelled_pkgs'};
5690 foreach my $field (qw( signupdate )) {
5692 next unless exists($params->{$field});
5694 my($beginning, $ending) = @{$params->{$field}};
5697 "cust_main.$field IS NOT NULL",
5698 "cust_main.$field >= $beginning",
5699 "cust_main.$field <= $ending";
5701 $orderby ||= "ORDER BY cust_main.$field";
5709 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
5711 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
5718 #my $balance_sql = $class->balance_sql();
5719 my $balance_sql = FS::cust_main->balance_sql();
5721 push @where, map { s/current_balance/$balance_sql/; $_ }
5722 @{ $params->{'current_balance'} };
5728 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5730 "cust_main.custbatch = '$1'";
5734 # setup queries, subs, etc. for the search
5737 $orderby ||= 'ORDER BY custnum';
5739 # here is the agent virtualization
5740 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
5742 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5744 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
5746 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
5748 my $select = join(', ',
5749 'cust_main.custnum',
5750 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
5753 my(@extra_headers) = ();
5754 my(@extra_fields) = ();
5756 if ($params->{'flattened_pkgs'}) {
5758 if ($dbh->{Driver}->{Name} eq 'Pg') {
5760 $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";
5762 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
5763 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
5764 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
5766 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
5767 "omitting packing information from report.";
5770 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";
5772 my $sth = dbh->prepare($header_query) or die dbh->errstr;
5773 $sth->execute() or die $sth->errstr;
5774 my $headerrow = $sth->fetchrow_arrayref;
5775 my $headercount = $headerrow ? $headerrow->[0] : 0;
5776 while($headercount) {
5777 unshift @extra_headers, "Package ". $headercount;
5778 unshift @extra_fields, eval q!sub {my $c = shift;
5779 my @a = split '\|', $c->magic;
5780 my $p = $a[!.--$headercount. q!];
5788 'table' => 'cust_main',
5789 'select' => $select,
5791 'extra_sql' => $extra_sql,
5792 'order_by' => $orderby,
5793 'count_query' => $count_query,
5794 'extra_headers' => \@extra_headers,
5795 'extra_fields' => \@extra_fields,
5800 =item email_search_sql HASHREF
5804 Emails a notice to the specified customers.
5806 Valid parameters are those of the L<search_sql> method, plus the following:
5828 Optional job queue job for status updates.
5832 Returns an error message, or false for success.
5834 If an error occurs during any email, stops the enture send and returns that
5835 error. Presumably if you're getting SMTP errors aborting is better than
5836 retrying everything.
5840 sub email_search_sql {
5841 my($class, $params) = @_;
5843 my $from = delete $params->{from};
5844 my $subject = delete $params->{subject};
5845 my $html_body = delete $params->{html_body};
5846 my $text_body = delete $params->{text_body};
5848 my $job = delete $params->{'job'};
5850 my $sql_query = $class->search_sql($params);
5852 my $count_query = delete($sql_query->{'count_query'});
5853 my $count_sth = dbh->prepare($count_query)
5854 or die "Error preparing $count_query: ". dbh->errstr;
5856 or die "Error executing $count_query: ". $count_sth->errstr;
5857 my $count_arrayref = $count_sth->fetchrow_arrayref;
5858 my $num_cust = $count_arrayref->[0];
5860 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
5861 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
5864 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
5866 #eventually order+limit magic to reduce memory use?
5867 foreach my $cust_main ( qsearch($sql_query) ) {
5869 my $to = $cust_main->invoicing_list_emailonly_scalar;
5872 my $error = send_email(
5876 'subject' => $subject,
5877 'html_body' => $html_body,
5878 'text_body' => $text_body,
5881 return $error if $error;
5883 if ( $job ) { #progressbar foo
5885 if ( time - $min_sec > $last ) {
5886 my $error = $job->update_statustext(
5887 int( 100 * $num / $num_cust )
5889 die $error if $error;
5899 use Storable qw(thaw);
5902 sub process_email_search_sql {
5904 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
5906 my $param = thaw(decode_base64(shift));
5907 warn Dumper($param) if $DEBUG;
5909 $param->{'job'} = $job;
5911 my $error = FS::cust_main->email_search_sql( $param );
5912 die $error if $error;
5916 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5918 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5919 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
5920 appropriate ship_ field is also searched).
5922 Additional options are the same as FS::Record::qsearch
5927 my( $self, $fuzzy, $hash, @opt) = @_;
5932 check_and_rebuild_fuzzyfiles();
5933 foreach my $field ( keys %$fuzzy ) {
5935 my $all = $self->all_X($field);
5936 next unless scalar(@$all);
5939 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5942 foreach ( keys %match ) {
5943 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5944 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5947 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5950 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5952 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5960 Returns a masked version of the named field
5965 my ($self,$field) = @_;
5969 'x'x(length($self->getfield($field))-4).
5970 substr($self->getfield($field), (length($self->getfield($field))-4));
5980 =item smart_search OPTION => VALUE ...
5982 Accepts the following options: I<search>, the string to search for. The string
5983 will be searched for as a customer number, phone number, name or company name,
5984 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5985 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5986 skip fuzzy matching when an exact match is found.
5988 Any additional options are treated as an additional qualifier on the search
5991 Returns a (possibly empty) array of FS::cust_main objects.
5998 #here is the agent virtualization
5999 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
6003 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
6004 my $search = delete $options{'search'};
6005 ( my $alphanum_search = $search ) =~ s/\W//g;
6007 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
6009 #false laziness w/Record::ut_phone
6010 my $phonen = "$1-$2-$3";
6011 $phonen .= " x$4" if $4;
6013 push @cust_main, qsearch( {
6014 'table' => 'cust_main',
6015 'hashref' => { %options },
6016 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
6018 join(' OR ', map "$_ = '$phonen'",
6019 qw( daytime night fax
6020 ship_daytime ship_night ship_fax )
6023 " AND $agentnums_sql", #agent virtualization
6026 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
6027 #try looking for matches with extensions unless one was specified
6029 push @cust_main, qsearch( {
6030 'table' => 'cust_main',
6031 'hashref' => { %options },
6032 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
6034 join(' OR ', map "$_ LIKE '$phonen\%'",
6036 ship_daytime ship_night )
6039 " AND $agentnums_sql", #agent virtualization
6044 # custnum search (also try agent_custid), with some tweaking options if your
6045 # legacy cust "numbers" have letters
6048 if ( $search =~ /^\s*(\d+)\s*$/
6049 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
6050 && $search =~ /^\s*(\w\w?\d+)\s*$/
6057 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
6058 push @cust_main, qsearch( {
6059 'table' => 'cust_main',
6060 'hashref' => { 'custnum' => $num, %options },
6061 'extra_sql' => " AND $agentnums_sql", #agent virtualization
6065 push @cust_main, qsearch( {
6066 'table' => 'cust_main',
6067 'hashref' => { 'agent_custid' => $num, %options },
6068 'extra_sql' => " AND $agentnums_sql", #agent virtualization
6071 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
6073 my($company, $last, $first) = ( $1, $2, $3 );
6075 # "Company (Last, First)"
6076 #this is probably something a browser remembered,
6077 #so just do an exact search
6079 foreach my $prefix ( '', 'ship_' ) {
6080 push @cust_main, qsearch( {
6081 'table' => 'cust_main',
6082 'hashref' => { $prefix.'first' => $first,
6083 $prefix.'last' => $last,
6084 $prefix.'company' => $company,
6087 'extra_sql' => " AND $agentnums_sql",
6091 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
6092 # try (ship_){last,company}
6096 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
6097 # # full strings the browser remembers won't work
6098 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
6100 use Lingua::EN::NameParse;
6101 my $NameParse = new Lingua::EN::NameParse(
6103 allow_reversed => 1,
6106 my($last, $first) = ( '', '' );
6107 #maybe disable this too and just rely on NameParse?
6108 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
6110 ($last, $first) = ( $1, $2 );
6112 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
6113 } elsif ( ! $NameParse->parse($value) ) {
6115 my %name = $NameParse->components;
6116 $first = $name{'given_name_1'};
6117 $last = $name{'surname_1'};
6121 if ( $first && $last ) {
6123 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
6126 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
6128 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
6129 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
6132 push @cust_main, qsearch( {
6133 'table' => 'cust_main',
6134 'hashref' => \%options,
6135 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
6138 # or it just be something that was typed in... (try that in a sec)
6142 my $q_value = dbh->quote($value);
6145 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
6146 $sql .= " ( LOWER(last) = $q_value
6147 OR LOWER(company) = $q_value
6148 OR LOWER(ship_last) = $q_value
6149 OR LOWER(ship_company) = $q_value
6152 push @cust_main, qsearch( {
6153 'table' => 'cust_main',
6154 'hashref' => \%options,
6155 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
6158 #no exact match, trying substring/fuzzy
6159 #always do substring & fuzzy (unless they're explicity config'ed off)
6160 #getting complaints searches are not returning enough
6161 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
6163 #still some false laziness w/search_sql (was search/cust_main.cgi)
6168 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
6169 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
6172 if ( $first && $last ) {
6175 { 'first' => { op=>'ILIKE', value=>"%$first%" },
6176 'last' => { op=>'ILIKE', value=>"%$last%" },
6178 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
6179 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
6186 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
6187 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
6191 foreach my $hashref ( @hashrefs ) {
6193 push @cust_main, qsearch( {
6194 'table' => 'cust_main',
6195 'hashref' => { %$hashref,
6198 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
6207 " AND $agentnums_sql", #extra_sql #agent virtualization
6210 if ( $first && $last ) {
6211 push @cust_main, FS::cust_main->fuzzy_search(
6212 { 'last' => $last, #fuzzy hashref
6213 'first' => $first }, #
6217 foreach my $field ( 'last', 'company' ) {
6219 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
6224 #eliminate duplicates
6226 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
6236 Accepts the following options: I<email>, the email address to search for. The
6237 email address will be searched for as an email invoice destination and as an
6240 #Any additional options are treated as an additional qualifier on the search
6241 #(i.e. I<agentnum>).
6243 Returns a (possibly empty) array of FS::cust_main objects (but usually just
6253 my $email = delete $options{'email'};
6255 #we're only being used by RT at the moment... no agent virtualization yet
6256 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
6260 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
6262 my ( $user, $domain ) = ( $1, $2 );
6264 warn "$me smart_search: searching for $user in domain $domain"
6270 'table' => 'cust_main_invoice',
6271 'hashref' => { 'dest' => $email },
6278 map $_->cust_svc->cust_pkg,
6280 'table' => 'svc_acct',
6281 'hashref' => { 'username' => $user, },
6283 'AND ( SELECT domain FROM svc_domain
6284 WHERE svc_acct.domsvc = svc_domain.svcnum
6285 ) = '. dbh->quote($domain),
6291 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
6293 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
6300 =item check_and_rebuild_fuzzyfiles
6304 use vars qw(@fuzzyfields);
6305 @fuzzyfields = ( 'last', 'first', 'company' );
6307 sub check_and_rebuild_fuzzyfiles {
6308 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6309 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
6312 =item rebuild_fuzzyfiles
6316 sub rebuild_fuzzyfiles {
6318 use Fcntl qw(:flock);
6320 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6321 mkdir $dir, 0700 unless -d $dir;
6323 foreach my $fuzzy ( @fuzzyfields ) {
6325 open(LOCK,">>$dir/cust_main.$fuzzy")
6326 or die "can't open $dir/cust_main.$fuzzy: $!";
6328 or die "can't lock $dir/cust_main.$fuzzy: $!";
6330 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
6331 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
6333 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
6334 my $sth = dbh->prepare("SELECT $field FROM cust_main".
6335 " WHERE $field != '' AND $field IS NOT NULL");
6336 $sth->execute or die $sth->errstr;
6338 while ( my $row = $sth->fetchrow_arrayref ) {
6339 print CACHE $row->[0]. "\n";
6344 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
6346 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
6357 my( $self, $field ) = @_;
6358 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6359 open(CACHE,"<$dir/cust_main.$field")
6360 or die "can't open $dir/cust_main.$field: $!";
6361 my @array = map { chomp; $_; } <CACHE>;
6366 =item append_fuzzyfiles LASTNAME COMPANY
6370 sub append_fuzzyfiles {
6371 #my( $first, $last, $company ) = @_;
6373 &check_and_rebuild_fuzzyfiles;
6375 use Fcntl qw(:flock);
6377 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6379 foreach my $field (qw( first last company )) {
6384 open(CACHE,">>$dir/cust_main.$field")
6385 or die "can't open $dir/cust_main.$field: $!";
6386 flock(CACHE,LOCK_EX)
6387 or die "can't lock $dir/cust_main.$field: $!";
6389 print CACHE "$value\n";
6391 flock(CACHE,LOCK_UN)
6392 or die "can't unlock $dir/cust_main.$field: $!";
6407 #warn join('-',keys %$param);
6408 my $fh = $param->{filehandle};
6409 my @fields = @{$param->{fields}};
6411 eval "use Text::CSV_XS;";
6414 my $csv = new Text::CSV_XS;
6421 local $SIG{HUP} = 'IGNORE';
6422 local $SIG{INT} = 'IGNORE';
6423 local $SIG{QUIT} = 'IGNORE';
6424 local $SIG{TERM} = 'IGNORE';
6425 local $SIG{TSTP} = 'IGNORE';
6426 local $SIG{PIPE} = 'IGNORE';
6428 my $oldAutoCommit = $FS::UID::AutoCommit;
6429 local $FS::UID::AutoCommit = 0;
6432 #while ( $columns = $csv->getline($fh) ) {
6434 while ( defined($line=<$fh>) ) {
6436 $csv->parse($line) or do {
6437 $dbh->rollback if $oldAutoCommit;
6438 return "can't parse: ". $csv->error_input();
6441 my @columns = $csv->fields();
6442 #warn join('-',@columns);
6445 foreach my $field ( @fields ) {
6446 $row{$field} = shift @columns;
6449 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
6450 unless ( $cust_main ) {
6451 $dbh->rollback if $oldAutoCommit;
6452 return "unknown custnum $row{'custnum'}";
6455 if ( $row{'amount'} > 0 ) {
6456 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
6458 $dbh->rollback if $oldAutoCommit;
6462 } elsif ( $row{'amount'} < 0 ) {
6463 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
6466 $dbh->rollback if $oldAutoCommit;
6476 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6478 return "Empty file!" unless $imported;
6484 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6486 Sends a templated email notification to the customer (see L<Text::Template>).
6488 OPTIONS is a hash and may include
6490 I<from> - the email sender (default is invoice_from)
6492 I<to> - comma-separated scalar or arrayref of recipients
6493 (default is invoicing_list)
6495 I<subject> - The subject line of the sent email notification
6496 (default is "Notice from company_name")
6498 I<extra_fields> - a hashref of name/value pairs which will be substituted
6501 The following variables are vavailable in the template.
6503 I<$first> - the customer first name
6504 I<$last> - the customer last name
6505 I<$company> - the customer company
6506 I<$payby> - a description of the method of payment for the customer
6507 # would be nice to use FS::payby::shortname
6508 I<$payinfo> - the account information used to collect for this customer
6509 I<$expdate> - the expiration of the customer payment in seconds from epoch
6514 my ($customer, $template, %options) = @_;
6516 return unless $conf->exists($template);
6518 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6519 $from = $options{from} if exists($options{from});
6521 my $to = join(',', $customer->invoicing_list_emailonly);
6522 $to = $options{to} if exists($options{to});
6524 my $subject = "Notice from " . $conf->config('company_name')
6525 if $conf->exists('company_name');
6526 $subject = $options{subject} if exists($options{subject});
6528 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6529 SOURCE => [ map "$_\n",
6530 $conf->config($template)]
6532 or die "can't create new Text::Template object: Text::Template::ERROR";
6533 $notify_template->compile()
6534 or die "can't compile template: Text::Template::ERROR";
6536 $FS::notify_template::_template::company_name = $conf->config('company_name');
6537 $FS::notify_template::_template::company_address =
6538 join("\n", $conf->config('company_address') ). "\n";
6540 my $paydate = $customer->paydate || '2037-12-31';
6541 $FS::notify_template::_template::first = $customer->first;
6542 $FS::notify_template::_template::last = $customer->last;
6543 $FS::notify_template::_template::company = $customer->company;
6544 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6545 my $payby = $customer->payby;
6546 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6547 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6549 #credit cards expire at the end of the month/year of their exp date
6550 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6551 $FS::notify_template::_template::payby = 'credit card';
6552 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6553 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6555 }elsif ($payby eq 'COMP') {
6556 $FS::notify_template::_template::payby = 'complimentary account';
6558 $FS::notify_template::_template::payby = 'current method';
6560 $FS::notify_template::_template::expdate = $expire_time;
6562 for (keys %{$options{extra_fields}}){
6564 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6567 send_email(from => $from,
6569 subject => $subject,
6570 body => $notify_template->fill_in( PACKAGE =>
6571 'FS::notify_template::_template' ),
6576 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6578 Generates a templated notification to the customer (see L<Text::Template>).
6580 OPTIONS is a hash and may include
6582 I<extra_fields> - a hashref of name/value pairs which will be substituted
6583 into the template. These values may override values mentioned below
6584 and those from the customer record.
6586 The following variables are available in the template instead of or in addition
6587 to the fields of the customer record.
6589 I<$payby> - a description of the method of payment for the customer
6590 # would be nice to use FS::payby::shortname
6591 I<$payinfo> - the masked account information used to collect for this customer
6592 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6593 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6597 sub generate_letter {
6598 my ($self, $template, %options) = @_;
6600 return unless $conf->exists($template);
6602 my $letter_template = new Text::Template
6604 SOURCE => [ map "$_\n", $conf->config($template)],
6605 DELIMITERS => [ '[@--', '--@]' ],
6607 or die "can't create new Text::Template object: Text::Template::ERROR";
6609 $letter_template->compile()
6610 or die "can't compile template: Text::Template::ERROR";
6612 my %letter_data = map { $_ => $self->$_ } $self->fields;
6613 $letter_data{payinfo} = $self->mask_payinfo;
6615 #my $paydate = $self->paydate || '2037-12-31';
6616 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6618 my $payby = $self->payby;
6619 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6620 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6622 #credit cards expire at the end of the month/year of their exp date
6623 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6624 $letter_data{payby} = 'credit card';
6625 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6626 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6628 }elsif ($payby eq 'COMP') {
6629 $letter_data{payby} = 'complimentary account';
6631 $letter_data{payby} = 'current method';
6633 $letter_data{expdate} = $expire_time;
6635 for (keys %{$options{extra_fields}}){
6636 $letter_data{$_} = $options{extra_fields}->{$_};
6639 unless(exists($letter_data{returnaddress})){
6640 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6641 $self->agent_template)
6643 if ( length($retadd) ) {
6644 $letter_data{returnaddress} = $retadd;
6645 } elsif ( grep /\S/, $conf->config('company_address') ) {
6646 $letter_data{returnaddress} =
6647 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6648 $conf->config('company_address')
6651 $letter_data{returnaddress} = '~';
6655 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6657 $letter_data{company_name} = $conf->config('company_name');
6659 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6660 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6664 ) or die "can't open temp file: $!\n";
6666 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6668 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6672 =item print_ps TEMPLATE
6674 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6680 my $file = $self->generate_letter(@_);
6681 FS::Misc::generate_ps($file);
6684 =item print TEMPLATE
6686 Prints the filled in template.
6688 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6692 sub queueable_print {
6695 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6696 or die "invalid customer number: " . $opt{custvnum};
6698 my $error = $self->print( $opt{template} );
6699 die $error if $error;
6703 my ($self, $template) = (shift, shift);
6704 do_print [ $self->print_ps($template) ];
6707 sub agent_template {
6709 $self->_agent_plandata('agent_templatename');
6712 sub agent_invoice_from {
6714 $self->_agent_plandata('agent_invoice_from');
6717 sub _agent_plandata {
6718 my( $self, $option ) = @_;
6720 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
6721 #agent-specific Conf
6723 use FS::part_event::Condition;
6725 my $agentnum = $self->agentnum;
6728 if ( driver_name =~ /^Pg/i ) {
6730 } elsif ( driver_name =~ /^mysql/i ) {
6733 die "don't know how to use regular expressions in ". driver_name. " databases";
6736 my $part_event_option =
6738 'select' => 'part_event_option.*',
6739 'table' => 'part_event_option',
6741 LEFT JOIN part_event USING ( eventpart )
6742 LEFT JOIN part_event_option AS peo_agentnum
6743 ON ( part_event.eventpart = peo_agentnum.eventpart
6744 AND peo_agentnum.optionname = 'agentnum'
6745 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
6747 LEFT JOIN part_event_option AS peo_cust_bill_age
6748 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
6749 AND peo_cust_bill_age.optionname = 'cust_bill_age'
6752 #'hashref' => { 'optionname' => $option },
6753 #'hashref' => { 'part_event_option.optionname' => $option },
6755 " WHERE part_event_option.optionname = ". dbh->quote($option).
6756 " AND action = 'cust_bill_send_agent' ".
6757 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
6758 " AND peo_agentnum.optionname = 'agentnum' ".
6759 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
6761 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
6763 ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
6765 , part_event.weight".
6769 unless ( $part_event_option ) {
6770 return $self->agent->invoice_template || ''
6771 if $option eq 'agent_templatename';
6775 $part_event_option->optionvalue;
6780 ## actual sub, not a method, designed to be called from the queue.
6781 ## sets up the customer, and calls the bill_and_collect
6782 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6783 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6784 $cust_main->bill_and_collect(
6795 The delete method should possibly take an FS::cust_main object reference
6796 instead of a scalar customer number.
6798 Bill and collect options should probably be passed as references instead of a
6801 There should probably be a configuration file with a list of allowed credit
6804 No multiple currency support (probably a larger project than just this module).
6806 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6808 Birthdates rely on negative epoch values.
6810 The payby for card/check batches is broken. With mixed batching, bad
6813 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6817 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6818 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6819 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.