Template_Overlay.pm 18.8 KB
Newer Older
1
# BEGIN BPS TAGGED BLOCK {{{
2
# 
3
# COPYRIGHT:
Jesse Vincent's avatar
Jesse Vincent committed
4
# 
Thomas Sibley's avatar
Thomas Sibley committed
5
# This software is Copyright (c) 1996-2010 Best Practical Solutions, LLC
6
#                                          <jesse@bestpractical.com>
7
# 
8
9
10
11
# (Except where explicitly superseded by other copyright notices)
# 
# 
# LICENSE:
12
13
14
15
# 
# 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
16
# from www.gnu.org.
17
18
19
20
21
22
# 
# 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.
# 
23
24
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
Jesse Vincent's avatar
Jesse Vincent committed
25
26
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
Ruslan Zakirov's avatar
Ruslan Zakirov committed
27
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
28
29
30
31
32
33
34
35
36
# 
# 
# 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.)
37
# 
38
39
40
41
42
43
44
45
# 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.
46
# 
47
# END BPS TAGGED BLOCK }}}
48

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# 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

67
68
69

package RT::Template;

70
use strict;
Ruslan Zakirov's avatar
Ruslan Zakirov committed
71
use warnings;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
72
73
no warnings qw(redefine);

74
use Text::Template;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
75
76
use MIME::Entity;
use MIME::Parser;
77
use Scalar::Util 'blessed';
78

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
79
80
81
82
83
84
sub _Accessible {
    my $self = shift;
    my %Cols = (
        id            => 'read',
        Name          => 'read/write',
        Description   => 'read/write',
85
        Type          => 'read/write',    #Type is one of Perl or Simple
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
86
87
88
89
90
91
92
93
94
95
96
97
        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;
98
99
100
    
    unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
        return ( 0, $self->loc('Permission Denied') );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
101
    }
102
    return $self->SUPER::_Set( @_ );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
103
104
105
106
}

=head2 _Value

Ruslan Zakirov's avatar
Ruslan Zakirov committed
107
108
Takes the name of a table column. Returns its value as a string,
if the user passes an ACL check, otherwise returns undef.
109

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
110
111
112
113
=cut

sub _Value {
    my $self  = shift;
114

115
    unless ( $self->CurrentUserCanRead() ) {
116
        return undef;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
117
    }
118
    return $self->__Value( @_ );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
119
120
121

}

Shawn M Moore's avatar
Shawn M Moore committed
122
=head2 Load <identifier>
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
123

Ruslan Zakirov's avatar
Ruslan Zakirov committed
124
Load a template, either by number or by name.
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
125

126
127
128
129
130
131
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.

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
132
133
134
135
136
=cut

sub Load {
    my $self       = shift;
    my $identifier = shift;
137
    return undef unless $identifier;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
138

139
140
    if ( $identifier =~ /\D/ ) {
        return $self->LoadByCol( 'Name', $identifier );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
141
    }
142
    return $self->LoadById( $identifier );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
143
144
145
146
}

=head2 LoadGlobalTemplate NAME

Jesse Vincent's avatar
Jesse Vincent committed
147
Load the global template with the name NAME
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
148
149
150
151
152

=cut

sub LoadGlobalTemplate {
    my $self = shift;
Ruslan Zakirov's avatar
Ruslan Zakirov committed
153
    my $name = shift;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
154

Ruslan Zakirov's avatar
Ruslan Zakirov committed
155
    return ( $self->LoadQueueTemplate( Queue => 0, Name => $name ) );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
156
157
}

Ruslan Zakirov's avatar
Ruslan Zakirov committed
158
=head2 LoadQueueTemplate (Queue => QUEUEID, Name => NAME)
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
159
160
161

Loads the Queue template named NAME for Queue QUEUE.

Ruslan Zakirov's avatar
Ruslan Zakirov committed
162
163
164
165
166
167
168
169
170
171
172
173
174
175
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:

    $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
    ...

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
176
177
178
179
180
181
=cut

sub LoadQueueTemplate {
    my $self = shift;
    my %args = (
        Queue => undef,
182
183
        Name  => undef,
        @_
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
184
185
    );

186
    return ( $self->LoadByCols( Name => $args{'Name'}, Queue => $args{'Queue'} ) );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

}

=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]',
209
        Type        => 'Perl',
210
        Name        => undef,
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
211
212
213
        @_
    );

