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.
388 Returns an error message, or false for success.
390 If any messages fail to send, they will be queued as individual
391 jobs which can be manually retried. If the first ten messages
392 in the job fail, the entire job will abort and return an error.
396 use Storable qw(thaw);
398 use Data::Dumper qw(Dumper);
399 use Digest::SHA qw(sha1); # for duplicate checking
401 sub email_search_result {
402 my($class, $param) = @_;
404 my $msgnum = $param->{msgnum};
405 my $from = delete $param->{from};
406 my $subject = delete $param->{subject};
407 my $html_body = delete $param->{html_body};
408 my $text_body = delete $param->{text_body};
411 my $job = delete $param->{'job'}
412 or die "email_search_result must run from the job queue.\n";
416 $msg_template = qsearchs('msg_template', { msgnum => $msgnum } )
417 or die "msgnum $msgnum not found\n";
419 $msg_template = FS::msg_template->new({
421 msgname => $subject, # maybe a timestamp also?
422 disabled => 'D', # 'D'raft
425 $error = $msg_template->insert(
429 return "$error (when creating draft template)" if $error;
432 my $sql_query = $class->search($param->{'search'});
433 $sql_query->{'select'} = $sql_query->{'table'} . '.*';
435 my $count_query = delete($sql_query->{'count_query'});
436 my $count_sth = dbh->prepare($count_query)
437 or die "Error preparing $count_query: ". dbh->errstr;
439 or die "Error executing $count_query: ". $count_sth->errstr;
440 my $count_arrayref = $count_sth->fetchrow_arrayref;
441 my $num_cust = $count_arrayref->[0];
443 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
449 if ( !$msg_template ) {
450 die "email_search_result now requires a msg_template";
453 #eventually order+limit magic to reduce memory use?
454 foreach my $obj ( qsearch($sql_query) ) {
456 #progressbar first, so that the count is right
458 if ( time - $min_sec > $last ) {
459 my $error = $job->update_statustext(
460 int( 100 * $num / $num_cust )
462 die $error if $error;
466 my $cust_main = $obj->cust_main;
468 next; # unlinked object; nothing else we can do
471 my $cust_msg = $msg_template->prepare(
472 'cust_main' => $cust_main,
476 # For non-cust_main searches, we avoid duplicates based on message
478 my $unique = $cust_main->custnum;
479 $unique .= sha1($cust_msg->text_body) if $class ne 'FS::cust_main';
480 if( $sent_to{$unique} ) {
486 $sent_to{$unique} = 1;
488 $error = $cust_msg->send;
491 # queue the sending of this message so that the user can see what we
492 # tried to do, and retry if desired
493 # (note the cust_msg itself also now has a status of 'failed'; that's
494 # fine, as it will get its status reset if we retry the job)
495 my $queue = new FS::queue {
496 'job' => 'FS::cust_msg::process_send',
497 'custnum' => $cust_main->custnum,
498 'status' => 'failed',
499 'statustext' => $error,
501 $queue->insert($cust_msg->custmsgnum);
502 push @retry_jobs, $queue;
509 (scalar(@retry_jobs) > 10 or $num == $num_cust)
511 # 10 is arbitrary, but if we have enough failures, that's
512 # probably a configuration or network problem, and we
513 # abort the batch and run away screaming.
514 # We NEVER do this if anything was successfully sent.
515 $_->delete foreach (@retry_jobs);
516 return "multiple failures: '$error'\n";
520 # if the message template was created as "draft", change its status to
522 if ($msg_template->disabled eq 'D') {
523 $msg_template->set('disabled' => 'C');
524 my $error = $msg_template->replace;
525 warn "$error (setting draft message template status)" if $error;
529 # fail the job, but with a status message that makes it clear
530 # something was sent.
531 return "Sent $success, skipped $dups duplicate(s), failed ".scalar(@retry_jobs).". Failed attempts placed in job queue.\n";
537 sub process_email_search_result {
539 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
542 warn Dumper($param) if $DEBUG;
544 $param->{'job'} = $job;
546 $param->{'search'} = thaw(decode_base64($param->{'search'}))
547 or die "process_email_search_result requires search params.\n";
549 my $table = $param->{'table'}
550 or die "process_email_search_result requires table.\n";
552 eval "use FS::$table;";
553 die "error loading FS::$table: $@\n" if $@;
555 my $error = "FS::$table"->email_search_result( $param );
556 dbh->commit; # save failed jobs before rethrowing the error
557 die $error if $error;
563 Returns a configuration handle (L<FS::Conf>) set to the customer's locale,
564 if they have one. If not, returns an FS::Conf with no locale.
570 return $self->{_conf} if (ref $self and $self->{_conf});
571 my $cust_main = $self->cust_main;
572 my $conf = new FS::Conf {
573 'locale' => ($cust_main ? $cust_main->locale : '')
575 $self->{_conf} = $conf if ref $self;
579 =item mt TEXT [, ARGS ]
581 Localizes a text string (see L<Locale::Maketext>) for the customer's locale,
588 return $self->{_lh}->maketext(@_) if (ref $self and $self->{_lh});
589 my $cust_main = $self->cust_main;
590 my $locale = $cust_main ? $cust_main->locale : '';
591 my $lh = FS::L10N->get_handle($locale);
592 $self->{_lh} = $lh if ref $self;
593 return $lh->maketext(@_);
596 =item time2str_local FORMAT, TIME[, ESCAPE]
598 Localizes a date (see L<Date::Language>) for the customer's locale.
600 FORMAT can be a L<Date::Format> string, or one of these special words:
602 - "short": the value of the "date_format" config setting for the customer's
603 locale, defaulting to "%x".
604 - "rdate": the same as "short" except that the default has a four-digit year.
605 - "long": the value of the "date_format_long" config setting for the
606 customer's locale, defaulting to "%b %o, %Y".
608 ESCAPE, if specified, is one of "latex" or "html", and will escape non-ASCII
609 characters and convert spaces to nonbreaking spaces.
614 # renamed so that we don't have to change every single reference to
615 # time2str everywhere
617 my ($format, $time, $escape) = @_;
618 return '' unless $time > 0; # work around time2str's traditional stupidity
620 $self->{_date_format} ||= {};
621 if (!exists($self->{_dh})) {
622 my $cust_main = $self->cust_main;
623 my $locale = $cust_main->locale if $cust_main;
625 my %info = FS::Locales->locale_info($locale);
626 my $dh = eval { Date::Language->new($info{'name'}) } ||
627 Date::Language->new(); # fall back to English
631 if ($format eq 'short') {
632 $format = $self->{_date_format}->{short}
633 ||= $self->conf->config('date_format') || '%x';
634 } elsif ($format eq 'rdate') {
635 $format = $self->{_date_format}->{rdate}
636 ||= $self->conf->config('date_format') || '%m/%d/%Y';
637 } elsif ($format eq 'long') {
638 $format = $self->{_date_format}->{long}
639 ||= $self->conf->config('date_format_long') || '%b %o, %Y';
642 # actually render the date
643 my $string = $self->{_dh}->time2str($format, $time);
646 if ($escape eq 'html') {
647 $string = encode_entities($string);
648 $string =~ s/ +/ /g;
649 } elsif ($escape eq 'latex') { # just do nbsp's here
663 L<FS::cust_main>, L<FS::Record>