X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fmsg_template.pm;h=1c458a090cb02cf0faf79ca9402cd925e3b84128;hp=7d507f4fb32ce5c2b633f351b492d1efdbbaecfb;hb=167480801f938b021e2b06113cf9284bd3b6895b;hpb=aa4d239c957f56aaf8f663ed9e3036477ae91b22 diff --git a/FS/FS/msg_template.pm b/FS/FS/msg_template.pm index 7d507f4fb..1c458a090 100644 --- a/FS/FS/msg_template.pm +++ b/FS/FS/msg_template.pm @@ -6,12 +6,19 @@ use Text::Template; use FS::Misc qw( generate_email send_email ); 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 vars '$DEBUG'; +use vars qw( $DEBUG $conf ); + +FS::UID->install_callback( sub { $conf = new FS::Conf; } ); $DEBUG=0; @@ -42,37 +49,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 @@ -93,14 +82,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 @@ -110,14 +126,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 @@ -138,8 +199,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') ; @@ -150,6 +209,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' @@ -166,7 +240,31 @@ Customer object (required). =item object Additional context object (currently, can be a cust_main, cust_pkg, -cust_bill, svc_acct, or cust_pay object). +cust_bill, cust_pay, cust_pay_pending, or svc_(acct, phone, broadband, +domain) ). If the object is a svc_*, 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 from_config + +Configuration option to use as the source address, based on the customer's +agentnum. If unspecified (or the named option is empty), 'invoice_from' +will be used. + +The I field in the template takes precedence over this. + +=item to + +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 @@ -177,6 +275,12 @@ sub prepare { my $cust_main = $opt{'cust_main'}; my $object = $opt{'object'}; + + # 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); @@ -186,15 +290,37 @@ sub prepare { # create substitution table ### my %hash; - foreach my $obj ($cust_main, $object || ()) { + 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{$name} = $obj->$name(); + $hash{$prefix.$name} = $obj->$name(); } elsif( ref($name) eq 'ARRAY' ) { # [ foo => sub { ... } ] - $hash{$name->[0]} = $name->[1]->($obj); + $hash{$prefix.($name->[0])} = $name->[1]->($obj); } else { warn "bad msg_template substitution: '$name'\n"; @@ -202,19 +328,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 @@ -226,7 +356,7 @@ sub prepare { $_ } @$guts; - $body = ''; + $body = '{ use Date::Format qw(time2str); "" }'; while(@$skin || @$guts) { $body .= shift(@$skin) || ''; $body .= shift(@$guts) || ''; @@ -247,17 +377,42 @@ sub prepare { # and email ### - my @to = $cust_main->invoicing_list_emailonly; - warn "prepared msg_template with no email destination (custnum ". - $cust_main->custnum.")\n" - if !@to; + my @to; + if ( exists($opt{'to'}) ) { + @to = split(/\s*,\s*/, $opt{'to'}); + } + else { + @to = $cust_main->invoicing_list_emailonly; + } + # no warning when preparing with no destination - my $conf = new FS::Conf; + my $from_addr = $self->from_addr; + + if ( !$from_addr ) { + if ( $opt{'from_config'} ) { + $from_addr = scalar( $conf->config($opt{'from_config'}, + $cust_main->agentnum) ); + } + $from_addr ||= scalar( $conf->config('invoice_from', + $cust_main->agentnum) ); + } +# my @cust_msg = (); +# if ( $conf->exists('log_sent_mail') and !$opt{'preview'} ) { +# my $cust_msg = FS::cust_msg->new({ +# 'custnum' => $cust_main->custnum, +# 'msgnum' => $self->msgnum, +# 'status' => 'prepared', +# }); +# $cust_msg->insert; +# @cust_msg = ('cust_msg' => $cust_msg); +# } ( - 'from' => $self->from || - scalar( $conf->config('invoice_from', $cust_main->agentnum) ), + 'custnum' => $cust_main->custnum, + 'msgnum' => $self->msgnum, + 'from' => $from_addr, 'to' => \@to, + 'bcc' => $self->bcc_addr || undef, 'subject' => $subject, 'html_body' => $body, 'text_body' => HTML::FormatText->new(leftmargin => 0, rightmargin => 70 @@ -283,8 +438,7 @@ sub send { # helper sub for package dates my $ymd = sub { $_[0] ? time2str('%Y-%m-%d', $_[0]) : '' }; -# needed for some things -my $conf = new FS::Conf; +#my $conf = new FS::Conf; #return contexts and fill-in values # If you add anything, be sure to add a description in @@ -310,13 +464,16 @@ sub substitutions { num_cancelled_pkgs num_ncancelled_pkgs num_pkgs classname categoryname balance + credit_limit invoicing_list_emailonly cust_status ucfirst_cust_status cust_statuscolor signupdate dundate + packages recurdates ), - [ signupdate_ymd => sub { time2str('%Y-%m-%d', shift->signupdate) } ], - [ dundate_ymd => sub { time2str('%Y-%m-%d', shift->dundate) } ], + [ expdate => sub { shift->paydate_epoch } ], #compatibility + [ signupdate_ymd => sub { $ymd->(shift->signupdate) } ], + [ dundate_ymd => sub { $ymd->(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 } ], @@ -324,6 +481,12 @@ sub substitutions { [ company_name => sub { $conf->config('company_name', shift->agentnum) } ], + [ company_address => sub { + $conf->config('company_address', shift->agentnum) + } ], + [ company_phonenum => sub { + $conf->config('company_phonenum', shift->agentnum) + } ], ], # next_bill_date 'cust_pkg' => [qw( @@ -335,6 +498,7 @@ sub substitutions { adjourn susp expire labels_short ), + [ pkg => sub { shift->part_pkg->pkg } ], [ cancel => sub { shift->getfield('cancel') } ], # grrr... [ start_ymd => sub { $ymd->(shift->getfield('start_date')) } ], [ setup_ymd => sub { $ymd->(shift->getfield('setup')) } ], @@ -351,11 +515,46 @@ sub substitutions { )], #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 welcome messages + ], + 'svc_domain' => [qw( + svcnum + domain + ), + [ registrar => sub { + my $registrar = qsearchs('registrar', + { registrarnum => shift->registrarnum} ); + $registrar ? $registrar->registrarname : '' + } + ], + [ catchall => sub { + my $svc_acct = qsearchs('svc_acct', { svcnum => shift->catchall }); + $svc_acct ? $svc_acct->email : '' + } + ], + ], + 'svc_phone' => [qw( + svcnum + phonenum + countrycode + domain + ) + ], + 'svc_broadband' => [qw( + svcnum + speed_up + speed_down + ip_addr + mac_addr + ) + ], + # for payment receipts 'cust_pay' => [qw( paynum _date @@ -370,36 +569,77 @@ sub substitutions { $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) + } ], + ], }; } +=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) = @_; my @fixes = ( - [ 'alerter_msgnum', 'alerter_template', '', '' ], - [ 'cancel_msgnum', 'cancelmessage', 'cancelsubject', '' ], - [ 'decline_msgnum', 'declinetemplate', '', '' ], - [ 'impending_recur_msgnum', 'impending_recur_template', '', '' ], - [ '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' ], + [ '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) = @$_; + 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), - '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; @@ -410,6 +650,19 @@ sub _upgrade_data { } } } + foreach my $msg_template ( qsearch('msg_template', {}) ) { + if ( $msg_template->subject || $msg_template->body ) { + # create new default content + my %content; + foreach ('subject','body') { + $content{$_} = $msg_template->$_; + $msg_template->setfield($_, ''); + } + + my $error = $msg_template->replace(%content); + die $error if $error; + } + } } sub eviscerate {