Shawn M Moore's avatar
Shawn M Moore committed
214
    if ( $args{Type} eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System) ) {
215
216
217
        return ( undef, $self->loc('Permission Denied') );
    }

218
    unless ( $args{'Queue'} ) {
219
        unless ( $self->CurrentUser->HasRight(Right =>'ModifyTemplate', Object => $RT::System) ) {
220
            return ( undef, $self->loc('Permission Denied') );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
221
        }
222
        $args{'Queue'} = 0;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
223
224
225
    }
    else {
        my $QueueObj = new RT::Queue( $self->CurrentUser );
226
        $QueueObj->Load( $args{'Queue'} ) || return ( undef, $self->loc('Invalid queue') );
227
    
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
228
        unless ( $QueueObj->CurrentUserHasRight('ModifyTemplate') ) {
229
            return ( undef, $self->loc('Permission Denied') );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
230
        }
231
        $args{'Queue'} = $QueueObj->Id;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
232
233
234
    }

    my $result = $self->SUPER::Create(
235
236
        Content     => $args{'Content'},
        Queue       => $args{'Queue'},
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
237
        Description => $args{'Description'},
238
        Name        => $args{'Name'},
239
        Type        => $args{'Type'},
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
    );

    return ($result);

}

=head2 Delete

Delete this template.

=cut

sub Delete {
    my $self = shift;

255
    unless ( $self->CurrentUserHasQueueRight('ModifyTemplate') ) {
256
        return ( 0, $self->loc('Permission Denied') );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
257
258
259
260
261
    }

    return ( $self->SUPER::Delete(@_) );
}

262
263
264
265
266
267
268
269
270
271
272
273
274
275
=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;
}

Ruslan Zakirov's avatar
Ruslan Zakirov committed
276
277
278
279
280
=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.

Ruslan Zakirov's avatar
Ruslan Zakirov committed
281
282
283
284
285
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.

Ruslan Zakirov's avatar
Ruslan Zakirov committed
286
287
=cut

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
288
289
290
291
292
sub MIMEObj {
    my $self = shift;
    return ( $self->{'MIMEObj'} );
}

Kevin Riggle's avatar
Kevin Riggle committed
293
=head2 Parse
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
294

Ruslan Zakirov's avatar
Ruslan Zakirov committed
295
This routine performs L<Text::Template> parsing on the template and then
Ruslan Zakirov's avatar
Ruslan Zakirov committed
296
297
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.
298

Ruslan Zakirov's avatar
Ruslan Zakirov committed
299
Takes a hash containing Argument, TicketObj, and TransactionObj and other
Ruslan Zakirov's avatar
Ruslan Zakirov committed
300
301
arguments that will be available in the template's code. TicketObj and
TransactionObj are not mandatory, but highly recommended.
302

Ruslan Zakirov's avatar
Ruslan Zakirov committed
303
304
It returns a tuple of (val, message). If val is false, the message contains
an error message.
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
305
306
307
308
309

=cut

sub Parse {
    my $self = shift;
310
311
    my ($rv, $msg);

Jesse Vincent's avatar
Jesse Vincent committed
312

313
314
315
316
317
318
319
320
    if ($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(@_);
    }

321
322
    return ($rv, $msg) unless $rv;

323
    my $mime_type   = $self->MIMEObj->mime_type;
324
    if (defined $mime_type and $mime_type eq 'text/html') {
325
326
327
328
329
330
331
332
        $self->_DowngradeFromHTML(@_);
    }

    return ($rv, $msg);
}

sub _Parse {
    my $self = shift;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
333

Ruslan Zakirov's avatar
Ruslan Zakirov committed
334
335
336
    # clear prev MIME object
    $self->{'MIMEObj'} = undef;

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
337
    #We're passing in whatever we were passed. it's destined for _ParseContent
338
    my ($content, $msg) = $self->_ParseContent(@_);
339
    return ( 0, $msg ) unless defined $content && length $content;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
340

341
342
343
344
345
346
347
348
349
350
    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;
    }

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
351
    my $parser = MIME::Parser->new();
352
353
354
    $parser->output_to_core(1);
    $parser->tmp_to_core(1);
    $parser->use_inner_files(1);
355

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
356
357
    ### Should we forgive normally-fatal errors?
    $parser->ignore_errors(1);
