1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
|
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2023 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>
=head1 NAME
RT::Template - RT's template object
=head1 SYNOPSIS
use RT::Template;
=head1 DESCRIPTION
=head1 METHODS
=cut
package RT::Template;
use strict;
use warnings;
use base 'RT::Record';
use RT::Queue;
use Text::Template;
use MIME::Entity;
use MIME::Parser;
use Scalar::Util 'blessed';
use RT::Interface::Web;
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
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;
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.
=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 ) );
}
=head2 LoadQueueTemplate (Queue => QUEUEID, Name => NAME)
Loads the Queue template named NAME for Queue QUEUE.
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 = (
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') );
}
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.
=cut
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;
}
=head2 IsOverride
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;
my $template = RT::Template->new( $self->CurrentUser );
$template->LoadGlobalTemplate( $self->Name );
return $template->id;
}
=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'} );
}
=head2 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.
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 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);
}
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();
$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
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(@_) };
}
$args{'EscapeURI'} = sub {
my $str = shift;
RT::Interface::Web::EscapeURI( \$str );
return $str;
};
$args{'EscapeHTML'} = sub {
my $str = shift;
RT::Interface::Web::EscapeHTML( \$str );
return $str;
};
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);
}
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(@_) );
}
=head2 SetQueue
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).)
=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 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 => ''},
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) = @_;
$self->SUPER::FindDependencies($walker, $deps);
$deps->Add( out => $self->QueueObj ) if $self->QueueObj->Id;
}
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 );
}
sub PreInflate {
my $class = shift;
my ($importer, $uid, $data) = @_;
$class->SUPER::PreInflate( $importer, $uid, $data );
my $obj = RT::Template->new( RT->SystemUser );
if ($data->{Queue} == 0) {
$obj->LoadGlobalTemplate( $data->{Name} );
} else {
$obj->LoadQueueTemplate( Queue => $data->{Queue}, Name => $data->{Name} );
}
if ($obj->Id) {
$importer->Resolve( $uid => ref($obj) => $obj->Id );
return;
}
return 1;
}
RT::Base->_ImportOverlays();
1;
|