rt/lib/RT/Links.pm

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