rt/lib/RT/Links_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46
  47 =head1 NAME
  48
  49   RT::Links - A collection of Link objects
  50
  51 =head1 SYNOPSIS
  52
  53   use RT::Links;
  54   my $links = new RT::Links($CurrentUser);
  55
  56 =head1 DESCRIPTION
  57
  58
  59 =head1 METHODS
  60
  61
  62 =begin testing
  63
  64 ok (require RT::Links);
  65
  66 =end testing
  67
  68 =cut
  69
  70
  71 package RT::Links;
  72
  73 use strict;
  74 no warnings qw(redefine);
  75 use RT::URI;
  76
  77 # {{{ sub Limit
  78 sub Limit  {
  79     my $self = shift;
  80     my %args = ( ENTRYAGGREGATOR => 'AND',
  81                  OPERATOR => '=',
  82                  @_);
  83
  84     #if someone's trying to search for tickets, try to resolve the uris for searching.
  85
  86     if (  ( $args{'OPERATOR'} eq '=') and
  87           ( $args{'FIELD'}  eq 'Base') or ($args{'FIELD'} eq 'Target')
  88        ) {
  89           my $dummy = RT::URI->new($self->CurrentUser);
  90            $dummy->FromURI($args{'VALUE'});
  91            # $uri = $dummy->URI;
  92     }
  93
  94
  95     # If we're limiting by target, order by base
  96     # (Order by the thing that's changing)
  97
  98     if ( ($args{'FIELD'} eq 'Target') or
  99          ($args{'FIELD'} eq 'LocalTarget') ) {
 100         $self->OrderBy (ALIAS => 'main',
 101                         FIELD => 'Base',
 102                         ORDER => 'ASC');
 103     }
 104     elsif ( ($args{'FIELD'} eq 'Base') or
 105             ($args{'FIELD'} eq 'LocalBase') ) {
 106         $self->OrderBy (ALIAS => 'main',
 107                         FIELD => 'Target',
 108                         ORDER => 'ASC');
 109     }
 110
 111
 112     $self->SUPER::Limit(%args);
 113 }
 114 # }}}
 115
 116 # {{{ LimitRefersTo
 117
 118 =head2 LimitRefersTo URI
 119
 120 find all things that refer to URI
 121
 122 =cut
 123
 124 sub LimitRefersTo {
 125     my $self = shift;
 126     my $URI = shift;
 127
 128     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 129     $self->Limit(FIELD => 'Target', VALUE => $URI);
 130 }
 131
 132 # }}}
 133 # {{{ LimitReferredToBy
 134
 135 =head2 LimitReferredToBy URI
 136
 137 find all things that URI refers to
 138
 139 =cut
 140
 141 sub LimitReferredToBy {
 142     my $self = shift;
 143     my $URI = shift;
 144
 145     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 146     $self->Limit(FIELD => 'Base', VALUE => $URI);
 147 }
 148
 149 # }}}
 150
 151
 152 # {{{ Next
 153 sub Next {
 154     my $self = shift;
 155
 156     my $Link = $self->SUPER::Next();
 157     return $Link unless $Link && ref $Link;
 158
 159     # Skip links to local objects thast are deleted
 160     if ( $Link->TargetURI->IsLocal and UNIVERSAL::isa($Link->TargetObj,"RT::Ticket")
 161              and $Link->TargetObj->__Value('status') eq "deleted") {
 162         return $self->Next;
 163     } elsif ($Link->BaseURI->IsLocal   and UNIVERSAL::isa($Link->BaseObj,"RT::Ticket")
 164              and $Link->BaseObj->__Value('status') eq "deleted") {
 165         return $self->Next;
 166     } else {
 167         return $Link;
 168     }
 169 }
 170
 171 # }}}
 172 1;
 173