rt/lib/RT/Templates.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
   6 #                                          <sales@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  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
  16 # from www.gnu.org.
  17 #
  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.
  22 #
  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.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  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.)
  37 #
  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.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 =head1 NAME
  50
  51   RT::Templates - a collection of RT Template objects
  52
  53 =head1 SYNOPSIS
  54
  55   use RT::Templates;
  56
  57 =head1 DESCRIPTION
  58
  59
  60 =head1 METHODS
  61
  62
  63 =cut
  64
  65
  66 package RT::Templates;
  67
  68 use strict;
  69 use warnings;
  70
  71 use RT::Template;
  72
  73 use base 'RT::SearchBuilder';
  74
  75 sub Table { 'Templates'}
  76
  77
  78 =head2 LimitToNotInQueue
  79
  80 Takes a queue id # and limits the returned set of templates to those which
  81 aren't that queue's templates.
  82
  83 =cut
  84
  85 sub LimitToNotInQueue {
  86     my $self = shift;
  87     my $queue_id = shift;
  88     $self->Limit(FIELD => 'Queue',
  89                  VALUE => "$queue_id",
  90                  OPERATOR => '!='
  91                 );
  92 }
  93
  94
  95 =head2 LimitToGlobal
  96
  97 Takes no arguments. Limits the returned set to "Global" templates
  98 which can be used with any queue.
  99
 100 =cut
 101
 102 sub LimitToGlobal {
 103     my $self = shift;
 104     $self->Limit(FIELD => 'Queue',
 105                  VALUE => "0",
 106                  OPERATOR => '='
 107                 );
 108 }
 109
 110
 111 =head2 LimitToQueue
 112
 113 Takes a queue id # and limits the returned set of templates to that queue's
 114 templates
 115
 116 =cut
 117
 118 sub LimitToQueue {
 119     my $self = shift;
 120     my $queue_id = shift;
 121     $self->Limit(FIELD => 'Queue',
 122                  VALUE => "$queue_id",
 123                  OPERATOR => '='
 124                 );
 125 }
 126
 127
 128 =head2 Next
 129
 130 Returns the next template that this user can see.
 131
 132 =cut
 133
 134 sub Next {
 135     my $self = shift;
 136
 137
 138     my $templ = $self->SUPER::Next();
 139     if ((defined($templ)) and (ref($templ))) {
 140
 141         # If it's part of a queue, and the user can read templates in
 142         # that queue, or the user can globally read templates, show it
 143         if ($templ->Queue && $templ->CurrentUserHasQueueRight('ShowTemplate') or
 144             $templ->CurrentUser->HasRight(Object => $RT::System, Right => 'ShowTemplate') or
 145             $templ->CurrentUser->HasRight(Object => $RT::System, Right => 'ShowGlobalTemplates')) {
 146             return($templ);
 147         }
 148
 149         #If the user doesn't have the right to show this template
 150         else {
 151             return($self->Next());
 152         }
 153     }
 154     #if there never was any template
 155     else {
 156         return(undef);
 157     }
 158
 159 }
 160
 161 =head2 NewItem
 162
 163 Returns an empty new RT::Template item
 164
 165 =cut
 166
 167 sub NewItem {
 168     my $self = shift;
 169     return(RT::Template->new($self->CurrentUser));
 170 }
 171
 172
 173 RT::Base->_ImportOverlays();
 174
 175 1;