rt/lib/RT/URI/base.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::base;
  50
  51 use strict;
  52 use base qw(RT::Base);
  53
  54 =head1 NAME
  55
  56 RT::URI::base
  57
  58 =head1 DESCRIPTION
  59
  60 A baseclass (and fallback) RT::URI handler. Every URI handler needs to
  61 handle the API presented here
  62
  63 =cut
  64
  65
  66 =head1 API
  67
  68 =head2 new
  69
  70 Create a new URI handler
  71
  72 =cut
  73
  74 sub new {
  75     my $proto = shift;
  76     my $class = ref($proto) || $proto;
  77     my $self  = {};
  78     bless( $self, $class );
  79     $self->CurrentUser(@_);
  80     return ($self);
  81 }
  82
  83 sub ParseObject  {
  84     my $self = shift;
  85     my $obj = shift;
  86     $self->{'uri'} = "unknown-object:".ref($obj);
  87 }
  88
  89 sub ParseURI {
  90     my $self = shift;
  91     my $uri = shift;
  92
  93     if ($uri =~  /^(.*?):/) {
  94         $self->{'scheme'} = $1;
  95     }
  96     $self->{'uri'} = $uri;
  97
  98
  99 }
 100
 101
 102 sub Object {
 103     my $self = shift;
 104     return undef;
 105
 106 }
 107
 108 sub URI {
 109     my $self = shift;
 110     return($self->{'uri'});
 111 }
 112
 113 sub Scheme {
 114     my $self = shift;
 115     return($self->{'scheme'});
 116
 117 }
 118
 119 sub HREF {
 120     my $self = shift;
 121     return($self->{'href'} || $self->{'uri'});
 122 }
 123
 124 sub IsLocal {
 125     my $self = shift;
 126     return undef;
 127 }
 128
 129 =head2 AsString
 130
 131 Return a "pretty" string representing the URI object.
 132
 133 This is meant to be used like this:
 134
 135  % $re = $uri->Resolver;
 136  <A HREF="<% $re->HREF %>"><% $re->AsString %></A>
 137
 138 =cut
 139
 140 sub AsString {
 141     my $self = shift;
 142     return $self->URI;
 143 }
 144
 145 RT::Base->_ImportOverlays();
 146
 147 1;