1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
6 # <jesse@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., 675 Mass Ave, Cambridge, MA 02139, USA.
28 # CONTRIBUTION SUBMISSION POLICY:
30 # (The following paragraph is not intended to limit the rights granted
31 # to you to modify and distribute this software under the terms of
32 # the GNU General Public License and is only of importance to you if
33 # you choose to contribute your changes and enhancements to the
34 # community by submitting them to Best Practical Solutions, LLC.)
36 # By intentionally submitting any modifications, corrections or
37 # derivatives to this work, or any other work intended for use with
38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
39 # you are the copyright holder for those contributions and you grant
40 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
41 # royalty-free, perpetual, license to use, copy, create derivative
42 # works based on those contributions, and sublicense and distribute
43 # those contributions and any derivatives thereof.
45 # END BPS TAGGED BLOCK }}}
61 This class provides a base class for URIs, such as those handled
75 Create a new RT::URI object.
82 my $class = ref($proto) || $proto;
84 bless( $self, $class );
86 $self->CurrentUser(@_);
95 =head2 FromObject <Object>
97 Given a local object, such as an RT::Ticket or an RT::FM::Article, this routine will return a URI for
106 return undef unless $obj->can('URI');
107 return $self->FromURI($obj->URI);
116 Returns a local object id for this content. You are expected to know
117 what sort of object this is the Id of
119 Returns true if everything is ok, otherwise false
127 return undef unless ($uri);
130 # Special case: integers passed in as URIs must be ticket ids
131 if ($uri =~ /^(\d+)$/) {
132 $scheme = "fsck.com-rt";
133 } elsif ($uri =~ /^((?:\w|\.|-)+?):/) {
137 $RT::Logger->warning("$self Could not determine a URI scheme for $uri");
141 # load up a resolver object for this scheme
142 $self->_GetResolver($scheme);
144 unless ($self->Resolver->ParseURI($uri)) {
145 $RT::Logger->warning("Resolver ".ref($self->Resolver)." could not parse $uri");
146 $self->{resolver} = undef; # clear resolver
158 =private _GetResolver <scheme>
160 Gets an RT URI resolver for the scheme <scheme>.
161 Falls back to a null resolver. RT::URI::base.
169 $scheme =~ s/(\.|-)/_/g;
174 require RT::URI::$scheme;
175 \$resolver = RT::URI::$scheme->new(\$self->CurrentUser);
179 $self->{'resolver'} = $resolver;
181 $self->{'resolver'} = RT::URI::base->new($self->CurrentUser);
192 Returns a local object id for this content. You are expected to know what sort of object this is the Id
199 return ($self->Resolver->Scheme);
207 Returns a local object id for this content. You are expected to know what sort of object this is the Id
214 return ($self->Resolver->URI);
223 Returns a local object for this content. This will usually be an RT::Ticket or somesuch
230 return($self->Resolver->Object);
241 Returns a local object for this content. This will usually be an RT::Ticket or somesuch
247 return $self->Resolver->IsLocal;
256 Returns this URI's URI resolver object
263 return ($self->{'resolver'});
266 eval "require RT::URI_Vendor";
267 die $@ if ($@ && $@ !~ qr{^Can't locate RT/URI_Vendor.pm});
268 eval "require RT::URI_Local";
269 die $@ if ($@ && $@ !~ qr{^Can't locate RT/URI_Local.pm});