1 package FS::msg_template;
2 use base qw( FS::Record );
5 use vars qw( $DEBUG $conf );
7 use Date::Format qw( time2str );
12 use HTML::Entities qw( decode_entities encode_entities ) ;
14 use HTML::TreeBuilder;
17 use FS::Misc qw( generate_email send_email do_print );
19 use FS::Record qw( qsearch qsearchs );
20 use FS::UID qw( dbh );
24 use FS::template_content;
26 FS::UID->install_callback( sub { $conf = new FS::Conf; } );
32 FS::msg_template - Object methods for msg_template records
38 $record = new FS::msg_template \%hash;
39 $record = new FS::msg_template { 'column' => 'value' };
41 $error = $record->insert;
43 $error = $new_record->replace($old_record);
45 $error = $record->delete;
47 $error = $record->check;
51 An FS::msg_template object represents a customer message template.
52 FS::msg_template inherits from FS::Record. The following fields are currently
57 =item msgnum - primary key
59 =item msgname - Name of the template. This will appear in the user interface;
60 if it needs to be localized for some users, add it to the message catalog.
62 =item agentnum - Agent associated with this template. Can be NULL for a
65 =item mime_type - MIME type. Defaults to text/html.
67 =item from_addr - Source email address.
69 =item disabled - disabled ('Y' or NULL).
79 Creates a new template. To add the template to the database, see L<"insert">.
81 Note that this stores the hash reference, not a distinct copy of the hash it
82 points to. You can ask the object for a copy with the I<hash> method.
86 # the new method can be inherited from FS::Record, if a table method is defined
88 sub table { 'msg_template'; }
90 =item insert [ CONTENT ]
92 Adds this record to the database. If there is an error, returns the error,
93 otherwise returns false.
95 A default (no locale) L<FS::template_content> object will be created. CONTENT
96 is an optional hash containing 'subject' and 'body' for this object.
104 my $oldAutoCommit = $FS::UID::AutoCommit;
105 local $FS::UID::AutoCommit = 0;
108 my $error = $self->SUPER::insert;
110 $content{'msgnum'} = $self->msgnum;
111 $content{'subject'} ||= '';
112 $content{'body'} ||= '';
113 my $template_content = new FS::template_content (\%content);
114 $error = $template_content->insert;
118 $dbh->rollback if $oldAutoCommit;
122 $dbh->commit if $oldAutoCommit;
128 Delete this record from the database.
132 # the delete method can be inherited from FS::Record
134 =item replace [ OLD_RECORD ] [ CONTENT ]
136 Replaces the OLD_RECORD with this one in the database. If there is an error,
137 returns the error, otherwise returns false.
139 CONTENT is an optional hash containing 'subject', 'body', and 'locale'. If
140 supplied, an L<FS::template_content> object will be created (or modified, if
141 one already exists for this locale).
147 my $old = ( ref($_[0]) and $_[0]->isa('FS::Record') )
149 : $self->replace_old;
152 my $oldAutoCommit = $FS::UID::AutoCommit;
153 local $FS::UID::AutoCommit = 0;
156 my $error = $self->SUPER::replace($old);
158 if ( !$error and %content ) {
159 $content{'locale'} ||= '';
160 my $new_content = qsearchs('template_content', {
161 'msgnum' => $self->msgnum,
162 'locale' => $content{'locale'},
164 if ( $new_content ) {
165 $new_content->subject($content{'subject'});
166 $new_content->body($content{'body'});
167 $error = $new_content->replace;
170 $content{'msgnum'} = $self->msgnum;
171 $new_content = new FS::template_content \%content;
172 $error = $new_content->insert;
177 $dbh->rollback if $oldAutoCommit;
181 warn "committing FS::msg_template->replace\n" if $DEBUG and $oldAutoCommit;
182 $dbh->commit if $oldAutoCommit;
190 Checks all fields to make sure this is a valid template. If there is
191 an error, returns the error, otherwise returns false. Called by the insert
196 # the check method should currently be supplied - FS::Record contains some
197 # data checking routines
203 $self->ut_numbern('msgnum')
204 || $self->ut_text('msgname')
205 || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
206 || $self->ut_textn('mime_type')
207 || $self->ut_enum('disabled', [ '', 'Y' ] )
208 || $self->ut_textn('from_addr')
210 return $error if $error;
212 $self->mime_type('text/html') unless $self->mime_type;
217 =item content_locales
219 Returns a hashref of the L<FS::template_content> objects attached to
220 this template, with the locale as key.
224 sub content_locales {
226 return $self->{'_content_locales'} ||= +{
227 map { $_->locale , $_ }
228 qsearch('template_content', { 'msgnum' => $self->msgnum })
232 =item prepare OPTION => VALUE
234 Fills in the template and returns a hash of the 'from' address, 'to'
235 addresses, subject line, and body.
237 Options are passed as a list of name/value pairs:
243 Customer object (required).
247 Additional context object (currently, can be a cust_main, cust_pkg,
248 cust_bill, cust_pay, cust_pay_pending, or svc_(acct, phone, broadband,
249 domain) ). If the object is a svc_*, its cust_pkg will be fetched and
250 used for substitution.
252 As a special case, this may be an arrayref of two objects. Both
253 objects will be available for substitution, with their field names
254 prefixed with 'new_' and 'old_' respectively. This is used in the
255 rt_ticket export when exporting "replace" events.
259 Configuration option to use as the source address, based on the customer's
260 agentnum. If unspecified (or the named option is empty), 'invoice_from'
263 The I<from_addr> field in the template takes precedence over this.
267 Destination address. The default is to use the customer's
268 invoicing_list addresses. Multiple addresses may be comma-separated.
272 A hash reference of additional substitutions
279 my( $self, %opt ) = @_;
281 my $cust_main = $opt{'cust_main'} or die 'cust_main required';
282 my $object = $opt{'object'} or die 'object required';
285 my $locale = $cust_main->locale || '';
286 warn "no locale for cust#".$cust_main->custnum."; using default content\n"
287 if $DEBUG and !$locale;
288 my $content = $self->content($cust_main->locale);
289 warn "preparing template '".$self->msgname."' to cust#".$cust_main->custnum."\n"
292 my $subs = $self->substitutions;
295 # create substitution table
298 my @objects = ($cust_main);
302 if( ref($object) eq 'ARRAY' ) {
303 # [new, old], for provisioning tickets
304 push @objects, $object->[0], $object->[1];
305 push @prefixes, 'new_', 'old_';
306 $svc = $object->[0] if $object->[0]->isa('FS::svc_Common');
309 push @objects, $object;
311 $svc = $object if $object->isa('FS::svc_Common');
315 push @objects, $svc->cust_svc->cust_pkg;
319 foreach my $obj (@objects) {
320 my $prefix = shift @prefixes;
321 foreach my $name (@{ $subs->{$obj->table} }) {
324 $hash{$prefix.$name} = $obj->$name();
326 elsif( ref($name) eq 'ARRAY' ) {
327 # [ foo => sub { ... } ]
328 $hash{$prefix.($name->[0])} = $name->[1]->($obj);
331 warn "bad msg_template substitution: '$name'\n";
337 if ( $opt{substitutions} ) {
338 $hash{$_} = $opt{substitutions}->{$_} foreach keys %{$opt{substitutions}};
341 $_ = encode_entities($_ || '') foreach values(%hash);
346 my $subject_tmpl = new Text::Template (
348 SOURCE => $content->subject,
350 my $subject = $subject_tmpl->fill_in( HASH => \%hash );
352 my $body = $content->body;
353 my ($skin, $guts) = eviscerate($body);
355 $_ = decode_entities($_); # turn all punctuation back into itself
356 s/\r//gs; # remove \r's
357 s/<br[^>]*>/\n/gsi; # and <br /> tags
358 s/<p>/\n/gsi; # and <p>
359 s/<\/p>//gsi; # and </p>
360 s/\240/ /gs; # and
364 $body = '{ use Date::Format qw(time2str); "" }';
365 while(@$skin || @$guts) {
366 $body .= shift(@$skin) || '';
367 $body .= shift(@$guts) || '';
374 my $body_tmpl = new Text::Template (
379 $body = $body_tmpl->fill_in( HASH => \%hash );
386 if ( exists($opt{'to'}) ) {
387 @to = split(/\s*,\s*/, $opt{'to'});
390 @to = $cust_main->invoicing_list_emailonly;
392 # no warning when preparing with no destination
394 my $from_addr = $self->from_addr;
397 if ( $opt{'from_config'} ) {
398 $from_addr = scalar( $conf->config($opt{'from_config'},
399 $cust_main->agentnum) );
401 $from_addr ||= $conf->config('invoice_from_name', $cust_main->agentnum) ?
402 $conf->config('invoice_from_name', $cust_main->agentnum) . ' <' .
403 $conf->config('invoice_from', $cust_main->agentnum) . '>' :
404 $conf->config('invoice_from', $cust_main->agentnum);
407 # if ( $conf->exists('log_sent_mail') and !$opt{'preview'} ) {
408 # my $cust_msg = FS::cust_msg->new({
409 # 'custnum' => $cust_main->custnum,
410 # 'msgnum' => $self->msgnum,
411 # 'status' => 'prepared',
414 # @cust_msg = ('cust_msg' => $cust_msg);
417 my $text_body = encode('UTF-8',
418 HTML::FormatText->new(leftmargin => 0, rightmargin => 70)
419 ->format( HTML::TreeBuilder->new_from_content($body) )
422 'custnum' => $cust_main->custnum,
423 'msgnum' => $self->msgnum,
424 'from' => $from_addr,
426 'bcc' => $self->bcc_addr || undef,
427 'subject' => $subject,
428 'html_body' => $body,
429 'text_body' => $text_body
434 =item send OPTION => VALUE
436 Fills in the template and sends it to the customer. Options are as for
441 # broken out from prepare() in case we want to queue the sending,
445 send_email(generate_email($self->prepare(@_)));
448 =item render OPTION => VALUE ...
450 Fills in the template and renders it to a PDF document. Returns the
451 name of the PDF file.
453 Options are as for 'prepare', but 'from' and 'to' are meaningless.
457 # will also have options to set paper size, margins, etc.
461 eval "use PDF::WebKit";
464 my %hash = $self->prepare(%opt);
465 my $html = $hash{'html_body'};
467 # Graphics/stylesheets should probably go in /var/www on the Freeside
469 my $kit = PDF::WebKit->new(\$html); #%options
470 # hack to use our wrapper script
471 $kit->configure(sub { shift->wkhtmltopdf('freeside-wkhtmltopdf') });
478 Render a PDF and send it to the printer. OPTIONS are as for 'render'.
483 my( $self, %opt ) = @_;
484 do_print( [ $self->render(%opt) ], agentnum=>$opt{cust_main}->agentnum );
487 # helper sub for package dates
488 my $ymd = sub { $_[0] ? time2str('%Y-%m-%d', $_[0]) : '' };
490 # helper sub for money amounts
491 my $money = sub { ($conf->money_char || '$') . sprintf('%.2f', $_[0] || 0) };
493 # helper sub for usage-related messages
494 my $usage_warning = sub {
496 foreach my $col (qw(seconds upbytes downbytes totalbytes)) {
497 my $amount = $svc->$col; next if $amount eq '';
498 my $method = $col.'_threshold';
499 my $threshold = $svc->$method; next if $threshold eq '';
500 return [$col, $amount, $threshold] if $amount <= $threshold;
501 # this only returns the first one that's below threshold, if there are
507 #my $conf = new FS::Conf;
509 #return contexts and fill-in values
510 # If you add anything, be sure to add a description in
511 # httemplate/edit/msg_template.html.
513 { 'cust_main' => [qw(
514 display_custnum agentnum agent_name
517 name name_short contact contact_firstlast
518 address1 address2 city county state zip
520 daytime night mobile fax
523 ship_name ship_name_short ship_contact ship_contact_firstlast
524 ship_address1 ship_address2 ship_city ship_county ship_state ship_zip
527 paymask payname paytype payip
528 num_cancelled_pkgs num_ncancelled_pkgs num_pkgs
529 classname categoryname
532 invoicing_list_emailonly
533 cust_status ucfirst_cust_status cust_statuscolor cust_status_label
538 [ invoicing_email => sub { shift->invoicing_list_emailonly_scalar } ],
539 #compatibility: obsolete ship_ fields - use the non-ship versions
542 [ "ship_$field" => sub { shift->$field } ]
544 qw( last first company daytime night fax )
546 # ship_name, ship_name_short, ship_contact, ship_contact_firstlast
548 [ expdate => sub { shift->paydate_epoch } ], #compatibility
549 [ signupdate_ymd => sub { $ymd->(shift->signupdate) } ],
550 [ dundate_ymd => sub { $ymd->(shift->dundate) } ],
551 [ paydate_my => sub { sprintf('%02d/%04d', shift->paydate_monthyear) } ],
552 [ otaker_first => sub { shift->access_user->first } ],
553 [ otaker_last => sub { shift->access_user->last } ],
554 [ payby => sub { FS::payby->shortname(shift->payby) } ],
555 [ company_name => sub {
556 $conf->config('company_name', shift->agentnum)
558 [ company_address => sub {
559 $conf->config('company_address', shift->agentnum)
561 [ company_phonenum => sub {
562 $conf->config('company_phonenum', shift->agentnum)
564 [ selfservice_server_base_url => sub {
565 $conf->config('selfservice_server-base_url') #, shift->agentnum)
570 pkgnum pkg_label pkg_label_long
574 start_date setup bill last_bill
578 [ pkg => sub { shift->part_pkg->pkg } ],
579 [ pkg_category => sub { shift->part_pkg->categoryname } ],
580 [ pkg_class => sub { shift->part_pkg->classname } ],
581 [ cancel => sub { shift->getfield('cancel') } ], # grrr...
582 [ start_ymd => sub { $ymd->(shift->getfield('start_date')) } ],
583 [ setup_ymd => sub { $ymd->(shift->getfield('setup')) } ],
584 [ next_bill_ymd => sub { $ymd->(shift->getfield('bill')) } ],
585 [ last_bill_ymd => sub { $ymd->(shift->getfield('last_bill')) } ],
586 [ adjourn_ymd => sub { $ymd->(shift->getfield('adjourn')) } ],
587 [ susp_ymd => sub { $ymd->(shift->getfield('susp')) } ],
588 [ expire_ymd => sub { $ymd->(shift->getfield('expire')) } ],
589 [ cancel_ymd => sub { $ymd->(shift->getfield('cancel')) } ],
591 # not necessarily correct for non-flat packages
592 [ setup_fee => sub { shift->part_pkg->option('setup_fee') } ],
593 [ recur_fee => sub { shift->part_pkg->option('recur_fee') } ],
595 [ freq_pretty => sub { shift->part_pkg->freq_pretty } ],
605 #XXX not really thinking about cust_bill substitutions quite yet
607 # for welcome and limit warning messages
613 [ password => sub { shift->getfield('_password') } ],
614 [ column => sub { &$usage_warning(shift)->[0] } ],
615 [ amount => sub { &$usage_warning(shift)->[1] } ],
616 [ threshold => sub { &$usage_warning(shift)->[2] } ],
623 my $registrar = qsearchs('registrar',
624 { registrarnum => shift->registrarnum} );
625 $registrar ? $registrar->registrarname : ''
629 my $svc_acct = qsearchs('svc_acct', { svcnum => shift->catchall });
630 $svc_acct ? $svc_acct->email : ''
641 'svc_broadband' => [qw(
649 # for payment receipts
654 [ paid => sub { sprintf("%.2f", shift->paid) } ],
655 # overrides the one in cust_main in cases where a cust_pay is passed
656 [ payby => sub { FS::payby->shortname(shift->payby) } ],
657 [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ],
659 my $cust_pay = shift;
660 ($cust_pay->payby eq 'CARD' || $cust_pay->payby eq 'CHEK') ?
661 $cust_pay->paymask : $cust_pay->decrypt($cust_pay->payinfo)
664 # for payment decline messages
665 # try to support all cust_pay fields
666 # 'error' is a special case, it contains the raw error from the gateway
667 'cust_pay_pending' => [qw(
671 [ paid => sub { sprintf("%.2f", shift->paid) } ],
672 [ payby => sub { FS::payby->shortname(shift->payby) } ],
673 [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ],
676 ($pending->payby eq 'CARD' || $pending->payby eq 'CHEK') ?
677 $pending->paymask : $pending->decrypt($pending->payinfo)
685 Returns the L<FS::template_content> object appropriate to LOCALE, if there
686 is one. If not, returns the one with a NULL locale.
693 qsearchs('template_content',
694 { 'msgnum' => $self->msgnum, 'locale' => $locale }) ||
695 qsearchs('template_content',
696 { 'msgnum' => $self->msgnum, 'locale' => '' });
701 Returns the L<FS::agent> object for this template.
706 my ($self, %opts) = @_;
709 # First move any historical templates in config to real message templates
713 [ 'alerter_msgnum', 'alerter_template', '', '', '' ],
714 [ 'cancel_msgnum', 'cancelmessage', 'cancelsubject', '', '' ],
715 [ 'decline_msgnum', 'declinetemplate', '', '', '' ],
716 [ 'impending_recur_msgnum', 'impending_recur_template', '', '', 'impending_recur_bcc' ],
717 [ 'payment_receipt_msgnum', 'payment_receipt_email', '', '', '' ],
718 [ 'welcome_msgnum', 'welcome_email', 'welcome_email-subject', 'welcome_email-from', '' ],
719 [ 'warning_msgnum', 'warning_email', 'warning_email-subject', 'warning_email-from', '' ],
722 my @agentnums = ('', map {$_->agentnum} qsearch('agent', {}));
723 foreach my $agentnum (@agentnums) {
725 my ($newname, $oldname, $subject, $from, $bcc) = @$_;
726 if ($conf->exists($oldname, $agentnum)) {
727 my $new = new FS::msg_template({
728 'msgname' => $oldname,
729 'agentnum' => $agentnum,
730 'from_addr' => ($from && $conf->config($from, $agentnum)) || '',
731 'bcc_addr' => ($bcc && $conf->config($from, $agentnum)) || '',
732 'subject' => ($subject && $conf->config($subject, $agentnum)) || '',
733 'mime_type' => 'text/html',
734 'body' => join('<BR>',$conf->config($oldname, $agentnum)),
736 my $error = $new->insert;
737 die $error if $error;
738 $conf->set($newname, $new->msgnum, $agentnum);
739 $conf->delete($oldname, $agentnum);
740 $conf->delete($from, $agentnum) if $from;
741 $conf->delete($subject, $agentnum) if $subject;
745 if ( $conf->exists('alert_expiration', $agentnum) ) {
746 my $msgnum = $conf->exists('alerter_msgnum', $agentnum);
747 my $template = FS::msg_template->by_key($msgnum) if $msgnum;
749 warn "template for alerter_msgnum $msgnum not found\n";
752 # this is now a set of billing events
753 foreach my $days (30, 15, 5) {
754 my $event = FS::part_event->new({
755 'agentnum' => $agentnum,
756 'event' => "Card expiration warning - $days days",
757 'eventtable' => 'cust_main',
758 'check_freq' => '1d',
759 'action' => 'notice',
760 'disabled' => 'Y', #initialize first
762 my $error = $event->insert( 'msgnum' => $msgnum );
764 warn "error creating expiration alert event:\n$error\n\n";
767 # make it work like before:
768 # only send each warning once before the card expires,
769 # only warn active customers,
770 # only warn customers with CARD/DCRD,
771 # only warn customers who get email invoices
773 'once_every' => { 'run_delay' => '30d' },
774 'cust_paydate_within' => { 'within' => $days.'d' },
775 'cust_status' => { 'status' => { 'active' => 1 } },
776 'payby' => { 'payby' => { 'CARD' => 1,
779 'message_email' => {},
781 foreach (keys %conds) {
782 my $condition = FS::part_event_condition->new({
783 'conditionname' => $_,
784 'eventpart' => $event->eventpart,
786 $error = $condition->insert( %{ $conds{$_} });
788 warn "error creating expiration alert event:\n$error\n\n";
792 $error = $event->initialize;
794 warn "expiration alert event was created, but not initialized:\n$error\n\n";
797 $conf->delete('alerter_msgnum', $agentnum);
798 $conf->delete('alert_expiration', $agentnum);
800 } # if alerter_msgnum
805 # Move subject and body from msg_template to template_content
808 foreach my $msg_template ( qsearch('msg_template', {}) ) {
809 if ( $msg_template->subject || $msg_template->body ) {
810 # create new default content
812 $content{subject} = $msg_template->subject;
813 $msg_template->set('subject', '');
815 # work around obscure Pg/DBD bug
816 # https://rt.cpan.org/Public/Bug/Display.html?id=60200
817 # (though the right fix is to upgrade DBD)
818 my $body = $msg_template->body;
819 if ( $body =~ /^x([0-9a-f]+)$/ ) {
820 # there should be no real message templates that look like that
821 warn "converting template body to TEXT\n";
822 $body = pack('H*', $1);
824 $content{body} = $body;
825 $msg_template->set('body', '');
827 my $error = $msg_template->replace(%content);
828 die $error if $error;
833 # Add new-style default templates if missing
835 $self->_populate_initial_data;
839 sub _populate_initial_data { #class method
840 #my($class, %opts) = @_;
843 eval "use FS::msg_template::InitialData;";
846 my $initial_data = FS::msg_template::InitialData->_initial_data;
848 foreach my $hash ( @$initial_data ) {
850 next if $hash->{_conf} && $conf->config( $hash->{_conf} );
852 my $msg_template = new FS::msg_template($hash);
853 my $error = $msg_template->insert( @{ $hash->{_insert_args} || [] } );
854 die $error if $error;
856 $conf->set( $hash->{_conf}, $msg_template->msgnum ) if $hash->{_conf};
863 # Every bit as pleasant as it sounds.
865 # We do this because Text::Template::Preprocess doesn't
866 # actually work. It runs the entire template through
867 # the preprocessor, instead of the code segments. Which
868 # is a shame, because Text::Template already contains
869 # the code to do this operation.
871 my (@outside, @inside);
874 while($body || $chunk) {
875 my ($first, $delim, $rest);
876 # put all leading non-delimiters into $first
878 ($body =~ /^((?:\\[{}]|[^{}])*)(.*)$/s);
880 # put a leading delimiter into $delim if there is one
882 ($rest =~ /^([{}]?)(.*)$/s);
884 if( $delim eq '{' ) {
887 push @outside, $chunk;
892 elsif( $delim eq '}' ) {
895 push @inside, $chunk;
903 push @outside, $chunk . $rest;
904 } # else ? something wrong
909 (\@outside, \@inside);
918 L<FS::Record>, schema.html from the base documentation.