Template.pm 24.3 KB
Newer Older
1
# BEGIN BPS TAGGED BLOCK {{{
Jesse Vincent's avatar
Jesse Vincent committed
2
#
3
# COPYRIGHT:
Jesse Vincent's avatar
Jesse Vincent committed
4
#
5
# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
Kevin Falcone's avatar
Kevin Falcone committed
6
#                                          <sales@bestpractical.com>
Jesse Vincent's avatar
Jesse Vincent committed
7
#
8
# (Except where explicitly superseded by other copyright notices)
Jesse Vincent's avatar
Jesse Vincent committed
9
10
#
#
11
# LICENSE:
Jesse Vincent's avatar
Jesse Vincent committed
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.
Jesse Vincent's avatar
Jesse Vincent committed
17
#
18
19
20
21
# 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.
Jesse Vincent's avatar
Jesse Vincent committed
22
#
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.
Jesse Vincent's avatar
Jesse Vincent committed
28
29
#
#
30
# CONTRIBUTION SUBMISSION POLICY:
Jesse Vincent's avatar
Jesse Vincent committed
31
#
32
33
34
35
36
# (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.)
Jesse Vincent's avatar
Jesse Vincent committed
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.
Jesse Vincent's avatar
Jesse Vincent committed
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;
72
73


Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
74

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

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

=head2 _Value

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

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

sub _Value {
    my $self  = shift;
115

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

}

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

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

127
128
129
130
131
132
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
133
134
135
136
137
=cut

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

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

=head2 LoadGlobalTemplate NAME

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

=cut

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

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

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

Loads the Queue template named NAME for Queue QUEUE.

Ruslan Zakirov's avatar
Ruslan Zakirov committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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
177
178
179
180
181
182
=cut

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

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

}

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

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

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

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

    return ($result);

}

=head2 Delete

Delete this template.

=cut

sub Delete {
    my $self = shift;

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

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

263
264
265
266
267
268
269
270
271
272
273
274
275
276
=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
277
278
279
280
281
=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
282
283
284
285
286
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
287
288
=cut

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

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

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

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

Ruslan Zakirov's avatar
Ruslan Zakirov committed
304
305
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
306
307
308
309
310

=cut

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

Jesse Vincent's avatar
Jesse Vincent committed
313

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

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

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

    return ($rv, $msg);
}

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

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

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

342
343
344
345
346
347
348
349
350
351
    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
352
    my $parser = MIME::Parser->new();
353
354
355
    $parser->output_to_core(1);
    $parser->tmp_to_core(1);
    $parser->use_inner_files(1);
356

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

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

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

}

# Perform Template substitutions on the template

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

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

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

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

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

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

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

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

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

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

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

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

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

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

517
518
519
520
521
522
523
524
525
526
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
527
        for my $column (qw/Id Subject Type InitialPriority FinalPriority Priority TimeEstimated TimeWorked Status TimeLeft Told Starts Started Due Resolved RequestorAddresses AdminCcAddresses CcAddresses/) {
528
529
            $template_args->{"Ticket".$column} = $ticket->$column;
        }
530
531
532
533
534
535
536

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

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

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

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

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

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

    $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;
570
571
    require Encode;
    # need to decode_utf8, see the doc of MIMEObj method
Ruslan Zakirov's avatar
Ruslan Zakirov committed
572
    my $tree = HTML::TreeBuilder->new_from_content(
573
        Encode::decode_utf8($new_entity->bodyhandle->as_string)
Ruslan Zakirov's avatar
Ruslan Zakirov committed
574
575
576
577
578
579
580
581
    );
    $new_entity->bodyhandle(MIME::Body::InCore->new(
        \(scalar HTML::FormatText->new(
            leftmargin  => 0,
            rightmargin => 78,
        )->format( $tree ))
    ));
    $tree->delete;
582
583
584
585

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

586
    return;
587
588
}

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

600
601
=head2 SetType

Shawn M Moore's avatar
Shawn M Moore committed
602
If setting Type to Perl, require the ExecuteCode right.
603
604
605
606
607
608
609

=cut

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

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

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

617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
=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 );
}

634
635
636
637
638
639
sub _UpdateAttributes {
    my $self = shift;
    my %args = (
        NewValues => {},
        @_,
    );
640

641
    my $type = $args{NewValues}{Type} || $self->Type;
642

643
644
645
646
647
    # 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');
        }
648
649
    }

