rt/lib/RT/URI.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 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 package RT::URI;
  50
  51 use strict;
  52 use base 'RT::Base';
  53
  54 use RT::URI::base;
  55 use Carp;
  56
  57 =head1 NAME
  58
  59 RT::URI
  60
  61 =head1 DESCRIPTION
  62
  63 This class provides a base class for URIs, such as those handled
  64 by RT::Link objects.
  65
  66 =head1 API
  67
  68
  69
  70 =cut
  71
  72
  73
  74
  75 =head2 new
  76
  77 Create a new RT::URI object.
  78
  79 =cut
  80
  81
  82 sub new {
  83     my $proto = shift;
  84     my $class = ref($proto) || $proto;
  85     my $self  = {};
  86     bless( $self, $class );
  87
  88     $self->CurrentUser(@_);
  89
  90     return ($self);
  91 }
  92
  93
  94
  95 # {{{ FromObject
  96
  97 =head2 FromObject <Object>
  98
  99 Given a local object, such as an RT::Ticket or an RT::FM::Article, this routine will return a URI for
 100 the local object
 101
 102 =cut
 103
 104 sub FromObject {
 105     my $self = shift;
 106     my $obj = shift;
 107
 108     return undef unless  $obj->can('URI');
 109     return $self->FromURI($obj->URI);
 110 }
 111
 112 # }}}
 113
 114 # {{{ FromURI
 115
 116 =head2 FromURI <URI>
 117
 118 Returns a local object id for this content. You are expected to know
 119 what sort of object this is the Id of
 120
 121 Returns true if everything is ok, otherwise false
 122
 123 =cut
 124
 125 sub FromURI {
 126     my $self = shift;
 127     my $uri = shift;
 128
 129     return undef unless ($uri);
 130
 131     my $scheme;
 132     # Special case: integers passed in as URIs must be ticket ids
 133     if ($uri =~ /^(\d+)$/) {
 134         $scheme = "fsck.com-rt";
 135     } elsif ($uri =~ /^((?:\w|\.|-)+?):/) {
 136         $scheme = $1;
 137     }
 138     else {
 139         $RT::Logger->warning("Could not determine a URI scheme for $uri");
 140         return (undef);
 141     }
 142
 143     # load up a resolver object for this scheme
 144     $self->_GetResolver($scheme);
 145
 146     unless ($self->Resolver->ParseURI($uri)) {
 147         $RT::Logger->warning( "Resolver "
 148               . ref( $self->Resolver )
 149               . " could not parse $uri, maybe Organization config was changed?"
 150         );
 151         $self->{resolver} = RT::URI::base->new( $self->CurrentUser ); # clear resolver
 152         return (undef);
 153     }
 154
 155     return(1);
 156
 157 }
 158
 159 # }}}
 160
 161 # {{{ _GetResolver
 162
 163 =head2 _GetResolver <scheme>
 164
 165 Gets an RT URI resolver for the scheme <scheme>.
 166 Falls back to a null resolver. RT::URI::base.
 167
 168 =cut
 169
 170 sub _GetResolver {
 171     my $self = shift;
 172     my $scheme = shift;
 173
 174     $scheme =~ s/(\.|-)/_/g;
 175     my $resolver;
 176
 177
 178     eval "
 179         require RT::URI::$scheme;
 180         \$resolver = RT::URI::$scheme->new(\$self->CurrentUser);
 181     ";
 182
 183     if ($resolver) {
 184         $self->{'resolver'} = $resolver;
 185     } else {
 186         $self->{'resolver'} = RT::URI::base->new($self->CurrentUser);
 187     }
 188
 189 }
 190
 191 # }}}
 192
 193 # {{{ Scheme
 194
 195 =head2 Scheme
 196
 197 Returns a local object id for this content.  You are expected to know
 198 what sort of object this is the Id of
 199
 200 =cut
 201
 202 sub Scheme {
 203     my $self = shift;
 204     return ($self->Resolver->Scheme);
 205
 206 }
 207 # }}}
 208 # {{{ URI
 209
 210 =head2 URI
 211
 212 Returns a local object id for this content.  You are expected to know what sort of object this is the Id
 213 of
 214
 215 =cut
 216
 217 sub URI {
 218     my $self = shift;
 219     return ($self->Resolver->URI);
 220
 221 }
 222 # }}}
 223
 224 # {{{ Object
 225
 226 =head2 Object
 227
 228 Returns a local object for this content. This will usually be an RT::Ticket or somesuch
 229
 230 =cut
 231
 232
 233 sub Object {
 234     my $self = shift;
 235     return($self->Resolver->Object);
 236
 237 }
 238
 239
 240 # }}}
 241
 242 # {{{ IsLocal
 243
 244 =head2 IsLocal
 245
 246 Returns a local object for this content. This will usually be an RT::Ticket or somesuch
 247
 248 =cut
 249
 250 sub IsLocal {
 251     my $self = shift;
 252     return $self->Resolver->IsLocal;
 253 }
 254
 255
 256 # }}}
 257
 258 =head2 AsHREF
 259
 260
 261 =cut
 262
 263
 264 sub AsHREF {
 265     my $self = shift;
 266     return $self->Resolver->HREF;
 267 }
 268
 269 =head2 Resolver
 270
 271 Returns this URI's URI resolver object
 272
 273 =cut
 274
 275
 276 sub Resolver {
 277     my $self =shift;
 278     return ($self->{'resolver'});
 279 }
 280
 281 RT::Base->_ImportOverlays();
 282
 283 1;