1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
51 RT::Attachments - a collection of RT::Attachment objects
59 This module should never be called directly by client code. it's an internal module which
60 should only be accessed through exported APIs in Ticket, Queue and other similar objects.
70 package RT::Attachments;
77 use base 'RT::SearchBuilder';
79 sub Table { 'Attachments'}
86 $self->{'table'} = "Attachments";
87 $self->{'primary_key'} = "id";
92 return $self->SUPER::_Init( @_ );
97 delete $self->{_sql_transaction_alias};
98 return $self->SUPER::CleanSlate( @_ );
102 =head2 TransactionAlias
104 Returns alias for transactions table with applied join condition.
105 Always return the same alias, so if you want to build some complex
106 or recursive joining then you have to create new alias youself.
110 sub TransactionAlias {
112 return $self->{'_sql_transaction_alias'}
113 if $self->{'_sql_transaction_alias'};
115 my $res = $self->NewAlias('Transactions');
117 ENTRYAGGREGATOR => 'AND',
118 FIELD => 'TransactionId',
119 VALUE => $res . '.id',
122 return $self->{'_sql_transaction_alias'} = $res;
125 =head2 ContentType (VALUE => 'text/plain', ENTRYAGGREGATOR => 'OR', OPERATOR => '=' )
127 Limit result set to attachments of ContentType 'TYPE'...
135 VALUE => 'text/plain',
137 ENTRYAGGREGATOR => 'OR',
141 return $self->Limit ( %args, FIELD => 'ContentType' );
146 Limit result set to children of Attachment ID
153 my $attachment = shift;
162 Limit result set to attachments with not empty content.
169 ENTRYAGGREGATOR => 'AND',
171 OPERATOR => 'IS NOT',
176 # http://rt3.fsck.com/Ticket/Display.html?id=12483
177 if ( RT->Config->Get('DatabaseType') ne 'Oracle' ) {
179 ENTRYAGGREGATOR => 'AND',
188 =head2 LimitByTicket $ticket_id
190 Limit result set to attachments of a ticket.
198 my $transactions = $self->TransactionAlias;
200 ENTRYAGGREGATOR => 'AND',
201 ALIAS => $transactions,
202 FIELD => 'ObjectType',
203 VALUE => 'RT::Ticket',
206 my $tickets = $self->NewAlias('Tickets');
208 ENTRYAGGREGATOR => 'AND',
211 VALUE => $transactions . '.ObjectId',
215 ENTRYAGGREGATOR => 'AND',
217 FIELD => 'EffectiveId',
227 my $Attachment = $self->SUPER::Next;
228 return $Attachment unless $Attachment;
230 if ( $Attachment->TransactionObj->CurrentUserCanSee ) {
233 # If the user doesn't have the right to show this ticket
241 Returns an empty new RT::Attachment item
247 return(RT::Attachment->new($self->CurrentUser));
250 RT::Base->_ImportOverlays();