X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fmsg_template.pm;h=270eb1f720de2b6c61ee72a623a28821c004a2a3;hb=387c96b0d8f224f3ade27bed9348f37b432bbb8a;hp=de804b6cc436d37817f8f09942e901596da9cbf8;hpb=f07729b883f93aab6eaf4dffaa9b725e36c6852a;p=freeside.git diff --git a/FS/FS/msg_template.pm b/FS/FS/msg_template.pm index de804b6cc..270eb1f72 100644 --- a/FS/FS/msg_template.pm +++ b/FS/FS/msg_template.pm @@ -7,6 +7,14 @@ use FS::Misc qw( generate_email send_email ); use FS::Conf; use FS::Record qw( qsearch qsearchs ); +use Date::Format qw( time2str ); +use HTML::Entities qw( decode_entities encode_entities ) ; +use HTML::FormatText; +use HTML::TreeBuilder; +use vars '$DEBUG'; + +$DEBUG=0; + =head1 NAME FS::msg_template - Object methods for msg_template records @@ -40,25 +48,32 @@ primary key =item msgname -msgname +Template name. =item agentnum -agentnum +Agent associated with this template. Can be NULL for a global template. =item mime_type -mime_type +MIME type. Defaults to text/html. + +=item from_addr + +Source email address. + +=item subject + +The message subject line, in L format. =item body -body +The message body, as plain text or HTML, in L format. =item disabled disabled - =back =head1 METHODS @@ -126,6 +141,7 @@ sub check { || $self->ut_anything('subject') || $self->ut_anything('body') || $self->ut_enum('disabled', [ '', 'Y' ] ) + || $self->ut_textn('from_addr') ; return $error if $error; @@ -134,9 +150,10 @@ sub check { $self->SUPER::check; } -=item send OPTION => VALUE, ... +=item prepare OPTION => VALUE -Fills in the template and emails it to the customer. +Fills in the template and returns a hash of the 'from' address, 'to' +addresses, subject line, and body. Options are passed as a list of name/value pairs: @@ -148,67 +165,164 @@ Customer object (required). =item object -Additional context object (currently, can be a cust_main object, cust_pkg -object, or cust_bill object). +Additional context object (currently, can be a cust_main, cust_pkg, +cust_bill, svc_acct, cust_pay, or cust_pay_pending). If the object +is a svc_acct, its cust_pkg will be fetched and used for substitution. + +As a special case, this may be an arrayref of two objects. Both +objects will be available for substitution, with their field names +prefixed with 'new_' and 'old_' respectively. This is used in the +rt_ticket export when exporting "replace" events. + +=item to + +Destination address. The default is to use the customer's +invoicing_list addresses. =back =cut -sub send { +sub prepare { my( $self, %opt ) = @_; my $cust_main = $opt{'cust_main'}; my $object = $opt{'object'}; - - ### - # fill-in - ### + warn "preparing template '".$self->msgname."' to cust#".$cust_main->custnum."\n" + if($DEBUG); my $subs = $self->substitutions; - - #XXX html escape this stuff - my %hash = map { $_ => $cust_main->$_() } @{ $subs->{'cust_main'} }; - unless ( ! $object || $object->table eq 'cust_main' ) { - %hash = ( %hash, map { $_ => $object->$_() } @{ $subs->{$object->table} } ); + + ### + # create substitution table + ### + my %hash; + my @objects = ($cust_main); + my @prefixes = (''); + my $svc; + if( ref $object ) { + if( ref($object) eq 'ARRAY' ) { + # [new, old], for provisioning tickets + push @objects, $object->[0], $object->[1]; + push @prefixes, 'new_', 'old_'; + $svc = $object->[0] if $object->[0]->isa('FS::svc_Common'); + } + else { + push @objects, $object; + push @prefixes, ''; + $svc = $object if $object->isa('FS::svc_Common'); + } } + if( $svc ) { + push @objects, $svc->cust_svc->cust_pkg; + push @prefixes, ''; + } + + foreach my $obj (@objects) { + my $prefix = shift @prefixes; + foreach my $name (@{ $subs->{$obj->table} }) { + if(!ref($name)) { + # simple case + $hash{$prefix.$name} = $obj->$name(); + } + elsif( ref($name) eq 'ARRAY' ) { + # [ foo => sub { ... } ] + $hash{$prefix.($name->[0])} = $name->[1]->($obj); + } + else { + warn "bad msg_template substitution: '$name'\n"; + #skip it? + } + } + } + $_ = encode_entities($_) foreach values(%hash); + + ### + # clean up template + ### my $subject_tmpl = new Text::Template ( TYPE => 'STRING', SOURCE => $self->subject, ); my $subject = $subject_tmpl->fill_in( HASH => \%hash ); + my $body = $self->body; + my ($skin, $guts) = eviscerate($body); + @$guts = map { + $_ = decode_entities($_); # turn all punctuation back into itself + s/\r//gs; # remove \r's + s/]*>/\n/gsi; # and
tags + s/

