Upgrade to 4.2.8
[usit-rt.git] / lib / RT / URI / fsck_com_article.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2014 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::fsck_com_article;
50
51 use strict;
52 use warnings;
53 no warnings 'redefine';
54
55 use base qw/RT::URI::base/;
56 use RT::Article;
57
58 =head2 LocalURIPrefix 
59
60 Returns the prefix for a local article URI
61
62 =cut
63
64 sub LocalURIPrefix {
65     my $self = shift;
66     my $prefix = $self->Scheme. "://". RT->Config->Get('Organization');
67     return ($prefix);
68 }
69
70 =head2 URIForObject RT::article
71
72 Returns the RT URI for a local RT::article object
73
74 =cut
75
76 sub URIForObject {
77
78     my $self = shift;
79
80     my $obj = shift;
81     return ($self->LocalURIPrefix . "/article/" . $obj->Id);
82 }
83
84
85 =head2 ParseObject $ArticleObj
86
87 When handed an L<RT::Article> object, figure out its URI
88
89 =cut
90
91 =head2 ParseURI URI
92
93 When handed an fsck.com-article URI, figures out things like whether its a local article
94 and what its ID is
95
96 =cut
97
98 sub ParseURI { 
99     my $self = shift;
100     my $uri = shift;
101
102     my $article;
103
104     if ($uri =~ /^(\d+)$/) {
105         $article = RT::Article->new($self->CurrentUser);
106         $article->Load($uri);
107         $self->{'uri'} = $article->URI;
108     }
109     else {
110         $self->{'uri'} = $uri;
111     }
112
113        #If it's a local URI, load the article object and return its URI
114     if ( $self->IsLocal) {
115         my $local_uri_prefix = $self->LocalURIPrefix;
116         if ($self->{'uri'} =~ /^$local_uri_prefix\/article\/(\d+)$/) {
117             my $id = $1;
118             $article = RT::Article->new( $self->CurrentUser );
119             my ($ret, $msg) = $article->Load($id);
120
121             #If we couldn't find a article, return undef.
122             unless ( $article and $article->Id ) {
123                 # We got an id, but couldn't load it, so warn that it may
124                 # have been deleted.
125                 RT::Logger->warning("Unable to load article for id $id. It may"
126                     . " have been deleted: $msg");
127                 return undef;
128             }
129         } else {
130             return undef;
131         }
132     }
133
134     #If we couldn't find a article, return undef.
135     unless ( $article and $article->Id ) {
136         return undef;
137     }
138
139     $self->{'object'} = $article;
140     return ($article->Id);
141 }
142
143 =head2 IsLocal 
144
145 Returns true if this URI is for a local article.
146 Returns undef otherwise.
147
148 =cut
149
150 sub IsLocal {
151     my $self = shift;
152     my $local_uri_prefix = $self->LocalURIPrefix;
153     if ($self->{'uri'} =~ /^$local_uri_prefix/) {
154         return 1;
155     }
156     else {
157         return undef;
158     }
159 }
160
161
162
163 =head2 Object
164
165 Returns the object for this URI, if it's local. Otherwise returns undef.
166
167 =cut
168
169 sub Object {
170     my $self = shift;
171     return ($self->{'object'});
172
173 }
174
175 =head2 Scheme
176
177 Return the URI scheme for RT articles
178
179 =cut
180
181 sub Scheme {
182     my $self = shift;
183     return "fsck.com-article";
184 }
185
186 =head2 HREF
187
188 If this is a local article, return an HTTP url to it.
189 Otherwise, return its URI
190
191 =cut
192
193 sub HREF {
194     my $self = shift;
195     if ($self->IsLocal && $self->Object) {
196         return ( RT->Config->Get('WebURL') . "Articles/Article/Display.html?id=".$self->Object->Id);
197     }   
198     else {
199         return ($self->URI);
200     }
201 }
202
203 =head2 AsString
204
205 Return "Article 23"
206
207 =cut
208
209 sub AsString {
210     my $self = shift;
211     if ($self->IsLocal && ( my $object = $self->Object )) {
212         if ( $object->Name ) {
213             return $self->loc('Article #[_1]: [_2]', $object->id, $object->Name);
214         } else {
215             return $self->loc('Article #[_1]', $object->id);
216         }
217     } else {
218         return $self->SUPER::AsString(@_);
219     }
220
221 }
222
223
224 1;