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 substitutions
278 my( $self, %opt ) = @_;
280 my $cust_main = $opt{'cust_main'} or die 'cust_main required';
281 my $object = $opt{'object'} or die 'object required';
284 my $locale = $cust_main->locale || '';
285 warn "no locale for cust#".$cust_main->custnum."; using default content\n"
286 if $DEBUG and !$locale;
287 my $content = $self->content($cust_main->locale);
288 warn "preparing template '".$self->msgname."' to cust#".$cust_main->custnum."\n"
291 my $subs = $self->substitutions;
294 # create substitution table
297 my @objects = ($cust_main);
301 if( ref($object) eq 'ARRAY' ) {
302 # [new, old], for provisioning tickets
303 push @objects, $object->[0], $object->[1];
304 push @prefixes, 'new_', 'old_';
305 $svc = $object->[0] if $object->[0]->isa('FS::svc_Common');
308 push @objects, $object;
310 $svc = $object if $object->isa('FS::svc_Common');
314 push @objects, $svc->cust_svc->cust_pkg;
318 foreach my $obj (@objects) {
319 my $prefix = shift @prefixes;
320 foreach my $name (@{ $subs->{$obj->table} }) {
323 $hash{$prefix.$name} = $obj->$name();
325 elsif( ref($name) eq 'ARRAY' ) {
326 # [ foo => sub { ... } ]
327 $hash{$prefix.($name->[0])} = $name->[1]->($obj);
330 warn "bad msg_template substitution: '$name'\n";
336 if ( $opt{substitutions} ) {
337 $hash{$_} = $opt{substitutions}->{$_} foreach keys %{$opt{substitutions}};
340 $_ = encode_entities($_ || '') foreach values(%hash);
345 my $subject_tmpl = new Text::Template (
347 SOURCE => $content->subject,
349 my $subject = $subject_tmpl->fill_in( HASH => \%hash );
351 my $body = $content->body;
352 my ($skin, $guts) = eviscerate($body);
354 $_ = decode_entities($_); # turn all punctuation back into itself
355 s/\r//gs; # remove \r's
356 s/<br[^>]*>/\n/gsi; # and <br /> tags
357 s/<p>/\n/gsi; # and <p>
358 s/<\/p>//gsi; # and </p>
359 s/\240/ /gs; # and
363 $body = '{ use Date::Format qw(time2str); "" }';
364 while(@$skin || @$guts) {
365 $body .= shift(@$skin) || '';
366 $body .= shift(@$guts) || '';
373 my $body_tmpl = new Text::Template (
378 $body = $body_tmpl->fill_in( HASH => \%hash );
385 if ( exists($opt{'to'}) ) {
387 @to = split(/\s*,\s*/, $opt{'to'});
389 } elsif ( $cust_main ) {
392 if ( $opt{'to_contact_classnum'} ) {
393 my $classnum = $opt{'to_contact_classnum'};
394 @classes = ref($classnum) ? @$classnum : split(',', $classnum);
397 @classes = ( 'invoice' );
399 @to = $cust_main->contact_list_email(@classes);
403 die 'no To: address or cust_main object specified';
407 my $from_addr = $self->from_addr;
410 if ( $opt{'from_config'} ) {
411 $from_addr = scalar( $conf->config($opt{'from_config'},
412 $cust_main->agentnum) );
414 $from_addr ||= $conf->invoice_from_full($cust_main->agentnum);
417 # if ( $conf->exists('log_sent_mail') and !$opt{'preview'} ) {
418 # my $cust_msg = FS::cust_msg->new({
419 # 'custnum' => $cust_main->custnum,
420 # 'msgnum' => $self->msgnum,
421 # 'status' => 'prepared',
424 # @cust_msg = ('cust_msg' => $cust_msg);
427 my $text_body = encode('UTF-8',
428 HTML::FormatText->new(leftmargin => 0, rightmargin => 70)
429 ->format( HTML::TreeBuilder->new_from_content($body) )
432 'custnum' => $cust_main->custnum,
433 'msgnum' => $self->msgnum,
434 'from' => $from_addr,
436 'bcc' => $self->bcc_addr || undef,
437 'subject' => $subject,
438 'html_body' => $body,
439 'text_body' => $text_body,
444 =item send OPTION => VALUE
446 Fills in the template and sends it to the customer. Options are as for
447 'prepare', plus 'attach', a L<MIME::Entity> (or arrayref of them) to attach
452 # broken out from prepare() in case we want to queue the sending,
458 my %email = generate_email($self->prepare(%opt));
459 if ( $opt{'attach'} ) {
461 if (ref($opt{'attach'}) eq 'ARRAY') {
462 @attach = @{ $opt{'attach'} };
464 @attach = $opt{'attach'};
466 push @{ $email{mimeparts} }, @attach;
472 =item render OPTION => VALUE ...
474 Fills in the template and renders it to a PDF document. Returns the
475 name of the PDF file.
477 Options are as for 'prepare', but 'from' and 'to' are meaningless.
481 # will also have options to set paper size, margins, etc.
485 eval "use PDF::WebKit";
488 my %hash = $self->prepare(%opt);
489 my $html = $hash{'html_body'};
491 # Graphics/stylesheets should probably go in /var/www on the Freeside
493 my $script_path = `/usr/bin/which freeside-wkhtmltopdf`;
495 my $kit = PDF::WebKit->new(\$html); #%options
496 # hack to use our wrapper script
497 $kit->configure(sub { shift->wkhtmltopdf($script_path) });
504 Render a PDF and send it to the printer. OPTIONS are as for 'render'.
509 my( $self, %opt ) = @_;
510 do_print( [ $self->render(%opt) ], agentnum=>$opt{cust_main}->agentnum );
513 # helper sub for package dates
514 my $ymd = sub { $_[0] ? time2str('%Y-%m-%d', $_[0]) : '' };
516 # helper sub for money amounts
517 my $money = sub { ($conf->money_char || '$') . sprintf('%.2f', $_[0] || 0) };
519 # helper sub for usage-related messages
520 my $usage_warning = sub {
522 foreach my $col (qw(seconds upbytes downbytes totalbytes)) {
523 my $amount = $svc->$col; next if $amount eq '';
524 my $method = $col.'_threshold';
525 my $threshold = $svc->$method; next if $threshold eq '';
526 return [$col, $amount, $threshold] if $amount <= $threshold;
527 # this only returns the first one that's below threshold, if there are
533 #my $conf = new FS::Conf;
535 #return contexts and fill-in values
536 # If you add anything, be sure to add a description in
537 # httemplate/edit/msg_template.html.
539 my $payinfo_sub = sub {
541 ($obj->payby eq 'CARD' || $obj->payby eq 'CHEK')
543 : $obj->decrypt($obj->payinfo)
545 my $payinfo_end = sub {
547 my $payinfo = &$payinfo_sub($obj);
548 substr($payinfo, -4);
550 { 'cust_main' => [qw(
551 display_custnum agentnum agent_name
554 name name_short contact contact_firstlast
555 address1 address2 city county state zip
557 daytime night mobile fax
560 ship_name ship_name_short ship_contact ship_contact_firstlast
561 ship_address1 ship_address2 ship_city ship_county ship_state ship_zip
564 paymask payname paytype payip
565 num_cancelled_pkgs num_ncancelled_pkgs num_pkgs
566 classname categoryname
569 invoicing_list_emailonly
570 cust_status ucfirst_cust_status cust_statuscolor
575 [ invoicing_email => sub { shift->invoicing_list_emailonly_scalar } ],
576 #compatibility: obsolete ship_ fields - use the non-ship versions
579 [ "ship_$field" => sub { shift->$field } ]
581 qw( last first company daytime night fax )
583 # ship_name, ship_name_short, ship_contact, ship_contact_firstlast
585 [ expdate => sub { shift->paydate_epoch } ], #compatibility
586 [ signupdate_ymd => sub { $ymd->(shift->signupdate) } ],
587 [ dundate_ymd => sub { $ymd->(shift->dundate) } ],
588 [ paydate_my => sub { sprintf('%02d/%04d', shift->paydate_monthyear) } ],
589 [ otaker_first => sub { shift->access_user->first } ],
590 [ otaker_last => sub { shift->access_user->last } ],
591 [ payby => sub { FS::payby->shortname(shift->payby) } ],
592 [ company_name => sub {
593 $conf->config('company_name', shift->agentnum)
595 [ company_address => sub {
596 $conf->config('company_address', shift->agentnum)
598 [ company_phonenum => sub {
599 $conf->config('company_phonenum', shift->agentnum)
601 [ selfservice_server_base_url => sub {
602 $conf->config('selfservice_server-base_url') #, shift->agentnum)
607 pkgnum pkg_label pkg_label_long
611 start_date setup bill last_bill
615 [ pkg => sub { shift->part_pkg->pkg } ],
616 [ pkg_category => sub { shift->part_pkg->categoryname } ],
617 [ pkg_class => sub { shift->part_pkg->classname } ],
618 [ cancel => sub { shift->getfield('cancel') } ], # grrr...
619 [ start_ymd => sub { $ymd->(shift->getfield('start_date')) } ],
620 [ setup_ymd => sub { $ymd->(shift->getfield('setup')) } ],
621 [ next_bill_ymd => sub { $ymd->(shift->getfield('bill')) } ],
622 [ last_bill_ymd => sub { $ymd->(shift->getfield('last_bill')) } ],
623 [ adjourn_ymd => sub { $ymd->(shift->getfield('adjourn')) } ],
624 [ susp_ymd => sub { $ymd->(shift->getfield('susp')) } ],
625 [ expire_ymd => sub { $ymd->(shift->getfield('expire')) } ],
626 [ cancel_ymd => sub { $ymd->(shift->getfield('cancel')) } ],
628 # not necessarily correct for non-flat packages
629 [ setup_fee => sub { shift->part_pkg->option('setup_fee') } ],
630 [ recur_fee => sub { shift->part_pkg->option('recur_fee') } ],
632 [ freq_pretty => sub { shift->part_pkg->freq_pretty } ],
641 [ due_date2str => sub { shift->due_date2str('short') } ],
643 #XXX not really thinking about cust_bill substitutions quite yet
645 # for welcome and limit warning messages
651 [ password => sub { shift->getfield('_password') } ],
652 [ column => sub { &$usage_warning(shift)->[0] } ],
653 [ amount => sub { &$usage_warning(shift)->[1] } ],
654 [ threshold => sub { &$usage_warning(shift)->[2] } ],
661 my $registrar = qsearchs('registrar',
662 { registrarnum => shift->registrarnum} );
663 $registrar ? $registrar->registrarname : ''
667 my $svc_acct = qsearchs('svc_acct', { svcnum => shift->catchall });
668 $svc_acct ? $svc_acct->email : ''
679 'svc_broadband' => [qw(
687 # for payment receipts
692 [ paid => sub { sprintf("%.2f", shift->paid) } ],
693 # overrides the one in cust_main in cases where a cust_pay is passed
694 [ payby => sub { FS::payby->shortname(shift->payby) } ],
695 [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ],
696 [ 'payinfo' => $payinfo_sub ],
697 [ 'payinfo_end' => $payinfo_end ],
699 # for refund receipts
702 [ refund => sub { sprintf("%.2f", shift->refund) } ],
703 [ payby => sub { FS::payby->shortname(shift->payby) } ],
704 [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ],
705 [ 'payinfo' => $payinfo_sub ],
706 [ 'payinfo_end' => $payinfo_end ],
708 # for payment decline messages
709 # try to support all cust_pay fields
710 # 'error' is a special case, it contains the raw error from the gateway
711 'cust_pay_pending' => [qw(
715 [ paid => sub { sprintf("%.2f", shift->paid) } ],
716 [ payby => sub { FS::payby->shortname(shift->payby) } ],
717 [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ],
718 [ 'payinfo' => $payinfo_sub ],
719 [ 'payinfo_end' => $payinfo_end ],
726 Returns the L<FS::template_content> object appropriate to LOCALE, if there
727 is one. If not, returns the one with a NULL locale.
734 qsearchs('template_content',
735 { 'msgnum' => $self->msgnum, 'locale' => $locale }) ||
736 qsearchs('template_content',
737 { 'msgnum' => $self->msgnum, 'locale' => '' });
742 Returns the L<FS::agent> object for this template.
747 qsearchs('agent', { 'agentnum' => $_[0]->agentnum });
751 my ($self, %opts) = @_;
754 # First move any historical templates in config to real message templates
758 [ 'alerter_msgnum', 'alerter_template', '', '', '' ],
759 [ 'cancel_msgnum', 'cancelmessage', 'cancelsubject', '', '' ],
760 [ 'decline_msgnum', 'declinetemplate', '', '', '' ],
761 [ 'impending_recur_msgnum', 'impending_recur_template', '', '', 'impending_recur_bcc' ],
762 [ 'payment_receipt_msgnum', 'payment_receipt_email', '', '', '' ],
763 [ 'welcome_msgnum', 'welcome_email', 'welcome_email-subject', 'welcome_email-from', '' ],
764 [ 'warning_msgnum', 'warning_email', 'warning_email-subject', 'warning_email-from', '' ],
767 my @agentnums = ('', map {$_->agentnum} qsearch('agent', {}));
768 foreach my $agentnum (@agentnums) {
770 my ($newname, $oldname, $subject, $from, $bcc) = @$_;
771 if ($conf->exists($oldname, $agentnum)) {
772 my $new = new FS::msg_template({
773 'msgname' => $oldname,
774 'agentnum' => $agentnum,
775 'from_addr' => ($from && $conf->config($from, $agentnum)) || '',
776 'bcc_addr' => ($bcc && $conf->config($from, $agentnum)) || '',
777 'subject' => ($subject && $conf->config($subject, $agentnum)) || '',
778 'mime_type' => 'text/html',
779 'body' => join('<BR>',$conf->config($oldname, $agentnum)),
781 my $error = $new->insert;
782 die $error if $error;
783 $conf->set($newname, $new->msgnum, $agentnum);
784 $conf->delete($oldname, $agentnum);
785 $conf->delete($from, $agentnum) if $from;
786 $conf->delete($subject, $agentnum) if $subject;
790 if ( $conf->exists('alert_expiration', $agentnum) ) {
791 my $msgnum = $conf->exists('alerter_msgnum', $agentnum);
792 my $template = FS::msg_template->by_key($msgnum) if $msgnum;
794 warn "template for alerter_msgnum $msgnum not found\n";
797 # this is now a set of billing events
798 foreach my $days (30, 15, 5) {
799 my $event = FS::part_event->new({
800 'agentnum' => $agentnum,
801 'event' => "Card expiration warning - $days days",
802 'eventtable' => 'cust_main',
803 'check_freq' => '1d',
804 'action' => 'notice',
805 'disabled' => 'Y', #initialize first
807 my $error = $event->insert( 'msgnum' => $msgnum );
809 warn "error creating expiration alert event:\n$error\n\n";
812 # make it work like before:
813 # only send each warning once before the card expires,
814 # only warn active customers,
815 # only warn customers with CARD/DCRD,
816 # only warn customers who get email invoices
818 'once_every' => { 'run_delay' => '30d' },
819 'cust_paydate_within' => { 'within' => $days.'d' },
820 'cust_status' => { 'status' => { 'active' => 1 } },
821 'payby' => { 'payby' => { 'CARD' => 1,
824 'message_email' => {},
826 foreach (keys %conds) {
827 my $condition = FS::part_event_condition->new({
828 'conditionname' => $_,
829 'eventpart' => $event->eventpart,
831 $error = $condition->insert( %{ $conds{$_} });
833 warn "error creating expiration alert event:\n$error\n\n";
837 $error = $event->initialize;
839 warn "expiration alert event was created, but not initialized:\n$error\n\n";
842 $conf->delete('alerter_msgnum', $agentnum);
843 $conf->delete('alert_expiration', $agentnum);
845 } # if alerter_msgnum
850 # Move subject and body from msg_template to template_content
853 foreach my $msg_template ( qsearch('msg_template', {}) ) {
854 if ( $msg_template->subject || $msg_template->body ) {
855 # create new default content
857 $content{subject} = $msg_template->subject;
858 $msg_template->set('subject', '');
860 # work around obscure Pg/DBD bug
861 # https://rt.cpan.org/Public/Bug/Display.html?id=60200
862 # (though the right fix is to upgrade DBD)
863 my $body = $msg_template->body;
864 if ( $body =~ /^x([0-9a-f]+)$/ ) {
865 # there should be no real message templates that look like that
866 warn "converting template body to TEXT\n";
867 $body = pack('H*', $1);
869 $content{body} = $body;
870 $msg_template->set('body', '');
872 my $error = $msg_template->replace(%content);
873 die $error if $error;
878 # Add new-style default templates if missing
880 $self->_populate_initial_data;
884 sub _populate_initial_data { #class method
885 #my($class, %opts) = @_;
888 eval "use FS::msg_template::InitialData;";
891 my $initial_data = FS::msg_template::InitialData->_initial_data;
893 foreach my $hash ( @$initial_data ) {
895 next if $hash->{_conf} && $conf->config( $hash->{_conf} );
897 my $msg_template = new FS::msg_template($hash);
898 my $error = $msg_template->insert( @{ $hash->{_insert_args} || [] } );
899 die $error if $error;
901 $conf->set( $hash->{_conf}, $msg_template->msgnum ) if $hash->{_conf};
908 # Every bit as pleasant as it sounds.
910 # We do this because Text::Template::Preprocess doesn't
911 # actually work. It runs the entire template through
912 # the preprocessor, instead of the code segments. Which
913 # is a shame, because Text::Template already contains
914 # the code to do this operation.
916 my (@outside, @inside);
919 while($body || $chunk) {
920 my ($first, $delim, $rest);
921 # put all leading non-delimiters into $first
923 ($body =~ /^((?:\\[{}]|[^{}])*)(.*)$/s);
925 # put a leading delimiter into $delim if there is one
927 ($rest =~ /^([{}]?)(.*)$/s);
929 if( $delim eq '{' ) {
932 push @outside, $chunk;
937 elsif( $delim eq '}' ) {
940 push @inside, $chunk;
948 push @outside, $chunk . $rest;
949 } # else ? something wrong
954 (\@outside, \@inside);
963 L<FS::Record>, schema.html from the base documentation.