1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
30 # CONTRIBUTION SUBMISSION POLICY:
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
47 # END BPS TAGGED BLOCK }}}
49 # Portions Copyright 2000 Tobias Brox <tobix@cpan.org>
53 RT::Template - RT's template object
78 use Scalar::Util 'blessed';
85 Description => 'read/write',
86 Type => 'read/write', #Type is one of Perl or Simple
87 Content => 'read/write',
88 Queue => 'read/write',
89 Creator => 'read/auto',
90 Created => 'read/auto',
91 LastUpdatedBy => 'read/auto',
92 LastUpdated => 'read/auto'
94 return $self->SUPER::_Accessible( @_, %Cols );
105 unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
106 return ( 0, $self->loc('Permission Denied') );
109 if (exists $args{Value}) {
110 if ($args{Field} eq 'Queue') {
112 # moving to another queue
113 my $queue = RT::Queue->new( $self->CurrentUser );
114 $queue->Load($args{Value});
115 unless ($queue->Id and $queue->CurrentUserHasRight('ModifyTemplate')) {
116 return ( 0, $self->loc('Permission Denied') );
120 unless ($self->CurrentUser->HasRight( Object => RT->System, Right => 'ModifyTemplate' )) {
121 return ( 0, $self->loc('Permission Denied') );
127 return $self->SUPER::_Set( @_ );
132 Takes the name of a table column. Returns its value as a string,
133 if the user passes an ACL check, otherwise returns undef.
140 unless ( $self->CurrentUserCanRead() ) {
143 return $self->__Value( @_ );
147 =head2 Load <identifier>
149 Load a template, either by number or by name.
151 Note that loading templates by name using this method B<is
152 ambiguous>. Several queues may have template with the same name
153 and as well global template with the same name may exist.
154 Use L</LoadGlobalTemplate> and/or L<LoadQueueTemplate> to get
161 my $identifier = shift;
162 return undef unless $identifier;
164 if ( $identifier =~ /\D/ ) {
165 return $self->LoadByCol( 'Name', $identifier );
167 return $self->LoadById( $identifier );
170 =head2 LoadGlobalTemplate NAME
172 Load the global template with the name NAME
176 sub LoadGlobalTemplate {
180 return ( $self->LoadQueueTemplate( Queue => 0, Name => $name ) );
183 =head2 LoadQueueTemplate (Queue => QUEUEID, Name => NAME)
185 Loads the Queue template named NAME for Queue QUEUE.
187 Note that this method doesn't load a global template with the same name
188 if template in the queue doesn't exist. THe following code can be used:
190 $template->LoadQueueTemplate( Queue => $queue_id, Name => $template_name );
191 unless ( $template->id ) {
192 $template->LoadGlobalTemplate( $template_name );
193 unless ( $template->id ) {
198 # ok, template either queue's or global
203 sub LoadQueueTemplate {
211 return ( $self->LoadByCols( Name => $args{'Name'}, Queue => $args{'Queue'} ) );
217 Takes a paramhash of Content, Queue, Name and Description.
218 Name should be a unique string identifying this Template.
219 Description and Content should be the template's title and content.
220 Queue should be 0 for a global template and the queue # for a queue-specific
223 Returns the Template's id # if the create was successful. Returns undef for
224 unknown database failure.
233 Description => '[no description]',
239 if ( $args{Type} eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System) ) {
240 return ( undef, $self->loc('Permission Denied') );
243 unless ( $args{'Queue'} ) {
244 unless ( $self->CurrentUser->HasRight(Right =>'ModifyTemplate', Object => $RT::System) ) {
245 return ( undef, $self->loc('Permission Denied') );
250 my $QueueObj = RT::Queue->new( $self->CurrentUser );
251 $QueueObj->Load( $args{'Queue'} ) || return ( undef, $self->loc('Invalid queue') );
253 unless ( $QueueObj->CurrentUserHasRight('ModifyTemplate') ) {
254 return ( undef, $self->loc('Permission Denied') );
256 $args{'Queue'} = $QueueObj->Id;
259 my $result = $self->SUPER::Create(
260 Content => $args{'Content'},
261 Queue => $args{'Queue'},
262 Description => $args{'Description'},
263 Name => $args{'Name'},
264 Type => $args{'Type'},
273 Delete this template.
280 unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
281 return ( 0, $self->loc('Permission Denied') );
284 return ( $self->SUPER::Delete(@_) );
289 Returns true value if content of the template is empty, otherwise
296 my $content = $self->Content;
297 return 0 if defined $content && length $content;
303 Returns L<MIME::Entity> object parsed using L</Parse> method. Returns
304 undef if last call to L</Parse> failed or never be called.
306 Note that content of the template is UTF-8, but L<MIME::Parser> is not
307 good at handling it and all data of the entity should be treated as
308 octets and converted to perl strings using Encode::decode_utf8 or
315 return ( $self->{'MIMEObj'} );
320 This routine performs L<Text::Template> parsing on the template and then
321 imports the results into a L<MIME::Entity> so we can really use it. Use
322 L</MIMEObj> method to get the L<MIME::Entity> object.
324 Takes a hash containing Argument, TicketObj, and TransactionObj and other
325 arguments that will be available in the template's code. TicketObj and
326 TransactionObj are not mandatory, but highly recommended.
328 It returns a tuple of (val, message). If val is false, the message contains
338 if ($self->Content =~ m{^Content-Type:\s+text/html\b}im) {
339 local $RT::Transaction::PreferredContentType = 'text/html';
340 ($rv, $msg) = $self->_Parse(@_);
343 ($rv, $msg) = $self->_Parse(@_);
346 return ($rv, $msg) unless $rv;
348 my $mime_type = $self->MIMEObj->mime_type;
349 if (defined $mime_type and $mime_type eq 'text/html') {
350 $self->_DowngradeFromHTML(@_);
359 # clear prev MIME object
360 $self->{'MIMEObj'} = undef;
362 #We're passing in whatever we were passed. it's destined for _ParseContent
363 my ($content, $msg) = $self->_ParseContent(@_);
364 return ( 0, $msg ) unless defined $content && length $content;
366 if ( $content =~ /^\S/s && $content !~ /^\S+:/ ) {
368 "Template #". $self->id ." has leading line that doesn't"
369 ." look like header field, if you don't want to override"
370 ." any headers and don't want to see this error message"
371 ." then leave first line of the template empty"
373 $content = "\n".$content;
376 my $parser = MIME::Parser->new();
377 $parser->output_to_core(1);
378 $parser->tmp_to_core(1);
379 $parser->use_inner_files(1);
381 ### Should we forgive normally-fatal errors?
382 $parser->ignore_errors(1);
383 # MIME::Parser doesn't play well with perl strings
384 utf8::encode($content);
385 $self->{'MIMEObj'} = eval { $parser->parse_data( \$content ) };
386 if ( my $error = $@ || $parser->last_error ) {
387 $RT::Logger->error( "$error" );
388 return ( 0, $error );
392 $self->{'MIMEObj'}->head->unfold;
394 return ( 1, $self->loc("Template parsed") );
398 # Perform Template substitutions on the template
405 TransactionObj => undef,
409 unless ( $self->CurrentUserCanRead() ) {
410 return (undef, $self->loc("Permission Denied"));
413 if ( $self->IsEmpty ) {
414 return ( undef, $self->loc("Template is empty") );
417 my $content = $self->SUPER::_Value('Content');
418 # We need to untaint the content of the template, since we'll be working
420 $content =~ s/^(.*)$/$1/;
422 $args{'Ticket'} = delete $args{'TicketObj'} if $args{'TicketObj'};
423 $args{'Transaction'} = delete $args{'TransactionObj'} if $args{'TransactionObj'};
424 $args{'Requestor'} = eval { $args{'Ticket'}->Requestors->UserMembersObj->First->Name }
426 $args{'rtname'} = RT->Config->Get('rtname');
427 if ( $args{'Ticket'} ) {
428 my $t = $args{'Ticket'}; # avoid memory leak
429 $args{'loc'} = sub { $t->loc(@_) };
431 $args{'loc'} = sub { $self->loc(@_) };
434 if ($self->Type eq 'Perl') {
435 return $self->_ParseContentPerl(
437 TemplateArgs => \%args,
441 return $self->_ParseContentSimple(
443 TemplateArgs => \%args,
448 # uses Text::Template for Perl templates
449 sub _ParseContentPerl {
457 foreach my $key ( keys %{ $args{TemplateArgs} } ) {
458 my $val = $args{TemplateArgs}{ $key };
459 next unless ref $val;
460 next if ref $val =~ /^(ARRAY|HASH|SCALAR|CODE)$/;
461 $args{TemplateArgs}{ $key } = \$val;
464 my $template = Text::Template->new(
466 SOURCE => $args{Content},
469 my $retval = $template->fill_in(
470 HASH => $args{TemplateArgs},
473 $RT::Logger->error("Template parsing error: $args{error}")
474 unless $args{error} =~ /^Died at /; # ignore intentional die()
479 return ( undef, $self->loc('Template parsing error') ) if $is_broken;
484 sub _ParseContentSimple {
492 $self->_MassageSimpleTemplateArgs(%args);
494 my $template = Text::Template->new(
496 SOURCE => $args{Content},
498 my ($ok) = $template->compile;
499 return ( undef, $self->loc('Template parsing error: [_1]', $Text::Template::ERROR) ) if !$ok;
501 # copied from Text::Template::fill_in and refactored to be simple variable
504 foreach my $fi_item (@{$template->{SOURCE}}) {
505 my ($fi_type, $fi_text, $fi_lineno) = @$fi_item;
506 if ($fi_type eq 'TEXT') {
508 } elsif ($fi_type eq 'PROG') {
510 my $original_fi_text = $fi_text;
512 # strip surrounding whitespace for simpler regexes
513 $fi_text =~ s/^\s+//;
514 $fi_text =~ s/\s+$//;
516 # if the codeblock is a simple $Variable lookup, use the value from
517 # the TemplateArgs hash...
518 if (my ($var) = $fi_text =~ /^\$(\w+)$/) {
519 if (exists $args{TemplateArgs}{$var}) {
520 $fi_res = $args{TemplateArgs}{$var};
524 # if there was no substitution then just reinsert the codeblock
525 if (!defined $fi_res) {
526 $fi_res = "{$original_fi_text}";
529 # If the value of the filled-in text really was undef,
530 # change it to an explicit empty string to avoid undefined
531 # value warnings later.
532 $fi_res = '' unless defined $fi_res;
541 sub _MassageSimpleTemplateArgs {
548 my $template_args = $args{TemplateArgs};
550 if (my $ticket = $template_args->{Ticket}) {
551 for my $column (qw/Id Subject Type InitialPriority FinalPriority Priority TimeEstimated TimeWorked Status TimeLeft Told Starts Started Due Resolved RequestorAddresses AdminCcAddresses CcAddresses/) {
552 $template_args->{"Ticket".$column} = $ticket->$column;
555 $template_args->{"TicketQueueId"} = $ticket->Queue;
556 $template_args->{"TicketQueueName"} = $ticket->QueueObj->Name;
558 $template_args->{"TicketOwnerId"} = $ticket->Owner;
559 $template_args->{"TicketOwnerName"} = $ticket->OwnerObj->Name;
560 $template_args->{"TicketOwnerEmailAddress"} = $ticket->OwnerObj->EmailAddress;
562 my $cfs = $ticket->CustomFields;
563 while (my $cf = $cfs->Next) {
564 $template_args->{"TicketCF" . $cf->Name} = $ticket->CustomFieldValuesAsString($cf->Name);
568 if (my $txn = $template_args->{Transaction}) {
569 for my $column (qw/Id TimeTaken Type Field OldValue NewValue Data Content Subject Description BriefDescription/) {
570 $template_args->{"Transaction".$column} = $txn->$column;
573 my $cfs = $txn->CustomFields;
574 while (my $cf = $cfs->Next) {
575 $template_args->{"TransactionCF" . $cf->Name} = $txn->CustomFieldValuesAsString($cf->Name);
580 sub _DowngradeFromHTML {
582 my $orig_entity = $self->MIMEObj;
584 my $new_entity = $orig_entity->dup; # this will fail badly if we go away from InCore parsing
585 $new_entity->head->mime_attr( "Content-Type" => 'text/plain' );
586 $new_entity->head->mime_attr( "Content-Type.charset" => 'utf-8' );
588 $orig_entity->head->mime_attr( "Content-Type" => 'text/html' );
589 $orig_entity->head->mime_attr( "Content-Type.charset" => 'utf-8' );
590 $orig_entity->make_multipart('alternative', Force => 1);
592 require HTML::FormatText;
593 require HTML::TreeBuilder;
595 # need to decode_utf8, see the doc of MIMEObj method
596 my $tree = HTML::TreeBuilder->new_from_content(
597 Encode::decode_utf8($new_entity->bodyhandle->as_string)
599 $new_entity->bodyhandle(MIME::Body::InCore->new(
600 \(scalar HTML::FormatText->new(
607 $orig_entity->add_part($new_entity, 0); # plain comes before html
608 $self->{MIMEObj} = $orig_entity;
613 =head2 CurrentUserHasQueueRight
615 Helper function to call the template's queue's CurrentUserHasQueueRight with the passed in args.
619 sub CurrentUserHasQueueRight {
621 return ( $self->QueueObj->CurrentUserHasRight(@_) );
626 If setting Type to Perl, require the ExecuteCode right.
634 if ($NewType eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
635 return ( undef, $self->loc('Permission Denied') );
638 return $self->_Set( Field => 'Type', Value => $NewType );
643 If changing content and the type is Perl, require the ExecuteCode right.
649 my $NewContent = shift;
651 if ($self->Type eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
652 return ( undef, $self->loc('Permission Denied') );
655 return $self->_Set( Field => 'Content', Value => $NewContent );
658 sub _UpdateAttributes {
665 my $type = $args{NewValues}{Type} || $self->Type;
667 # forbid updating content when the (possibly new) value of Type is Perl
668 if ($type eq 'Perl' && exists $args{NewValues}{Content}) {
669 if (!$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
670 return $self->loc('Permission Denied');
674 return $self->SUPER::_UpdateAttributes(%args);
679 If the template's Type is Perl, then compile check all the codeblocks to see if
680 they are syntactically valid. We eval them in a codeblock to avoid actually
683 Returns an (ok, message) pair.
690 return (1, $self->loc("Template does not include Perl code"))
691 unless $self->Type eq 'Perl';
693 my $content = $self->Content;
694 $content = '' if !defined($content);
696 my $template = Text::Template->new(
700 my ($ok) = $template->compile;
701 return ( undef, $self->loc('Template parsing error: [_1]', $Text::Template::ERROR) ) if !$ok;
703 # copied from Text::Template::fill_in and refactored to be compile checks
704 foreach my $fi_item (@{$template->{SOURCE}}) {
705 my ($fi_type, $fi_text, $fi_lineno) = @$fi_item;
706 next unless $fi_type eq 'PROG';
710 eval "sub { $fi_text }";
716 # provide a (hopefully) useful line number for the error, but clean up
717 # all the other extraneous garbage
718 $error =~ s/\(eval \d+\) line (\d+).*/"template line " . ($1+$fi_lineno-1)/es;
720 return (0, $self->loc("Couldn't compile template codeblock '[_1]': [_2]", $fi_text, $error));
723 return (1, $self->loc("Template compiles"));
726 =head2 CurrentUserCanRead
730 sub CurrentUserCanRead {
733 return 1 if $self->CurrentUserHasQueueRight('ShowTemplate');
735 return $self->CurrentUser->HasRight( Right =>'ShowGlobalTemplates', Object => $RT::System )
736 if !$self->QueueObj->Id;
744 use base 'RT::Record';
746 sub Table {'Templates'}
755 Returns the current value of id.
756 (In the database, id is stored as int(11).)
764 Returns the current value of Queue.
765 (In the database, Queue is stored as int(11).)
769 =head2 SetQueue VALUE
773 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
774 (In the database, Queue will be stored as a int(11).)
782 Returns the Queue Object which has the id returned by Queue
789 my $Queue = RT::Queue->new($self->CurrentUser);
790 $Queue->Load($self->__Value('Queue'));
796 Returns the current value of Name.
797 (In the database, Name is stored as varchar(200).)
805 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
806 (In the database, Name will be stored as a varchar(200).)
814 Returns the current value of Description.
815 (In the database, Description is stored as varchar(255).)
819 =head2 SetDescription VALUE
822 Set Description to VALUE.
823 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
824 (In the database, Description will be stored as a varchar(255).)
832 Returns the current value of Type.
833 (In the database, Type is stored as varchar(16).)
841 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
842 (In the database, Type will be stored as a varchar(16).)
850 Returns the current value of Language.
851 (In the database, Language is stored as varchar(16).)
855 =head2 SetLanguage VALUE
858 Set Language to VALUE.
859 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
860 (In the database, Language will be stored as a varchar(16).)
868 Returns the current value of TranslationOf.
869 (In the database, TranslationOf is stored as int(11).)
873 =head2 SetTranslationOf VALUE
876 Set TranslationOf to VALUE.
877 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
878 (In the database, TranslationOf will be stored as a int(11).)
886 Returns the current value of Content.
887 (In the database, Content is stored as text.)
891 =head2 SetContent VALUE
894 Set Content to VALUE.
895 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
896 (In the database, Content will be stored as a text.)
904 Returns the current value of LastUpdated.
905 (In the database, LastUpdated is stored as datetime.)
913 Returns the current value of LastUpdatedBy.
914 (In the database, LastUpdatedBy is stored as int(11).)
922 Returns the current value of Creator.
923 (In the database, Creator is stored as int(11).)
931 Returns the current value of Created.
932 (In the database, Created is stored as datetime.)
939 sub _CoreAccessible {
943 {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''},
945 {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
947 {read => 1, write => 1, sql_type => 12, length => 200, is_blob => 0, is_numeric => 0, type => 'varchar(200)', default => ''},
949 {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''},
951 {read => 1, write => 1, sql_type => 12, length => 16, is_blob => 0, is_numeric => 0, type => 'varchar(16)', default => ''},
953 {read => 1, write => 1, sql_type => 12, length => 16, is_blob => 0, is_numeric => 0, type => 'varchar(16)', default => ''},
955 {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
957 {read => 1, write => 1, sql_type => -4, length => 0, is_blob => 1, is_numeric => 0, type => 'text', default => ''},
959 {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
961 {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
963 {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
965 {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
970 RT::Base->_ImportOverlays();