rt/lib/RT/Attachments_Overlay.pm

   1 # {{{ BEGIN BPS TAGGED BLOCK
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2004 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 =head1 NAME
  47
  48   RT::Attachments - a collection of RT::Attachment objects
  49
  50 =head1 SYNOPSIS
  51
  52   use RT::Attachments;
  53
  54 =head1 DESCRIPTION
  55
  56 This module should never be called directly by client code. it's an internal module which
  57 should only be accessed through exported APIs in Ticket, Queue and other similar objects.
  58
  59
  60 =head1 METHODS
  61
  62
  63 =begin testing
  64
  65 ok (require RT::Attachments);
  66
  67 =end testing
  68
  69 =cut
  70
  71 use strict;
  72 no warnings qw(redefine);
  73
  74 # {{{ sub _Init
  75 sub _Init   {
  76   my $self = shift;
  77
  78   $self->{'table'} = "Attachments";
  79   $self->{'primary_key'} = "id";
  80   return ( $self->SUPER::_Init(@_));
  81 }
  82 # }}}
  83
  84
  85 # {{{ sub ContentType
  86
  87 =head2 ContentType (VALUE => 'text/plain', ENTRYAGGREGATOR => 'OR', OPERATOR => '=' )
  88
  89 Limit result set to attachments of ContentType 'TYPE'...
  90
  91 =cut
  92
  93
  94 sub ContentType  {
  95   my $self = shift;
  96   my %args = ( VALUE => 'text/plain',
  97                OPERATOR => '=',
  98                ENTRYAGGREGATOR => 'OR',
  99                @_);
 100
 101   $self->Limit ( FIELD => 'ContentType',
 102                  VALUE => $args{'VALUE'},
 103                  OPERATOR => $args{'OPERATOR'},
 104                  ENTRYAGGREGATOR => $args{'ENTRYAGGREGATOR'});
 105 }
 106 # }}}
 107
 108 # {{{ sub ChildrenOf
 109
 110 =head2 ChildrenOf ID
 111
 112 Limit result set to children of Attachment ID
 113
 114 =cut
 115
 116
 117 sub ChildrenOf  {
 118   my $self = shift;
 119   my $attachment = shift;
 120   $self->Limit ( FIELD => 'Parent',
 121                  VALUE => $attachment);
 122 }
 123 # }}}
 124
 125 # {{{ sub NewItem
 126 sub NewItem  {
 127   my $self = shift;
 128
 129   use RT::Attachment;
 130   my $item = new RT::Attachment($self->CurrentUser);
 131   return($item);
 132 }
 133 # }}}
 134
 135 # {{{ sub Next
 136 sub Next {
 137     my $self = shift;
 138
 139     my $Attachment = $self->SUPER::Next();
 140     if ((defined($Attachment)) and (ref($Attachment))) {
 141         if ($Attachment->TransactionObj->__Value('Type') =~ /^Comment/ &&
 142             $Attachment->TransactionObj->TicketObj->CurrentUserHasRight('ShowTicketComments')) {
 143             return($Attachment);
 144         } elsif ($Attachment->TransactionObj->__Value('Type') !~ /^Comment/ &&
 145                  $Attachment->TransactionObj->TicketObj->CurrentUserHasRight('ShowTicket')) {
 146             return($Attachment);
 147         }
 148
 149         #If the user doesn't have the right to show this ticket
 150         else {
 151             return($self->Next());
 152         }
 153     }
 154
 155     #if there never was any ticket
 156     else {
 157         return(undef);
 158     }
 159 }
 160 # }}}
 161
 162   1;
 163
 164
 165
 166