[freeside-commits] freeside/FS/FS Mason.pm, 1.78.2.1, 1.78.2.2 Misc.pm, 1.46, 1.46.2.1 Schema.pm, 1.317.2.1, 1.317.2.2 msg_template.pm, 1.21, 1.21.2.1 template_content.pm, NONE, 1.1.2.2
Mark Wells
mark at wavetail.420.am
Fri Aug 5 00:25:44 PDT 2011
Update of /home/cvs/cvsroot/freeside/FS/FS
In directory wavetail.420.am:/tmp/cvs-serv15439/FS/FS
Modified Files:
Tag: FREESIDE_2_3_BRANCH
Mason.pm Misc.pm Schema.pm msg_template.pm
Added Files:
Tag: FREESIDE_2_3_BRANCH
template_content.pm
Log Message:
message template localization, #13601
--- NEW FILE: template_content.pm ---
package FS::template_content;
use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
=head1 NAME
FS::template_content - Object methods for template_content records
=head1 SYNOPSIS
use FS::template_content;
$record = new FS::template_content \%hash;
$record = new FS::template_content { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::template_content object represents the content of a message template
(subject line and body) for a specific region. FS::template_content inherits
from FS::Record. The following fields are currently supported:
=over 4
=item contentnum - primary key
=item msgnum - the L<FS::msg_template> for which this is the content.
=item locale - locale (such as 'en_US'); can be NULL.
=item subject - Subject: line of the message, in L<Text::Template> format.
=item body - Message body, as plain text or HTML, in L<Text::Template> format.
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new example. To add the example to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'template_content'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=item delete
Delete this record from the database.
=cut
# the delete method can be inherited from FS::Record
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
# the replace method can be inherited from FS::Record
=item check
Checks all fields to make sure this is a valid example. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('contentnum')
|| $self->ut_foreign_key('msgnum', 'msg_template', 'msgnum')
|| $self->ut_textn('locale')
|| $self->ut_anything('subject')
|| $self->ut_anything('body')
;
return $error if $error;
$self->SUPER::check;
}
=back
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
Index: msg_template.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/msg_template.pm,v
retrieving revision 1.21
retrieving revision 1.21.2.1
diff -u -w -d -r1.21 -r1.21.2.1
--- msg_template.pm 12 Jul 2011 07:54:21 -0000 1.21
+++ msg_template.pm 5 Aug 2011 07:25:42 -0000 1.21.2.1
@@ -6,9 +6,11 @@
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 ) ;
@@ -47,37 +49,19 @@
=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<Text::Template> 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<Text::Template> 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 +82,41 @@
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
@@ -115,14 +126,59 @@
# 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
@@ -143,8 +199,6 @@
|| $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 +209,21 @@
$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'
@@ -202,6 +271,12 @@
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);
@@ -257,11 +332,11 @@
###
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
@@ -505,6 +580,32 @@
};
}
+=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) = @_;
@@ -542,6 +643,19 @@
}
}
}
+ 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 {
Index: Misc.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/Misc.pm,v
retrieving revision 1.46
retrieving revision 1.46.2.1
diff -u -w -d -r1.46 -r1.46.2.1
--- Misc.pm 1 Jul 2011 05:33:54 -0000 1.46
+++ Misc.pm 5 Aug 2011 07:25:42 -0000 1.46.2.1
@@ -9,6 +9,7 @@
use IPC::Run3; # for do_print... should just use IPC::Run i guess
use File::Temp;
use Tie::IxHash;
+use Encode;
#do NOT depend on any FS:: modules here, causes weird (sometimes unreproducable
#until on client machine) dependancy loops. put them in FS::Misc::Something
#instead
@@ -187,7 +188,7 @@
'Sender' => $options{'from'},
'Reply-To' => $options{'from'},
'Date' => time2str("%a, %d %b %Y %X %z", $time),
- 'Subject' => $options{'subject'},
+ 'Subject' => Encode::encode('MIME-Header', $options{'subject'}),
'Message-ID' => "<$message_id>",
@mimeargs,
);
@@ -352,8 +353,8 @@
$alternative->attach(
'Type' => 'text/plain',
- #'Encoding' => 'quoted-printable',
- 'Encoding' => '7bit',
+ 'Encoding' => 'quoted-printable',
+ #'Encoding' => '7bit',
'Data' => $data,
'Disposition' => 'inline',
);
Index: Mason.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/Mason.pm,v
retrieving revision 1.78.2.1
retrieving revision 1.78.2.2
diff -u -w -d -r1.78.2.1 -r1.78.2.2
--- Mason.pm 27 Jul 2011 23:56:55 -0000 1.78.2.1
+++ Mason.pm 5 Aug 2011 07:25:41 -0000 1.78.2.2
@@ -289,6 +289,7 @@
use FS::rate_center;
use FS::cust_msg;
use FS::radius_group;
+ use FS::template_content;
# Sammath Naur
if ( $FS::Mason::addl_handler_use ) {
Index: Schema.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/Schema.pm,v
retrieving revision 1.317.2.1
retrieving revision 1.317.2.2
diff -u -w -d -r1.317.2.1 -r1.317.2.2
--- Schema.pm 26 Jul 2011 23:46:09 -0000 1.317.2.1
+++ Schema.pm 5 Aug 2011 07:25:42 -0000 1.317.2.2
@@ -3386,8 +3386,21 @@
'bcc_addr', 'varchar', 'NULL', 255, '', '',
],
'primary_key' => 'msgnum',
- 'unique' => [ ['msgname', 'mime_type'] ],
- 'index' => [ ['agentnum'], ]
+ 'unique' => [ ],
+ 'index' => [ ['agentnum'], ],
+ },
+
+ 'template_content' => {
+ 'columns' => [
+ 'contentnum', 'serial', '', '', '', '',
+ 'msgnum', 'int', '', '', '', '',
+ 'locale', 'varchar', 'NULL', 16, '', '',
+ 'subject', 'varchar', 'NULL', 512, '', '',
+ 'body', 'text', 'NULL', '', '', '',
+ ],
+ 'primary_key' => 'contentnum',
+ 'unique' => [ ['msgnum', 'locale'] ],
+ 'index' => [ ],
},
'cust_msg' => {
More information about the freeside-commits
mailing list