/\n/gsi; # and

+ s/<\/p>//gsi; # and

+ s/\240/ /gs; # and   + $_ + } @$guts; + + $body = '{ use Date::Format qw(time2str); "" }'; + while(@$skin || @$guts) { + $body .= shift(@$skin) || ''; + $body .= shift(@$guts) || ''; + } + + ### + # fill-in + ### + my $body_tmpl = new Text::Template ( - TYPE => 'STRING', - SOURCE => $self->body, + TYPE => 'STRING', + SOURCE => $body, ); - my $body = $body_tmpl->fill_in( HASH => \%hash ); + + $body = $body_tmpl->fill_in( HASH => \%hash ); ### # and email ### - my @to = $cust_main->invoicing_list_emailonly; - #unless (@to) { #XXX do something } + my @to = ($opt{'to'}) || $cust_main->invoicing_list_emailonly; + warn "prepared msg_template with no email destination (custnum ". + $cust_main->custnum.")\n" + if !@to; my $conf = new FS::Conf; - send_email( - generate_email( - #XXX override from in event? - 'from' => scalar( $conf->config('invoice_from', $cust_main->agentnum) ), - 'to' => \@to, - 'subject' => $subject, - 'html_body' => $body, - #XXX auto-make a text copy w/HTML::FormatText? - # alas, us luddite mutt/pine users just aren't that big a deal - ) + ( + 'from' => $self->from_addr || + scalar( $conf->config('invoice_from', $cust_main->agentnum) ), + 'to' => \@to, + 'bcc' => $self->bcc_addr || undef, + 'subject' => $subject, + 'html_body' => $body, + 'text_body' => HTML::FormatText->new(leftmargin => 0, rightmargin => 70 + )->format( HTML::TreeBuilder->new_from_content($body) ), ); } +=item send OPTION => VALUE + +Fills in the template and sends it to the customer. Options are as for +'prepare'. + +=cut + +# broken out from prepare() in case we want to queue the sending, +# preview it, etc. +sub send { + my $self = shift; + send_email(generate_email($self->prepare(@_))); +} + +# helper sub for package dates +my $ymd = sub { $_[0] ? time2str('%Y-%m-%d', $_[0]) : '' }; + +# needed for some things +my $conf = new FS::Conf; + #return contexts and fill-in values +# If you add anything, be sure to add a description in +# httemplate/edit/msg_template.html. sub substitutions { { 'cust_main' => [qw( display_custnum agentnum agent_name @@ -226,28 +340,190 @@ sub substitutions { ship_country ship_daytime ship_night ship_fax - payby paymask payname paytype payip + paymask payname paytype payip num_cancelled_pkgs num_ncancelled_pkgs num_pkgs classname categoryname balance + credit_limit invoicing_list_emailonly cust_status ucfirst_cust_status cust_statuscolor - )], - #XXX make these pretty: signupdate dundate paydate_monthyear usernum - # next_bill_date - - 'cust_pkg' => [qw( - )], - #XXX these are going to take more pretty-ing up + signupdate dundate + expdate + packages recurdates + ), + # expdate is a special case + [ signupdate_ymd => sub { time2str('%Y-%m-%d', shift->signupdate) } ], + [ dundate_ymd => sub { time2str('%Y-%m-%d', shift->dundate) } ], + [ paydate_my => sub { sprintf('%02d/%04d', shift->paydate_monthyear) } ], + [ otaker_first => sub { shift->access_user->first } ], + [ otaker_last => sub { shift->access_user->last } ], + [ payby => sub { FS::payby->shortname(shift->payby) } ], + [ company_name => sub { + $conf->config('company_name', shift->agentnum) + } ], + [ company_address => sub { + $conf->config('company_address', shift->agentnum) + } ], + ], + # next_bill_date + 'cust_pkg' => [qw( + pkgnum pkg pkg_label pkg_label_long + location_label + status statuscolor + + start_date setup bill last_bill + adjourn susp expire + labels_short + ), + [ cancel => sub { shift->getfield('cancel') } ], # grrr... + [ start_ymd => sub { $ymd->(shift->getfield('start_date')) } ], + [ setup_ymd => sub { $ymd->(shift->getfield('setup')) } ], + [ next_bill_ymd => sub { $ymd->(shift->getfield('bill')) } ], + [ last_bill_ymd => sub { $ymd->(shift->getfield('last_bill')) } ], + [ adjourn_ymd => sub { $ymd->(shift->getfield('adjourn')) } ], + [ susp_ymd => sub { $ymd->(shift->getfield('susp')) } ], + [ expire_ymd => sub { $ymd->(shift->getfield('expire')) } ], + [ cancel_ymd => sub { $ymd->(shift->getfield('cancel')) } ], + ], 'cust_bill' => [qw( invnum + _date )], #XXX not really thinking about cust_bill substitutions quite yet - + + # for welcome and limit warning messages + 'svc_acct' => [qw( + svcnum + username + domain + ), + [ password => sub { shift->getfield('_password') } ], + ], + # for payment receipts + 'cust_pay' => [qw( + paynum + _date + ), + [ paid => sub { sprintf("%.2f", shift->paid) } ], + # overrides the one in cust_main in cases where a cust_pay is passed + [ payby => sub { FS::payby->shortname(shift->payby) } ], + [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ], + [ payinfo => sub { + my $cust_pay = shift; + ($cust_pay->payby eq 'CARD' || $cust_pay->payby eq 'CHEK') ? + $cust_pay->paymask : $cust_pay->decrypt($cust_pay->payinfo) + } ], + ], + # for payment decline messages + # try to support all cust_pay fields + # 'error' is a special case, it contains the raw error from the gateway + 'cust_pay_pending' => [qw( + _date + error + ), + [ paid => sub { sprintf("%.2f", shift->paid) } ], + [ payby => sub { FS::payby->shortname(shift->payby) } ], + [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ], + [ payinfo => sub { + my $pending = shift; + ($pending->payby eq 'CARD' || $pending->payby eq 'CHEK') ? + $pending->paymask : $pending->decrypt($pending->payinfo) + } ], + ], }; } +sub _upgrade_data { + my ($self, %opts) = @_; + + my @fixes = ( + [ 'alerter_msgnum', 'alerter_template', '', '', '' ], + [ 'cancel_msgnum', 'cancelmessage', 'cancelsubject', '', '' ], + [ 'decline_msgnum', 'declinetemplate', '', '', '' ], + [ 'impending_recur_msgnum', 'impending_recur_template', '', '', 'impending_recur_bcc' ], + [ 'payment_receipt_msgnum', 'payment_receipt_email', '', '', '' ], + [ 'welcome_msgnum', 'welcome_email', 'welcome_email-subject', 'welcome_email-from', '' ], + [ 'warning_msgnum', 'warning_email', 'warning_email-subject', 'warning_email-from', '' ], + ); + + my $conf = new FS::Conf; + my @agentnums = ('', map {$_->agentnum} qsearch('agent', {})); + foreach my $agentnum (@agentnums) { + foreach (@fixes) { + 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)), + }); + my $error = $new->insert; + die $error if $error; + $conf->set($newname, $new->msgnum, $agentnum); + $conf->delete($oldname, $agentnum); + $conf->delete($from, $agentnum) if $from; + $conf->delete($subject, $agentnum) if $subject; + } + } + } +} + +sub eviscerate { + # Every bit as pleasant as it sounds. + # + # We do this because Text::Template::Preprocess doesn't + # actually work. It runs the entire template through + # the preprocessor, instead of the code segments. Which + # is a shame, because Text::Template already contains + # the code to do this operation. + my $body = shift; + my (@outside, @inside); + my $depth = 0; + my $chunk = ''; + while($body || $chunk) { + my ($first, $delim, $rest); + # put all leading non-delimiters into $first + ($first, $rest) = + ($body =~ /^((?:\\[{}]|[^{}])*)(.*)$/s); + $chunk .= $first; + # put a leading delimiter into $delim if there is one + ($delim, $rest) = + ($rest =~ /^([{}]?)(.*)$/s); + + if( $delim eq '{' ) { + $chunk .= '{'; + if( $depth == 0 ) { + push @outside, $chunk; + $chunk = ''; + } + $depth++; + } + elsif( $delim eq '}' ) { + $depth--; + if( $depth == 0 ) { + push @inside, $chunk; + $chunk = ''; + } + $chunk .= '}'; + } + else { + # no more delimiters + if( $depth == 0 ) { + push @outside, $chunk . $rest; + } # else ? something wrong + last; + } + $body = $rest; + } + (\@outside, \@inside); +} + =back =head1 BUGS