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