diff options
Diffstat (limited to 'rt/lib/RT/URI.pm')
| -rw-r--r-- | rt/lib/RT/URI.pm | 271 |
1 files changed, 271 insertions, 0 deletions
diff --git a/rt/lib/RT/URI.pm b/rt/lib/RT/URI.pm new file mode 100644 index 000000000..fdbe63bea --- /dev/null +++ b/rt/lib/RT/URI.pm @@ -0,0 +1,271 @@ +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC +# <jesse@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. +# +# 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., 675 Mass Ave, Cambridge, MA 02139, USA. +# +# +# 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 RT::URI::base; +use Carp; + +=head1 NAME + +RT::URI + +=head1 DESCRIPTION + +This class provides a base class for URIs, such as those handled +by RT::Link objects. + +=head1 API + + + +=cut + + + + +=head2 new + +Create a new RT::URI object. + +=cut + + +sub new { + my $proto = shift; + my $class = ref($proto) || $proto; + my $self = {}; + bless( $self, $class ); + + $self->CurrentUser(@_); + + return ($self); +} + + + +# {{{ 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 +the local object + +=cut + +sub FromObject { + my $self = shift; + my $obj = shift; + + return undef unless $obj->can('URI'); + return $self->FromURI($obj->URI); +} + +# }}} + +# {{{ FromURI + +=head2 FromURI <URI> + +Returns a local object id for this content. You are expected to know +what sort of object this is the Id of + +Returns true if everything is ok, otherwise false + +=cut + +sub FromURI { + my $self = 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; + } + else { + $RT::Logger->warning("$self Could not determine a URI scheme for $uri"); + return (undef); + } + + # 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); + } + +return(1); + +} + +# }}} + +# {{{ _GetResolver + +=private _GetResolver <scheme> + +Gets an RT URI resolver for the scheme <scheme>. +Falls back to a null resolver. RT::URI::base. + +=cut + +sub _GetResolver { + my $self = shift; + my $scheme = shift; + + $scheme =~ s/(\.|-)/_/g; + my $resolver; + + + eval " + require RT::URI::$scheme; + \$resolver = RT::URI::$scheme->new(\$self->CurrentUser); + "; + + if ($resolver) { + $self->{'resolver'} = $resolver; + } else { + $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 + +=cut + +sub Scheme { + my $self = shift; + return ($self->Resolver->Scheme); + +} +# }}} +# {{{ URI + +=head2 URI + +Returns a local object id for this content. You are expected to know what sort of object this is the Id +of + +=cut + +sub URI { + my $self = shift; + return ($self->Resolver->URI); + +} +# }}} + +# {{{ Object + +=head2 Object + +Returns a local object for this content. This will usually be an RT::Ticket or somesuch + +=cut + + +sub Object { + my $self = shift; + return($self->Resolver->Object); + +} + + +# }}} + +# {{{ IsLocal + +=head2 IsLocal + +Returns a local object for this content. This will usually be an RT::Ticket or somesuch + +=cut + +sub IsLocal { + my $self = shift; + return $self->Resolver->IsLocal; +} + + +# }}} + + +=head Resolver + +Returns this URI's URI resolver object + +=cut + + +sub Resolver { + my $self =shift; + 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}); + +1; |