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 vars '$DEBUG';
+use Encode;
+
+use File::Temp;
+use IPC::Run qw(run);
+use vars qw( $DEBUG $conf );
+
+FS::UID->install_callback( sub { $conf = new FS::Conf; } );
$DEBUG=0;
=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
+=item msgnum - primary key
-MIME type. Defaults to text/html.
+=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 from_addr
+=item agentnum - Agent associated with this template. Can be NULL for a
+global template.
-Source email address.
+=item mime_type - MIME type. Defaults to text/html.
-=item subject
+=item from_addr - Source email address.
-The message subject line, in L<Text::Template> format.
-
-=item body
-
-The message body, as plain text or HTML, in L<Text::Template> format.
-
-=item disabled
-
-disabled
+=item disabled - disabled ('Y' or NULL).
=back
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<FS::template_content> 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
# 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<FS::template_content> 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
|| $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')
;
$self->SUPER::check;
}
+=item content_locales
+
+Returns a hashref of the L<FS::template_content> 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'
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
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);
}
}
}
- $_ = 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
my @to;
if ( exists($opt{'to'}) ) {
+
@to = split(/\s*,\s*/, $opt{'to'});
+
+ } elsif ( $cust_main ) {
+
+ my @classes;
+ if ( $opt{'to_contact_classnum'} ) {
+ my $classnum = $opt{'to_contact_classnum'};
+ @classes = ref($classnum) ? @$classnum : split(',', $classnum);
+ }
+ if (!@classes) {
+ @classes = ( 'invoice' );
+ }
+ @to = $cust_main->contact_list_email(@classes);
+
+ } else {
+
+ die 'no To: address or cust_main object specified';
+
}
- 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 ) {
$from_addr = scalar( $conf->config($opt{'from_config'},
$cust_main->agentnum) );
}
- $from_addr ||= scalar( $conf->config('invoice_from',
- $cust_main->agentnum) );
+ $from_addr ||= $conf->invoice_from_full($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);
+# }
+
+ my $text_body = encode('UTF-8',
+ HTML::FormatText->new(leftmargin => 0, rightmargin => 70)
+ ->format( HTML::TreeBuilder->new_from_content($body) )
+ );
(
+ '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
- )->format( HTML::TreeBuilder->new_from_content($body) ),
+ 'text_body' => $text_body,
);
}
=item send OPTION => VALUE
Fills in the template and sends it to the customer. Options are as for
-'prepare'.
+'prepare', plus 'attach', a L<MIME::Entity> (or arrayref of them) to attach
+to the message.
=cut
# preview it, etc.
sub send {
my $self = shift;
- send_email(generate_email($self->prepare(@_)));
+ my %opt = @_;
+
+ my %email = generate_email($self->prepare(%opt));
+ if ( $opt{'attach'} ) {
+ my @attach;
+ if (ref($opt{'attach'}) eq 'ARRAY') {
+ @attach = @{ $opt{'attach'} };
+ } else {
+ @attach = $opt{'attach'};
+ }
+ push @{ $email{mimeparts} }, @attach;
+ }
+
+ send_email(%email);
+}
+
+=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 $script_path = `/usr/bin/which freeside-wkhtmltopdf`;
+ chomp $script_path;
+ my $kit = PDF::WebKit->new(\$html); #%options
+ # hack to use our wrapper script
+ $kit->configure(sub { shift->wkhtmltopdf($script_path) });
+
+ $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]) : '' };
-# needed for some things
-my $conf = new FS::Conf;
+# 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
# If you add anything, be sure to add a description in
# httemplate/edit/msg_template.html.
sub substitutions {
+ my $payinfo_sub = sub {
+ my $obj = shift;
+ ($obj->payby eq 'CARD' || $obj->payby eq 'CHEK')
+ ? $obj->paymask
+ : $obj->decrypt($obj->payinfo)
+ };
+ my $payinfo_end = sub {
+ my $obj = shift;
+ my $payinfo = &$payinfo_sub($obj);
+ substr($payinfo, -4);
+ };
{ 'cust_main' => [qw(
display_custnum agentnum agent_name
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
cust_status ucfirst_cust_status cust_statuscolor
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) } ],
+ [ 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) } ],
[ paydate_my => sub { sprintf('%02d/%04d', shift->paydate_monthyear) } ],
[ otaker_first => sub { shift->access_user->first } ],
[ otaker_last => sub { shift->access_user->last } ],
[ company_phonenum => sub {
$conf->config('company_phonenum', shift->agentnum)
} ],
+ [ selfservice_server_base_url => sub {
+ $conf->config('selfservice_server-base_url') #, shift->agentnum)
+ } ],
],
# next_bill_date
'cust_pkg' => [qw(
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')) } ],
[ 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
_date
- )],
+ _date_pretty
+ due_date
+ ),
+ [ due_date2str => sub { shift->due_date2str('short') } ],
+ ],
#XXX not really thinking about cust_bill substitutions quite yet
# for welcome and limit warning messages
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
# 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)
- } ],
+ [ 'payinfo' => $payinfo_sub ],
+ [ 'payinfo_end' => $payinfo_end ],
+ ],
+ # for refund receipts
+ 'cust_refund' => [
+ 'refundnum',
+ [ refund => sub { sprintf("%.2f", shift->refund) } ],
+ [ payby => sub { FS::payby->shortname(shift->payby) } ],
+ [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ],
+ [ 'payinfo' => $payinfo_sub ],
+ [ 'payinfo_end' => $payinfo_end ],
],
# for payment decline messages
# try to support all cust_pay fields
[ 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)
- } ],
+ [ 'payinfo' => $payinfo_sub ],
+ [ 'payinfo_end' => $payinfo_end ],
],
};
}
+=item content LOCALE
+
+Returns the L<FS::template_content> 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<FS::agent> object for this template.
+
+=cut
+
+sub agent {
+ qsearchs('agent', { 'agentnum' => $_[0]->agentnum });
+}
+
sub _upgrade_data {
my ($self, %opts) = @_;
+ ###
+ # First move any historical templates in config to real message templates
+ ###
+
my @fixes = (
[ 'alerter_msgnum', 'alerter_template', '', '', '' ],
[ 'cancel_msgnum', 'cancelmessage', 'cancelsubject', '', '' ],
[ '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('<BR>',$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('<BR>',$conf->config($oldname, $agentnum)),
});
my $error = $new->insert;
die $error if $error;
$conf->delete($subject, $agentnum) if $subject;
}
}
+
+ if ( $conf->exists('alert_expiration', $agentnum) ) {
+ my $msgnum = $conf->exists('alerter_msgnum', $agentnum);
+ my $template = FS::msg_template->by_key($msgnum) if $msgnum;
+ if (!$template) {
+ warn "template for alerter_msgnum $msgnum not found\n";
+ next;
+ }
+ # this is now a set of billing events
+ foreach my $days (30, 15, 5) {
+ my $event = FS::part_event->new({
+ 'agentnum' => $agentnum,
+ 'event' => "Card expiration warning - $days days",
+ 'eventtable' => 'cust_main',
+ 'check_freq' => '1d',
+ 'action' => 'notice',
+ 'disabled' => 'Y', #initialize first
+ });
+ my $error = $event->insert( 'msgnum' => $msgnum );
+ if ($error) {
+ warn "error creating expiration alert event:\n$error\n\n";
+ next;
+ }
+ # make it work like before:
+ # only send each warning once before the card expires,
+ # only warn active customers,
+ # only warn customers with CARD/DCRD,
+ # only warn customers who get email invoices
+ my %conds = (
+ 'once_every' => { 'run_delay' => '30d' },
+ 'cust_paydate_within' => { 'within' => $days.'d' },
+ 'cust_status' => { 'status' => { 'active' => 1 } },
+ 'payby' => { 'payby' => { 'CARD' => 1,
+ 'DCRD' => 1, }
+ },
+ 'message_email' => {},
+ );
+ foreach (keys %conds) {
+ my $condition = FS::part_event_condition->new({
+ 'conditionname' => $_,
+ 'eventpart' => $event->eventpart,
+ });
+ $error = $condition->insert( %{ $conds{$_} });
+ if ( $error ) {
+ warn "error creating expiration alert event:\n$error\n\n";
+ next;
+ }
+ }
+ $error = $event->initialize;
+ if ( $error ) {
+ warn "expiration alert event was created, but not initialized:\n$error\n\n";
+ }
+ } # foreach $days
+ $conf->delete('alerter_msgnum', $agentnum);
+ $conf->delete('alert_expiration', $agentnum);
+
+ } # if alerter_msgnum
+
+ }
+
+ ###
+ # Move subject and body from msg_template to template_content
+ ###
+
+ 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;
+ }
}
+
+ ###
+ # Add new-style default templates if missing
+ ###
+ $self->_populate_initial_data;
+
+}
+
+sub _populate_initial_data { #class method
+ #my($class, %opts) = @_;
+ #my $class = shift;
+
+ eval "use FS::msg_template::InitialData;";
+ die $@ if $@;
+
+ my $initial_data = FS::msg_template::InitialData->_initial_data;
+
+ foreach my $hash ( @$initial_data ) {
+
+ next if $hash->{_conf} && $conf->config( $hash->{_conf} );
+
+ my $msg_template = new FS::msg_template($hash);
+ my $error = $msg_template->insert( @{ $hash->{_insert_args} || [] } );
+ die $error if $error;
+
+ $conf->set( $hash->{_conf}, $msg_template->msgnum ) if $hash->{_conf};
+
+ }
+
}
sub eviscerate {