1 package FS::msg_template;
4 use base qw( FS::Record );
6 use FS::Misc qw( generate_email send_email do_print );
8 use FS::Record qw( qsearch qsearchs );
13 use FS::template_content;
15 use Date::Format qw( time2str );
16 use HTML::Entities qw( decode_entities encode_entities ) ;
18 use HTML::TreeBuilder;
23 use vars qw( $DEBUG $conf );
25 FS::UID->install_callback( sub { $conf = new FS::Conf; } );
31 FS::msg_template - Object methods for msg_template records
37 $record = new FS::msg_template \%hash;
38 $record = new FS::msg_template { 'column' => 'value' };
40 $error = $record->insert;
42 $error = $new_record->replace($old_record);
44 $error = $record->delete;
46 $error = $record->check;
50 An FS::msg_template object represents a customer message template.
51 FS::msg_template inherits from FS::Record. The following fields are currently
56 =item msgnum - primary key
58 =item msgname - Name of the template. This will appear in the user interface;
59 if it needs to be localized for some users, add it to the message catalog.
61 =item agentnum - Agent associated with this template. Can be NULL for a
64 =item mime_type - MIME type. Defaults to text/html.
66 =item from_addr - Source email address.
68 =item disabled - disabled ('Y' or NULL).
78 Creates a new template. To add the template to the database, see L<"insert">.
80 Note that this stores the hash reference, not a distinct copy of the hash it
81 points to. You can ask the object for a copy with the I<hash> method.
85 # the new method can be inherited from FS::Record, if a table method is defined
87 sub table { 'msg_template'; }
89 =item insert [ CONTENT ]
91 Adds this record to the database. If there is an error, returns the error,
92 otherwise returns false.
94 A default (no locale) L<FS::template_content> object will be created. CONTENT
95 is an optional hash containing 'subject' and 'body' for this object.
103 my $oldAutoCommit = $FS::UID::AutoCommit;
104 local $FS::UID::AutoCommit = 0;
107 my $error = $self->SUPER::insert;
109 $content{'msgnum'} = $self->msgnum;
110 $content{'subject'} ||= '';
111 $content{'body'} ||= '';
112 my $template_content = new FS::template_content (\%content);
113 $error = $template_content->insert;
117 $dbh->rollback if $oldAutoCommit;
121 $dbh->commit if $oldAutoCommit;
127 Delete this record from the database.
131 # the delete method can be inherited from FS::Record
133 =item replace [ OLD_RECORD ] [ CONTENT ]
135 Replaces the OLD_RECORD with this one in the database. If there is an error,
136 returns the error, otherwise returns false.
138 CONTENT is an optional hash containing 'subject', 'body', and 'locale'. If
139 supplied, an L<FS::template_content> object will be created (or modified, if
140 one already exists for this locale).
146 my $old = ( ref($_[0]) and $_[0]->isa('FS::Record') )
148 : $self->replace_old;
151 my $oldAutoCommit = $FS::UID::AutoCommit;
152 local $FS::UID::AutoCommit = 0;
155 my $error = $self->SUPER::replace($old);
157 if ( !$error and %content ) {
158 $content{'locale'} ||= '';
159 my $new_content = qsearchs('template_content', {
160 'msgnum' => $self->msgnum,
161 'locale' => $content{'locale'},
163 if ( $new_content ) {
164 $new_content->subject($content{'subject'});
165 $new_content->body($content{'body'});
166 $error = $new_content->replace;
169 $content{'msgnum'} = $self->msgnum;
170 $new_content = new FS::template_content \%content;
171 $error = $new_content->insert;
176 $dbh->rollback if $oldAutoCommit;
180 warn "committing FS::msg_template->replace\n" if $DEBUG and $oldAutoCommit;
181 $dbh->commit if $oldAutoCommit;
189 Checks all fields to make sure this is a valid template. If there is
190 an error, returns the error, otherwise returns false. Called by the insert
195 # the check method should currently be supplied - FS::Record contains some
196 # data checking routines
202 $self->ut_numbern('msgnum')
203 || $self->ut_text('msgname')
204 || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
205 || $self->ut_textn('mime_type')
206 || $self->ut_enum('disabled', [ '', 'Y' ] )
207 || $self->ut_textn('from_addr')
209 return $error if $error;
211 $self->mime_type('text/html') unless $self->mime_type;
216 =item content_locales
218 Returns a hashref of the L<FS::template_content> objects attached to
219 this template, with the locale as key.
223 sub content_locales {
225 return $self->{'_content_locales'} ||= +{
226 map { $_->locale , $_ }
227 qsearch('template_content', { 'msgnum' => $self->msgnum })
231 =item prepare OPTION => VALUE
233 Fills in the template and returns a hash of the 'from' address, 'to'
234 addresses, subject line, and body.
236 Options are passed as a list of name/value pairs:
242 Customer object (required).
246 Additional context object (currently, can be a cust_main, cust_pkg,
247 cust_bill, cust_pay, cust_pay_pending, or svc_(acct, phone, broadband,
248 domain) ). If the object is a svc_*, its cust_pkg will be fetched and
249 used for substitution.
251 As a special case, this may be an arrayref of two objects. Both
252 objects will be available for substitution, with their field names
253 prefixed with 'new_' and 'old_' respectively. This is used in the
254 rt_ticket export when exporting "replace" events.
258 Configuration option to use as the source address, based on the customer's
259 agentnum. If unspecified (or the named option is empty), 'invoice_from'
262 The I<from_addr> field in the template takes precedence over this.
266 Destination address. The default is to use the customer's
267 invoicing_list addresses. Multiple addresses may be comma-separated.
271 A hash reference of additional string substitutions
275 A hash reference, keys are the names of existing substitutions,
276 values are an addition parameter object to pass to the subroutine
277 for that substitution, e.g.
280 'payment_history' => {
281 'start_date' => 1434764295,
290 my( $self, %opt ) = @_;
292 my $cust_main = $opt{'cust_main'} or die 'cust_main required';
293 my $object = $opt{'object'} or die 'object required';
296 my $locale = $cust_main->locale || '';
297 warn "no locale for cust#".$cust_main->custnum."; using default content\n"
298 if $DEBUG and !$locale;
299 my $content = $self->content($cust_main->locale);
300 warn "preparing template '".$self->msgname."' to cust#".$cust_main->custnum."\n"
303 my $subs = $self->substitutions;
306 # create substitution table
309 my @objects = ($cust_main);
313 if( ref($object) eq 'ARRAY' ) {
314 # [new, old], for provisioning tickets
315 push @objects, $object->[0], $object->[1];
316 push @prefixes, 'new_', 'old_';
317 $svc = $object->[0] if $object->[0]->isa('FS::svc_Common');
320 push @objects, $object;
322 $svc = $object if $object->isa('FS::svc_Common');
326 push @objects, $svc->cust_svc->cust_pkg;
330 foreach my $obj (@objects) {
331 my $prefix = shift @prefixes;
332 foreach my $name (@{ $subs->{$obj->table} }) {
335 $hash{$prefix.$name} = $obj->$name();
337 elsif( ref($name) eq 'ARRAY' ) {
338 # [ foo => sub { ... } ]
340 push(@subparam, $opt{'sub_param'}->{$name->[0]})
341 if $opt{'sub_param'} && $opt{'sub_param'}->{$name->[0]};
342 $hash{$prefix.($name->[0])} = $name->[1]->($obj,@subparam);
345 warn "bad msg_template substitution: '$name'\n";
351 if ( $opt{substitutions} ) {
352 $hash{$_} = $opt{substitutions}->{$_} foreach keys %{$opt{substitutions}};
355 foreach my $key (keys %hash) {
356 next if $self->no_encode($key);
357 $hash{$key} = encode_entities($_ || '');
363 my $subject_tmpl = new Text::Template (
365 SOURCE => $content->subject,
367 my $subject = $subject_tmpl->fill_in( HASH => \%hash );
369 my $body = $content->body;
370 my ($skin, $guts) = eviscerate($body);
372 $_ = decode_entities($_); # turn all punctuation back into itself
373 s/\r//gs; # remove \r's
374 s/<br[^>]*>/\n/gsi; # and <br /> tags
375 s/<p>/\n/gsi; # and <p>
376 s/<\/p>//gsi; # and </p>
377 s/\240/ /gs; # and
381 $body = '{ use Date::Format qw(time2str); "" }';
382 while(@$skin || @$guts) {
383 $body .= shift(@$skin) || '';
384 $body .= shift(@$guts) || '';
391 my $body_tmpl = new Text::Template (
396 $body = $body_tmpl->fill_in( HASH => \%hash );
403 if ( exists($opt{'to'}) ) {
404 @to = split(/\s*,\s*/, $opt{'to'});
407 @to = $cust_main->invoicing_list_emailonly;
409 # no warning when preparing with no destination
411 my $from_addr = $self->from_addr;
414 if ( $opt{'from_config'} ) {
415 $from_addr = scalar( $conf->config($opt{'from_config'},
416 $cust_main->agentnum) );
418 $from_addr ||= $conf->invoice_from_full($cust_main->agentnum);
421 # if ( $conf->exists('log_sent_mail') and !$opt{'preview'} ) {
422 # my $cust_msg = FS::cust_msg->new({
423 # 'custnum' => $cust_main->custnum,
424 # 'msgnum' => $self->msgnum,
425 # 'status' => 'prepared',
428 # @cust_msg = ('cust_msg' => $cust_msg);
431 my $text_body = encode('UTF-8',
432 HTML::FormatText->new(leftmargin => 0, rightmargin => 70)
433 ->format( HTML::TreeBuilder->new_from_content($body) )
436 'custnum' => $cust_main->custnum,
437 'msgnum' => $self->msgnum,
438 'from' => $from_addr,
440 'bcc' => $self->bcc_addr || undef,
441 'subject' => $subject,
442 'html_body' => $body,
443 'text_body' => $text_body
448 =item send OPTION => VALUE
450 Fills in the template and sends it to the customer. Options are as for
455 # broken out from prepare() in case we want to queue the sending,
459 send_email(generate_email($self->prepare(@_)));
462 =item render OPTION => VALUE ...
464 Fills in the template and renders it to a PDF document. Returns the
465 name of the PDF file.
467 Options are as for 'prepare', but 'from' and 'to' are meaningless.
471 # will also have options to set paper size, margins, etc.
475 eval "use PDF::WebKit";
478 my %hash = $self->prepare(%opt);
479 my $html = $hash{'html_body'};
481 # Graphics/stylesheets should probably go in /var/www on the Freeside
483 my $script_path = `/usr/bin/which freeside-wkhtmltopdf`;
485 my $kit = PDF::WebKit->new(\$html); #%options
486 # hack to use our wrapper script
487 $kit->configure(sub { shift->wkhtmltopdf($script_path) });
494 Render a PDF and send it to the printer. OPTIONS are as for 'render'.
499 my( $self, %opt ) = @_;
500 do_print( [ $self->render(%opt) ], agentnum=>$opt{cust_main}->agentnum );
503 # helper sub for package dates
504 my $ymd = sub { $_[0] ? time2str('%Y-%m-%d', $_[0]) : '' };
506 # helper sub for money amounts
507 my $money = sub { ($conf->money_char || '$') . sprintf('%.2f', $_[0] || 0) };
509 # helper sub for usage-related messages
510 my $usage_warning = sub {
512 foreach my $col (qw(seconds upbytes downbytes totalbytes)) {
513 my $amount = $svc->$col; next if $amount eq '';
514 my $method = $col.'_threshold';
515 my $threshold = $svc->$method; next if $threshold eq '';
516 return [$col, $amount, $threshold] if $amount <= $threshold;
517 # this only returns the first one that's below threshold, if there are
523 #my $conf = new FS::Conf;
525 # for substitutions that handle their own encoding
529 return ($field eq 'payment_history');
532 #return contexts and fill-in values
533 # If you add anything, be sure to add a description in
534 # httemplate/edit/msg_template.html.
536 { 'cust_main' => [qw(
537 display_custnum agentnum agent_name
540 name name_short contact contact_firstlast
541 address1 address2 city county state zip
543 daytime night mobile fax
546 ship_name ship_name_short ship_contact ship_contact_firstlast
547 ship_address1 ship_address2 ship_city ship_county ship_state ship_zip
550 paymask payname paytype payip
551 num_cancelled_pkgs num_ncancelled_pkgs num_pkgs
552 classname categoryname
555 invoicing_list_emailonly
556 cust_status ucfirst_cust_status cust_statuscolor
561 [ invoicing_email => sub { shift->invoicing_list_emailonly_scalar } ],
562 #compatibility: obsolete ship_ fields - use the non-ship versions
565 [ "ship_$field" => sub { shift->$field } ]
567 qw( last first company daytime night fax )
569 # ship_name, ship_name_short, ship_contact, ship_contact_firstlast
571 [ expdate => sub { shift->paydate_epoch } ], #compatibility
572 [ signupdate_ymd => sub { $ymd->(shift->signupdate) } ],
573 [ dundate_ymd => sub { $ymd->(shift->dundate) } ],
574 [ paydate_my => sub { sprintf('%02d/%04d', shift->paydate_monthyear) } ],
575 [ otaker_first => sub { shift->access_user->first } ],
576 [ otaker_last => sub { shift->access_user->last } ],
577 [ payby => sub { FS::payby->shortname(shift->payby) } ],
578 [ company_name => sub {
579 $conf->config('company_name', shift->agentnum)
581 [ company_address => sub {
582 $conf->config('company_address', shift->agentnum)
584 [ company_phonenum => sub {
585 $conf->config('company_phonenum', shift->agentnum)
587 [ selfservice_server_base_url => sub {
588 $conf->config('selfservice_server-base_url') #, shift->agentnum)
590 [ payment_history => sub {
591 my $cust_main = shift;
592 my $param = shift || {};
593 #html works, see no_encode method
594 return '<PRE>' . encode_entities($cust_main->payment_history_text($param)) . '</PRE>';
599 pkgnum pkg_label pkg_label_long
603 start_date setup bill last_bill
607 [ pkg => sub { shift->part_pkg->pkg } ],
608 [ pkg_category => sub { shift->part_pkg->categoryname } ],
609 [ pkg_class => sub { shift->part_pkg->classname } ],
610 [ cancel => sub { shift->getfield('cancel') } ], # grrr...
611 [ start_ymd => sub { $ymd->(shift->getfield('start_date')) } ],
612 [ setup_ymd => sub { $ymd->(shift->getfield('setup')) } ],
613 [ next_bill_ymd => sub { $ymd->(shift->getfield('bill')) } ],
614 [ last_bill_ymd => sub { $ymd->(shift->getfield('last_bill')) } ],
615 [ adjourn_ymd => sub { $ymd->(shift->getfield('adjourn')) } ],
616 [ susp_ymd => sub { $ymd->(shift->getfield('susp')) } ],
617 [ expire_ymd => sub { $ymd->(shift->getfield('expire')) } ],
618 [ cancel_ymd => sub { $ymd->(shift->getfield('cancel')) } ],
620 # not necessarily correct for non-flat packages
621 [ setup_fee => sub { shift->part_pkg->option('setup_fee') } ],
622 [ recur_fee => sub { shift->part_pkg->option('recur_fee') } ],
624 [ freq_pretty => sub { shift->part_pkg->freq_pretty } ],
633 [ due_date2str => sub { shift->due_date2str('short') } ],
635 #XXX not really thinking about cust_bill substitutions quite yet
637 # for welcome and limit warning messages
643 [ password => sub { shift->getfield('_password') } ],
644 [ column => sub { &$usage_warning(shift)->[0] } ],
645 [ amount => sub { &$usage_warning(shift)->[1] } ],
646 [ threshold => sub { &$usage_warning(shift)->[2] } ],
653 my $registrar = qsearchs('registrar',
654 { registrarnum => shift->registrarnum} );
655 $registrar ? $registrar->registrarname : ''
659 my $svc_acct = qsearchs('svc_acct', { svcnum => shift->catchall });
660 $svc_acct ? $svc_acct->email : ''
671 'svc_broadband' => [qw(
679 # for payment receipts
684 [ paid => sub { sprintf("%.2f", shift->paid) } ],
685 # overrides the one in cust_main in cases where a cust_pay is passed
686 [ payby => sub { FS::payby->shortname(shift->payby) } ],
687 [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ],
689 my $cust_pay = shift;
690 ($cust_pay->payby eq 'CARD' || $cust_pay->payby eq 'CHEK') ?
691 $cust_pay->paymask : $cust_pay->decrypt($cust_pay->payinfo)
694 # for payment decline messages
695 # try to support all cust_pay fields
696 # 'error' is a special case, it contains the raw error from the gateway
697 'cust_pay_pending' => [qw(
701 [ paid => sub { sprintf("%.2f", shift->paid) } ],
702 [ payby => sub { FS::payby->shortname(shift->payby) } ],
703 [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ],
706 ($pending->payby eq 'CARD' || $pending->payby eq 'CHEK') ?
707 $pending->paymask : $pending->decrypt($pending->payinfo)
715 Returns the L<FS::template_content> object appropriate to LOCALE, if there
716 is one. If not, returns the one with a NULL locale.
723 qsearchs('template_content',
724 { 'msgnum' => $self->msgnum, 'locale' => $locale }) ||
725 qsearchs('template_content',
726 { 'msgnum' => $self->msgnum, 'locale' => '' });
731 Returns the L<FS::agent> object for this template.
736 qsearchs('agent', { 'agentnum' => $_[0]->agentnum });
740 my ($self, %opts) = @_;
743 # First move any historical templates in config to real message templates
747 [ 'alerter_msgnum', 'alerter_template', '', '', '' ],
748 [ 'cancel_msgnum', 'cancelmessage', 'cancelsubject', '', '' ],
749 [ 'decline_msgnum', 'declinetemplate', '', '', '' ],
750 [ 'impending_recur_msgnum', 'impending_recur_template', '', '', 'impending_recur_bcc' ],
751 [ 'payment_receipt_msgnum', 'payment_receipt_email', '', '', '' ],
752 [ 'welcome_msgnum', 'welcome_email', 'welcome_email-subject', 'welcome_email-from', '' ],
753 [ 'warning_msgnum', 'warning_email', 'warning_email-subject', 'warning_email-from', '' ],
756 my @agentnums = ('', map {$_->agentnum} qsearch('agent', {}));
757 foreach my $agentnum (@agentnums) {
759 my ($newname, $oldname, $subject, $from, $bcc) = @$_;
760 if ($conf->exists($oldname, $agentnum)) {
761 my $new = new FS::msg_template({
762 'msgname' => $oldname,
763 'agentnum' => $agentnum,
764 'from_addr' => ($from && $conf->config($from, $agentnum)) || '',
765 'bcc_addr' => ($bcc && $conf->config($from, $agentnum)) || '',
766 'subject' => ($subject && $conf->config($subject, $agentnum)) || '',
767 'mime_type' => 'text/html',
768 'body' => join('<BR>',$conf->config($oldname, $agentnum)),
770 my $error = $new->insert;
771 die $error if $error;
772 $conf->set($newname, $new->msgnum, $agentnum);
773 $conf->delete($oldname, $agentnum);
774 $conf->delete($from, $agentnum) if $from;
775 $conf->delete($subject, $agentnum) if $subject;
779 if ( $conf->exists('alert_expiration', $agentnum) ) {
780 my $msgnum = $conf->exists('alerter_msgnum', $agentnum);
781 my $template = FS::msg_template->by_key($msgnum) if $msgnum;
783 warn "template for alerter_msgnum $msgnum not found\n";
786 # this is now a set of billing events
787 foreach my $days (30, 15, 5) {
788 my $event = FS::part_event->new({
789 'agentnum' => $agentnum,
790 'event' => "Card expiration warning - $days days",
791 'eventtable' => 'cust_main',
792 'check_freq' => '1d',
793 'action' => 'notice',
794 'disabled' => 'Y', #initialize first
796 my $error = $event->insert( 'msgnum' => $msgnum );
798 warn "error creating expiration alert event:\n$error\n\n";
801 # make it work like before:
802 # only send each warning once before the card expires,
803 # only warn active customers,
804 # only warn customers with CARD/DCRD,
805 # only warn customers who get email invoices
807 'once_every' => { 'run_delay' => '30d' },
808 'cust_paydate_within' => { 'within' => $days.'d' },
809 'cust_status' => { 'status' => { 'active' => 1 } },
810 'payby' => { 'payby' => { 'CARD' => 1,
813 'message_email' => {},
815 foreach (keys %conds) {
816 my $condition = FS::part_event_condition->new({
817 'conditionname' => $_,
818 'eventpart' => $event->eventpart,
820 $error = $condition->insert( %{ $conds{$_} });
822 warn "error creating expiration alert event:\n$error\n\n";
826 $error = $event->initialize;
828 warn "expiration alert event was created, but not initialized:\n$error\n\n";
831 $conf->delete('alerter_msgnum', $agentnum);
832 $conf->delete('alert_expiration', $agentnum);
834 } # if alerter_msgnum
839 # Move subject and body from msg_template to template_content
842 foreach my $msg_template ( qsearch('msg_template', {}) ) {
843 if ( $msg_template->subject || $msg_template->body ) {
844 # create new default content
846 $content{subject} = $msg_template->subject;
847 $msg_template->set('subject', '');
849 # work around obscure Pg/DBD bug
850 # https://rt.cpan.org/Public/Bug/Display.html?id=60200
851 # (though the right fix is to upgrade DBD)
852 my $body = $msg_template->body;
853 if ( $body =~ /^x([0-9a-f]+)$/ ) {
854 # there should be no real message templates that look like that
855 warn "converting template body to TEXT\n";
856 $body = pack('H*', $1);
858 $content{body} = $body;
859 $msg_template->set('body', '');
861 my $error = $msg_template->replace(%content);
862 die $error if $error;
867 # Add new-style default templates if missing
869 $self->_populate_initial_data;
873 sub _populate_initial_data { #class method
874 #my($class, %opts) = @_;
877 eval "use FS::msg_template::InitialData;";
880 my $initial_data = FS::msg_template::InitialData->_initial_data;
882 foreach my $hash ( @$initial_data ) {
884 next if $hash->{_conf} && $conf->config( $hash->{_conf} );
886 my $msg_template = new FS::msg_template($hash);
887 my $error = $msg_template->insert( @{ $hash->{_insert_args} || [] } );
888 die $error if $error;
890 $conf->set( $hash->{_conf}, $msg_template->msgnum ) if $hash->{_conf};
897 # Every bit as pleasant as it sounds.
899 # We do this because Text::Template::Preprocess doesn't
900 # actually work. It runs the entire template through
901 # the preprocessor, instead of the code segments. Which
902 # is a shame, because Text::Template already contains
903 # the code to do this operation.
905 my (@outside, @inside);
908 while($body || $chunk) {
909 my ($first, $delim, $rest);
910 # put all leading non-delimiters into $first
912 ($body =~ /^((?:\\[{}]|[^{}])*)(.*)$/s);
914 # put a leading delimiter into $delim if there is one
916 ($rest =~ /^([{}]?)(.*)$/s);
918 if( $delim eq '{' ) {
921 push @outside, $chunk;
926 elsif( $delim eq '}' ) {
929 push @inside, $chunk;
937 push @outside, $chunk . $rest;
938 } # else ? something wrong
943 (\@outside, \@inside);
952 L<FS::Record>, schema.html from the base documentation.