rt/lib/RT/Links_Overlay.pm

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