650
    return $self->SUPER::_UpdateAttributes(%args);
651
652
}

653
654
=head2 CompileCheck

655
If the template's Type is Perl, then compile check all the codeblocks to see if
656
657
658
659
660
661
662
663
664
665
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
666
    return (1, $self->loc("Template does not include Perl code"))
667
        unless $self->Type eq 'Perl';
668

669
670
671
    my $content = $self->Content;
    $content = '' if !defined($content);

672
673
    my $template = Text::Template->new(
        TYPE   => 'STRING',
674
        SOURCE => $content,
675
    );
676
677
    my ($ok) = $template->compile;
    return ( undef, $self->loc('Template parsing error: [_1]', $Text::Template::ERROR) ) if !$ok;
678
679
680
681
682
683

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

684
685
686
687
        do {
            no strict 'vars';
            eval "sub { $fi_text }";
        };
688
689
690
691
692
693
694
695
696
697
698
        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
699
    return (1, $self->loc("Template compiles"));
700
}
701

702
703
704
705
706
707
=head2 CurrentUserCanRead

=cut

sub CurrentUserCanRead {
    my $self =shift;
708
709
710
711
712
713
714

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

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

    return;
715
716
}

Jesse Vincent's avatar
rt.2.1  
Jesse Vincent committed
717
1;
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

use RT::Queue;
use base 'RT::Record';

sub Table {'Templates'}






=head2 id

Returns the current value of id.
(In the database, id is stored as int(11).)


=cut


=head2 Queue

Returns the current value of Queue.
(In the database, Queue is stored as int(11).)



=head2 SetQueue VALUE


Set Queue to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, Queue will be stored as a int(11).)


=cut


=head2 QueueObj

Returns the Queue Object which has the id returned by Queue


=cut

sub QueueObj {
	my $self = shift;
	my $Queue =  RT::Queue->new($self->CurrentUser);
	$Queue->Load($self->__Value('Queue'));
	return($Queue);
}

=head2 Name

Returns the current value of Name.
(In the database, Name is stored as varchar(200).)



=head2 SetName VALUE


Set Name to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, Name will be stored as a varchar(200).)


=cut


=head2 Description

Returns the current value of Description.
(In the database, Description is stored as varchar(255).)



=head2 SetDescription VALUE


Set Description to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, Description will be stored as a varchar(255).)


=cut


=head2 Type

Returns the current value of Type.
(In the database, Type is stored as varchar(16).)



=head2 SetType VALUE


Set Type to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, Type will be stored as a varchar(16).)


=cut


=head2 Language

Returns the current value of Language.
(In the database, Language is stored as varchar(16).)



=head2 SetLanguage VALUE


Set Language to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, Language will be stored as a varchar(16).)


=cut


=head2 TranslationOf

Returns the current value of TranslationOf.
(In the database, TranslationOf is stored as int(11).)



=head2 SetTranslationOf VALUE


Set TranslationOf to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, TranslationOf will be stored as a int(11).)


=cut


=head2 Content

Returns the current value of Content.
(In the database, Content is stored as text.)



=head2 SetContent VALUE


Set Content to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, Content will be stored as a text.)


=cut


=head2 LastUpdated

Returns the current value of LastUpdated.
(In the database, LastUpdated is stored as datetime.)


=cut


=head2 LastUpdatedBy

Returns the current value of LastUpdatedBy.
(In the database, LastUpdatedBy is stored as int(11).)


=cut


=head2 Creator

Returns the current value of Creator.
(In the database, Creator is stored as int(11).)


=cut


=head2 Created

Returns the current value of Created.
(In the database, Created is stored as datetime.)


=cut



sub _CoreAccessible {
    {

        id =>
		{read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
        Queue =>
		{read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
        Name =>
		{read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => ''},
        Description =>
		{read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
        Type =>
		{read => 1, write => 1, sql_type => 12, length => 16,  is_blob => 0,  is_numeric => 0,  type => 'varchar(16)', default => ''},
        Language =>
		{read => 1, write => 1, sql_type => 12, length => 16,  is_blob => 0,  is_numeric => 0,  type => 'varchar(16)', default => ''},
        TranslationOf =>
		{read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
        Content =>
		{read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'text', default => ''},
        LastUpdated =>
		{read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
        LastUpdatedBy =>
		{read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
        Creator =>
		{read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
        Created =>
		{read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},

 }
};

RT::Base->_ImportOverlays();

1;