1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2013 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 (not $self->IsEmpty and $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;
393 $self->{'MIMEObj'}->head->modify(1);
395 return ( 1, $self->loc("Template parsed") );
399 # Perform Template substitutions on the template
406 TransactionObj => undef,
410 unless ( $self->CurrentUserCanRead() ) {
411 return (undef, $self->loc("Permission Denied"));
414 if ( $self->IsEmpty ) {
415 return ( undef, $self->loc("Template is empty") );
418 my $content = $self->SUPER::_Value('Content');
419 # We need to untaint the content of the template, since we'll be working
421 $content =~ s/^(.*)$/$1/;
423 $args{'Ticket'} = delete $args{'TicketObj'} if $args{'TicketObj'};
424 $args{'Transaction'} = delete $args{'TransactionObj'} if $args{'TransactionObj'};
425 $args{'Requestor'} = eval { $args{'Ticket'}->Requestors->UserMembersObj->First->Name }
427 $args{'rtname'} = RT->Config->Get('rtname');
428 if ( $args{'Ticket'} ) {
429 my $t = $args{'Ticket'}; # avoid memory leak
430 $args{'loc'} = sub { $t->loc(@_) };
432 $args{'loc'} = sub { $self->loc(@_) };
435 if ($self->Type eq 'Perl') {
436 return $self->_ParseContentPerl(
438 TemplateArgs => \%args,
442 return $self->_ParseContentSimple(
444 TemplateArgs => \%args,
449 # uses Text::Template for Perl templates
450 sub _ParseContentPerl {
458 foreach my $key ( keys %{ $args{TemplateArgs} } ) {
459 my $val = $args{TemplateArgs}{ $key };
460 next unless ref $val;
461 next if ref($val) =~ /^(ARRAY|HASH|SCALAR|CODE)$/;
462 $args{TemplateArgs}{ $key } = \$val;
465 my $template = Text::Template->new(
467 SOURCE => $args{Content},
470 my $retval = $template->fill_in(
471 HASH => $args{TemplateArgs},
474 $RT::Logger->error("Template parsing error: $args{error}")
475 unless $args{error} =~ /^Died at /; # ignore intentional die()
480 return ( undef, $self->loc('Template parsing error') ) if $is_broken;
485 sub _ParseContentSimple {
493 $self->_MassageSimpleTemplateArgs(%args);
495 my $template = Text::Template->new(
497 SOURCE => $args{Content},
499 my ($ok) = $template->compile;
500 return ( undef, $self->loc('Template parsing error: [_1]', $Text::Template::ERROR) ) if !$ok;
502 # copied from Text::Template::fill_in and refactored to be simple variable
505 foreach my $fi_item (@{$template->{SOURCE}}) {
506 my ($fi_type, $fi_text, $fi_lineno) = @$fi_item;
507 if ($fi_type eq 'TEXT') {
509 } elsif ($fi_type eq 'PROG') {
511 my $original_fi_text = $fi_text;
513 # strip surrounding whitespace for simpler regexes
514 $fi_text =~ s/^\s+//;
515 $fi_text =~ s/\s+$//;
517 # if the codeblock is a simple $Variable lookup, use the value from
518 # the TemplateArgs hash...
519 if (my ($var) = $fi_text =~ /^\$(\w+)$/) {
520 if (exists $args{TemplateArgs}{$var}) {
521 $fi_res = $args{TemplateArgs}{$var};
525 # if there was no substitution then just reinsert the codeblock
526 if (!defined $fi_res) {
527 $fi_res = "{$original_fi_text}";
530 # If the value of the filled-in text really was undef,
531 # change it to an explicit empty string to avoid undefined
532 # value warnings later.
533 $fi_res = '' unless defined $fi_res;
542 sub _MassageSimpleTemplateArgs {
549 my $template_args = $args{TemplateArgs};
551 if (my $ticket = $template_args->{Ticket}) {
552 for my $column (qw/Id Subject Type InitialPriority FinalPriority Priority TimeEstimated TimeWorked Status TimeLeft Told Starts Started Due Resolved RequestorAddresses AdminCcAddresses CcAddresses/) {
553 $template_args->{"Ticket".$column} = $ticket->$column;
556 $template_args->{"TicketQueueId"} = $ticket->Queue;
557 $template_args->{"TicketQueueName"} = $ticket->QueueObj->Name;
559 $template_args->{"TicketOwnerId"} = $ticket->Owner;
560 $template_args->{"TicketOwnerName"} = $ticket->OwnerObj->Name;
561 $template_args->{"TicketOwnerEmailAddress"} = $ticket->OwnerObj->EmailAddress;
563 my $cfs = $ticket->CustomFields;
564 while (my $cf = $cfs->Next) {
565 $template_args->{"TicketCF" . $cf->Name} = $ticket->CustomFieldValuesAsString($cf->Name);
569 if (my $txn = $template_args->{Transaction}) {
570 for my $column (qw/Id TimeTaken Type Field OldValue NewValue Data Content Subject Description BriefDescription/) {
571 $template_args->{"Transaction".$column} = $txn->$column;
574 my $cfs = $txn->CustomFields;
575 while (my $cf = $cfs->Next) {
576 $template_args->{"TransactionCF" . $cf->Name} = $txn->CustomFieldValuesAsString($cf->Name);
581 sub _DowngradeFromHTML {
583 my $orig_entity = $self->MIMEObj;
585 my $new_entity = $orig_entity->dup; # this will fail badly if we go away from InCore parsing
586 $new_entity->head->mime_attr( "Content-Type" => 'text/plain' );
587 $new_entity->head->mime_attr( "Content-Type.charset" => 'utf-8' );
589 $orig_entity->head->mime_attr( "Content-Type" => 'text/html' );
590 $orig_entity->head->mime_attr( "Content-Type.charset" => 'utf-8' );
591 $orig_entity->make_multipart('alternative', Force => 1);
593 require HTML::FormatText;
594 require HTML::TreeBuilder;
596 # need to decode_utf8, see the doc of MIMEObj method
597 my $tree = HTML::TreeBuilder->new_from_content(
598 Encode::decode_utf8($new_entity->bodyhandle->as_string)
600 $new_entity->bodyhandle(MIME::Body::InCore->new(
601 \(scalar HTML::FormatText->new(
608 $orig_entity->add_part($new_entity, 0); # plain comes before html
609 $self->{MIMEObj} = $orig_entity;
614 =head2 CurrentUserHasQueueRight
616 Helper function to call the template's queue's CurrentUserHasQueueRight with the passed in args.
620 sub CurrentUserHasQueueRight {
622 return ( $self->QueueObj->CurrentUserHasRight(@_) );
627 If setting Type to Perl, require the ExecuteCode right.
635 if ($NewType eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
636 return ( undef, $self->loc('Permission Denied') );
639 return $self->_Set( Field => 'Type', Value => $NewType );
644 If changing content and the type is Perl, require the ExecuteCode right.
650 my $NewContent = shift;
652 if ($self->Type eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
653 return ( undef, $self->loc('Permission Denied') );
656 return $self->_Set( Field => 'Content', Value => $NewContent );
659 sub _UpdateAttributes {
666 my $type = $args{NewValues}{Type} || $self->Type;
668 # forbid updating content when the (possibly new) value of Type is Perl
669 if ($type eq 'Perl' && exists $args{NewValues}{Content}) {
670 if (!$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
671 return $self->loc('Permission Denied');
675 return $self->SUPER::_UpdateAttributes(%args);
680 If the template's Type is Perl, then compile check all the codeblocks to see if
681 they are syntactically valid. We eval them in a codeblock to avoid actually
684 Returns an (ok, message) pair.
691 return (1, $self->loc("Template does not include Perl code"))
692 unless $self->Type eq 'Perl';
694 my $content = $self->Content;
695 $content = '' if !defined($content);
697 my $template = Text::Template->new(
701 my ($ok) = $template->compile;
702 return ( undef, $self->loc('Template parsing error: [_1]', $Text::Template::ERROR) ) if !$ok;
704 # copied from Text::Template::fill_in and refactored to be compile checks
705 foreach my $fi_item (@{$template->{SOURCE}}) {
706 my ($fi_type, $fi_text, $fi_lineno) = @$fi_item;
707 next unless $fi_type eq 'PROG';
711 eval "sub { $fi_text }";
717 # provide a (hopefully) useful line number for the error, but clean up
718 # all the other extraneous garbage
719 $error =~ s/\(eval \d+\) line (\d+).*/"template line " . ($1+$fi_lineno-1)/es;
721 return (0, $self->loc("Couldn't compile template codeblock '[_1]': [_2]", $fi_text, $error));
724 return (1, $self->loc("Template compiles"));
727 =head2 CurrentUserCanRead
731 sub CurrentUserCanRead {
734 return 1 if $self->CurrentUserHasQueueRight('ShowTemplate');
736 return $self->CurrentUser->HasRight( Right =>'ShowGlobalTemplates', Object => $RT::System )
737 if !$self->QueueObj->Id;
745 use base 'RT::Record';
747 sub Table {'Templates'}
756 Returns the current value of id.
757 (In the database, id is stored as int(11).)
765 Returns the current value of Queue.
766 (In the database, Queue is stored as int(11).)
770 =head2 SetQueue VALUE
774 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
775 (In the database, Queue will be stored as a int(11).)
783 Returns the Queue Object which has the id returned by Queue
790 my $Queue = RT::Queue->new($self->CurrentUser);
791 $Queue->Load($self->__Value('Queue'));
797 Returns the current value of Name.
798 (In the database, Name is stored as varchar(200).)
806 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
807 (In the database, Name will be stored as a varchar(200).)
815 Returns the current value of Description.
816 (In the database, Description is stored as varchar(255).)
820 =head2 SetDescription VALUE
823 Set Description to VALUE.
824 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
825 (In the database, Description will be stored as a varchar(255).)
833 Returns the current value of Type.
834 (In the database, Type is stored as varchar(16).)
842 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
843 (In the database, Type will be stored as a varchar(16).)
851 Returns the current value of Language.
852 (In the database, Language is stored as varchar(16).)
856 =head2 SetLanguage VALUE
859 Set Language to VALUE.
860 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
861 (In the database, Language will be stored as a varchar(16).)
869 Returns the current value of TranslationOf.
870 (In the database, TranslationOf is stored as int(11).)
874 =head2 SetTranslationOf VALUE
877 Set TranslationOf to VALUE.
878 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
879 (In the database, TranslationOf will be stored as a int(11).)
887 Returns the current value of Content.
888 (In the database, Content is stored as text.)
892 =head2 SetContent VALUE
895 Set Content to VALUE.
896 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
897 (In the database, Content will be stored as a text.)
905 Returns the current value of LastUpdated.
906 (In the database, LastUpdated is stored as datetime.)
914 Returns the current value of LastUpdatedBy.
915 (In the database, LastUpdatedBy is stored as int(11).)
923 Returns the current value of Creator.
924 (In the database, Creator is stored as int(11).)
932 Returns the current value of Created.
933 (In the database, Created is stored as datetime.)
940 sub _CoreAccessible {
944 {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''},
946 {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
948 {read => 1, write => 1, sql_type => 12, length => 200, is_blob => 0, is_numeric => 0, type => 'varchar(200)', default => ''},
950 {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''},
952 {read => 1, write => 1, sql_type => 12, length => 16, is_blob => 0, is_numeric => 0, type => 'varchar(16)', default => ''},
954 {read => 1, write => 1, sql_type => 12, length => 16, is_blob => 0, is_numeric => 0, type => 'varchar(16)', default => ''},
956 {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
958 {read => 1, write => 1, sql_type => -4, length => 0, is_blob => 1, is_numeric => 0, type => 'text', default => ''},
960 {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
962 {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
964 {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
966 {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
971 RT::Base->_ImportOverlays();