rt/lib/RT/Shredder/Dependencies.pm

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