rt/lib/RT/Shredder/Dependency.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2015 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::Dependency;
  50
  51 use strict;
  52 use warnings;
  53 use RT::Shredder::Constants;
  54 use RT::Shredder::Exceptions;
  55
  56 my %FlagDescs = (
  57     RT::Shredder::Constants::DEPENDS_ON, 'depends on',
  58     RT::Shredder::Constants::VARIABLE,   'resolvable dependency',
  59     RT::Shredder::Constants::WIPE_AFTER, 'delete after',
  60 );
  61
  62 sub new
  63 {
  64     my $proto = shift;
  65     my $self = bless( {}, ref $proto || $proto );
  66     $self->Set( @_ );
  67     return $self;
  68 }
  69
  70 sub Set
  71 {
  72     my $self = shift;
  73     my %args = ( Flags => RT::Shredder::Constants::DEPENDS_ON, @_ );
  74     my @keys = qw(Flags BaseObject TargetObject);
  75     @$self{ @keys } = @args{ @keys };
  76
  77     return;
  78 }
  79
  80 sub AsString
  81 {
  82     my $self = shift;
  83     my $res = $self->BaseObject->UID;
  84     $res .= " ". $self->FlagsAsString;
  85     $res .= " ". $self->TargetObject->UID;
  86     return $res;
  87 }
  88
  89 sub Flags { return $_[0]->{'Flags'} }
  90 sub FlagsAsString
  91 {
  92     my $self = shift;
  93     my @res = ();
  94     foreach ( sort keys %FlagDescs ) {
  95         if( $self->Flags() & $_ ) {
  96             push( @res, $FlagDescs{ $_ } );
  97         }
  98     }
  99     push @res, 'no flags' unless( @res );
 100     return "(" . join( ',', @res ) . ")";
 101 }
 102
 103
 104 sub BaseObject { return $_[0]->{'BaseObject'} }
 105 sub TargetObject { return $_[0]->{'TargetObject'} }
 106 sub Object { return shift()->{ ({@_})->{Type}. "Object" } }
 107
 108 sub TargetClass { return ref $_[0]->{'TargetObject'} }
 109 sub BaseClass {    return ref $_[0]->{'BaseObject'} }
 110 sub Class { return ref shift()->Object( @_ ) }
 111
 112 1;