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