rt/lib/RT/Links_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::Links - A collection of Link objects
  51
  52 =head1 SYNOPSIS
  53
  54   use RT::Links;
  55   my $links = new RT::Links($CurrentUser);
  56
  57 =head1 DESCRIPTION
  58
  59
  60 =head1 METHODS
  61
  62
  63 =begin testing
  64
  65 ok (require RT::Links);
  66
  67 =end testing
  68
  69 =cut
  70
  71
  72 package RT::Links;
  73
  74 use strict;
  75 no warnings qw(redefine);
  76 use RT::URI;
  77
  78 # {{{ sub Limit
  79 sub Limit  {
  80     my $self = shift;
  81     my %args = ( ENTRYAGGREGATOR => 'AND',
  82                  OPERATOR => '=',
  83                  @_);
  84
  85     #if someone's trying to search for tickets, try to resolve the uris for searching.
  86
  87     if (  ( $args{'OPERATOR'} eq '=') and
  88           ( $args{'FIELD'}  eq 'Base') or ($args{'FIELD'} eq 'Target')
  89        ) {
  90           my $dummy = RT::URI->new($self->CurrentUser);
  91            $dummy->FromURI($args{'VALUE'});
  92            # $uri = $dummy->URI;
  93     }
  94
  95
  96     # If we're limiting by target, order by base
  97     # (Order by the thing that's changing)
  98
  99     if ( ($args{'FIELD'} eq 'Target') or
 100          ($args{'FIELD'} eq 'LocalTarget') ) {
 101         $self->OrderBy (ALIAS => 'main',
 102                         FIELD => 'Base',
 103                         ORDER => 'ASC');
 104     }
 105     elsif ( ($args{'FIELD'} eq 'Base') or
 106             ($args{'FIELD'} eq 'LocalBase') ) {
 107         $self->OrderBy (ALIAS => 'main',
 108                         FIELD => 'Target',
 109                         ORDER => 'ASC');
 110     }
 111
 112
 113     $self->SUPER::Limit(%args);
 114 }
 115 # }}}
 116
 117 # {{{ LimitRefersTo
 118
 119 =head2 LimitRefersTo URI
 120
 121 find all things that refer to URI
 122
 123 =cut
 124
 125 sub LimitRefersTo {
 126     my $self = shift;
 127     my $URI = shift;
 128
 129     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 130     $self->Limit(FIELD => 'Target', VALUE => $URI);
 131 }
 132
 133 # }}}
 134 # {{{ LimitReferredToBy
 135
 136 =head2 LimitReferredToBy URI
 137
 138 find all things that URI refers to
 139
 140 =cut
 141
 142 sub LimitReferredToBy {
 143     my $self = shift;
 144     my $URI = shift;
 145
 146     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 147     $self->Limit(FIELD => 'Base', VALUE => $URI);
 148 }
 149
 150 # }}}
 151
 152
 153 # {{{ Next
 154 sub Next {
 155     my $self = shift;
 156
 157     my $Link = $self->SUPER::Next();
 158     return $Link unless $Link && ref $Link;
 159
 160     # Skip links to local objects thast are deleted
 161     if ( $Link->TargetURI->IsLocal and UNIVERSAL::isa($Link->TargetObj,"RT::Ticket")
 162              and $Link->TargetObj->__Value('status') eq "deleted") {
 163         return $self->Next;
 164     } elsif ($Link->BaseURI->IsLocal   and UNIVERSAL::isa($Link->BaseObj,"RT::Ticket")
 165              and $Link->BaseObj->__Value('status') eq "deleted") {
 166         return $self->Next;
 167     } else {
 168         return $Link;
 169     }
 170 }
 171
 172 # }}}
 173 1;
 174