rt/lib/RT/Transactions_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 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/copyleft/gpl.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 =head1 NAME
  49
  50   RT::Transactions - a collection of RT Transaction objects
  51
  52 =head1 SYNOPSIS
  53
  54   use RT::Transactions;
  55
  56
  57 =head1 DESCRIPTION
  58
  59
  60 =head1 METHODS
  61
  62 =begin testing
  63
  64 ok (require RT::Transactions);
  65
  66 =end testing
  67
  68 =cut
  69
  70
  71 package RT::Transactions;
  72
  73 use strict;
  74 no warnings qw(redefine);
  75
  76 # {{{ sub _Init
  77 sub _Init   {
  78   my $self = shift;
  79
  80   $self->{'table'} = "Transactions";
  81   $self->{'primary_key'} = "id";
  82
  83   # By default, order by the date of the transaction, rather than ID.
  84   $self->OrderByCols( { FIELD => 'Created',
  85                         ORDER => 'ASC' },
  86                       { FIELD => 'id',
  87                         ORDER => 'ASC' } );
  88
  89   return ( $self->SUPER::_Init(@_));
  90 }
  91 # }}}
  92
  93 =head2 Limit
  94
  95 A wrapper around SUPER::Limit to catch migration issues
  96
  97 =cut
  98
  99 sub Limit {
 100         my $self = shift;
 101         my %args = (@_);
 102
 103         if ($args{'FIELD'} eq 'Ticket') {
 104                 Carp::cluck("Historical code calling RT::Transactions::Limit with a 'Ticket' at (". join(":",caller).").  This deprecated API will be deleted in 3.6");
 105                 $self->SUPER::Limit(FIELD => 'ObjectType', OPERATOR => '=', VALUE =>'RT::Ticket');
 106                 $args{'FIELD'} = 'ObjectId';
 107                 $self->SUPER::Limit(%args);
 108
 109         } else {
 110
 111                 $self->SUPER::Limit(%args);
 112         }
 113
 114
 115 }
 116
 117
 118
 119 =head2 LimitToTicket TICKETID
 120
 121 Find only transactions for the ticket whose id is TICKETID.
 122
 123 This includes tickets merged into TICKETID.
 124
 125 Repeated calls to this method will intelligently limit down to that set of tickets, joined with an OR
 126
 127
 128 =cut
 129
 130
 131 sub LimitToTicket {
 132     my $self = shift;
 133     my $tid  = shift;
 134
 135     unless ( $self->{'tickets_table'} ) {
 136         $self->{'tickets_table'} ||= $self->NewAlias('Tickets');
 137         $self->Join(
 138             ALIAS1 => 'main',
 139             FIELD1 => 'ObjectId',
 140             ALIAS2 => $self->{'tickets_table'},
 141             FIELD2 => 'id'
 142         );
 143         $self->Limit(
 144             FIELD => 'ObjectType',
 145             VALUE => 'RT::Ticket',
 146         );
 147     }
 148     $self->Limit(
 149         ALIAS           => $self->{tickets_table},
 150         FIELD           => 'EffectiveId',
 151         OPERATOR        => '=',
 152         ENTRYAGGREGATOR => 'OR',
 153         VALUE           => $tid,
 154     );
 155
 156 }
 157
 158
 159 # {{{ sub Next
 160 sub Next {
 161     my $self = shift;
 162
 163     my $Transaction = $self->SUPER::Next();
 164     if ((defined($Transaction)) and (ref($Transaction))) {
 165         # If the user can see the transaction's type, then they can
 166         #  see the transaction and we should hand it back.
 167         if ($Transaction->Type) {
 168             return($Transaction);
 169         }
 170
 171         #If the user doesn't have the right to show this ticket
 172         else {
 173             return($self->Next());
 174         }
 175     }
 176
 177     #if there never was any ticket
 178     else {
 179         return(undef);
 180     }
 181 }
 182 # }}}
 183
 184
 185
 186 1;
 187