X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FURI%2Ffsck_com_rt.pm;h=053268f9eeb94dc38b73f56651c0d623183f395d;hp=36e8f82fdd19e43960544db4a1a04cc5f2e34b95;hb=9aee669886202be7035e6c6049fc71bc99dd3013;hpb=945721f48f74d5cfffef7c7cf3a3d6bc2521f5dd diff --git a/rt/lib/RT/URI/fsck_com_rt.pm b/rt/lib/RT/URI/fsck_com_rt.pm index 36e8f82fd..053268f9e 100644 --- a/rt/lib/RT/URI/fsck_com_rt.pm +++ b/rt/lib/RT/URI/fsck_com_rt.pm @@ -1,161 +1,148 @@ -# BEGIN LICENSE BLOCK -# -# Copyright (c) 1996-2003 Jesse Vincent -# -# (Except where explictly superceded by other copyright notices) -# +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC +# +# +# (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 # been provided with this software, but in any event can be snarfed # from www.gnu.org. -# +# # This work is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # 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. -# -# -# END LICENSE BLOCK -package RT::URI::fsck_com_rt; - -use RT::Ticket; - -use RT::URI::base; +# +# 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 BPS TAGGED BLOCK }}} use strict; -use vars qw(@ISA); -@ISA = qw/RT::URI::base/; - - - - -=head2 LocalURIPrefix - -Returns the prefix for a local ticket URI - -=begin testing - -use_ok("RT::URI::fsck_com_rt"); -my $uri = RT::URI::fsck_com_rt->new($RT::SystemUser); - -ok(ref($uri)); - -use Data::Dumper; - - -ok (UNIVERSAL::isa($uri,RT::URI::fsck_com_rt), "It's an RT::URI::fsck_com_rt"); +use warnings; -ok ($uri->isa('RT::URI::base'), "It's an RT::URI::base"); -ok ($uri->isa('RT::Base'), "It's an RT::Base"); - -is ($uri->LocalURIPrefix , 'fsck.com-rt://example.com/ticket/'); - -=end testing +package RT::URI::fsck_com_rt; +use base 'RT::URI::base'; +=head2 LocalURIPrefix +Returns the prefix for a local URI. =cut sub LocalURIPrefix { my $self = shift; - my $prefix = $self->Scheme. "://$RT::Organization/ticket/"; + + my $prefix = $self->Scheme. "://". RT->Config->Get('Organization'); + return ($prefix); } +=head2 ObjectType +=cut +sub ObjectType { + my $self = shift; + my $object = shift || $self->Object; + my $type = 'ticket'; + if (ref($object) && (ref($object) ne 'RT::Ticket')) { + $type = ref($object); + } -=head2 URIForObject RT::Ticket - -Returns the RT URI for a local RT::Ticket object + return ($type); +} -=begin testing -my $ticket = RT::Ticket->new($RT::SystemUser); -$ticket->Load(1); -my $uri = RT::URI::fsck_com_rt->new($ticket->CurrentUser); -is($uri->LocalURIPrefix . "1" , $uri->URIForObject($ticket)); +=head2 URIForObject RT::Record -=end testing +Returns the RT URI for a local RT::Record object =cut sub URIForObject { - my $self = shift; - my $obj = shift; - return ($self->LocalURIPrefix. $obj->Id); + return ($self->LocalURIPrefix ."/". $self->ObjectType($obj) ."/". $obj->Id); } -=head2 ParseObject $TicketObj - -When handed an RT::Ticekt object, figure out its URI +=head2 ParseURI URI +When handed an fsck.com-rt: URI, figures out things like whether its a local record and what its ID is =cut +sub ParseURI { + my $self = shift; + my $uri = shift; + + if ( $uri =~ /^\d+$/ ) { + use RT::Ticket; + my $ticket = RT::Ticket->new( $self->CurrentUser ); + $ticket->Load( $uri ); + $self->{'uri'} = $ticket->URI; + $self->{'object'} = $ticket; + return ($ticket->id); + } + else { + $self->{'uri'} = $uri; + } -=head2 ParseURI URI + #If it's a local URI, load the ticket object and return its URI + if ( $self->IsLocal ) { + my $local_uri_prefix = $self->LocalURIPrefix; + if ( $self->{'uri'} =~ /^\Q$local_uri_prefix\E\/(.*?)\/(\d+)$/i ) { + my $type = $1; + my $id = $2; -When handed an fsck.com-rt: URI, figures out things like whether its a local ticket -and what its ID is + if ( $type eq 'ticket' ) { $type = 'RT::Ticket' } -=cut + # We can instantiate any RT::Record subtype. but not anything else + if ( UNIVERSAL::isa( $type, 'RT::Record' ) ) { + my $record = $type->new( $self->CurrentUser ); + $record->Load($id); -sub ParseURI { - my $self = shift; - my $uri = shift; - - my $ticket; - - if ($uri =~ /^(\d+)$/) { - $ticket = RT::Ticket->new($self->CurrentUser); - $ticket->Load($uri); - $self->{'uri'} = $ticket->URI; - } - else { - $self->{'uri'} = $uri; - } - - - - #If it's a local URI, load the ticket object and return its URI - if ( $self->IsLocal) { - - my $local_uri_prefix = $self->LocalURIPrefix; - if ($self->{'uri'} =~ /^$local_uri_prefix(\d+)$/) { - my $id = $1; - - - $ticket = RT::Ticket->new( $self->CurrentUser ); - $ticket->Load($id); - - #If we couldn't find a ticket, return undef. - unless ( defined $ticket->Id ) { - return undef; - } - } else { - return undef; - } - } - - $self->{'object'} = $ticket; - if ( UNIVERSAL::can( $ticket, 'Id' ) ) { - return ( $ticket->Id ); - } - else { - return undef; + if ( $record->Id ) { + $self->{'object'} = $record; + return ( $record->Id ); + } + } + + } } + return undef; } =head2 IsLocal @@ -163,23 +150,20 @@ sub ParseURI { Returns true if this URI is for a local ticket. Returns undef otherwise. - - =cut sub IsLocal { - my $self = shift; - my $local_uri_prefix = $self->LocalURIPrefix; - if ($self->{'uri'} =~ /^$local_uri_prefix/) { - return 1; + my $self = shift; + my $local_uri_prefix = $self->LocalURIPrefix; + if ( $self->{'uri'} =~ /^\Q$local_uri_prefix/i ) { + return 1; + } + else { + return undef; } - else { - return undef; - } } - =head2 Object Returns the object for this URI, if it's local. Otherwise returns undef. @@ -189,19 +173,18 @@ Returns the object for this URI, if it's local. Otherwise returns undef. sub Object { my $self = shift; return ($self->{'object'}); - } =head2 Scheme -Return the URI scheme for RT tickets +Return the URI scheme for RT records =cut sub Scheme { my $self = shift; - return "fsck.com-rt"; + return "fsck.com-rt"; } =head2 HREF @@ -214,34 +197,44 @@ Otherwise, return its URI sub HREF { my $self = shift; - if ($self->IsLocal) { - return ( $RT::WebURL . "Ticket/Display.html?id=".$self->Object->Id); - } - else { - return ($self->URI); + return $self->URI unless $self->IsLocal; + + my $obj = $self->Object; + if ( $obj && $self->ObjectType eq 'ticket' ) { + return RT->Config->Get('WebURL') ."Ticket/Display.html?id=". $obj->id; } + + return $self->URI; } =head2 AsString -Returns either a localized string 'ticket #23' or the full URI if the object is not local +Returns either a localized string C<#23: Subject> for tickets, C for other object types (not really used), or the full URI if the object +is not local. =cut sub AsString { my $self = shift; - if ($self->IsLocal) { - return $self->loc("ticket #[_1]", $self->Object->Id); - + if ($self->IsLocal && ( my $object = $self->Object )) { + if ($object->isa('RT::Ticket')) { + return $self->loc("#[_1]: [_2]", $object->Id, $object->Subject || ''); + } else { + my $name = $object->_Accessible('Name', 'read') ? $object->Name : undef; + + if ( defined $name and length $name ) { + return $self->loc("[_1] #[_2]: [_3]", $self->ObjectType, $object->Id, $name); + } else { + return $self->loc("[_1] #[_2]", $self->ObjectType, $object->Id); + } + } } else { - return $self->Object->URI; + return $self->URI; } } -eval "require RT::URI::fsck_com_rt_Vendor"; -die $@ if ($@ && $@ !~ qr{^Can't locate RT/URI/fsck_com_rt_Vendor.pm}); -eval "require RT::URI::fsck_com_rt_Local"; -die $@ if ($@ && $@ !~ qr{^Can't locate RT/URI/fsck_com_rt_Local.pm}); +RT::Base->_ImportOverlays(); 1;