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.
1529 if ( $self->{'_pkgnum'} ) {
1530 values %{ $self->{'_pkgnum'}->cache };
1532 qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1536 =item ncancelled_pkgs
1538 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1542 sub ncancelled_pkgs {
1544 if ( $self->{'_pkgnum'} ) {
1545 grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
1547 @{ [ # force list context
1548 qsearch( 'cust_pkg', {
1549 'custnum' => $self->custnum,
1552 qsearch( 'cust_pkg', {
1553 'custnum' => $self->custnum,
1560 =item suspended_pkgs
1562 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1566 sub suspended_pkgs {
1568 grep { $_->susp } $self->ncancelled_pkgs;
1571 =item unflagged_suspended_pkgs
1573 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1574 customer (thouse packages without the `manual_flag' set).
1578 sub unflagged_suspended_pkgs {
1580 return $self->suspended_pkgs
1581 unless dbdef->table('cust_pkg')->column('manual_flag');
1582 grep { ! $_->manual_flag } $self->suspended_pkgs;
1585 =item unsuspended_pkgs
1587 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1592 sub unsuspended_pkgs {
1594 grep { ! $_->susp } $self->ncancelled_pkgs;
1597 =item num_cancelled_pkgs
1599 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1604 sub num_cancelled_pkgs {
1606 $self->num_pkgs("cancel IS NOT NULL AND cust_pkg.cancel != 0");
1610 my( $self, $sql ) = @_;
1611 my $sth = dbh->prepare(
1612 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? AND $sql"
1613 ) or die dbh->errstr;
1614 $sth->execute($self->custnum) or die $sth->errstr;
1615 $sth->fetchrow_arrayref->[0];
1620 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1621 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1622 on success or a list of errors.
1628 grep { $_->unsuspend } $self->suspended_pkgs;
1633 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1635 Returns a list: an empty list on success or a list of errors.
1641 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1644 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1646 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1647 PKGPARTs (see L<FS::part_pkg>).
1649 Returns a list: an empty list on success or a list of errors.
1653 sub suspend_if_pkgpart {
1655 my (@pkgparts, %opt);
1656 if (ref($_[0]) eq 'HASH'){
1657 @pkgparts = @{$_[0]{pkgparts}};
1662 grep { $_->suspend(%opt) }
1663 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1664 $self->unsuspended_pkgs;
1667 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1669 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1670 listed PKGPARTs (see L<FS::part_pkg>).
1672 Returns a list: an empty list on success or a list of errors.
1676 sub suspend_unless_pkgpart {
1678 my (@pkgparts, %opt);
1679 if (ref($_[0]) eq 'HASH'){
1680 @pkgparts = @{$_[0]{pkgparts}};
1685 grep { $_->suspend(%opt) }
1686 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1687 $self->unsuspended_pkgs;
1690 =item cancel [ OPTION => VALUE ... ]
1692 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1694 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1696 I<quiet> can be set true to supress email cancellation notices.
1698 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1700 I<ban> can be set true to ban this customer's credit card or ACH information,
1703 Always returns a list: an empty list on success or a list of errors.
1711 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1713 #should try decryption (we might have the private key)
1714 # and if not maybe queue a job for the server that does?
1715 return ( "Can't (yet) ban encrypted credit cards" )
1716 if $self->is_encrypted($self->payinfo);
1718 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1719 my $error = $ban->insert;
1720 return ( $error ) if $error;
1724 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1727 sub _banned_pay_hashref {
1738 'payby' => $payby2ban{$self->payby},
1739 'payinfo' => md5_base64($self->payinfo),
1746 Returns all notes (see L<FS::cust_main_note>) for this customer.
1753 qsearch( 'cust_main_note',
1754 { 'custnum' => $self->custnum },
1756 'ORDER BY _DATE DESC'
1762 Returns the agent (see L<FS::agent>) for this customer.
1768 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1773 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1774 conjunction with the collect method.
1776 Options are passed as name-value pairs.
1778 Currently available options are:
1780 resetup - if set true, re-charges setup fees.
1782 time - bills the customer as if it were that time. Specified as a UNIX
1783 timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
1784 L<Date::Parse> for conversion functions. For example:
1788 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1791 If there is an error, returns the error, otherwise returns false.
1796 my( $self, %options ) = @_;
1797 return '' if $self->payby eq 'COMP';
1798 warn "$me bill customer ". $self->custnum. "\n"
1801 my $time = $options{'time'} || time;
1806 local $SIG{HUP} = 'IGNORE';
1807 local $SIG{INT} = 'IGNORE';
1808 local $SIG{QUIT} = 'IGNORE';
1809 local $SIG{TERM} = 'IGNORE';
1810 local $SIG{TSTP} = 'IGNORE';
1811 local $SIG{PIPE} = 'IGNORE';
1813 my $oldAutoCommit = $FS::UID::AutoCommit;
1814 local $FS::UID::AutoCommit = 0;
1817 $self->select_for_update; #mutex
1819 #create a new invoice
1820 #(we'll remove it later if it doesn't actually need to be generated [contains
1821 # no line items] and we're inside a transaciton so nothing else will see it)
1822 my $cust_bill = new FS::cust_bill ( {
1823 'custnum' => $self->custnum,
1825 #'charged' => $charged,
1828 $error = $cust_bill->insert;
1830 $dbh->rollback if $oldAutoCommit;
1831 return "can't create invoice for customer #". $self->custnum. ": $error";
1833 my $invnum = $cust_bill->invnum;
1836 # find the packages which are due for billing, find out how much they are
1837 # & generate invoice database.
1840 my( $total_setup, $total_recur ) = ( 0, 0 );
1842 my @precommit_hooks = ();
1844 foreach my $cust_pkg (
1845 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1848 #NO!! next if $cust_pkg->cancel;
1849 next if $cust_pkg->getfield('cancel');
1851 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1853 #? to avoid use of uninitialized value errors... ?
1854 $cust_pkg->setfield('bill', '')
1855 unless defined($cust_pkg->bill);
1857 my $part_pkg = $cust_pkg->part_pkg;
1859 my %hash = $cust_pkg->hash;
1860 my $old_cust_pkg = new FS::cust_pkg \%hash;
1869 if ( !$cust_pkg->setup || $options{'resetup'} ) {
1871 warn " bill setup\n" if $DEBUG > 1;
1873 $setup = eval { $cust_pkg->calc_setup( $time ) };
1875 $dbh->rollback if $oldAutoCommit;
1876 return "$@ running calc_setup for $cust_pkg\n";
1879 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1883 # bill recurring fee
1888 if ( $part_pkg->getfield('freq') ne '0' &&
1889 ! $cust_pkg->getfield('susp') &&
1890 ( $cust_pkg->getfield('bill') || 0 ) <= $time
1893 warn " bill recur\n" if $DEBUG > 1;
1895 # XXX shared with $recur_prog
1896 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1898 #over two params! lets at least switch to a hashref for the rest...
1899 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1901 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1903 $dbh->rollback if $oldAutoCommit;
1904 return "$@ running calc_recur for $cust_pkg\n";
1907 #change this bit to use Date::Manip? CAREFUL with timezones (see
1908 # mailing list archive)
1909 my ($sec,$min,$hour,$mday,$mon,$year) =
1910 (localtime($sdate) )[0,1,2,3,4,5];
1912 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1913 # only for figuring next bill date, nothing else, so, reset $sdate again
1915 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1916 $cust_pkg->last_bill($sdate)
1917 if $cust_pkg->dbdef_table->column('last_bill');
1919 if ( $part_pkg->freq =~ /^\d+$/ ) {
1920 $mon += $part_pkg->freq;
1921 until ( $mon < 12 ) { $mon -= 12; $year++; }
1922 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1924 $mday += $weeks * 7;
1925 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1928 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1932 $dbh->rollback if $oldAutoCommit;
1933 return "unparsable frequency: ". $part_pkg->freq;
1935 $cust_pkg->setfield('bill',
1936 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1939 warn "\$setup is undefined" unless defined($setup);
1940 warn "\$recur is undefined" unless defined($recur);
1941 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1944 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1947 if ( $cust_pkg->modified ) {
1949 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1952 $error=$cust_pkg->replace($old_cust_pkg);
1953 if ( $error ) { #just in case
1954 $dbh->rollback if $oldAutoCommit;
1955 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1958 $setup = sprintf( "%.2f", $setup );
1959 $recur = sprintf( "%.2f", $recur );
1960 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1961 $dbh->rollback if $oldAutoCommit;
1962 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1964 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1965 $dbh->rollback if $oldAutoCommit;
1966 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1969 if ( $setup != 0 || $recur != 0 ) {
1971 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1973 my $cust_bill_pkg = new FS::cust_bill_pkg ({
1974 'invnum' => $invnum,
1975 'pkgnum' => $cust_pkg->pkgnum,
1979 'edate' => $cust_pkg->bill,
1980 'details' => \@details,
1982 $error = $cust_bill_pkg->insert;
1984 $dbh->rollback if $oldAutoCommit;
1985 return "can't create invoice line item for invoice #$invnum: $error";
1987 $total_setup += $setup;
1988 $total_recur += $recur;
1994 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
1997 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2000 my %taxhash = map { $_ => $self->get("$prefix$_") }
2001 qw( state county country );
2003 $taxhash{'taxclass'} = $part_pkg->taxclass;
2005 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2008 $taxhash{'taxclass'} = '';
2009 @taxes = qsearch( 'cust_main_county', \%taxhash );
2012 #one more try at a whole-country tax rate
2014 $taxhash{$_} = '' foreach qw( state county );
2015 @taxes = qsearch( 'cust_main_county', \%taxhash );
2018 # maybe eliminate this entirely, along with all the 0% records
2020 $dbh->rollback if $oldAutoCommit;
2022 "fatal: can't find tax rate for state/county/country/taxclass ".
2023 join('/', ( map $self->get("$prefix$_"),
2024 qw(state county country)
2026 $part_pkg->taxclass ). "\n";
2029 foreach my $tax ( @taxes ) {
2031 my $taxable_charged = 0;
2032 $taxable_charged += $setup
2033 unless $part_pkg->setuptax =~ /^Y$/i
2034 || $tax->setuptax =~ /^Y$/i;
2035 $taxable_charged += $recur
2036 unless $part_pkg->recurtax =~ /^Y$/i
2037 || $tax->recurtax =~ /^Y$/i;
2038 next unless $taxable_charged;
2040 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2041 #my ($mon,$year) = (localtime($sdate) )[4,5];
2042 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2044 my $freq = $part_pkg->freq || 1;
2045 if ( $freq !~ /(\d+)$/ ) {
2046 $dbh->rollback if $oldAutoCommit;
2047 return "daily/weekly package definitions not (yet?)".
2048 " compatible with monthly tax exemptions";
2050 my $taxable_per_month =
2051 sprintf("%.2f", $taxable_charged / $freq );
2053 #call the whole thing off if this customer has any old
2054 #exemption records...
2055 my @cust_tax_exempt =
2056 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2057 if ( @cust_tax_exempt ) {
2058 $dbh->rollback if $oldAutoCommit;
2060 'this customer still has old-style tax exemption records; '.
2061 'run bin/fs-migrate-cust_tax_exempt?';
2064 foreach my $which_month ( 1 .. $freq ) {
2066 #maintain the new exemption table now
2069 FROM cust_tax_exempt_pkg
2070 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2071 LEFT JOIN cust_bill USING ( invnum )
2077 my $sth = dbh->prepare($sql) or do {
2078 $dbh->rollback if $oldAutoCommit;
2079 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2087 $dbh->rollback if $oldAutoCommit;
2088 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2090 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2092 my $remaining_exemption =
2093 $tax->exempt_amount - $existing_exemption;
2094 if ( $remaining_exemption > 0 ) {
2095 my $addl = $remaining_exemption > $taxable_per_month
2096 ? $taxable_per_month
2097 : $remaining_exemption;
2098 $taxable_charged -= $addl;
2100 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2101 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2102 'taxnum' => $tax->taxnum,
2103 'year' => 1900+$year,
2105 'amount' => sprintf("%.2f", $addl ),
2107 $error = $cust_tax_exempt_pkg->insert;
2109 $dbh->rollback if $oldAutoCommit;
2110 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2112 } # if $remaining_exemption > 0
2116 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2117 until ( $mon < 13 ) { $mon -= 12; $year++; }
2119 } #foreach $which_month
2121 } #if $tax->exempt_amount
2123 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2125 #$tax += $taxable_charged * $cust_main_county->tax / 100
2126 $tax{ $tax->taxname || 'Tax' } +=
2127 $taxable_charged * $tax->tax / 100
2129 } #foreach my $tax ( @taxes )
2131 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2133 } #if $setup != 0 || $recur != 0
2135 } #if $cust_pkg->modified
2137 } #foreach my $cust_pkg
2139 unless ( $cust_bill->cust_bill_pkg ) {
2140 $cust_bill->delete; #don't create an invoice w/o line items
2141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2145 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2147 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2148 my $tax = sprintf("%.2f", $tax{$taxname} );
2149 $charged = sprintf( "%.2f", $charged+$tax );
2151 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2152 'invnum' => $invnum,
2158 'itemdesc' => $taxname,
2160 $error = $cust_bill_pkg->insert;
2162 $dbh->rollback if $oldAutoCommit;
2163 return "can't create invoice line item for invoice #$invnum: $error";
2165 $total_setup += $tax;
2169 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2170 $error = $cust_bill->replace;
2172 $dbh->rollback if $oldAutoCommit;
2173 return "can't update charged for invoice #$invnum: $error";
2176 foreach my $hook ( @precommit_hooks ) {
2178 &{$hook}; #($self) ?
2181 $dbh->rollback if $oldAutoCommit;
2182 return "$@ running precommit hook $hook\n";
2186 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2190 =item collect OPTIONS
2192 (Attempt to) collect money for this customer's outstanding invoices (see
2193 L<FS::cust_bill>). Usually used after the bill method.
2195 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2196 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2197 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2199 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2200 and the invoice events web interface.
2202 If there is an error, returns the error, otherwise returns false.
2204 Options are passed as name-value pairs.
2206 Currently available options are:
2208 invoice_time - Use this time when deciding when to print invoices and
2209 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>
2210 for conversion functions.
2212 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2215 quiet - set true to surpress email card/ACH decline notices.
2217 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2220 payby - allows for one time override of normal customer billing method
2225 my( $self, %options ) = @_;
2226 my $invoice_time = $options{'invoice_time'} || time;
2229 local $SIG{HUP} = 'IGNORE';
2230 local $SIG{INT} = 'IGNORE';
2231 local $SIG{QUIT} = 'IGNORE';
2232 local $SIG{TERM} = 'IGNORE';
2233 local $SIG{TSTP} = 'IGNORE';
2234 local $SIG{PIPE} = 'IGNORE';
2236 my $oldAutoCommit = $FS::UID::AutoCommit;
2237 local $FS::UID::AutoCommit = 0;
2240 $self->select_for_update; #mutex
2242 my $balance = $self->balance;
2243 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2245 unless ( $balance > 0 ) { #redundant?????
2246 $dbh->rollback if $oldAutoCommit; #hmm
2250 if ( exists($options{'retry_card'}) ) {
2251 carp 'retry_card option passed to collect is deprecated; use retry';
2252 $options{'retry'} ||= $options{'retry_card'};
2254 if ( exists($options{'retry'}) && $options{'retry'} ) {
2255 my $error = $self->retry_realtime;
2257 $dbh->rollback if $oldAutoCommit;
2263 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2264 $extra_sql = " AND freq = '1m' ";
2266 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2269 foreach my $cust_bill ( $self->open_cust_bill ) {
2271 # don't try to charge for the same invoice if it's already in a batch
2272 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2274 last if $self->balance <= 0;
2276 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2279 foreach my $part_bill_event ( due_events ( $cust_bill,
2280 exists($options{'payby'})
2286 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2287 || $self->balance <= 0; # or if balance<=0
2290 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2291 warn " do_event " . $cust_bill . " ". (%options) . "\n"
2294 if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2295 # gah, even with transactions.
2296 $dbh->commit if $oldAutoCommit; #well.
2305 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2310 =item retry_realtime
2312 Schedules realtime / batch credit card / electronic check / LEC billing
2313 events for for retry. Useful if card information has changed or manual
2314 retry is desired. The 'collect' method must be called to actually retry
2317 Implementation details: For each of this customer's open invoices, changes
2318 the status of the first "done" (with statustext error) realtime processing
2323 sub retry_realtime {
2326 local $SIG{HUP} = 'IGNORE';
2327 local $SIG{INT} = 'IGNORE';
2328 local $SIG{QUIT} = 'IGNORE';
2329 local $SIG{TERM} = 'IGNORE';
2330 local $SIG{TSTP} = 'IGNORE';
2331 local $SIG{PIPE} = 'IGNORE';
2333 my $oldAutoCommit = $FS::UID::AutoCommit;
2334 local $FS::UID::AutoCommit = 0;
2337 foreach my $cust_bill (
2338 grep { $_->cust_bill_event }
2339 $self->open_cust_bill
2341 my @cust_bill_event =
2342 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2344 #$_->part_bill_event->plan eq 'realtime-card'
2345 $_->part_bill_event->eventcode =~
2346 /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2347 && $_->status eq 'done'
2350 $cust_bill->cust_bill_event;
2351 next unless @cust_bill_event;
2352 my $error = $cust_bill_event[0]->retry;
2354 $dbh->rollback if $oldAutoCommit;
2355 return "error scheduling invoice event for retry: $error";
2360 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2365 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2367 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2368 via a Business::OnlinePayment realtime gateway. See
2369 L<http://420.am/business-onlinepayment> for supported gateways.
2371 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2373 Available options are: I<description>, I<invnum>, I<quiet>
2375 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2376 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2377 if set, will override the value from the customer record.
2379 I<description> is a free-text field passed to the gateway. It defaults to
2380 "Internet services".
2382 If an I<invnum> is specified, this payment (if successful) is applied to the
2383 specified invoice. If you don't specify an I<invnum> you might want to
2384 call the B<apply_payments> method.
2386 I<quiet> can be set true to surpress email decline notices.
2388 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2393 my( $self, $method, $amount, %options ) = @_;
2395 warn "$me realtime_bop: $method $amount\n";
2396 warn " $_ => $options{$_}\n" foreach keys %options;
2399 $options{'description'} ||= 'Internet services';
2401 eval "use Business::OnlinePayment";
2404 my $payinfo = exists($options{'payinfo'})
2405 ? $options{'payinfo'}
2413 if ( $options{'invnum'} ) {
2414 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2415 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2417 map { $_->part_pkg->taxclass }
2419 map { $_->cust_pkg }
2420 $cust_bill->cust_bill_pkg;
2421 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2422 #different taxclasses
2423 $taxclass = $taxclasses[0];
2427 #look for an agent gateway override first
2429 if ( $method eq 'CC' ) {
2430 $cardtype = cardtype($payinfo);
2431 } elsif ( $method eq 'ECHECK' ) {
2434 $cardtype = $method;
2438 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2439 cardtype => $cardtype,
2440 taxclass => $taxclass, } )
2441 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2443 taxclass => $taxclass, } )
2444 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2445 cardtype => $cardtype,
2447 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2449 taxclass => '', } );
2451 my $payment_gateway = '';
2452 my( $processor, $login, $password, $action, @bop_options );
2453 if ( $override ) { #use a payment gateway override
2455 $payment_gateway = $override->payment_gateway;
2457 $processor = $payment_gateway->gateway_module;
2458 $login = $payment_gateway->gateway_username;
2459 $password = $payment_gateway->gateway_password;
2460 $action = $payment_gateway->gateway_action;
2461 @bop_options = $payment_gateway->options;
2463 } else { #use the standard settings from the config
2465 ( $processor, $login, $password, $action, @bop_options ) =
2466 $self->default_payment_gateway($method);
2474 my $address = exists($options{'address1'})
2475 ? $options{'address1'}
2477 my $address2 = exists($options{'address2'})
2478 ? $options{'address2'}
2480 $address .= ", ". $address2 if length($address2);
2482 my $o_payname = exists($options{'payname'})
2483 ? $options{'payname'}
2485 my($payname, $payfirst, $paylast);
2486 if ( $o_payname && $method ne 'ECHECK' ) {
2487 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2488 or return "Illegal payname $payname";
2489 ($payfirst, $paylast) = ($1, $2);
2491 $payfirst = $self->getfield('first');
2492 $paylast = $self->getfield('last');
2493 $payname = "$payfirst $paylast";
2496 my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
2497 if ( $conf->exists('emailinvoiceauto')
2498 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2499 push @invoicing_list, $self->all_emails;
2502 my $email = ($conf->exists('business-onlinepayment-email-override'))
2503 ? $conf->config('business-onlinepayment-email-override')
2504 : $invoicing_list[0];
2508 my $payip = exists($options{'payip'})
2511 $content{customer_ip} = $payip
2514 $content{invoice_number} = $options{'invnum'}
2515 if exists($options{'invnum'}) && length($options{'invnum'});
2517 if ( $method eq 'CC' ) {
2519 $content{card_number} = $payinfo;
2520 my $paydate = exists($options{'paydate'})
2521 ? $options{'paydate'}
2523 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2524 $content{expiration} = "$2/$1";
2526 my $paycvv = exists($options{'paycvv'})
2527 ? $options{'paycvv'}
2529 $content{cvv2} = $self->paycvv
2532 my $paystart_month = exists($options{'paystart_month'})
2533 ? $options{'paystart_month'}
2534 : $self->paystart_month;
2536 my $paystart_year = exists($options{'paystart_year'})
2537 ? $options{'paystart_year'}
2538 : $self->paystart_year;
2540 $content{card_start} = "$paystart_month/$paystart_year"
2541 if $paystart_month && $paystart_year;
2543 my $payissue = exists($options{'payissue'})
2544 ? $options{'payissue'}
2546 $content{issue_number} = $payissue if $payissue;
2548 $content{recurring_billing} = 'YES'
2549 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2551 'payinfo' => $payinfo,
2553 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2555 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2559 } elsif ( $method eq 'ECHECK' ) {
2560 ( $content{account_number}, $content{routing_code} ) =
2561 split('@', $payinfo);
2562 $content{bank_name} = $o_payname;
2563 $content{account_type} = 'CHECKING';
2564 $content{account_name} = $payname;
2565 $content{customer_org} = $self->company ? 'B' : 'I';
2566 $content{customer_ssn} = exists($options{'ss'})
2569 } elsif ( $method eq 'LEC' ) {
2570 $content{phone} = $payinfo;
2574 # run transaction(s)
2577 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2579 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2580 $transaction->content(
2583 'password' => $password,
2584 'action' => $action1,
2585 'description' => $options{'description'},
2586 'amount' => $amount,
2587 #'invoice_number' => $options{'invnum'},
2588 'customer_id' => $self->custnum,
2589 'last_name' => $paylast,
2590 'first_name' => $payfirst,
2592 'address' => $address,
2593 'city' => ( exists($options{'city'})
2596 'state' => ( exists($options{'state'})
2599 'zip' => ( exists($options{'zip'})
2602 'country' => ( exists($options{'country'})
2603 ? $options{'country'}
2605 'referer' => 'http://cleanwhisker.420.am/',
2607 'phone' => $self->daytime || $self->night,
2610 $transaction->submit();
2612 if ( $transaction->is_success() && $action2 ) {
2613 my $auth = $transaction->authorization;
2614 my $ordernum = $transaction->can('order_number')
2615 ? $transaction->order_number
2619 new Business::OnlinePayment( $processor, @bop_options );
2626 password => $password,
2627 order_number => $ordernum,
2629 authorization => $auth,
2630 description => $options{'description'},
2633 foreach my $field (qw( authorization_source_code returned_ACI
2634 transaction_identifier validation_code
2635 transaction_sequence_num local_transaction_date
2636 local_transaction_time AVS_result_code )) {
2637 $capture{$field} = $transaction->$field() if $transaction->can($field);
2640 $capture->content( %capture );
2644 unless ( $capture->is_success ) {
2645 my $e = "Authorization successful but capture failed, custnum #".
2646 $self->custnum. ': '. $capture->result_code.
2647 ": ". $capture->error_message;
2655 # remove paycvv after initial transaction
2658 #false laziness w/misc/process/payment.cgi - check both to make sure working
2660 if ( defined $self->dbdef_table->column('paycvv')
2661 && length($self->paycvv)
2662 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2664 my $error = $self->remove_cvv;
2666 warn "WARNING: error removing cvv: $error\n";
2674 if ( $transaction->is_success() ) {
2676 my %method2payby = (
2683 if ( $payment_gateway ) { # agent override
2684 $paybatch = $payment_gateway->gatewaynum. '-';
2687 $paybatch .= "$processor:". $transaction->authorization;
2689 $paybatch .= ':'. $transaction->order_number
2690 if $transaction->can('order_number')
2691 && length($transaction->order_number);
2693 my $cust_pay = new FS::cust_pay ( {
2694 'custnum' => $self->custnum,
2695 'invnum' => $options{'invnum'},
2698 'payby' => $method2payby{$method},
2699 'payinfo' => $payinfo,
2700 'paybatch' => $paybatch,
2702 my $error = $cust_pay->insert;
2704 $cust_pay->invnum(''); #try again with no specific invnum
2705 my $error2 = $cust_pay->insert;
2707 # gah, even with transactions.
2708 my $e = 'WARNING: Card/ACH debited but database not updated - '.
2709 "error inserting payment ($processor): $error2".
2710 " (previously tried insert with invnum #$options{'invnum'}" .
2716 return ''; #no error
2720 my $perror = "$processor error: ". $transaction->error_message;
2722 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2723 && $conf->exists('emaildecline')
2724 && grep { $_ ne 'POST' } $self->invoicing_list
2725 && ! grep { $transaction->error_message =~ /$_/ }
2726 $conf->config('emaildecline-exclude')
2728 my @templ = $conf->config('declinetemplate');
2729 my $template = new Text::Template (
2731 SOURCE => [ map "$_\n", @templ ],
2732 ) or return "($perror) can't create template: $Text::Template::ERROR";
2733 $template->compile()
2734 or return "($perror) can't compile template: $Text::Template::ERROR";
2736 my $templ_hash = { error => $transaction->error_message };
2738 my $error = send_email(
2739 'from' => $conf->config('invoice_from'),
2740 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2741 'subject' => 'Your payment could not be processed',
2742 'body' => [ $template->fill_in(HASH => $templ_hash) ],
2745 $perror .= " (also received error sending decline notification: $error)"
2755 =item default_payment_gateway
2759 sub default_payment_gateway {
2760 my( $self, $method ) = @_;
2762 die "Real-time processing not enabled\n"
2763 unless $conf->exists('business-onlinepayment');
2766 my $bop_config = 'business-onlinepayment';
2767 $bop_config .= '-ach'
2768 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2769 my ( $processor, $login, $password, $action, @bop_options ) =
2770 $conf->config($bop_config);
2771 $action ||= 'normal authorization';
2772 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2773 die "No real-time processor is enabled - ".
2774 "did you set the business-onlinepayment configuration value?\n"
2777 ( $processor, $login, $password, $action, @bop_options )
2782 Removes the I<paycvv> field from the database directly.
2784 If there is an error, returns the error, otherwise returns false.
2790 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2791 or return dbh->errstr;
2792 $sth->execute($self->custnum)
2793 or return $sth->errstr;
2798 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2800 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2801 via a Business::OnlinePayment realtime gateway. See
2802 L<http://420.am/business-onlinepayment> for supported gateways.
2804 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2806 Available options are: I<amount>, I<reason>, I<paynum>
2808 Most gateways require a reference to an original payment transaction to refund,
2809 so you probably need to specify a I<paynum>.
2811 I<amount> defaults to the original amount of the payment if not specified.
2813 I<reason> specifies a reason for the refund.
2815 Implementation note: If I<amount> is unspecified or equal to the amount of the
2816 orignal payment, first an attempt is made to "void" the transaction via
2817 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2818 the normal attempt is made to "refund" ("credit") the transaction via the
2819 gateway is attempted.
2821 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2822 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2823 #if set, will override the value from the customer record.
2825 #If an I<invnum> is specified, this payment (if successful) is applied to the
2826 #specified invoice. If you don't specify an I<invnum> you might want to
2827 #call the B<apply_payments> method.
2831 #some false laziness w/realtime_bop, not enough to make it worth merging
2832 #but some useful small subs should be pulled out
2833 sub realtime_refund_bop {
2834 my( $self, $method, %options ) = @_;
2836 warn "$me realtime_refund_bop: $method refund\n";
2837 warn " $_ => $options{$_}\n" foreach keys %options;
2840 eval "use Business::OnlinePayment";
2844 # look up the original payment and optionally a gateway for that payment
2848 my $amount = $options{'amount'};
2850 my( $processor, $login, $password, @bop_options ) ;
2851 my( $auth, $order_number ) = ( '', '', '' );
2853 if ( $options{'paynum'} ) {
2855 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
2856 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2857 or return "Unknown paynum $options{'paynum'}";
2858 $amount ||= $cust_pay->paid;
2860 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-]*)(:([\w\-]+))?$/
2861 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2862 $cust_pay->paybatch;
2863 my $gatewaynum = '';
2864 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2866 if ( $gatewaynum ) { #gateway for the payment to be refunded
2868 my $payment_gateway =
2869 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2870 die "payment gateway $gatewaynum not found"
2871 unless $payment_gateway;
2873 $processor = $payment_gateway->gateway_module;
2874 $login = $payment_gateway->gateway_username;
2875 $password = $payment_gateway->gateway_password;
2876 @bop_options = $payment_gateway->options;
2878 } else { #try the default gateway
2880 my( $conf_processor, $unused_action );
2881 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2882 $self->default_payment_gateway($method);
2884 return "processor of payment $options{'paynum'} $processor does not".
2885 " match default processor $conf_processor"
2886 unless $processor eq $conf_processor;
2891 } else { # didn't specify a paynum, so look for agent gateway overrides
2892 # like a normal transaction
2895 if ( $method eq 'CC' ) {
2896 $cardtype = cardtype($self->payinfo);
2897 } elsif ( $method eq 'ECHECK' ) {
2900 $cardtype = $method;
2903 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2904 cardtype => $cardtype,
2906 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2908 taxclass => '', } );
2910 if ( $override ) { #use a payment gateway override
2912 my $payment_gateway = $override->payment_gateway;
2914 $processor = $payment_gateway->gateway_module;
2915 $login = $payment_gateway->gateway_username;
2916 $password = $payment_gateway->gateway_password;
2917 #$action = $payment_gateway->gateway_action;
2918 @bop_options = $payment_gateway->options;
2920 } else { #use the standard settings from the config
2923 ( $processor, $login, $password, $unused_action, @bop_options ) =
2924 $self->default_payment_gateway($method);
2929 return "neither amount nor paynum specified" unless $amount;
2934 'password' => $password,
2935 'order_number' => $order_number,
2936 'amount' => $amount,
2937 'referer' => 'http://cleanwhisker.420.am/',
2939 $content{authorization} = $auth
2940 if length($auth); #echeck/ACH transactions have an order # but no auth
2941 #(at least with authorize.net)
2943 #first try void if applicable
2944 if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
2945 warn " attempting void\n" if $DEBUG > 1;
2946 my $void = new Business::OnlinePayment( $processor, @bop_options );
2947 $void->content( 'action' => 'void', %content );
2949 if ( $void->is_success ) {
2950 my $error = $cust_pay->void($options{'reason'});
2952 # gah, even with transactions.
2953 my $e = 'WARNING: Card/ACH voided but database not updated - '.
2954 "error voiding payment: $error";
2958 warn " void successful\n" if $DEBUG > 1;
2963 warn " void unsuccessful, trying refund\n"
2967 my $address = $self->address1;
2968 $address .= ", ". $self->address2 if $self->address2;
2970 my($payname, $payfirst, $paylast);
2971 if ( $self->payname && $method ne 'ECHECK' ) {
2972 $payname = $self->payname;
2973 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2974 or return "Illegal payname $payname";
2975 ($payfirst, $paylast) = ($1, $2);
2977 $payfirst = $self->getfield('first');
2978 $paylast = $self->getfield('last');
2979 $payname = "$payfirst $paylast";
2982 my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
2983 if ( $conf->exists('emailinvoiceauto')
2984 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2985 push @invoicing_list, $self->all_emails;
2988 my $email = ($conf->exists('business-onlinepayment-email-override'))
2989 ? $conf->config('business-onlinepayment-email-override')
2990 : $invoicing_list[0];
2992 my $payip = exists($options{'payip'})
2995 $content{customer_ip} = $payip
2999 if ( $method eq 'CC' ) {
3002 $content{card_number} = $payinfo = $cust_pay->payinfo;
3003 #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3004 #$content{expiration} = "$2/$1";
3006 $content{card_number} = $payinfo = $self->payinfo;
3007 $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3008 $content{expiration} = "$2/$1";
3011 } elsif ( $method eq 'ECHECK' ) {
3012 ( $content{account_number}, $content{routing_code} ) =
3013 split('@', $payinfo = $self->payinfo);
3014 $content{bank_name} = $self->payname;
3015 $content{account_type} = 'CHECKING';
3016 $content{account_name} = $payname;
3017 $content{customer_org} = $self->company ? 'B' : 'I';
3018 $content{customer_ssn} = $self->ss;
3019 } elsif ( $method eq 'LEC' ) {
3020 $content{phone} = $payinfo = $self->payinfo;
3024 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3025 my %sub_content = $refund->content(
3026 'action' => 'credit',
3027 'customer_id' => $self->custnum,
3028 'last_name' => $paylast,
3029 'first_name' => $payfirst,
3031 'address' => $address,
3032 'city' => $self->city,
3033 'state' => $self->state,
3034 'zip' => $self->zip,
3035 'country' => $self->country,
3037 'phone' => $self->daytime || $self->night,
3040 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3044 return "$processor error: ". $refund->error_message
3045 unless $refund->is_success();
3047 my %method2payby = (
3053 my $paybatch = "$processor:". $refund->authorization;
3054 $paybatch .= ':'. $refund->order_number
3055 if $refund->can('order_number') && $refund->order_number;
3057 while ( $cust_pay && $cust_pay->unappled < $amount ) {
3058 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3059 last unless @cust_bill_pay;
3060 my $cust_bill_pay = pop @cust_bill_pay;
3061 my $error = $cust_bill_pay->delete;
3065 my $cust_refund = new FS::cust_refund ( {
3066 'custnum' => $self->custnum,
3067 'paynum' => $options{'paynum'},
3068 'refund' => $amount,
3070 'payby' => $method2payby{$method},
3071 'payinfo' => $payinfo,
3072 'paybatch' => $paybatch,
3073 'reason' => $options{'reason'} || 'card or ACH refund',
3075 my $error = $cust_refund->insert;
3077 $cust_refund->paynum(''); #try again with no specific paynum
3078 my $error2 = $cust_refund->insert;
3080 # gah, even with transactions.
3081 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3082 "error inserting refund ($processor): $error2".
3083 " (previously tried insert with paynum #$options{'paynum'}" .
3096 Returns the total owed for this customer on all invoices
3097 (see L<FS::cust_bill/owed>).
3103 $self->total_owed_date(2145859200); #12/31/2037
3106 =item total_owed_date TIME
3108 Returns the total owed for this customer on all invoices with date earlier than
3109 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3110 see L<Time::Local> and L<Date::Parse> for conversion functions.
3114 sub total_owed_date {
3118 foreach my $cust_bill (
3119 grep { $_->_date <= $time }
3120 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3122 $total_bill += $cust_bill->owed;
3124 sprintf( "%.2f", $total_bill );
3127 =item apply_credits OPTION => VALUE ...
3129 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3130 to outstanding invoice balances in chronological order (or reverse
3131 chronological order if the I<order> option is set to B<newest>) and returns the
3132 value of any remaining unapplied credits available for refund (see
3133 L<FS::cust_refund>).
3141 return 0 unless $self->total_credited;
3143 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3144 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3146 my @invoices = $self->open_cust_bill;
3147 @invoices = sort { $b->_date <=> $a->_date } @invoices
3148 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3151 foreach my $cust_bill ( @invoices ) {
3154 if ( !defined($credit) || $credit->credited == 0) {
3155 $credit = pop @credits or last;
3158 if ($cust_bill->owed >= $credit->credited) {
3159 $amount=$credit->credited;
3161 $amount=$cust_bill->owed;
3164 my $cust_credit_bill = new FS::cust_credit_bill ( {
3165 'crednum' => $credit->crednum,
3166 'invnum' => $cust_bill->invnum,
3167 'amount' => $amount,
3169 my $error = $cust_credit_bill->insert;
3170 die $error if $error;
3172 redo if ($cust_bill->owed > 0);
3176 return $self->total_credited;
3179 =item apply_payments
3181 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3182 to outstanding invoice balances in chronological order.
3184 #and returns the value of any remaining unapplied payments.
3188 sub apply_payments {
3193 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3194 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3196 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3197 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3201 foreach my $cust_bill ( @invoices ) {
3204 if ( !defined($payment) || $payment->unapplied == 0 ) {
3205 $payment = pop @payments or last;
3208 if ( $cust_bill->owed >= $payment->unapplied ) {
3209 $amount = $payment->unapplied;
3211 $amount = $cust_bill->owed;
3214 my $cust_bill_pay = new FS::cust_bill_pay ( {
3215 'paynum' => $payment->paynum,
3216 'invnum' => $cust_bill->invnum,
3217 'amount' => $amount,
3219 my $error = $cust_bill_pay->insert;
3220 die $error if $error;
3222 redo if ( $cust_bill->owed > 0);
3226 return $self->total_unapplied_payments;
3229 =item total_credited
3231 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3232 customer. See L<FS::cust_credit/credited>.
3236 sub total_credited {
3238 my $total_credit = 0;
3239 foreach my $cust_credit ( qsearch('cust_credit', {
3240 'custnum' => $self->custnum,
3242 $total_credit += $cust_credit->credited;
3244 sprintf( "%.2f", $total_credit );
3247 =item total_unapplied_payments
3249 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3250 See L<FS::cust_pay/unapplied>.
3254 sub total_unapplied_payments {
3256 my $total_unapplied = 0;
3257 foreach my $cust_pay ( qsearch('cust_pay', {
3258 'custnum' => $self->custnum,
3260 $total_unapplied += $cust_pay->unapplied;
3262 sprintf( "%.2f", $total_unapplied );
3267 Returns the balance for this customer (total_owed minus total_credited
3268 minus total_unapplied_payments).
3275 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3279 =item balance_date TIME
3281 Returns the balance for this customer, only considering invoices with date
3282 earlier than TIME (total_owed_date minus total_credited minus
3283 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3284 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3293 $self->total_owed_date($time)
3294 - $self->total_credited
3295 - $self->total_unapplied_payments
3299 =item in_transit_payments
3301 Returns the total of requests for payments for this customer pending in
3302 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3306 sub in_transit_payments {
3308 my $in_transit_payments = 0;
3309 foreach my $pay_batch ( qsearch('pay_batch', {
3312 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3313 'batchnum' => $pay_batch->batchnum,
3314 'custnum' => $self->custnum,
3316 $in_transit_payments += $cust_pay_batch->amount;
3319 sprintf( "%.2f", $in_transit_payments );
3322 =item paydate_monthyear
3324 Returns a two-element list consisting of the month and year of this customer's
3325 paydate (credit card expiration date for CARD customers)
3329 sub paydate_monthyear {
3331 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3333 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3340 =item invoicing_list [ ARRAYREF ]
3342 If an arguement is given, sets these email addresses as invoice recipients
3343 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3344 (except as warnings), so use check_invoicing_list first.
3346 Returns a list of email addresses (with svcnum entries expanded).
3348 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3349 check it without disturbing anything by passing nothing.
3351 This interface may change in the future.
3355 sub invoicing_list {
3356 my( $self, $arrayref ) = @_;
3359 my @cust_main_invoice;
3360 if ( $self->custnum ) {
3361 @cust_main_invoice =
3362 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3364 @cust_main_invoice = ();
3366 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3367 #warn $cust_main_invoice->destnum;
3368 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3369 #warn $cust_main_invoice->destnum;
3370 my $error = $cust_main_invoice->delete;
3371 warn $error if $error;
3374 if ( $self->custnum ) {
3375 @cust_main_invoice =
3376 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3378 @cust_main_invoice = ();
3380 my %seen = map { $_->address => 1 } @cust_main_invoice;
3381 foreach my $address ( @{$arrayref} ) {
3382 next if exists $seen{$address} && $seen{$address};
3383 $seen{$address} = 1;
3384 my $cust_main_invoice = new FS::cust_main_invoice ( {
3385 'custnum' => $self->custnum,
3388 my $error = $cust_main_invoice->insert;
3389 warn $error if $error;
3393 if ( $self->custnum ) {
3395 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3402 =item check_invoicing_list ARRAYREF
3404 Checks these arguements as valid input for the invoicing_list method. If there
3405 is an error, returns the error, otherwise returns false.
3409 sub check_invoicing_list {
3410 my( $self, $arrayref ) = @_;
3411 foreach my $address ( @{$arrayref} ) {
3413 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3414 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3417 my $cust_main_invoice = new FS::cust_main_invoice ( {
3418 'custnum' => $self->custnum,
3421 my $error = $self->custnum
3422 ? $cust_main_invoice->check
3423 : $cust_main_invoice->checkdest
3425 return $error if $error;
3430 =item set_default_invoicing_list
3432 Sets the invoicing list to all accounts associated with this customer,
3433 overwriting any previous invoicing list.
3437 sub set_default_invoicing_list {
3439 $self->invoicing_list($self->all_emails);
3444 Returns the email addresses of all accounts provisioned for this customer.
3451 foreach my $cust_pkg ( $self->all_pkgs ) {
3452 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3454 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3455 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3457 $list{$_}=1 foreach map { $_->email } @svc_acct;
3462 =item invoicing_list_addpost
3464 Adds postal invoicing to this customer. If this customer is already configured
3465 to receive postal invoices, does nothing.
3469 sub invoicing_list_addpost {
3471 return if grep { $_ eq 'POST' } $self->invoicing_list;
3472 my @invoicing_list = $self->invoicing_list;
3473 push @invoicing_list, 'POST';
3474 $self->invoicing_list(\@invoicing_list);
3477 =item invoicing_list_emailonly
3479 Returns the list of email invoice recipients (invoicing_list without non-email
3480 destinations such as POST and FAX).
3484 sub invoicing_list_emailonly {
3486 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3489 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3491 Returns an array of customers referred by this customer (referral_custnum set
3492 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3493 customers referred by customers referred by this customer and so on, inclusive.
3494 The default behavior is DEPTH 1 (no recursion).
3498 sub referral_cust_main {
3500 my $depth = @_ ? shift : 1;
3501 my $exclude = @_ ? shift : {};
3504 map { $exclude->{$_->custnum}++; $_; }
3505 grep { ! $exclude->{ $_->custnum } }
3506 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3510 map { $_->referral_cust_main($depth-1, $exclude) }
3517 =item referral_cust_main_ncancelled
3519 Same as referral_cust_main, except only returns customers with uncancelled
3524 sub referral_cust_main_ncancelled {
3526 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3529 =item referral_cust_pkg [ DEPTH ]
3531 Like referral_cust_main, except returns a flat list of all unsuspended (and
3532 uncancelled) packages for each customer. The number of items in this list may
3533 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3537 sub referral_cust_pkg {
3539 my $depth = @_ ? shift : 1;
3541 map { $_->unsuspended_pkgs }
3542 grep { $_->unsuspended_pkgs }
3543 $self->referral_cust_main($depth);
3546 =item referring_cust_main
3548 Returns the single cust_main record for the customer who referred this customer
3549 (referral_custnum), or false.
3553 sub referring_cust_main {
3555 return '' unless $self->referral_custnum;
3556 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3559 =item credit AMOUNT, REASON
3561 Applies a credit to this customer. If there is an error, returns the error,
3562 otherwise returns false.
3567 my( $self, $amount, $reason ) = @_;
3568 my $cust_credit = new FS::cust_credit {
3569 'custnum' => $self->custnum,
3570 'amount' => $amount,
3571 'reason' => $reason,
3573 $cust_credit->insert;
3576 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3578 Creates a one-time charge for this customer. If there is an error, returns
3579 the error, otherwise returns false.
3584 my ( $self, $amount ) = ( shift, shift );
3585 my $pkg = @_ ? shift : 'One-time charge';
3586 my $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3587 my $taxclass = @_ ? shift : '';
3589 local $SIG{HUP} = 'IGNORE';
3590 local $SIG{INT} = 'IGNORE';
3591 local $SIG{QUIT} = 'IGNORE';
3592 local $SIG{TERM} = 'IGNORE';
3593 local $SIG{TSTP} = 'IGNORE';
3594 local $SIG{PIPE} = 'IGNORE';
3596 my $oldAutoCommit = $FS::UID::AutoCommit;
3597 local $FS::UID::AutoCommit = 0;
3600 my $part_pkg = new FS::part_pkg ( {
3602 'comment' => $comment,
3603 #'setup' => $amount,
3606 'plandata' => "setup_fee=$amount",
3609 'taxclass' => $taxclass,
3612 my $error = $part_pkg->insert;
3614 $dbh->rollback if $oldAutoCommit;
3618 my $pkgpart = $part_pkg->pkgpart;
3619 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3620 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3621 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3622 $error = $type_pkgs->insert;
3624 $dbh->rollback if $oldAutoCommit;
3629 my $cust_pkg = new FS::cust_pkg ( {
3630 'custnum' => $self->custnum,
3631 'pkgpart' => $pkgpart,
3634 $error = $cust_pkg->insert;
3636 $dbh->rollback if $oldAutoCommit;
3640 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3647 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3653 sort { $a->_date <=> $b->_date }
3654 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3657 =item open_cust_bill
3659 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3664 sub open_cust_bill {
3666 grep { $_->owed > 0 } $self->cust_bill;
3671 Returns all the credits (see L<FS::cust_credit>) for this customer.
3677 sort { $a->_date <=> $b->_date }
3678 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3683 Returns all the payments (see L<FS::cust_pay>) for this customer.
3689 sort { $a->_date <=> $b->_date }
3690 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3695 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3701 sort { $a->_date <=> $b->_date }
3702 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3708 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3714 sort { $a->_date <=> $b->_date }
3715 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3718 =item select_for_update
3720 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
3725 sub select_for_update {
3727 qsearch('cust_main', { 'custnum' => $self->custnum }, '*', 'FOR UPDATE' );
3732 Returns a name string for this customer, either "Company (Last, First)" or
3739 my $name = $self->contact;
3740 $name = $self->company. " ($name)" if $self->company;
3746 Returns a name string for this (service/shipping) contact, either
3747 "Company (Last, First)" or "Last, First".
3753 if ( $self->get('ship_last') ) {
3754 my $name = $self->ship_contact;
3755 $name = $self->ship_company. " ($name)" if $self->ship_company;
3764 Returns this customer's full (billing) contact name only, "Last, First"
3770 $self->get('last'). ', '. $self->first;
3775 Returns this customer's full (shipping) contact name only, "Last, First"
3781 $self->get('ship_last')
3782 ? $self->get('ship_last'). ', '. $self->ship_first
3788 Returns this customer's full country name
3794 code2country($self->country);
3799 Returns a status string for this customer, currently:
3803 =item prospect - No packages have ever been ordered
3805 =item active - One or more recurring packages is active
3807 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3809 =item suspended - All non-cancelled recurring packages are suspended
3811 =item cancelled - All recurring packages are cancelled
3819 for my $status (qw( prospect active inactive suspended cancelled )) {
3820 my $method = $status.'_sql';
3821 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3822 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3823 $sth->execute( ($self->custnum) x $numnum ) or die $sth->errstr;
3824 return $status if $sth->fetchrow_arrayref->[0];
3830 Returns a hex triplet color string for this customer's status.
3834 use vars qw(%statuscolor);
3836 'prospect' => '7e0079', #'000000', #black? naw, purple
3837 'active' => '00CC00', #green
3838 'inactive' => '0000CC', #blue
3839 'suspended' => 'FF9900', #yellow
3840 'cancelled' => 'FF0000', #red
3845 $statuscolor{$self->status};
3850 =head1 CLASS METHODS
3856 Returns an SQL expression identifying prospective cust_main records (customers
3857 with no packages ever ordered)
3861 use vars qw($select_count_pkgs);
3862 $select_count_pkgs =
3863 "SELECT COUNT(*) FROM cust_pkg
3864 WHERE cust_pkg.custnum = cust_main.custnum";
3866 sub select_count_pkgs_sql {
3870 sub prospect_sql { "
3871 0 = ( $select_count_pkgs )
3876 Returns an SQL expression identifying active cust_main records (customers with
3877 no active recurring packages, but otherwise unsuspended/uncancelled).
3882 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
3888 Returns an SQL expression identifying inactive cust_main records (customers with
3889 active recurring packages).
3893 sub inactive_sql { "
3894 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3896 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
3902 Returns an SQL expression identifying suspended cust_main records.
3907 sub suspended_sql { susp_sql(@_); }
3909 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
3911 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3917 Returns an SQL expression identifying cancelled cust_main records.
3921 sub cancelled_sql { cancel_sql(@_); }
3924 my $recurring_sql = FS::cust_pkg->recurring_sql;
3925 #my $recurring_sql = "
3926 # '0' != ( select freq from part_pkg
3927 # where cust_pkg.pkgpart = part_pkg.pkgpart )
3931 0 < ( $select_count_pkgs )
3932 AND 0 = ( $select_count_pkgs AND $recurring_sql
3933 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3939 =item uncancelled_sql
3941 Returns an SQL expression identifying un-cancelled cust_main records.
3945 sub uncancelled_sql { uncancel_sql(@_); }
3946 sub uncancel_sql { "
3947 ( 0 < ( $select_count_pkgs
3948 AND ( cust_pkg.cancel IS NULL
3949 OR cust_pkg.cancel = 0
3952 OR 0 = ( $select_count_pkgs )
3956 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
3958 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
3959 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
3960 appropriate ship_ field is also searched).
3962 Additional options are the same as FS::Record::qsearch
3967 my( $self, $fuzzy, $hash, @opt) = @_;
3972 check_and_rebuild_fuzzyfiles();
3973 foreach my $field ( keys %$fuzzy ) {
3975 my $all = $self->all_X($field);
3976 next unless scalar(@$all);
3979 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
3982 foreach ( keys %match ) {
3983 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
3984 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
3987 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
3990 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
3992 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4004 =item smart_search OPTION => VALUE ...
4006 Accepts the following options: I<search>, the string to search for. The string
4007 will be searched for as a customer number, phone number, name or company name,
4008 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4009 for the exact heuristics used).
4011 Any additional options are treated as an additional qualifier on the search
4014 Returns a (possibly empty) array of FS::cust_main objects.
4021 #here is the agent virtualization
4022 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4026 my $search = delete $options{'search'};
4027 ( my $alphanum_search = $search ) =~ s/\W//g;
4029 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4031 #false laziness w/Record::ut_phone
4032 my $phonen = "$1-$2-$3";
4033 $phonen .= " x$4" if $4;
4035 push @cust_main, qsearch( {
4036 'table' => 'cust_main',
4037 'hashref' => { %options },
4038 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4040 join(' OR ', map "$_ = '$phonen'",
4041 qw( daytime night fax
4042 ship_daytime ship_night ship_fax )
4045 " AND $agentnums_sql", #agent virtualization
4048 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4049 #try looking for matches with extensions unless one was specified
4051 push @cust_main, qsearch( {
4052 'table' => 'cust_main',
4053 'hashref' => { %options },
4054 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4056 join(' OR ', map "$_ LIKE '$phonen\%'",
4058 ship_daytime ship_night )
4061 " AND $agentnums_sql", #agent virtualization
4066 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4068 push @cust_main, qsearch( {
4069 'table' => 'cust_main',
4070 'hashref' => { 'custnum' => $1, %options },
4071 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4074 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4076 my($company, $last, $first) = ( $1, $2, $3 );
4078 # "Company (Last, First)"
4079 #this is probably something a browser remembered,
4080 #so just do an exact search
4082 foreach my $prefix ( '', 'ship_' ) {
4083 push @cust_main, qsearch( {
4084 'table' => 'cust_main',
4085 'hashref' => { $prefix.'first' => $first,
4086 $prefix.'last' => $last,
4087 $prefix.'company' => $company,
4090 'extra_sql' => " AND $agentnums_sql",
4094 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4095 # try (ship_){last,company}
4099 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4100 # # full strings the browser remembers won't work
4101 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4103 use Lingua::EN::NameParse;
4104 my $NameParse = new Lingua::EN::NameParse(
4106 allow_reversed => 1,
4109 my($last, $first) = ( '', '' );
4110 #maybe disable this too and just rely on NameParse?
4111 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4113 ($last, $first) = ( $1, $2 );
4115 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
4116 } elsif ( ! $NameParse->parse($value) ) {
4118 my %name = $NameParse->components;
4119 $first = $name{'given_name_1'};
4120 $last = $name{'surname_1'};
4124 if ( $first && $last ) {
4126 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4129 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4131 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4132 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4135 push @cust_main, qsearch( {
4136 'table' => 'cust_main',
4137 'hashref' => \%options,
4138 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4141 # or it just be something that was typed in... (try that in a sec)
4145 my $q_value = dbh->quote($value);
4148 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4149 $sql .= " ( LOWER(last) = $q_value
4150 OR LOWER(company) = $q_value
4151 OR LOWER(ship_last) = $q_value
4152 OR LOWER(ship_company) = $q_value
4155 push @cust_main, qsearch( {
4156 'table' => 'cust_main',
4157 'hashref' => \%options,
4158 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4161 #always do substring & fuzzy,
4162 #getting complains searches are not returning enough
4163 #unless ( @cust_main ) { #no exact match, trying substring/fuzzy
4165 #still some false laziness w/ search/cust_main.cgi
4170 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
4171 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4174 if ( $first && $last ) {
4177 { 'first' => { op=>'ILIKE', value=>"%$first%" },
4178 'last' => { op=>'ILIKE', value=>"%$last%" },
4180 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
4181 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
4188 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
4189 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
4193 foreach my $hashref ( @hashrefs ) {
4195 push @cust_main, qsearch( {
4196 'table' => 'cust_main',
4197 'hashref' => { %$hashref,
4200 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4209 " AND $agentnums_sql", #extra_sql #agent virtualization
4212 if ( $first && $last ) {
4213 push @cust_main, FS::cust_main->fuzzy_search(
4214 { 'last' => $last, #fuzzy hashref
4215 'first' => $first }, #
4219 foreach my $field ( 'last', 'company' ) {
4221 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4226 #eliminate duplicates
4228 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4236 =item check_and_rebuild_fuzzyfiles
4240 use vars qw(@fuzzyfields);
4241 @fuzzyfields = ( 'last', 'first', 'company' );
4243 sub check_and_rebuild_fuzzyfiles {
4244 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4245 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4248 =item rebuild_fuzzyfiles
4252 sub rebuild_fuzzyfiles {
4254 use Fcntl qw(:flock);
4256 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4257 mkdir $dir, 0700 unless -d $dir;
4259 foreach my $fuzzy ( @fuzzyfields ) {
4261 open(LOCK,">>$dir/cust_main.$fuzzy")
4262 or die "can't open $dir/cust_main.$fuzzy: $!";
4264 or die "can't lock $dir/cust_main.$fuzzy: $!";
4266 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4267 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4269 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4270 my $sth = dbh->prepare("SELECT $field FROM cust_main".
4271 " WHERE $field != '' AND $field IS NOT NULL");
4272 $sth->execute or die $sth->errstr;
4274 while ( my $row = $sth->fetchrow_arrayref ) {
4275 print CACHE $row->[0]. "\n";
4280 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4282 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4293 my( $self, $field ) = @_;
4294 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4295 open(CACHE,"<$dir/cust_main.$field")
4296 or die "can't open $dir/cust_main.$field: $!";
4297 my @array = map { chomp; $_; } <CACHE>;
4302 =item append_fuzzyfiles LASTNAME COMPANY
4306 sub append_fuzzyfiles {
4307 #my( $first, $last, $company ) = @_;
4309 &check_and_rebuild_fuzzyfiles;
4311 use Fcntl qw(:flock);
4313 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4315 foreach my $field (qw( first last company )) {
4320 open(CACHE,">>$dir/cust_main.$field")
4321 or die "can't open $dir/cust_main.$field: $!";
4322 flock(CACHE,LOCK_EX)
4323 or die "can't lock $dir/cust_main.$field: $!";
4325 print CACHE "$value\n";
4327 flock(CACHE,LOCK_UN)
4328 or die "can't unlock $dir/cust_main.$field: $!";
4343 #warn join('-',keys %$param);
4344 my $fh = $param->{filehandle};
4345 my $agentnum = $param->{agentnum};
4347 my $refnum = $param->{refnum};
4348 my $pkgpart = $param->{pkgpart};
4350 #my @fields = @{$param->{fields}};
4351 my $format = $param->{'format'};
4354 if ( $format eq 'simple' ) {
4355 @fields = qw( cust_pkg.setup dayphone first last
4356 address1 address2 city state zip comments );
4358 } elsif ( $format eq 'extended' ) {
4359 @fields = qw( agent_custid refnum
4360 last first address1 address2 city state zip country
4362 ship_last ship_first ship_address1 ship_address2
4363 ship_city ship_state ship_zip ship_country
4364 payinfo paycvv paydate
4367 svc_acct.username svc_acct._password
4371 die "unknown format $format";
4374 eval "use Text::CSV_XS;";
4377 my $csv = new Text::CSV_XS;
4384 local $SIG{HUP} = 'IGNORE';
4385 local $SIG{INT} = 'IGNORE';
4386 local $SIG{QUIT} = 'IGNORE';
4387 local $SIG{TERM} = 'IGNORE';
4388 local $SIG{TSTP} = 'IGNORE';
4389 local $SIG{PIPE} = 'IGNORE';
4391 my $oldAutoCommit = $FS::UID::AutoCommit;
4392 local $FS::UID::AutoCommit = 0;
4395 #while ( $columns = $csv->getline($fh) ) {
4397 while ( defined($line=<$fh>) ) {
4399 $csv->parse($line) or do {
4400 $dbh->rollback if $oldAutoCommit;
4401 return "can't parse: ". $csv->error_input();
4404 my @columns = $csv->fields();
4405 #warn join('-',@columns);
4408 agentnum => $agentnum,
4410 country => $conf->config('countrydefault') || 'US',
4411 payby => $payby, #default
4412 paydate => '12/2037', #default
4414 my $billtime = time;
4415 my %cust_pkg = ( pkgpart => $pkgpart );
4417 foreach my $field ( @fields ) {
4419 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4421 #$cust_pkg{$1} = str2time( shift @$columns );
4422 if ( $1 eq 'pkgpart' ) {
4423 $cust_pkg{$1} = shift @columns;
4424 } elsif ( $1 eq 'setup' ) {
4425 $billtime = str2time(shift @columns);
4427 $cust_pkg{$1} = str2time( shift @columns );
4430 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4432 $svc_acct{$1} = shift @columns;
4436 #refnum interception
4437 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4439 my $referral = $columns[0];
4440 my %hash = ( 'referral' => $referral,
4441 'agentnum' => $agentnum,
4445 my $part_referral = qsearchs('part_referral', \%hash )
4446 || new FS::part_referral \%hash;
4448 unless ( $part_referral->refnum ) {
4449 my $error = $part_referral->insert;
4451 $dbh->rollback if $oldAutoCommit;
4452 return "can't auto-insert advertising source: $referral: $error";
4456 $columns[0] = $part_referral->refnum;
4459 #$cust_main{$field} = shift @$columns;
4460 $cust_main{$field} = shift @columns;
4464 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4466 my $invoicing_list = $cust_main{'invoicing_list'}
4467 ? [ delete $cust_main{'invoicing_list'} ]
4470 my $cust_main = new FS::cust_main ( \%cust_main );
4473 tie my %hash, 'Tie::RefHash'; #this part is important
4475 if ( $cust_pkg{'pkgpart'} ) {
4476 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4479 if ( $svc_acct{'username'} ) {
4480 my $part_pkg = $cust_pkg->part_pkg;
4481 unless ( $part_pkg ) {
4482 $dbh->rollback if $oldAutoCommit;
4483 return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4485 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4486 push @svc_acct, new FS::svc_acct ( \%svc_acct )
4489 $hash{$cust_pkg} = \@svc_acct;
4492 my $error = $cust_main->insert( \%hash, $invoicing_list );
4495 $dbh->rollback if $oldAutoCommit;
4496 return "can't insert customer for $line: $error";
4499 if ( $format eq 'simple' ) {
4501 #false laziness w/bill.cgi
4502 $error = $cust_main->bill( 'time' => $billtime );
4504 $dbh->rollback if $oldAutoCommit;
4505 return "can't bill customer for $line: $error";
4508 $cust_main->apply_payments;
4509 $cust_main->apply_credits;
4511 $error = $cust_main->collect();
4513 $dbh->rollback if $oldAutoCommit;
4514 return "can't collect customer for $line: $error";
4522 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4524 return "Empty file!" unless $imported;
4536 #warn join('-',keys %$param);
4537 my $fh = $param->{filehandle};
4538 my @fields = @{$param->{fields}};
4540 eval "use Text::CSV_XS;";
4543 my $csv = new Text::CSV_XS;
4550 local $SIG{HUP} = 'IGNORE';
4551 local $SIG{INT} = 'IGNORE';
4552 local $SIG{QUIT} = 'IGNORE';
4553 local $SIG{TERM} = 'IGNORE';
4554 local $SIG{TSTP} = 'IGNORE';
4555 local $SIG{PIPE} = 'IGNORE';
4557 my $oldAutoCommit = $FS::UID::AutoCommit;
4558 local $FS::UID::AutoCommit = 0;
4561 #while ( $columns = $csv->getline($fh) ) {
4563 while ( defined($line=<$fh>) ) {
4565 $csv->parse($line) or do {
4566 $dbh->rollback if $oldAutoCommit;
4567 return "can't parse: ". $csv->error_input();
4570 my @columns = $csv->fields();
4571 #warn join('-',@columns);
4574 foreach my $field ( @fields ) {
4575 $row{$field} = shift @columns;
4578 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4579 unless ( $cust_main ) {
4580 $dbh->rollback if $oldAutoCommit;
4581 return "unknown custnum $row{'custnum'}";
4584 if ( $row{'amount'} > 0 ) {
4585 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4587 $dbh->rollback if $oldAutoCommit;
4591 } elsif ( $row{'amount'} < 0 ) {
4592 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4595 $dbh->rollback if $oldAutoCommit;
4605 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4607 return "Empty file!" unless $imported;
4619 The delete method should possibly take an FS::cust_main object reference
4620 instead of a scalar customer number.
4622 Bill and collect options should probably be passed as references instead of a
4625 There should probably be a configuration file with a list of allowed credit
4628 No multiple currency support (probably a larger project than just this module).
4630 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4632 Birthdates rely on negative epoch values.
4636 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4637 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4638 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.