rt/lib/RT/Util.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 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::Util;
  50 use strict;
  51 use warnings;
  52
  53 use base 'Exporter';
  54 our @EXPORT = qw/safe_run_child/;
  55
  56 sub safe_run_child (&) {
  57     my $our_pid = $$;
  58
  59     # situation here is wierd, running external app
  60     # involves fork+exec. At some point after fork,
  61     # but before exec (or during) code can die in a
  62     # child. Local is no help here as die throws
  63     # error out of scope and locals are reset to old
  64     # values. Instead we set values, eval code, check pid
  65     # on failure and reset values only in our original
  66     # process
  67     my $dbh = $RT::Handle->dbh;
  68     $dbh->{'InactiveDestroy'} = 1 if $dbh;
  69     $RT::Handle->{'DisconnectHandleOnDestroy'} = 0;
  70
  71     my @res;
  72     my $want = wantarray;
  73     eval {
  74         unless ( defined $want ) {
  75             _safe_run_child( @_ );
  76         } elsif ( $want ) {
  77             @res = _safe_run_child( @_ );
  78         } else {
  79             @res = ( scalar _safe_run_child( @_ ) );
  80         }
  81         1;
  82     } or do {
  83         my $err = $@;
  84         if ( $our_pid == $$ ) {
  85             $RT::Logger->error( $err );
  86             $dbh->{'InactiveDestroy'} = 0 if $dbh;
  87             $RT::Handle->{'DisconnectHandleOnDestroy'} = 1;
  88         }
  89         $err =~ s/^Stack:.*$//ms;
  90         #TODO we need to localize this
  91         die 'System Error: ' . $err;
  92     };
  93     return $want? (@res) : $res[0];
  94 }
  95
  96 sub _safe_run_child {
  97     local @ENV{ 'LANG', 'LC_ALL' } = ( 'C', 'C' );
  98
  99     return shift->() if $ENV{'MOD_PERL'} || $CGI::SpeedyCGI::i_am_speedy;
 100
 101     # We need to reopen stdout temporarily, because in FCGI
 102     # environment, stdout is tied to FCGI::Stream, and the child
 103     # of the run3 wouldn't be able to reopen STDOUT properly.
 104     my $stdin = IO::Handle->new;
 105     $stdin->fdopen( 0, 'r' );
 106     local *STDIN = $stdin;
 107
 108     my $stdout = IO::Handle->new;
 109     $stdout->fdopen( 1, 'w' );
 110     local *STDOUT = $stdout;
 111
 112     my $stderr = IO::Handle->new;
 113     $stderr->fdopen( 2, 'w' );
 114     local *STDERR = $stderr;
 115
 116     return shift->();
 117 }
 118
 119 eval "require RT::Util_Vendor";
 120 if ($@ && $@ !~ qr{^Can't locate RT/Util_Vendor.pm}) {
 121     die $@;
 122 };
 123
 124 eval "require RT::Util_Local";
 125 if ($@ && $@ !~ qr{^Can't locate RT/Util_Local.pm}) {
 126     die $@;
 127 };
 128
 129 1;