rt/lib/RT/Links_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2009 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/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     #if someone's trying to search for tickets, try to resolve the uris for searching.
  82
  83     if (  ( $args{'OPERATOR'} eq '=') and
  84           ( $args{'FIELD'}  eq 'Base') or ($args{'FIELD'} eq 'Target')
  85        ) {
  86           my $dummy = RT::URI->new($self->CurrentUser);
  87            $dummy->FromURI($args{'VALUE'});
  88            # $uri = $dummy->URI;
  89     }
  90
  91
  92     # If we're limiting by target, order by base
  93     # (Order by the thing that's changing)
  94
  95     if ( ($args{'FIELD'} eq 'Target') or
  96          ($args{'FIELD'} eq 'LocalTarget') ) {
  97         $self->OrderBy (ALIAS => 'main',
  98                         FIELD => 'Base',
  99                         ORDER => 'ASC');
 100     }
 101     elsif ( ($args{'FIELD'} eq 'Base') or
 102             ($args{'FIELD'} eq 'LocalBase') ) {
 103         $self->OrderBy (ALIAS => 'main',
 104                         FIELD => 'Target',
 105                         ORDER => 'ASC');
 106     }
 107
 108
 109     $self->SUPER::Limit(%args);
 110 }
 111 # }}}
 112
 113 # {{{ LimitRefersTo
 114
 115 =head2 LimitRefersTo URI
 116
 117 find all things that refer to URI
 118
 119 =cut
 120
 121 sub LimitRefersTo {
 122     my $self = shift;
 123     my $URI = shift;
 124
 125     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 126     $self->Limit(FIELD => 'Target', VALUE => $URI);
 127 }
 128
 129 # }}}
 130 # {{{ LimitReferredToBy
 131
 132 =head2 LimitReferredToBy URI
 133
 134 find all things that URI refers to
 135
 136 =cut
 137
 138 sub LimitReferredToBy {
 139     my $self = shift;
 140     my $URI = shift;
 141
 142     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 143     $self->Limit(FIELD => 'Base', VALUE => $URI);
 144 }
 145
 146 # }}}
 147
 148
 149 # {{{ Next
 150 sub Next {
 151     my $self = shift;
 152
 153     my $Link = $self->SUPER::Next();
 154     return $Link unless $Link && ref $Link;
 155
 156     # skip very invalid Link records
 157     unless ($Link->Target && $Link->Base) {
 158         return $self->Next;
 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