358
359
360
    # MIME::Parser doesn't play well with perl strings
    utf8::encode($content);
    $self->{'MIMEObj'} = eval { $parser->parse_data( \$content ) };
361
362
    if ( my $error = $@ || $parser->last_error ) {
        $RT::Logger->error( "$error" );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
363
364
365
366
        return ( 0, $error );
    }

    # Unfold all headers
367
    $self->{'MIMEObj'}->head->unfold;
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
368

369
    return ( 1, $self->loc("Template parsed") );
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
370
371
372
373
374
375
376
377
378
379
380
381
382
383

}

# Perform Template substitutions on the template

sub _ParseContent {
    my $self = shift;
    my %args = (
        Argument       => undef,
        TicketObj      => undef,
        TransactionObj => undef,
        @_
    );

384
    unless ( $self->CurrentUserCanRead() ) {
385
        return (undef, $self->loc("Permission Denied"));
386
387
    }

388
389
    if ( $self->IsEmpty ) {
        return ( undef, $self->loc("Template is empty") );
390
391
    }

392
    my $content = $self->SUPER::_Value('Content');
Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
393
394
395
396
    # We need to untaint the content of the template, since we'll be working
    # with it
    $content =~ s/^(.*)$/$1/;

397
398
    $args{'Ticket'} = delete $args{'TicketObj'} if $args{'TicketObj'};
    $args{'Transaction'} = delete $args{'TransactionObj'} if $args{'TransactionObj'};
Ruslan Zakirov's avatar
Ruslan Zakirov committed
399
400
    $args{'Requestor'} = eval { $args{'Ticket'}->Requestors->UserMembersObj->First->Name }
        if $args{'Ticket'};
Ruslan Zakirov's avatar
Ruslan Zakirov committed
401
402
403
404
405
406
407
408
    $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(@_) };
    }

409
410
    if ($self->Type eq 'Perl') {
        return $self->_ParseContentPerl(
411
412
413
414
415
416
417
418
419
420
421
422
            Content      => $content,
            TemplateArgs => \%args,
        );
    }
    else {
        return $self->_ParseContentSimple(
            Content      => $content,
            TemplateArgs => \%args,
        );
    }
}

423
424
# uses Text::Template for Perl templates
sub _ParseContentPerl {
425
426
427
428
429
430
    my $self = shift;
    my %args = (
        Content      => undef,
        TemplateArgs => {},
        @_,
    );
431

432
433
434
435
436
437
438
    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;
    }

439
440
441
442
    my $template = Text::Template->new(
        TYPE   => 'STRING',
        SOURCE => $args{Content},
    );
443
    my $is_broken = 0;
444
    my $retval = $template->fill_in(
445
        HASH => $args{TemplateArgs},
446
447
448
449
450
451
        BROKEN => sub {
            my (%args) = @_;
            $RT::Logger->error("Template parsing error: $args{error}")
                unless $args{error} =~ /^Died at /; # ignore intentional die()
            $is_broken++;
            return undef;
452
        },
453
    );
454
    return ( undef, $self->loc('Template parsing error') ) if $is_broken;
455

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
456
457
458
    return ($retval);
}

