rt/lib/RT/Links.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2012 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 = RT::Links->new($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 use warnings;
  72
  73
  74 use RT::Link;
  75
  76 use base 'RT::SearchBuilder';
  77
  78 sub Table { 'Links'}
  79
  80
  81 use RT::URI;
  82
  83 sub Limit  {
  84     my $self = shift;
  85     my %args = ( ENTRYAGGREGATOR => 'AND',
  86                  OPERATOR => '=',
  87                  @_);
  88
  89     # If we're limiting by target, order by base
  90     # (Order by the thing that's changing)
  91
  92     if ( ($args{'FIELD'} eq 'Target') or
  93          ($args{'FIELD'} eq 'LocalTarget') ) {
  94         $self->OrderBy (ALIAS => 'main',
  95                         FIELD => 'Base',
  96                         ORDER => 'ASC');
  97     }
  98     elsif ( ($args{'FIELD'} eq 'Base') or
  99             ($args{'FIELD'} eq 'LocalBase') ) {
 100         $self->OrderBy (ALIAS => 'main',
 101                         FIELD => 'Target',
 102                         ORDER => 'ASC');
 103     }
 104
 105
 106     $self->SUPER::Limit(%args);
 107 }
 108
 109
 110 =head2 LimitRefersTo URI
 111
 112 find all things that refer to URI
 113
 114 =cut
 115
 116 sub LimitRefersTo {
 117     my $self = shift;
 118     my $URI = shift;
 119
 120     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 121     $self->Limit(FIELD => 'Target', VALUE => $URI);
 122 }
 123
 124
 125 =head2 LimitReferredToBy URI
 126
 127 find all things that URI refers to
 128
 129 =cut
 130
 131 sub LimitReferredToBy {
 132     my $self = shift;
 133     my $URI = shift;
 134
 135     $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
 136     $self->Limit(FIELD => 'Base', VALUE => $URI);
 137 }
 138
 139 # }}}
 140
 141 =head2 NewItem
 142
 143 Returns an empty new RT::Link item
 144
 145 =cut
 146
 147 sub NewItem {
 148     my $self = shift;
 149     return(RT::Link->new($self->CurrentUser));
 150 }
 151
 152 sub AddRecord {
 153     my $self = shift;
 154     my $record = shift;
 155     return unless $self->IsValidLink($record);
 156
 157     push @{$self->{'items'}}, $record;
 158     $self->{'rows'}++;
 159 }
 160
 161 =head2 IsValidLink
 162
 163 if linked to a local ticket and is deleted, then the link is invalid.
 164
 165 =cut
 166
 167 sub IsValidLink {
 168     my $self = shift;
 169     my $link = shift;
 170
 171     return unless $link && ref $link && $link->Target && $link->Base;
 172
 173     # Skip links to local objects thast are deleted
 174     return
 175       if $link->TargetURI->IsLocal
 176           && ( UNIVERSAL::isa( $link->TargetObj, "RT::Ticket" )
 177               && $link->TargetObj->__Value('status') eq "deleted"
 178               || UNIVERSAL::isa( $link->BaseObj, "RT::Ticket" )
 179               && $link->BaseObj->__Value('status') eq "deleted" );
 180
 181     return 1;
 182 }
 183
 184 RT::Base->_ImportOverlays();
 185
 186 1;