rt/lib/RT/Attachments_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46
  47 =head1 NAME
  48
  49   RT::Attachments - a collection of RT::Attachment objects
  50
  51 =head1 SYNOPSIS
  52
  53   use RT::Attachments;
  54
  55 =head1 DESCRIPTION
  56
  57 This module should never be called directly by client code. it's an internal module which
  58 should only be accessed through exported APIs in Ticket, Queue and other similar objects.
  59
  60
  61 =head1 METHODS
  62
  63
  64 =begin testing
  65
  66 ok (require RT::Attachments);
  67
  68 =end testing
  69
  70 =cut
  71
  72
  73 package RT::Attachments;
  74
  75 use strict;
  76 no warnings qw(redefine);
  77
  78 # {{{ sub _Init
  79 sub _Init   {
  80   my $self = shift;
  81
  82   $self->{'table'} = "Attachments";
  83   $self->{'primary_key'} = "id";
  84   return ( $self->SUPER::_Init(@_));
  85 }
  86 # }}}
  87
  88
  89 # {{{ sub ContentType
  90
  91 =head2 ContentType (VALUE => 'text/plain', ENTRYAGGREGATOR => 'OR', OPERATOR => '=' )
  92
  93 Limit result set to attachments of ContentType 'TYPE'...
  94
  95 =cut
  96
  97
  98 sub ContentType  {
  99   my $self = shift;
 100   my %args = ( VALUE => 'text/plain',
 101                OPERATOR => '=',
 102                ENTRYAGGREGATOR => 'OR',
 103                @_);
 104
 105   $self->Limit ( FIELD => 'ContentType',
 106                  VALUE => $args{'VALUE'},
 107                  OPERATOR => $args{'OPERATOR'},
 108                  ENTRYAGGREGATOR => $args{'ENTRYAGGREGATOR'});
 109 }
 110 # }}}
 111
 112 # {{{ sub ChildrenOf
 113
 114 =head2 ChildrenOf ID
 115
 116 Limit result set to children of Attachment ID
 117
 118 =cut
 119
 120
 121 sub ChildrenOf  {
 122   my $self = shift;
 123   my $attachment = shift;
 124   $self->Limit ( FIELD => 'Parent',
 125                  VALUE => $attachment);
 126 }
 127 # }}}
 128
 129 # {{{ sub NewItem
 130 sub NewItem  {
 131   my $self = shift;
 132
 133   use RT::Attachment;
 134   my $item = new RT::Attachment($self->CurrentUser);
 135   return($item);
 136 }
 137 # }}}
 138
 139 # {{{ sub Next
 140 sub Next {
 141     my $self = shift;
 142
 143     my $Attachment = $self->SUPER::Next();
 144     if ((defined($Attachment)) and (ref($Attachment))) {
 145         if ($Attachment->TransactionObj->__Value('Type') =~ /^Comment/ &&
 146             $Attachment->TransactionObj->TicketObj->CurrentUserHasRight('ShowTicketComments')) {
 147             return($Attachment);
 148         } elsif ($Attachment->TransactionObj->__Value('Type') !~ /^Comment/ &&
 149                  $Attachment->TransactionObj->TicketObj->CurrentUserHasRight('ShowTicket')) {
 150             return($Attachment);
 151         }
 152
 153         #If the user doesn't have the right to show this ticket
 154         else {
 155             return($self->Next());
 156         }
 157     }
 158
 159     #if there never was any ticket
 160     else {
 161         return(undef);
 162     }
 163 }
 164 # }}}
 165
 166   1;
 167
 168
 169
 170