rt/lib/RT/Shredder/Exceptions.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::Exception;
  50
  51 use warnings;
  52 use strict;
  53
  54 use Exception::Class;
  55 use base qw(Exception::Class::Base);
  56
  57 BEGIN {
  58     __PACKAGE__->NoRefs(0);
  59 }
  60
  61 #sub NoRefs { return 0 }
  62 sub show_trace { return 1 }
  63
  64 package RT::Shredder::Exception::Info;
  65
  66 use base qw(RT::Shredder::Exception);
  67
  68 my %DESCRIPTION = (
  69     DependenciesLimit => <<END,
  70 Dependecies list have reached its limit.
  71 See \$RT::DependenciesLimit in RT::Shredder docs.
  72 END
  73
  74     SystemObject => <<END,
  75 System object was requested for deletion, shredder couldn't
  76 do that because system would be unusable than.
  77 END
  78
  79     CouldntLoadObject => <<END,
  80 Shredder couldn't load object. Most probably it's not fatal error.
  81 May be you've used Objects plugin and asked to delete object that
  82 doesn't exist in the system. If you think that your request was
  83 correct and it's problem of the Shredder then you can get full error
  84 message from RT log files and send bug report.
  85 END
  86
  87     NoResolver => <<END,
  88 Object has dependency that could be resolved, but resolver
  89 wasn't defined. You have to re-read documentation of the
  90 plugin you're using, for example the 'Users' plugin has
  91 option 'replace_relations' argument.
  92 END
  93 );
  94
  95 sub Fields { return ((shift)->SUPER::Fields(@_), 'tag') }
  96
  97 sub tag { return (shift)->{'tag'} }
  98
  99 sub full_message {
 100     my $self = shift;
 101     my $error = $self->message;
 102     if ( my $tag = $self->tag ) {
 103         my $message = $DESCRIPTION{ $self->tag } || '';
 104         warn "Tag '$tag' doesn't exist" unless $message;
 105         $message .= "\nAdditional info:\n$error" if $error;
 106         return $message;
 107     }
 108     return $DESCRIPTION{$error} || $error;
 109 }
 110
 111 sub show_trace { return 0 }
 112
 113 1;