# BEGIN BPS TAGGED BLOCK {{{
-#
+#
# COPYRIGHT:
-#
-# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC
-# <jesse@bestpractical.com>
-#
+#
+# This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC
+# <sales@bestpractical.com>
+#
# (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.
-#
+#
# 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/copyleft/gpl.html.
-#
-#
+# 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
# 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 }}}
-# 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 !!
#
+# END BPS TAGGED BLOCK }}}
+
+=head1 NAME
+
+ 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.
+
+=cut
+
+
+package RT::Link;
use strict;
+use warnings;
+
+
+
+use base 'RT::Record';
+
+sub Table {'Links'}
+use Carp;
+use RT::URI;
+use List::Util 'first';
+use List::MoreUtils 'uniq';
+
+# Helper tables for links mapping to make it easier
+# to build and parse links between objects.
+our %TYPEMAP = (
+ MemberOf => { Type => 'MemberOf', Mode => 'Target', Display => 0 },
+ Parents => { Type => 'MemberOf', Mode => 'Target', Display => 1 },
+ Parent => { Type => 'MemberOf', Mode => 'Target', Display => 0 },
+ Members => { Type => 'MemberOf', Mode => 'Base', Display => 0 },
+ Member => { Type => 'MemberOf', Mode => 'Base', Display => 0 },
+ Children => { Type => 'MemberOf', Mode => 'Base', Display => 1 },
+ Child => { Type => 'MemberOf', Mode => 'Base', Display => 0 },
+ HasMember => { Type => 'MemberOf', Mode => 'Base', Display => 0 },
+ RefersTo => { Type => 'RefersTo', Mode => 'Target', Display => 1 },
+ ReferredToBy => { Type => 'RefersTo', Mode => 'Base', Display => 1 },
+ DependsOn => { Type => 'DependsOn', Mode => 'Target', Display => 1 },
+ DependedOnBy => { Type => 'DependsOn', Mode => 'Base', Display => 1 },
+ MergedInto => { Type => 'MergedInto', Mode => 'Target', Display => 1 },
+);
+our %DIRMAP = (
+ MemberOf => { Base => 'MemberOf', Target => 'HasMember' },
+ RefersTo => { Base => 'RefersTo', Target => 'ReferredToBy' },
+ DependsOn => { Base => 'DependsOn', Target => 'DependedOnBy' },
+ MergedInto => { Base => 'MergedInto', Target => 'MergedInto' },
+);
+__PACKAGE__->_BuildDisplayAs;
+
+my %DISPLAY_AS;
+sub _BuildDisplayAs {
+ %DISPLAY_AS = ();
+ foreach my $in_db ( uniq map { $_->{Type} } values %TYPEMAP ) {
+ foreach my $mode (qw(Base Target)) {
+ $DISPLAY_AS{$in_db}{$mode} = first {
+ $TYPEMAP{$_}{Display}
+ && $TYPEMAP{$_}{Type} eq $in_db
+ && $TYPEMAP{$_}{Mode} eq $mode
+ } keys %TYPEMAP;
+ }
+ }
+}
-=head1 NAME
+=head1 CLASS METHODS
-RT::Link
+=head2 DisplayTypes
+Returns a list of the standard link Types for display, including directional
+variants but not aliases.
-=head1 SYNOPSIS
+=cut
-=head1 DESCRIPTION
+sub DisplayTypes {
+ sort { $a cmp $b }
+ uniq
+ grep { defined }
+ map { values %$_ }
+ values %DISPLAY_AS
+}
=head1 METHODS
+=head2 Create PARAMHASH
+
+Create a new link object. Takes 'Base', 'Target' and 'Type'.
+Returns undef on failure or a Link Id on success.
+
=cut
-package RT::Link;
-use RT::Record;
+sub Create {
+ my $self = shift;
+ my %args = ( Base => undef,
+ Target => undef,
+ Type => undef,
+ @_ );
+
+ my $base = RT::URI->new( $self->CurrentUser );
+ unless ($base->FromURI( $args{'Base'} )) {
+ my $msg = $self->loc("Couldn't resolve base '[_1]' into a URI.", $args{'Base'});
+ $RT::Logger->warning( "$self $msg" );
+ return wantarray ? (undef, $msg) : undef;
+ }
+
+ my $target = RT::URI->new( $self->CurrentUser );
+ unless ($target->FromURI( $args{'Target'} )) {
+ my $msg = $self->loc("Couldn't resolve target '[_1]' into a URI.", $args{'Target'});
+ $RT::Logger->warning( "$self $msg" );
+ return wantarray ? (undef, $msg) : 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
-use vars qw( @ISA );
-@ISA= qw( RT::Record );
+=head2 LoadByParams
-sub _Init {
- my $self = shift;
+ 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
- $self->Table('Links');
- $self->SUPER::_Init(@_);
+sub LoadByParams {
+ my $self = shift;
+ my %args = ( Base => undef,
+ Target => undef,
+ Type => undef,
+ @_ );
+
+ my $base = RT::URI->new($self->CurrentUser);
+ $base->FromURI( $args{'Base'} )
+ or return wantarray ? (0, $self->loc("Couldn't parse Base URI: [_1]", $args{Base})) : 0;
+
+ my $target = RT::URI->new($self->CurrentUser);
+ $target->FromURI( $args{'Target'} )
+ or return wantarray ? (0, $self->loc("Couldn't parse Target URI: [_1]", $args{Target})) : 0;
+
+ my ( $id, $msg ) = $self->LoadByCols( Base => $base->URI,
+ Type => $args{'Type'},
+ Target => $target->URI );
+
+ unless ($id) {
+ return wantarray ? ( 0, $self->loc("Couldn't load link: [_1]", $msg) ) : 0;
+ } else {
+ return wantarray ? ($id, $msg) : $id;
+ }
}
+=head2 Load
+
+ Load an RT::Link object from the database. Takes one parameter, the id of an entry in the links table.
+
+
+=cut
+
+sub Load {
+ my $self = shift;
+ my $identifier = shift;
+
+
+
+
+ if ( $identifier !~ /^\d+$/ ) {
+ return wantarray ? ( 0, $self->loc("That's not a numerical id") ) : 0;
+ }
+ else {
+ my ( $id, $msg ) = $self->LoadById($identifier);
+ unless ( $self->Id ) {
+ return wantarray ? ( 0, $self->loc("Couldn't load link") ) : 0;
+ }
+ return wantarray ? ( $id, $msg ) : $id;
+ }
+}
-=head2 Create PARAMHASH
-Create takes a hash of values and creates a row in the database:
+=head2 TargetURI
- varchar(240) 'Base'.
- varchar(240) 'Target'.
- varchar(20) 'Type'.
- int(11) 'LocalTarget'.
- int(11) 'LocalBase'.
+returns an RT::URI object for the "Target" of this link.
=cut
+sub TargetURI {
+ my $self = shift;
+ my $URI = RT::URI->new($self->CurrentUser);
+ $URI->FromURI($self->Target);
+ return ($URI);
+}
+=head2 TargetObj
-sub Create {
+=cut
+
+sub TargetObj {
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'},
-);
+ 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).)
=head2 Base
-Returns the current value of Base.
+Returns the current value of Base.
(In the database, Base is stored as varchar(240).)
=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).)
=head2 Target
-Returns the current value of Target.
+Returns the current value of Target.
(In the database, Target is stored as varchar(240).)
=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).)
=head2 Type
-Returns the current value of Type.
+Returns the current value of Type.
(In the database, Type is stored as varchar(20).)
=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).)
=head2 LocalTarget
-Returns the current value of LocalTarget.
+Returns the current value of LocalTarget.
(In the database, LocalTarget is stored as int(11).)
=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).)
=head2 LocalBase
-Returns the current value of LocalBase.
+Returns the current value of LocalBase.
(In the database, LocalBase is stored as int(11).)
=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).)
=head2 LastUpdatedBy
-Returns the current value of LastUpdatedBy.
+Returns the current value of LastUpdatedBy.
(In the database, LastUpdatedBy is stored as int(11).)
=head2 LastUpdated
-Returns the current value of LastUpdated.
+Returns the current value of LastUpdated.
(In the database, LastUpdated is stored as datetime.)
=head2 Creator
-Returns the current value of Creator.
+Returns the current value of Creator.
(In the database, Creator is stored as int(11).)
=head2 Created
-Returns the current value of Created.
+Returns the current value of Created.
(In the database, Created is stored as datetime.)
sub _CoreAccessible {
{
-
+
id =>
- {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''},
- Base =>
- {read => 1, write => 1, sql_type => 12, length => 240, is_blob => 0, is_numeric => 0, type => 'varchar(240)', default => ''},
- Target =>
- {read => 1, write => 1, sql_type => 12, length => 240, is_blob => 0, is_numeric => 0, type => 'varchar(240)', default => ''},
- Type =>
- {read => 1, write => 1, sql_type => 12, length => 20, is_blob => 0, is_numeric => 0, type => 'varchar(20)', default => ''},
- LocalTarget =>
- {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
- LocalBase =>
- {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
- LastUpdatedBy =>
- {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
- LastUpdated =>
- {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
- Creator =>
- {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
- Created =>
- {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
+ {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''},
+ Base =>
+ {read => 1, write => 1, sql_type => 12, length => 240, is_blob => 0, is_numeric => 0, type => 'varchar(240)', default => ''},
+ Target =>
+ {read => 1, write => 1, sql_type => 12, length => 240, is_blob => 0, is_numeric => 0, type => 'varchar(240)', default => ''},
+ Type =>
+ {read => 1, write => 1, sql_type => 12, length => 20, is_blob => 0, is_numeric => 0, type => 'varchar(20)', default => ''},
+ LocalTarget =>
+ {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
+ LocalBase =>
+ {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
+ LastUpdatedBy =>
+ {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
+ LastUpdated =>
+ {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
+ Creator =>
+ {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
+ Created =>
+ {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
}
};
+sub FindDependencies {
+ my $self = shift;
+ my ($walker, $deps) = @_;
- eval "require RT::Link_Overlay";
- if ($@ && $@ !~ qr{^Can't locate RT/Link_Overlay.pm}) {
- die $@;
- };
-
- eval "require RT::Link_Vendor";
- if ($@ && $@ !~ qr{^Can't locate RT/Link_Vendor.pm}) {
- die $@;
- };
-
- eval "require RT::Link_Local";
- if ($@ && $@ !~ qr{^Can't locate RT/Link_Local.pm}) {
- die $@;
- };
-
-
-
-
-=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.
+ $self->SUPER::FindDependencies($walker, $deps);
-These overlay files can contain new subs or subs to replace existing subs in this module.
+ $deps->Add( out => $self->BaseObj ) if $self->BaseObj and $self->BaseObj->id;
+ $deps->Add( out => $self->TargetObj ) if $self->TargetObj and $self->TargetObj->id;
+}
-Each of these files should begin with the line
+sub __DependsOn {
+ my $self = shift;
+ my %args = (
+ Shredder => undef,
+ Dependencies => undef,
+ @_,
+ );
+ my $deps = $args{'Dependencies'};
+ my $list = [];
+
+# AddLink transactions
+ my $map = { %RT::Link::TYPEMAP };
+ my $link_meta = $map->{ $self->Type };
+ unless ( $link_meta && $link_meta->{'Mode'} && $link_meta->{'Type'} ) {
+ RT::Shredder::Exception->throw( 'Wrong link link_meta, no record for '. $self->Type );
+ }
+ if ( $self->BaseURI->IsLocal ) {
+ my $objs = $self->BaseObj->Transactions;
+ $objs->Limit(
+ FIELD => 'Type',
+ OPERATOR => '=',
+ VALUE => 'AddLink',
+ );
+ $objs->Limit( FIELD => 'NewValue', VALUE => $self->Target );
+ while ( my ($k, $v) = each %$map ) {
+ next unless $v->{'Type'} eq $link_meta->{'Type'};
+ next unless $v->{'Mode'} eq $link_meta->{'Mode'};
+ $objs->Limit( FIELD => 'Field', VALUE => $k );
+ }
+ push( @$list, $objs );
+ }
+
+ my %reverse = ( Base => 'Target', Target => 'Base' );
+ if ( $self->TargetURI->IsLocal ) {
+ my $objs = $self->TargetObj->Transactions;
+ $objs->Limit(
+ FIELD => 'Type',
+ OPERATOR => '=',
+ VALUE => 'AddLink',
+ );
+ $objs->Limit( FIELD => 'NewValue', VALUE => $self->Base );
+ while ( my ($k, $v) = each %$map ) {
+ next unless $v->{'Type'} eq $link_meta->{'Type'};
+ next unless $v->{'Mode'} eq $reverse{ $link_meta->{'Mode'} };
+ $objs->Limit( FIELD => 'Field', VALUE => $k );
+ }
+ push( @$list, $objs );
+ }
+
+ $deps->_PushDependencies(
+ BaseObject => $self,
+ Flags => RT::Shredder::Constants::DEPENDS_ON|RT::Shredder::Constants::WIPE_AFTER,
+ TargetObjects => $list,
+ Shredder => $args{'Shredder'}
+ );
+ return $self->SUPER::__DependsOn( %args );
+}
- no warnings qw(redefine);
+sub Serialize {
+ my $self = shift;
+ my %args = (@_);
+ my %store = $self->SUPER::Serialize(@_);
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+ delete $store{LocalBase} if $store{Base};
+ delete $store{LocalTarget} if $store{Target};
+ return %store;
+}
-RT::Link_Overlay, RT::Link_Vendor, RT::Link_Local
-=cut
+sub PreInflate {
+ my $class = shift;
+ my ($importer, $uid, $data) = @_;
+
+ for my $dir (qw/Base Target/) {
+ my $uid_ref = $data->{$dir};
+ next unless $uid_ref and ref $uid_ref;
+
+ my $to_uid = ${ $uid_ref };
+ my $obj = $importer->LookupObj( $to_uid );
+ if ($obj) {
+ $data->{$dir} = $obj->URI;
+ $data->{"Local$dir"} = $obj->Id if $obj->isa("RT::Ticket");
+ } else {
+ $data->{$dir} = "";
+ $importer->Postpone(
+ for => $to_uid,
+ uid => $uid,
+ uri => $dir,
+ column => ($to_uid =~ /RT::Ticket/ ? "Local$dir" : undef),
+ );
+ }
+
+ }
+
+ return $class->SUPER::PreInflate( $importer, $uid, $data );
+}
+RT::Base->_ImportOverlays();
1;
projects / freeside.git / blobdiff