4 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
5 $import $skip_fuzzyfiles $ignore_expired_card );
6 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 eval "use Time::Local;";
12 die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
13 if $] < 5.006 && !defined($Time::Local::VERSION);
14 #eval "use Time::Local qw(timelocal timelocal_nocheck);";
15 eval "use Time::Local qw(timelocal_nocheck);";
17 use Digest::MD5 qw(md5_base64);
21 use String::Approx qw(amatch);
22 use Business::CreditCard 0.28;
24 use FS::UID qw( getotaker dbh );
25 use FS::Record qw( qsearchs qsearch dbdef );
26 use FS::Misc qw( send_email );
27 use FS::Msgcat qw(gettext);
31 use FS::cust_bill_pkg;
33 use FS::cust_pay_void;
36 use FS::part_referral;
37 use FS::cust_main_county;
39 use FS::cust_main_invoice;
40 use FS::cust_credit_bill;
41 use FS::cust_bill_pay;
42 use FS::prepay_credit;
45 use FS::part_bill_event qw(due_events);
46 use FS::cust_bill_event;
47 use FS::cust_tax_exempt;
48 use FS::cust_tax_exempt_pkg;
50 use FS::payment_gateway;
51 use FS::agent_payment_gateway;
53 use FS::payinfo_Mixin;
55 @ISA = qw( FS::Record FS::payinfo_Mixin );
57 @EXPORT_OK = qw( smart_search );
59 $realtime_bop_decline_quiet = 0;
61 # 1 is mostly method/subroutine entry and options
62 # 2 traces progress of some operations
63 # 3 is even more information including possibly sensitive data
65 $me = '[FS::cust_main]';
69 $ignore_expired_card = 0;
71 @encrypted_fields = ('payinfo', 'paycvv');
73 #ask FS::UID to run this stuff for us later
74 #$FS::UID::callback{'FS::cust_main'} = sub {
75 install_callback FS::UID sub {
77 #yes, need it for stuff below (prolly should be cached)
82 my ( $hashref, $cache ) = @_;
83 if ( exists $hashref->{'pkgnum'} ) {
84 #@{ $self->{'_pkgnum'} } = ();
85 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
86 $self->{'_pkgnum'} = $subcache;
87 #push @{ $self->{'_pkgnum'} },
88 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
94 FS::cust_main - Object methods for cust_main records
100 $record = new FS::cust_main \%hash;
101 $record = new FS::cust_main { 'column' => 'value' };
103 $error = $record->insert;
105 $error = $new_record->replace($old_record);
107 $error = $record->delete;
109 $error = $record->check;
111 @cust_pkg = $record->all_pkgs;
113 @cust_pkg = $record->ncancelled_pkgs;
115 @cust_pkg = $record->suspended_pkgs;
117 $error = $record->bill;
118 $error = $record->bill %options;
119 $error = $record->bill 'time' => $time;
121 $error = $record->collect;
122 $error = $record->collect %options;
123 $error = $record->collect 'invoice_time' => $time,
128 An FS::cust_main object represents a customer. FS::cust_main inherits from
129 FS::Record. The following fields are currently supported:
133 =item custnum - primary key (assigned automatically for new customers)
135 =item agentnum - agent (see L<FS::agent>)
137 =item refnum - Advertising source (see L<FS::part_referral>)
143 =item ss - social security number (optional)
145 =item company - (optional)
149 =item address2 - (optional)
153 =item county - (optional, see L<FS::cust_main_county>)
155 =item state - (see L<FS::cust_main_county>)
159 =item country - (see L<FS::cust_main_county>)
161 =item daytime - phone (optional)
163 =item night - phone (optional)
165 =item fax - phone (optional)
167 =item ship_first - name
169 =item ship_last - name
171 =item ship_company - (optional)
175 =item ship_address2 - (optional)
179 =item ship_county - (optional, see L<FS::cust_main_county>)
181 =item ship_state - (see L<FS::cust_main_county>)
185 =item ship_country - (see L<FS::cust_main_county>)
187 =item ship_daytime - phone (optional)
189 =item ship_night - phone (optional)
191 =item ship_fax - phone (optional)
193 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
195 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
197 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
201 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
203 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
205 =item paystart_month - start date month (maestro/solo cards only)
207 =item paystart_year - start date year (maestro/solo cards only)
209 =item payissue - issue number (maestro/solo cards only)
211 =item payname - name on card or billing name
213 =item payip - IP address from which payment information was received
215 =item tax - tax exempt, empty or `Y'
217 =item otaker - order taker (assigned automatically, see L<FS::UID>)
219 =item comments - comments (optional)
221 =item referral_custnum - referring customer number
223 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
233 Creates a new customer. To add the customer to the database, see L<"insert">.
235 Note that this stores the hash reference, not a distinct copy of the hash it
236 points to. You can ask the object for a copy with the I<hash> method.
240 sub table { 'cust_main'; }
242 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
244 Adds this customer to the database. If there is an error, returns the error,
245 otherwise returns false.
247 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
248 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
249 are inserted atomicly, or the transaction is rolled back. Passing an empty
250 hash reference is equivalent to not supplying this parameter. There should be
251 a better explanation of this, but until then, here's an example:
254 tie %hash, 'Tie::RefHash'; #this part is important
256 $cust_pkg => [ $svc_acct ],
259 $cust_main->insert( \%hash );
261 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
262 be set as the invoicing list (see L<"invoicing_list">). Errors return as
263 expected and rollback the entire transaction; it is not necessary to call
264 check_invoicing_list first. The invoicing_list is set after the records in the
265 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
266 invoicing_list destination to the newly-created svc_acct. Here's an example:
268 $cust_main->insert( {}, [ $email, 'POST' ] );
270 Currently available options are: I<depend_jobnum> and I<noexport>.
272 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
273 on the supplied jobnum (they will not run until the specific job completes).
274 This can be used to defer provisioning until some action completes (such
275 as running the customer's credit card successfully).
277 The I<noexport> option is deprecated. If I<noexport> is set true, no
278 provisioning jobs (exports) are scheduled. (You can schedule them later with
279 the B<reexport> method.)
285 my $cust_pkgs = @_ ? shift : {};
286 my $invoicing_list = @_ ? shift : '';
288 warn "$me insert called with options ".
289 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
292 local $SIG{HUP} = 'IGNORE';
293 local $SIG{INT} = 'IGNORE';
294 local $SIG{QUIT} = 'IGNORE';
295 local $SIG{TERM} = 'IGNORE';
296 local $SIG{TSTP} = 'IGNORE';
297 local $SIG{PIPE} = 'IGNORE';
299 my $oldAutoCommit = $FS::UID::AutoCommit;
300 local $FS::UID::AutoCommit = 0;
303 my $prepay_identifier = '';
304 my( $amount, $seconds ) = ( 0, 0 );
306 if ( $self->payby eq 'PREPAY' ) {
308 $self->payby('BILL');
309 $prepay_identifier = $self->payinfo;
312 warn " looking up prepaid card $prepay_identifier\n"
315 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
317 $dbh->rollback if $oldAutoCommit;
318 #return "error applying prepaid card (transaction rolled back): $error";
322 $payby = 'PREP' if $amount;
324 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
327 $self->payby('BILL');
328 $amount = $self->paid;
332 warn " inserting $self\n"
335 $self->signupdate(time) unless $self->signupdate;
337 my $error = $self->SUPER::insert;
339 $dbh->rollback if $oldAutoCommit;
340 #return "inserting cust_main record (transaction rolled back): $error";
344 warn " setting invoicing list\n"
347 if ( $invoicing_list ) {
348 $error = $self->check_invoicing_list( $invoicing_list );
350 $dbh->rollback if $oldAutoCommit;
351 return "checking invoicing_list (transaction rolled back): $error";
353 $self->invoicing_list( $invoicing_list );
356 if ( $conf->config('cust_main-skeleton_tables')
357 && $conf->config('cust_main-skeleton_custnum') ) {
359 warn " inserting skeleton records\n"
362 my $error = $self->start_copy_skel;
364 $dbh->rollback if $oldAutoCommit;
370 warn " ordering packages\n"
373 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
375 $dbh->rollback if $oldAutoCommit;
380 $dbh->rollback if $oldAutoCommit;
381 return "No svc_acct record to apply pre-paid time";
385 warn " inserting initial $payby payment of $amount\n"
387 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
389 $dbh->rollback if $oldAutoCommit;
390 return "inserting payment (transaction rolled back): $error";
394 unless ( $import || $skip_fuzzyfiles ) {
395 warn " queueing fuzzyfiles update\n"
397 $error = $self->queue_fuzzyfiles_update;
399 $dbh->rollback if $oldAutoCommit;
400 return "updating fuzzy search cache: $error";
404 warn " insert complete; committing transaction\n"
407 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
412 sub start_copy_skel {
415 #'mg_user_preference' => {},
416 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
417 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
418 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
419 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
420 my @tables = eval($conf->config_binary('cust_main-skeleton_tables'));
423 _copy_skel( 'cust_main', #tablename
424 $conf->config('cust_main-skeleton_custnum'), #sourceid
425 $self->custnum, #destid
426 @tables, #child tables
430 #recursive subroutine, not a method
432 my( $table, $sourceid, $destid, %child_tables ) = @_;
435 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
436 ( $table, $primary_key ) = ( $1, $2 );
438 my $dbdef_table = dbdef->table($table);
439 $primary_key = $dbdef_table->primary_key
440 or return "$table has no primary key".
441 " (or do you need to run dbdef-create?)";
444 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
445 join (', ', keys %child_tables). "\n"
448 foreach my $child_table_def ( keys %child_tables ) {
452 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
453 ( $child_table, $child_pkey ) = ( $1, $2 );
455 $child_table = $child_table_def;
457 $child_pkey = dbdef->table($child_table)->primary_key;
458 # or return "$table has no primary key".
459 # " (or do you need to run dbdef-create?)\n";
463 if ( keys %{ $child_tables{$child_table_def} } ) {
465 return "$child_table has no primary key".
466 " (run dbdef-create or try specifying it?)\n"
469 #false laziness w/Record::insert and only works on Pg
470 #refactor the proper last-inserted-id stuff out of Record::insert if this
471 # ever gets use for anything besides a quick kludge for one customer
472 my $default = dbdef->table($child_table)->column($child_pkey)->default;
473 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
474 or return "can't parse $child_table.$child_pkey default value ".
475 " for sequence name: $default";
480 my @sel_columns = grep { $_ ne $primary_key }
481 dbdef->table($child_table)->columns;
482 my $sel_columns = join(', ', @sel_columns );
484 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
485 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
486 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
488 my $sel_st = "SELECT $sel_columns FROM $child_table".
489 " WHERE $primary_key = $sourceid";
492 my $sel_sth = dbh->prepare( $sel_st )
493 or return dbh->errstr;
495 $sel_sth->execute or return $sel_sth->errstr;
497 while ( my $row = $sel_sth->fetchrow_hashref ) {
499 warn " selected row: ".
500 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
504 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
505 my $ins_sth =dbh->prepare($statement)
506 or return dbh->errstr;
507 my @param = ( $destid, map $row->{$_}, @ins_columns );
508 warn " $statement: [ ". join(', ', @param). " ]\n"
510 $ins_sth->execute( @param )
511 or return $ins_sth->errstr;
513 #next unless keys %{ $child_tables{$child_table} };
514 next unless $sequence;
516 #another section of that laziness
517 my $seq_sql = "SELECT currval('$sequence')";
518 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
519 $seq_sth->execute or return $seq_sth->errstr;
520 my $insertid = $seq_sth->fetchrow_arrayref->[0];
522 # don't drink soap! recurse! recurse! okay!
524 _copy_skel( $child_table_def,
525 $row->{$child_pkey}, #sourceid
527 %{ $child_tables{$child_table_def} },
529 return $error if $error;
539 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
541 Like the insert method on an existing record, this method orders a package
542 and included services atomicaly. Pass a Tie::RefHash data structure to this
543 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
544 be a better explanation of this, but until then, here's an example:
547 tie %hash, 'Tie::RefHash'; #this part is important
549 $cust_pkg => [ $svc_acct ],
552 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
554 Services can be new, in which case they are inserted, or existing unaudited
555 services, in which case they are linked to the newly-created package.
557 Currently available options are: I<depend_jobnum> and I<noexport>.
559 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
560 on the supplied jobnum (they will not run until the specific job completes).
561 This can be used to defer provisioning until some action completes (such
562 as running the customer's credit card successfully).
564 The I<noexport> option is deprecated. If I<noexport> is set true, no
565 provisioning jobs (exports) are scheduled. (You can schedule them later with
566 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
567 on the cust_main object is not recommended, as existing services will also be
574 my $cust_pkgs = shift;
577 my %svc_options = ();
578 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
579 if exists $options{'depend_jobnum'};
580 warn "$me order_pkgs called with options ".
581 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
584 local $SIG{HUP} = 'IGNORE';
585 local $SIG{INT} = 'IGNORE';
586 local $SIG{QUIT} = 'IGNORE';
587 local $SIG{TERM} = 'IGNORE';
588 local $SIG{TSTP} = 'IGNORE';
589 local $SIG{PIPE} = 'IGNORE';
591 my $oldAutoCommit = $FS::UID::AutoCommit;
592 local $FS::UID::AutoCommit = 0;
595 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
597 foreach my $cust_pkg ( keys %$cust_pkgs ) {
598 $cust_pkg->custnum( $self->custnum );
599 my $error = $cust_pkg->insert;
601 $dbh->rollback if $oldAutoCommit;
602 return "inserting cust_pkg (transaction rolled back): $error";
604 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
605 if ( $svc_something->svcnum ) {
606 my $old_cust_svc = $svc_something->cust_svc;
607 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
608 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
609 $error = $new_cust_svc->replace($old_cust_svc);
611 $svc_something->pkgnum( $cust_pkg->pkgnum );
612 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
613 $svc_something->seconds( $svc_something->seconds + $$seconds );
616 $error = $svc_something->insert(%svc_options);
619 $dbh->rollback if $oldAutoCommit;
620 #return "inserting svc_ (transaction rolled back): $error";
626 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
630 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
632 Recharges this (existing) customer with the specified prepaid card (see
633 L<FS::prepay_credit>), specified either by I<identifier> or as an
634 FS::prepay_credit object. If there is an error, returns the error, otherwise
637 Optionally, four scalar references can be passed as well. They will have their
638 values filled in with the amount, number of seconds, and number of upload and
639 download bytes applied by this prepaid
644 sub recharge_prepay {
645 my( $self, $prepay_credit, $amountref, $secondsref,
646 $upbytesref, $downbytesref, $totalbytesref ) = @_;
648 local $SIG{HUP} = 'IGNORE';
649 local $SIG{INT} = 'IGNORE';
650 local $SIG{QUIT} = 'IGNORE';
651 local $SIG{TERM} = 'IGNORE';
652 local $SIG{TSTP} = 'IGNORE';
653 local $SIG{PIPE} = 'IGNORE';
655 my $oldAutoCommit = $FS::UID::AutoCommit;
656 local $FS::UID::AutoCommit = 0;
659 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
661 my $error = $self->get_prepay($prepay_credit, \$amount,
662 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
663 || $self->increment_seconds($seconds)
664 || $self->increment_upbytes($upbytes)
665 || $self->increment_downbytes($downbytes)
666 || $self->increment_totalbytes($totalbytes)
667 || $self->insert_cust_pay_prepay( $amount,
669 ? $prepay_credit->identifier
674 $dbh->rollback if $oldAutoCommit;
678 if ( defined($amountref) ) { $$amountref = $amount; }
679 if ( defined($secondsref) ) { $$secondsref = $seconds; }
680 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
681 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
682 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
684 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
689 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
691 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
692 specified either by I<identifier> or as an FS::prepay_credit object.
694 References to I<amount> and I<seconds> scalars should be passed as arguments
695 and will be incremented by the values of the prepaid card.
697 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
698 check or set this customer's I<agentnum>.
700 If there is an error, returns the error, otherwise returns false.
706 my( $self, $prepay_credit, $amountref, $secondsref,
707 $upref, $downref, $totalref) = @_;
709 local $SIG{HUP} = 'IGNORE';
710 local $SIG{INT} = 'IGNORE';
711 local $SIG{QUIT} = 'IGNORE';
712 local $SIG{TERM} = 'IGNORE';
713 local $SIG{TSTP} = 'IGNORE';
714 local $SIG{PIPE} = 'IGNORE';
716 my $oldAutoCommit = $FS::UID::AutoCommit;
717 local $FS::UID::AutoCommit = 0;
720 unless ( ref($prepay_credit) ) {
722 my $identifier = $prepay_credit;
724 $prepay_credit = qsearchs(
726 { 'identifier' => $prepay_credit },
731 unless ( $prepay_credit ) {
732 $dbh->rollback if $oldAutoCommit;
733 return "Invalid prepaid card: ". $identifier;
738 if ( $prepay_credit->agentnum ) {
739 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
740 $dbh->rollback if $oldAutoCommit;
741 return "prepaid card not valid for agent ". $self->agentnum;
743 $self->agentnum($prepay_credit->agentnum);
746 my $error = $prepay_credit->delete;
748 $dbh->rollback if $oldAutoCommit;
749 return "removing prepay_credit (transaction rolled back): $error";
752 $$amountref += $prepay_credit->amount;
753 $$secondsref += $prepay_credit->seconds;
754 $$upref += $prepay_credit->upbytes;
755 $$downref += $prepay_credit->downbytes;
756 $$totalref += $prepay_credit->totalbytes;
758 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
763 =item increment_upbytes SECONDS
765 Updates this customer's single or primary account (see L<FS::svc_acct>) by
766 the specified number of upbytes. If there is an error, returns the error,
767 otherwise returns false.
771 sub increment_upbytes {
772 _increment_column( shift, 'upbytes', @_);
775 =item increment_downbytes SECONDS
777 Updates this customer's single or primary account (see L<FS::svc_acct>) by
778 the specified number of downbytes. If there is an error, returns the error,
779 otherwise returns false.
783 sub increment_downbytes {
784 _increment_column( shift, 'downbytes', @_);
787 =item increment_totalbytes SECONDS
789 Updates this customer's single or primary account (see L<FS::svc_acct>) by
790 the specified number of totalbytes. If there is an error, returns the error,
791 otherwise returns false.
795 sub increment_totalbytes {
796 _increment_column( shift, 'totalbytes', @_);
799 =item increment_seconds SECONDS
801 Updates this customer's single or primary account (see L<FS::svc_acct>) by
802 the specified number of seconds. If there is an error, returns the error,
803 otherwise returns false.
807 sub increment_seconds {
808 _increment_column( shift, 'seconds', @_);
811 =item _increment_column AMOUNT
813 Updates this customer's single or primary account (see L<FS::svc_acct>) by
814 the specified number of seconds or bytes. If there is an error, returns
815 the error, otherwise returns false.
819 sub _increment_column {
820 my( $self, $column, $amount ) = @_;
821 warn "$me increment_column called: $column, $amount\n"
824 return '' unless $amount;
826 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
827 $self->ncancelled_pkgs;
830 return 'No packages with primary or single services found'.
831 ' to apply pre-paid time';
832 } elsif ( scalar(@cust_pkg) > 1 ) {
833 #maybe have a way to specify the package/account?
834 return 'Multiple packages found to apply pre-paid time';
837 my $cust_pkg = $cust_pkg[0];
838 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
842 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
845 return 'No account found to apply pre-paid time';
846 } elsif ( scalar(@cust_svc) > 1 ) {
847 return 'Multiple accounts found to apply pre-paid time';
850 my $svc_acct = $cust_svc[0]->svc_x;
851 warn " found service svcnum ". $svc_acct->pkgnum.
852 ' ('. $svc_acct->email. ")\n"
855 $column = "increment_$column";
856 $svc_acct->$column($amount);
860 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
862 Inserts a prepayment in the specified amount for this customer. An optional
863 second argument can specify the prepayment identifier for tracking purposes.
864 If there is an error, returns the error, otherwise returns false.
868 sub insert_cust_pay_prepay {
869 shift->insert_cust_pay('PREP', @_);
872 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
874 Inserts a cash payment in the specified amount for this customer. An optional
875 second argument can specify the payment identifier for tracking purposes.
876 If there is an error, returns the error, otherwise returns false.
880 sub insert_cust_pay_cash {
881 shift->insert_cust_pay('CASH', @_);
884 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
886 Inserts a Western Union payment in the specified amount for this customer. An
887 optional second argument can specify the prepayment identifier for tracking
888 purposes. If there is an error, returns the error, otherwise returns false.
892 sub insert_cust_pay_west {
893 shift->insert_cust_pay('WEST', @_);
896 sub insert_cust_pay {
897 my( $self, $payby, $amount ) = splice(@_, 0, 3);
898 my $payinfo = scalar(@_) ? shift : '';
900 my $cust_pay = new FS::cust_pay {
901 'custnum' => $self->custnum,
902 'paid' => sprintf('%.2f', $amount),
903 #'_date' => #date the prepaid card was purchased???
905 'payinfo' => $payinfo,
913 This method is deprecated. See the I<depend_jobnum> option to the insert and
914 order_pkgs methods for a better way to defer provisioning.
916 Re-schedules all exports by calling the B<reexport> method of all associated
917 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
918 otherwise returns false.
925 carp "WARNING: FS::cust_main::reexport is deprectated; ".
926 "use the depend_jobnum option to insert or order_pkgs to delay export";
928 local $SIG{HUP} = 'IGNORE';
929 local $SIG{INT} = 'IGNORE';
930 local $SIG{QUIT} = 'IGNORE';
931 local $SIG{TERM} = 'IGNORE';
932 local $SIG{TSTP} = 'IGNORE';
933 local $SIG{PIPE} = 'IGNORE';
935 my $oldAutoCommit = $FS::UID::AutoCommit;
936 local $FS::UID::AutoCommit = 0;
939 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
940 my $error = $cust_pkg->reexport;
942 $dbh->rollback if $oldAutoCommit;
947 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
952 =item delete NEW_CUSTNUM
954 This deletes the customer. If there is an error, returns the error, otherwise
957 This will completely remove all traces of the customer record. This is not
958 what you want when a customer cancels service; for that, cancel all of the
959 customer's packages (see L</cancel>).
961 If the customer has any uncancelled packages, you need to pass a new (valid)
962 customer number for those packages to be transferred to. Cancelled packages
963 will be deleted. Did I mention that this is NOT what you want when a customer
964 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
966 You can't delete a customer with invoices (see L<FS::cust_bill>),
967 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
968 refunds (see L<FS::cust_refund>).
975 local $SIG{HUP} = 'IGNORE';
976 local $SIG{INT} = 'IGNORE';
977 local $SIG{QUIT} = 'IGNORE';
978 local $SIG{TERM} = 'IGNORE';
979 local $SIG{TSTP} = 'IGNORE';
980 local $SIG{PIPE} = 'IGNORE';
982 my $oldAutoCommit = $FS::UID::AutoCommit;
983 local $FS::UID::AutoCommit = 0;
986 if ( $self->cust_bill ) {
987 $dbh->rollback if $oldAutoCommit;
988 return "Can't delete a customer with invoices";
990 if ( $self->cust_credit ) {
991 $dbh->rollback if $oldAutoCommit;
992 return "Can't delete a customer with credits";
994 if ( $self->cust_pay ) {
995 $dbh->rollback if $oldAutoCommit;
996 return "Can't delete a customer with payments";
998 if ( $self->cust_refund ) {
999 $dbh->rollback if $oldAutoCommit;
1000 return "Can't delete a customer with refunds";
1003 my @cust_pkg = $self->ncancelled_pkgs;
1005 my $new_custnum = shift;
1006 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1007 $dbh->rollback if $oldAutoCommit;
1008 return "Invalid new customer number: $new_custnum";
1010 foreach my $cust_pkg ( @cust_pkg ) {
1011 my %hash = $cust_pkg->hash;
1012 $hash{'custnum'} = $new_custnum;
1013 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1014 my $error = $new_cust_pkg->replace($cust_pkg);
1016 $dbh->rollback if $oldAutoCommit;
1021 my @cancelled_cust_pkg = $self->all_pkgs;
1022 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1023 my $error = $cust_pkg->delete;
1025 $dbh->rollback if $oldAutoCommit;
1030 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1031 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1033 my $error = $cust_main_invoice->delete;
1035 $dbh->rollback if $oldAutoCommit;
1040 my $error = $self->SUPER::delete;
1042 $dbh->rollback if $oldAutoCommit;
1046 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1051 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1053 Replaces the OLD_RECORD with this one in the database. If there is an error,
1054 returns the error, otherwise returns false.
1056 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1057 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1058 expected and rollback the entire transaction; it is not necessary to call
1059 check_invoicing_list first. Here's an example:
1061 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1069 warn "$me replace called\n"
1072 local $SIG{HUP} = 'IGNORE';
1073 local $SIG{INT} = 'IGNORE';
1074 local $SIG{QUIT} = 'IGNORE';
1075 local $SIG{TERM} = 'IGNORE';
1076 local $SIG{TSTP} = 'IGNORE';
1077 local $SIG{PIPE} = 'IGNORE';
1079 # We absolutely have to have an old vs. new record to make this work.
1080 if (!defined($old)) {
1081 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1084 my $curuser = $FS::CurrentUser::CurrentUser;
1085 if ( $self->payby eq 'COMP'
1086 && $self->payby ne $old->payby
1087 && ! $curuser->access_right('Complimentary customer')
1090 return "You are not permitted to create complimentary accounts.";
1093 local($ignore_expired_card) = 1
1094 if $old->payby =~ /^(CARD|DCRD)$/
1095 && $self->payby =~ /^(CARD|DCRD)$/
1096 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1098 my $oldAutoCommit = $FS::UID::AutoCommit;
1099 local $FS::UID::AutoCommit = 0;
1102 my $error = $self->SUPER::replace($old);
1105 $dbh->rollback if $oldAutoCommit;
1109 if ( @param ) { # INVOICING_LIST_ARYREF
1110 my $invoicing_list = shift @param;
1111 $error = $self->check_invoicing_list( $invoicing_list );
1113 $dbh->rollback if $oldAutoCommit;
1116 $self->invoicing_list( $invoicing_list );
1119 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1120 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1121 # card/check/lec info has changed, want to retry realtime_ invoice events
1122 my $error = $self->retry_realtime;
1124 $dbh->rollback if $oldAutoCommit;
1129 unless ( $import || $skip_fuzzyfiles ) {
1130 $error = $self->queue_fuzzyfiles_update;
1132 $dbh->rollback if $oldAutoCommit;
1133 return "updating fuzzy search cache: $error";
1137 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1142 =item queue_fuzzyfiles_update
1144 Used by insert & replace to update the fuzzy search cache
1148 sub queue_fuzzyfiles_update {
1151 local $SIG{HUP} = 'IGNORE';
1152 local $SIG{INT} = 'IGNORE';
1153 local $SIG{QUIT} = 'IGNORE';
1154 local $SIG{TERM} = 'IGNORE';
1155 local $SIG{TSTP} = 'IGNORE';
1156 local $SIG{PIPE} = 'IGNORE';
1158 my $oldAutoCommit = $FS::UID::AutoCommit;
1159 local $FS::UID::AutoCommit = 0;
1162 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1163 my $error = $queue->insert( map $self->getfield($_),
1164 qw(first last company)
1167 $dbh->rollback if $oldAutoCommit;
1168 return "queueing job (transaction rolled back): $error";
1171 if ( $self->ship_last ) {
1172 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1173 $error = $queue->insert( map $self->getfield("ship_$_"),
1174 qw(first last company)
1177 $dbh->rollback if $oldAutoCommit;
1178 return "queueing job (transaction rolled back): $error";
1182 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1189 Checks all fields to make sure this is a valid customer record. If there is
1190 an error, returns the error, otherwise returns false. Called by the insert
1191 and replace methods.
1198 warn "$me check BEFORE: \n". $self->_dump
1202 $self->ut_numbern('custnum')
1203 || $self->ut_number('agentnum')
1204 || $self->ut_textn('agent_custid')
1205 || $self->ut_number('refnum')
1206 || $self->ut_name('last')
1207 || $self->ut_name('first')
1208 || $self->ut_snumbern('birthdate')
1209 || $self->ut_snumbern('signupdate')
1210 || $self->ut_textn('company')
1211 || $self->ut_text('address1')
1212 || $self->ut_textn('address2')
1213 || $self->ut_text('city')
1214 || $self->ut_textn('county')
1215 || $self->ut_textn('state')
1216 || $self->ut_country('country')
1217 || $self->ut_anything('comments')
1218 || $self->ut_numbern('referral_custnum')
1220 #barf. need message catalogs. i18n. etc.
1221 $error .= "Please select an advertising source."
1222 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1223 return $error if $error;
1225 return "Unknown agent"
1226 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1228 return "Unknown refnum"
1229 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1231 return "Unknown referring custnum: ". $self->referral_custnum
1232 unless ! $self->referral_custnum
1233 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1235 if ( $self->ss eq '' ) {
1240 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1241 or return "Illegal social security number: ". $self->ss;
1242 $self->ss("$1-$2-$3");
1246 # bad idea to disable, causes billing to fail because of no tax rates later
1247 # unless ( $import ) {
1248 unless ( qsearch('cust_main_county', {
1249 'country' => $self->country,
1252 return "Unknown state/county/country: ".
1253 $self->state. "/". $self->county. "/". $self->country
1254 unless qsearch('cust_main_county',{
1255 'state' => $self->state,
1256 'county' => $self->county,
1257 'country' => $self->country,
1263 $self->ut_phonen('daytime', $self->country)
1264 || $self->ut_phonen('night', $self->country)
1265 || $self->ut_phonen('fax', $self->country)
1266 || $self->ut_zip('zip', $self->country)
1268 return $error if $error;
1271 last first company address1 address2 city county state zip
1272 country daytime night fax
1275 if ( defined $self->dbdef_table->column('ship_last') ) {
1276 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1278 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1282 $self->ut_name('ship_last')
1283 || $self->ut_name('ship_first')
1284 || $self->ut_textn('ship_company')
1285 || $self->ut_text('ship_address1')
1286 || $self->ut_textn('ship_address2')
1287 || $self->ut_text('ship_city')
1288 || $self->ut_textn('ship_county')
1289 || $self->ut_textn('ship_state')
1290 || $self->ut_country('ship_country')
1292 return $error if $error;
1294 #false laziness with above
1295 unless ( qsearchs('cust_main_county', {
1296 'country' => $self->ship_country,
1299 return "Unknown ship_state/ship_county/ship_country: ".
1300 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1301 unless qsearch('cust_main_county',{
1302 'state' => $self->ship_state,
1303 'county' => $self->ship_county,
1304 'country' => $self->ship_country,
1310 $self->ut_phonen('ship_daytime', $self->ship_country)
1311 || $self->ut_phonen('ship_night', $self->ship_country)
1312 || $self->ut_phonen('ship_fax', $self->ship_country)
1313 || $self->ut_zip('ship_zip', $self->ship_country)
1315 return $error if $error;
1317 } else { # ship_ info eq billing info, so don't store dup info in database
1318 $self->setfield("ship_$_", '')
1319 foreach qw( last first company address1 address2 city county state zip
1320 country daytime night fax );
1324 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1325 # or return "Illegal payby: ". $self->payby;
1327 FS::payby->can_payby($self->table, $self->payby)
1328 or return "Illegal payby: ". $self->payby;
1330 $error = $self->ut_numbern('paystart_month')
1331 || $self->ut_numbern('paystart_year')
1332 || $self->ut_numbern('payissue')
1334 return $error if $error;
1336 if ( $self->payip eq '' ) {
1339 $error = $self->ut_ip('payip');
1340 return $error if $error;
1343 # If it is encrypted and the private key is not availaible then we can't
1344 # check the credit card.
1346 my $check_payinfo = 1;
1348 if ($self->is_encrypted($self->payinfo)) {
1352 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1354 my $payinfo = $self->payinfo;
1355 $payinfo =~ s/\D//g;
1356 $payinfo =~ /^(\d{13,16})$/
1357 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1359 $self->payinfo($payinfo);
1361 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1363 return gettext('unknown_card_type')
1364 if cardtype($self->payinfo) eq "Unknown";
1366 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1368 return 'Banned credit card: banned on '.
1369 time2str('%a %h %o at %r', $ban->_date).
1370 ' by '. $ban->otaker.
1371 ' (ban# '. $ban->bannum. ')';
1374 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1375 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1376 $self->paycvv =~ /^(\d{4})$/
1377 or return "CVV2 (CID) for American Express cards is four digits.";
1380 $self->paycvv =~ /^(\d{3})$/
1381 or return "CVV2 (CVC2/CID) is three digits.";
1388 my $cardtype = cardtype($payinfo);
1389 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1391 return "Start date or issue number is required for $cardtype cards"
1392 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1394 return "Start month must be between 1 and 12"
1395 if $self->paystart_month
1396 and $self->paystart_month < 1 || $self->paystart_month > 12;
1398 return "Start year must be 1990 or later"
1399 if $self->paystart_year
1400 and $self->paystart_year < 1990;
1402 return "Issue number must be beween 1 and 99"
1404 and $self->payissue < 1 || $self->payissue > 99;
1407 $self->paystart_month('');
1408 $self->paystart_year('');
1409 $self->payissue('');
1412 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1414 my $payinfo = $self->payinfo;
1415 $payinfo =~ s/[^\d\@]//g;
1416 if ( $conf->exists('echeck-nonus') ) {
1417 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1418 $payinfo = "$1\@$2";
1420 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1421 $payinfo = "$1\@$2";
1423 $self->payinfo($payinfo);
1426 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1428 return 'Banned ACH account: banned on '.
1429 time2str('%a %h %o at %r', $ban->_date).
1430 ' by '. $ban->otaker.
1431 ' (ban# '. $ban->bannum. ')';
1434 } elsif ( $self->payby eq 'LECB' ) {
1436 my $payinfo = $self->payinfo;
1437 $payinfo =~ s/\D//g;
1438 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1440 $self->payinfo($payinfo);
1443 } elsif ( $self->payby eq 'BILL' ) {
1445 $error = $self->ut_textn('payinfo');
1446 return "Illegal P.O. number: ". $self->payinfo if $error;
1449 } elsif ( $self->payby eq 'COMP' ) {
1451 my $curuser = $FS::CurrentUser::CurrentUser;
1452 if ( ! $self->custnum
1453 && ! $curuser->access_right('Complimentary customer')
1456 return "You are not permitted to create complimentary accounts."
1459 $error = $self->ut_textn('payinfo');
1460 return "Illegal comp account issuer: ". $self->payinfo if $error;
1463 } elsif ( $self->payby eq 'PREPAY' ) {
1465 my $payinfo = $self->payinfo;
1466 $payinfo =~ s/\W//g; #anything else would just confuse things
1467 $self->payinfo($payinfo);
1468 $error = $self->ut_alpha('payinfo');
1469 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1470 return "Unknown prepayment identifier"
1471 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1476 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1477 return "Expiration date required"
1478 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1482 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1483 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1484 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1485 ( $m, $y ) = ( $3, "20$2" );
1487 return "Illegal expiration date: ". $self->paydate;
1489 $self->paydate("$y-$m-01");
1490 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1491 return gettext('expired_card')
1493 && !$ignore_expired_card
1494 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1497 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1498 ( ! $conf->exists('require_cardname')
1499 || $self->payby !~ /^(CARD|DCRD)$/ )
1501 $self->payname( $self->first. " ". $self->getfield('last') );
1503 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1504 or return gettext('illegal_name'). " payname: ". $self->payname;
1508 foreach my $flag (qw( tax spool_cdr )) {
1509 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1513 $self->otaker(getotaker) unless $self->otaker;
1515 warn "$me check AFTER: \n". $self->_dump
1518 $self->SUPER::check;
1523 Returns all packages (see L<FS::cust_pkg>) for this customer.
1530 return $self->num_pkgs unless wantarray;
1533 if ( $self->{'_pkgnum'} ) {
1534 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1536 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1539 sort sort_packages @cust_pkg;
1542 =item ncancelled_pkgs
1544 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1548 sub ncancelled_pkgs {
1551 return $self->num_ncancelled_pkgs unless wantarray;
1554 if ( $self->{'_pkgnum'} ) {
1556 @cust_pkg = grep { ! $_->getfield('cancel') }
1557 values %{ $self->{'_pkgnum'}->cache };
1562 qsearch( 'cust_pkg', {
1563 'custnum' => $self->custnum,
1567 qsearch( 'cust_pkg', {
1568 'custnum' => $self->custnum,
1573 sort sort_packages @cust_pkg;
1577 # This should be generalized to use config options to determine order.
1579 if ( $a->get('cancel') and $b->get('cancel') ) {
1580 $a->pkgnum <=> $b->pkgnum;
1581 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1582 return -1 if $b->get('cancel');
1583 return 1 if $a->get('cancel');
1586 $a->pkgnum <=> $b->pkgnum;
1590 =item suspended_pkgs
1592 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1596 sub suspended_pkgs {
1598 grep { $_->susp } $self->ncancelled_pkgs;
1601 =item unflagged_suspended_pkgs
1603 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1604 customer (thouse packages without the `manual_flag' set).
1608 sub unflagged_suspended_pkgs {
1610 return $self->suspended_pkgs
1611 unless dbdef->table('cust_pkg')->column('manual_flag');
1612 grep { ! $_->manual_flag } $self->suspended_pkgs;
1615 =item unsuspended_pkgs
1617 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1622 sub unsuspended_pkgs {
1624 grep { ! $_->susp } $self->ncancelled_pkgs;
1627 =item num_cancelled_pkgs
1629 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1634 sub num_cancelled_pkgs {
1635 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1638 sub num_ncancelled_pkgs {
1639 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1643 my( $self, $sql ) = @_;
1644 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1645 my $sth = dbh->prepare(
1646 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1647 ) or die dbh->errstr;
1648 $sth->execute($self->custnum) or die $sth->errstr;
1649 $sth->fetchrow_arrayref->[0];
1654 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1655 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1656 on success or a list of errors.
1662 grep { $_->unsuspend } $self->suspended_pkgs;
1667 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1669 Returns a list: an empty list on success or a list of errors.
1675 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1678 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1680 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1681 PKGPARTs (see L<FS::part_pkg>).
1683 Returns a list: an empty list on success or a list of errors.
1687 sub suspend_if_pkgpart {
1689 my (@pkgparts, %opt);
1690 if (ref($_[0]) eq 'HASH'){
1691 @pkgparts = @{$_[0]{pkgparts}};
1696 grep { $_->suspend(%opt) }
1697 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1698 $self->unsuspended_pkgs;
1701 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1703 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1704 listed PKGPARTs (see L<FS::part_pkg>).
1706 Returns a list: an empty list on success or a list of errors.
1710 sub suspend_unless_pkgpart {
1712 my (@pkgparts, %opt);
1713 if (ref($_[0]) eq 'HASH'){
1714 @pkgparts = @{$_[0]{pkgparts}};
1719 grep { $_->suspend(%opt) }
1720 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1721 $self->unsuspended_pkgs;
1724 =item cancel [ OPTION => VALUE ... ]
1726 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1728 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1730 I<quiet> can be set true to supress email cancellation notices.
1732 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1734 I<ban> can be set true to ban this customer's credit card or ACH information,
1737 Always returns a list: an empty list on success or a list of errors.
1745 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1747 #should try decryption (we might have the private key)
1748 # and if not maybe queue a job for the server that does?
1749 return ( "Can't (yet) ban encrypted credit cards" )
1750 if $self->is_encrypted($self->payinfo);
1752 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1753 my $error = $ban->insert;
1754 return ( $error ) if $error;
1758 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1761 sub _banned_pay_hashref {
1772 'payby' => $payby2ban{$self->payby},
1773 'payinfo' => md5_base64($self->payinfo),
1774 #don't ever *search* on reason! #'reason' =>
1780 Returns all notes (see L<FS::cust_main_note>) for this customer.
1787 qsearch( 'cust_main_note',
1788 { 'custnum' => $self->custnum },
1790 'ORDER BY _DATE DESC'
1796 Returns the agent (see L<FS::agent>) for this customer.
1802 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1807 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1808 conjunction with the collect method.
1810 Options are passed as name-value pairs.
1812 Currently available options are:
1814 resetup - if set true, re-charges setup fees.
1816 time - bills the customer as if it were that time. Specified as a UNIX
1817 timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
1818 L<Date::Parse> for conversion functions. For example:
1822 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1825 If there is an error, returns the error, otherwise returns false.
1830 my( $self, %options ) = @_;
1831 return '' if $self->payby eq 'COMP';
1832 warn "$me bill customer ". $self->custnum. "\n"
1835 my $time = $options{'time'} || time;
1840 local $SIG{HUP} = 'IGNORE';
1841 local $SIG{INT} = 'IGNORE';
1842 local $SIG{QUIT} = 'IGNORE';
1843 local $SIG{TERM} = 'IGNORE';
1844 local $SIG{TSTP} = 'IGNORE';
1845 local $SIG{PIPE} = 'IGNORE';
1847 my $oldAutoCommit = $FS::UID::AutoCommit;
1848 local $FS::UID::AutoCommit = 0;
1851 $self->select_for_update; #mutex
1853 #create a new invoice
1854 #(we'll remove it later if it doesn't actually need to be generated [contains
1855 # no line items] and we're inside a transaciton so nothing else will see it)
1856 my $cust_bill = new FS::cust_bill ( {
1857 'custnum' => $self->custnum,
1859 #'charged' => $charged,
1862 $error = $cust_bill->insert;
1864 $dbh->rollback if $oldAutoCommit;
1865 return "can't create invoice for customer #". $self->custnum. ": $error";
1867 my $invnum = $cust_bill->invnum;
1870 # find the packages which are due for billing, find out how much they are
1871 # & generate invoice database.
1874 my( $total_setup, $total_recur ) = ( 0, 0 );
1876 my @precommit_hooks = ();
1878 foreach my $cust_pkg (
1879 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1882 #NO!! next if $cust_pkg->cancel;
1883 next if $cust_pkg->getfield('cancel');
1885 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1887 #? to avoid use of uninitialized value errors... ?
1888 $cust_pkg->setfield('bill', '')
1889 unless defined($cust_pkg->bill);
1891 my $part_pkg = $cust_pkg->part_pkg;
1893 my %hash = $cust_pkg->hash;
1894 my $old_cust_pkg = new FS::cust_pkg \%hash;
1903 if ( !$cust_pkg->setup || $options{'resetup'} ) {
1905 warn " bill setup\n" if $DEBUG > 1;
1907 $setup = eval { $cust_pkg->calc_setup( $time ) };
1909 $dbh->rollback if $oldAutoCommit;
1910 return "$@ running calc_setup for $cust_pkg\n";
1913 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1917 # bill recurring fee
1922 if ( $part_pkg->getfield('freq') ne '0' &&
1923 ! $cust_pkg->getfield('susp') &&
1924 ( $cust_pkg->getfield('bill') || 0 ) <= $time
1927 warn " bill recur\n" if $DEBUG > 1;
1929 # XXX shared with $recur_prog
1930 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1932 #over two params! lets at least switch to a hashref for the rest...
1933 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1935 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1937 $dbh->rollback if $oldAutoCommit;
1938 return "$@ running calc_recur for $cust_pkg\n";
1941 #change this bit to use Date::Manip? CAREFUL with timezones (see
1942 # mailing list archive)
1943 my ($sec,$min,$hour,$mday,$mon,$year) =
1944 (localtime($sdate) )[0,1,2,3,4,5];
1946 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1947 # only for figuring next bill date, nothing else, so, reset $sdate again
1949 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1950 $cust_pkg->last_bill($sdate)
1951 if $cust_pkg->dbdef_table->column('last_bill');
1953 if ( $part_pkg->freq =~ /^\d+$/ ) {
1954 $mon += $part_pkg->freq;
1955 until ( $mon < 12 ) { $mon -= 12; $year++; }
1956 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1958 $mday += $weeks * 7;
1959 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1962 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1966 $dbh->rollback if $oldAutoCommit;
1967 return "unparsable frequency: ". $part_pkg->freq;
1969 $cust_pkg->setfield('bill',
1970 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1973 warn "\$setup is undefined" unless defined($setup);
1974 warn "\$recur is undefined" unless defined($recur);
1975 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1978 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1981 if ( $cust_pkg->modified ) {
1983 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1986 $error=$cust_pkg->replace($old_cust_pkg);
1987 if ( $error ) { #just in case
1988 $dbh->rollback if $oldAutoCommit;
1989 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1992 $setup = sprintf( "%.2f", $setup );
1993 $recur = sprintf( "%.2f", $recur );
1994 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1995 $dbh->rollback if $oldAutoCommit;
1996 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1998 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1999 $dbh->rollback if $oldAutoCommit;
2000 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2003 if ( $setup != 0 || $recur != 0 ) {
2005 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2007 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2008 'invnum' => $invnum,
2009 'pkgnum' => $cust_pkg->pkgnum,
2013 'edate' => $cust_pkg->bill,
2014 'details' => \@details,
2016 $error = $cust_bill_pkg->insert;
2018 $dbh->rollback if $oldAutoCommit;
2019 return "can't create invoice line item for invoice #$invnum: $error";
2021 $total_setup += $setup;
2022 $total_recur += $recur;
2028 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2031 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2034 my %taxhash = map { $_ => $self->get("$prefix$_") }
2035 qw( state county country );
2037 $taxhash{'taxclass'} = $part_pkg->taxclass;
2039 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2042 $taxhash{'taxclass'} = '';
2043 @taxes = qsearch( 'cust_main_county', \%taxhash );
2046 #one more try at a whole-country tax rate
2048 $taxhash{$_} = '' foreach qw( state county );
2049 @taxes = qsearch( 'cust_main_county', \%taxhash );
2052 # maybe eliminate this entirely, along with all the 0% records
2054 $dbh->rollback if $oldAutoCommit;
2056 "fatal: can't find tax rate for state/county/country/taxclass ".
2057 join('/', ( map $self->get("$prefix$_"),
2058 qw(state county country)
2060 $part_pkg->taxclass ). "\n";
2063 foreach my $tax ( @taxes ) {
2065 my $taxable_charged = 0;
2066 $taxable_charged += $setup
2067 unless $part_pkg->setuptax =~ /^Y$/i
2068 || $tax->setuptax =~ /^Y$/i;
2069 $taxable_charged += $recur
2070 unless $part_pkg->recurtax =~ /^Y$/i
2071 || $tax->recurtax =~ /^Y$/i;
2072 next unless $taxable_charged;
2074 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2075 #my ($mon,$year) = (localtime($sdate) )[4,5];
2076 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2078 my $freq = $part_pkg->freq || 1;
2079 if ( $freq !~ /(\d+)$/ ) {
2080 $dbh->rollback if $oldAutoCommit;
2081 return "daily/weekly package definitions not (yet?)".
2082 " compatible with monthly tax exemptions";
2084 my $taxable_per_month =
2085 sprintf("%.2f", $taxable_charged / $freq );
2087 #call the whole thing off if this customer has any old
2088 #exemption records...
2089 my @cust_tax_exempt =
2090 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2091 if ( @cust_tax_exempt ) {
2092 $dbh->rollback if $oldAutoCommit;
2094 'this customer still has old-style tax exemption records; '.
2095 'run bin/fs-migrate-cust_tax_exempt?';
2098 foreach my $which_month ( 1 .. $freq ) {
2100 #maintain the new exemption table now
2103 FROM cust_tax_exempt_pkg
2104 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2105 LEFT JOIN cust_bill USING ( invnum )
2111 my $sth = dbh->prepare($sql) or do {
2112 $dbh->rollback if $oldAutoCommit;
2113 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2121 $dbh->rollback if $oldAutoCommit;
2122 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2124 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2126 my $remaining_exemption =
2127 $tax->exempt_amount - $existing_exemption;
2128 if ( $remaining_exemption > 0 ) {
2129 my $addl = $remaining_exemption > $taxable_per_month
2130 ? $taxable_per_month
2131 : $remaining_exemption;
2132 $taxable_charged -= $addl;
2134 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2135 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2136 'taxnum' => $tax->taxnum,
2137 'year' => 1900+$year,
2139 'amount' => sprintf("%.2f", $addl ),
2141 $error = $cust_tax_exempt_pkg->insert;
2143 $dbh->rollback if $oldAutoCommit;
2144 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2146 } # if $remaining_exemption > 0
2150 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2151 until ( $mon < 13 ) { $mon -= 12; $year++; }
2153 } #foreach $which_month
2155 } #if $tax->exempt_amount
2157 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2159 #$tax += $taxable_charged * $cust_main_county->tax / 100
2160 $tax{ $tax->taxname || 'Tax' } +=
2161 $taxable_charged * $tax->tax / 100
2163 } #foreach my $tax ( @taxes )
2165 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2167 } #if $setup != 0 || $recur != 0
2169 } #if $cust_pkg->modified
2171 } #foreach my $cust_pkg
2173 unless ( $cust_bill->cust_bill_pkg ) {
2174 $cust_bill->delete; #don't create an invoice w/o line items
2175 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2179 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2181 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2182 my $tax = sprintf("%.2f", $tax{$taxname} );
2183 $charged = sprintf( "%.2f", $charged+$tax );
2185 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2186 'invnum' => $invnum,
2192 'itemdesc' => $taxname,
2194 $error = $cust_bill_pkg->insert;
2196 $dbh->rollback if $oldAutoCommit;
2197 return "can't create invoice line item for invoice #$invnum: $error";
2199 $total_setup += $tax;
2203 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2204 $error = $cust_bill->replace;
2206 $dbh->rollback if $oldAutoCommit;
2207 return "can't update charged for invoice #$invnum: $error";
2210 foreach my $hook ( @precommit_hooks ) {
2212 &{$hook}; #($self) ?
2215 $dbh->rollback if $oldAutoCommit;
2216 return "$@ running precommit hook $hook\n";
2220 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2224 =item collect OPTIONS
2226 (Attempt to) collect money for this customer's outstanding invoices (see
2227 L<FS::cust_bill>). Usually used after the bill method.
2229 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2230 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2231 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2233 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2234 and the invoice events web interface.
2236 If there is an error, returns the error, otherwise returns false.
2238 Options are passed as name-value pairs.
2240 Currently available options are:
2242 invoice_time - Use this time when deciding when to print invoices and
2243 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>
2244 for conversion functions.
2246 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2249 quiet - set true to surpress email card/ACH decline notices.
2251 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2254 payby - allows for one time override of normal customer billing method
2259 my( $self, %options ) = @_;
2260 my $invoice_time = $options{'invoice_time'} || time;
2263 local $SIG{HUP} = 'IGNORE';
2264 local $SIG{INT} = 'IGNORE';
2265 local $SIG{QUIT} = 'IGNORE';
2266 local $SIG{TERM} = 'IGNORE';
2267 local $SIG{TSTP} = 'IGNORE';
2268 local $SIG{PIPE} = 'IGNORE';
2270 my $oldAutoCommit = $FS::UID::AutoCommit;
2271 local $FS::UID::AutoCommit = 0;
2274 $self->select_for_update; #mutex
2276 my $balance = $self->balance;
2277 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2279 unless ( $balance > 0 ) { #redundant?????
2280 $dbh->rollback if $oldAutoCommit; #hmm
2284 if ( exists($options{'retry_card'}) ) {
2285 carp 'retry_card option passed to collect is deprecated; use retry';
2286 $options{'retry'} ||= $options{'retry_card'};
2288 if ( exists($options{'retry'}) && $options{'retry'} ) {
2289 my $error = $self->retry_realtime;
2291 $dbh->rollback if $oldAutoCommit;
2297 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2298 $extra_sql = " AND freq = '1m' ";
2300 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2303 foreach my $cust_bill ( $self->open_cust_bill ) {
2305 # don't try to charge for the same invoice if it's already in a batch
2306 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2308 last if $self->balance <= 0;
2310 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2313 foreach my $part_bill_event ( due_events ( $cust_bill,
2314 exists($options{'payby'})
2320 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2321 || $self->balance <= 0; # or if balance<=0
2324 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2325 warn " do_event " . $cust_bill . " ". (%options) . "\n"
2328 if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2329 # gah, even with transactions.
2330 $dbh->commit if $oldAutoCommit; #well.
2339 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2344 =item retry_realtime
2346 Schedules realtime / batch credit card / electronic check / LEC billing
2347 events for for retry. Useful if card information has changed or manual
2348 retry is desired. The 'collect' method must be called to actually retry
2351 Implementation details: For each of this customer's open invoices, changes
2352 the status of the first "done" (with statustext error) realtime processing
2357 sub retry_realtime {
2360 local $SIG{HUP} = 'IGNORE';
2361 local $SIG{INT} = 'IGNORE';
2362 local $SIG{QUIT} = 'IGNORE';
2363 local $SIG{TERM} = 'IGNORE';
2364 local $SIG{TSTP} = 'IGNORE';
2365 local $SIG{PIPE} = 'IGNORE';
2367 my $oldAutoCommit = $FS::UID::AutoCommit;
2368 local $FS::UID::AutoCommit = 0;
2371 foreach my $cust_bill (
2372 grep { $_->cust_bill_event }
2373 $self->open_cust_bill
2375 my @cust_bill_event =
2376 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2378 #$_->part_bill_event->plan eq 'realtime-card'
2379 $_->part_bill_event->eventcode =~
2380 /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2381 && $_->status eq 'done'
2384 $cust_bill->cust_bill_event;
2385 next unless @cust_bill_event;
2386 my $error = $cust_bill_event[0]->retry;
2388 $dbh->rollback if $oldAutoCommit;
2389 return "error scheduling invoice event for retry: $error";
2394 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2399 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2401 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2402 via a Business::OnlinePayment realtime gateway. See
2403 L<http://420.am/business-onlinepayment> for supported gateways.
2405 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2407 Available options are: I<description>, I<invnum>, I<quiet>
2409 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2410 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2411 if set, will override the value from the customer record.
2413 I<description> is a free-text field passed to the gateway. It defaults to
2414 "Internet services".
2416 If an I<invnum> is specified, this payment (if successful) is applied to the
2417 specified invoice. If you don't specify an I<invnum> you might want to
2418 call the B<apply_payments> method.
2420 I<quiet> can be set true to surpress email decline notices.
2422 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2427 my( $self, $method, $amount, %options ) = @_;
2429 warn "$me realtime_bop: $method $amount\n";
2430 warn " $_ => $options{$_}\n" foreach keys %options;
2433 $options{'description'} ||= 'Internet services';
2435 eval "use Business::OnlinePayment";
2438 my $payinfo = exists($options{'payinfo'})
2439 ? $options{'payinfo'}
2447 if ( $options{'invnum'} ) {
2448 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2449 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2451 map { $_->part_pkg->taxclass }
2453 map { $_->cust_pkg }
2454 $cust_bill->cust_bill_pkg;
2455 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2456 #different taxclasses
2457 $taxclass = $taxclasses[0];
2461 #look for an agent gateway override first
2463 if ( $method eq 'CC' ) {
2464 $cardtype = cardtype($payinfo);
2465 } elsif ( $method eq 'ECHECK' ) {
2468 $cardtype = $method;
2472 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2473 cardtype => $cardtype,
2474 taxclass => $taxclass, } )
2475 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2477 taxclass => $taxclass, } )
2478 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2479 cardtype => $cardtype,
2481 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2483 taxclass => '', } );
2485 my $payment_gateway = '';
2486 my( $processor, $login, $password, $action, @bop_options );
2487 if ( $override ) { #use a payment gateway override
2489 $payment_gateway = $override->payment_gateway;
2491 $processor = $payment_gateway->gateway_module;
2492 $login = $payment_gateway->gateway_username;
2493 $password = $payment_gateway->gateway_password;
2494 $action = $payment_gateway->gateway_action;
2495 @bop_options = $payment_gateway->options;
2497 } else { #use the standard settings from the config
2499 ( $processor, $login, $password, $action, @bop_options ) =
2500 $self->default_payment_gateway($method);
2508 my $address = exists($options{'address1'})
2509 ? $options{'address1'}
2511 my $address2 = exists($options{'address2'})
2512 ? $options{'address2'}
2514 $address .= ", ". $address2 if length($address2);
2516 my $o_payname = exists($options{'payname'})
2517 ? $options{'payname'}
2519 my($payname, $payfirst, $paylast);
2520 if ( $o_payname && $method ne 'ECHECK' ) {
2521 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2522 or return "Illegal payname $payname";
2523 ($payfirst, $paylast) = ($1, $2);
2525 $payfirst = $self->getfield('first');
2526 $paylast = $self->getfield('last');
2527 $payname = "$payfirst $paylast";
2530 my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
2531 if ( $conf->exists('emailinvoiceauto')
2532 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2533 push @invoicing_list, $self->all_emails;
2536 my $email = ($conf->exists('business-onlinepayment-email-override'))
2537 ? $conf->config('business-onlinepayment-email-override')
2538 : $invoicing_list[0];
2542 my $payip = exists($options{'payip'})
2545 $content{customer_ip} = $payip
2548 $content{invoice_number} = $options{'invnum'}
2549 if exists($options{'invnum'}) && length($options{'invnum'});
2551 if ( $method eq 'CC' ) {
2553 $content{card_number} = $payinfo;
2554 my $paydate = exists($options{'paydate'})
2555 ? $options{'paydate'}
2557 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2558 $content{expiration} = "$2/$1";
2560 my $paycvv = exists($options{'paycvv'})
2561 ? $options{'paycvv'}
2563 $content{cvv2} = $self->paycvv
2566 my $paystart_month = exists($options{'paystart_month'})
2567 ? $options{'paystart_month'}
2568 : $self->paystart_month;
2570 my $paystart_year = exists($options{'paystart_year'})
2571 ? $options{'paystart_year'}
2572 : $self->paystart_year;
2574 $content{card_start} = "$paystart_month/$paystart_year"
2575 if $paystart_month && $paystart_year;
2577 my $payissue = exists($options{'payissue'})
2578 ? $options{'payissue'}
2580 $content{issue_number} = $payissue if $payissue;
2582 $content{recurring_billing} = 'YES'
2583 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2585 'payinfo' => $payinfo,
2587 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2589 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2593 } elsif ( $method eq 'ECHECK' ) {
2594 ( $content{account_number}, $content{routing_code} ) =
2595 split('@', $payinfo);
2596 $content{bank_name} = $o_payname;
2597 $content{account_type} = 'CHECKING';
2598 $content{account_name} = $payname;
2599 $content{customer_org} = $self->company ? 'B' : 'I';
2600 $content{customer_ssn} = exists($options{'ss'})
2603 } elsif ( $method eq 'LEC' ) {
2604 $content{phone} = $payinfo;
2608 # run transaction(s)
2611 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2613 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2614 $transaction->content(
2617 'password' => $password,
2618 'action' => $action1,
2619 'description' => $options{'description'},
2620 'amount' => $amount,
2621 #'invoice_number' => $options{'invnum'},
2622 'customer_id' => $self->custnum,
2623 'last_name' => $paylast,
2624 'first_name' => $payfirst,
2626 'address' => $address,
2627 'city' => ( exists($options{'city'})
2630 'state' => ( exists($options{'state'})
2633 'zip' => ( exists($options{'zip'})
2636 'country' => ( exists($options{'country'})
2637 ? $options{'country'}
2639 'referer' => 'http://cleanwhisker.420.am/',
2641 'phone' => $self->daytime || $self->night,
2644 $transaction->submit();
2646 if ( $transaction->is_success() && $action2 ) {
2647 my $auth = $transaction->authorization;
2648 my $ordernum = $transaction->can('order_number')
2649 ? $transaction->order_number
2653 new Business::OnlinePayment( $processor, @bop_options );
2660 password => $password,
2661 order_number => $ordernum,
2663 authorization => $auth,
2664 description => $options{'description'},
2667 foreach my $field (qw( authorization_source_code returned_ACI
2668 transaction_identifier validation_code
2669 transaction_sequence_num local_transaction_date
2670 local_transaction_time AVS_result_code )) {
2671 $capture{$field} = $transaction->$field() if $transaction->can($field);
2674 $capture->content( %capture );
2678 unless ( $capture->is_success ) {
2679 my $e = "Authorization successful but capture failed, custnum #".
2680 $self->custnum. ': '. $capture->result_code.
2681 ": ". $capture->error_message;
2689 # remove paycvv after initial transaction
2692 #false laziness w/misc/process/payment.cgi - check both to make sure working
2694 if ( defined $self->dbdef_table->column('paycvv')
2695 && length($self->paycvv)
2696 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2698 my $error = $self->remove_cvv;
2700 warn "WARNING: error removing cvv: $error\n";
2708 if ( $transaction->is_success() ) {
2710 my %method2payby = (
2717 if ( $payment_gateway ) { # agent override
2718 $paybatch = $payment_gateway->gatewaynum. '-';
2721 $paybatch .= "$processor:". $transaction->authorization;
2723 $paybatch .= ':'. $transaction->order_number
2724 if $transaction->can('order_number')
2725 && length($transaction->order_number);
2727 my $cust_pay = new FS::cust_pay ( {
2728 'custnum' => $self->custnum,
2729 'invnum' => $options{'invnum'},
2732 'payby' => $method2payby{$method},
2733 'payinfo' => $payinfo,
2734 'paybatch' => $paybatch,
2736 my $error = $cust_pay->insert;
2738 $cust_pay->invnum(''); #try again with no specific invnum
2739 my $error2 = $cust_pay->insert;
2741 # gah, even with transactions.
2742 my $e = 'WARNING: Card/ACH debited but database not updated - '.
2743 "error inserting payment ($processor): $error2".
2744 " (previously tried insert with invnum #$options{'invnum'}" .
2750 return ''; #no error
2754 my $perror = "$processor error: ". $transaction->error_message;
2756 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2757 && $conf->exists('emaildecline')
2758 && grep { $_ ne 'POST' } $self->invoicing_list
2759 && ! grep { $transaction->error_message =~ /$_/ }
2760 $conf->config('emaildecline-exclude')
2762 my @templ = $conf->config('declinetemplate');
2763 my $template = new Text::Template (
2765 SOURCE => [ map "$_\n", @templ ],
2766 ) or return "($perror) can't create template: $Text::Template::ERROR";
2767 $template->compile()
2768 or return "($perror) can't compile template: $Text::Template::ERROR";
2770 my $templ_hash = { error => $transaction->error_message };
2772 my $error = send_email(
2773 'from' => $conf->config('invoice_from'),
2774 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2775 'subject' => 'Your payment could not be processed',
2776 'body' => [ $template->fill_in(HASH => $templ_hash) ],
2779 $perror .= " (also received error sending decline notification: $error)"
2789 =item default_payment_gateway
2793 sub default_payment_gateway {
2794 my( $self, $method ) = @_;
2796 die "Real-time processing not enabled\n"
2797 unless $conf->exists('business-onlinepayment');
2800 my $bop_config = 'business-onlinepayment';
2801 $bop_config .= '-ach'
2802 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2803 my ( $processor, $login, $password, $action, @bop_options ) =
2804 $conf->config($bop_config);
2805 $action ||= 'normal authorization';
2806 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2807 die "No real-time processor is enabled - ".
2808 "did you set the business-onlinepayment configuration value?\n"
2811 ( $processor, $login, $password, $action, @bop_options )
2816 Removes the I<paycvv> field from the database directly.
2818 If there is an error, returns the error, otherwise returns false.
2824 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2825 or return dbh->errstr;
2826 $sth->execute($self->custnum)
2827 or return $sth->errstr;
2832 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2834 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2835 via a Business::OnlinePayment realtime gateway. See
2836 L<http://420.am/business-onlinepayment> for supported gateways.
2838 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2840 Available options are: I<amount>, I<reason>, I<paynum>
2842 Most gateways require a reference to an original payment transaction to refund,
2843 so you probably need to specify a I<paynum>.
2845 I<amount> defaults to the original amount of the payment if not specified.
2847 I<reason> specifies a reason for the refund.
2849 Implementation note: If I<amount> is unspecified or equal to the amount of the
2850 orignal payment, first an attempt is made to "void" the transaction via
2851 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2852 the normal attempt is made to "refund" ("credit") the transaction via the
2853 gateway is attempted.
2855 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2856 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2857 #if set, will override the value from the customer record.
2859 #If an I<invnum> is specified, this payment (if successful) is applied to the
2860 #specified invoice. If you don't specify an I<invnum> you might want to
2861 #call the B<apply_payments> method.
2865 #some false laziness w/realtime_bop, not enough to make it worth merging
2866 #but some useful small subs should be pulled out
2867 sub realtime_refund_bop {
2868 my( $self, $method, %options ) = @_;
2870 warn "$me realtime_refund_bop: $method refund\n";
2871 warn " $_ => $options{$_}\n" foreach keys %options;
2874 eval "use Business::OnlinePayment";
2878 # look up the original payment and optionally a gateway for that payment
2882 my $amount = $options{'amount'};
2884 my( $processor, $login, $password, @bop_options ) ;
2885 my( $auth, $order_number ) = ( '', '', '' );
2887 if ( $options{'paynum'} ) {
2889 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
2890 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2891 or return "Unknown paynum $options{'paynum'}";
2892 $amount ||= $cust_pay->paid;
2894 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-]*)(:([\w\-]+))?$/
2895 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2896 $cust_pay->paybatch;
2897 my $gatewaynum = '';
2898 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2900 if ( $gatewaynum ) { #gateway for the payment to be refunded
2902 my $payment_gateway =
2903 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2904 die "payment gateway $gatewaynum not found"
2905 unless $payment_gateway;
2907 $processor = $payment_gateway->gateway_module;
2908 $login = $payment_gateway->gateway_username;
2909 $password = $payment_gateway->gateway_password;
2910 @bop_options = $payment_gateway->options;
2912 } else { #try the default gateway
2914 my( $conf_processor, $unused_action );
2915 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2916 $self->default_payment_gateway($method);
2918 return "processor of payment $options{'paynum'} $processor does not".
2919 " match default processor $conf_processor"
2920 unless $processor eq $conf_processor;
2925 } else { # didn't specify a paynum, so look for agent gateway overrides
2926 # like a normal transaction
2929 if ( $method eq 'CC' ) {
2930 $cardtype = cardtype($self->payinfo);
2931 } elsif ( $method eq 'ECHECK' ) {
2934 $cardtype = $method;
2937 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2938 cardtype => $cardtype,
2940 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2942 taxclass => '', } );
2944 if ( $override ) { #use a payment gateway override
2946 my $payment_gateway = $override->payment_gateway;
2948 $processor = $payment_gateway->gateway_module;
2949 $login = $payment_gateway->gateway_username;
2950 $password = $payment_gateway->gateway_password;
2951 #$action = $payment_gateway->gateway_action;
2952 @bop_options = $payment_gateway->options;
2954 } else { #use the standard settings from the config
2957 ( $processor, $login, $password, $unused_action, @bop_options ) =
2958 $self->default_payment_gateway($method);
2963 return "neither amount nor paynum specified" unless $amount;
2968 'password' => $password,
2969 'order_number' => $order_number,
2970 'amount' => $amount,
2971 'referer' => 'http://cleanwhisker.420.am/',
2973 $content{authorization} = $auth
2974 if length($auth); #echeck/ACH transactions have an order # but no auth
2975 #(at least with authorize.net)
2977 #first try void if applicable
2978 if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
2979 warn " attempting void\n" if $DEBUG > 1;
2980 my $void = new Business::OnlinePayment( $processor, @bop_options );
2981 $void->content( 'action' => 'void', %content );
2983 if ( $void->is_success ) {
2984 my $error = $cust_pay->void($options{'reason'});
2986 # gah, even with transactions.
2987 my $e = 'WARNING: Card/ACH voided but database not updated - '.
2988 "error voiding payment: $error";
2992 warn " void successful\n" if $DEBUG > 1;
2997 warn " void unsuccessful, trying refund\n"
3001 my $address = $self->address1;
3002 $address .= ", ". $self->address2 if $self->address2;
3004 my($payname, $payfirst, $paylast);
3005 if ( $self->payname && $method ne 'ECHECK' ) {
3006 $payname = $self->payname;
3007 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3008 or return "Illegal payname $payname";
3009 ($payfirst, $paylast) = ($1, $2);
3011 $payfirst = $self->getfield('first');
3012 $paylast = $self->getfield('last');
3013 $payname = "$payfirst $paylast";
3016 my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
3017 if ( $conf->exists('emailinvoiceauto')
3018 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3019 push @invoicing_list, $self->all_emails;
3022 my $email = ($conf->exists('business-onlinepayment-email-override'))
3023 ? $conf->config('business-onlinepayment-email-override')
3024 : $invoicing_list[0];
3026 my $payip = exists($options{'payip'})
3029 $content{customer_ip} = $payip
3033 if ( $method eq 'CC' ) {
3036 $content{card_number} = $payinfo = $cust_pay->payinfo;
3037 #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3038 #$content{expiration} = "$2/$1";
3040 $content{card_number} = $payinfo = $self->payinfo;
3041 $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3042 $content{expiration} = "$2/$1";
3045 } elsif ( $method eq 'ECHECK' ) {
3046 ( $content{account_number}, $content{routing_code} ) =
3047 split('@', $payinfo = $self->payinfo);
3048 $content{bank_name} = $self->payname;
3049 $content{account_type} = 'CHECKING';
3050 $content{account_name} = $payname;
3051 $content{customer_org} = $self->company ? 'B' : 'I';
3052 $content{customer_ssn} = $self->ss;
3053 } elsif ( $method eq 'LEC' ) {
3054 $content{phone} = $payinfo = $self->payinfo;
3058 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3059 my %sub_content = $refund->content(
3060 'action' => 'credit',
3061 'customer_id' => $self->custnum,
3062 'last_name' => $paylast,
3063 'first_name' => $payfirst,
3065 'address' => $address,
3066 'city' => $self->city,
3067 'state' => $self->state,
3068 'zip' => $self->zip,
3069 'country' => $self->country,
3071 'phone' => $self->daytime || $self->night,
3074 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3078 return "$processor error: ". $refund->error_message
3079 unless $refund->is_success();
3081 my %method2payby = (
3087 my $paybatch = "$processor:". $refund->authorization;
3088 $paybatch .= ':'. $refund->order_number
3089 if $refund->can('order_number') && $refund->order_number;
3091 while ( $cust_pay && $cust_pay->unappled < $amount ) {
3092 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3093 last unless @cust_bill_pay;
3094 my $cust_bill_pay = pop @cust_bill_pay;
3095 my $error = $cust_bill_pay->delete;
3099 my $cust_refund = new FS::cust_refund ( {
3100 'custnum' => $self->custnum,
3101 'paynum' => $options{'paynum'},
3102 'refund' => $amount,
3104 'payby' => $method2payby{$method},
3105 'payinfo' => $payinfo,
3106 'paybatch' => $paybatch,
3107 'reason' => $options{'reason'} || 'card or ACH refund',
3109 my $error = $cust_refund->insert;
3111 $cust_refund->paynum(''); #try again with no specific paynum
3112 my $error2 = $cust_refund->insert;
3114 # gah, even with transactions.
3115 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3116 "error inserting refund ($processor): $error2".
3117 " (previously tried insert with paynum #$options{'paynum'}" .
3130 Returns the total owed for this customer on all invoices
3131 (see L<FS::cust_bill/owed>).
3137 $self->total_owed_date(2145859200); #12/31/2037
3140 =item total_owed_date TIME
3142 Returns the total owed for this customer on all invoices with date earlier than
3143 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3144 see L<Time::Local> and L<Date::Parse> for conversion functions.
3148 sub total_owed_date {
3152 foreach my $cust_bill (
3153 grep { $_->_date <= $time }
3154 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3156 $total_bill += $cust_bill->owed;
3158 sprintf( "%.2f", $total_bill );
3161 =item apply_credits OPTION => VALUE ...
3163 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3164 to outstanding invoice balances in chronological order (or reverse
3165 chronological order if the I<order> option is set to B<newest>) and returns the
3166 value of any remaining unapplied credits available for refund (see
3167 L<FS::cust_refund>).
3175 return 0 unless $self->total_credited;
3177 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3178 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3180 my @invoices = $self->open_cust_bill;
3181 @invoices = sort { $b->_date <=> $a->_date } @invoices
3182 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3185 foreach my $cust_bill ( @invoices ) {
3188 if ( !defined($credit) || $credit->credited == 0) {
3189 $credit = pop @credits or last;
3192 if ($cust_bill->owed >= $credit->credited) {
3193 $amount=$credit->credited;
3195 $amount=$cust_bill->owed;
3198 my $cust_credit_bill = new FS::cust_credit_bill ( {
3199 'crednum' => $credit->crednum,
3200 'invnum' => $cust_bill->invnum,
3201 'amount' => $amount,
3203 my $error = $cust_credit_bill->insert;
3204 die $error if $error;
3206 redo if ($cust_bill->owed > 0);
3210 return $self->total_credited;
3213 =item apply_payments
3215 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3216 to outstanding invoice balances in chronological order.
3218 #and returns the value of any remaining unapplied payments.
3222 sub apply_payments {
3227 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3228 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3230 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3231 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3235 foreach my $cust_bill ( @invoices ) {
3238 if ( !defined($payment) || $payment->unapplied == 0 ) {
3239 $payment = pop @payments or last;
3242 if ( $cust_bill->owed >= $payment->unapplied ) {
3243 $amount = $payment->unapplied;
3245 $amount = $cust_bill->owed;
3248 my $cust_bill_pay = new FS::cust_bill_pay ( {
3249 'paynum' => $payment->paynum,
3250 'invnum' => $cust_bill->invnum,
3251 'amount' => $amount,
3253 my $error = $cust_bill_pay->insert;
3254 die $error if $error;
3256 redo if ( $cust_bill->owed > 0);
3260 return $self->total_unapplied_payments;
3263 =item total_credited
3265 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3266 customer. See L<FS::cust_credit/credited>.
3270 sub total_credited {
3272 my $total_credit = 0;
3273 foreach my $cust_credit ( qsearch('cust_credit', {
3274 'custnum' => $self->custnum,
3276 $total_credit += $cust_credit->credited;
3278 sprintf( "%.2f", $total_credit );
3281 =item total_unapplied_payments
3283 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3284 See L<FS::cust_pay/unapplied>.
3288 sub total_unapplied_payments {
3290 my $total_unapplied = 0;
3291 foreach my $cust_pay ( qsearch('cust_pay', {
3292 'custnum' => $self->custnum,
3294 $total_unapplied += $cust_pay->unapplied;
3296 sprintf( "%.2f", $total_unapplied );
3301 Returns the balance for this customer (total_owed minus total_credited
3302 minus total_unapplied_payments).
3309 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3313 =item balance_date TIME
3315 Returns the balance for this customer, only considering invoices with date
3316 earlier than TIME (total_owed_date minus total_credited minus
3317 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3318 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3327 $self->total_owed_date($time)
3328 - $self->total_credited
3329 - $self->total_unapplied_payments
3333 =item in_transit_payments
3335 Returns the total of requests for payments for this customer pending in
3336 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3340 sub in_transit_payments {
3342 my $in_transit_payments = 0;
3343 foreach my $pay_batch ( qsearch('pay_batch', {
3346 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3347 'batchnum' => $pay_batch->batchnum,
3348 'custnum' => $self->custnum,
3350 $in_transit_payments += $cust_pay_batch->amount;
3353 sprintf( "%.2f", $in_transit_payments );
3356 =item paydate_monthyear
3358 Returns a two-element list consisting of the month and year of this customer's
3359 paydate (credit card expiration date for CARD customers)
3363 sub paydate_monthyear {
3365 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3367 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3374 =item invoicing_list [ ARRAYREF ]
3376 If an arguement is given, sets these email addresses as invoice recipients
3377 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3378 (except as warnings), so use check_invoicing_list first.
3380 Returns a list of email addresses (with svcnum entries expanded).
3382 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3383 check it without disturbing anything by passing nothing.
3385 This interface may change in the future.
3389 sub invoicing_list {
3390 my( $self, $arrayref ) = @_;
3393 my @cust_main_invoice;
3394 if ( $self->custnum ) {
3395 @cust_main_invoice =
3396 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3398 @cust_main_invoice = ();
3400 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3401 #warn $cust_main_invoice->destnum;
3402 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3403 #warn $cust_main_invoice->destnum;
3404 my $error = $cust_main_invoice->delete;
3405 warn $error if $error;
3408 if ( $self->custnum ) {
3409 @cust_main_invoice =
3410 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3412 @cust_main_invoice = ();
3414 my %seen = map { $_->address => 1 } @cust_main_invoice;
3415 foreach my $address ( @{$arrayref} ) {
3416 next if exists $seen{$address} && $seen{$address};
3417 $seen{$address} = 1;
3418 my $cust_main_invoice = new FS::cust_main_invoice ( {
3419 'custnum' => $self->custnum,
3422 my $error = $cust_main_invoice->insert;
3423 warn $error if $error;
3427 if ( $self->custnum ) {
3429 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3436 =item check_invoicing_list ARRAYREF
3438 Checks these arguements as valid input for the invoicing_list method. If there
3439 is an error, returns the error, otherwise returns false.
3443 sub check_invoicing_list {
3444 my( $self, $arrayref ) = @_;
3445 foreach my $address ( @{$arrayref} ) {
3447 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3448 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3451 my $cust_main_invoice = new FS::cust_main_invoice ( {
3452 'custnum' => $self->custnum,
3455 my $error = $self->custnum
3456 ? $cust_main_invoice->check
3457 : $cust_main_invoice->checkdest
3459 return $error if $error;
3464 =item set_default_invoicing_list
3466 Sets the invoicing list to all accounts associated with this customer,
3467 overwriting any previous invoicing list.
3471 sub set_default_invoicing_list {
3473 $self->invoicing_list($self->all_emails);
3478 Returns the email addresses of all accounts provisioned for this customer.
3485 foreach my $cust_pkg ( $self->all_pkgs ) {
3486 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3488 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3489 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3491 $list{$_}=1 foreach map { $_->email } @svc_acct;
3496 =item invoicing_list_addpost
3498 Adds postal invoicing to this customer. If this customer is already configured
3499 to receive postal invoices, does nothing.
3503 sub invoicing_list_addpost {
3505 return if grep { $_ eq 'POST' } $self->invoicing_list;
3506 my @invoicing_list = $self->invoicing_list;
3507 push @invoicing_list, 'POST';
3508 $self->invoicing_list(\@invoicing_list);
3511 =item invoicing_list_emailonly
3513 Returns the list of email invoice recipients (invoicing_list without non-email
3514 destinations such as POST and FAX).
3518 sub invoicing_list_emailonly {
3520 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3523 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3525 Returns an array of customers referred by this customer (referral_custnum set
3526 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3527 customers referred by customers referred by this customer and so on, inclusive.
3528 The default behavior is DEPTH 1 (no recursion).
3532 sub referral_cust_main {
3534 my $depth = @_ ? shift : 1;
3535 my $exclude = @_ ? shift : {};
3538 map { $exclude->{$_->custnum}++; $_; }
3539 grep { ! $exclude->{ $_->custnum } }
3540 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3544 map { $_->referral_cust_main($depth-1, $exclude) }
3551 =item referral_cust_main_ncancelled
3553 Same as referral_cust_main, except only returns customers with uncancelled
3558 sub referral_cust_main_ncancelled {
3560 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3563 =item referral_cust_pkg [ DEPTH ]
3565 Like referral_cust_main, except returns a flat list of all unsuspended (and
3566 uncancelled) packages for each customer. The number of items in this list may
3567 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3571 sub referral_cust_pkg {
3573 my $depth = @_ ? shift : 1;
3575 map { $_->unsuspended_pkgs }
3576 grep { $_->unsuspended_pkgs }
3577 $self->referral_cust_main($depth);
3580 =item referring_cust_main
3582 Returns the single cust_main record for the customer who referred this customer
3583 (referral_custnum), or false.
3587 sub referring_cust_main {
3589 return '' unless $self->referral_custnum;
3590 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3593 =item credit AMOUNT, REASON
3595 Applies a credit to this customer. If there is an error, returns the error,
3596 otherwise returns false.
3601 my( $self, $amount, $reason ) = @_;
3602 my $cust_credit = new FS::cust_credit {
3603 'custnum' => $self->custnum,
3604 'amount' => $amount,
3605 'reason' => $reason,
3607 $cust_credit->insert;
3610 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3612 Creates a one-time charge for this customer. If there is an error, returns
3613 the error, otherwise returns false.
3618 my ( $self, $amount ) = ( shift, shift );
3619 my $pkg = @_ ? shift : 'One-time charge';
3620 my $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3621 my $taxclass = @_ ? shift : '';
3623 local $SIG{HUP} = 'IGNORE';
3624 local $SIG{INT} = 'IGNORE';
3625 local $SIG{QUIT} = 'IGNORE';
3626 local $SIG{TERM} = 'IGNORE';
3627 local $SIG{TSTP} = 'IGNORE';
3628 local $SIG{PIPE} = 'IGNORE';
3630 my $oldAutoCommit = $FS::UID::AutoCommit;
3631 local $FS::UID::AutoCommit = 0;
3634 my $part_pkg = new FS::part_pkg ( {
3636 'comment' => $comment,
3637 #'setup' => $amount,
3640 'plandata' => "setup_fee=$amount",
3643 'taxclass' => $taxclass,
3646 my $error = $part_pkg->insert;
3648 $dbh->rollback if $oldAutoCommit;
3652 my $pkgpart = $part_pkg->pkgpart;
3653 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3654 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3655 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3656 $error = $type_pkgs->insert;
3658 $dbh->rollback if $oldAutoCommit;
3663 my $cust_pkg = new FS::cust_pkg ( {
3664 'custnum' => $self->custnum,
3665 'pkgpart' => $pkgpart,
3668 $error = $cust_pkg->insert;
3670 $dbh->rollback if $oldAutoCommit;
3674 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3681 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3687 sort { $a->_date <=> $b->_date }
3688 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3691 =item open_cust_bill
3693 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3698 sub open_cust_bill {
3700 grep { $_->owed > 0 } $self->cust_bill;
3705 Returns all the credits (see L<FS::cust_credit>) for this customer.
3711 sort { $a->_date <=> $b->_date }
3712 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3717 Returns all the payments (see L<FS::cust_pay>) for this customer.
3723 sort { $a->_date <=> $b->_date }
3724 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3729 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3735 sort { $a->_date <=> $b->_date }
3736 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3742 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3748 sort { $a->_date <=> $b->_date }
3749 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3752 =item select_for_update
3754 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
3759 sub select_for_update {
3761 qsearch('cust_main', { 'custnum' => $self->custnum }, '*', 'FOR UPDATE' );
3766 Returns a name string for this customer, either "Company (Last, First)" or
3773 my $name = $self->contact;
3774 $name = $self->company. " ($name)" if $self->company;
3780 Returns a name string for this (service/shipping) contact, either
3781 "Company (Last, First)" or "Last, First".
3787 if ( $self->get('ship_last') ) {
3788 my $name = $self->ship_contact;
3789 $name = $self->ship_company. " ($name)" if $self->ship_company;
3798 Returns this customer's full (billing) contact name only, "Last, First"
3804 $self->get('last'). ', '. $self->first;
3809 Returns this customer's full (shipping) contact name only, "Last, First"
3815 $self->get('ship_last')
3816 ? $self->get('ship_last'). ', '. $self->ship_first
3822 Returns this customer's full country name
3828 code2country($self->country);
3833 Returns a status string for this customer, currently:
3837 =item prospect - No packages have ever been ordered
3839 =item active - One or more recurring packages is active
3841 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3843 =item suspended - All non-cancelled recurring packages are suspended
3845 =item cancelled - All recurring packages are cancelled
3853 for my $status (qw( prospect active inactive suspended cancelled )) {
3854 my $method = $status.'_sql';
3855 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3856 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3857 $sth->execute( ($self->custnum) x $numnum ) or die $sth->errstr;
3858 return $status if $sth->fetchrow_arrayref->[0];
3864 Returns a hex triplet color string for this customer's status.
3868 use vars qw(%statuscolor);
3870 'prospect' => '7e0079', #'000000', #black? naw, purple
3871 'active' => '00CC00', #green
3872 'inactive' => '0000CC', #blue
3873 'suspended' => 'FF9900', #yellow
3874 'cancelled' => 'FF0000', #red
3879 $statuscolor{$self->status};
3884 =head1 CLASS METHODS
3890 Returns an SQL expression identifying prospective cust_main records (customers
3891 with no packages ever ordered)
3895 use vars qw($select_count_pkgs);
3896 $select_count_pkgs =
3897 "SELECT COUNT(*) FROM cust_pkg
3898 WHERE cust_pkg.custnum = cust_main.custnum";
3900 sub select_count_pkgs_sql {
3904 sub prospect_sql { "
3905 0 = ( $select_count_pkgs )
3910 Returns an SQL expression identifying active cust_main records (customers with
3911 no active recurring packages, but otherwise unsuspended/uncancelled).
3916 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
3922 Returns an SQL expression identifying inactive cust_main records (customers with
3923 active recurring packages).
3927 sub inactive_sql { "
3928 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3930 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
3936 Returns an SQL expression identifying suspended cust_main records.
3941 sub suspended_sql { susp_sql(@_); }
3943 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
3945 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3951 Returns an SQL expression identifying cancelled cust_main records.
3955 sub cancelled_sql { cancel_sql(@_); }
3958 my $recurring_sql = FS::cust_pkg->recurring_sql;
3959 #my $recurring_sql = "
3960 # '0' != ( select freq from part_pkg
3961 # where cust_pkg.pkgpart = part_pkg.pkgpart )
3965 0 < ( $select_count_pkgs )
3966 AND 0 = ( $select_count_pkgs AND $recurring_sql
3967 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3973 =item uncancelled_sql
3975 Returns an SQL expression identifying un-cancelled cust_main records.
3979 sub uncancelled_sql { uncancel_sql(@_); }
3980 sub uncancel_sql { "
3981 ( 0 < ( $select_count_pkgs
3982 AND ( cust_pkg.cancel IS NULL
3983 OR cust_pkg.cancel = 0
3986 OR 0 = ( $select_count_pkgs )
3990 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
3992 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
3993 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
3994 appropriate ship_ field is also searched).
3996 Additional options are the same as FS::Record::qsearch
4001 my( $self, $fuzzy, $hash, @opt) = @_;
4006 check_and_rebuild_fuzzyfiles();
4007 foreach my $field ( keys %$fuzzy ) {
4009 my $all = $self->all_X($field);
4010 next unless scalar(@$all);
4013 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4016 foreach ( keys %match ) {
4017 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4018 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4021 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4024 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4026 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4038 =item smart_search OPTION => VALUE ...
4040 Accepts the following options: I<search>, the string to search for. The string
4041 will be searched for as a customer number, phone number, name or company name,
4042 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4043 for the exact heuristics used).
4045 Any additional options are treated as an additional qualifier on the search
4048 Returns a (possibly empty) array of FS::cust_main objects.
4055 #here is the agent virtualization
4056 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4060 my $search = delete $options{'search'};
4061 ( my $alphanum_search = $search ) =~ s/\W//g;
4063 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4065 #false laziness w/Record::ut_phone
4066 my $phonen = "$1-$2-$3";
4067 $phonen .= " x$4" if $4;
4069 push @cust_main, qsearch( {
4070 'table' => 'cust_main',
4071 'hashref' => { %options },
4072 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4074 join(' OR ', map "$_ = '$phonen'",
4075 qw( daytime night fax
4076 ship_daytime ship_night ship_fax )
4079 " AND $agentnums_sql", #agent virtualization
4082 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4083 #try looking for matches with extensions unless one was specified
4085 push @cust_main, qsearch( {
4086 'table' => 'cust_main',
4087 'hashref' => { %options },
4088 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4090 join(' OR ', map "$_ LIKE '$phonen\%'",
4092 ship_daytime ship_night )
4095 " AND $agentnums_sql", #agent virtualization
4100 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4102 push @cust_main, qsearch( {
4103 'table' => 'cust_main',
4104 'hashref' => { 'custnum' => $1, %options },
4105 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4108 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4110 my($company, $last, $first) = ( $1, $2, $3 );
4112 # "Company (Last, First)"
4113 #this is probably something a browser remembered,
4114 #so just do an exact search
4116 foreach my $prefix ( '', 'ship_' ) {
4117 push @cust_main, qsearch( {
4118 'table' => 'cust_main',
4119 'hashref' => { $prefix.'first' => $first,
4120 $prefix.'last' => $last,
4121 $prefix.'company' => $company,
4124 'extra_sql' => " AND $agentnums_sql",
4128 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4129 # try (ship_){last,company}
4133 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4134 # # full strings the browser remembers won't work
4135 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4137 use Lingua::EN::NameParse;
4138 my $NameParse = new Lingua::EN::NameParse(
4140 allow_reversed => 1,
4143 my($last, $first) = ( '', '' );
4144 #maybe disable this too and just rely on NameParse?
4145 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4147 ($last, $first) = ( $1, $2 );
4149 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
4150 } elsif ( ! $NameParse->parse($value) ) {
4152 my %name = $NameParse->components;
4153 $first = $name{'given_name_1'};
4154 $last = $name{'surname_1'};
4158 if ( $first && $last ) {
4160 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4163 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4165 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4166 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4169 push @cust_main, qsearch( {
4170 'table' => 'cust_main',
4171 'hashref' => \%options,
4172 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4175 # or it just be something that was typed in... (try that in a sec)
4179 my $q_value = dbh->quote($value);
4182 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4183 $sql .= " ( LOWER(last) = $q_value
4184 OR LOWER(company) = $q_value
4185 OR LOWER(ship_last) = $q_value
4186 OR LOWER(ship_company) = $q_value
4189 push @cust_main, qsearch( {
4190 'table' => 'cust_main',
4191 'hashref' => \%options,
4192 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4195 #always do substring & fuzzy,
4196 #getting complains searches are not returning enough
4197 #unless ( @cust_main ) { #no exact match, trying substring/fuzzy
4199 #still some false laziness w/ search/cust_main.cgi
4204 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
4205 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4208 if ( $first && $last ) {
4211 { 'first' => { op=>'ILIKE', value=>"%$first%" },
4212 'last' => { op=>'ILIKE', value=>"%$last%" },
4214 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
4215 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
4222 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
4223 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
4227 foreach my $hashref ( @hashrefs ) {
4229 push @cust_main, qsearch( {
4230 'table' => 'cust_main',
4231 'hashref' => { %$hashref,
4234 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4243 " AND $agentnums_sql", #extra_sql #agent virtualization
4246 if ( $first && $last ) {
4247 push @cust_main, FS::cust_main->fuzzy_search(
4248 { 'last' => $last, #fuzzy hashref
4249 'first' => $first }, #
4253 foreach my $field ( 'last', 'company' ) {
4255 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4260 #eliminate duplicates
4262 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4270 =item check_and_rebuild_fuzzyfiles
4274 use vars qw(@fuzzyfields);
4275 @fuzzyfields = ( 'last', 'first', 'company' );
4277 sub check_and_rebuild_fuzzyfiles {
4278 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4279 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4282 =item rebuild_fuzzyfiles
4286 sub rebuild_fuzzyfiles {
4288 use Fcntl qw(:flock);
4290 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4291 mkdir $dir, 0700 unless -d $dir;
4293 foreach my $fuzzy ( @fuzzyfields ) {
4295 open(LOCK,">>$dir/cust_main.$fuzzy")
4296 or die "can't open $dir/cust_main.$fuzzy: $!";
4298 or die "can't lock $dir/cust_main.$fuzzy: $!";
4300 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4301 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4303 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4304 my $sth = dbh->prepare("SELECT $field FROM cust_main".
4305 " WHERE $field != '' AND $field IS NOT NULL");
4306 $sth->execute or die $sth->errstr;
4308 while ( my $row = $sth->fetchrow_arrayref ) {
4309 print CACHE $row->[0]. "\n";
4314 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4316 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4327 my( $self, $field ) = @_;
4328 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4329 open(CACHE,"<$dir/cust_main.$field")
4330 or die "can't open $dir/cust_main.$field: $!";
4331 my @array = map { chomp; $_; } <CACHE>;
4336 =item append_fuzzyfiles LASTNAME COMPANY
4340 sub append_fuzzyfiles {
4341 #my( $first, $last, $company ) = @_;
4343 &check_and_rebuild_fuzzyfiles;
4345 use Fcntl qw(:flock);
4347 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4349 foreach my $field (qw( first last company )) {
4354 open(CACHE,">>$dir/cust_main.$field")
4355 or die "can't open $dir/cust_main.$field: $!";
4356 flock(CACHE,LOCK_EX)
4357 or die "can't lock $dir/cust_main.$field: $!";
4359 print CACHE "$value\n";
4361 flock(CACHE,LOCK_UN)
4362 or die "can't unlock $dir/cust_main.$field: $!";
4377 #warn join('-',keys %$param);
4378 my $fh = $param->{filehandle};
4379 my $agentnum = $param->{agentnum};
4381 my $refnum = $param->{refnum};
4382 my $pkgpart = $param->{pkgpart};
4384 #my @fields = @{$param->{fields}};
4385 my $format = $param->{'format'};
4388 if ( $format eq 'simple' ) {
4389 @fields = qw( cust_pkg.setup dayphone first last
4390 address1 address2 city state zip comments );
4392 } elsif ( $format eq 'extended' ) {
4393 @fields = qw( agent_custid refnum
4394 last first address1 address2 city state zip country
4396 ship_last ship_first ship_address1 ship_address2
4397 ship_city ship_state ship_zip ship_country
4398 payinfo paycvv paydate
4401 svc_acct.username svc_acct._password
4405 die "unknown format $format";
4408 eval "use Text::CSV_XS;";
4411 my $csv = new Text::CSV_XS;
4418 local $SIG{HUP} = 'IGNORE';
4419 local $SIG{INT} = 'IGNORE';
4420 local $SIG{QUIT} = 'IGNORE';
4421 local $SIG{TERM} = 'IGNORE';
4422 local $SIG{TSTP} = 'IGNORE';
4423 local $SIG{PIPE} = 'IGNORE';
4425 my $oldAutoCommit = $FS::UID::AutoCommit;
4426 local $FS::UID::AutoCommit = 0;
4429 #while ( $columns = $csv->getline($fh) ) {
4431 while ( defined($line=<$fh>) ) {
4433 $csv->parse($line) or do {
4434 $dbh->rollback if $oldAutoCommit;
4435 return "can't parse: ". $csv->error_input();
4438 my @columns = $csv->fields();
4439 #warn join('-',@columns);
4442 agentnum => $agentnum,
4444 country => $conf->config('countrydefault') || 'US',
4445 payby => $payby, #default
4446 paydate => '12/2037', #default
4448 my $billtime = time;
4449 my %cust_pkg = ( pkgpart => $pkgpart );
4451 foreach my $field ( @fields ) {
4453 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4455 #$cust_pkg{$1} = str2time( shift @$columns );
4456 if ( $1 eq 'pkgpart' ) {
4457 $cust_pkg{$1} = shift @columns;
4458 } elsif ( $1 eq 'setup' ) {
4459 $billtime = str2time(shift @columns);
4461 $cust_pkg{$1} = str2time( shift @columns );
4464 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4466 $svc_acct{$1} = shift @columns;
4470 #refnum interception
4471 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4473 my $referral = $columns[0];
4474 my %hash = ( 'referral' => $referral,
4475 'agentnum' => $agentnum,
4479 my $part_referral = qsearchs('part_referral', \%hash )
4480 || new FS::part_referral \%hash;
4482 unless ( $part_referral->refnum ) {
4483 my $error = $part_referral->insert;
4485 $dbh->rollback if $oldAutoCommit;
4486 return "can't auto-insert advertising source: $referral: $error";
4490 $columns[0] = $part_referral->refnum;
4493 #$cust_main{$field} = shift @$columns;
4494 $cust_main{$field} = shift @columns;
4498 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4500 my $invoicing_list = $cust_main{'invoicing_list'}
4501 ? [ delete $cust_main{'invoicing_list'} ]
4504 my $cust_main = new FS::cust_main ( \%cust_main );
4507 tie my %hash, 'Tie::RefHash'; #this part is important
4509 if ( $cust_pkg{'pkgpart'} ) {
4510 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4513 if ( $svc_acct{'username'} ) {
4514 my $part_pkg = $cust_pkg->part_pkg;
4515 unless ( $part_pkg ) {
4516 $dbh->rollback if $oldAutoCommit;
4517 return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4519 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4520 push @svc_acct, new FS::svc_acct ( \%svc_acct )
4523 $hash{$cust_pkg} = \@svc_acct;
4526 my $error = $cust_main->insert( \%hash, $invoicing_list );
4529 $dbh->rollback if $oldAutoCommit;
4530 return "can't insert customer for $line: $error";
4533 if ( $format eq 'simple' ) {
4535 #false laziness w/bill.cgi
4536 $error = $cust_main->bill( 'time' => $billtime );
4538 $dbh->rollback if $oldAutoCommit;
4539 return "can't bill customer for $line: $error";
4542 $cust_main->apply_payments;
4543 $cust_main->apply_credits;
4545 $error = $cust_main->collect();
4547 $dbh->rollback if $oldAutoCommit;
4548 return "can't collect customer for $line: $error";
4556 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4558 return "Empty file!" unless $imported;
4570 #warn join('-',keys %$param);
4571 my $fh = $param->{filehandle};
4572 my @fields = @{$param->{fields}};
4574 eval "use Text::CSV_XS;";
4577 my $csv = new Text::CSV_XS;
4584 local $SIG{HUP} = 'IGNORE';
4585 local $SIG{INT} = 'IGNORE';
4586 local $SIG{QUIT} = 'IGNORE';
4587 local $SIG{TERM} = 'IGNORE';
4588 local $SIG{TSTP} = 'IGNORE';
4589 local $SIG{PIPE} = 'IGNORE';
4591 my $oldAutoCommit = $FS::UID::AutoCommit;
4592 local $FS::UID::AutoCommit = 0;
4595 #while ( $columns = $csv->getline($fh) ) {
4597 while ( defined($line=<$fh>) ) {
4599 $csv->parse($line) or do {
4600 $dbh->rollback if $oldAutoCommit;
4601 return "can't parse: ". $csv->error_input();
4604 my @columns = $csv->fields();
4605 #warn join('-',@columns);
4608 foreach my $field ( @fields ) {
4609 $row{$field} = shift @columns;
4612 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4613 unless ( $cust_main ) {
4614 $dbh->rollback if $oldAutoCommit;
4615 return "unknown custnum $row{'custnum'}";
4618 if ( $row{'amount'} > 0 ) {
4619 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4621 $dbh->rollback if $oldAutoCommit;
4625 } elsif ( $row{'amount'} < 0 ) {
4626 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4629 $dbh->rollback if $oldAutoCommit;
4639 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4641 return "Empty file!" unless $imported;
4653 The delete method should possibly take an FS::cust_main object reference
4654 instead of a scalar customer number.
4656 Bill and collect options should probably be passed as references instead of a
4659 There should probably be a configuration file with a list of allowed credit
4662 No multiple currency support (probably a larger project than just this module).
4664 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4666 Birthdates rely on negative epoch values.
4670 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4671 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4672 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.