-# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Template.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
-# Copyright 1996-2002 Jesse Vincent <jesse@bestpractical.com>
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2014 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.
+#
+# 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 }}}
+
# Portions Copyright 2000 Tobias Brox <tobix@cpan.org>
-# Released under the terms of the GNU General Public License
=head1 NAME
use RT::Template;
-
=head1 DESCRIPTION
=head1 METHODS
-=begin testing
-
-ok(require RT::TestHarness);
-ok(require RT::Template);
-
-=end testing
=cut
-package RT::Template;
-use RT::Record;
-use MIME::Entity;
-use MIME::Parser;
-@ISA = qw(RT::Record);
+package RT::Template;
-# {{{ sub _Init
+use strict;
+use warnings;
-sub _Init {
- my $self = shift;
- $self->{'table'} = "Templates";
- return ( $self->SUPER::_Init(@_) );
-}
-# }}}
-# {{{ sub _Accessible
+use Text::Template;
+use MIME::Entity;
+use MIME::Parser;
+use Scalar::Util 'blessed';
sub _Accessible {
my $self = shift;
id => 'read',
Name => 'read/write',
Description => 'read/write',
- Type => 'read/write', #Type is one of Action or Message
+ Type => 'read/write', #Type is one of Perl or Simple
Content => 'read/write',
Queue => 'read/write',
Creator => 'read/auto',
return $self->SUPER::_Accessible( @_, %Cols );
}
-# }}}
-
-# {{{ sub _Set
-
sub _Set {
my $self = shift;
-
- # use super::value or we get acl blocked
- if ( ( defined $self->SUPER::_Value('Queue') )
- && ( $self->SUPER::_Value('Queue') == 0 ) )
- {
- unless ( $self->CurrentUser->HasSystemRight('ModifyTemplate') ) {
- return ( 0, 'Permission Denied' );
- }
+ my %args = (
+ Field => undef,
+ Value => undef,
+ @_,
+ );
+
+ unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
+ return ( 0, $self->loc('Permission Denied') );
}
- else {
- unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
- return ( 0, '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(@_) );
+ return $self->SUPER::_Set( @_ );
}
-# }}}
-
-# {{{ sub _Value
-
=head2 _Value
-Takes the name of a table column.
-Returns its value as a string, if the user passes an ACL check
+Takes the name of a table column. Returns its value as a string,
+if the user passes an ACL check, otherwise returns undef.
=cut
sub _Value {
-
my $self = shift;
- my $field = shift;
- #If the current user doesn't have ACLs, don't let em at it.
- #use super::value or we get acl blocked
- if ( ( !defined $self->__Value('Queue') )
- || ( $self->__Value('Queue') == 0 ) )
- {
- unless ( $self->CurrentUser->HasSystemRight('ShowTemplate') ) {
- return (undef);
- }
+ unless ( $self->CurrentUserCanRead() ) {
+ return undef;
}
- else {
- unless ( $self->CurrentUserHasQueueRight('ShowTemplate') ) {
- return (undef);
- }
- }
- return ( $self->__Value($field) );
+ return $self->__Value( @_ );
}
-# }}}
-
-# {{{ sub Load
+=head2 Load <identifier>
-=head2 Load <identifer>
+Load a template, either by number or by name.
-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</LoadGlobalTemplate> and/or L<LoadQueueTemplate> to get
+precise result.
=cut
sub Load {
my $self = shift;
my $identifier = shift;
+ return undef unless $identifier;
- if ( !$identifier ) {
- return (undef);
- }
-
- if ( $identifier !~ /\D/ ) {
- $self->SUPER::LoadById($identifier);
- }
- else {
- $self->LoadByCol( 'Name', $identifier );
-
+ if ( $identifier =~ /\D/ ) {
+ return $self->LoadByCol( 'Name', $identifier );
}
+ return $self->LoadById( $identifier );
}
-# }}}
-
-# {{{ sub LoadGlobalTemplate
-
=head2 LoadGlobalTemplate NAME
-Load the global tempalte with the name NAME
+Load the global template with the name NAME
=cut
sub LoadGlobalTemplate {
my $self = shift;
- my $id = shift;
+ my $name = shift;
- return ( $self->LoadQueueTemplate( Queue => 0, Name => $id ) );
+ return ( $self->LoadQueueTemplate( Queue => 0, Name => $name ) );
}
-# }}}
+=head2 LoadQueueTemplate (Queue => QUEUEID, Name => NAME)
-# {{{ sub LoadQueueTemplate
+Loads the Queue template named NAME for Queue QUEUE.
-=head2 LoadQueueTemplate (Queue => QUEUEID, Name => NAME)
+Note that this method doesn't load a global template with the same name
+if template in the queue doesn't exist. THe following code can be used:
-Loads the Queue template named NAME for Queue QUEUE.
+ $template->LoadQueueTemplate( Queue => $queue_id, Name => $template_name );
+ unless ( $template->id ) {
+ $template->LoadGlobalTemplate( $template_name );
+ unless ( $template->id ) {
+ # no template
+ ...
+ }
+ }
+ # ok, template either queue's or global
+ ...
=cut
my $self = shift;
my %args = (
Queue => undef,
- Name => undef
+ Name => undef,
+ @_
);
- return ( $self->LoadByCols( Name => $args{'Name'}, Queue => {'Queue'} ) );
+ return ( $self->LoadByCols( Name => $args{'Name'}, Queue => $args{'Queue'} ) );
}
-# }}}
-
-# {{{ sub Create
-
=head2 Create
Takes a paramhash of Content, Queue, Name and Description.
Returns the Template's id # if the create was successful. Returns undef for
unknown database failure.
-
=cut
sub Create {
Content => undef,
Queue => 0,
Description => '[no description]',
- Type => 'Action', #By default, template are 'Action' templates
- Name => undef,
+ Type => 'Perl',
+ Name => undef,
@_
);
- if ( $args{'Queue'} == 0 ) {
- unless ( $self->CurrentUser->HasSystemRight('ModifyTemplate') ) {
- return (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 = new RT::Queue( $self->CurrentUser );
- $QueueObj->Load( $args{'Queue'} ) || return ( 0, 'Invalid queue' );
-
+ my $QueueObj = RT::Queue->new( $self->CurrentUser );
+ $QueueObj->Load( $args{'Queue'} ) || return ( undef, $self->loc('Invalid queue') );
+
unless ( $QueueObj->CurrentUserHasRight('ModifyTemplate') ) {
- return (undef);
+ return ( undef, $self->loc('Permission Denied') );
}
+ $args{'Queue'} = $QueueObj->Id;
}
- my $result = $self->SUPER::Create(
- Content => $args{'Content'},
- Queue => $args{'Queue'},
- ,
+ my ( $result, $msg ) = $self->SUPER::Create(
+ Content => $args{'Content'},
+ Queue => $args{'Queue'},
Description => $args{'Description'},
- Name => $args{'Name'}
+ Name => $args{'Name'},
+ Type => $args{'Type'},
);
- return ($result);
+ if ( wantarray ) {
+ return ( $result, $msg );
+ } else {
+ return ( $result );
+ }
}
-# }}}
-
-# {{{ sub Delete
-
=head2 Delete
Delete this template.
sub Delete {
my $self = shift;
- unless ( $self->CurrentUserHasRight('ModifyTemplate') ) {
- return ( 0, 'Permission Denied' );
+ unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
+ return ( 0, $self->loc('Permission Denied') );
}
return ( $self->SUPER::Delete(@_) );
}
-# }}}
+=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;
+}
+
+=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 UTF-8, but L<MIME::Parser> is not
+good at handling it and all data of the entity should be treated as
+octets and converted to perl strings using Encode::decode_utf8 or
+something else.
+
+=cut
-# {{{ sub MIMEObj
sub MIMEObj {
my $self = shift;
return ( $self->{'MIMEObj'} );
}
-# }}}
+=head2 Parse
-# {{{ sub Parse
+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.
-=item Parse
+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.
- This routine performs Text::Template parsing on thte template and then imports the
- results into a MIME::Entity so we can really use it
- It returns a tuple of (val, message)
- If val is 0, the message contains an error message
+It returns a tuple of (val, message). If val is false, the message contains
+an error message.
=cut
sub Parse {
my $self = shift;
+ my ($rv, $msg);
- #We're passing in whatever we were passed. it's destined for _ParseContent
- my $content = $self->_ParseContent(@_);
- #Lets build our mime Entity
+ 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);
+}
+
+sub _Parse {
+ my $self = shift;
+
+ # 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();
-
- # Do work on the parsed template in memory, rather than on disk
- $parser->output_to_core(1);
+ $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);
- $self->{'MIMEObj'} = eval { $parser->parse_data($content) };
- $error = ( $@ || $parser->last_error );
-
- if ($error) {
- $RT::Logger->error("$error");
+ # MIME::Parser doesn't play well with perl strings
+ utf8::encode($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->unfold;
+ $self->{'MIMEObj'}->head->modify(1);
- return ( 1, "Template parsed" );
-
+ return ( 1, $self->loc("Template parsed") );
}
-# }}}
-
-# {{{ sub _ParseContent
-
# Perform Template substitutions on the template
sub _ParseContent {
@_
);
- # Might be subject to change
- use Text::Template;
+ unless ( $self->CurrentUserCanRead() ) {
+ return (undef, $self->loc("Permission Denied"));
+ }
- $T::Ticket = $args{'TicketObj'};
- $T::Transaction = $args{'TransactionObj'};
- $T::Argument = $args{'Argument'};
- $T::rtname = $RT::rtname;
+ if ( $self->IsEmpty ) {
+ return ( undef, $self->loc("Template is empty") );
+ }
+ my $content = $self->SUPER::_Value('Content');
# We need to untaint the content of the template, since we'll be working
# with it
- my $content = $self->Content();
$content =~ s/^(.*)$/$1/;
- $template = Text::Template->new(
- TYPE => STRING,
- SOURCE => $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 => {},
+ @_,
);
- my $retval = $template->fill_in( PACKAGE => T );
+ 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 $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);
}
-# }}}
-
-# {{{ sub QueueObj
+sub _ParseContentSimple {
+ my $self = shift;
+ my %args = (
+ Content => undef,
+ TemplateArgs => {},
+ @_,
+ );
-=head2 QueueObj
+ $self->_MassageSimpleTemplateArgs(%args);
-Takes nothing. returns this ticket's queue object
+ 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;
+ }
+ }
-=cut
+ return $fi_r;
+}
-sub QueueObj {
+sub _MassageSimpleTemplateArgs {
my $self = shift;
- if ( !defined $self->{'queue'} ) {
- require RT::Queue;
- $self->{'queue'} = RT::Queue->new( $self->CurrentUser );
-
- unless ( $self->{'queue'} ) {
- $RT::Logger->crit(
- "RT::Queue->new(" . $self->CurrentUser . ") returned false" );
- return (undef);
+ 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) {
+ $template_args->{"TicketCF" . $cf->Name} = $ticket->CustomFieldValuesAsString($cf->Name);
}
- my ($result) = $self->{'queue'}->Load( $self->__Value('Queue') );
+ }
+ 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) {
+ $template_args->{"TransactionCF" . $cf->Name} = $txn->CustomFieldValuesAsString($cf->Name);
+ }
}
- return ( $self->{'queue'} );
}
-# }}}
-
-# {{{ sub CurrentUserHasQueueRight
+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' );
+ $orig_entity->make_multipart('alternative', Force => 1);
+
+ require HTML::FormatText;
+ require HTML::TreeBuilder;
+ require Encode;
+ # need to decode_utf8, see the doc of MIMEObj method
+ my $tree = HTML::TreeBuilder->new_from_content(
+ Encode::decode_utf8($new_entity->bodyhandle->as_string)
+ );
+ $new_entity->bodyhandle(MIME::Body::InCore->new(
+ \(scalar HTML::FormatText->new(
+ leftmargin => 0,
+ rightmargin => 78,
+ )->format( $tree ))
+ ));
+ $tree->delete;
+
+ $orig_entity->add_part($new_entity, 0); # plain comes before html
+ $self->{MIMEObj} = $orig_entity;
+
+ return;
+}
=head2 CurrentUserHasQueueRight
return ( $self->QueueObj->CurrentUserHasRight(@_) );
}
-# }}}
+=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;
+
+ return 1 if $self->CurrentUserHasQueueRight('ShowTemplate');
+
+ return $self->CurrentUser->HasRight( Right =>'ShowGlobalTemplates', Object => $RT::System )
+ if !$self->QueueObj->Id;
+
+ return;
+}
+
+1;
+
+use RT::Queue;
+use base 'RT::Record';
+
+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).)
+
+
+
+=head2 SetQueue VALUE
+
+
+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).)
+
+
+=cut
+
+
+=head2 QueueObj
+
+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).)
+
+
+
+=head2 SetName VALUE
+
+
+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).)
+
+
+=cut
+
+
+=head2 Description
+
+Returns the current value of Description.
+(In the database, Description is stored as varchar(255).)
+
+
+
+=head2 SetDescription VALUE
+
+
+Set Description 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).)
+
+
+=cut
+
+
+=head2 Type
+
+Returns the current value of Type.
+(In the database, Type is stored as varchar(16).)
+
+
+
+=head2 SetType VALUE
+
+
+Set Type 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).)
+
+
+=cut
+
+
+=head2 Language
+
+Returns the current value of Language.
+(In the database, Language is stored as varchar(16).)
+
+
+
+=head2 SetLanguage VALUE
+
+
+Set Language 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).)
+
+
+=cut
+
+
+=head2 TranslationOf
+
+Returns the current value of TranslationOf.
+(In the database, TranslationOf is stored as int(11).)
+
+
+
+=head2 SetTranslationOf VALUE
+
+
+Set TranslationOf 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).)
+
+
+=cut
+
+
+=head2 Content
+
+Returns the current value of Content.
+(In the database, Content is stored as text.)
+
+
+
+=head2 SetContent 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 text.)
+
+
+=cut
+
+
+=head2 LastUpdated
+
+Returns the current value of LastUpdated.
+(In the database, LastUpdated is stored as datetime.)
+
+
+=cut
+
+
+=head2 LastUpdatedBy
+
+Returns the current value of LastUpdatedBy.
+(In the database, LastUpdatedBy is stored as int(11).)
+
+
+=cut
+
+
+=head2 Creator
+
+Returns the current value of Creator.
+(In the database, Creator is stored as int(11).)
+
+
+=cut
+
+
+=head2 Created
+
+Returns the current value of Created.
+(In the database, Created is stored as datetime.)
+
+
+=cut
+
+
+
+sub _CoreAccessible {
+ {
+
+ id =>
+ {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 => ''},
+ Language =>
+ {read => 1, write => 1, sql_type => 12, length => 16, is_blob => 0, is_numeric => 0, type => 'varchar(16)', default => ''},
+ TranslationOf =>
+ {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
+ 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 => ''},
+
+ }
+};
+
+RT::Base->_ImportOverlays();
+
1;
projects / freeside.git / blobdiff