X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fmsg_template.pm;h=2f5e4762aa6235fd806fe92d6c3c58fac051bc5f;hb=55753aaf5b1189c06a99fe5e0791fc33316df06f;hp=65acd9aaca276e66e7bb1ac39574ec2937b1e45f;hpb=0b81782a6257456e04fb8a5a7faf0dbfbf7bc166;p=freeside.git diff --git a/FS/FS/msg_template.pm b/FS/FS/msg_template.pm index 65acd9aac..2f5e4762a 100644 --- a/FS/FS/msg_template.pm +++ b/FS/FS/msg_template.pm @@ -3,17 +3,22 @@ package FS::msg_template; use strict; use base qw( FS::Record ); use Text::Template; -use FS::Misc qw( generate_email send_email ); +use FS::Misc qw( generate_email send_email do_print ); use FS::Conf; use FS::Record qw( qsearch qsearchs ); +use FS::UID qw( dbh ); use FS::cust_main; use FS::cust_msg; +use FS::template_content; use Date::Format qw( time2str ); use HTML::Entities qw( decode_entities encode_entities ) ; use HTML::FormatText; use HTML::TreeBuilder; + +use File::Temp; +use IPC::Run qw(run); use vars qw( $DEBUG $conf ); FS::UID->install_callback( sub { $conf = new FS::Conf; } ); @@ -47,37 +52,19 @@ supported: =over 4 -=item msgnum - -primary key - -=item msgname - -Template name. - -=item agentnum - -Agent associated with this template. Can be NULL for a global template. - -=item mime_type - -MIME type. Defaults to text/html. - -=item from_addr - -Source email address. - -=item subject +=item msgnum - primary key -The message subject line, in L format. +=item msgname - Name of the template. This will appear in the user interface; +if it needs to be localized for some users, add it to the message catalog. -=item body +=item agentnum - Agent associated with this template. Can be NULL for a +global template. -The message body, as plain text or HTML, in L format. +=item mime_type - MIME type. Defaults to text/html. -=item disabled +=item from_addr - Source email address. -disabled +=item disabled - disabled ('Y' or NULL). =back @@ -98,14 +85,41 @@ points to. You can ask the object for a copy with the I method. sub table { 'msg_template'; } -=item insert +=item insert [ CONTENT ] Adds this record to the database. If there is an error, returns the error, otherwise returns false. +A default (no locale) L object will be created. CONTENT +is an optional hash containing 'subject' and 'body' for this object. + =cut -# the insert method can be inherited from FS::Record +sub insert { + my $self = shift; + my %content = @_; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + my $error = $self->SUPER::insert; + if ( !$error ) { + $content{'msgnum'} = $self->msgnum; + $content{'subject'} ||= ''; + $content{'body'} ||= ''; + my $template_content = new FS::template_content (\%content); + $error = $template_content->insert; + } + + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + $dbh->commit if $oldAutoCommit; + return; +} =item delete @@ -115,14 +129,59 @@ Delete this record from the database. # the delete method can be inherited from FS::Record -=item replace OLD_RECORD +=item replace [ OLD_RECORD ] [ CONTENT ] Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. +CONTENT is an optional hash containing 'subject', 'body', and 'locale'. If +supplied, an L object will be created (or modified, if +one already exists for this locale). + =cut -# the replace method can be inherited from FS::Record +sub replace { + my $self = shift; + my $old = ( ref($_[0]) and $_[0]->isa('FS::Record') ) + ? shift + : $self->replace_old; + my %content = @_; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + my $error = $self->SUPER::replace($old); + + if ( !$error and %content ) { + $content{'locale'} ||= ''; + my $new_content = qsearchs('template_content', { + 'msgnum' => $self->msgnum, + 'locale' => $content{'locale'}, + } ); + if ( $new_content ) { + $new_content->subject($content{'subject'}); + $new_content->body($content{'body'}); + $error = $new_content->replace; + } + else { + $content{'msgnum'} = $self->msgnum; + $new_content = new FS::template_content \%content; + $error = $new_content->insert; + } + } + + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + warn "committing FS::msg_template->replace\n" if $DEBUG and $oldAutoCommit; + $dbh->commit if $oldAutoCommit; + return; +} + + =item check @@ -143,8 +202,6 @@ sub check { || $self->ut_text('msgname') || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum') || $self->ut_textn('mime_type') - || $self->ut_anything('subject') - || $self->ut_anything('body') || $self->ut_enum('disabled', [ '', 'Y' ] ) || $self->ut_textn('from_addr') ; @@ -155,6 +212,21 @@ sub check { $self->SUPER::check; } +=item content_locales + +Returns a hashref of the L objects attached to +this template, with the locale as key. + +=cut + +sub content_locales { + my $self = shift; + return $self->{'_content_locales'} ||= +{ + map { $_->locale , $_ } + qsearch('template_content', { 'msgnum' => $self->msgnum }) + }; +} + =item prepare OPTION => VALUE Fills in the template and returns a hash of the 'from' address, 'to' @@ -193,6 +265,10 @@ The I field in the template takes precedence over this. Destination address. The default is to use the customer's invoicing_list addresses. Multiple addresses may be comma-separated. +=item substitutions + +A hash reference of additional substitutions + =back =cut @@ -200,8 +276,14 @@ invoicing_list addresses. Multiple addresses may be comma-separated. sub prepare { my( $self, %opt ) = @_; - my $cust_main = $opt{'cust_main'}; - my $object = $opt{'object'}; + my $cust_main = $opt{'cust_main'} or die 'cust_main required'; + my $object = $opt{'object'} or die 'object required'; + + # localization + my $locale = $cust_main->locale || ''; + warn "no locale for cust#".$cust_main->custnum."; using default content\n" + if $DEBUG and !$locale; + my $content = $self->content($cust_main->locale); warn "preparing template '".$self->msgname."' to cust#".$cust_main->custnum."\n" if($DEBUG); @@ -249,19 +331,23 @@ sub prepare { } } } - $_ = encode_entities($_ || '') foreach values(%hash); + if ( $opt{substitutions} ) { + $hash{$_} = $opt{substitutions}->{$_} foreach keys %{$opt{substitutions}}; + } + + $_ = encode_entities($_ || '') foreach values(%hash); ### # clean up template ### my $subject_tmpl = new Text::Template ( TYPE => 'STRING', - SOURCE => $self->subject, + SOURCE => $content->subject, ); my $subject = $subject_tmpl->fill_in( HASH => \%hash ); - my $body = $self->body; + my $body = $content->body; my ($skin, $guts) = eviscerate($body); @$guts = map { $_ = decode_entities($_); # turn all punctuation back into itself @@ -352,9 +438,65 @@ sub send { send_email(generate_email($self->prepare(@_))); } +=item render OPTION => VALUE ... + +Fills in the template and renders it to a PDF document. Returns the +name of the PDF file. + +Options are as for 'prepare', but 'from' and 'to' are meaningless. + +=cut + +# will also have options to set paper size, margins, etc. + +sub render { + my $self = shift; + eval "use PDF::WebKit"; + die $@ if $@; + my %opt = @_; + my %hash = $self->prepare(%opt); + my $html = $hash{'html_body'}; + + # Graphics/stylesheets should probably go in /var/www on the Freeside + # machine. + my $kit = PDF::WebKit->new(\$html); #%options + # hack to use our wrapper script + $kit->configure(sub { shift->wkhtmltopdf('freeside-wkhtmltopdf') }); + + $kit->to_pdf; +} + +=item print OPTIONS + +Render a PDF and send it to the printer. OPTIONS are as for 'render'. + +=cut + +sub print { + my( $self, %opt ) = @_; + do_print( [ $self->render(%opt) ], agentnum=>$opt{cust_main}->agentnum ); +} + # helper sub for package dates my $ymd = sub { $_[0] ? time2str('%Y-%m-%d', $_[0]) : '' }; +# helper sub for money amounts +my $money = sub { ($conf->money_char || '$') . sprintf('%.2f', $_[0] || 0) }; + +# helper sub for usage-related messages +my $usage_warning = sub { + my $svc = shift; + foreach my $col (qw(seconds upbytes downbytes totalbytes)) { + my $amount = $svc->$col; next if $amount eq ''; + my $method = $col.'_threshold'; + my $threshold = $svc->$method; next if $threshold eq ''; + return [$col, $amount, $threshold] if $amount <= $threshold; + # this only returns the first one that's below threshold, if there are + # several. + } + return ['', '', '']; +}; + #my $conf = new FS::Conf; #return contexts and fill-in values @@ -368,14 +510,12 @@ sub substitutions { name name_short contact contact_firstlast address1 address2 city county state zip country - daytime night fax + daytime night mobile fax has_ship_address - ship_last ship_first ship_company ship_name ship_name_short ship_contact ship_contact_firstlast ship_address1 ship_address2 ship_city ship_county ship_state ship_zip ship_country - ship_daytime ship_night ship_fax paymask payname paytype payip num_cancelled_pkgs num_ncancelled_pkgs num_pkgs @@ -388,6 +528,16 @@ sub substitutions { signupdate dundate packages recurdates ), + [ invoicing_email => sub { shift->invoicing_list_emailonly_scalar } ], + #compatibility: obsolete ship_ fields - use the non-ship versions + map ( + { my $field = $_; + [ "ship_$field" => sub { shift->$field } ] + } + qw( last first company daytime night fax ) + ), + # ship_name, ship_name_short, ship_contact, ship_contact_firstlast + # still work, though [ expdate => sub { shift->paydate_epoch } ], #compatibility [ signupdate_ymd => sub { $ymd->(shift->signupdate) } ], [ dundate_ymd => sub { $ymd->(shift->dundate) } ], @@ -416,6 +566,8 @@ sub substitutions { labels_short ), [ pkg => sub { shift->part_pkg->pkg } ], + [ pkg_category => sub { shift->part_pkg->categoryname } ], + [ pkg_class => sub { shift->part_pkg->classname } ], [ cancel => sub { shift->getfield('cancel') } ], # grrr... [ start_ymd => sub { $ymd->(shift->getfield('start_date')) } ], [ setup_ymd => sub { $ymd->(shift->getfield('setup')) } ], @@ -425,6 +577,13 @@ sub substitutions { [ susp_ymd => sub { $ymd->(shift->getfield('susp')) } ], [ expire_ymd => sub { $ymd->(shift->getfield('expire')) } ], [ cancel_ymd => sub { $ymd->(shift->getfield('cancel')) } ], + + # not necessarily correct for non-flat packages + [ setup_fee => sub { shift->part_pkg->option('setup_fee') } ], + [ recur_fee => sub { shift->part_pkg->option('recur_fee') } ], + + [ freq_pretty => sub { shift->part_pkg->freq_pretty } ], + ], 'cust_bill' => [qw( invnum @@ -439,6 +598,9 @@ sub substitutions { domain ), [ password => sub { shift->getfield('_password') } ], + [ column => sub { &$usage_warning(shift)->[0] } ], + [ amount => sub { &$usage_warning(shift)->[1] } ], + [ threshold => sub { &$usage_warning(shift)->[2] } ], ], 'svc_domain' => [qw( svcnum @@ -505,6 +667,32 @@ sub substitutions { }; } +=item content LOCALE + +Returns the L object appropriate to LOCALE, if there +is one. If not, returns the one with a NULL locale. + +=cut + +sub content { + my $self = shift; + my $locale = shift; + qsearchs('template_content', + { 'msgnum' => $self->msgnum, 'locale' => $locale }) || + qsearchs('template_content', + { 'msgnum' => $self->msgnum, 'locale' => '' }); +} + +=item agent + +Returns the L object for this template. + +=cut + +sub agent { + qsearchs('agent', { 'agentnum' => $_[0]->agentnum }); +} + sub _upgrade_data { my ($self, %opts) = @_; @@ -524,14 +712,13 @@ sub _upgrade_data { my ($newname, $oldname, $subject, $from, $bcc) = @$_; if ($conf->exists($oldname, $agentnum)) { my $new = new FS::msg_template({ - 'msgname' => $oldname, - 'agentnum' => $agentnum, - 'from_addr' => ($from && $conf->config($from, $agentnum)) || - $conf->config('invoice_from', $agentnum), - 'bcc_addr' => ($bcc && $conf->config($from, $agentnum)) || '', - 'subject' => ($subject && $conf->config($subject, $agentnum)) || '', - 'mime_type' => 'text/html', - 'body' => join('
',$conf->config($oldname, $agentnum)), + 'msgname' => $oldname, + 'agentnum' => $agentnum, + 'from_addr' => ($from && $conf->config($from, $agentnum)) || '', + 'bcc_addr' => ($bcc && $conf->config($from, $agentnum)) || '', + 'subject' => ($subject && $conf->config($subject, $agentnum)) || '', + 'mime_type' => 'text/html', + 'body' => join('
',$conf->config($oldname, $agentnum)), }); my $error = $new->insert; die $error if $error; @@ -542,6 +729,29 @@ sub _upgrade_data { } } } + foreach my $msg_template ( qsearch('msg_template', {}) ) { + if ( $msg_template->subject || $msg_template->body ) { + # create new default content + my %content; + $content{subject} = $msg_template->subject; + $msg_template->set('subject', ''); + + # work around obscure Pg/DBD bug + # https://rt.cpan.org/Public/Bug/Display.html?id=60200 + # (though the right fix is to upgrade DBD) + my $body = $msg_template->body; + if ( $body =~ /^x([0-9a-f]+)$/ ) { + # there should be no real message templates that look like that + warn "converting template body to TEXT\n"; + $body = pack('H*', $1); + } + $content{body} = $body; + $msg_template->set('body', ''); + + my $error = $msg_template->replace(%content); + die $error if $error; + } + } } sub eviscerate {