rt/lib/RT/Templates_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
   6 #                                          <jesse@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 no warnings qw(redefine);
  70
  71
  72 # {{{ sub _Init
  73
  74 =head2 _Init
  75
  76   Returns RT::Templates specific init info like table and primary key names
  77
  78 =cut
  79
  80 sub _Init {
  81
  82     my $self = shift;
  83     $self->{'table'} = "Templates";
  84     $self->{'primary_key'} = "id";
  85     return ($self->SUPER::_Init(@_));
  86 }
  87 # }}}
  88
  89 # {{{ LimitToNotInQueue
  90
  91 =head2 LimitToNotInQueue
  92
  93 Takes a queue id # and limits the returned set of templates to those which
  94 aren't that queue's templates.
  95
  96 =cut
  97
  98 sub LimitToNotInQueue {
  99     my $self = shift;
 100     my $queue_id = shift;
 101     $self->Limit(FIELD => 'Queue',
 102                  VALUE => "$queue_id",
 103                  OPERATOR => '!='
 104                 );
 105 }
 106 # }}}
 107
 108 # {{{ LimitToGlobal
 109
 110 =head2 LimitToGlobal
 111
 112 Takes no arguments. Limits the returned set to "Global" templates
 113 which can be used with any queue.
 114
 115 =cut
 116
 117 sub LimitToGlobal {
 118     my $self = shift;
 119     my $queue_id = shift;
 120     $self->Limit(FIELD => 'Queue',
 121                  VALUE => "0",
 122                  OPERATOR => '='
 123                 );
 124 }
 125 # }}}
 126
 127 # {{{ LimitToQueue
 128
 129 =head2 LimitToQueue
 130
 131 Takes a queue id # and limits the returned set of templates to that queue's
 132 templates
 133
 134 =cut
 135
 136 sub LimitToQueue {
 137     my $self = shift;
 138     my $queue_id = shift;
 139     $self->Limit(FIELD => 'Queue',
 140                  VALUE => "$queue_id",
 141                  OPERATOR => '='
 142                 );
 143 }
 144 # }}}
 145
 146 # {{{ sub NewItem
 147
 148 =head2 NewItem
 149
 150 Returns a new empty Template object
 151
 152 =cut
 153
 154 sub NewItem  {
 155   my $self = shift;
 156
 157   use RT::Template;
 158   my $item = new RT::Template($self->CurrentUser);
 159   return($item);
 160 }
 161 # }}}
 162
 163 # {{{ sub Next
 164
 165 =head2 Next
 166
 167 Returns the next template that this user can see.
 168
 169 =cut
 170
 171 sub Next {
 172     my $self = shift;
 173
 174
 175     my $templ = $self->SUPER::Next();
 176     if ((defined($templ)) and (ref($templ))) {
 177
 178         # If it's part of a queue, and the user can read templates in
 179         # that queue, or the user can globally read templates, show it
 180         if ($templ->Queue && $templ->CurrentUserHasQueueRight('ShowTemplate') or
 181             $templ->CurrentUser->HasRight(Object => $RT::System, Right => 'ShowTemplate')) {
 182             return($templ);
 183         }
 184
 185         #If the user doesn't have the right to show this template
 186         else {
 187             return($self->Next());
 188         }
 189     }
 190     #if there never was any template
 191     else {
 192         return(undef);
 193     }
 194
 195 }
 196 # }}}
 197
 198 1;
 199