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;
213 my $cust_main = $self->cust_main;
214 return $self->cust_unlinked_msg unless $cust_main;
215 return $cust_main->cust_status;
218 =item ucfirst_cust_status
220 Given an object that contains fields from cust_main (say, from a JOINed
221 search; see httemplate/search/ for examples), returns the equivalent of the
222 FS::cust_main I<ucfirst_status> method, or "(unlinked)" if this object is not
223 linked to a customer.
227 sub ucfirst_cust_status {
228 carp "ucfirst_cust_status deprecated, use cust_status_label";
229 local($FS::cust_main::ucfirst_nowarn) = 1;
232 ? ucfirst( $self->cust_status(@_) )
233 : $self->cust_unlinked_msg;
236 =item cust_status_label
240 sub cust_status_label {
244 ? FS::cust_main::cust_status_label($self)
245 : $self->cust_unlinked_msg;
248 =item cust_statuscolor
250 Given an object that contains fields from cust_main (say, from a JOINed
251 search; see httemplate/search/ for examples), returns the equivalent of the
252 FS::cust_main I<statuscol> method, or "000000" if this object is not linked to
257 sub cust_statuscolor {
261 ? FS::cust_main::cust_statuscolor($self)
272 ? $self->cust_main->agent_name
273 : $self->cust_unlinked_msg;
286 Class methods that return SQL framents, equivalent to the corresponding
287 FS::cust_main method.
292 # \$self->cust_linked
293 # ? FS::cust_main::${sub}_sql(\$self)
296 foreach my $sub (qw( prospect active inactive suspended cancelled )) {
299 confess 'cust_main_Mixin ${sub}_sql called with object' if ref(\$_[0]);
300 'cust_main.custnum IS NOT NULL AND '. FS::cust_main->${sub}_sql();
306 =item cust_search_sql
308 Returns a list of SQL WHERE fragments to search for parameters specified
309 in HASHREF. Valid parameters are:
321 sub cust_search_sql {
322 my($class, $param) = @_;
325 warn "$me cust_search_sql called with params: \n".
326 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
331 if ( $param->{'agentnum'} && $param->{'agentnum'} =~ /^(\d+)$/ ) {
332 push @search, "cust_main.agentnum = $1";
335 #status (prospect active inactive suspended cancelled)
336 if ( grep { $param->{'status'} eq $_ } FS::cust_main->statuses() ) {
337 my $method = $param->{'status'}. '_sql';
338 push @search, $class->$method();
341 #here is the agent virtualization
343 $FS::CurrentUser::CurrentUser->agentnums_sql( 'table' => 'cust_main' );
349 =item email_search_result HASHREF
351 Emails a notice to the specified customers. Customers without
352 invoice email destinations will be skipped.
360 Queue job for status updates. Required.
364 Hashref of params to the L<search()> method. Required.
368 Message template number (see L<FS::msg_template>). Overrides all
369 of the following options.
387 =item to_contact_classnum
389 The customer contact class (or classes, as a comma-separated list) to send
390 the message to. If unspecified, will be sent to any contacts that are marked
391 as invoice destinations (the equivalent of specifying 'invoice').
395 Returns an error message, or false for success.
397 If any messages fail to send, they will be queued as individual
398 jobs which can be manually retried. If the first ten messages
399 in the job fail, the entire job will abort and return an error.
403 use Storable qw(thaw);
405 use Data::Dumper qw(Dumper);
406 use Digest::SHA qw(sha1); # for duplicate checking
408 sub email_search_result {
409 my($class, $param) = @_;
411 my $msgnum = $param->{msgnum};
412 my $from = delete $param->{from};
413 my $subject = delete $param->{subject};
414 my $html_body = delete $param->{html_body};
415 my $text_body = delete $param->{text_body};
416 my $to_contact_classnum = delete $param->{to_contact_classnum};
419 my $job = delete $param->{'job'}
420 or die "email_search_result must run from the job queue.\n";
424 $msg_template = qsearchs('msg_template', { msgnum => $msgnum } )
425 or die "msgnum $msgnum not found\n";
427 $msg_template = FS::msg_template->new({
429 msgname => $subject, # maybe a timestamp also?
430 disabled => 'D', # 'D'raft
433 $error = $msg_template->insert(
437 return "$error (when creating draft template)" if $error;
440 my $sql_query = $class->search($param->{'search'});
441 $sql_query->{'select'} = $sql_query->{'table'} . '.*';
443 my $count_query = delete($sql_query->{'count_query'});
444 my $count_sth = dbh->prepare($count_query)
445 or die "Error preparing $count_query: ". dbh->errstr;
447 or die "Error executing $count_query: ". $count_sth->errstr;
448 my $count_arrayref = $count_sth->fetchrow_arrayref;
449 my $num_cust = $count_arrayref->[0];
451 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
457 if ( !$msg_template ) {
458 die "email_search_result now requires a msg_template";
461 #eventually order+limit magic to reduce memory use?
462 foreach my $obj ( qsearch($sql_query) ) {
464 #progressbar first, so that the count is right
466 if ( time - $min_sec > $last ) {
467 my $error = $job->update_statustext(
468 int( 100 * $num / $num_cust )
470 die $error if $error;
474 my $cust_main = $obj->cust_main;
476 next; # unlinked object; nothing else we can do
479 my $cust_msg = $msg_template->prepare(
480 'cust_main' => $cust_main,
482 'to_contact_classnum' => $to_contact_classnum,
485 # For non-cust_main searches, we avoid duplicates based on message
487 my $unique = $cust_main->custnum;
488 $unique .= sha1($cust_msg->text_body) if $class ne 'FS::cust_main';
489 if( $sent_to{$unique} ) {
495 $sent_to{$unique} = 1;
497 $error = $cust_msg->send;
500 # queue the sending of this message so that the user can see what we
501 # tried to do, and retry if desired
502 # (note the cust_msg itself also now has a status of 'failed'; that's
503 # fine, as it will get its status reset if we retry the job)
504 my $queue = new FS::queue {
505 'job' => 'FS::cust_msg::process_send',
506 'custnum' => $cust_main->custnum,
507 'status' => 'failed',
508 'statustext' => $error,
510 $queue->insert($cust_msg->custmsgnum);
511 push @retry_jobs, $queue;
518 (scalar(@retry_jobs) > 10 or $num == $num_cust)
520 # 10 is arbitrary, but if we have enough failures, that's
521 # probably a configuration or network problem, and we
522 # abort the batch and run away screaming.
523 # We NEVER do this if anything was successfully sent.
524 $_->delete foreach (@retry_jobs);
525 return "multiple failures: '$error'\n";
529 # if the message template was created as "draft", change its status to
531 if ($msg_template->disabled eq 'D') {
532 $msg_template->set('disabled' => 'C');
533 my $error = $msg_template->replace;
534 warn "$error (setting draft message template status)" if $error;
538 # fail the job, but with a status message that makes it clear
539 # something was sent.
540 return "Sent $success, skipped $dups duplicate(s), failed ".scalar(@retry_jobs).". Failed attempts placed in job queue.\n";
546 sub process_email_search_result {
548 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
551 warn Dumper($param) if $DEBUG;
553 $param->{'job'} = $job;
555 $param->{'search'} = thaw(decode_base64($param->{'search'}))
556 or die "process_email_search_result requires search params.\n";
558 my $table = $param->{'table'}
559 or die "process_email_search_result requires table.\n";
561 eval "use FS::$table;";
562 die "error loading FS::$table: $@\n" if $@;
564 my $error = "FS::$table"->email_search_result( $param );
565 dbh->commit; # save failed jobs before rethrowing the error
566 die $error if $error;
572 Returns a configuration handle (L<FS::Conf>) set to the customer's locale,
573 if they have one. If not, returns an FS::Conf with no locale.
579 return $self->{_conf} if (ref $self and $self->{_conf});
580 my $cust_main = $self->cust_main;
581 my $conf = new FS::Conf {
582 'locale' => ($cust_main ? $cust_main->locale : '')
584 $self->{_conf} = $conf if ref $self;
588 =item mt TEXT [, ARGS ]
590 Localizes a text string (see L<Locale::Maketext>) for the customer's locale,
597 return $self->{_lh}->maketext(@_) if (ref $self and $self->{_lh});
598 my $cust_main = $self->cust_main;
599 my $locale = $cust_main ? $cust_main->locale : '';
600 my $lh = FS::L10N->get_handle($locale);
601 $self->{_lh} = $lh if ref $self;
602 return $lh->maketext(@_);
605 =item time2str_local FORMAT, TIME[, ESCAPE]
607 Localizes a date (see L<Date::Language>) for the customer's locale.
609 FORMAT can be a L<Date::Format> string, or one of these special words:
611 - "short": the value of the "date_format" config setting for the customer's
612 locale, defaulting to "%x".
613 - "rdate": the same as "short" except that the default has a four-digit year.
614 - "long": the value of the "date_format_long" config setting for the
615 customer's locale, defaulting to "%b %o, %Y".
617 ESCAPE, if specified, is one of "latex" or "html", and will escape non-ASCII
618 characters and convert spaces to nonbreaking spaces.
623 # renamed so that we don't have to change every single reference to
624 # time2str everywhere
626 my ($format, $time, $escape) = @_;
627 return '' unless $time > 0; # work around time2str's traditional stupidity
629 $self->{_date_format} ||= {};
630 if (!exists($self->{_dh})) {
631 my $cust_main = $self->cust_main;
632 my $locale = $cust_main->locale if $cust_main;
634 my %info = FS::Locales->locale_info($locale);
635 my $dh = eval { Date::Language->new($info{'name'}) } ||
636 Date::Language->new(); # fall back to English
640 if ($format eq 'short') {
641 $format = $self->{_date_format}->{short}
642 ||= $self->conf->config('date_format') || '%x';
643 } elsif ($format eq 'rdate') {
644 $format = $self->{_date_format}->{rdate}
645 ||= $self->conf->config('date_format') || '%m/%d/%Y';
646 } elsif ($format eq 'long') {
647 $format = $self->{_date_format}->{long}
648 ||= $self->conf->config('date_format_long') || '%b %o, %Y';
651 # actually render the date
652 my $string = $self->{_dh}->time2str($format, $time);
655 if ($escape eq 'html') {
656 $string = encode_entities($string);
657 $string =~ s/ +/ /g;
658 } elsif ($escape eq 'latex') { # just do nbsp's here
666 =item unsuspend_balance
668 If conf I<unsuspend_balance> is set and customer's current balance is
669 beneath the set threshold, unsuspends customer packages.
673 sub unsuspend_balance {
675 my $cust_main = $self->cust_main;
676 my $conf = $self->conf;
677 my $setting = $conf->config('unsuspend_balance') or return;
679 if ($setting eq 'Zero') {
682 # kind of a pain to load/check all cust_bill instead of just open ones,
683 # but if for some reason payment gets applied to later bills before
684 # earlier ones, we still want to consider the later ones as allowable balance
685 } elsif ($setting eq 'Latest invoice charges') {
686 my @cust_bill = $cust_main->cust_bill();
687 my $cust_bill = $cust_bill[-1]; #always want the most recent one
689 $maxbalance = $cust_bill->charged || 0;
693 } elsif ($setting eq 'Charges not past due') {
696 foreach my $cust_bill ($cust_main->cust_bill()) {
697 next unless $now <= ($cust_bill->due_date || $cust_bill->_date);
698 $maxbalance += $cust_bill->charged || 0;
700 } elsif (length($setting)) {
701 warn "Unrecognized unsuspend_balance setting $setting";
706 my $balance = $cust_main->balance || 0;
707 if ($balance <= $maxbalance) {
708 my @errors = $cust_main->unsuspend;
709 # side-fx with nested transactions? upstack rolls back?
710 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
723 L<FS::cust_main>, L<FS::Record>