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;
39 use FS::cust_tax_location;
41 use FS::cust_main_invoice;
42 use FS::cust_credit_bill;
43 use FS::cust_bill_pay;
44 use FS::prepay_credit;
48 use FS::part_event_condition;
51 use FS::payment_gateway;
52 use FS::agent_payment_gateway;
54 use FS::payinfo_Mixin;
57 @ISA = qw( FS::payinfo_Mixin FS::Record );
59 @EXPORT_OK = qw( smart_search );
61 $realtime_bop_decline_quiet = 0;
63 # 1 is mostly method/subroutine entry and options
64 # 2 traces progress of some operations
65 # 3 is even more information including possibly sensitive data
67 $me = '[FS::cust_main]';
71 $ignore_expired_card = 0;
73 @encrypted_fields = ('payinfo', 'paycvv');
74 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
76 #ask FS::UID to run this stuff for us later
77 #$FS::UID::callback{'FS::cust_main'} = sub {
78 install_callback FS::UID sub {
80 #yes, need it for stuff below (prolly should be cached)
85 my ( $hashref, $cache ) = @_;
86 if ( exists $hashref->{'pkgnum'} ) {
87 #@{ $self->{'_pkgnum'} } = ();
88 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
89 $self->{'_pkgnum'} = $subcache;
90 #push @{ $self->{'_pkgnum'} },
91 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
97 FS::cust_main - Object methods for cust_main records
103 $record = new FS::cust_main \%hash;
104 $record = new FS::cust_main { 'column' => 'value' };
106 $error = $record->insert;
108 $error = $new_record->replace($old_record);
110 $error = $record->delete;
112 $error = $record->check;
114 @cust_pkg = $record->all_pkgs;
116 @cust_pkg = $record->ncancelled_pkgs;
118 @cust_pkg = $record->suspended_pkgs;
120 $error = $record->bill;
121 $error = $record->bill %options;
122 $error = $record->bill 'time' => $time;
124 $error = $record->collect;
125 $error = $record->collect %options;
126 $error = $record->collect 'invoice_time' => $time,
131 An FS::cust_main object represents a customer. FS::cust_main inherits from
132 FS::Record. The following fields are currently supported:
136 =item custnum - primary key (assigned automatically for new customers)
138 =item agentnum - agent (see L<FS::agent>)
140 =item refnum - Advertising source (see L<FS::part_referral>)
146 =item ss - social security number (optional)
148 =item company - (optional)
152 =item address2 - (optional)
156 =item county - (optional, see L<FS::cust_main_county>)
158 =item state - (see L<FS::cust_main_county>)
162 =item country - (see L<FS::cust_main_county>)
164 =item daytime - phone (optional)
166 =item night - phone (optional)
168 =item fax - phone (optional)
170 =item ship_first - name
172 =item ship_last - name
174 =item ship_company - (optional)
178 =item ship_address2 - (optional)
182 =item ship_county - (optional, see L<FS::cust_main_county>)
184 =item ship_state - (see L<FS::cust_main_county>)
188 =item ship_country - (see L<FS::cust_main_county>)
190 =item ship_daytime - phone (optional)
192 =item ship_night - phone (optional)
194 =item ship_fax - phone (optional)
196 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
198 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
200 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
204 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
206 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
208 =item paystart_month - start date month (maestro/solo cards only)
210 =item paystart_year - start date year (maestro/solo cards only)
212 =item payissue - issue number (maestro/solo cards only)
214 =item payname - name on card or billing name
216 =item payip - IP address from which payment information was received
218 =item tax - tax exempt, empty or `Y'
220 =item otaker - order taker (assigned automatically, see L<FS::UID>)
222 =item comments - comments (optional)
224 =item referral_custnum - referring customer number
226 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
228 =item dundate - a suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
230 =item squelch_cdr - Discourage individual CDR printing, empty or `Y'
240 Creates a new customer. To add the customer to the database, see L<"insert">.
242 Note that this stores the hash reference, not a distinct copy of the hash it
243 points to. You can ask the object for a copy with the I<hash> method.
247 sub table { 'cust_main'; }
249 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
251 Adds this customer to the database. If there is an error, returns the error,
252 otherwise returns false.
254 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
255 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
256 are inserted atomicly, or the transaction is rolled back. Passing an empty
257 hash reference is equivalent to not supplying this parameter. There should be
258 a better explanation of this, but until then, here's an example:
261 tie %hash, 'Tie::RefHash'; #this part is important
263 $cust_pkg => [ $svc_acct ],
266 $cust_main->insert( \%hash );
268 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
269 be set as the invoicing list (see L<"invoicing_list">). Errors return as
270 expected and rollback the entire transaction; it is not necessary to call
271 check_invoicing_list first. The invoicing_list is set after the records in the
272 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
273 invoicing_list destination to the newly-created svc_acct. Here's an example:
275 $cust_main->insert( {}, [ $email, 'POST' ] );
277 Currently available options are: I<depend_jobnum> and I<noexport>.
279 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
280 on the supplied jobnum (they will not run until the specific job completes).
281 This can be used to defer provisioning until some action completes (such
282 as running the customer's credit card successfully).
284 The I<noexport> option is deprecated. If I<noexport> is set true, no
285 provisioning jobs (exports) are scheduled. (You can schedule them later with
286 the B<reexport> method.)
292 my $cust_pkgs = @_ ? shift : {};
293 my $invoicing_list = @_ ? shift : '';
295 warn "$me insert called with options ".
296 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
299 local $SIG{HUP} = 'IGNORE';
300 local $SIG{INT} = 'IGNORE';
301 local $SIG{QUIT} = 'IGNORE';
302 local $SIG{TERM} = 'IGNORE';
303 local $SIG{TSTP} = 'IGNORE';
304 local $SIG{PIPE} = 'IGNORE';
306 my $oldAutoCommit = $FS::UID::AutoCommit;
307 local $FS::UID::AutoCommit = 0;
310 my $prepay_identifier = '';
311 my( $amount, $seconds ) = ( 0, 0 );
313 if ( $self->payby eq 'PREPAY' ) {
315 $self->payby('BILL');
316 $prepay_identifier = $self->payinfo;
319 warn " looking up prepaid card $prepay_identifier\n"
322 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
324 $dbh->rollback if $oldAutoCommit;
325 #return "error applying prepaid card (transaction rolled back): $error";
329 $payby = 'PREP' if $amount;
331 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
334 $self->payby('BILL');
335 $amount = $self->paid;
339 warn " inserting $self\n"
342 $self->signupdate(time) unless $self->signupdate;
344 $self->auto_agent_custid()
345 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
347 my $error = $self->SUPER::insert;
349 $dbh->rollback if $oldAutoCommit;
350 #return "inserting cust_main record (transaction rolled back): $error";
354 warn " setting invoicing list\n"
357 if ( $invoicing_list ) {
358 $error = $self->check_invoicing_list( $invoicing_list );
360 $dbh->rollback if $oldAutoCommit;
361 #return "checking invoicing_list (transaction rolled back): $error";
364 $self->invoicing_list( $invoicing_list );
367 if ( $conf->config('cust_main-skeleton_tables')
368 && $conf->config('cust_main-skeleton_custnum') ) {
370 warn " inserting skeleton records\n"
373 my $error = $self->start_copy_skel;
375 $dbh->rollback if $oldAutoCommit;
381 warn " ordering packages\n"
384 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
386 $dbh->rollback if $oldAutoCommit;
391 $dbh->rollback if $oldAutoCommit;
392 return "No svc_acct record to apply pre-paid time";
396 warn " inserting initial $payby payment of $amount\n"
398 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
400 $dbh->rollback if $oldAutoCommit;
401 return "inserting payment (transaction rolled back): $error";
405 unless ( $import || $skip_fuzzyfiles ) {
406 warn " queueing fuzzyfiles update\n"
408 $error = $self->queue_fuzzyfiles_update;
410 $dbh->rollback if $oldAutoCommit;
411 return "updating fuzzy search cache: $error";
415 warn " insert complete; committing transaction\n"
418 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
423 use File::CounterFile;
424 sub auto_agent_custid {
427 my $format = $conf->config('cust_main-auto_agent_custid');
429 if ( $format eq '1YMMXXXXXXXX' ) {
431 my $counter = new File::CounterFile 'cust_main.agent_custid';
434 my $ym = 100000000000 + time2str('%y%m00000000', time);
435 if ( $ym > $counter->value ) {
436 $counter->{'value'} = $agent_custid = $ym;
437 $counter->{'updated'} = 1;
439 $agent_custid = $counter->inc;
445 die "Unknown cust_main-auto_agent_custid format: $format";
448 $self->agent_custid($agent_custid);
452 sub start_copy_skel {
455 #'mg_user_preference' => {},
456 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
457 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
458 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
459 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
460 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
463 _copy_skel( 'cust_main', #tablename
464 $conf->config('cust_main-skeleton_custnum'), #sourceid
465 $self->custnum, #destid
466 @tables, #child tables
470 #recursive subroutine, not a method
472 my( $table, $sourceid, $destid, %child_tables ) = @_;
475 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
476 ( $table, $primary_key ) = ( $1, $2 );
478 my $dbdef_table = dbdef->table($table);
479 $primary_key = $dbdef_table->primary_key
480 or return "$table has no primary key".
481 " (or do you need to run dbdef-create?)";
484 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
485 join (', ', keys %child_tables). "\n"
488 foreach my $child_table_def ( keys %child_tables ) {
492 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
493 ( $child_table, $child_pkey ) = ( $1, $2 );
495 $child_table = $child_table_def;
497 $child_pkey = dbdef->table($child_table)->primary_key;
498 # or return "$table has no primary key".
499 # " (or do you need to run dbdef-create?)\n";
503 if ( keys %{ $child_tables{$child_table_def} } ) {
505 return "$child_table has no primary key".
506 " (run dbdef-create or try specifying it?)\n"
509 #false laziness w/Record::insert and only works on Pg
510 #refactor the proper last-inserted-id stuff out of Record::insert if this
511 # ever gets use for anything besides a quick kludge for one customer
512 my $default = dbdef->table($child_table)->column($child_pkey)->default;
513 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
514 or return "can't parse $child_table.$child_pkey default value ".
515 " for sequence name: $default";
520 my @sel_columns = grep { $_ ne $primary_key }
521 dbdef->table($child_table)->columns;
522 my $sel_columns = join(', ', @sel_columns );
524 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
525 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
526 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
528 my $sel_st = "SELECT $sel_columns FROM $child_table".
529 " WHERE $primary_key = $sourceid";
532 my $sel_sth = dbh->prepare( $sel_st )
533 or return dbh->errstr;
535 $sel_sth->execute or return $sel_sth->errstr;
537 while ( my $row = $sel_sth->fetchrow_hashref ) {
539 warn " selected row: ".
540 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
544 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
545 my $ins_sth =dbh->prepare($statement)
546 or return dbh->errstr;
547 my @param = ( $destid, map $row->{$_}, @ins_columns );
548 warn " $statement: [ ". join(', ', @param). " ]\n"
550 $ins_sth->execute( @param )
551 or return $ins_sth->errstr;
553 #next unless keys %{ $child_tables{$child_table} };
554 next unless $sequence;
556 #another section of that laziness
557 my $seq_sql = "SELECT currval('$sequence')";
558 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
559 $seq_sth->execute or return $seq_sth->errstr;
560 my $insertid = $seq_sth->fetchrow_arrayref->[0];
562 # don't drink soap! recurse! recurse! okay!
564 _copy_skel( $child_table_def,
565 $row->{$child_pkey}, #sourceid
567 %{ $child_tables{$child_table_def} },
569 return $error if $error;
579 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
581 Like the insert method on an existing record, this method orders a package
582 and included services atomicaly. Pass a Tie::RefHash data structure to this
583 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
584 be a better explanation of this, but until then, here's an example:
587 tie %hash, 'Tie::RefHash'; #this part is important
589 $cust_pkg => [ $svc_acct ],
592 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
594 Services can be new, in which case they are inserted, or existing unaudited
595 services, in which case they are linked to the newly-created package.
597 Currently available options are: I<depend_jobnum> and I<noexport>.
599 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
600 on the supplied jobnum (they will not run until the specific job completes).
601 This can be used to defer provisioning until some action completes (such
602 as running the customer's credit card successfully).
604 The I<noexport> option is deprecated. If I<noexport> is set true, no
605 provisioning jobs (exports) are scheduled. (You can schedule them later with
606 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
607 on the cust_main object is not recommended, as existing services will also be
614 my $cust_pkgs = shift;
617 my %svc_options = ();
618 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
619 if exists $options{'depend_jobnum'};
620 warn "$me order_pkgs called with options ".
621 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
624 local $SIG{HUP} = 'IGNORE';
625 local $SIG{INT} = 'IGNORE';
626 local $SIG{QUIT} = 'IGNORE';
627 local $SIG{TERM} = 'IGNORE';
628 local $SIG{TSTP} = 'IGNORE';
629 local $SIG{PIPE} = 'IGNORE';
631 my $oldAutoCommit = $FS::UID::AutoCommit;
632 local $FS::UID::AutoCommit = 0;
635 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
637 foreach my $cust_pkg ( keys %$cust_pkgs ) {
638 $cust_pkg->custnum( $self->custnum );
639 my $error = $cust_pkg->insert;
641 $dbh->rollback if $oldAutoCommit;
642 return "inserting cust_pkg (transaction rolled back): $error";
644 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
645 if ( $svc_something->svcnum ) {
646 my $old_cust_svc = $svc_something->cust_svc;
647 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
648 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
649 $error = $new_cust_svc->replace($old_cust_svc);
651 $svc_something->pkgnum( $cust_pkg->pkgnum );
652 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
653 $svc_something->seconds( $svc_something->seconds + $$seconds );
656 $error = $svc_something->insert(%svc_options);
659 $dbh->rollback if $oldAutoCommit;
660 #return "inserting svc_ (transaction rolled back): $error";
666 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
670 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
672 Recharges this (existing) customer with the specified prepaid card (see
673 L<FS::prepay_credit>), specified either by I<identifier> or as an
674 FS::prepay_credit object. If there is an error, returns the error, otherwise
677 Optionally, four scalar references can be passed as well. They will have their
678 values filled in with the amount, number of seconds, and number of upload and
679 download bytes applied by this prepaid
684 sub recharge_prepay {
685 my( $self, $prepay_credit, $amountref, $secondsref,
686 $upbytesref, $downbytesref, $totalbytesref ) = @_;
688 local $SIG{HUP} = 'IGNORE';
689 local $SIG{INT} = 'IGNORE';
690 local $SIG{QUIT} = 'IGNORE';
691 local $SIG{TERM} = 'IGNORE';
692 local $SIG{TSTP} = 'IGNORE';
693 local $SIG{PIPE} = 'IGNORE';
695 my $oldAutoCommit = $FS::UID::AutoCommit;
696 local $FS::UID::AutoCommit = 0;
699 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
701 my $error = $self->get_prepay($prepay_credit, \$amount,
702 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
703 || $self->increment_seconds($seconds)
704 || $self->increment_upbytes($upbytes)
705 || $self->increment_downbytes($downbytes)
706 || $self->increment_totalbytes($totalbytes)
707 || $self->insert_cust_pay_prepay( $amount,
709 ? $prepay_credit->identifier
714 $dbh->rollback if $oldAutoCommit;
718 if ( defined($amountref) ) { $$amountref = $amount; }
719 if ( defined($secondsref) ) { $$secondsref = $seconds; }
720 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
721 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
722 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
724 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
729 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
731 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
732 specified either by I<identifier> or as an FS::prepay_credit object.
734 References to I<amount> and I<seconds> scalars should be passed as arguments
735 and will be incremented by the values of the prepaid card.
737 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
738 check or set this customer's I<agentnum>.
740 If there is an error, returns the error, otherwise returns false.
746 my( $self, $prepay_credit, $amountref, $secondsref,
747 $upref, $downref, $totalref) = @_;
749 local $SIG{HUP} = 'IGNORE';
750 local $SIG{INT} = 'IGNORE';
751 local $SIG{QUIT} = 'IGNORE';
752 local $SIG{TERM} = 'IGNORE';
753 local $SIG{TSTP} = 'IGNORE';
754 local $SIG{PIPE} = 'IGNORE';
756 my $oldAutoCommit = $FS::UID::AutoCommit;
757 local $FS::UID::AutoCommit = 0;
760 unless ( ref($prepay_credit) ) {
762 my $identifier = $prepay_credit;
764 $prepay_credit = qsearchs(
766 { 'identifier' => $prepay_credit },
771 unless ( $prepay_credit ) {
772 $dbh->rollback if $oldAutoCommit;
773 return "Invalid prepaid card: ". $identifier;
778 if ( $prepay_credit->agentnum ) {
779 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
780 $dbh->rollback if $oldAutoCommit;
781 return "prepaid card not valid for agent ". $self->agentnum;
783 $self->agentnum($prepay_credit->agentnum);
786 my $error = $prepay_credit->delete;
788 $dbh->rollback if $oldAutoCommit;
789 return "removing prepay_credit (transaction rolled back): $error";
792 $$amountref += $prepay_credit->amount;
793 $$secondsref += $prepay_credit->seconds;
794 $$upref += $prepay_credit->upbytes;
795 $$downref += $prepay_credit->downbytes;
796 $$totalref += $prepay_credit->totalbytes;
798 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
803 =item increment_upbytes SECONDS
805 Updates this customer's single or primary account (see L<FS::svc_acct>) by
806 the specified number of upbytes. If there is an error, returns the error,
807 otherwise returns false.
811 sub increment_upbytes {
812 _increment_column( shift, 'upbytes', @_);
815 =item increment_downbytes SECONDS
817 Updates this customer's single or primary account (see L<FS::svc_acct>) by
818 the specified number of downbytes. If there is an error, returns the error,
819 otherwise returns false.
823 sub increment_downbytes {
824 _increment_column( shift, 'downbytes', @_);
827 =item increment_totalbytes SECONDS
829 Updates this customer's single or primary account (see L<FS::svc_acct>) by
830 the specified number of totalbytes. If there is an error, returns the error,
831 otherwise returns false.
835 sub increment_totalbytes {
836 _increment_column( shift, 'totalbytes', @_);
839 =item increment_seconds SECONDS
841 Updates this customer's single or primary account (see L<FS::svc_acct>) by
842 the specified number of seconds. If there is an error, returns the error,
843 otherwise returns false.
847 sub increment_seconds {
848 _increment_column( shift, 'seconds', @_);
851 =item _increment_column AMOUNT
853 Updates this customer's single or primary account (see L<FS::svc_acct>) by
854 the specified number of seconds or bytes. If there is an error, returns
855 the error, otherwise returns false.
859 sub _increment_column {
860 my( $self, $column, $amount ) = @_;
861 warn "$me increment_column called: $column, $amount\n"
864 return '' unless $amount;
866 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
867 $self->ncancelled_pkgs;
870 return 'No packages with primary or single services found'.
871 ' to apply pre-paid time';
872 } elsif ( scalar(@cust_pkg) > 1 ) {
873 #maybe have a way to specify the package/account?
874 return 'Multiple packages found to apply pre-paid time';
877 my $cust_pkg = $cust_pkg[0];
878 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
882 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
885 return 'No account found to apply pre-paid time';
886 } elsif ( scalar(@cust_svc) > 1 ) {
887 return 'Multiple accounts found to apply pre-paid time';
890 my $svc_acct = $cust_svc[0]->svc_x;
891 warn " found service svcnum ". $svc_acct->pkgnum.
892 ' ('. $svc_acct->email. ")\n"
895 $column = "increment_$column";
896 $svc_acct->$column($amount);
900 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
902 Inserts a prepayment in the specified amount for this customer. An optional
903 second argument can specify the prepayment identifier for tracking purposes.
904 If there is an error, returns the error, otherwise returns false.
908 sub insert_cust_pay_prepay {
909 shift->insert_cust_pay('PREP', @_);
912 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
914 Inserts a cash payment in the specified amount for this customer. An optional
915 second argument can specify the payment identifier for tracking purposes.
916 If there is an error, returns the error, otherwise returns false.
920 sub insert_cust_pay_cash {
921 shift->insert_cust_pay('CASH', @_);
924 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
926 Inserts a Western Union payment in the specified amount for this customer. An
927 optional second argument can specify the prepayment identifier for tracking
928 purposes. If there is an error, returns the error, otherwise returns false.
932 sub insert_cust_pay_west {
933 shift->insert_cust_pay('WEST', @_);
936 sub insert_cust_pay {
937 my( $self, $payby, $amount ) = splice(@_, 0, 3);
938 my $payinfo = scalar(@_) ? shift : '';
940 my $cust_pay = new FS::cust_pay {
941 'custnum' => $self->custnum,
942 'paid' => sprintf('%.2f', $amount),
943 #'_date' => #date the prepaid card was purchased???
945 'payinfo' => $payinfo,
953 This method is deprecated. See the I<depend_jobnum> option to the insert and
954 order_pkgs methods for a better way to defer provisioning.
956 Re-schedules all exports by calling the B<reexport> method of all associated
957 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
958 otherwise returns false.
965 carp "WARNING: FS::cust_main::reexport is deprectated; ".
966 "use the depend_jobnum option to insert or order_pkgs to delay export";
968 local $SIG{HUP} = 'IGNORE';
969 local $SIG{INT} = 'IGNORE';
970 local $SIG{QUIT} = 'IGNORE';
971 local $SIG{TERM} = 'IGNORE';
972 local $SIG{TSTP} = 'IGNORE';
973 local $SIG{PIPE} = 'IGNORE';
975 my $oldAutoCommit = $FS::UID::AutoCommit;
976 local $FS::UID::AutoCommit = 0;
979 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
980 my $error = $cust_pkg->reexport;
982 $dbh->rollback if $oldAutoCommit;
987 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
992 =item delete NEW_CUSTNUM
994 This deletes the customer. If there is an error, returns the error, otherwise
997 This will completely remove all traces of the customer record. This is not
998 what you want when a customer cancels service; for that, cancel all of the
999 customer's packages (see L</cancel>).
1001 If the customer has any uncancelled packages, you need to pass a new (valid)
1002 customer number for those packages to be transferred to. Cancelled packages
1003 will be deleted. Did I mention that this is NOT what you want when a customer
1004 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1006 You can't delete a customer with invoices (see L<FS::cust_bill>),
1007 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1008 refunds (see L<FS::cust_refund>).
1015 local $SIG{HUP} = 'IGNORE';
1016 local $SIG{INT} = 'IGNORE';
1017 local $SIG{QUIT} = 'IGNORE';
1018 local $SIG{TERM} = 'IGNORE';
1019 local $SIG{TSTP} = 'IGNORE';
1020 local $SIG{PIPE} = 'IGNORE';
1022 my $oldAutoCommit = $FS::UID::AutoCommit;
1023 local $FS::UID::AutoCommit = 0;
1026 if ( $self->cust_bill ) {
1027 $dbh->rollback if $oldAutoCommit;
1028 return "Can't delete a customer with invoices";
1030 if ( $self->cust_credit ) {
1031 $dbh->rollback if $oldAutoCommit;
1032 return "Can't delete a customer with credits";
1034 if ( $self->cust_pay ) {
1035 $dbh->rollback if $oldAutoCommit;
1036 return "Can't delete a customer with payments";
1038 if ( $self->cust_refund ) {
1039 $dbh->rollback if $oldAutoCommit;
1040 return "Can't delete a customer with refunds";
1043 my @cust_pkg = $self->ncancelled_pkgs;
1045 my $new_custnum = shift;
1046 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1047 $dbh->rollback if $oldAutoCommit;
1048 return "Invalid new customer number: $new_custnum";
1050 foreach my $cust_pkg ( @cust_pkg ) {
1051 my %hash = $cust_pkg->hash;
1052 $hash{'custnum'} = $new_custnum;
1053 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1054 my $error = $new_cust_pkg->replace($cust_pkg,
1055 options => { $cust_pkg->options },
1058 $dbh->rollback if $oldAutoCommit;
1063 my @cancelled_cust_pkg = $self->all_pkgs;
1064 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1065 my $error = $cust_pkg->delete;
1067 $dbh->rollback if $oldAutoCommit;
1072 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1073 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1075 my $error = $cust_main_invoice->delete;
1077 $dbh->rollback if $oldAutoCommit;
1082 my $error = $self->SUPER::delete;
1084 $dbh->rollback if $oldAutoCommit;
1088 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1093 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ]
1095 Replaces the OLD_RECORD with this one in the database. If there is an error,
1096 returns the error, otherwise returns false.
1098 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1099 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1100 expected and rollback the entire transaction; it is not necessary to call
1101 check_invoicing_list first. Here's an example:
1103 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1110 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1112 : $self->replace_old;
1116 warn "$me replace called\n"
1119 my $curuser = $FS::CurrentUser::CurrentUser;
1120 if ( $self->payby eq 'COMP'
1121 && $self->payby ne $old->payby
1122 && ! $curuser->access_right('Complimentary customer')
1125 return "You are not permitted to create complimentary accounts.";
1128 local($ignore_expired_card) = 1
1129 if $old->payby =~ /^(CARD|DCRD)$/
1130 && $self->payby =~ /^(CARD|DCRD)$/
1131 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1133 local $SIG{HUP} = 'IGNORE';
1134 local $SIG{INT} = 'IGNORE';
1135 local $SIG{QUIT} = 'IGNORE';
1136 local $SIG{TERM} = 'IGNORE';
1137 local $SIG{TSTP} = 'IGNORE';
1138 local $SIG{PIPE} = 'IGNORE';
1140 my $oldAutoCommit = $FS::UID::AutoCommit;
1141 local $FS::UID::AutoCommit = 0;
1144 my $error = $self->SUPER::replace($old);
1147 $dbh->rollback if $oldAutoCommit;
1151 if ( @param ) { # INVOICING_LIST_ARYREF
1152 my $invoicing_list = shift @param;
1153 $error = $self->check_invoicing_list( $invoicing_list );
1155 $dbh->rollback if $oldAutoCommit;
1158 $self->invoicing_list( $invoicing_list );
1161 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1162 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1163 # card/check/lec info has changed, want to retry realtime_ invoice events
1164 my $error = $self->retry_realtime;
1166 $dbh->rollback if $oldAutoCommit;
1171 unless ( $import || $skip_fuzzyfiles ) {
1172 $error = $self->queue_fuzzyfiles_update;
1174 $dbh->rollback if $oldAutoCommit;
1175 return "updating fuzzy search cache: $error";
1179 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1184 =item queue_fuzzyfiles_update
1186 Used by insert & replace to update the fuzzy search cache
1190 sub queue_fuzzyfiles_update {
1193 local $SIG{HUP} = 'IGNORE';
1194 local $SIG{INT} = 'IGNORE';
1195 local $SIG{QUIT} = 'IGNORE';
1196 local $SIG{TERM} = 'IGNORE';
1197 local $SIG{TSTP} = 'IGNORE';
1198 local $SIG{PIPE} = 'IGNORE';
1200 my $oldAutoCommit = $FS::UID::AutoCommit;
1201 local $FS::UID::AutoCommit = 0;
1204 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1205 my $error = $queue->insert( map $self->getfield($_),
1206 qw(first last company)
1209 $dbh->rollback if $oldAutoCommit;
1210 return "queueing job (transaction rolled back): $error";
1213 if ( $self->ship_last ) {
1214 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1215 $error = $queue->insert( map $self->getfield("ship_$_"),
1216 qw(first last company)
1219 $dbh->rollback if $oldAutoCommit;
1220 return "queueing job (transaction rolled back): $error";
1224 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1231 Checks all fields to make sure this is a valid customer record. If there is
1232 an error, returns the error, otherwise returns false. Called by the insert
1233 and replace methods.
1240 warn "$me check BEFORE: \n". $self->_dump
1244 $self->ut_numbern('custnum')
1245 || $self->ut_number('agentnum')
1246 || $self->ut_textn('agent_custid')
1247 || $self->ut_number('refnum')
1248 || $self->ut_textn('custbatch')
1249 || $self->ut_name('last')
1250 || $self->ut_name('first')
1251 || $self->ut_snumbern('birthdate')
1252 || $self->ut_snumbern('signupdate')
1253 || $self->ut_textn('company')
1254 || $self->ut_text('address1')
1255 || $self->ut_textn('address2')
1256 || $self->ut_text('city')
1257 || $self->ut_textn('county')
1258 || $self->ut_textn('state')
1259 || $self->ut_country('country')
1260 || $self->ut_anything('comments')
1261 || $self->ut_numbern('referral_custnum')
1262 || $self->ut_textn('stateid')
1263 || $self->ut_textn('stateid_state')
1264 || $self->ut_textn('invoice_terms')
1267 #barf. need message catalogs. i18n. etc.
1268 $error .= "Please select an advertising source."
1269 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1270 return $error if $error;
1272 return "Unknown agent"
1273 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1275 return "Unknown refnum"
1276 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1278 return "Unknown referring custnum: ". $self->referral_custnum
1279 unless ! $self->referral_custnum
1280 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1282 if ( $self->ss eq '' ) {
1287 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1288 or return "Illegal social security number: ". $self->ss;
1289 $self->ss("$1-$2-$3");
1293 # bad idea to disable, causes billing to fail because of no tax rates later
1294 # unless ( $import ) {
1295 unless ( qsearch('cust_main_county', {
1296 'country' => $self->country,
1299 return "Unknown state/county/country: ".
1300 $self->state. "/". $self->county. "/". $self->country
1301 unless qsearch('cust_main_county',{
1302 'state' => $self->state,
1303 'county' => $self->county,
1304 'country' => $self->country,
1310 $self->ut_phonen('daytime', $self->country)
1311 || $self->ut_phonen('night', $self->country)
1312 || $self->ut_phonen('fax', $self->country)
1313 || $self->ut_zip('zip', $self->country)
1315 return $error if $error;
1317 if ( $conf->exists('cust_main-require_phone')
1318 && ! length($self->daytime) && ! length($self->night)
1321 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1323 : FS::Msgcat::_gettext('daytime');
1324 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1326 : FS::Msgcat::_gettext('night');
1328 return "$daytime_label or $night_label is required"
1332 if ( $self->has_ship_address
1333 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1334 $self->addr_fields )
1338 $self->ut_name('ship_last')
1339 || $self->ut_name('ship_first')
1340 || $self->ut_textn('ship_company')
1341 || $self->ut_text('ship_address1')
1342 || $self->ut_textn('ship_address2')
1343 || $self->ut_text('ship_city')
1344 || $self->ut_textn('ship_county')
1345 || $self->ut_textn('ship_state')
1346 || $self->ut_country('ship_country')
1348 return $error if $error;
1350 #false laziness with above
1351 unless ( qsearchs('cust_main_county', {
1352 'country' => $self->ship_country,
1355 return "Unknown ship_state/ship_county/ship_country: ".
1356 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1357 unless qsearch('cust_main_county',{
1358 'state' => $self->ship_state,
1359 'county' => $self->ship_county,
1360 'country' => $self->ship_country,
1366 $self->ut_phonen('ship_daytime', $self->ship_country)
1367 || $self->ut_phonen('ship_night', $self->ship_country)
1368 || $self->ut_phonen('ship_fax', $self->ship_country)
1369 || $self->ut_zip('ship_zip', $self->ship_country)
1371 return $error if $error;
1373 return "Unit # is required."
1374 if $self->ship_address2 =~ /^\s*$/
1375 && $conf->exists('cust_main-require_address2');
1377 } else { # ship_ info eq billing info, so don't store dup info in database
1379 $self->setfield("ship_$_", '')
1380 foreach $self->addr_fields;
1382 return "Unit # is required."
1383 if $self->address2 =~ /^\s*$/
1384 && $conf->exists('cust_main-require_address2');
1388 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1389 # or return "Illegal payby: ". $self->payby;
1391 FS::payby->can_payby($self->table, $self->payby)
1392 or return "Illegal payby: ". $self->payby;
1394 $error = $self->ut_numbern('paystart_month')
1395 || $self->ut_numbern('paystart_year')
1396 || $self->ut_numbern('payissue')
1397 || $self->ut_textn('paytype')
1399 return $error if $error;
1401 if ( $self->payip eq '' ) {
1404 $error = $self->ut_ip('payip');
1405 return $error if $error;
1408 # If it is encrypted and the private key is not availaible then we can't
1409 # check the credit card.
1411 my $check_payinfo = 1;
1413 if ($self->is_encrypted($self->payinfo)) {
1417 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1419 my $payinfo = $self->payinfo;
1420 $payinfo =~ s/\D//g;
1421 $payinfo =~ /^(\d{13,16})$/
1422 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1424 $self->payinfo($payinfo);
1426 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1428 return gettext('unknown_card_type')
1429 if cardtype($self->payinfo) eq "Unknown";
1431 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1433 return 'Banned credit card: banned on '.
1434 time2str('%a %h %o at %r', $ban->_date).
1435 ' by '. $ban->otaker.
1436 ' (ban# '. $ban->bannum. ')';
1439 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1440 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1441 $self->paycvv =~ /^(\d{4})$/
1442 or return "CVV2 (CID) for American Express cards is four digits.";
1445 $self->paycvv =~ /^(\d{3})$/
1446 or return "CVV2 (CVC2/CID) is three digits.";
1453 my $cardtype = cardtype($payinfo);
1454 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1456 return "Start date or issue number is required for $cardtype cards"
1457 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1459 return "Start month must be between 1 and 12"
1460 if $self->paystart_month
1461 and $self->paystart_month < 1 || $self->paystart_month > 12;
1463 return "Start year must be 1990 or later"
1464 if $self->paystart_year
1465 and $self->paystart_year < 1990;
1467 return "Issue number must be beween 1 and 99"
1469 and $self->payissue < 1 || $self->payissue > 99;
1472 $self->paystart_month('');
1473 $self->paystart_year('');
1474 $self->payissue('');
1477 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1479 my $payinfo = $self->payinfo;
1480 $payinfo =~ s/[^\d\@]//g;
1481 if ( $conf->exists('echeck-nonus') ) {
1482 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1483 $payinfo = "$1\@$2";
1485 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1486 $payinfo = "$1\@$2";
1488 $self->payinfo($payinfo);
1491 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1493 return 'Banned ACH account: banned on '.
1494 time2str('%a %h %o at %r', $ban->_date).
1495 ' by '. $ban->otaker.
1496 ' (ban# '. $ban->bannum. ')';
1499 } elsif ( $self->payby eq 'LECB' ) {
1501 my $payinfo = $self->payinfo;
1502 $payinfo =~ s/\D//g;
1503 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1505 $self->payinfo($payinfo);
1508 } elsif ( $self->payby eq 'BILL' ) {
1510 $error = $self->ut_textn('payinfo');
1511 return "Illegal P.O. number: ". $self->payinfo if $error;
1514 } elsif ( $self->payby eq 'COMP' ) {
1516 my $curuser = $FS::CurrentUser::CurrentUser;
1517 if ( ! $self->custnum
1518 && ! $curuser->access_right('Complimentary customer')
1521 return "You are not permitted to create complimentary accounts."
1524 $error = $self->ut_textn('payinfo');
1525 return "Illegal comp account issuer: ". $self->payinfo if $error;
1528 } elsif ( $self->payby eq 'PREPAY' ) {
1530 my $payinfo = $self->payinfo;
1531 $payinfo =~ s/\W//g; #anything else would just confuse things
1532 $self->payinfo($payinfo);
1533 $error = $self->ut_alpha('payinfo');
1534 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1535 return "Unknown prepayment identifier"
1536 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1541 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1542 return "Expiration date required"
1543 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1547 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1548 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1549 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1550 ( $m, $y ) = ( $3, "20$2" );
1552 return "Illegal expiration date: ". $self->paydate;
1554 $self->paydate("$y-$m-01");
1555 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1556 return gettext('expired_card')
1558 && !$ignore_expired_card
1559 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1562 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1563 ( ! $conf->exists('require_cardname')
1564 || $self->payby !~ /^(CARD|DCRD)$/ )
1566 $self->payname( $self->first. " ". $self->getfield('last') );
1568 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1569 or return gettext('illegal_name'). " payname: ". $self->payname;
1573 foreach my $flag (qw( tax spool_cdr squelch_cdr )) {
1574 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1578 $self->otaker(getotaker) unless $self->otaker;
1580 warn "$me check AFTER: \n". $self->_dump
1583 $self->SUPER::check;
1588 Returns a list of fields which have ship_ duplicates.
1593 qw( last first company
1594 address1 address2 city county state zip country
1599 =item has_ship_address
1601 Returns true if this customer record has a separate shipping address.
1605 sub has_ship_address {
1607 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1612 Returns all packages (see L<FS::cust_pkg>) for this customer.
1619 return $self->num_pkgs unless wantarray;
1622 if ( $self->{'_pkgnum'} ) {
1623 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1625 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1628 sort sort_packages @cust_pkg;
1633 Synonym for B<all_pkgs>.
1638 shift->all_pkgs(@_);
1641 =item ncancelled_pkgs
1643 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1647 sub ncancelled_pkgs {
1650 return $self->num_ncancelled_pkgs unless wantarray;
1653 if ( $self->{'_pkgnum'} ) {
1655 warn "$me ncancelled_pkgs: returning cached objects"
1658 @cust_pkg = grep { ! $_->getfield('cancel') }
1659 values %{ $self->{'_pkgnum'}->cache };
1663 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1664 $self->custnum. "\n"
1668 qsearch( 'cust_pkg', {
1669 'custnum' => $self->custnum,
1673 qsearch( 'cust_pkg', {
1674 'custnum' => $self->custnum,
1679 sort sort_packages @cust_pkg;
1683 # This should be generalized to use config options to determine order.
1685 if ( $a->get('cancel') and $b->get('cancel') ) {
1686 $a->pkgnum <=> $b->pkgnum;
1687 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1688 return -1 if $b->get('cancel');
1689 return 1 if $a->get('cancel');
1692 $a->pkgnum <=> $b->pkgnum;
1696 =item suspended_pkgs
1698 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1702 sub suspended_pkgs {
1704 grep { $_->susp } $self->ncancelled_pkgs;
1707 =item unflagged_suspended_pkgs
1709 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1710 customer (thouse packages without the `manual_flag' set).
1714 sub unflagged_suspended_pkgs {
1716 return $self->suspended_pkgs
1717 unless dbdef->table('cust_pkg')->column('manual_flag');
1718 grep { ! $_->manual_flag } $self->suspended_pkgs;
1721 =item unsuspended_pkgs
1723 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1728 sub unsuspended_pkgs {
1730 grep { ! $_->susp } $self->ncancelled_pkgs;
1733 =item num_cancelled_pkgs
1735 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1740 sub num_cancelled_pkgs {
1741 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1744 sub num_ncancelled_pkgs {
1745 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1749 my( $self ) = shift;
1750 my $sql = scalar(@_) ? shift : '';
1751 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1752 my $sth = dbh->prepare(
1753 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1754 ) or die dbh->errstr;
1755 $sth->execute($self->custnum) or die $sth->errstr;
1756 $sth->fetchrow_arrayref->[0];
1761 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1762 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1763 on success or a list of errors.
1769 grep { $_->unsuspend } $self->suspended_pkgs;
1774 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1776 Returns a list: an empty list on success or a list of errors.
1782 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1785 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1787 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1788 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1789 of a list of pkgparts; the hashref has the following keys:
1793 =item pkgparts - listref of pkgparts
1795 =item (other options are passed to the suspend method)
1800 Returns a list: an empty list on success or a list of errors.
1804 sub suspend_if_pkgpart {
1806 my (@pkgparts, %opt);
1807 if (ref($_[0]) eq 'HASH'){
1808 @pkgparts = @{$_[0]{pkgparts}};
1813 grep { $_->suspend(%opt) }
1814 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1815 $self->unsuspended_pkgs;
1818 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1820 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1821 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1822 instead of a list of pkgparts; the hashref has the following keys:
1826 =item pkgparts - listref of pkgparts
1828 =item (other options are passed to the suspend method)
1832 Returns a list: an empty list on success or a list of errors.
1836 sub suspend_unless_pkgpart {
1838 my (@pkgparts, %opt);
1839 if (ref($_[0]) eq 'HASH'){
1840 @pkgparts = @{$_[0]{pkgparts}};
1845 grep { $_->suspend(%opt) }
1846 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1847 $self->unsuspended_pkgs;
1850 =item cancel [ OPTION => VALUE ... ]
1852 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1854 Available options are:
1858 =item quiet - can be set true to supress email cancellation notices.
1860 =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.
1862 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1866 Always returns a list: an empty list on success or a list of errors.
1871 my( $self, %opt ) = @_;
1873 warn "$me cancel called on customer ". $self->custnum. " with options ".
1874 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1877 return ( 'access denied' )
1878 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1880 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1882 #should try decryption (we might have the private key)
1883 # and if not maybe queue a job for the server that does?
1884 return ( "Can't (yet) ban encrypted credit cards" )
1885 if $self->is_encrypted($self->payinfo);
1887 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1888 my $error = $ban->insert;
1889 return ( $error ) if $error;
1893 my @pkgs = $self->ncancelled_pkgs;
1895 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1896 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1899 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1902 sub _banned_pay_hashref {
1913 'payby' => $payby2ban{$self->payby},
1914 'payinfo' => md5_base64($self->payinfo),
1915 #don't ever *search* on reason! #'reason' =>
1921 Returns all notes (see L<FS::cust_main_note>) for this customer.
1928 qsearch( 'cust_main_note',
1929 { 'custnum' => $self->custnum },
1931 'ORDER BY _DATE DESC'
1937 Returns the agent (see L<FS::agent>) for this customer.
1943 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1946 =item bill_and_collect
1948 Cancels and suspends any packages due, generates bills, applies payments and
1951 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1953 Options are passed as name-value pairs. Currently available options are:
1959 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:
1963 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1967 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.
1971 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1975 If set true, re-charges setup fees.
1979 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)
1985 sub bill_and_collect {
1986 my( $self, %options ) = @_;
1992 #$options{actual_time} not $options{time} because freeside-daily -d is for
1993 #pre-printing invoices
1994 my @cancel_pkgs = grep { $_->expire && $_->expire <= $options{actual_time} }
1995 $self->ncancelled_pkgs;
1997 foreach my $cust_pkg ( @cancel_pkgs ) {
1998 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
1999 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2000 'reason_otaker' => $cpr->otaker
2004 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2005 " for custnum ". $self->custnum. ": $error"
2013 #$options{actual_time} not $options{time} because freeside-daily -d is for
2014 #pre-printing invoices
2017 && ( ( $_->part_pkg->is_prepaid
2019 && $_->bill < $options{actual_time}
2022 && $_->adjourn <= $options{actual_time}
2026 $self->ncancelled_pkgs;
2028 foreach my $cust_pkg ( @susp_pkgs ) {
2029 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2030 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2031 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2032 'reason_otaker' => $cpr->otaker
2037 warn "Error suspending package ". $cust_pkg->pkgnum.
2038 " for custnum ". $self->custnum. ": $error"
2046 my $error = $self->bill( %options );
2047 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2049 $self->apply_payments_and_credits;
2051 $error = $self->collect( %options );
2052 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2058 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2059 conjunction with the collect method by calling B<bill_and_collect>.
2061 If there is an error, returns the error, otherwise returns false.
2063 Options are passed as name-value pairs. Currently available options are:
2069 If set true, re-charges setup fees.
2073 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:
2077 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2081 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2083 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2087 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.
2094 my( $self, %options ) = @_;
2095 return '' if $self->payby eq 'COMP';
2096 warn "$me bill customer ". $self->custnum. "\n"
2099 my $time = $options{'time'} || time;
2102 local $SIG{HUP} = 'IGNORE';
2103 local $SIG{INT} = 'IGNORE';
2104 local $SIG{QUIT} = 'IGNORE';
2105 local $SIG{TERM} = 'IGNORE';
2106 local $SIG{TSTP} = 'IGNORE';
2107 local $SIG{PIPE} = 'IGNORE';
2109 my $oldAutoCommit = $FS::UID::AutoCommit;
2110 local $FS::UID::AutoCommit = 0;
2113 $self->select_for_update; #mutex
2115 my @cust_bill_pkg = ();
2118 # find the packages which are due for billing, find out how much they are
2119 # & generate invoice database.
2122 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2126 my @precommit_hooks = ();
2128 my @cust_pkgs = qsearch('cust_pkg', { 'custnum' => $self->custnum } );
2129 foreach my $cust_pkg (@cust_pkgs) {
2131 #NO!! next if $cust_pkg->cancel;
2132 next if $cust_pkg->getfield('cancel');
2134 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2136 #? to avoid use of uninitialized value errors... ?
2137 $cust_pkg->setfield('bill', '')
2138 unless defined($cust_pkg->bill);
2140 #my $part_pkg = $cust_pkg->part_pkg;
2142 my $real_pkgpart = $cust_pkg->pkgpart;
2143 my %hash = $cust_pkg->hash;
2145 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2147 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2150 $self->_make_lines( 'part_pkg' => $part_pkg,
2151 'cust_pkg' => $cust_pkg,
2152 'precommit_hooks' => \@precommit_hooks,
2153 'line_items' => \@cust_bill_pkg,
2154 'setup' => \$total_setup,
2155 'recur' => \$total_recur,
2156 'tax_matrix' => \%taxlisthash,
2158 'options' => \%options,
2161 $dbh->rollback if $oldAutoCommit;
2165 } #foreach my $part_pkg
2167 } #foreach my $cust_pkg
2169 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2170 #but do commit any package date cycling that happened
2171 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2175 my $postal_pkg = $self->charge_postal_fee();
2176 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2177 $dbh->rollback if $oldAutoCommit;
2178 return "can't charge postal invoice fee for customer ".
2179 $self->custnum. ": $postal_pkg";
2182 ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2183 !$conf->exists('postal_invoice-recurring_only')
2187 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2189 $self->_make_lines( 'part_pkg' => $part_pkg,
2190 'cust_pkg' => $postal_pkg,
2191 'precommit_hooks' => \@precommit_hooks,
2192 'line_items' => \@cust_bill_pkg,
2193 'setup' => \$total_setup,
2194 'recur' => \$total_recur,
2195 'tax_matrix' => \%taxlisthash,
2197 'options' => \%options,
2200 $dbh->rollback if $oldAutoCommit;
2206 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2207 foreach my $tax ( keys %taxlisthash ) {
2208 my $tax_object = shift @{ $taxlisthash{$tax} };
2209 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2210 my $listref_or_error = $tax_object->taxline( @{ $taxlisthash{$tax} } );
2211 unless (ref($listref_or_error)) {
2212 $dbh->rollback if $oldAutoCommit;
2213 return $listref_or_error;
2215 unshift @{ $taxlisthash{$tax} }, $tax_object;
2217 warn "adding ". $listref_or_error->[1].
2218 " as ". $listref_or_error->[0]. "\n"
2220 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2221 if ( $taxname{ $listref_or_error->[0] } ) {
2222 push @{ $taxname{ $listref_or_error->[0] } }, $tax_object->taxname;
2224 $taxname{ $listref_or_error->[0] } = [ $tax_object->taxname ];
2229 #some taxes are taxed
2232 warn "finding taxed taxes...\n" if $DEBUG > 2;
2233 foreach my $tax ( keys %taxlisthash ) {
2234 my $tax_object = shift @{ $taxlisthash{$tax} };
2235 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
2237 next unless $tax_object->can('tax_on_tax');
2239 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
2240 my $totname = ref( $tot ). ' '. $tot->taxnum;
2242 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
2244 next unless exists( $taxlisthash{ $totname } ); # only increase
2246 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
2247 if ( exists( $totlisthash{ $totname } ) ) {
2248 push @{ $totlisthash{ $totname } }, $tax{ $tax_object->taxname };
2250 $totlisthash{ $totname } = [ $tot, $tax{ $tax_object->taxname } ];
2255 warn "having a look at taxed taxes...\n" if $DEBUG > 2;
2256 foreach my $tax ( keys %totlisthash ) {
2257 my $tax_object = shift @{ $totlisthash{$tax} };
2258 warn "found previously found taxed tax ". $tax_object->taxname. "\n"
2260 my $listref_or_error = $tax_object->taxline( @{ $totlisthash{$tax} } );
2261 unless (ref($listref_or_error)) {
2262 $dbh->rollback if $oldAutoCommit;
2263 return $listref_or_error;
2266 warn "adding taxed tax amount ". $listref_or_error->[1].
2267 " as ". $tax_object->taxname. "\n"
2269 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2272 #consolidate and create tax line items
2273 warn "consolidating and generating...\n" if $DEBUG > 2;
2274 foreach my $taxname ( keys %taxname ) {
2277 warn "adding $taxname\n" if $DEBUG > 1;
2278 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2279 $tax += $tax{$taxitem} unless $seen{$taxitem};
2280 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2284 $tax = sprintf('%.2f', $tax );
2285 $total_setup = sprintf('%.2f', $total_setup+$tax );
2287 push @cust_bill_pkg, new FS::cust_bill_pkg {
2293 'itemdesc' => $taxname,
2298 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2300 #create the new invoice
2301 my $cust_bill = new FS::cust_bill ( {
2302 'custnum' => $self->custnum,
2303 '_date' => ( $options{'invoice_time'} || $time ),
2304 'charged' => $charged,
2306 my $error = $cust_bill->insert;
2308 $dbh->rollback if $oldAutoCommit;
2309 return "can't create invoice for customer #". $self->custnum. ": $error";
2312 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2313 $cust_bill_pkg->invnum($cust_bill->invnum);
2314 my $error = $cust_bill_pkg->insert;
2316 $dbh->rollback if $oldAutoCommit;
2317 return "can't create invoice line item: $error";
2322 foreach my $hook ( @precommit_hooks ) {
2324 &{$hook}; #($self) ?
2327 $dbh->rollback if $oldAutoCommit;
2328 return "$@ running precommit hook $hook\n";
2332 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2338 my ($self, %params) = @_;
2340 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2341 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2342 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2343 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2344 my $total_setup = $params{setup} or die "no setup accumulator specified";
2345 my $total_recur = $params{recur} or die "no recur accumulator specified";
2346 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2347 my $time = $params{'time'} or die "no time specified";
2348 my (%options) = %{$params{options}}; #hmmm only for 'resetup'
2351 my $real_pkgpart = $cust_pkg->pkgpart;
2352 my %hash = $cust_pkg->hash;
2353 my $old_cust_pkg = new FS::cust_pkg \%hash;
2359 $cust_pkg->pkgpart($part_pkg->pkgpart);
2367 if ( ! $cust_pkg->setup &&
2369 ( $conf->exists('disable_setup_suspended_pkgs') &&
2370 ! $cust_pkg->getfield('susp')
2371 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2373 || $options{'resetup'}
2376 warn " bill setup\n" if $DEBUG > 1;
2379 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2380 return "$@ running calc_setup for $cust_pkg\n"
2383 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2385 $cust_pkg->setfield('setup', $time)
2386 unless $cust_pkg->setup;
2387 #do need it, but it won't get written to the db
2388 #|| $cust_pkg->pkgpart != $real_pkgpart;
2393 # bill recurring fee
2396 #XXX unit stuff here too
2400 if ( ! $cust_pkg->getfield('susp') and
2401 ( $part_pkg->getfield('freq') ne '0' &&
2402 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2404 || ( $part_pkg->plan eq 'voip_cdr'
2405 && $part_pkg->option('bill_every_call')
2409 # XXX should this be a package event? probably. events are called
2410 # at collection time at the moment, though...
2411 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2412 if $part_pkg->can('reset_usage');
2413 #don't want to reset usage just cause we want a line item??
2414 #&& $part_pkg->pkgpart == $real_pkgpart;
2416 warn " bill recur\n" if $DEBUG > 1;
2419 # XXX shared with $recur_prog
2420 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2422 #over two params! lets at least switch to a hashref for the rest...
2423 my $increment_next_bill = ( $part_pkg->freq ne '0'
2424 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2426 my %param = ( 'precommit_hooks' => $precommit_hooks,
2427 'increment_next_bill' => $increment_next_bill,
2430 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2431 return "$@ running calc_recur for $cust_pkg\n"
2434 if ( $increment_next_bill ) {
2436 #change this bit to use Date::Manip? CAREFUL with timezones (see
2437 # mailing list archive)
2438 my ($sec,$min,$hour,$mday,$mon,$year) =
2439 (localtime($sdate) )[0,1,2,3,4,5];
2441 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2442 # only for figuring next bill date, nothing else, so, reset $sdate again
2444 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2445 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2446 $cust_pkg->last_bill($sdate);
2448 if ( $part_pkg->freq =~ /^\d+$/ ) {
2449 $mon += $part_pkg->freq;
2450 until ( $mon < 12 ) { $mon -= 12; $year++; }
2451 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2453 $mday += $weeks * 7;
2454 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2457 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2461 return "unparsable frequency: ". $part_pkg->freq;
2463 $cust_pkg->setfield('bill',
2464 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2470 warn "\$setup is undefined" unless defined($setup);
2471 warn "\$recur is undefined" unless defined($recur);
2472 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2475 # If there's line items, create em cust_bill_pkg records
2476 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2481 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2482 # hmm.. and if just the options are modified in some weird price plan?
2484 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2487 my $error = $cust_pkg->replace( $old_cust_pkg,
2488 'options' => { $cust_pkg->options },
2490 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2491 if $error; #just in case
2494 $setup = sprintf( "%.2f", $setup );
2495 $recur = sprintf( "%.2f", $recur );
2496 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2497 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2499 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2500 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2503 if ( $setup != 0 || $recur != 0 ) {
2505 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2508 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2510 warn " adding customer package invoice detail: $_\n"
2511 foreach @cust_pkg_detail;
2513 push @details, @cust_pkg_detail;
2515 my $cust_bill_pkg = new FS::cust_bill_pkg {
2516 'pkgnum' => $cust_pkg->pkgnum,
2518 'unitsetup' => $unitsetup,
2520 'unitrecur' => $unitrecur,
2521 'quantity' => $cust_pkg->quantity,
2522 'details' => \@details,
2525 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2526 $cust_bill_pkg->sdate( $hash{last_bill} );
2527 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2528 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2529 $cust_bill_pkg->sdate( $sdate );
2530 $cust_bill_pkg->edate( $cust_pkg->bill );
2533 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2534 unless $part_pkg->pkgpart == $real_pkgpart;
2536 $$total_setup += $setup;
2537 $$total_recur += $recur;
2544 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg);
2545 return $error if $error;
2547 push @$cust_bill_pkgs, $cust_bill_pkg;
2549 } #if $setup != 0 || $recur != 0
2559 my $part_pkg = shift;
2560 my $taxlisthash = shift;
2561 my $cust_bill_pkg = shift;
2562 my $cust_pkg = shift;
2564 my %cust_bill_pkg = ();
2568 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2573 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
2574 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
2575 push @classes, 'setup' if $cust_bill_pkg->setup;
2576 push @classes, 'recur' if $cust_bill_pkg->recur;
2578 if ( $conf->exists('enable_taxproducts')
2579 && (scalar($part_pkg->part_pkg_taxoverride) || $part_pkg->has_taxproduct)
2580 && ( $self->tax !~ /Y/i && $self->payby ne 'COMP' )
2584 foreach my $class (@classes) {
2585 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $prefix );
2586 return $err_or_ref unless ref($err_or_ref);
2587 $taxes{$class} = $err_or_ref;
2590 unless (exists $taxes{''}) {
2591 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $prefix );
2592 return $err_or_ref unless ref($err_or_ref);
2593 $taxes{''} = $err_or_ref;
2596 } elsif ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
2598 my %taxhash = map { $_ => $self->get("$prefix$_") }
2599 qw( state county country );
2601 $taxhash{'taxclass'} = $part_pkg->taxclass;
2603 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2606 $taxhash{'taxclass'} = '';
2607 @taxes = qsearch( 'cust_main_county', \%taxhash );
2610 #one more try at a whole-country tax rate
2612 $taxhash{$_} = '' foreach qw( state county );
2613 @taxes = qsearch( 'cust_main_county', \%taxhash );
2616 $taxes{''} = [ @taxes ];
2617 $taxes{'setup'} = [ @taxes ];
2618 $taxes{'recur'} = [ @taxes ];
2619 $taxes{$_} = [ @taxes ] foreach (@classes);
2621 # maybe eliminate this entirely, along with all the 0% records
2624 "fatal: can't find tax rate for state/county/country/taxclass ".
2625 join('/', ( map $self->get("$prefix$_"),
2626 qw(state county country)
2628 $part_pkg->taxclass ). "\n";
2631 } #if $conf->exists('enable_taxproducts') ...
2634 if ( $conf->exists('separate_usage') ) {
2635 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
2636 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
2637 push @display, new FS::cust_bill_pkg_display { type => 'S' };
2638 push @display, new FS::cust_bill_pkg_display { type => 'R' };
2639 push @display, new FS::cust_bill_pkg_display { type => 'U',
2642 if ($section && $summary) {
2643 $display[2]->post_total('Y');
2644 push @display, new FS::cust_bill_pkg_display { type => 'U',
2649 $cust_bill_pkg->set('display', \@display);
2651 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
2652 foreach my $key (keys %tax_cust_bill_pkg) {
2653 my @taxes = @{ $taxes{$key} || [] };
2654 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
2656 foreach my $tax ( @taxes ) {
2657 my $taxname = ref( $tax ). ' '. $tax->taxnum;
2658 if ( exists( $taxlisthash->{ $taxname } ) ) {
2659 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
2661 $taxlisthash->{ $taxname } = [ $tax, $tax_cust_bill_pkg ];
2671 my $part_pkg = shift;
2676 my $geocode = $self->geocode('cch');
2678 my @taxclassnums = map { $_->taxclassnum }
2679 $part_pkg->part_pkg_taxoverride($class);
2681 unless (@taxclassnums) {
2682 @taxclassnums = map { $_->taxclassnum }
2683 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
2685 warn "Found taxclassnum values of ". join(',', @taxclassnums)
2690 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2692 @taxes = qsearch({ 'table' => 'tax_rate',
2693 'hashref' => { 'geocode' => $geocode, },
2694 'extra_sql' => $extra_sql,
2696 if scalar(@taxclassnums);
2698 # maybe eliminate this entirely, along with all the 0% records
2701 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2702 join('/', ( map $self->get("$prefix$_"),
2705 $part_pkg->taxproduct_description,
2706 $part_pkg->pkgpart ). "\n";
2709 warn "Found taxes ".
2710 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
2717 =item collect OPTIONS
2719 (Attempt to) collect money for this customer's outstanding invoices (see
2720 L<FS::cust_bill>). Usually used after the bill method.
2722 Actions are now triggered by billing events; see L<FS::part_event> and the
2723 billing events web interface. Old-style invoice events (see
2724 L<FS::part_bill_event>) have been deprecated.
2726 If there is an error, returns the error, otherwise returns false.
2728 Options are passed as name-value pairs.
2730 Currently available options are:
2736 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.
2740 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2744 set true to surpress email card/ACH decline notices.
2748 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2752 allows for one time override of normal customer billing method
2756 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)
2764 my( $self, %options ) = @_;
2765 my $invoice_time = $options{'invoice_time'} || time;
2768 local $SIG{HUP} = 'IGNORE';
2769 local $SIG{INT} = 'IGNORE';
2770 local $SIG{QUIT} = 'IGNORE';
2771 local $SIG{TERM} = 'IGNORE';
2772 local $SIG{TSTP} = 'IGNORE';
2773 local $SIG{PIPE} = 'IGNORE';
2775 my $oldAutoCommit = $FS::UID::AutoCommit;
2776 local $FS::UID::AutoCommit = 0;
2779 $self->select_for_update; #mutex
2782 my $balance = $self->balance;
2783 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2786 if ( exists($options{'retry_card'}) ) {
2787 carp 'retry_card option passed to collect is deprecated; use retry';
2788 $options{'retry'} ||= $options{'retry_card'};
2790 if ( exists($options{'retry'}) && $options{'retry'} ) {
2791 my $error = $self->retry_realtime;
2793 $dbh->rollback if $oldAutoCommit;
2798 # false laziness w/pay_batch::import_results
2800 my $due_cust_event = $self->due_cust_event(
2801 'debug' => ( $options{'debug'} || 0 ),
2802 'time' => $invoice_time,
2803 'check_freq' => $options{'check_freq'},
2805 unless( ref($due_cust_event) ) {
2806 $dbh->rollback if $oldAutoCommit;
2807 return $due_cust_event;
2810 foreach my $cust_event ( @$due_cust_event ) {
2814 #re-eval event conditions (a previous event could have changed things)
2815 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2816 #don't leave stray "new/locked" records around
2817 my $error = $cust_event->delete;
2819 #gah, even with transactions
2820 $dbh->commit if $oldAutoCommit; #well.
2827 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2828 warn " running cust_event ". $cust_event->eventnum. "\n"
2832 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2833 if ( my $error = $cust_event->do_event() ) {
2834 #XXX wtf is this? figure out a proper dealio with return value
2836 # gah, even with transactions.
2837 $dbh->commit if $oldAutoCommit; #well.
2844 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2849 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2851 Inserts database records for and returns an ordered listref of new events due
2852 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2853 events are due, an empty listref is returned. If there is an error, returns a
2854 scalar error message.
2856 To actually run the events, call each event's test_condition method, and if
2857 still true, call the event's do_event method.
2859 Options are passed as a hashref or as a list of name-value pairs. Available
2866 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.
2870 "Current time" for the events.
2874 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)
2878 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2882 Explicitly pass the objects to be tested (typically used with eventtable).
2888 sub due_cust_event {
2890 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2893 #my $DEBUG = $opt{'debug'}
2894 local($DEBUG) = $opt{'debug'}
2895 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2897 warn "$me due_cust_event called with options ".
2898 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2901 $opt{'time'} ||= time;
2903 local $SIG{HUP} = 'IGNORE';
2904 local $SIG{INT} = 'IGNORE';
2905 local $SIG{QUIT} = 'IGNORE';
2906 local $SIG{TERM} = 'IGNORE';
2907 local $SIG{TSTP} = 'IGNORE';
2908 local $SIG{PIPE} = 'IGNORE';
2910 my $oldAutoCommit = $FS::UID::AutoCommit;
2911 local $FS::UID::AutoCommit = 0;
2914 $self->select_for_update; #mutex
2917 # 1: find possible events (initial search)
2920 my @cust_event = ();
2922 my @eventtable = $opt{'eventtable'}
2923 ? ( $opt{'eventtable'} )
2924 : FS::part_event->eventtables_runorder;
2926 foreach my $eventtable ( @eventtable ) {
2929 if ( $opt{'objects'} ) {
2931 @objects = @{ $opt{'objects'} };
2935 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2936 @objects = ( $eventtable eq 'cust_main' )
2938 : ( $self->$eventtable() );
2942 my @e_cust_event = ();
2944 my $cross = "CROSS JOIN $eventtable";
2945 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2946 unless $eventtable eq 'cust_main';
2948 foreach my $object ( @objects ) {
2950 #this first search uses the condition_sql magic for optimization.
2951 #the more possible events we can eliminate in this step the better
2953 my $cross_where = '';
2954 my $pkey = $object->primary_key;
2955 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2957 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2959 FS::part_event_condition->where_conditions_sql( $eventtable,
2960 'time'=>$opt{'time'}
2962 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2964 $extra_sql = "AND $extra_sql" if $extra_sql;
2966 #here is the agent virtualization
2967 $extra_sql .= " AND ( part_event.agentnum IS NULL
2968 OR part_event.agentnum = ". $self->agentnum. ' )';
2970 $extra_sql .= " $order";
2972 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2973 if $opt{'debug'} > 2;
2974 my @part_event = qsearch( {
2975 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2976 'select' => 'part_event.*',
2977 'table' => 'part_event',
2978 'addl_from' => "$cross $join",
2979 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2980 'eventtable' => $eventtable,
2983 'extra_sql' => "AND $cross_where $extra_sql",
2987 my $pkey = $object->primary_key;
2988 warn " ". scalar(@part_event).
2989 " possible events found for $eventtable ". $object->$pkey(). "\n";
2992 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2996 warn " ". scalar(@e_cust_event).
2997 " subtotal possible cust events found for $eventtable\n"
3000 push @cust_event, @e_cust_event;
3004 warn " ". scalar(@cust_event).
3005 " total possible cust events found in initial search\n"
3009 # 2: test conditions
3014 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3015 'stats_hashref' => \%unsat ),
3018 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3021 warn " invalid conditions not eliminated with condition_sql:\n".
3022 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3029 unless( $opt{testonly} ) {
3030 foreach my $cust_event ( @cust_event ) {
3032 my $error = $cust_event->insert();
3034 $dbh->rollback if $oldAutoCommit;
3041 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3047 warn " returning events: ". Dumper(@cust_event). "\n"
3054 =item retry_realtime
3056 Schedules realtime / batch credit card / electronic check / LEC billing
3057 events for for retry. Useful if card information has changed or manual
3058 retry is desired. The 'collect' method must be called to actually retry
3061 Implementation details: For either this customer, or for each of this
3062 customer's open invoices, changes the status of the first "done" (with
3063 statustext error) realtime processing event to "failed".
3067 sub retry_realtime {
3070 local $SIG{HUP} = 'IGNORE';
3071 local $SIG{INT} = 'IGNORE';
3072 local $SIG{QUIT} = 'IGNORE';
3073 local $SIG{TERM} = 'IGNORE';
3074 local $SIG{TSTP} = 'IGNORE';
3075 local $SIG{PIPE} = 'IGNORE';
3077 my $oldAutoCommit = $FS::UID::AutoCommit;
3078 local $FS::UID::AutoCommit = 0;
3081 #a little false laziness w/due_cust_event (not too bad, really)
3083 my $join = FS::part_event_condition->join_conditions_sql;
3084 my $order = FS::part_event_condition->order_conditions_sql;
3087 . join ( ' OR ' , map {
3088 "( part_event.eventtable = " . dbh->quote($_)
3089 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3090 } FS::part_event->eventtables)
3093 #here is the agent virtualization
3094 my $agent_virt = " ( part_event.agentnum IS NULL
3095 OR part_event.agentnum = ". $self->agentnum. ' )';
3097 #XXX this shouldn't be hardcoded, actions should declare it...
3098 my @realtime_events = qw(
3099 cust_bill_realtime_card
3100 cust_bill_realtime_check
3101 cust_bill_realtime_lec
3105 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3110 my @cust_event = qsearchs({
3111 'table' => 'cust_event',
3112 'select' => 'cust_event.*',
3113 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3114 'hashref' => { 'status' => 'done' },
3115 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3116 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3119 my %seen_invnum = ();
3120 foreach my $cust_event (@cust_event) {
3122 #max one for the customer, one for each open invoice
3123 my $cust_X = $cust_event->cust_X;
3124 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3128 or $cust_event->part_event->eventtable eq 'cust_bill'
3131 my $error = $cust_event->retry;
3133 $dbh->rollback if $oldAutoCommit;
3134 return "error scheduling event for retry: $error";
3139 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3144 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3146 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3147 via a Business::OnlinePayment realtime gateway. See
3148 L<http://420.am/business-onlinepayment> for supported gateways.
3150 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3152 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3154 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3155 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3156 if set, will override the value from the customer record.
3158 I<description> is a free-text field passed to the gateway. It defaults to
3159 "Internet services".
3161 If an I<invnum> is specified, this payment (if successful) is applied to the
3162 specified invoice. If you don't specify an I<invnum> you might want to
3163 call the B<apply_payments> method.
3165 I<quiet> can be set true to surpress email decline notices.
3167 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3168 resulting paynum, if any.
3170 I<payunique> is a unique identifier for this payment.
3172 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3177 my( $self, $method, $amount, %options ) = @_;
3179 warn "$me realtime_bop: $method $amount\n";
3180 warn " $_ => $options{$_}\n" foreach keys %options;
3183 $options{'description'} ||= 'Internet services';
3185 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3187 eval "use Business::OnlinePayment";
3190 my $payinfo = exists($options{'payinfo'})
3191 ? $options{'payinfo'}
3194 my %method2payby = (
3201 # check for banned credit card/ACH
3204 my $ban = qsearchs('banned_pay', {
3205 'payby' => $method2payby{$method},
3206 'payinfo' => md5_base64($payinfo),
3208 return "Banned credit card" if $ban;
3215 if ( $options{'invnum'} ) {
3216 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3217 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3219 map { $_->part_pkg->taxclass }
3221 map { $_->cust_pkg }
3222 $cust_bill->cust_bill_pkg;
3223 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
3224 #different taxclasses
3225 $taxclass = $taxclasses[0];
3229 #look for an agent gateway override first
3231 if ( $method eq 'CC' ) {
3232 $cardtype = cardtype($payinfo);
3233 } elsif ( $method eq 'ECHECK' ) {
3236 $cardtype = $method;
3240 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3241 cardtype => $cardtype,
3242 taxclass => $taxclass, } )
3243 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3245 taxclass => $taxclass, } )
3246 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3247 cardtype => $cardtype,
3249 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3251 taxclass => '', } );
3253 my $payment_gateway = '';
3254 my( $processor, $login, $password, $action, @bop_options );
3255 if ( $override ) { #use a payment gateway override
3257 $payment_gateway = $override->payment_gateway;
3259 $processor = $payment_gateway->gateway_module;
3260 $login = $payment_gateway->gateway_username;
3261 $password = $payment_gateway->gateway_password;
3262 $action = $payment_gateway->gateway_action;
3263 @bop_options = $payment_gateway->options;
3265 } else { #use the standard settings from the config
3267 ( $processor, $login, $password, $action, @bop_options ) =
3268 $self->default_payment_gateway($method);
3276 my $address = exists($options{'address1'})
3277 ? $options{'address1'}
3279 my $address2 = exists($options{'address2'})
3280 ? $options{'address2'}
3282 $address .= ", ". $address2 if length($address2);
3284 my $o_payname = exists($options{'payname'})
3285 ? $options{'payname'}
3287 my($payname, $payfirst, $paylast);
3288 if ( $o_payname && $method ne 'ECHECK' ) {
3289 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3290 or return "Illegal payname $payname";
3291 ($payfirst, $paylast) = ($1, $2);
3293 $payfirst = $self->getfield('first');
3294 $paylast = $self->getfield('last');
3295 $payname = "$payfirst $paylast";
3298 my @invoicing_list = $self->invoicing_list_emailonly;
3299 if ( $conf->exists('emailinvoiceautoalways')
3300 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3301 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3302 push @invoicing_list, $self->all_emails;
3305 my $email = ($conf->exists('business-onlinepayment-email-override'))
3306 ? $conf->config('business-onlinepayment-email-override')
3307 : $invoicing_list[0];
3311 my $payip = exists($options{'payip'})
3314 $content{customer_ip} = $payip
3317 $content{invoice_number} = $options{'invnum'}
3318 if exists($options{'invnum'}) && length($options{'invnum'});
3320 $content{email_customer} =
3321 ( $conf->exists('business-onlinepayment-email_customer')
3322 || $conf->exists('business-onlinepayment-email-override') );
3325 if ( $method eq 'CC' ) {
3327 $content{card_number} = $payinfo;
3328 $paydate = exists($options{'paydate'})
3329 ? $options{'paydate'}
3331 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3332 $content{expiration} = "$2/$1";
3334 my $paycvv = exists($options{'paycvv'})
3335 ? $options{'paycvv'}
3337 $content{cvv2} = $paycvv
3340 my $paystart_month = exists($options{'paystart_month'})
3341 ? $options{'paystart_month'}
3342 : $self->paystart_month;
3344 my $paystart_year = exists($options{'paystart_year'})
3345 ? $options{'paystart_year'}
3346 : $self->paystart_year;
3348 $content{card_start} = "$paystart_month/$paystart_year"
3349 if $paystart_month && $paystart_year;
3351 my $payissue = exists($options{'payissue'})
3352 ? $options{'payissue'}
3354 $content{issue_number} = $payissue if $payissue;
3356 $content{recurring_billing} = 'YES'
3357 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3359 'payinfo' => $payinfo,
3361 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3363 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3367 } elsif ( $method eq 'ECHECK' ) {
3368 ( $content{account_number}, $content{routing_code} ) =
3369 split('@', $payinfo);
3370 $content{bank_name} = $o_payname;
3371 $content{bank_state} = exists($options{'paystate'})
3372 ? $options{'paystate'}
3373 : $self->getfield('paystate');
3374 $content{account_type} = exists($options{'paytype'})
3375 ? uc($options{'paytype'}) || 'CHECKING'
3376 : uc($self->getfield('paytype')) || 'CHECKING';
3377 $content{account_name} = $payname;
3378 $content{customer_org} = $self->company ? 'B' : 'I';
3379 $content{state_id} = exists($options{'stateid'})
3380 ? $options{'stateid'}
3381 : $self->getfield('stateid');
3382 $content{state_id_state} = exists($options{'stateid_state'})
3383 ? $options{'stateid_state'}
3384 : $self->getfield('stateid_state');
3385 $content{customer_ssn} = exists($options{'ss'})
3388 } elsif ( $method eq 'LEC' ) {
3389 $content{phone} = $payinfo;
3393 # run transaction(s)
3396 my $balance = exists( $options{'balance'} )
3397 ? $options{'balance'}
3400 $self->select_for_update; #mutex ... just until we get our pending record in
3402 #the checks here are intended to catch concurrent payments
3403 #double-form-submission prevention is taken care of in cust_pay_pending::check
3406 return "The customer's balance has changed; $method transaction aborted."
3407 if $self->balance < $balance;
3408 #&& $self->balance < $amount; #might as well anyway?
3410 #also check and make sure there aren't *other* pending payments for this cust
3412 my @pending = qsearch('cust_pay_pending', {
3413 'custnum' => $self->custnum,
3414 'status' => { op=>'!=', value=>'done' }
3416 return "A payment is already being processed for this customer (".
3417 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3418 "); $method transaction aborted."
3419 if scalar(@pending);
3421 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3423 my $cust_pay_pending = new FS::cust_pay_pending {
3424 'custnum' => $self->custnum,
3425 #'invnum' => $options{'invnum'},
3428 'payby' => $method2payby{$method},
3429 'payinfo' => $payinfo,
3430 'paydate' => $paydate,
3432 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3434 $cust_pay_pending->payunique( $options{payunique} )
3435 if defined($options{payunique}) && length($options{payunique});
3436 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3437 return $cpp_new_err if $cpp_new_err;
3439 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3441 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3442 $transaction->content(
3445 'password' => $password,
3446 'action' => $action1,
3447 'description' => $options{'description'},
3448 'amount' => $amount,
3449 #'invoice_number' => $options{'invnum'},
3450 'customer_id' => $self->custnum,
3451 'last_name' => $paylast,
3452 'first_name' => $payfirst,
3454 'address' => $address,
3455 'city' => ( exists($options{'city'})
3458 'state' => ( exists($options{'state'})
3461 'zip' => ( exists($options{'zip'})
3464 'country' => ( exists($options{'country'})
3465 ? $options{'country'}
3467 'referer' => 'http://cleanwhisker.420.am/',
3469 'phone' => $self->daytime || $self->night,
3473 $cust_pay_pending->status('pending');
3474 my $cpp_pending_err = $cust_pay_pending->replace;
3475 return $cpp_pending_err if $cpp_pending_err;
3478 my $BOP_TESTING = 0;
3479 my $BOP_TESTING_SUCCESS = 1;
3481 unless ( $BOP_TESTING ) {
3482 $transaction->submit();
3484 if ( $BOP_TESTING_SUCCESS ) {
3485 $transaction->is_success(1);
3486 $transaction->authorization('fake auth');
3488 $transaction->is_success(0);
3489 $transaction->error_message('fake failure');
3493 if ( $transaction->is_success() && $action2 ) {
3495 $cust_pay_pending->status('authorized');
3496 my $cpp_authorized_err = $cust_pay_pending->replace;
3497 return $cpp_authorized_err if $cpp_authorized_err;
3499 my $auth = $transaction->authorization;
3500 my $ordernum = $transaction->can('order_number')
3501 ? $transaction->order_number
3505 new Business::OnlinePayment( $processor, @bop_options );
3512 password => $password,
3513 order_number => $ordernum,
3515 authorization => $auth,
3516 description => $options{'description'},
3519 foreach my $field (qw( authorization_source_code returned_ACI
3520 transaction_identifier validation_code
3521 transaction_sequence_num local_transaction_date
3522 local_transaction_time AVS_result_code )) {
3523 $capture{$field} = $transaction->$field() if $transaction->can($field);
3526 $capture->content( %capture );
3530 unless ( $capture->is_success ) {
3531 my $e = "Authorization successful but capture failed, custnum #".
3532 $self->custnum. ': '. $capture->result_code.
3533 ": ". $capture->error_message;
3540 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3541 my $cpp_captured_err = $cust_pay_pending->replace;
3542 return $cpp_captured_err if $cpp_captured_err;
3545 # remove paycvv after initial transaction
3548 #false laziness w/misc/process/payment.cgi - check both to make sure working
3550 if ( defined $self->dbdef_table->column('paycvv')
3551 && length($self->paycvv)
3552 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3554 my $error = $self->remove_cvv;
3556 warn "WARNING: error removing cvv: $error\n";
3564 if ( $transaction->is_success() ) {
3567 if ( $payment_gateway ) { # agent override
3568 $paybatch = $payment_gateway->gatewaynum. '-';
3571 $paybatch .= "$processor:". $transaction->authorization;
3573 $paybatch .= ':'. $transaction->order_number
3574 if $transaction->can('order_number')
3575 && length($transaction->order_number);
3577 my $cust_pay = new FS::cust_pay ( {
3578 'custnum' => $self->custnum,
3579 'invnum' => $options{'invnum'},
3582 'payby' => $method2payby{$method},
3583 'payinfo' => $payinfo,
3584 'paybatch' => $paybatch,
3585 'paydate' => $paydate,
3587 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3588 $cust_pay->payunique( $options{payunique} )
3589 if defined($options{payunique}) && length($options{payunique});
3591 my $oldAutoCommit = $FS::UID::AutoCommit;
3592 local $FS::UID::AutoCommit = 0;
3595 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3597 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3600 $cust_pay->invnum(''); #try again with no specific invnum
3601 my $error2 = $cust_pay->insert( $options{'manual'} ?
3602 ( 'manual' => 1 ) : ()
3605 # gah. but at least we have a record of the state we had to abort in
3606 # from cust_pay_pending now.
3607 my $e = "WARNING: $method captured but payment not recorded - ".
3608 "error inserting payment ($processor): $error2".
3609 " (previously tried insert with invnum #$options{'invnum'}" .
3610 ": $error ) - pending payment saved as paypendingnum ".
3611 $cust_pay_pending->paypendingnum. "\n";
3617 if ( $options{'paynum_ref'} ) {
3618 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3621 $cust_pay_pending->status('done');
3622 $cust_pay_pending->statustext('captured');
3623 my $cpp_done_err = $cust_pay_pending->replace;
3625 if ( $cpp_done_err ) {
3627 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3628 my $e = "WARNING: $method captured but payment not recorded - ".
3629 "error updating status for paypendingnum ".
3630 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3636 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3637 return ''; #no error
3643 my $perror = "$processor error: ". $transaction->error_message;
3645 unless ( $transaction->error_message ) {
3648 if ( $transaction->can('response_page') ) {
3650 'page' => ( $transaction->can('response_page')
3651 ? $transaction->response_page
3654 'code' => ( $transaction->can('response_code')
3655 ? $transaction->response_code
3658 'headers' => ( $transaction->can('response_headers')
3659 ? $transaction->response_headers
3665 "No additional debugging information available for $processor";
3668 $perror .= "No error_message returned from $processor -- ".
3669 ( ref($t_response) ? Dumper($t_response) : $t_response );
3673 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3674 && $conf->exists('emaildecline')
3675 && grep { $_ ne 'POST' } $self->invoicing_list
3676 && ! grep { $transaction->error_message =~ /$_/ }
3677 $conf->config('emaildecline-exclude')
3679 my @templ = $conf->config('declinetemplate');
3680 my $template = new Text::Template (
3682 SOURCE => [ map "$_\n", @templ ],
3683 ) or return "($perror) can't create template: $Text::Template::ERROR";
3684 $template->compile()
3685 or return "($perror) can't compile template: $Text::Template::ERROR";
3687 my $templ_hash = { error => $transaction->error_message };
3689 my $error = send_email(
3690 'from' => $conf->config('invoice_from'),
3691 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3692 'subject' => 'Your payment could not be processed',
3693 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3696 $perror .= " (also received error sending decline notification: $error)"
3701 $cust_pay_pending->status('done');
3702 $cust_pay_pending->statustext("declined: $perror");
3703 my $cpp_done_err = $cust_pay_pending->replace;
3704 if ( $cpp_done_err ) {
3705 my $e = "WARNING: $method declined but pending payment not resolved - ".
3706 "error updating status for paypendingnum ".
3707 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3709 $perror = "$e ($perror)";
3722 my( $self, $method, $amount, %options ) = @_;
3724 if ( $options{'fake_failure'} ) {
3725 return "Error: No error; test failure requested with fake_failure";
3728 my %method2payby = (
3735 #if ( $payment_gateway ) { # agent override
3736 # $paybatch = $payment_gateway->gatewaynum. '-';
3739 #$paybatch .= "$processor:". $transaction->authorization;
3741 #$paybatch .= ':'. $transaction->order_number
3742 # if $transaction->can('order_number')
3743 # && length($transaction->order_number);
3745 my $paybatch = 'FakeProcessor:54:32';
3747 my $cust_pay = new FS::cust_pay ( {
3748 'custnum' => $self->custnum,
3749 'invnum' => $options{'invnum'},
3752 'payby' => $method2payby{$method},
3753 #'payinfo' => $payinfo,
3754 'payinfo' => '4111111111111111',
3755 'paybatch' => $paybatch,
3756 #'paydate' => $paydate,
3757 'paydate' => '2012-05-01',
3759 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3761 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3764 $cust_pay->invnum(''); #try again with no specific invnum
3765 my $error2 = $cust_pay->insert( $options{'manual'} ?
3766 ( 'manual' => 1 ) : ()
3769 # gah, even with transactions.
3770 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3771 "error inserting (fake!) payment: $error2".
3772 " (previously tried insert with invnum #$options{'invnum'}" .
3779 if ( $options{'paynum_ref'} ) {
3780 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3783 return ''; #no error
3787 =item default_payment_gateway
3791 sub default_payment_gateway {
3792 my( $self, $method ) = @_;
3794 die "Real-time processing not enabled\n"
3795 unless $conf->exists('business-onlinepayment');
3798 my $bop_config = 'business-onlinepayment';
3799 $bop_config .= '-ach'
3800 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3801 my ( $processor, $login, $password, $action, @bop_options ) =
3802 $conf->config($bop_config);
3803 $action ||= 'normal authorization';
3804 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3805 die "No real-time processor is enabled - ".
3806 "did you set the business-onlinepayment configuration value?\n"
3809 ( $processor, $login, $password, $action, @bop_options )
3814 Removes the I<paycvv> field from the database directly.
3816 If there is an error, returns the error, otherwise returns false.
3822 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3823 or return dbh->errstr;
3824 $sth->execute($self->custnum)
3825 or return $sth->errstr;
3830 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3832 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3833 via a Business::OnlinePayment realtime gateway. See
3834 L<http://420.am/business-onlinepayment> for supported gateways.
3836 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3838 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3840 Most gateways require a reference to an original payment transaction to refund,
3841 so you probably need to specify a I<paynum>.
3843 I<amount> defaults to the original amount of the payment if not specified.
3845 I<reason> specifies a reason for the refund.
3847 I<paydate> specifies the expiration date for a credit card overriding the
3848 value from the customer record or the payment record. Specified as yyyy-mm-dd
3850 Implementation note: If I<amount> is unspecified or equal to the amount of the
3851 orignal payment, first an attempt is made to "void" the transaction via
3852 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3853 the normal attempt is made to "refund" ("credit") the transaction via the
3854 gateway is attempted.
3856 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3857 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3858 #if set, will override the value from the customer record.
3860 #If an I<invnum> is specified, this payment (if successful) is applied to the
3861 #specified invoice. If you don't specify an I<invnum> you might want to
3862 #call the B<apply_payments> method.
3866 #some false laziness w/realtime_bop, not enough to make it worth merging
3867 #but some useful small subs should be pulled out
3868 sub realtime_refund_bop {
3869 my( $self, $method, %options ) = @_;
3871 warn "$me realtime_refund_bop: $method refund\n";
3872 warn " $_ => $options{$_}\n" foreach keys %options;
3875 eval "use Business::OnlinePayment";
3879 # look up the original payment and optionally a gateway for that payment
3883 my $amount = $options{'amount'};
3885 my( $processor, $login, $password, @bop_options ) ;
3886 my( $auth, $order_number ) = ( '', '', '' );
3888 if ( $options{'paynum'} ) {
3890 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3891 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3892 or return "Unknown paynum $options{'paynum'}";
3893 $amount ||= $cust_pay->paid;
3895 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3896 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3897 $cust_pay->paybatch;
3898 my $gatewaynum = '';
3899 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3901 if ( $gatewaynum ) { #gateway for the payment to be refunded
3903 my $payment_gateway =
3904 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3905 die "payment gateway $gatewaynum not found"
3906 unless $payment_gateway;
3908 $processor = $payment_gateway->gateway_module;
3909 $login = $payment_gateway->gateway_username;
3910 $password = $payment_gateway->gateway_password;
3911 @bop_options = $payment_gateway->options;
3913 } else { #try the default gateway
3915 my( $conf_processor, $unused_action );
3916 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3917 $self->default_payment_gateway($method);
3919 return "processor of payment $options{'paynum'} $processor does not".
3920 " match default processor $conf_processor"
3921 unless $processor eq $conf_processor;
3926 } else { # didn't specify a paynum, so look for agent gateway overrides
3927 # like a normal transaction
3930 if ( $method eq 'CC' ) {
3931 $cardtype = cardtype($self->payinfo);
3932 } elsif ( $method eq 'ECHECK' ) {
3935 $cardtype = $method;
3938 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3939 cardtype => $cardtype,
3941 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3943 taxclass => '', } );
3945 if ( $override ) { #use a payment gateway override
3947 my $payment_gateway = $override->payment_gateway;
3949 $processor = $payment_gateway->gateway_module;
3950 $login = $payment_gateway->gateway_username;
3951 $password = $payment_gateway->gateway_password;
3952 #$action = $payment_gateway->gateway_action;
3953 @bop_options = $payment_gateway->options;
3955 } else { #use the standard settings from the config
3958 ( $processor, $login, $password, $unused_action, @bop_options ) =
3959 $self->default_payment_gateway($method);
3964 return "neither amount nor paynum specified" unless $amount;
3969 'password' => $password,
3970 'order_number' => $order_number,
3971 'amount' => $amount,
3972 'referer' => 'http://cleanwhisker.420.am/',
3974 $content{authorization} = $auth
3975 if length($auth); #echeck/ACH transactions have an order # but no auth
3976 #(at least with authorize.net)
3978 my $disable_void_after;
3979 if ($conf->exists('disable_void_after')
3980 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3981 $disable_void_after = $1;
3984 #first try void if applicable
3985 if ( $cust_pay && $cust_pay->paid == $amount
3987 ( not defined($disable_void_after) )
3988 || ( time < ($cust_pay->_date + $disable_void_after ) )
3991 warn " attempting void\n" if $DEBUG > 1;
3992 my $void = new Business::OnlinePayment( $processor, @bop_options );
3993 $void->content( 'action' => 'void', %content );
3995 if ( $void->is_success ) {
3996 my $error = $cust_pay->void($options{'reason'});
3998 # gah, even with transactions.
3999 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4000 "error voiding payment: $error";
4004 warn " void successful\n" if $DEBUG > 1;
4009 warn " void unsuccessful, trying refund\n"
4013 my $address = $self->address1;
4014 $address .= ", ". $self->address2 if $self->address2;
4016 my($payname, $payfirst, $paylast);
4017 if ( $self->payname && $method ne 'ECHECK' ) {
4018 $payname = $self->payname;
4019 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4020 or return "Illegal payname $payname";
4021 ($payfirst, $paylast) = ($1, $2);
4023 $payfirst = $self->getfield('first');
4024 $paylast = $self->getfield('last');
4025 $payname = "$payfirst $paylast";
4028 my @invoicing_list = $self->invoicing_list_emailonly;
4029 if ( $conf->exists('emailinvoiceautoalways')
4030 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4031 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4032 push @invoicing_list, $self->all_emails;
4035 my $email = ($conf->exists('business-onlinepayment-email-override'))
4036 ? $conf->config('business-onlinepayment-email-override')
4037 : $invoicing_list[0];
4039 my $payip = exists($options{'payip'})
4042 $content{customer_ip} = $payip
4046 if ( $method eq 'CC' ) {
4049 $content{card_number} = $payinfo = $cust_pay->payinfo;
4050 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4051 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4052 ($content{expiration} = "$2/$1"); # where available
4054 $content{card_number} = $payinfo = $self->payinfo;
4055 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4056 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4057 $content{expiration} = "$2/$1";
4060 } elsif ( $method eq 'ECHECK' ) {
4063 $payinfo = $cust_pay->payinfo;
4065 $payinfo = $self->payinfo;
4067 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4068 $content{bank_name} = $self->payname;
4069 $content{account_type} = 'CHECKING';
4070 $content{account_name} = $payname;
4071 $content{customer_org} = $self->company ? 'B' : 'I';
4072 $content{customer_ssn} = $self->ss;
4073 } elsif ( $method eq 'LEC' ) {
4074 $content{phone} = $payinfo = $self->payinfo;
4078 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4079 my %sub_content = $refund->content(
4080 'action' => 'credit',
4081 'customer_id' => $self->custnum,
4082 'last_name' => $paylast,
4083 'first_name' => $payfirst,
4085 'address' => $address,
4086 'city' => $self->city,
4087 'state' => $self->state,
4088 'zip' => $self->zip,
4089 'country' => $self->country,
4091 'phone' => $self->daytime || $self->night,
4094 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4098 return "$processor error: ". $refund->error_message
4099 unless $refund->is_success();
4101 my %method2payby = (
4107 my $paybatch = "$processor:". $refund->authorization;
4108 $paybatch .= ':'. $refund->order_number
4109 if $refund->can('order_number') && $refund->order_number;
4111 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4112 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4113 last unless @cust_bill_pay;
4114 my $cust_bill_pay = pop @cust_bill_pay;
4115 my $error = $cust_bill_pay->delete;
4119 my $cust_refund = new FS::cust_refund ( {
4120 'custnum' => $self->custnum,
4121 'paynum' => $options{'paynum'},
4122 'refund' => $amount,
4124 'payby' => $method2payby{$method},
4125 'payinfo' => $payinfo,
4126 'paybatch' => $paybatch,
4127 'reason' => $options{'reason'} || 'card or ACH refund',
4129 my $error = $cust_refund->insert;
4131 $cust_refund->paynum(''); #try again with no specific paynum
4132 my $error2 = $cust_refund->insert;
4134 # gah, even with transactions.
4135 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4136 "error inserting refund ($processor): $error2".
4137 " (previously tried insert with paynum #$options{'paynum'}" .
4148 =item batch_card OPTION => VALUE...
4150 Adds a payment for this invoice to the pending credit card batch (see
4151 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
4152 runs the payment using a realtime gateway.
4157 my ($self, %options) = @_;
4160 if (exists($options{amount})) {
4161 $amount = $options{amount};
4163 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
4165 return '' unless $amount > 0;
4167 my $invnum = delete $options{invnum};
4168 my $payby = $options{invnum} || $self->payby; #dubious
4170 if ($options{'realtime'}) {
4171 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
4177 my $oldAutoCommit = $FS::UID::AutoCommit;
4178 local $FS::UID::AutoCommit = 0;
4181 #this needs to handle mysql as well as Pg, like svc_acct.pm
4182 #(make it into a common function if folks need to do batching with mysql)
4183 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
4184 or return "Cannot lock pay_batch: " . $dbh->errstr;
4188 'payby' => FS::payby->payby2payment($payby),
4191 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
4193 unless ( $pay_batch ) {
4194 $pay_batch = new FS::pay_batch \%pay_batch;
4195 my $error = $pay_batch->insert;
4197 $dbh->rollback if $oldAutoCommit;
4198 die "error creating new batch: $error\n";
4202 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
4203 'batchnum' => $pay_batch->batchnum,
4204 'custnum' => $self->custnum,
4207 foreach (qw( address1 address2 city state zip country payby payinfo paydate
4209 $options{$_} = '' unless exists($options{$_});
4212 my $cust_pay_batch = new FS::cust_pay_batch ( {
4213 'batchnum' => $pay_batch->batchnum,
4214 'invnum' => $invnum || 0, # is there a better value?
4215 # this field should be
4217 # cust_bill_pay_batch now
4218 'custnum' => $self->custnum,
4219 'last' => $self->getfield('last'),
4220 'first' => $self->getfield('first'),
4221 'address1' => $options{address1} || $self->address1,
4222 'address2' => $options{address2} || $self->address2,
4223 'city' => $options{city} || $self->city,
4224 'state' => $options{state} || $self->state,
4225 'zip' => $options{zip} || $self->zip,
4226 'country' => $options{country} || $self->country,
4227 'payby' => $options{payby} || $self->payby,
4228 'payinfo' => $options{payinfo} || $self->payinfo,
4229 'exp' => $options{paydate} || $self->paydate,
4230 'payname' => $options{payname} || $self->payname,
4231 'amount' => $amount, # consolidating
4234 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
4235 if $old_cust_pay_batch;
4238 if ($old_cust_pay_batch) {
4239 $error = $cust_pay_batch->replace($old_cust_pay_batch)
4241 $error = $cust_pay_batch->insert;
4245 $dbh->rollback if $oldAutoCommit;
4249 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
4250 foreach my $cust_bill ($self->open_cust_bill) {
4251 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
4252 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
4253 'invnum' => $cust_bill->invnum,
4254 'paybatchnum' => $cust_pay_batch->paybatchnum,
4255 'amount' => $cust_bill->owed,
4258 if ($unapplied >= $cust_bill_pay_batch->amount){
4259 $unapplied -= $cust_bill_pay_batch->amount;
4262 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
4263 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
4265 $error = $cust_bill_pay_batch->insert;
4267 $dbh->rollback if $oldAutoCommit;
4272 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4278 Returns the total owed for this customer on all invoices
4279 (see L<FS::cust_bill/owed>).
4285 $self->total_owed_date(2145859200); #12/31/2037
4288 =item total_owed_date TIME
4290 Returns the total owed for this customer on all invoices with date earlier than
4291 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
4292 see L<Time::Local> and L<Date::Parse> for conversion functions.
4296 sub total_owed_date {
4300 foreach my $cust_bill (
4301 grep { $_->_date <= $time }
4302 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4304 $total_bill += $cust_bill->owed;
4306 sprintf( "%.2f", $total_bill );
4309 =item apply_payments_and_credits
4311 Applies unapplied payments and credits.
4313 In most cases, this new method should be used in place of sequential
4314 apply_payments and apply_credits methods.
4316 If there is an error, returns the error, otherwise returns false.
4320 sub apply_payments_and_credits {
4323 local $SIG{HUP} = 'IGNORE';
4324 local $SIG{INT} = 'IGNORE';
4325 local $SIG{QUIT} = 'IGNORE';
4326 local $SIG{TERM} = 'IGNORE';
4327 local $SIG{TSTP} = 'IGNORE';
4328 local $SIG{PIPE} = 'IGNORE';
4330 my $oldAutoCommit = $FS::UID::AutoCommit;
4331 local $FS::UID::AutoCommit = 0;
4334 $self->select_for_update; #mutex
4336 foreach my $cust_bill ( $self->open_cust_bill ) {
4337 my $error = $cust_bill->apply_payments_and_credits;
4339 $dbh->rollback if $oldAutoCommit;
4340 return "Error applying: $error";
4344 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4349 =item apply_credits OPTION => VALUE ...
4351 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4352 to outstanding invoice balances in chronological order (or reverse
4353 chronological order if the I<order> option is set to B<newest>) and returns the
4354 value of any remaining unapplied credits available for refund (see
4355 L<FS::cust_refund>).
4357 Dies if there is an error.
4365 local $SIG{HUP} = 'IGNORE';
4366 local $SIG{INT} = 'IGNORE';
4367 local $SIG{QUIT} = 'IGNORE';
4368 local $SIG{TERM} = 'IGNORE';
4369 local $SIG{TSTP} = 'IGNORE';
4370 local $SIG{PIPE} = 'IGNORE';
4372 my $oldAutoCommit = $FS::UID::AutoCommit;
4373 local $FS::UID::AutoCommit = 0;
4376 $self->select_for_update; #mutex
4378 unless ( $self->total_credited ) {
4379 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4383 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4384 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4386 my @invoices = $self->open_cust_bill;
4387 @invoices = sort { $b->_date <=> $a->_date } @invoices
4388 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4391 foreach my $cust_bill ( @invoices ) {
4394 if ( !defined($credit) || $credit->credited == 0) {
4395 $credit = pop @credits or last;
4398 if ($cust_bill->owed >= $credit->credited) {
4399 $amount=$credit->credited;
4401 $amount=$cust_bill->owed;
4404 my $cust_credit_bill = new FS::cust_credit_bill ( {
4405 'crednum' => $credit->crednum,
4406 'invnum' => $cust_bill->invnum,
4407 'amount' => $amount,
4409 my $error = $cust_credit_bill->insert;
4411 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4415 redo if ($cust_bill->owed > 0);
4419 my $total_credited = $self->total_credited;
4421 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4423 return $total_credited;
4426 =item apply_payments
4428 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4429 to outstanding invoice balances in chronological order.
4431 #and returns the value of any remaining unapplied payments.
4433 Dies if there is an error.
4437 sub apply_payments {
4440 local $SIG{HUP} = 'IGNORE';
4441 local $SIG{INT} = 'IGNORE';
4442 local $SIG{QUIT} = 'IGNORE';
4443 local $SIG{TERM} = 'IGNORE';
4444 local $SIG{TSTP} = 'IGNORE';
4445 local $SIG{PIPE} = 'IGNORE';
4447 my $oldAutoCommit = $FS::UID::AutoCommit;
4448 local $FS::UID::AutoCommit = 0;
4451 $self->select_for_update; #mutex
4455 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4456 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4458 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4459 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4463 foreach my $cust_bill ( @invoices ) {
4466 if ( !defined($payment) || $payment->unapplied == 0 ) {
4467 $payment = pop @payments or last;
4470 if ( $cust_bill->owed >= $payment->unapplied ) {
4471 $amount = $payment->unapplied;
4473 $amount = $cust_bill->owed;
4476 my $cust_bill_pay = new FS::cust_bill_pay ( {
4477 'paynum' => $payment->paynum,
4478 'invnum' => $cust_bill->invnum,
4479 'amount' => $amount,
4481 my $error = $cust_bill_pay->insert;
4483 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4487 redo if ( $cust_bill->owed > 0);
4491 my $total_unapplied_payments = $self->total_unapplied_payments;
4493 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4495 return $total_unapplied_payments;
4498 =item total_credited
4500 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4501 customer. See L<FS::cust_credit/credited>.
4505 sub total_credited {
4507 my $total_credit = 0;
4508 foreach my $cust_credit ( qsearch('cust_credit', {
4509 'custnum' => $self->custnum,
4511 $total_credit += $cust_credit->credited;
4513 sprintf( "%.2f", $total_credit );
4516 =item total_unapplied_payments
4518 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4519 See L<FS::cust_pay/unapplied>.
4523 sub total_unapplied_payments {
4525 my $total_unapplied = 0;
4526 foreach my $cust_pay ( qsearch('cust_pay', {
4527 'custnum' => $self->custnum,
4529 $total_unapplied += $cust_pay->unapplied;
4531 sprintf( "%.2f", $total_unapplied );
4534 =item total_unapplied_refunds
4536 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4537 customer. See L<FS::cust_refund/unapplied>.
4541 sub total_unapplied_refunds {
4543 my $total_unapplied = 0;
4544 foreach my $cust_refund ( qsearch('cust_refund', {
4545 'custnum' => $self->custnum,
4547 $total_unapplied += $cust_refund->unapplied;
4549 sprintf( "%.2f", $total_unapplied );
4554 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4555 total_credited minus total_unapplied_payments).
4563 + $self->total_unapplied_refunds
4564 - $self->total_credited
4565 - $self->total_unapplied_payments
4569 =item balance_date TIME
4571 Returns the balance for this customer, only considering invoices with date
4572 earlier than TIME (total_owed_date minus total_credited minus
4573 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4574 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4583 $self->total_owed_date($time)
4584 + $self->total_unapplied_refunds
4585 - $self->total_credited
4586 - $self->total_unapplied_payments
4590 =item in_transit_payments
4592 Returns the total of requests for payments for this customer pending in
4593 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4597 sub in_transit_payments {
4599 my $in_transit_payments = 0;
4600 foreach my $pay_batch ( qsearch('pay_batch', {
4603 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4604 'batchnum' => $pay_batch->batchnum,
4605 'custnum' => $self->custnum,
4607 $in_transit_payments += $cust_pay_batch->amount;
4610 sprintf( "%.2f", $in_transit_payments );
4613 =item paydate_monthyear
4615 Returns a two-element list consisting of the month and year of this customer's
4616 paydate (credit card expiration date for CARD customers)
4620 sub paydate_monthyear {
4622 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4624 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4631 =item invoicing_list [ ARRAYREF ]
4633 If an arguement is given, sets these email addresses as invoice recipients
4634 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4635 (except as warnings), so use check_invoicing_list first.
4637 Returns a list of email addresses (with svcnum entries expanded).
4639 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4640 check it without disturbing anything by passing nothing.
4642 This interface may change in the future.
4646 sub invoicing_list {
4647 my( $self, $arrayref ) = @_;
4650 my @cust_main_invoice;
4651 if ( $self->custnum ) {
4652 @cust_main_invoice =
4653 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4655 @cust_main_invoice = ();
4657 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4658 #warn $cust_main_invoice->destnum;
4659 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4660 #warn $cust_main_invoice->destnum;
4661 my $error = $cust_main_invoice->delete;
4662 warn $error if $error;
4665 if ( $self->custnum ) {
4666 @cust_main_invoice =
4667 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4669 @cust_main_invoice = ();
4671 my %seen = map { $_->address => 1 } @cust_main_invoice;
4672 foreach my $address ( @{$arrayref} ) {
4673 next if exists $seen{$address} && $seen{$address};
4674 $seen{$address} = 1;
4675 my $cust_main_invoice = new FS::cust_main_invoice ( {
4676 'custnum' => $self->custnum,
4679 my $error = $cust_main_invoice->insert;
4680 warn $error if $error;
4684 if ( $self->custnum ) {
4686 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4693 =item check_invoicing_list ARRAYREF
4695 Checks these arguements as valid input for the invoicing_list method. If there
4696 is an error, returns the error, otherwise returns false.
4700 sub check_invoicing_list {
4701 my( $self, $arrayref ) = @_;
4703 foreach my $address ( @$arrayref ) {
4705 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4706 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4709 my $cust_main_invoice = new FS::cust_main_invoice ( {
4710 'custnum' => $self->custnum,
4713 my $error = $self->custnum
4714 ? $cust_main_invoice->check
4715 : $cust_main_invoice->checkdest
4717 return $error if $error;
4721 return "Email address required"
4722 if $conf->exists('cust_main-require_invoicing_list_email')
4723 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4728 =item set_default_invoicing_list
4730 Sets the invoicing list to all accounts associated with this customer,
4731 overwriting any previous invoicing list.
4735 sub set_default_invoicing_list {
4737 $self->invoicing_list($self->all_emails);
4742 Returns the email addresses of all accounts provisioned for this customer.
4749 foreach my $cust_pkg ( $self->all_pkgs ) {
4750 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4752 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4753 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4755 $list{$_}=1 foreach map { $_->email } @svc_acct;
4760 =item invoicing_list_addpost
4762 Adds postal invoicing to this customer. If this customer is already configured
4763 to receive postal invoices, does nothing.
4767 sub invoicing_list_addpost {
4769 return if grep { $_ eq 'POST' } $self->invoicing_list;
4770 my @invoicing_list = $self->invoicing_list;
4771 push @invoicing_list, 'POST';
4772 $self->invoicing_list(\@invoicing_list);
4775 =item invoicing_list_emailonly
4777 Returns the list of email invoice recipients (invoicing_list without non-email
4778 destinations such as POST and FAX).
4782 sub invoicing_list_emailonly {
4784 warn "$me invoicing_list_emailonly called"
4786 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4789 =item invoicing_list_emailonly_scalar
4791 Returns the list of email invoice recipients (invoicing_list without non-email
4792 destinations such as POST and FAX) as a comma-separated scalar.
4796 sub invoicing_list_emailonly_scalar {
4798 warn "$me invoicing_list_emailonly_scalar called"
4800 join(', ', $self->invoicing_list_emailonly);
4803 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4805 Returns an array of customers referred by this customer (referral_custnum set
4806 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4807 customers referred by customers referred by this customer and so on, inclusive.
4808 The default behavior is DEPTH 1 (no recursion).
4812 sub referral_cust_main {
4814 my $depth = @_ ? shift : 1;
4815 my $exclude = @_ ? shift : {};
4818 map { $exclude->{$_->custnum}++; $_; }
4819 grep { ! $exclude->{ $_->custnum } }
4820 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4824 map { $_->referral_cust_main($depth-1, $exclude) }
4831 =item referral_cust_main_ncancelled
4833 Same as referral_cust_main, except only returns customers with uncancelled
4838 sub referral_cust_main_ncancelled {
4840 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4843 =item referral_cust_pkg [ DEPTH ]
4845 Like referral_cust_main, except returns a flat list of all unsuspended (and
4846 uncancelled) packages for each customer. The number of items in this list may
4847 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4851 sub referral_cust_pkg {
4853 my $depth = @_ ? shift : 1;
4855 map { $_->unsuspended_pkgs }
4856 grep { $_->unsuspended_pkgs }
4857 $self->referral_cust_main($depth);
4860 =item referring_cust_main
4862 Returns the single cust_main record for the customer who referred this customer
4863 (referral_custnum), or false.
4867 sub referring_cust_main {
4869 return '' unless $self->referral_custnum;
4870 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4873 =item credit AMOUNT, REASON
4875 Applies a credit to this customer. If there is an error, returns the error,
4876 otherwise returns false.
4881 my( $self, $amount, $reason, %options ) = @_;
4882 my $cust_credit = new FS::cust_credit {
4883 'custnum' => $self->custnum,
4884 'amount' => $amount,
4885 'reason' => $reason,
4887 $cust_credit->insert(%options);
4890 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4892 Creates a one-time charge for this customer. If there is an error, returns
4893 the error, otherwise returns false.
4899 my ( $amount, $quantity, $pkg, $comment, $taxclass, $additional, $classnum );
4900 my ( $taxproduct, $override );
4901 if ( ref( $_[0] ) ) {
4902 $amount = $_[0]->{amount};
4903 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
4904 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4905 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4906 : '$'. sprintf("%.2f",$amount);
4907 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4908 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4909 $additional = $_[0]->{additional};
4910 $taxproduct = $_[0]->{taxproductnum};
4911 $override = { '' => $_[0]->{tax_override} };
4915 $pkg = @_ ? shift : 'One-time charge';
4916 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4917 $taxclass = @_ ? shift : '';
4921 local $SIG{HUP} = 'IGNORE';
4922 local $SIG{INT} = 'IGNORE';
4923 local $SIG{QUIT} = 'IGNORE';
4924 local $SIG{TERM} = 'IGNORE';
4925 local $SIG{TSTP} = 'IGNORE';
4926 local $SIG{PIPE} = 'IGNORE';
4928 my $oldAutoCommit = $FS::UID::AutoCommit;
4929 local $FS::UID::AutoCommit = 0;
4932 my $part_pkg = new FS::part_pkg ( {
4934 'comment' => $comment,
4938 'classnum' => $classnum ? $classnum : '',
4939 'taxclass' => $taxclass,
4940 'taxproductnum' => $taxproduct,
4943 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4944 ( 0 .. @$additional - 1 )
4946 'additional_count' => scalar(@$additional),
4947 'setup_fee' => $amount,
4950 my $error = $part_pkg->insert( options => \%options,
4951 tax_overrides => $override,
4954 $dbh->rollback if $oldAutoCommit;
4958 my $pkgpart = $part_pkg->pkgpart;
4959 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4960 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4961 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4962 $error = $type_pkgs->insert;
4964 $dbh->rollback if $oldAutoCommit;
4969 my $cust_pkg = new FS::cust_pkg ( {
4970 'custnum' => $self->custnum,
4971 'pkgpart' => $pkgpart,
4972 'quantity' => $quantity,
4975 $error = $cust_pkg->insert;
4977 $dbh->rollback if $oldAutoCommit;
4981 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4986 #=item charge_postal_fee
4988 #Applies a one time charge this customer. If there is an error,
4989 #returns the error, returns the cust_pkg charge object or false
4990 #if there was no charge.
4994 # This should be a customer event. For that to work requires that bill
4995 # also be a customer event.
4997 sub charge_postal_fee {
5000 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
5001 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
5003 my $cust_pkg = new FS::cust_pkg ( {
5004 'custnum' => $self->custnum,
5005 'pkgpart' => $pkgpart,
5009 my $error = $cust_pkg->insert;
5010 $error ? $error : $cust_pkg;
5015 Returns all the invoices (see L<FS::cust_bill>) for this customer.
5021 sort { $a->_date <=> $b->_date }
5022 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
5025 =item open_cust_bill
5027 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
5032 sub open_cust_bill {
5034 grep { $_->owed > 0 } $self->cust_bill;
5039 Returns all the credits (see L<FS::cust_credit>) for this customer.
5045 sort { $a->_date <=> $b->_date }
5046 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
5051 Returns all the payments (see L<FS::cust_pay>) for this customer.
5057 sort { $a->_date <=> $b->_date }
5058 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
5063 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
5069 sort { $a->_date <=> $b->_date }
5070 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
5073 =item cust_pay_batch
5075 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
5079 sub cust_pay_batch {
5081 sort { $a->_date <=> $b->_date }
5082 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
5087 Returns all the refunds (see L<FS::cust_refund>) for this customer.
5093 sort { $a->_date <=> $b->_date }
5094 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
5097 =item display_custnum
5099 Returns the displayed customer number for this customer: agent_custid if
5100 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
5104 sub display_custnum {
5106 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
5107 return $self->agent_custid;
5109 return $self->custnum;
5115 Returns a name string for this customer, either "Company (Last, First)" or
5122 my $name = $self->contact;
5123 $name = $self->company. " ($name)" if $self->company;
5129 Returns a name string for this (service/shipping) contact, either
5130 "Company (Last, First)" or "Last, First".
5136 if ( $self->get('ship_last') ) {
5137 my $name = $self->ship_contact;
5138 $name = $self->ship_company. " ($name)" if $self->ship_company;
5147 Returns this customer's full (billing) contact name only, "Last, First"
5153 $self->get('last'). ', '. $self->first;
5158 Returns this customer's full (shipping) contact name only, "Last, First"
5164 $self->get('ship_last')
5165 ? $self->get('ship_last'). ', '. $self->ship_first
5171 Returns this customer's full country name
5177 code2country($self->country);
5180 =item geocode DATA_VENDOR
5182 Returns a value for the customer location as encoded by DATA_VENDOR.
5183 Currently this only makes sense for "CCH" as DATA_VENDOR.
5188 my ($self, $data_vendor) = (shift, shift); #always cch for now
5190 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
5194 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
5195 if $self->country eq 'US';
5197 #CCH specific location stuff
5198 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
5201 my @cust_tax_location =
5203 'table' => 'cust_tax_location',
5204 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
5205 'extra_sql' => $extra_sql,
5206 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
5209 $geocode = $cust_tax_location[0]->geocode
5210 if scalar(@cust_tax_location);
5219 Returns a status string for this customer, currently:
5223 =item prospect - No packages have ever been ordered
5225 =item active - One or more recurring packages is active
5227 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
5229 =item suspended - All non-cancelled recurring packages are suspended
5231 =item cancelled - All recurring packages are cancelled
5237 sub status { shift->cust_status(@_); }
5241 for my $status (qw( prospect active inactive suspended cancelled )) {
5242 my $method = $status.'_sql';
5243 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
5244 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
5245 $sth->execute( ($self->custnum) x $numnum )
5246 or die "Error executing 'SELECT $sql': ". $sth->errstr;
5247 return $status if $sth->fetchrow_arrayref->[0];
5251 =item ucfirst_cust_status
5253 =item ucfirst_status
5255 Returns the status with the first character capitalized.
5259 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
5261 sub ucfirst_cust_status {
5263 ucfirst($self->cust_status);
5268 Returns a hex triplet color string for this customer's status.
5272 use vars qw(%statuscolor);
5273 tie %statuscolor, 'Tie::IxHash',
5274 'prospect' => '7e0079', #'000000', #black? naw, purple
5275 'active' => '00CC00', #green
5276 'inactive' => '0000CC', #blue
5277 'suspended' => 'FF9900', #yellow
5278 'cancelled' => 'FF0000', #red
5281 sub statuscolor { shift->cust_statuscolor(@_); }
5283 sub cust_statuscolor {
5285 $statuscolor{$self->cust_status};
5290 Returns an array of hashes representing the customer's RT tickets.
5297 my $num = $conf->config('cust_main-max_tickets') || 10;
5300 unless ( $conf->config('ticket_system-custom_priority_field') ) {
5302 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
5306 foreach my $priority (
5307 $conf->config('ticket_system-custom_priority_field-values'), ''
5309 last if scalar(@tickets) >= $num;
5311 @{ FS::TicketSystem->customer_tickets( $self->custnum,
5312 $num - scalar(@tickets),
5321 # Return services representing svc_accts in customer support packages
5322 sub support_services {
5324 my %packages = map { $_ => 1 } $conf->config('support_packages');
5326 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
5327 grep { $_->part_svc->svcdb eq 'svc_acct' }
5328 map { $_->cust_svc }
5329 grep { exists $packages{ $_->pkgpart } }
5330 $self->ncancelled_pkgs;
5336 =head1 CLASS METHODS
5342 Class method that returns the list of possible status strings for customers
5343 (see L<the status method|/status>). For example:
5345 @statuses = FS::cust_main->statuses();
5350 #my $self = shift; #could be class...
5356 Returns an SQL expression identifying prospective cust_main records (customers
5357 with no packages ever ordered)
5361 use vars qw($select_count_pkgs);
5362 $select_count_pkgs =
5363 "SELECT COUNT(*) FROM cust_pkg
5364 WHERE cust_pkg.custnum = cust_main.custnum";
5366 sub select_count_pkgs_sql {
5370 sub prospect_sql { "
5371 0 = ( $select_count_pkgs )
5376 Returns an SQL expression identifying active cust_main records (customers with
5377 active recurring packages).
5382 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5388 Returns an SQL expression identifying inactive cust_main records (customers with
5389 no active recurring packages, but otherwise unsuspended/uncancelled).
5393 sub inactive_sql { "
5394 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5396 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5402 Returns an SQL expression identifying suspended cust_main records.
5407 sub suspended_sql { susp_sql(@_); }
5409 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5411 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5417 Returns an SQL expression identifying cancelled cust_main records.
5421 sub cancelled_sql { cancel_sql(@_); }
5424 my $recurring_sql = FS::cust_pkg->recurring_sql;
5425 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
5428 0 < ( $select_count_pkgs )
5429 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
5430 AND 0 = ( $select_count_pkgs AND $recurring_sql
5431 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5433 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5439 =item uncancelled_sql
5441 Returns an SQL expression identifying un-cancelled cust_main records.
5445 sub uncancelled_sql { uncancel_sql(@_); }
5446 sub uncancel_sql { "
5447 ( 0 < ( $select_count_pkgs
5448 AND ( cust_pkg.cancel IS NULL
5449 OR cust_pkg.cancel = 0
5452 OR 0 = ( $select_count_pkgs )
5458 Returns an SQL fragment to retreive the balance.
5463 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5464 WHERE cust_bill.custnum = cust_main.custnum )
5465 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5466 WHERE cust_pay.custnum = cust_main.custnum )
5467 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5468 WHERE cust_credit.custnum = cust_main.custnum )
5469 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5470 WHERE cust_refund.custnum = cust_main.custnum )
5473 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5475 Returns an SQL fragment to retreive the balance for this customer, only
5476 considering invoices with date earlier than START_TIME, and optionally not
5477 later than END_TIME (total_owed_date minus total_credited minus
5478 total_unapplied_payments).
5480 Times are specified as SQL fragments or numeric
5481 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5482 L<Date::Parse> for conversion functions. The empty string can be passed
5483 to disable that time constraint completely.
5485 Available options are:
5489 =item unapplied_date
5491 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)
5496 set to true to remove all customer comparison clauses, for totals
5501 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5506 JOIN clause (typically used with the total option)
5512 sub balance_date_sql {
5513 my( $class, $start, $end, %opt ) = @_;
5515 my $owed = FS::cust_bill->owed_sql;
5516 my $unapp_refund = FS::cust_refund->unapplied_sql;
5517 my $unapp_credit = FS::cust_credit->unapplied_sql;
5518 my $unapp_pay = FS::cust_pay->unapplied_sql;
5520 my $j = $opt{'join'} || '';
5522 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5523 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5524 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5525 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5527 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5528 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5529 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5530 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5535 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5537 Helper method for balance_date_sql; name (and usage) subject to change
5538 (suggestions welcome).
5540 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5541 cust_refund, cust_credit or cust_pay).
5543 If TABLE is "cust_bill" or the unapplied_date option is true, only
5544 considers records with date earlier than START_TIME, and optionally not
5545 later than END_TIME .
5549 sub _money_table_where {
5550 my( $class, $table, $start, $end, %opt ) = @_;
5553 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5554 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5555 push @where, "$table._date <= $start" if defined($start) && length($start);
5556 push @where, "$table._date > $end" if defined($end) && length($end);
5558 push @where, @{$opt{'where'}} if $opt{'where'};
5559 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5565 =item search_sql HASHREF
5569 Returns a qsearch hash expression to search for parameters specified in HREF.
5570 Valid parameters are
5578 =item cancelled_pkgs
5584 listref of start date, end date
5590 =item current_balance
5592 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
5596 =item flattened_pkgs
5605 my ($class, $params) = @_;
5616 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5618 "cust_main.agentnum = $1";
5625 #prospect active inactive suspended cancelled
5626 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
5627 my $method = $params->{'status'}. '_sql';
5628 #push @where, $class->$method();
5629 push @where, FS::cust_main->$method();
5633 # parse cancelled package checkbox
5638 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
5639 unless $params->{'cancelled_pkgs'};
5645 foreach my $field (qw( signupdate )) {
5647 next unless exists($params->{$field});
5649 my($beginning, $ending) = @{$params->{$field}};
5652 "cust_main.$field IS NOT NULL",
5653 "cust_main.$field >= $beginning",
5654 "cust_main.$field <= $ending";
5656 $orderby ||= "ORDER BY cust_main.$field";
5664 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
5666 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
5673 #my $balance_sql = $class->balance_sql();
5674 my $balance_sql = FS::cust_main->balance_sql();
5676 push @where, map { s/current_balance/$balance_sql/; $_ }
5677 @{ $params->{'current_balance'} };
5683 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5685 "cust_main.custbatch = '$1'";
5689 # setup queries, subs, etc. for the search
5692 $orderby ||= 'ORDER BY custnum';
5694 # here is the agent virtualization
5695 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
5697 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5699 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
5701 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
5703 my $select = join(', ',
5704 'cust_main.custnum',
5705 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
5708 my(@extra_headers) = ();
5709 my(@extra_fields) = ();
5711 if ($params->{'flattened_pkgs'}) {
5713 if ($dbh->{Driver}->{Name} eq 'Pg') {
5715 $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";
5717 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
5718 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
5719 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
5721 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
5722 "omitting packing information from report.";
5725 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";
5727 my $sth = dbh->prepare($header_query) or die dbh->errstr;
5728 $sth->execute() or die $sth->errstr;
5729 my $headerrow = $sth->fetchrow_arrayref;
5730 my $headercount = $headerrow ? $headerrow->[0] : 0;
5731 while($headercount) {
5732 unshift @extra_headers, "Package ". $headercount;
5733 unshift @extra_fields, eval q!sub {my $c = shift;
5734 my @a = split '\|', $c->magic;
5735 my $p = $a[!.--$headercount. q!];
5743 'table' => 'cust_main',
5744 'select' => $select,
5746 'extra_sql' => $extra_sql,
5747 'order_by' => $orderby,
5748 'count_query' => $count_query,
5749 'extra_headers' => \@extra_headers,
5750 'extra_fields' => \@extra_fields,
5755 =item email_search_sql HASHREF
5759 Emails a notice to the specified customers.
5761 Valid parameters are those of the L<search_sql> method, plus the following:
5783 Optional job queue job for status updates.
5787 Returns an error message, or false for success.
5789 If an error occurs during any email, stops the enture send and returns that
5790 error. Presumably if you're getting SMTP errors aborting is better than
5791 retrying everything.
5795 sub email_search_sql {
5796 my($class, $params) = @_;
5798 my $from = delete $params->{from};
5799 my $subject = delete $params->{subject};
5800 my $html_body = delete $params->{html_body};
5801 my $text_body = delete $params->{text_body};
5803 my $job = delete $params->{'job'};
5805 my $sql_query = $class->search_sql($params);
5807 my $count_query = delete($sql_query->{'count_query'});
5808 my $count_sth = dbh->prepare($count_query)
5809 or die "Error preparing $count_query: ". dbh->errstr;
5811 or die "Error executing $count_query: ". $count_sth->errstr;
5812 my $count_arrayref = $count_sth->fetchrow_arrayref;
5813 my $num_cust = $count_arrayref->[0];
5815 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
5816 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
5819 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
5821 #eventually order+limit magic to reduce memory use?
5822 foreach my $cust_main ( qsearch($sql_query) ) {
5824 my $to = $cust_main->invoicing_list_emailonly_scalar;
5827 my $error = send_email(
5831 'subject' => $subject,
5832 'html_body' => $html_body,
5833 'text_body' => $text_body,
5836 return $error if $error;
5838 if ( $job ) { #progressbar foo
5840 if ( time - $min_sec > $last ) {
5841 my $error = $job->update_statustext(
5842 int( 100 * $num / $num_cust )
5844 die $error if $error;
5854 use Storable qw(thaw);
5857 sub process_email_search_sql {
5859 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
5861 my $param = thaw(decode_base64(shift));
5862 warn Dumper($param) if $DEBUG;
5864 $param->{'job'} = $job;
5866 my $error = FS::cust_main->email_search_sql( $param );
5867 die $error if $error;
5871 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5873 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5874 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
5875 appropriate ship_ field is also searched).
5877 Additional options are the same as FS::Record::qsearch
5882 my( $self, $fuzzy, $hash, @opt) = @_;
5887 check_and_rebuild_fuzzyfiles();
5888 foreach my $field ( keys %$fuzzy ) {
5890 my $all = $self->all_X($field);
5891 next unless scalar(@$all);
5894 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5897 foreach ( keys %match ) {
5898 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5899 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5902 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5905 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5907 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5915 Returns a masked version of the named field
5920 my ($self,$field) = @_;
5924 'x'x(length($self->getfield($field))-4).
5925 substr($self->getfield($field), (length($self->getfield($field))-4));
5935 =item smart_search OPTION => VALUE ...
5937 Accepts the following options: I<search>, the string to search for. The string
5938 will be searched for as a customer number, phone number, name or company name,
5939 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5940 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5941 skip fuzzy matching when an exact match is found.
5943 Any additional options are treated as an additional qualifier on the search
5946 Returns a (possibly empty) array of FS::cust_main objects.
5953 #here is the agent virtualization
5954 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5958 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5959 my $search = delete $options{'search'};
5960 ( my $alphanum_search = $search ) =~ s/\W//g;
5962 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5964 #false laziness w/Record::ut_phone
5965 my $phonen = "$1-$2-$3";
5966 $phonen .= " x$4" if $4;
5968 push @cust_main, qsearch( {
5969 'table' => 'cust_main',
5970 'hashref' => { %options },
5971 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5973 join(' OR ', map "$_ = '$phonen'",
5974 qw( daytime night fax
5975 ship_daytime ship_night ship_fax )
5978 " AND $agentnums_sql", #agent virtualization
5981 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5982 #try looking for matches with extensions unless one was specified
5984 push @cust_main, qsearch( {
5985 'table' => 'cust_main',
5986 'hashref' => { %options },
5987 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5989 join(' OR ', map "$_ LIKE '$phonen\%'",
5991 ship_daytime ship_night )
5994 " AND $agentnums_sql", #agent virtualization
5999 # custnum search (also try agent_custid), with some tweaking options if your
6000 # legacy cust "numbers" have letters
6003 if ( $search =~ /^\s*(\d+)\s*$/
6004 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
6005 && $search =~ /^\s*(\w\w?\d+)\s*$/
6012 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
6013 push @cust_main, qsearch( {
6014 'table' => 'cust_main',
6015 'hashref' => { 'custnum' => $num, %options },
6016 'extra_sql' => " AND $agentnums_sql", #agent virtualization
6020 push @cust_main, qsearch( {
6021 'table' => 'cust_main',
6022 'hashref' => { 'agent_custid' => $num, %options },
6023 'extra_sql' => " AND $agentnums_sql", #agent virtualization
6026 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
6028 my($company, $last, $first) = ( $1, $2, $3 );
6030 # "Company (Last, First)"
6031 #this is probably something a browser remembered,
6032 #so just do an exact search
6034 foreach my $prefix ( '', 'ship_' ) {
6035 push @cust_main, qsearch( {
6036 'table' => 'cust_main',
6037 'hashref' => { $prefix.'first' => $first,
6038 $prefix.'last' => $last,
6039 $prefix.'company' => $company,
6042 'extra_sql' => " AND $agentnums_sql",
6046 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
6047 # try (ship_){last,company}
6051 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
6052 # # full strings the browser remembers won't work
6053 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
6055 use Lingua::EN::NameParse;
6056 my $NameParse = new Lingua::EN::NameParse(
6058 allow_reversed => 1,
6061 my($last, $first) = ( '', '' );
6062 #maybe disable this too and just rely on NameParse?
6063 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
6065 ($last, $first) = ( $1, $2 );
6067 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
6068 } elsif ( ! $NameParse->parse($value) ) {
6070 my %name = $NameParse->components;
6071 $first = $name{'given_name_1'};
6072 $last = $name{'surname_1'};
6076 if ( $first && $last ) {
6078 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
6081 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
6083 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
6084 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
6087 push @cust_main, qsearch( {
6088 'table' => 'cust_main',
6089 'hashref' => \%options,
6090 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
6093 # or it just be something that was typed in... (try that in a sec)
6097 my $q_value = dbh->quote($value);
6100 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
6101 $sql .= " ( LOWER(last) = $q_value
6102 OR LOWER(company) = $q_value
6103 OR LOWER(ship_last) = $q_value
6104 OR LOWER(ship_company) = $q_value
6107 push @cust_main, qsearch( {
6108 'table' => 'cust_main',
6109 'hashref' => \%options,
6110 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
6113 #no exact match, trying substring/fuzzy
6114 #always do substring & fuzzy (unless they're explicity config'ed off)
6115 #getting complaints searches are not returning enough
6116 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
6118 #still some false laziness w/search_sql (was search/cust_main.cgi)
6123 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
6124 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
6127 if ( $first && $last ) {
6130 { 'first' => { op=>'ILIKE', value=>"%$first%" },
6131 'last' => { op=>'ILIKE', value=>"%$last%" },
6133 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
6134 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
6141 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
6142 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
6146 foreach my $hashref ( @hashrefs ) {
6148 push @cust_main, qsearch( {
6149 'table' => 'cust_main',
6150 'hashref' => { %$hashref,
6153 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
6162 " AND $agentnums_sql", #extra_sql #agent virtualization
6165 if ( $first && $last ) {
6166 push @cust_main, FS::cust_main->fuzzy_search(
6167 { 'last' => $last, #fuzzy hashref
6168 'first' => $first }, #
6172 foreach my $field ( 'last', 'company' ) {
6174 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
6179 #eliminate duplicates
6181 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
6191 Accepts the following options: I<email>, the email address to search for. The
6192 email address will be searched for as an email invoice destination and as an
6195 #Any additional options are treated as an additional qualifier on the search
6196 #(i.e. I<agentnum>).
6198 Returns a (possibly empty) array of FS::cust_main objects (but usually just
6208 my $email = delete $options{'email'};
6210 #we're only being used by RT at the moment... no agent virtualization yet
6211 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
6215 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
6217 my ( $user, $domain ) = ( $1, $2 );
6219 warn "$me smart_search: searching for $user in domain $domain"
6225 'table' => 'cust_main_invoice',
6226 'hashref' => { 'dest' => $email },
6233 map $_->cust_svc->cust_pkg,
6235 'table' => 'svc_acct',
6236 'hashref' => { 'username' => $user, },
6238 'AND ( SELECT domain FROM svc_domain
6239 WHERE svc_acct.domsvc = svc_domain.svcnum
6240 ) = '. dbh->quote($domain),
6246 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
6248 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
6255 =item check_and_rebuild_fuzzyfiles
6259 use vars qw(@fuzzyfields);
6260 @fuzzyfields = ( 'last', 'first', 'company' );
6262 sub check_and_rebuild_fuzzyfiles {
6263 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6264 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
6267 =item rebuild_fuzzyfiles
6271 sub rebuild_fuzzyfiles {
6273 use Fcntl qw(:flock);
6275 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6276 mkdir $dir, 0700 unless -d $dir;
6278 foreach my $fuzzy ( @fuzzyfields ) {
6280 open(LOCK,">>$dir/cust_main.$fuzzy")
6281 or die "can't open $dir/cust_main.$fuzzy: $!";
6283 or die "can't lock $dir/cust_main.$fuzzy: $!";
6285 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
6286 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
6288 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
6289 my $sth = dbh->prepare("SELECT $field FROM cust_main".
6290 " WHERE $field != '' AND $field IS NOT NULL");
6291 $sth->execute or die $sth->errstr;
6293 while ( my $row = $sth->fetchrow_arrayref ) {
6294 print CACHE $row->[0]. "\n";
6299 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
6301 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
6312 my( $self, $field ) = @_;
6313 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6314 open(CACHE,"<$dir/cust_main.$field")
6315 or die "can't open $dir/cust_main.$field: $!";
6316 my @array = map { chomp; $_; } <CACHE>;
6321 =item append_fuzzyfiles LASTNAME COMPANY
6325 sub append_fuzzyfiles {
6326 #my( $first, $last, $company ) = @_;
6328 &check_and_rebuild_fuzzyfiles;
6330 use Fcntl qw(:flock);
6332 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6334 foreach my $field (qw( first last company )) {
6339 open(CACHE,">>$dir/cust_main.$field")
6340 or die "can't open $dir/cust_main.$field: $!";
6341 flock(CACHE,LOCK_EX)
6342 or die "can't lock $dir/cust_main.$field: $!";
6344 print CACHE "$value\n";
6346 flock(CACHE,LOCK_UN)
6347 or die "can't unlock $dir/cust_main.$field: $!";
6362 #warn join('-',keys %$param);
6363 my $fh = $param->{filehandle};
6364 my @fields = @{$param->{fields}};
6366 eval "use Text::CSV_XS;";
6369 my $csv = new Text::CSV_XS;
6376 local $SIG{HUP} = 'IGNORE';
6377 local $SIG{INT} = 'IGNORE';
6378 local $SIG{QUIT} = 'IGNORE';
6379 local $SIG{TERM} = 'IGNORE';
6380 local $SIG{TSTP} = 'IGNORE';
6381 local $SIG{PIPE} = 'IGNORE';
6383 my $oldAutoCommit = $FS::UID::AutoCommit;
6384 local $FS::UID::AutoCommit = 0;
6387 #while ( $columns = $csv->getline($fh) ) {
6389 while ( defined($line=<$fh>) ) {
6391 $csv->parse($line) or do {
6392 $dbh->rollback if $oldAutoCommit;
6393 return "can't parse: ". $csv->error_input();
6396 my @columns = $csv->fields();
6397 #warn join('-',@columns);
6400 foreach my $field ( @fields ) {
6401 $row{$field} = shift @columns;
6404 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
6405 unless ( $cust_main ) {
6406 $dbh->rollback if $oldAutoCommit;
6407 return "unknown custnum $row{'custnum'}";
6410 if ( $row{'amount'} > 0 ) {
6411 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
6413 $dbh->rollback if $oldAutoCommit;
6417 } elsif ( $row{'amount'} < 0 ) {
6418 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
6421 $dbh->rollback if $oldAutoCommit;
6431 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6433 return "Empty file!" unless $imported;
6439 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6441 Sends a templated email notification to the customer (see L<Text::Template>).
6443 OPTIONS is a hash and may include
6445 I<from> - the email sender (default is invoice_from)
6447 I<to> - comma-separated scalar or arrayref of recipients
6448 (default is invoicing_list)
6450 I<subject> - The subject line of the sent email notification
6451 (default is "Notice from company_name")
6453 I<extra_fields> - a hashref of name/value pairs which will be substituted
6456 The following variables are vavailable in the template.
6458 I<$first> - the customer first name
6459 I<$last> - the customer last name
6460 I<$company> - the customer company
6461 I<$payby> - a description of the method of payment for the customer
6462 # would be nice to use FS::payby::shortname
6463 I<$payinfo> - the account information used to collect for this customer
6464 I<$expdate> - the expiration of the customer payment in seconds from epoch
6469 my ($customer, $template, %options) = @_;
6471 return unless $conf->exists($template);
6473 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6474 $from = $options{from} if exists($options{from});
6476 my $to = join(',', $customer->invoicing_list_emailonly);
6477 $to = $options{to} if exists($options{to});
6479 my $subject = "Notice from " . $conf->config('company_name')
6480 if $conf->exists('company_name');
6481 $subject = $options{subject} if exists($options{subject});
6483 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6484 SOURCE => [ map "$_\n",
6485 $conf->config($template)]
6487 or die "can't create new Text::Template object: Text::Template::ERROR";
6488 $notify_template->compile()
6489 or die "can't compile template: Text::Template::ERROR";
6491 $FS::notify_template::_template::company_name = $conf->config('company_name');
6492 $FS::notify_template::_template::company_address =
6493 join("\n", $conf->config('company_address') ). "\n";
6495 my $paydate = $customer->paydate || '2037-12-31';
6496 $FS::notify_template::_template::first = $customer->first;
6497 $FS::notify_template::_template::last = $customer->last;
6498 $FS::notify_template::_template::company = $customer->company;
6499 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6500 my $payby = $customer->payby;
6501 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6502 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6504 #credit cards expire at the end of the month/year of their exp date
6505 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6506 $FS::notify_template::_template::payby = 'credit card';
6507 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6508 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6510 }elsif ($payby eq 'COMP') {
6511 $FS::notify_template::_template::payby = 'complimentary account';
6513 $FS::notify_template::_template::payby = 'current method';
6515 $FS::notify_template::_template::expdate = $expire_time;
6517 for (keys %{$options{extra_fields}}){
6519 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6522 send_email(from => $from,
6524 subject => $subject,
6525 body => $notify_template->fill_in( PACKAGE =>
6526 'FS::notify_template::_template' ),
6531 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6533 Generates a templated notification to the customer (see L<Text::Template>).
6535 OPTIONS is a hash and may include
6537 I<extra_fields> - a hashref of name/value pairs which will be substituted
6538 into the template. These values may override values mentioned below
6539 and those from the customer record.
6541 The following variables are available in the template instead of or in addition
6542 to the fields of the customer record.
6544 I<$payby> - a description of the method of payment for the customer
6545 # would be nice to use FS::payby::shortname
6546 I<$payinfo> - the masked account information used to collect for this customer
6547 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6548 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6552 sub generate_letter {
6553 my ($self, $template, %options) = @_;
6555 return unless $conf->exists($template);
6557 my $letter_template = new Text::Template
6559 SOURCE => [ map "$_\n", $conf->config($template)],
6560 DELIMITERS => [ '[@--', '--@]' ],
6562 or die "can't create new Text::Template object: Text::Template::ERROR";
6564 $letter_template->compile()
6565 or die "can't compile template: Text::Template::ERROR";
6567 my %letter_data = map { $_ => $self->$_ } $self->fields;
6568 $letter_data{payinfo} = $self->mask_payinfo;
6570 #my $paydate = $self->paydate || '2037-12-31';
6571 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6573 my $payby = $self->payby;
6574 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6575 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6577 #credit cards expire at the end of the month/year of their exp date
6578 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6579 $letter_data{payby} = 'credit card';
6580 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6581 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6583 }elsif ($payby eq 'COMP') {
6584 $letter_data{payby} = 'complimentary account';
6586 $letter_data{payby} = 'current method';
6588 $letter_data{expdate} = $expire_time;
6590 for (keys %{$options{extra_fields}}){
6591 $letter_data{$_} = $options{extra_fields}->{$_};
6594 unless(exists($letter_data{returnaddress})){
6595 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6596 $self->agent_template)
6598 if ( length($retadd) ) {
6599 $letter_data{returnaddress} = $retadd;
6600 } elsif ( grep /\S/, $conf->config('company_address') ) {
6601 $letter_data{returnaddress} =
6602 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6603 $conf->config('company_address')
6606 $letter_data{returnaddress} = '~';
6610 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6612 $letter_data{company_name} = $conf->config('company_name');
6614 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6615 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6619 ) or die "can't open temp file: $!\n";
6621 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6623 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6627 =item print_ps TEMPLATE
6629 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6635 my $file = $self->generate_letter(@_);
6636 FS::Misc::generate_ps($file);
6639 =item print TEMPLATE
6641 Prints the filled in template.
6643 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6647 sub queueable_print {
6650 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6651 or die "invalid customer number: " . $opt{custvnum};
6653 my $error = $self->print( $opt{template} );
6654 die $error if $error;
6658 my ($self, $template) = (shift, shift);
6659 do_print [ $self->print_ps($template) ];
6662 sub agent_template {
6664 $self->_agent_plandata('agent_templatename');
6667 sub agent_invoice_from {
6669 $self->_agent_plandata('agent_invoice_from');
6672 sub _agent_plandata {
6673 my( $self, $option ) = @_;
6675 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
6676 #agent-specific Conf
6678 use FS::part_event::Condition;
6680 my $agentnum = $self->agentnum;
6683 if ( driver_name =~ /^Pg/i ) {
6685 } elsif ( driver_name =~ /^mysql/i ) {
6688 die "don't know how to use regular expressions in ". driver_name. " databases";
6691 my $part_event_option =
6693 'select' => 'part_event_option.*',
6694 'table' => 'part_event_option',
6696 LEFT JOIN part_event USING ( eventpart )
6697 LEFT JOIN part_event_option AS peo_agentnum
6698 ON ( part_event.eventpart = peo_agentnum.eventpart
6699 AND peo_agentnum.optionname = 'agentnum'
6700 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
6702 LEFT JOIN part_event_option AS peo_cust_bill_age
6703 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
6704 AND peo_cust_bill_age.optionname = 'cust_bill_age'
6707 #'hashref' => { 'optionname' => $option },
6708 #'hashref' => { 'part_event_option.optionname' => $option },
6710 " WHERE part_event_option.optionname = ". dbh->quote($option).
6711 " AND action = 'cust_bill_send_agent' ".
6712 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
6713 " AND peo_agentnum.optionname = 'agentnum' ".
6714 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
6716 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
6718 ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
6720 , part_event.weight".
6724 unless ( $part_event_option ) {
6725 return $self->agent->invoice_template || ''
6726 if $option eq 'agent_templatename';
6730 $part_event_option->optionvalue;
6735 ## actual sub, not a method, designed to be called from the queue.
6736 ## sets up the customer, and calls the bill_and_collect
6737 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6738 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6739 $cust_main->bill_and_collect(
6750 The delete method should possibly take an FS::cust_main object reference
6751 instead of a scalar customer number.
6753 Bill and collect options should probably be passed as references instead of a
6756 There should probably be a configuration file with a list of allowed credit
6759 No multiple currency support (probably a larger project than just this module).
6761 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6763 Birthdates rely on negative epoch values.
6765 The payby for card/check batches is broken. With mixed batching, bad
6768 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6772 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6773 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6774 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.