rt 4.2.14 (#13852)
[freeside.git] / rt / lib / RT / Links.pm
index 7a1773a..d2ecca2 100644 (file)
-# BEGIN LICENSE BLOCK
-# 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-# 
-# (Except where explictly superceded by other copyright notices)
-# 
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
 # This work is made available to you under the terms of Version 2 of
 # the GNU General Public License. A copy of that license should have
 # been provided with this software, but in any event can be snarfed
 # from www.gnu.org.
-# 
+#
 # This work is distributed in the hope that it will be useful, but
 # WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 # General Public License for more details.
-# 
-# Unless otherwise specified, all modifications, corrections or
-# extensions to this work which alter its source code become the
-# property of Best Practical Solutions, LLC when submitted for
-# inclusion in the work.
-# 
-# 
-# END LICENSE BLOCK
-# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
-# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.  
-# 
-# !! DO NOT EDIT THIS FILE !!
 #
-
-use strict;
-
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
 
 =head1 NAME
 
-  RT::Links -- Class Description
+  RT::Links - A collection of Link objects
+
 =head1 SYNOPSIS
 
-  use RT::Links
+  use RT::Links;
+  my $links = RT::Links->new($CurrentUser);
 
 =head1 DESCRIPTION
 
 
 =head1 METHODS
 
+
+
 =cut
 
+
 package RT::Links;
 
-use RT::SearchBuilder;
-use RT::Link;
+use strict;
+use warnings;
 
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
+use base 'RT::SearchBuilder';
 
+use RT::Link;
+
+sub Table { 'Links'}
 
-sub _Init {
-    my $self = shift;
-    $self->{'table'} = 'Links';
-    $self->{'primary_key'} = 'id';
 
+use RT::URI;
 
-    return ( $self->SUPER::_Init(@_) );
+sub Limit  {
+    my $self = shift;
+    my %args = ( ENTRYAGGREGATOR => 'AND',
+                 OPERATOR => '=',
+                 @_);
+
+    # If we're limiting by target, order by base
+    # (Order by the thing that's changing)
+
+    if ( ($args{'FIELD'} eq 'Target') or
+         ($args{'FIELD'} eq 'LocalTarget') ) {
+        $self->OrderByCols(
+            { ALIAS => 'main', FIELD => 'LocalBase', ORDER => 'ASC' },
+            { ALIAS => 'main', FIELD => 'Base', ORDER => 'ASC' },
+        );
+    }
+    elsif ( ($args{'FIELD'} eq 'Base') or
+            ($args{'FIELD'} eq 'LocalBase') ) {
+        $self->OrderByCols(
+            { ALIAS => 'main', FIELD => 'LocalTarget', ORDER => 'ASC' },
+            { ALIAS => 'main', FIELD => 'Target', ORDER => 'ASC' },
+        );
+    }
+
+
+    $self->SUPER::Limit(%args);
 }
 
 
-=item NewItem
+=head2 LimitRefersTo URI
 
-Returns an empty new RT::Link item
+find all things that refer to URI
 
 =cut
 
-sub NewItem {
+sub LimitRefersTo {
     my $self = shift;
-    return(RT::Link->new($self->CurrentUser));
+    my $URI = shift;
+
+    $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
+    $self->Limit(FIELD => 'Target', VALUE => $URI);
 }
 
-        eval "require RT::Links_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/Links_Overlay.pm}) {
-            die $@;
-        };
 
-        eval "require RT::Links_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/Links_Vendor.pm}) {
-            die $@;
-        };
+=head2 LimitReferredToBy URI
+
+find all things that URI refers to
+
+=cut
 
-        eval "require RT::Links_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/Links_Local.pm}) {
-            die $@;
-        };
+sub LimitReferredToBy {
+    my $self = shift;
+    my $URI = shift;
 
+    $self->Limit(FIELD => 'Type', VALUE => 'RefersTo');
+    $self->Limit(FIELD => 'Base', VALUE => $URI);
+}
 
+# }}}
 
+sub AddRecord {
+    my $self = shift;
+    my $record = shift;
+    return unless $self->IsValidLink($record);
 
-=head1 SEE ALSO
+    push @{$self->{'items'}}, $record;
+}
 
-This class allows "overlay" methods to be placed
-into the following files _Overlay is for a System overlay by the original author,
-_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.  
+=head2 IsValidLink
 
-These overlay files can contain new subs or subs to replace existing subs in this module.
+if linked to a local ticket and is deleted, then the link is invalid.
 
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line 
+=cut
 
-   no warnings qw(redefine);
+sub IsValidLink {
+    my $self = shift;
+    my $link = shift;
 
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+    return unless $link && ref $link && $link->Target && $link->Base;
 
-RT::Links_Overlay, RT::Links_Vendor, RT::Links_Local
+    # Skip links to local objects thast are deleted
+    return
+      if $link->TargetURI->IsLocal
+          && ( UNIVERSAL::isa( $link->TargetObj, "RT::Ticket" )
+              && $link->TargetObj->__Value('status') eq "deleted"
+              || UNIVERSAL::isa( $link->BaseObj, "RT::Ticket" )
+              && $link->BaseObj->__Value('status') eq "deleted" );
 
-=cut
+    return 1;
+}
 
+RT::Base->_ImportOverlays();
 
 1;