-# 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
-package RT::URI;;
+#
+# 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 }}}
+
+package RT::URI;
use strict;
-use vars qw/@ISA/;
-@ISA = qw(RT::Base);
+use warnings;
+use base 'RT::Base';
use RT::URI::base;
use Carp;
return ($self);
}
+=head2 CanonicalizeURI <URI>
+Returns the canonical form of the given URI by calling L</FromURI> and then L</URI>.
+
+If the URI is unparseable by FromURI the passed in URI is simply returned untouched.
+
+=cut
+
+sub CanonicalizeURI {
+ my $self = shift;
+ my $uri = shift;
+ if ($self->FromURI($uri)) {
+ my $canonical = $self->URI;
+ if ($canonical and $uri ne $canonical) {
+ RT->Logger->debug("Canonicalizing URI '$uri' to '$canonical'");
+ $uri = $canonical;
+ }
+ }
+ return $uri;
+}
-# {{{ FromObject
=head2 FromObject <Object>
-Given a local object, such as an RT::Ticket or an RT::FM::Article, this routine will return a URI for
+Given a local object, such as an RT::Ticket or an RT::Article, this routine will return a URI for
the local object
=cut
return $self->FromURI($obj->URI);
}
-# }}}
-# {{{ FromURI
=head2 FromURI <URI>
sub FromURI {
my $self = shift;
- my $uri = shift;
+ my $uri = shift;
return undef unless ($uri);
- my $scheme;
- # Special case: integers passed in as URIs must be ticket ids
- if ($uri =~ /^(\d+)$/) {
- $scheme = "fsck.com-rt";
- } elsif ($uri =~ /^((?:\w|\.|-)+?):/) {
- $scheme = $1;
+ my $scheme;
+ # Special case: integers passed in as URIs must be ticket ids
+ if ($uri =~ /^(\d+)$/) {
+ $scheme = "fsck.com-rt";
+ } elsif ($uri =~ /^((?!javascript|data)(?:\w|\.|-)+?):/i) {
+ $scheme = $1;
}
else {
- $RT::Logger->warning("$self Could not determine a URI scheme for $uri");
- return (undef);
+ $self->{resolver} = RT::URI::base->new( $self->CurrentUser ); # clear resolver
+ $RT::Logger->warning("Could not determine a URI scheme for $uri");
+ return (undef);
}
-
- # load up a resolver object for this scheme
+
+ # load up a resolver object for this scheme
$self->_GetResolver($scheme);
-
+
unless ($self->Resolver->ParseURI($uri)) {
- $RT::Logger->warning("Resolver ".ref($self->Resolver)." could not parse $uri");
- $self->{resolver} = undef; # clear resolver
- return (undef);
+ $RT::Logger->warning( "Resolver "
+ . ref( $self->Resolver )
+ . " could not parse $uri, maybe Organization config was changed?"
+ );
+ $self->{resolver} = RT::URI::base->new( $self->CurrentUser ); # clear resolver
+ return (undef);
}
-return(1);
+ return(1);
}
-# }}}
-# {{{ _GetResolver
-=private _GetResolver <scheme>
+=head2 _GetResolver <scheme>
Gets an RT URI resolver for the scheme <scheme>.
Falls back to a null resolver. RT::URI::base.
my $resolver;
- eval "
- require RT::URI::$scheme;
- \$resolver = RT::URI::$scheme->new(\$self->CurrentUser);
- ";
+ eval "
+ require RT::URI::$scheme;
+ \$resolver = RT::URI::$scheme->new(\$self->CurrentUser);
+ ";
- if ($resolver) {
+ if ($resolver) {
$self->{'resolver'} = $resolver;
- } else {
+ } else {
+ RT->Logger->warning("Failed to create new resolver object for scheme '$scheme': $@")
+ if $@ !~ m{Can't locate RT/URI/\Q$scheme\E};
$self->{'resolver'} = RT::URI::base->new($self->CurrentUser);
- }
+ }
}
-# }}}
-# {{{ Scheme
=head2 Scheme
-Returns a local object id for this content. You are expected to know what sort of object this is the Id
-of
+Returns a local object id for this content. You are expected to know
+what sort of object this is the Id of
=cut
return ($self->Resolver->Scheme);
}
-# }}}
-# {{{ URI
=head2 URI
return ($self->Resolver->URI);
}
-# }}}
-# {{{ Object
=head2 Object
}
-# }}}
-# {{{ IsLocal
=head2 IsLocal
}
-# }}}
+=head2 AsHREF
+
+
+=cut
+
+
+sub AsHREF {
+ my $self = shift;
+ return $self->Resolver->HREF;
+}
-=head Resolver
+=head2 Resolver
Returns this URI's URI resolver object
return ($self->{'resolver'});
}
-eval "require RT::URI_Vendor";
-die $@ if ($@ && $@ !~ qr{^Can't locate RT/URI_Vendor.pm});
-eval "require RT::URI_Local";
-die $@ if ($@ && $@ !~ qr{^Can't locate RT/URI_Local.pm});
+=head2 AsString
+
+Returns a friendly display form of the object if Local, or the full URI
+
+=cut
+
+sub AsString {
+ my $self = shift;
+ return $self->Resolver->AsString;
+}
+
+RT::Base->_ImportOverlays();
1;