459
460
461
462
463
464
465
466
sub _ParseContentSimple {
    my $self = shift;
    my %args = (
        Content      => undef,
        TemplateArgs => {},
        @_,
    );

467
468
    $self->_MassageSimpleTemplateArgs(%args);

Shawn M Moore's avatar
Shawn M Moore committed
469
470
471
472
    my $template = Text::Template->new(
        TYPE   => 'STRING',
        SOURCE => $args{Content},
    );
473
474
    my ($ok) = $template->compile;
    return ( undef, $self->loc('Template parsing error') ) if !$ok;
Shawn M Moore's avatar
Shawn M Moore committed
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

    # 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
500
            if (!defined $fi_res) {
Shawn M Moore's avatar
Shawn M Moore committed
501
502
503
504
505
506
507
508
509
510
511
512
513
                $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;
514
515
}

516
517
518
519
520
521
522
523
524
525
sub _MassageSimpleTemplateArgs {
    my $self = shift;
    my %args = (
        TemplateArgs => {},
        @_,
    );

    my $template_args = $args{TemplateArgs};

    if (my $ticket = $template_args->{Ticket}) {
Shawn M Moore's avatar
Shawn M Moore committed
526
        for my $column (qw/Id Subject Type InitialPriority FinalPriority Priority TimeEstimated TimeWorked Status TimeLeft Told Starts Started Due Resolved RequestorAddresses AdminCcAddresses CcAddresses/) {
527
528
            $template_args->{"Ticket".$column} = $ticket->$column;
        }
529
530
531
532
533
534
535

        $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;
536
537
538
539
540

        my $cfs = $ticket->CustomFields;
        while (my $cf = $cfs->Next) {
            $template_args->{"TicketCF" . $cf->Name} = $ticket->CustomFieldValuesAsString($cf->Name);
        }
541
542
543
    }

    if (my $txn = $template_args->{Transaction}) {
Shawn M Moore's avatar
Shawn M Moore committed
544
        for my $column (qw/Id TimeTaken Type Field OldValue NewValue Data Content Subject Description BriefDescription/) {
545
546
            $template_args->{"Transaction".$column} = $txn->$column;
        }
Shawn M Moore's avatar
Shawn M Moore committed
547
548
549
550
551

        my $cfs = $txn->CustomFields;
        while (my $cf = $cfs->Next) {
            $template_args->{"TransactionCF" . $cf->Name} = $txn->CustomFieldValuesAsString($cf->Name);
        }
552
553
554
    }
}

555
556
557
558
sub _DowngradeFromHTML {
    my $self = shift;
    my $orig_entity = $self->MIMEObj;

559
560
561
    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' );
562
563
564
565
566
567
568

    $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;
Ruslan Zakirov's avatar
Ruslan Zakirov committed
569
570
571
572
573
574
575
576
577
578
    my $tree = HTML::TreeBuilder->new_from_content(
        $new_entity->bodyhandle->as_string
    );
    $new_entity->bodyhandle(MIME::Body::InCore->new(
        \(scalar HTML::FormatText->new(
            leftmargin  => 0,
            rightmargin => 78,
        )->format( $tree ))
    ));
    $tree->delete;
579
580
581
582

    $orig_entity->add_part($new_entity, 0); # plain comes before html
    $self->{MIMEObj} = $orig_entity;

583
    return;
584
585
}

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
586
587
588
589
590
591
592
593
594
595
596
=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(@_) );
}

597
598
=head2 SetType

Shawn M Moore's avatar
Shawn M Moore committed
599
If setting Type to Perl, require the ExecuteCode right.
600
601
602
603
604
605
606

=cut

sub SetType {
    my $self    = shift;
    my $NewType = shift;

Shawn M Moore's avatar
Shawn M Moore committed
607
    if ($NewType eq 'Perl' && !$self->CurrentUser->HasRight(Right => 'ExecuteCode', Object => $RT::System)) {
608
609
610
611
612
613
        return ( undef, $self->loc('Permission Denied') );
    }

    return $self->_Set( Field => 'Type', Value => $NewType );
}

614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
=head2 SetContent

If setting Content, require the ExecuteCode right.

=cut

sub SetContent {
    my $self    = shift;
    my $content = 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 => $content );
}

631
632
=head2 CompileCheck

633
If the template's Type is Perl, then compile check all the codeblocks to see if
634
635
636
637
638
639
640
641
642
643
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;

Shawn M Moore's avatar
Shawn M Moore committed
644
    return (1, $self->loc("Template does not include Perl code"))
645
        unless $self->Type eq 'Perl';
646

647
648
649
    my $content = $self->Content;
    $content = '' if !defined($content);

650
651
    my $template = Text::Template->new(
        TYPE   => 'STRING',
652
        SOURCE => $content,
653
654
655
656
657
658
659
660
    );
    $template->compile;

    # 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';

661
662
663
664
        do {
            no strict 'vars';
            eval "sub { $fi_text }";
        };
665
666
667
668
669
670
671
672
673
674
675
        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));
    }

Shawn M Moore's avatar
Shawn M Moore committed
676
    return (1, $self->loc("Template compiles"));
677
}
678

679
680
681
682
683
684
=head2 CurrentUserCanRead

=cut

sub CurrentUserCanRead {
    my $self =shift;
685
686
687
688
689
690
691

    return 1 if $self->CurrentUserHasQueueRight('ShowTemplate');

    return $self->CurrentUser->HasRight( Right =>'ShowGlobalTemplates', Object => $RT::System )
        if !$self->QueueObj->Id;

    return;
692
693
}

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
694
1;