1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
64 This class provides a base class for URIs, such as those handled
78 Create a new RT::URI object.
85 my $class = ref($proto) || $proto;
87 bless( $self, $class );
89 $self->CurrentUser(@_);
94 =head2 CanonicalizeURI <URI>
96 Returns the canonical form of the given URI by calling L</FromURI> and then L</URI>.
98 If the URI is unparseable by FromURI the passed in URI is simply returned untouched.
102 sub CanonicalizeURI {
105 if ($self->FromURI($uri)) {
106 my $canonical = $self->URI;
107 if ($canonical and $uri ne $canonical) {
108 RT->Logger->debug("Canonicalizing URI '$uri' to '$canonical'");
116 =head2 FromObject <Object>
118 Given a local object, such as an RT::Ticket or an RT::Article, this routine will return a URI for
127 return undef unless $obj->can('URI');
128 return $self->FromURI($obj->URI);
135 Returns a local object id for this content. You are expected to know
136 what sort of object this is the Id of
138 Returns true if everything is ok, otherwise false
146 return undef unless ($uri);
149 # Special case: integers passed in as URIs must be ticket ids
150 if ($uri =~ /^(\d+)$/) {
151 $scheme = "fsck.com-rt";
152 } elsif ($uri =~ /^((?!javascript|data)(?:\w|\.|-)+?):/i) {
156 $self->{resolver} = RT::URI::base->new( $self->CurrentUser ); # clear resolver
157 $RT::Logger->warning("Could not determine a URI scheme for $uri");
161 # load up a resolver object for this scheme
162 $self->_GetResolver($scheme);
164 unless ($self->Resolver->ParseURI($uri)) {
165 $RT::Logger->warning( "Resolver "
166 . ref( $self->Resolver )
167 . " could not parse $uri, maybe Organization config was changed?"
169 $self->{resolver} = RT::URI::base->new( $self->CurrentUser ); # clear resolver
179 =head2 _GetResolver <scheme>
181 Gets an RT URI resolver for the scheme <scheme>.
182 Falls back to a null resolver. RT::URI::base.
190 $scheme =~ s/(\.|-)/_/g;
195 require RT::URI::$scheme;
196 \$resolver = RT::URI::$scheme->new(\$self->CurrentUser);
200 $self->{'resolver'} = $resolver;
202 $self->{'resolver'} = RT::URI::base->new($self->CurrentUser);
211 Returns a local object id for this content. You are expected to know
212 what sort of object this is the Id of
218 return ($self->Resolver->Scheme);
224 Returns a local object id for this content. You are expected to know what sort of object this is the Id
231 return ($self->Resolver->URI);
238 Returns a local object for this content. This will usually be an RT::Ticket or somesuch
245 return($self->Resolver->Object);
254 Returns a local object for this content. This will usually be an RT::Ticket or somesuch
260 return $self->Resolver->IsLocal;
273 return $self->Resolver->HREF;
278 Returns this URI's URI resolver object
285 return ($self->{'resolver'});
288 RT::Base->_ImportOverlays();