diff options
Diffstat (limited to 'rt/lib/RT/Attachments.pm')
| -rwxr-xr-x | rt/lib/RT/Attachments.pm | 197 |
1 files changed, 163 insertions, 34 deletions
diff --git a/rt/lib/RT/Attachments.pm b/rt/lib/RT/Attachments.pm index 40f25e435..2bdbc244c 100755 --- a/rt/lib/RT/Attachments.pm +++ b/rt/lib/RT/Attachments.pm @@ -2,7 +2,7 @@ # # COPYRIGHT: # -# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC +# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC # <sales@bestpractical.com> # # (Except where explicitly superseded by other copyright notices) @@ -46,78 +46,207 @@ # # END BPS TAGGED BLOCK }}} -# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>) -# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. -# -# !! DO NOT EDIT THIS FILE !! -# - -use strict; - - =head1 NAME - RT::Attachments -- Class Description - + RT::Attachments - a collection of RT::Attachment objects + =head1 SYNOPSIS - use RT::Attachments + use RT::Attachments; =head1 DESCRIPTION +This module should never be called directly by client code. it's an internal module which +should only be accessed through exported APIs in Ticket, Queue and other similar objects. + =head1 METHODS + + =cut + package RT::Attachments; +use strict; +use warnings; + -use RT::SearchBuilder; use RT::Attachment; -use vars qw( @ISA ); -@ISA= qw(RT::SearchBuilder); +use base 'RT::SearchBuilder'; + +sub Table { 'Attachments'} + + +use RT::Attachment; +sub _Init { + my $self = shift; + $self->{'table'} = "Attachments"; + $self->{'primary_key'} = "id"; + $self->OrderBy( + FIELD => 'id', + ORDER => 'ASC', + ); + return $self->SUPER::_Init( @_ ); +} -sub _Init { +sub CleanSlate { my $self = shift; - $self->{'table'} = 'Attachments'; - $self->{'primary_key'} = 'id'; + delete $self->{_sql_transaction_alias}; + return $self->SUPER::CleanSlate( @_ ); +} - return ( $self->SUPER::_Init(@_) ); +=head2 TransactionAlias + +Returns alias for transactions table with applied join condition. +Always return the same alias, so if you want to build some complex +or recursive joining then you have to create new alias youself. + +=cut + +sub TransactionAlias { + my $self = shift; + return $self->{'_sql_transaction_alias'} + if $self->{'_sql_transaction_alias'}; + + my $res = $self->NewAlias('Transactions'); + $self->Limit( + ENTRYAGGREGATOR => 'AND', + FIELD => 'TransactionId', + VALUE => $res . '.id', + QUOTEVALUE => 0, + ); + return $self->{'_sql_transaction_alias'} = $res; } +=head2 ContentType (VALUE => 'text/plain', ENTRYAGGREGATOR => 'OR', OPERATOR => '=' ) -=head2 NewItem +Limit result set to attachments of ContentType 'TYPE'... -Returns an empty new RT::Attachment item +=cut + + +sub ContentType { + my $self = shift; + my %args = ( + VALUE => 'text/plain', + OPERATOR => '=', + ENTRYAGGREGATOR => 'OR', + @_ + ); + + return $self->Limit ( %args, FIELD => 'ContentType' ); +} + +=head2 ChildrenOf ID + +Limit result set to children of Attachment ID =cut -sub NewItem { + +sub ChildrenOf { my $self = shift; - return(RT::Attachment->new($self->CurrentUser)); + my $attachment = shift; + return $self->Limit( + FIELD => 'Parent', + VALUE => $attachment + ); } -RT::Base->_ImportOverlays(); -=head1 SEE ALSO +=head2 LimitNotEmpty + +Limit result set to attachments with not empty content. + +=cut + +sub LimitNotEmpty { + my $self = shift; + $self->Limit( + ENTRYAGGREGATOR => 'AND', + FIELD => 'Content', + OPERATOR => 'IS NOT', + VALUE => 'NULL', + QUOTEVALUE => 0, + ); + + # http://rt3.fsck.com/Ticket/Display.html?id=12483 + if ( RT->Config->Get('DatabaseType') ne 'Oracle' ) { + $self->Limit( + ENTRYAGGREGATOR => 'AND', + FIELD => 'Content', + OPERATOR => '!=', + VALUE => '', + ); + } + return; +} + +=head2 LimitByTicket $ticket_id + +Limit result set to attachments of a ticket. -This class allows "overlay" methods to be placed -into the following files _Overlay is for a System overlay by the original author, -_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations. +=cut + +sub LimitByTicket { + my $self = shift; + my $tid = shift; + + my $transactions = $self->TransactionAlias; + $self->Limit( + ENTRYAGGREGATOR => 'AND', + ALIAS => $transactions, + FIELD => 'ObjectType', + VALUE => 'RT::Ticket', + ); + + my $tickets = $self->NewAlias('Tickets'); + $self->Limit( + ENTRYAGGREGATOR => 'AND', + ALIAS => $tickets, + FIELD => 'id', + VALUE => $transactions . '.ObjectId', + QUOTEVALUE => 0, + ); + $self->Limit( + ENTRYAGGREGATOR => 'AND', + ALIAS => $tickets, + FIELD => 'EffectiveId', + VALUE => $tid, + ); + return; +} -These overlay files can contain new subs or subs to replace existing subs in this module. +# {{{ sub Next +sub Next { + my $self = shift; -Each of these files should begin with the line + my $Attachment = $self->SUPER::Next; + return $Attachment unless $Attachment; - no warnings qw(redefine); + if ( $Attachment->TransactionObj->CurrentUserCanSee ) { + return $Attachment; + } else { + # If the user doesn't have the right to show this ticket + return $self->Next; + } +} -so that perl does not kick and scream when you redefine a subroutine or variable in your overlay. -RT::Attachments_Overlay, RT::Attachments_Vendor, RT::Attachments_Local +=head2 NewItem + +Returns an empty new RT::Attachment item =cut +sub NewItem { + my $self = shift; + return(RT::Attachment->new($self->CurrentUser)); +} + +RT::Base->_ImportOverlays(); 1; |