1 package FS::cust_main_Mixin;
4 use vars qw( $DEBUG $me );
5 use Carp qw( confess carp cluck );
8 use FS::Record qw( qsearch qsearchs );
9 use FS::Misc qw( send_email generate_email );
13 $me = '[FS::cust_main_Mixin]';
17 FS::cust_main_Mixin - Mixin class for records that contain fields from cust_main
21 package FS::some_table;
23 @ISA = qw( FS::cust_main_Mixin FS::Record );
27 This is a mixin class for records that contain fields from the cust_main table,
28 for example, from a JOINed search. See httemplate/search/ for examples.
36 sub cust_unlinked_msg { '(unlinked)'; }
37 sub cust_linked { $_[0]->custnum; }
41 cluck ref($self). '->cust_main called' if $DEBUG;
42 $self->cust_linked ? qsearchs('cust_main', {custnum => $self->custnum}) : '';
47 Given an object that contains fields from cust_main (say, from a JOINed
48 search; see httemplate/search/ for examples), returns the equivalent of the
49 FS::cust_main I<name> method, or "(unlinked)" if this object is not linked to
57 ? FS::cust_main::display_custnum($self)
58 : $self->cust_unlinked_msg;
63 Given an object that contains fields from cust_main (say, from a JOINed
64 search; see httemplate/search/ for examples), returns the equivalent of the
65 FS::cust_main I<name> method, or "(unlinked)" if this object is not linked to
73 ? FS::cust_main::name($self)
74 : $self->cust_unlinked_msg;
79 Given an object that contains fields from cust_main (say, from a JOINed
80 search; see httemplate/search/ for examples), returns the equivalent of the
81 FS::cust_main I<ship_name> method, or "(unlinked)" if this object is not
89 ? FS::cust_main::ship_name($self)
90 : $self->cust_unlinked_msg;
95 Given an object that contains fields from cust_main (say, from a JOINed
96 search; see httemplate/search/ for examples), returns the equivalent of the
97 FS::cust_main I<contact> method, or "(unlinked)" if this object is not linked
105 ? FS::cust_main::contact($self)
106 : $self->cust_unlinked_msg;
111 Given an object that contains fields from cust_main (say, from a JOINed
112 search; see httemplate/search/ for examples), returns the equivalent of the
113 FS::cust_main I<ship_contact> method, or "(unlinked)" if this object is not
114 linked to a customer.
121 ? FS::cust_main::ship_contact($self)
122 : $self->cust_unlinked_msg;
127 Given an object that contains fields from cust_main (say, from a JOINed
128 search; see httemplate/search/ for examples), returns the equivalent of the
129 FS::cust_main I<country_full> method, or "(unlinked)" if this object is not
130 linked to a customer.
136 if ( $self->locationnum ) { # cust_pkg has this
137 my $location = FS::cust_location->by_key($self->locationnum);
138 $location ? $location->country_full : '';
139 } elsif ( $self->cust_linked ) {
140 $self->cust_main->bill_country_full;
144 =item invoicing_list_emailonly
146 Given an object that contains fields from cust_main (say, from a JOINed
147 search; see httemplate/search/ for examples), returns the equivalent of the
148 FS::cust_main I<invoicing_list_emailonly> method, or "(unlinked)" if this
149 object is not linked to a customer.
153 sub invoicing_list_emailonly {
155 warn "invoicing_list_email only called on $self, ".
156 "custnum ". $self->custnum. "\n"
159 ? FS::cust_main::invoicing_list_emailonly($self)
160 : $self->cust_unlinked_msg;
163 =item invoicing_list_emailonly_scalar
165 Given an object that contains fields from cust_main (say, from a JOINed
166 search; see httemplate/search/ for examples), returns the equivalent of the
167 FS::cust_main I<invoicing_list_emailonly_scalar> method, or "(unlinked)" if
168 this object is not linked to a customer.
172 sub invoicing_list_emailonly_scalar {
174 warn "invoicing_list_emailonly called on $self, ".
175 "custnum ". $self->custnum. "\n"
178 ? FS::cust_main::invoicing_list_emailonly_scalar($self)
179 : $self->cust_unlinked_msg;
184 Given an object that contains fields from cust_main (say, from a JOINed
185 search; see httemplate/search/ for examples), returns the equivalent of the
186 FS::cust_main I<invoicing_list> method, or "(unlinked)" if this object is not
187 linked to a customer.
189 Note: this method is read-only.
197 ? FS::cust_main::invoicing_list($self)
203 Given an object that contains fields from cust_main (say, from a JOINed
204 search; see httemplate/search/ for examples), returns the equivalent of the
205 FS::cust_main I<status> method, or "(unlinked)" if this object is not linked to
212 return $self->cust_unlinked_msg unless $self->cust_linked;
214 #FS::cust_main::status($self)
215 #false laziness w/actual cust_main::status
216 # (make sure FS::cust_main methods are called)
217 for my $status (qw( prospect active inactive suspended cancelled )) {
218 my $method = $status.'_sql';
219 my $sql = FS::cust_main->$method();;
220 my $numnum = ( $sql =~ s/cust_main\.custnum/?/g );
221 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
222 $sth->execute( ($self->custnum) x $numnum )
223 or die "Error executing 'SELECT $sql': ". $sth->errstr;
224 return $status if $sth->fetchrow_arrayref->[0];
228 =item ucfirst_cust_status
230 Given an object that contains fields from cust_main (say, from a JOINed
231 search; see httemplate/search/ for examples), returns the equivalent of the
232 FS::cust_main I<ucfirst_status> method, or "(unlinked)" if this object is not
233 linked to a customer.
237 sub ucfirst_cust_status {
238 carp "ucfirst_cust_status deprecated, use cust_status_label";
239 local($FS::cust_main::ucfirst_nowarn) = 1;
242 ? ucfirst( $self->cust_status(@_) )
243 : $self->cust_unlinked_msg;
246 =item cust_status_label
250 sub cust_status_label {
254 ? FS::cust_main::cust_status_label($self)
255 : $self->cust_unlinked_msg;
258 =item cust_statuscolor
260 Given an object that contains fields from cust_main (say, from a JOINed
261 search; see httemplate/search/ for examples), returns the equivalent of the
262 FS::cust_main I<statuscol> method, or "000000" if this object is not linked to
267 sub cust_statuscolor {
271 ? FS::cust_main::cust_statuscolor($self)
285 Class methods that return SQL framents, equivalent to the corresponding
286 FS::cust_main method.
291 # \$self->cust_linked
292 # ? FS::cust_main::${sub}_sql(\$self)
295 foreach my $sub (qw( prospect active inactive suspended cancelled )) {
298 confess 'cust_main_Mixin ${sub}_sql called with object' if ref(\$_[0]);
299 'cust_main.custnum IS NOT NULL AND '. FS::cust_main->${sub}_sql();
305 =item cust_search_sql
307 Returns a list of SQL WHERE fragments to search for parameters specified
308 in HASHREF. Valid parameters are:
320 sub cust_search_sql {
321 my($class, $param) = @_;
324 warn "$me cust_search_sql called with params: \n".
325 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
330 if ( $param->{'agentnum'} && $param->{'agentnum'} =~ /^(\d+)$/ ) {
331 push @search, "cust_main.agentnum = $1";
334 #status (prospect active inactive suspended cancelled)
335 if ( grep { $param->{'status'} eq $_ } FS::cust_main->statuses() ) {
336 my $method = $param->{'status'}. '_sql';
337 push @search, $class->$method();
340 #here is the agent virtualization
342 $FS::CurrentUser::CurrentUser->agentnums_sql( 'table' => 'cust_main' );
348 =item email_search_result HASHREF
350 Emails a notice to the specified customers. Customers without
351 invoice email destinations will be skipped.
359 Queue job for status updates. Required.
363 Hashref of params to the L<search()> method. Required.
367 Message template number (see L<FS::msg_template>). Overrides all
368 of the following options.
386 =item to_contact_classnum
388 The customer contact class (or classes, as a comma-separated list) to send
389 the message to. If unspecified, will be sent to any contacts that are marked
390 as invoice destinations (the equivalent of specifying 'invoice').
394 Returns an error message, or false for success.
396 If any messages fail to send, they will be queued as individual
397 jobs which can be manually retried. If the first ten messages
398 in the job fail, the entire job will abort and return an error.
402 use Storable qw(thaw);
404 use Data::Dumper qw(Dumper);
405 use Digest::SHA qw(sha1); # for duplicate checking
407 sub email_search_result {
408 my($class, $param) = @_;
410 my $msgnum = $param->{msgnum};
411 my $from = delete $param->{from};
412 my $subject = delete $param->{subject};
413 my $html_body = delete $param->{html_body};
414 my $text_body = delete $param->{text_body};
415 my $to_contact_classnum = delete $param->{to_contact_classnum};
418 my $job = delete $param->{'job'}
419 or die "email_search_result must run from the job queue.\n";
423 $msg_template = qsearchs('msg_template', { msgnum => $msgnum } )
424 or die "msgnum $msgnum not found\n";
426 $msg_template = FS::msg_template->new({
428 msgname => $subject, # maybe a timestamp also?
429 disabled => 'D', # 'D'raft
432 $error = $msg_template->insert(
436 return "$error (when creating draft template)" if $error;
439 my $sql_query = $class->search($param->{'search'});
440 $sql_query->{'select'} = $sql_query->{'table'} . '.*';
442 my $count_query = delete($sql_query->{'count_query'});
443 my $count_sth = dbh->prepare($count_query)
444 or die "Error preparing $count_query: ". dbh->errstr;
446 or die "Error executing $count_query: ". $count_sth->errstr;
447 my $count_arrayref = $count_sth->fetchrow_arrayref;
448 my $num_cust = $count_arrayref->[0];
450 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
456 if ( !$msg_template ) {
457 die "email_search_result now requires a msg_template";
460 #eventually order+limit magic to reduce memory use?
461 foreach my $obj ( qsearch($sql_query) ) {
463 #progressbar first, so that the count is right
465 if ( time - $min_sec > $last ) {
466 my $error = $job->update_statustext(
467 int( 100 * $num / $num_cust )
469 die $error if $error;
473 my $cust_main = $obj->cust_main;
475 next; # unlinked object; nothing else we can do
478 my $cust_msg = $msg_template->prepare(
479 'cust_main' => $cust_main,
481 'to_contact_classnum' => $to_contact_classnum,
484 # For non-cust_main searches, we avoid duplicates based on message
486 my $unique = $cust_main->custnum;
487 $unique .= sha1($cust_msg->text_body) if $class ne 'FS::cust_main';
488 if( $sent_to{$unique} ) {
494 $sent_to{$unique} = 1;
496 $error = $cust_msg->send;
499 # queue the sending of this message so that the user can see what we
500 # tried to do, and retry if desired
501 # (note the cust_msg itself also now has a status of 'failed'; that's
502 # fine, as it will get its status reset if we retry the job)
503 my $queue = new FS::queue {
504 'job' => 'FS::cust_msg::process_send',
505 'custnum' => $cust_main->custnum,
506 'status' => 'failed',
507 'statustext' => $error,
509 $queue->insert($cust_msg->custmsgnum);
510 push @retry_jobs, $queue;
517 (scalar(@retry_jobs) > 10 or $num == $num_cust)
519 # 10 is arbitrary, but if we have enough failures, that's
520 # probably a configuration or network problem, and we
521 # abort the batch and run away screaming.
522 # We NEVER do this if anything was successfully sent.
523 $_->delete foreach (@retry_jobs);
524 return "multiple failures: '$error'\n";
528 # if the message template was created as "draft", change its status to
530 if ($msg_template->disabled eq 'D') {
531 $msg_template->set('disabled' => 'C');
532 my $error = $msg_template->replace;
533 warn "$error (setting draft message template status)" if $error;
537 # fail the job, but with a status message that makes it clear
538 # something was sent.
539 return "Sent $success, skipped $dups duplicate(s), failed ".scalar(@retry_jobs).". Failed attempts placed in job queue.\n";
545 sub process_email_search_result {
547 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
550 warn Dumper($param) if $DEBUG;
552 $param->{'job'} = $job;
554 $param->{'search'} = thaw(decode_base64($param->{'search'}))
555 or die "process_email_search_result requires search params.\n";
557 my $table = $param->{'table'}
558 or die "process_email_search_result requires table.\n";
560 eval "use FS::$table;";
561 die "error loading FS::$table: $@\n" if $@;
563 my $error = "FS::$table"->email_search_result( $param );
564 dbh->commit; # save failed jobs before rethrowing the error
565 die $error if $error;
571 Returns a configuration handle (L<FS::Conf>) set to the customer's locale,
572 if they have one. If not, returns an FS::Conf with no locale.
578 return $self->{_conf} if (ref $self and $self->{_conf});
579 my $cust_main = $self->cust_main;
580 my $conf = new FS::Conf {
581 'locale' => ($cust_main ? $cust_main->locale : '')
583 $self->{_conf} = $conf if ref $self;
587 =item mt TEXT [, ARGS ]
589 Localizes a text string (see L<Locale::Maketext>) for the customer's locale,
596 return $self->{_lh}->maketext(@_) if (ref $self and $self->{_lh});
597 my $cust_main = $self->cust_main;
598 my $locale = $cust_main ? $cust_main->locale : '';
599 my $lh = FS::L10N->get_handle($locale);
600 $self->{_lh} = $lh if ref $self;
601 return $lh->maketext(@_);
604 =item time2str_local FORMAT, TIME[, ESCAPE]
606 Localizes a date (see L<Date::Language>) for the customer's locale.
608 FORMAT can be a L<Date::Format> string, or one of these special words:
610 - "short": the value of the "date_format" config setting for the customer's
611 locale, defaulting to "%x".
612 - "rdate": the same as "short" except that the default has a four-digit year.
613 - "long": the value of the "date_format_long" config setting for the
614 customer's locale, defaulting to "%b %o, %Y".
616 ESCAPE, if specified, is one of "latex" or "html", and will escape non-ASCII
617 characters and convert spaces to nonbreaking spaces.
622 # renamed so that we don't have to change every single reference to
623 # time2str everywhere
625 my ($format, $time, $escape) = @_;
626 return '' unless $time > 0; # work around time2str's traditional stupidity
628 $self->{_date_format} ||= {};
629 if (!exists($self->{_dh})) {
630 my $cust_main = $self->cust_main;
631 my $locale = $cust_main->locale if $cust_main;
633 my %info = FS::Locales->locale_info($locale);
634 my $dh = eval { Date::Language->new($info{'name'}) } ||
635 Date::Language->new(); # fall back to English
639 if ($format eq 'short') {
640 $format = $self->{_date_format}->{short}
641 ||= $self->conf->config('date_format') || '%x';
642 } elsif ($format eq 'rdate') {
643 $format = $self->{_date_format}->{rdate}
644 ||= $self->conf->config('date_format') || '%m/%d/%Y';
645 } elsif ($format eq 'long') {
646 $format = $self->{_date_format}->{long}
647 ||= $self->conf->config('date_format_long') || '%b %o, %Y';
650 # actually render the date
651 my $string = $self->{_dh}->time2str($format, $time);
654 if ($escape eq 'html') {
655 $string = encode_entities($string);
656 $string =~ s/ +/ /g;
657 } elsif ($escape eq 'latex') { # just do nbsp's here
665 =item unsuspend_balance
667 If conf I<unsuspend_balance> is set and customer's current balance is
668 beneath the set threshold, unsuspends customer packages.
672 sub unsuspend_balance {
674 my $cust_main = $self->cust_main;
675 my $conf = $self->conf;
676 my $setting = $conf->config('unsuspend_balance');
678 if ($setting eq 'Zero') {
681 # kind of a pain to load/check all cust_bill instead of just open ones,
682 # but if for some reason payment gets applied to later bills before
683 # earlier ones, we still want to consider the later ones as allowable balance
684 } elsif ($setting eq 'Latest invoice charges') {
685 my @cust_bill = $cust_main->cust_bill();
686 my $cust_bill = $cust_bill[-1]; #always want the most recent one
688 $maxbalance = $cust_bill->charged || 0;
692 } elsif ($setting eq 'Charges not past due') {
695 foreach my $cust_bill ($cust_main->cust_bill()) {
696 next unless $now <= ($cust_bill->due_date || $cust_bill->_date);
697 $maxbalance += $cust_bill->charged || 0;
699 } elsif (length($setting)) {
700 warn "Unrecognized unsuspend_balance setting $setting";
705 my $balance = $cust_main->balance || 0;
706 if ($balance <= $maxbalance) {
707 my @errors = $cust_main->unsuspend;
708 # side-fx with nested transactions? upstack rolls back?
709 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
722 L<FS::cust_main>, L<FS::Record>