lib/RT/Shredder/Dependencies.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::Shredder::Dependencies;
  50
  51 use strict;
  52 use warnings;
  53 use RT::Shredder::Exceptions;
  54 use RT::Shredder::Constants;
  55 use RT::Shredder::Dependency;
  56 use RT::Record;
  57
  58
  59
  60 =head1 METHODS
  61
  62 =head2 new
  63
  64 Creates new empty collection of dependecies.
  65
  66 =cut
  67
  68 sub new
  69 {
  70     my $proto = shift;
  71     my $self = bless( {}, ref $proto || $proto );
  72     $self->{'list'} = [];
  73     return $self;
  74 }
  75
  76 =head2 _PushDependencies
  77
  78 Put in objects into collection.
  79 Takes
  80 BaseObject - any supported object of RT::Record subclass;
  81 Flags - flags that describe relationship between target and base objects;
  82 TargetObjects - any of RT::SearchBuilder or RT::Record subclassed objects
  83 or array ref on list of this objects;
  84 Shredder - RT::Shredder object.
  85
  86 SeeAlso: _PushDependecy, RT::Shredder::Dependency
  87
  88 =cut
  89
  90 sub _PushDependencies
  91 {
  92     my $self = shift;
  93     my %args = ( TargetObjects => undef, Shredder => undef, @_ );
  94     my @objs = $args{'Shredder'}->CastObjectsToRecords( Objects => delete $args{'TargetObjects'} );
  95     $self->_PushDependency( %args, TargetObject => $_ ) foreach @objs;
  96     return;
  97 }
  98
  99 sub _PushDependency
 100 {
 101     my $self = shift;
 102     my %args = (
 103             BaseObject => undef,
 104             Flags => undef,
 105             TargetObject => undef,
 106             Shredder => undef,
 107             @_
 108            );
 109     my $rec = $args{'Shredder'}->PutObject( Object => $args{'TargetObject'} );
 110     return if $rec->{'State'} & WIPED; # there is no object anymore
 111
 112     push @{ $self->{'list'} },
 113         RT::Shredder::Dependency->new(
 114             BaseObject => $args{'BaseObject'},
 115             Flags => $args{'Flags'},
 116             TargetObject => $rec->{'Object'},
 117         );
 118
 119     if( scalar @{ $self->{'list'} } > ( $RT::DependenciesLimit || 1000 ) ) {
 120         RT::Shredder::Exception::Info->throw( 'DependenciesLimit' );
 121     }
 122     return;
 123 }
 124
 125 =head2 List
 126
 127
 128 =cut
 129
 130 sub List
 131 {
 132     my $self = shift;
 133     my %args = (
 134         WithFlags => undef,
 135         WithoutFlags => undef,
 136         Callback => undef,
 137         @_
 138     );
 139
 140     my $wflags = delete $args{'WithFlags'};
 141     my $woflags = delete $args{'WithoutFlags'};
 142
 143     return
 144         map $args{'Callback'}? $args{'Callback'}->($_): $_,
 145         grep !defined( $wflags ) || ($_->Flags & $wflags) == $wflags,
 146         grep !defined( $woflags ) || !($_->Flags & $woflags),
 147         @{ $self->{'list'} };
 148 }
 149
 150 1;