-# BEGIN LICENSE BLOCK
-#
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-#
-# (Except where explictly superceded by other copyright notices)
-#
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2019 Best Practical Solutions, LLC
+# <sales@bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
-#
+#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
-#
-# Unless otherwise specified, all modifications, corrections or
-# extensions to this work which alter its source code become the
-# property of Best Practical Solutions, LLC when submitted for
-# inclusion in the work.
-#
-#
-# END LICENSE BLOCK
-# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
-# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
-#
-# !! DO NOT EDIT THIS FILE !!
#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
-use strict;
-
+# Portions Copyright 2000 Tobias Brox <tobix@cpan.org>
=head1 NAME
-RT::Template
-
+ RT::Template - RT's template object
=head1 SYNOPSIS
+ use RT::Template;
+
=head1 DESCRIPTION
+
=head1 METHODS
+
=cut
+
package RT::Template;
-use RT::Record;
+
+use strict;
+use warnings;
+
+use base 'RT::Record';
+
use RT::Queue;
+use Text::Template;
+use MIME::Entity;
+use MIME::Parser;
+use Scalar::Util 'blessed';
+
+sub _Accessible {
+ my $self = shift;
+ my %Cols = (
+ id => 'read',
+ Name => 'read/write',
+ Description => 'read/write',
+ Type => 'read/write', #Type is one of Perl or Simple
+ Content => 'read/write',
+ Queue => 'read/write',
+ Creator => 'read/auto',
+ Created => 'read/auto',
+ LastUpdatedBy => 'read/auto',
+ LastUpdated => 'read/auto'
+ );
+ return $self->SUPER::_Accessible( @_, %Cols );
+}
+
+sub _Set {
+ my $self = shift;
+ my %args = (
+ Field => undef,
+ Value => undef,
+ @_,
+ );
+
+ unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
+ return ( 0, $self->loc('Permission Denied') );
+ }
+
+ if (exists $args{Value}) {
+ if ($args{Field} eq 'Queue') {
+ if ($args{Value}) {
+ # moving to another queue
+ my $queue = RT::Queue->new( $self->CurrentUser );
+ $queue->Load($args{Value});
+ unless ($queue->Id and $queue->CurrentUserHasRight('ModifyTemplate')) {
+ return ( 0, $self->loc('Permission Denied') );
+ }
+ } else {
+ # moving to global
+ unless ($self->CurrentUser->HasRight( Object => RT->System, Right => 'ModifyTemplate' )) {
+ return ( 0, $self->loc('Permission Denied') );
+ }
+ }
+ }
+ }
+
+ return $self->SUPER::_Set( @_ );
+}
+
+=head2 _Value
-use vars qw( @ISA );
-@ISA= qw( RT::Record );
+Takes the name of a table column. Returns its value as a string,
+if the user passes an ACL check, otherwise returns undef.
-sub _Init {
- my $self = shift;
+=cut
+
+sub _Value {
+ my $self = shift;
+
+ unless ( $self->CurrentUserCanRead() ) {
+ return undef;
+ }
+ return $self->__Value( @_ );
+
+}
+
+=head2 Load <identifier>
+
+Load a template, either by number or by name.
+
+Note that loading templates by name using this method B<is
+ambiguous>. Several queues may have template with the same name
+and as well global template with the same name may exist.
+Use L</LoadByName>, L</LoadGlobalTemplate> or L<LoadQueueTemplate> to get
+precise result.
+
+=cut
+
+sub Load {
+ my $self = shift;
+ my $identifier = shift;
+ return undef unless $identifier;
+
+ if ( $identifier =~ /\D/ ) {
+ return $self->LoadByCol( 'Name', $identifier );
+ }
+ return $self->LoadById( $identifier );
+}
+
+=head2 LoadByName
+
+Takes Name and Queue arguments. Tries to load queue specific template
+first, then global. If Queue argument is omitted then global template
+is tried, not template with the name in any queue.
- $self->Table('Templates');
- $self->SUPER::_Init(@_);
+=cut
+
+sub LoadByName {
+ my $self = shift;
+ my %args = (
+ Queue => undef,
+ Name => undef,
+ @_
+ );
+ my $queue = $args{'Queue'};
+ if ( blessed $queue ) {
+ $queue = $queue->id;
+ } elsif ( defined $queue and $queue =~ /\D/ ) {
+ my $tmp = RT::Queue->new( $self->CurrentUser );
+ $tmp->Load($queue);
+ $queue = $tmp->id;
+ }
+
+ return $self->LoadGlobalTemplate( $args{'Name'} ) unless $queue;
+
+ $self->LoadQueueTemplate( Queue => $queue, Name => $args{'Name'} );
+ return $self->id if $self->id;
+ return $self->LoadGlobalTemplate( $args{'Name'} );
}
+=head2 LoadGlobalTemplate NAME
+
+Load the global template with the name NAME
+=cut
+sub LoadGlobalTemplate {
+ my $self = shift;
+ my $name = shift;
+ return ( $self->LoadQueueTemplate( Queue => 0, Name => $name ) );
+}
-=item Create PARAMHASH
+=head2 LoadQueueTemplate (Queue => QUEUEID, Name => NAME)
-Create takes a hash of values and creates a row in the database:
+Loads the Queue template named NAME for Queue QUEUE.
- int(11) 'Queue'.
- varchar(200) 'Name'.
- varchar(255) 'Description'.
- varchar(16) 'Type'.
- varchar(16) 'Language'.
- int(11) 'TranslationOf'.
- blob 'Content'.
+Note that this method doesn't load a global template with the same name
+if template in the queue doesn't exist. Use L</LoadByName>.
=cut
+sub LoadQueueTemplate {
+ my $self = shift;
+ my %args = (
+ Queue => undef,
+ Name => undef,
+ @_
+ );
+ return ( $self->LoadByCols( Name => $args{'Name'}, Queue => $args{'Queue'} ) );
+}
+
+=head2 Create
+
+Takes a paramhash of Content, Queue, Name and Description.
+Name should be a unique string identifying this Template.
+Description and Content should be the template's title and content.
+Queue should be 0 for a global template and the queue # for a queue-specific
+template.
+
+Returns the Template's id # if the create was successful. Returns undef for
+unknown database failure.
+
+=cut
sub Create {
my $self = shift;
- my %args = (
- Queue => '0',
- Name => '',
- Description => '',
- Type => '',
- Language => '',
- TranslationOf => '0',
- Content => '',
+ my %args = (
+ Content => undef,
+ Queue => 0,
+ Description => '[no description]',
+ Type => 'Perl',
+ Name => undef,
+ @_
+ );
+
+ if ( $args{Type} eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System) ) {
+ return ( undef, $self->loc('Permission Denied') );
+ }
+
+ unless ( $args{'Queue'} ) {
+ unless ( $self->CurrentUser->HasRight(Right =>'ModifyTemplate', Object => $RT::System) ) {
+ return ( undef, $self->loc('Permission Denied') );
+ }
+ $args{'Queue'} = 0;
+ }
+ else {
+ my $QueueObj = RT::Queue->new( $self->CurrentUser );
+ $QueueObj->Load( $args{'Queue'} ) || return ( undef, $self->loc('Invalid queue') );
+
+ unless ( $QueueObj->CurrentUserHasRight('ModifyTemplate') ) {
+ return ( undef, $self->loc('Permission Denied') );
+ }
+ $args{'Queue'} = $QueueObj->Id;
+ }
+
+ return ( undef, $self->loc('Name is required') )
+ unless $args{Name};
+
+ {
+ my $tmp = $self->new( RT->SystemUser );
+ $tmp->LoadByCols( Name => $args{'Name'}, Queue => $args{'Queue'} );
+ return ( undef, $self->loc('A Template with that name already exists') )
+ if $tmp->id;
+ }
+
+ my ( $result, $msg ) = $self->SUPER::Create(
+ Content => $args{'Content'},
+ Queue => $args{'Queue'},
+ Description => $args{'Description'},
+ Name => $args{'Name'},
+ Type => $args{'Type'},
+ );
+
+ if ( wantarray ) {
+ return ( $result, $msg );
+ } else {
+ return ( $result );
+ }
+
+}
+
+=head2 Delete
+
+Delete this template.
+
+=cut
+
+sub Delete {
+ my $self = shift;
+
+ unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
+ return ( 0, $self->loc('Permission Denied') );
+ }
- @_);
- $self->SUPER::Create(
- Queue => $args{'Queue'},
- Name => $args{'Name'},
- Description => $args{'Description'},
- Type => $args{'Type'},
- Language => $args{'Language'},
- TranslationOf => $args{'TranslationOf'},
- Content => $args{'Content'},
-);
+ if ( !$self->IsOverride && $self->UsedBy->Count ) {
+ return ( 0, $self->loc('Template is in use') );
+ }
+ return ( $self->SUPER::Delete(@_) );
}
+=head2 UsedBy
+Returns L<RT::Scrips> limitted to scrips that use this template. Takes
+into account that template can be overriden in a queue.
-=item id
+=cut
-Returns the current value of id.
-(In the database, id is stored as int(11).)
+sub UsedBy {
+ my $self = shift;
+
+ my $scrips = RT::Scrips->new( $self->CurrentUser );
+ $scrips->LimitByTemplate( $self );
+ return $scrips;
+}
+=head2 IsEmpty
+
+Returns true value if content of the template is empty, otherwise
+returns false.
=cut
+sub IsEmpty {
+ my $self = shift;
+ my $content = $self->Content;
+ return 0 if defined $content && length $content;
+ return 1;
+}
-=item Queue
+=head2 IsOverride
-Returns the current value of Queue.
-(In the database, Queue is stored as int(11).)
+Returns true if it's queue specific template and there is global
+template with the same name.
+=cut
+sub IsOverride {
+ my $self = shift;
+ return 0 unless $self->Queue;
-=item SetQueue VALUE
+ my $template = RT::Template->new( $self->CurrentUser );
+ $template->LoadGlobalTemplate( $self->Name );
+ return $template->id;
+}
-Set Queue to VALUE.
-Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Queue will be stored as a int(11).)
+=head2 MIMEObj
+
+Returns L<MIME::Entity> object parsed using L</Parse> method. Returns
+undef if last call to L</Parse> failed or never be called.
+Note that content of the template is characters, but the contents of all
+L<MIME::Entity> objects (including the one returned by this function,
+are bytes in UTF-8.
=cut
+sub MIMEObj {
+ my $self = shift;
+ return ( $self->{'MIMEObj'} );
+}
-=item QueueObj
+=head2 Parse
-Returns the Queue Object which has the id returned by Queue
+This routine performs L<Text::Template> parsing on the template and then
+imports the results into a L<MIME::Entity> so we can really use it. Use
+L</MIMEObj> method to get the L<MIME::Entity> object.
+
+Takes a hash containing Argument, TicketObj, and TransactionObj and other
+arguments that will be available in the template's code. TicketObj and
+TransactionObj are not mandatory, but highly recommended.
+It returns a tuple of (val, message). If val is false, the message contains
+an error message.
=cut
-sub QueueObj {
- my $self = shift;
- my $Queue = RT::Queue->new($self->CurrentUser);
- $Queue->Load($self->__Value('Queue'));
- return($Queue);
+sub Parse {
+ my $self = shift;
+ my ($rv, $msg);
+
+
+ if (not $self->IsEmpty and $self->Content =~ m{^Content-Type:\s+text/html\b}im) {
+ local $RT::Transaction::PreferredContentType = 'text/html';
+ ($rv, $msg) = $self->_Parse(@_);
+ }
+ else {
+ ($rv, $msg) = $self->_Parse(@_);
+ }
+
+ return ($rv, $msg) unless $rv;
+
+ my $mime_type = $self->MIMEObj->mime_type;
+ if (defined $mime_type and $mime_type eq 'text/html') {
+ $self->_DowngradeFromHTML(@_);
+ }
+
+ return ($rv, $msg);
}
-=item Name
+sub _Parse {
+ my $self = shift;
-Returns the current value of Name.
-(In the database, Name is stored as varchar(200).)
+ # clear prev MIME object
+ $self->{'MIMEObj'} = undef;
+
+ #We're passing in whatever we were passed. it's destined for _ParseContent
+ my ($content, $msg) = $self->_ParseContent(@_);
+ return ( 0, $msg ) unless defined $content && length $content;
+
+ if ( $content =~ /^\S/s && $content !~ /^\S+:/ ) {
+ $RT::Logger->error(
+ "Template #". $self->id ." has leading line that doesn't"
+ ." look like header field, if you don't want to override"
+ ." any headers and don't want to see this error message"
+ ." then leave first line of the template empty"
+ );
+ $content = "\n".$content;
+ }
+
+ my $parser = MIME::Parser->new();
+ $parser->output_to_core(1);
+ $parser->tmp_to_core(1);
+ $parser->use_inner_files(1);
+
+ ### Should we forgive normally-fatal errors?
+ $parser->ignore_errors(1);
+ # Always provide bytes, not characters, to MIME objects
+ $content = Encode::encode( 'UTF-8', $content );
+ $self->{'MIMEObj'} = eval { $parser->parse_data( \$content ) };
+ if ( my $error = $@ || $parser->last_error ) {
+ $RT::Logger->error( "$error" );
+ return ( 0, $error );
+ }
+
+ # Unfold all headers
+ $self->{'MIMEObj'}->head->unfold;
+ $self->{'MIMEObj'}->head->modify(1);
+
+ return ( 1, $self->loc("Template parsed") );
+}
+# Perform Template substitutions on the template
-=item SetName VALUE
+sub _ParseContent {
+ my $self = shift;
+ my %args = (
+ Argument => undef,
+ TicketObj => undef,
+ TransactionObj => undef,
+ @_
+ );
+
+ unless ( $self->CurrentUserCanRead() ) {
+ return (undef, $self->loc("Permission Denied"));
+ }
+
+ if ( $self->IsEmpty ) {
+ return ( undef, $self->loc("Template is empty") );
+ }
+
+ my $content = $self->SUPER::_Value('Content');
+
+ $args{'Ticket'} = delete $args{'TicketObj'} if $args{'TicketObj'};
+ $args{'Transaction'} = delete $args{'TransactionObj'} if $args{'TransactionObj'};
+ $args{'Requestor'} = eval { $args{'Ticket'}->Requestors->UserMembersObj->First->Name }
+ if $args{'Ticket'};
+ $args{'rtname'} = RT->Config->Get('rtname');
+ if ( $args{'Ticket'} ) {
+ my $t = $args{'Ticket'}; # avoid memory leak
+ $args{'loc'} = sub { $t->loc(@_) };
+ } else {
+ $args{'loc'} = sub { $self->loc(@_) };
+ }
+
+ if ($self->Type eq 'Perl') {
+ return $self->_ParseContentPerl(
+ Content => $content,
+ TemplateArgs => \%args,
+ );
+ }
+ else {
+ return $self->_ParseContentSimple(
+ Content => $content,
+ TemplateArgs => \%args,
+ );
+ }
+}
+# uses Text::Template for Perl templates
+sub _ParseContentPerl {
+ my $self = shift;
+ my %args = (
+ Content => undef,
+ TemplateArgs => {},
+ @_,
+ );
+
+ foreach my $key ( keys %{ $args{TemplateArgs} } ) {
+ my $val = $args{TemplateArgs}{ $key };
+ next unless ref $val;
+ next if ref($val) =~ /^(ARRAY|HASH|SCALAR|CODE)$/;
+ $args{TemplateArgs}{ $key } = \$val;
+ }
+
+ my $template = Text::Template->new(
+ TYPE => 'STRING',
+ SOURCE => $args{Content},
+ );
+ my ($ok) = $template->compile;
+ unless ($ok) {
+ $RT::Logger->error("Template parsing error in @{[$self->Name]} (#@{[$self->id]}): $Text::Template::ERROR");
+ return ( undef, $self->loc('Template parsing error: [_1]', $Text::Template::ERROR) );
+ }
+
+ my $is_broken = 0;
+ my $retval = $template->fill_in(
+ HASH => $args{TemplateArgs},
+ BROKEN => sub {
+ my (%args) = @_;
+ $RT::Logger->error("Template parsing error: $args{error}")
+ unless $args{error} =~ /^Died at /; # ignore intentional die()
+ $is_broken++;
+ return undef;
+ },
+ );
+ return ( undef, $self->loc('Template parsing error') ) if $is_broken;
+
+ return ($retval);
+}
-Set Name to VALUE.
-Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Name will be stored as a varchar(200).)
+sub _ParseContentSimple {
+ my $self = shift;
+ my %args = (
+ Content => undef,
+ TemplateArgs => {},
+ @_,
+ );
+
+ $self->_MassageSimpleTemplateArgs(%args);
+
+ my $template = Text::Template->new(
+ TYPE => 'STRING',
+ SOURCE => $args{Content},
+ );
+ my ($ok) = $template->compile;
+ return ( undef, $self->loc('Template parsing error: [_1]', $Text::Template::ERROR) ) if !$ok;
+
+ # copied from Text::Template::fill_in and refactored to be simple variable
+ # interpolation
+ my $fi_r = '';
+ foreach my $fi_item (@{$template->{SOURCE}}) {
+ my ($fi_type, $fi_text, $fi_lineno) = @$fi_item;
+ if ($fi_type eq 'TEXT') {
+ $fi_r .= $fi_text;
+ } elsif ($fi_type eq 'PROG') {
+ my $fi_res;
+ my $original_fi_text = $fi_text;
+
+ # strip surrounding whitespace for simpler regexes
+ $fi_text =~ s/^\s+//;
+ $fi_text =~ s/\s+$//;
+
+ # if the codeblock is a simple $Variable lookup, use the value from
+ # the TemplateArgs hash...
+ if (my ($var) = $fi_text =~ /^\$(\w+)$/) {
+ if (exists $args{TemplateArgs}{$var}) {
+ $fi_res = $args{TemplateArgs}{$var};
+ }
+ }
+
+ # if there was no substitution then just reinsert the codeblock
+ if (!defined $fi_res) {
+ $fi_res = "{$original_fi_text}";
+ }
+
+ # If the value of the filled-in text really was undef,
+ # change it to an explicit empty string to avoid undefined
+ # value warnings later.
+ $fi_res = '' unless defined $fi_res;
+
+ $fi_r .= $fi_res;
+ }
+ }
+
+ return $fi_r;
+}
+
+sub _MassageSimpleTemplateArgs {
+ my $self = shift;
+ my %args = (
+ TemplateArgs => {},
+ @_,
+ );
+
+ my $template_args = $args{TemplateArgs};
+
+ if (my $ticket = $template_args->{Ticket}) {
+ for my $column (qw/Id Subject Type InitialPriority FinalPriority Priority TimeEstimated TimeWorked Status TimeLeft Told Starts Started Due Resolved RequestorAddresses AdminCcAddresses CcAddresses/) {
+ $template_args->{"Ticket".$column} = $ticket->$column;
+ }
+
+ $template_args->{"TicketQueueId"} = $ticket->Queue;
+ $template_args->{"TicketQueueName"} = $ticket->QueueObj->Name;
+
+ $template_args->{"TicketOwnerId"} = $ticket->Owner;
+ $template_args->{"TicketOwnerName"} = $ticket->OwnerObj->Name;
+ $template_args->{"TicketOwnerEmailAddress"} = $ticket->OwnerObj->EmailAddress;
+
+ my $cfs = $ticket->CustomFields;
+ while (my $cf = $cfs->Next) {
+ my $simple = $cf->Name;
+ $simple =~ s/\W//g;
+ $template_args->{"TicketCF" . $simple}
+ = $ticket->CustomFieldValuesAsString($cf->Name);
+ }
+ }
+
+ if (my $txn = $template_args->{Transaction}) {
+ for my $column (qw/Id TimeTaken Type Field OldValue NewValue Data Content Subject Description BriefDescription/) {
+ $template_args->{"Transaction".$column} = $txn->$column;
+ }
+
+ my $cfs = $txn->CustomFields;
+ while (my $cf = $cfs->Next) {
+ my $simple = $cf->Name;
+ $simple =~ s/\W//g;
+ $template_args->{"TransactionCF" . $simple}
+ = $txn->CustomFieldValuesAsString($cf->Name);
+ }
+ }
+}
+
+sub _DowngradeFromHTML {
+ my $self = shift;
+ my $orig_entity = $self->MIMEObj;
+
+ my $new_entity = $orig_entity->dup; # this will fail badly if we go away from InCore parsing
+ $new_entity->head->mime_attr( "Content-Type" => 'text/plain' );
+ $new_entity->head->mime_attr( "Content-Type.charset" => 'utf-8' );
+
+ $orig_entity->head->mime_attr( "Content-Type" => 'text/html' );
+ $orig_entity->head->mime_attr( "Content-Type.charset" => 'utf-8' );
+
+ my $body = $new_entity->bodyhandle->as_string;
+ $body = Encode::decode( "UTF-8", $body );
+ my $html = RT::Interface::Email::ConvertHTMLToText( $body );
+ $html = Encode::encode( "UTF-8", $html );
+ return unless defined $html;
+
+ $new_entity->bodyhandle(MIME::Body::InCore->new( \$html ));
+
+ $orig_entity->make_multipart('alternative', Force => 1);
+ $orig_entity->add_part($new_entity, 0); # plain comes before html
+ $self->{MIMEObj} = $orig_entity;
+
+ return;
+}
+
+=head2 CurrentUserHasQueueRight
+Helper function to call the template's queue's CurrentUserHasQueueRight with the passed in args.
=cut
+sub CurrentUserHasQueueRight {
+ my $self = shift;
+ return ( $self->QueueObj->CurrentUserHasRight(@_) );
+}
-=item Description
+=head2 SetQueue
-Returns the current value of Description.
-(In the database, Description is stored as varchar(255).)
+Changing queue is not implemented.
+
+=cut
+
+sub SetQueue {
+ my $self = shift;
+ return ( undef, $self->loc('Changing queue is not implemented') );
+}
+
+=head2 SetName
+
+Change name of the template.
+
+=cut
+
+sub SetName {
+ my $self = shift;
+ my $value = shift;
+
+ return ( undef, $self->loc('Name is required') )
+ unless $value;
+
+ return $self->_Set( Field => 'Name', Value => $value )
+ if lc($self->Name) eq lc($value);
+
+ my $tmp = $self->new( RT->SystemUser );
+ $tmp->LoadByCols( Name => $value, Queue => $self->Queue );
+ return ( undef, $self->loc('A Template with that name already exists') )
+ if $tmp->id;
+
+ return $self->_Set( Field => 'Name', Value => $value );
+}
+
+=head2 SetType
+
+If setting Type to Perl, require the ExecuteCode right.
+
+=cut
+
+sub SetType {
+ my $self = shift;
+ my $NewType = shift;
+
+ if ($NewType eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
+ return ( undef, $self->loc('Permission Denied') );
+ }
+
+ return $self->_Set( Field => 'Type', Value => $NewType );
+}
+
+=head2 SetContent
+
+If changing content and the type is Perl, require the ExecuteCode right.
+
+=cut
+
+sub SetContent {
+ my $self = shift;
+ my $NewContent = shift;
+
+ if ($self->Type eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
+ return ( undef, $self->loc('Permission Denied') );
+ }
+
+ return $self->_Set( Field => 'Content', Value => $NewContent );
+}
+
+sub _UpdateAttributes {
+ my $self = shift;
+ my %args = (
+ NewValues => {},
+ @_,
+ );
+
+ my $type = $args{NewValues}{Type} || $self->Type;
+
+ # forbid updating content when the (possibly new) value of Type is Perl
+ if ($type eq 'Perl' && exists $args{NewValues}{Content}) {
+ if (!$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
+ return $self->loc('Permission Denied');
+ }
+ }
+
+ return $self->SUPER::_UpdateAttributes(%args);
+}
+
+=head2 CompileCheck
+
+If the template's Type is Perl, then compile check all the codeblocks to see if
+they are syntactically valid. We eval them in a codeblock to avoid actually
+executing the code.
+
+Returns an (ok, message) pair.
+
+=cut
+
+sub CompileCheck {
+ my $self = shift;
+
+ return (1, $self->loc("Template does not include Perl code"))
+ unless $self->Type eq 'Perl';
+
+ my $content = $self->Content;
+ $content = '' if !defined($content);
+
+ my $template = Text::Template->new(
+ TYPE => 'STRING',
+ SOURCE => $content,
+ );
+ my ($ok) = $template->compile;
+ return ( undef, $self->loc('Template parsing error: [_1]', $Text::Template::ERROR) ) if !$ok;
+
+ # copied from Text::Template::fill_in and refactored to be compile checks
+ foreach my $fi_item (@{$template->{SOURCE}}) {
+ my ($fi_type, $fi_text, $fi_lineno) = @$fi_item;
+ next unless $fi_type eq 'PROG';
+
+ do {
+ no strict 'vars';
+ eval "sub { $fi_text }";
+ };
+ next if !$@;
+
+ my $error = $@;
+
+ # provide a (hopefully) useful line number for the error, but clean up
+ # all the other extraneous garbage
+ $error =~ s/\(eval \d+\) line (\d+).*/"template line " . ($1+$fi_lineno-1)/es;
+
+ return (0, $self->loc("Couldn't compile template codeblock '[_1]': [_2]", $fi_text, $error));
+ }
+
+ return (1, $self->loc("Template compiles"));
+}
+
+=head2 CurrentUserCanRead
+=cut
+
+sub CurrentUserCanRead {
+ my $self =shift;
+
+ if ($self->__Value('Queue')) {
+ my $queue = RT::Queue->new( RT->SystemUser );
+ $queue->Load( $self->__Value('Queue'));
+ return 1 if $self->CurrentUser->HasRight( Right => 'ShowTemplate', Object => $queue );
+ } else {
+ return 1 if $self->CurrentUser->HasRight( Right => 'ShowGlobalTemplates', Object => $RT::System );
+ return 1 if $self->CurrentUser->HasRight( Right => 'ShowTemplate', Object => $RT::System );
+ }
+
+ return;
+}
+
+1;
+
+sub Table {'Templates'}
+
+
+
+
+
+
+=head2 id
+
+Returns the current value of id.
+(In the database, id is stored as int(11).)
+
+
+=cut
+
+
+=head2 Queue
+
+Returns the current value of Queue.
+(In the database, Queue is stored as int(11).)
-=item SetDescription VALUE
+=head2 SetQueue VALUE
-Set Description to VALUE.
+
+Set Queue to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Description will be stored as a varchar(255).)
+(In the database, Queue will be stored as a int(11).)
=cut
-=item Type
+=head2 QueueObj
-Returns the current value of Type.
-(In the database, Type is stored as varchar(16).)
+Returns the Queue Object which has the id returned by Queue
+
+
+=cut
+
+sub QueueObj {
+ my $self = shift;
+ my $Queue = RT::Queue->new($self->CurrentUser);
+ $Queue->Load($self->__Value('Queue'));
+ return($Queue);
+}
+
+=head2 Name
+
+Returns the current value of Name.
+(In the database, Name is stored as varchar(200).)
-=item SetType VALUE
+=head2 SetName VALUE
-Set Type to VALUE.
+Set Name to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Type will be stored as a varchar(16).)
+(In the database, Name will be stored as a varchar(200).)
=cut
-=item Language
+=head2 Description
-Returns the current value of Language.
-(In the database, Language is stored as varchar(16).)
+Returns the current value of Description.
+(In the database, Description is stored as varchar(255).)
-=item SetLanguage VALUE
+=head2 SetDescription VALUE
-Set Language to VALUE.
+Set Description to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Language will be stored as a varchar(16).)
+(In the database, Description will be stored as a varchar(255).)
=cut
-=item TranslationOf
+=head2 Type
-Returns the current value of TranslationOf.
-(In the database, TranslationOf is stored as int(11).)
+Returns the current value of Type.
+(In the database, Type is stored as varchar(16).)
-=item SetTranslationOf VALUE
+=head2 SetType VALUE
-Set TranslationOf to VALUE.
+Set Type to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, TranslationOf will be stored as a int(11).)
+(In the database, Type will be stored as a varchar(16).)
=cut
-=item Content
+=head2 Content
-Returns the current value of Content.
-(In the database, Content is stored as blob.)
+Returns the current value of Content.
+(In the database, Content is stored as text.)
-=item SetContent VALUE
+=head2 SetContent VALUE
-Set Content to VALUE.
+Set Content to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Content will be stored as a blob.)
+(In the database, Content will be stored as a text.)
=cut
-=item LastUpdated
+=head2 LastUpdated
-Returns the current value of LastUpdated.
+Returns the current value of LastUpdated.
(In the database, LastUpdated is stored as datetime.)
=cut
-=item LastUpdatedBy
+=head2 LastUpdatedBy
-Returns the current value of LastUpdatedBy.
+Returns the current value of LastUpdatedBy.
(In the database, LastUpdatedBy is stored as int(11).)
=cut
-=item Creator
+=head2 Creator
-Returns the current value of Creator.
+Returns the current value of Creator.
(In the database, Creator is stored as int(11).)
=cut
-=item Created
+=head2 Created
-Returns the current value of Created.
+Returns the current value of Created.
(In the database, Created is stored as datetime.)
-sub _ClassAccessible {
+sub _CoreAccessible {
{
-
+
id =>
- {read => 1, type => 'int(11)', default => ''},
- Queue =>
- {read => 1, write => 1, type => 'int(11)', default => '0'},
- Name =>
- {read => 1, write => 1, type => 'varchar(200)', default => ''},
- Description =>
- {read => 1, write => 1, type => 'varchar(255)', default => ''},
- Type =>
- {read => 1, write => 1, type => 'varchar(16)', default => ''},
- Language =>
- {read => 1, write => 1, type => 'varchar(16)', default => ''},
- TranslationOf =>
- {read => 1, write => 1, type => 'int(11)', default => '0'},
- Content =>
- {read => 1, write => 1, type => 'blob', default => ''},
- LastUpdated =>
- {read => 1, auto => 1, type => 'datetime', default => ''},
- LastUpdatedBy =>
- {read => 1, auto => 1, type => 'int(11)', default => '0'},
- Creator =>
- {read => 1, auto => 1, type => 'int(11)', default => '0'},
- Created =>
- {read => 1, auto => 1, type => 'datetime', default => ''},
+ {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''},
+ Queue =>
+ {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
+ Name =>
+ {read => 1, write => 1, sql_type => 12, length => 200, is_blob => 0, is_numeric => 0, type => 'varchar(200)', default => ''},
+ Description =>
+ {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''},
+ Type =>
+ {read => 1, write => 1, sql_type => 12, length => 16, is_blob => 0, is_numeric => 0, type => 'varchar(16)', default => ''},
+ Content =>
+ {read => 1, write => 1, sql_type => -4, length => 0, is_blob => 1, is_numeric => 0, type => 'text', default => ''},
+ LastUpdated =>
+ {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
+ LastUpdatedBy =>
+ {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
+ Creator =>
+ {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
+ Created =>
+ {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
}
};
+sub FindDependencies {
+ my $self = shift;
+ my ($walker, $deps) = @_;
- eval "require RT::Template_Overlay";
- if ($@ && $@ !~ qr{^Can't locate RT/Template_Overlay.pm}) {
- die $@;
- };
-
- eval "require RT::Template_Vendor";
- if ($@ && $@ !~ qr{^Can't locate RT/Template_Vendor.pm}) {
- die $@;
- };
-
- eval "require RT::Template_Local";
- if ($@ && $@ !~ qr{^Can't locate RT/Template_Local.pm}) {
- die $@;
- };
-
-
-
-
-=head1 SEE ALSO
+ $self->SUPER::FindDependencies($walker, $deps);
-This class allows "overlay" methods to be placed
-into the following files _Overlay is for a System overlay by the original author,
-_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
+ $deps->Add( out => $self->QueueObj ) if $self->QueueObj->Id;
+}
-These overlay files can contain new subs or subs to replace existing subs in this module.
+sub __DependsOn {
+ my $self = shift;
+ my %args = (
+ Shredder => undef,
+ Dependencies => undef,
+ @_,
+ );
+ my $deps = $args{'Dependencies'};
+ my $list = [];
+
+# Scrips
+ push( @$list, $self->UsedBy );
+
+ $deps->_PushDependencies(
+ BaseObject => $self,
+ Flags => RT::Shredder::Constants::DEPENDS_ON,
+ TargetObjects => $list,
+ Shredder => $args{'Shredder'},
+ );
+
+ return $self->SUPER::__DependsOn( %args );
+}
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line
+sub PreInflate {
+ my $class = shift;
+ my ($importer, $uid, $data) = @_;
- no warnings qw(redefine);
+ $class->SUPER::PreInflate( $importer, $uid, $data );
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+ my $obj = RT::Template->new( RT->SystemUser );
+ if ($data->{Queue} == 0) {
+ $obj->LoadGlobalTemplate( $data->{Name} );
+ } else {
+ $obj->LoadQueueTemplate( Queue => $data->{Queue}, Name => $data->{Name} );
+ }
-RT::Template_Overlay, RT::Template_Vendor, RT::Template_Local
+ if ($obj->Id) {
+ $importer->Resolve( $uid => ref($obj) => $obj->Id );
+ return;
+ }
-=cut
+ return 1;
+}
+RT::Base->_ImportOverlays();
1;