diff options
Diffstat (limited to 'rt/lib/RT/Link.pm')
| -rw-r--r-- | rt/lib/RT/Link.pm | 313 |
1 files changed, 227 insertions, 86 deletions
diff --git a/rt/lib/RT/Link.pm b/rt/lib/RT/Link.pm index 1aff5ef64..b26f5643c 100644 --- a/rt/lib/RT/Link.pm +++ b/rt/lib/RT/Link.pm @@ -2,7 +2,7 @@ # # COPYRIGHT: # -# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC +# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC # <sales@bestpractical.com> # # (Except where explicitly superseded by other copyright notices) @@ -46,86 +46,246 @@ # # END BPS TAGGED BLOCK }}} -# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>) -# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. -# -# !! DO NOT EDIT THIS FILE !! -# - -use strict; - - =head1 NAME -RT::Link - + RT::Link - an RT Link object =head1 SYNOPSIS + use RT::Link; + =head1 DESCRIPTION +This module should never be called directly by client code. it's an internal module which +should only be accessed through exported APIs in Ticket other similar objects. + =head1 METHODS + + =cut + package RT::Link; -use RT::Record; +use strict; +use warnings; + + + +use base 'RT::Record'; + +sub Table {'Links'} +use Carp; +use RT::URI; + + + +=head2 Create PARAMHASH -use vars qw( @ISA ); -@ISA= qw( RT::Record ); +Create a new link object. Takes 'Base', 'Target' and 'Type'. +Returns undef on failure or a Link Id on success. -sub _Init { - my $self = shift; +=cut - $self->Table('Links'); - $self->SUPER::_Init(@_); +sub Create { + my $self = shift; + my %args = ( Base => undef, + Target => undef, + Type => undef, + @_ ); + + my $base = RT::URI->new( $self->CurrentUser ); + $base->FromURI( $args{'Base'} ); + + unless ( $base->Resolver && $base->Scheme ) { + my $msg = $self->loc("Couldn't resolve base '[_1]' into a URI.", + $args{'Base'}); + $RT::Logger->warning( "$self $msg" ); + + if (wantarray) { + return(undef, $msg); + } else { + return (undef); + } + } + + my $target = RT::URI->new( $self->CurrentUser ); + $target->FromURI( $args{'Target'} ); + + unless ( $target->Resolver ) { + my $msg = $self->loc("Couldn't resolve target '[_1]' into a URI.", + $args{'Target'}); + $RT::Logger->warning( "$self $msg" ); + + if (wantarray) { + return(undef, $msg); + } else { + return (undef); + } + } + + my $base_id = 0; + my $target_id = 0; + + + + + if ( $base->IsLocal ) { + my $object = $base->Object; + unless (UNIVERSAL::can($object, 'Id')) { + return (undef, $self->loc("[_1] appears to be a local object, but can't be found in the database", $args{'Base'})); + + } + $base_id = $object->Id if UNIVERSAL::isa($object, 'RT::Ticket'); + } + if ( $target->IsLocal ) { + my $object = $target->Object; + unless (UNIVERSAL::can($object, 'Id')) { + return (undef, $self->loc("[_1] appears to be a local object, but can't be found in the database", $args{'Target'})); + + } + $target_id = $object->Id if UNIVERSAL::isa($object, 'RT::Ticket'); + } + + # We don't want references to ourself + if ( $base->URI eq $target->URI ) { + return ( 0, $self->loc("Can't link a ticket to itself") ); + } + + # }}} + + my ( $id, $msg ) = $self->SUPER::Create( Base => $base->URI, + Target => $target->URI, + LocalBase => $base_id, + LocalTarget => $target_id, + Type => $args{'Type'} ); + return ( $id, $msg ); } + # sub LoadByParams + +=head2 LoadByParams + Load an RT::Link object from the database. Takes three parameters + + Base => undef, + Target => undef, + Type =>undef + + Base and Target are expected to be integers which refer to Tickets or URIs + Type is the link type +=cut +sub LoadByParams { + my $self = shift; + my %args = ( Base => undef, + Target => undef, + Type => undef, + @_ ); -=head2 Create PARAMHASH + my $base = RT::URI->new($self->CurrentUser); + $base->FromURI( $args{'Base'} ); -Create takes a hash of values and creates a row in the database: + my $target = RT::URI->new($self->CurrentUser); + $target->FromURI( $args{'Target'} ); + + unless ($base->Resolver && $target->Resolver) { + return ( 0, $self->loc("Couldn't load link") ); + } + + + my ( $id, $msg ) = $self->LoadByCols( Base => $base->URI, + Type => $args{'Type'}, + Target => $target->URI ); + + unless ($id) { + return ( 0, $self->loc("Couldn't load link") ); + } +} + + +=head2 Load + + Load an RT::Link object from the database. Takes one parameter, the id of an entry in the links table. - varchar(240) 'Base'. - varchar(240) 'Target'. - varchar(20) 'Type'. - int(11) 'LocalTarget'. - int(11) 'LocalBase'. =cut +sub Load { + my $self = shift; + my $identifier = shift; -sub Create { + + if ( $identifier !~ /^\d+$/ ) { + return ( 0, $self->loc("That's not a numerical id") ); + } + else { + my ( $id, $msg ) = $self->LoadById($identifier); + unless ( $self->Id ) { + return ( 0, $self->loc("Couldn't load link") ); + } + return ( $id, $msg ); + } +} + + + + +=head2 TargetURI + +returns an RT::URI object for the "Target" of this link. + +=cut + +sub TargetURI { my $self = shift; - my %args = ( - Base => '', - Target => '', - Type => '', - LocalTarget => '0', - LocalBase => '0', - - @_); - $self->SUPER::Create( - Base => $args{'Base'}, - Target => $args{'Target'}, - Type => $args{'Type'}, - LocalTarget => $args{'LocalTarget'}, - LocalBase => $args{'LocalBase'}, -); + my $URI = RT::URI->new($self->CurrentUser); + $URI->FromURI($self->Target); + return ($URI); +} + + +=head2 TargetObj +=cut + +sub TargetObj { + my $self = shift; + return $self->TargetURI->Object; } +=head2 BaseURI + +returns an RT::URI object for the "Base" of this link. + +=cut + +sub BaseURI { + my $self = shift; + my $URI = RT::URI->new($self->CurrentUser); + $URI->FromURI($self->Base); + return ($URI); +} + + +=head2 BaseObj + +=cut + +sub BaseObj { + my $self = shift; + return $self->BaseURI->Object; +} + =head2 id -Returns the current value of id. +Returns the current value of id. (In the database, id is stored as int(11).) @@ -134,7 +294,7 @@ Returns the current value of id. =head2 Base -Returns the current value of Base. +Returns the current value of Base. (In the database, Base is stored as varchar(240).) @@ -142,7 +302,7 @@ Returns the current value of Base. =head2 SetBase VALUE -Set Base to VALUE. +Set Base to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Base will be stored as a varchar(240).) @@ -152,7 +312,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 Target -Returns the current value of Target. +Returns the current value of Target. (In the database, Target is stored as varchar(240).) @@ -160,7 +320,7 @@ Returns the current value of Target. =head2 SetTarget VALUE -Set Target to VALUE. +Set Target to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Target will be stored as a varchar(240).) @@ -170,7 +330,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 Type -Returns the current value of Type. +Returns the current value of Type. (In the database, Type is stored as varchar(20).) @@ -178,7 +338,7 @@ Returns the current value of Type. =head2 SetType VALUE -Set Type to VALUE. +Set Type to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Type will be stored as a varchar(20).) @@ -188,7 +348,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 LocalTarget -Returns the current value of LocalTarget. +Returns the current value of LocalTarget. (In the database, LocalTarget is stored as int(11).) @@ -196,7 +356,7 @@ Returns the current value of LocalTarget. =head2 SetLocalTarget VALUE -Set LocalTarget to VALUE. +Set LocalTarget to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, LocalTarget will be stored as a int(11).) @@ -206,7 +366,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 LocalBase -Returns the current value of LocalBase. +Returns the current value of LocalBase. (In the database, LocalBase is stored as int(11).) @@ -214,7 +374,7 @@ Returns the current value of LocalBase. =head2 SetLocalBase VALUE -Set LocalBase to VALUE. +Set LocalBase to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, LocalBase will be stored as a int(11).) @@ -224,7 +384,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 LastUpdatedBy -Returns the current value of LastUpdatedBy. +Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).) @@ -233,7 +393,7 @@ Returns the current value of LastUpdatedBy. =head2 LastUpdated -Returns the current value of LastUpdated. +Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.) @@ -242,7 +402,7 @@ Returns the current value of LastUpdated. =head2 Creator -Returns the current value of Creator. +Returns the current value of Creator. (In the database, Creator is stored as int(11).) @@ -251,7 +411,7 @@ Returns the current value of Creator. =head2 Created -Returns the current value of Created. +Returns the current value of Created. (In the database, Created is stored as datetime.) @@ -261,26 +421,26 @@ Returns the current value of Created. sub _CoreAccessible { { - + id => {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, - Base => + Base => {read => 1, write => 1, sql_type => 12, length => 240, is_blob => 0, is_numeric => 0, type => 'varchar(240)', default => ''}, - Target => + Target => {read => 1, write => 1, sql_type => 12, length => 240, is_blob => 0, is_numeric => 0, type => 'varchar(240)', default => ''}, - Type => + Type => {read => 1, write => 1, sql_type => 12, length => 20, is_blob => 0, is_numeric => 0, type => 'varchar(20)', default => ''}, - LocalTarget => + LocalTarget => {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, - LocalBase => + LocalBase => {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, - LastUpdatedBy => + LastUpdatedBy => {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, - LastUpdated => + LastUpdated => {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, - Creator => + Creator => {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, - Created => + Created => {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, } @@ -288,23 +448,4 @@ sub _CoreAccessible { RT::Base->_ImportOverlays(); -=head1 SEE ALSO - -This class allows "overlay" methods to be placed -into the following files _Overlay is for a System overlay by the original author, -_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations. - -These overlay files can contain new subs or subs to replace existing subs in this module. - -Each of these files should begin with the line - - no warnings qw(redefine); - -so that perl does not kick and scream when you redefine a subroutine or variable in your overlay. - -RT::Link_Overlay, RT::Link_Vendor, RT::Link_Local - -=cut - - 1; |