rt/lib/RT/Links_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
   6 #                                          <sales@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/licenses/old-licenses/gpl-2.0.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
  49 =head1 NAME
  50
  51   RT::Links - A collection of Link objects
  52
  53 =head1 SYNOPSIS
  54
  55   use RT::Links;
  56   my $links = new RT::Links($CurrentUser);
  57
  58 =head1 DESCRIPTION
  59
  60
  61 =head1 METHODS
  62
  63
  64
  65 =cut
  66
  67
  68 package RT::Links;
  69
  70 use strict;
  71 no warnings qw(redefine);
  72 use RT::URI;
  73
  74 # {{{ sub Limit
  75 sub Limit  {
  76     my $self = shift;
  77     my %args = ( ENTRYAGGREGATOR => 'AND',
  78                  OPERATOR => '=',
  79                  @_);
  80
  81
  82     # If we're limiting by target, order by base
  83     # (Order by the thing that's changing)
  84
  85     if ( ($args{'FIELD'} eq 'Target') or
  86          ($args{'FIELD'} eq 'LocalTarget') ) {
  87         $self->OrderBy (ALIAS => 'main',
  88                         FIELD => 'Base',
  89                         ORDER => 'ASC');
  90     }
  91     elsif ( ($args{'FIELD'} eq 'Base') or
  92             ($args{'FIELD'} eq 'LocalBase') ) {
  93         $self->OrderBy (ALIAS => 'main',
  94                         FIELD => 'Target',
  95                         ORDER => 'ASC');
  96     }
  97
  98
  99     $self->SUPER::Limit(%args);
 100 }
 101 # }}}
 102
 103 # {{{ LimitRefersTo
 104
 105 =head2 LimitRefersTo URI
 106
 107 find all things that refer to URI
 108
 109 =cut
 110
 111 sub LimitRefersTo {
 112     my $self = shift;
 113     my $URI = shift;
 114
 115     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 116     $self->Limit(FIELD => 'Target', VALUE => $URI);
 117 }
 118
 119 # }}}
 120 # {{{ LimitReferredToBy
 121
 122 =head2 LimitReferredToBy URI
 123
 124 find all things that URI refers to
 125
 126 =cut
 127
 128 sub LimitReferredToBy {
 129     my $self = shift;
 130     my $URI = shift;
 131
 132     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 133     $self->Limit(FIELD => 'Base', VALUE => $URI);
 134 }
 135
 136 # }}}
 137
 138
 139 # {{{ Next
 140 sub Next {
 141     my $self = shift;
 142
 143     my $Link = $self->SUPER::Next();
 144     return $Link unless $Link && ref $Link;
 145
 146     # skip very invalid Link records
 147     unless ($Link->Target && $Link->Base) {
 148         return $self->Next;
 149     }
 150     # Skip links to local objects thast are deleted
 151     if ( $Link->TargetURI->IsLocal and UNIVERSAL::isa($Link->TargetObj,"RT::Ticket")
 152              and $Link->TargetObj->__Value('status') eq "deleted") {
 153         return $self->Next;
 154     } elsif ($Link->BaseURI->IsLocal   and UNIVERSAL::isa($Link->BaseObj,"RT::Ticket")
 155              and $Link->BaseObj->__Value('status') eq "deleted") {
 156         return $self->Next;
 157     } else {
 158         return $Link;
 159     }
 160 }
 161
 162 # }}}
 163 1;
 164