rt/lib/RT/URI/base.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
   6 #                                          <jesse@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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  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.)
  35 #
  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.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46 package RT::URI::base;
  47
  48 use strict;
  49 use base qw(RT::Base);
  50
  51 =head1 NAME
  52
  53 RT::URI::base
  54
  55 =head1 DESCRIPTION
  56
  57 A baseclass (and fallback) RT::URI handler. Every URI handler needs to
  58 handle the API presented here
  59
  60 =cut
  61
  62
  63 =head1 API
  64
  65 =head2 new
  66
  67 Create a new URI handler
  68
  69 =cut
  70
  71 sub new {
  72     my $proto = shift;
  73     my $class = ref($proto) || $proto;
  74     my $self  = {};
  75     bless( $self, $class );
  76     $self->CurrentUser(@_);
  77     return ($self);
  78 }
  79
  80 sub ParseObject  {
  81     my $self = shift;
  82     my $obj = shift;
  83     $self->{'uri'} = "unknown-object:".ref($obj);
  84 }
  85
  86 sub ParseURI {
  87     my $self = shift;
  88     my $uri = shift;
  89
  90     if ($uri =~  /^(.*?):/) {
  91         $self->{'scheme'} = $1;
  92     }
  93     $self->{'uri'} = $uri;
  94
  95
  96 }
  97
  98
  99 sub Object {
 100     my $self = shift;
 101     return undef;
 102
 103 }
 104
 105 sub URI {
 106     my $self = shift;
 107     return($self->{'uri'});
 108 }
 109
 110 sub Scheme {
 111     my $self = shift;
 112     return($self->{'scheme'});
 113
 114 }
 115
 116 sub HREF {
 117     my $self = shift;
 118     return($self->{'href'} || $self->{'uri'});
 119 }
 120
 121 sub IsLocal {
 122     my $self = shift;
 123     return undef;
 124 }
 125
 126 =head2 AsString
 127
 128 Return a "pretty" string representing the URI object.
 129
 130 This is meant to be used like this:
 131
 132  % $re = $uri->Resolver;
 133  <A HREF="<% $re->HREF %>"><% $re->AsString %></A>
 134
 135 =cut
 136
 137 sub AsString {
 138     my $self = shift;
 139     return $self->URI;
 140 }
 141
 142 eval "require RT::URI::base_Vendor";
 143 die $@ if ($@ && $@ !~ qr{^Can't locate RT/URI/base_Vendor.pm});
 144 eval "require RT::URI::base_Local";
 145 die $@ if ($@ && $@ !~ qr{^Can't locate RT/URI/base_Local.pm});
 146
 147 1;