import torrus 1.0.9
[freeside.git] / rt / lib / RT / URI.pm
index 7acc1dc..70654e1 100644 (file)
@@ -1,8 +1,14 @@
-# BEGIN LICENSE BLOCK
+# BEGIN BPS TAGGED BLOCK {{{
 # 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
+# COPYRIGHT:
 # 
-# (Except where explictly superceded by other copyright notices)
+# This software is Copyright (c) 1996-2009 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
 # 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.
+# 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 LICENSE BLOCK
-package RT::URI;;
+# END BPS TAGGED BLOCK }}}
+
+package RT::URI;
 
 use strict;
-use vars qw/@ISA/;
-@ISA = qw(RT::Base);
+use base 'RT::Base';
 
 use RT::URI::base;
 use Carp;
@@ -91,8 +115,10 @@ sub FromObject {
 
 =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 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
 
@@ -102,16 +128,16 @@ sub FromURI {
 
     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 =~ /^((?:\w|\.|-)+?):/) {
+       $scheme = $1;
     }
     else {
-        $RT::Logger->warning("$self Could not determine a URI scheme for $uri");
-               return (undef);
+        $RT::Logger->warning("Could not determine a URI scheme for $uri");
+        return (undef);
     }
      
     # load up a resolver object for this scheme  
@@ -119,16 +145,19 @@ sub FromURI {
     
     unless ($self->Resolver->ParseURI($uri)) {
         $RT::Logger->warning("Resolver ".ref($self->Resolver)." could not parse $uri");
+        $self->{resolver} = RT::URI::base->new( $self->CurrentUser ); # clear resolver
        return (undef);
     }
 
+    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.
@@ -143,16 +172,16 @@ sub _GetResolver {
     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 {
         $self->{'resolver'} = RT::URI::base->new($self->CurrentUser); 
-        }
+    }
 
 }
 
@@ -162,8 +191,8 @@ sub _GetResolver {
 
 =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
 
@@ -223,8 +252,18 @@ sub IsLocal {
 
 # }}}
 
+=head2 AsHREF
+
+
+=cut
+
+
+sub AsHREF {
+    my $self = shift;
+    return $self->Resolver->HREF;
+}
 
-=head Resolver
+=head2 Resolver
 
 Returns this URI's URI resolver object