lib/DBIx/Class/_Util.pm

   1 package # hide from PAUSE
   2   DBIx::Class::_Util;
   3
   4 use warnings;
   5 use strict;
   6
   7 use constant SPURIOUS_VERSION_CHECK_WARNINGS => ($] < 5.010 ? 1 : 0);
   8
   9 BEGIN {
  10   package # hide from pause
  11     DBIx::Class::_ENV_;
  12
  13   use Config;
  14
  15   use constant {
  16
  17     # but of course
  18     BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0,
  19
  20     HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
  21
  22     # ::Runmode would only be loaded by DBICTest, which in turn implies t/
  23     DBICTEST => eval { DBICTest::RunMode->is_author } ? 1 : 0,
  24
  25     # During 5.13 dev cycle HELEMs started to leak on copy
  26     PEEPEENESS =>
  27       # request for all tests would force "non-leaky" illusion and vice-versa
  28       defined $ENV{DBICTEST_ALL_LEAKS}                                              ? !$ENV{DBICTEST_ALL_LEAKS}
  29       # otherwise confess that this perl is busted ONLY on smokers
  30     : eval { DBICTest::RunMode->is_smoker } && ($] >= 5.013005 and $] <= 5.013006)  ? 1
  31       # otherwise we are good
  32                                                                                     : 0
  33     ,
  34
  35     ASSERT_NO_INTERNAL_WANTARRAY => $ENV{DBIC_ASSERT_NO_INTERNAL_WANTARRAY} ? 1 : 0,
  36
  37     IV_SIZE => $Config{ivsize},
  38
  39     OS_NAME => $^O,
  40   };
  41
  42   if ($] < 5.009_005) {
  43     require MRO::Compat;
  44     constant->import( OLD_MRO => 1 );
  45   }
  46   else {
  47     require mro;
  48     constant->import( OLD_MRO => 0 );
  49   }
  50 }
  51
  52 # FIXME - this is not supposed to be here
  53 # Carp::Skip to the rescue soon
  54 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
  55
  56 use Carp 'croak';
  57 use Scalar::Util qw(weaken blessed reftype);
  58
  59 use base 'Exporter';
  60 our @EXPORT_OK = qw(sigwarn_silencer modver_gt_or_eq fail_on_internal_wantarray refcount hrefaddr is_exception);
  61
  62 sub sigwarn_silencer ($) {
  63   my $pattern = shift;
  64
  65   croak "Expecting a regexp" if ref $pattern ne 'Regexp';
  66
  67   my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
  68
  69   return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
  70 }
  71
  72 sub hrefaddr ($) { sprintf '0x%x', &Scalar::Util::refaddr }
  73
  74 sub refcount ($) {
  75   croak "Expecting a reference" if ! length ref $_[0];
  76
  77   require B;
  78   # No tempvars - must operate on $_[0], otherwise the pad
  79   # will count as an extra ref
  80   B::svref_2object($_[0])->REFCNT;
  81 }
  82
  83 sub is_exception ($) {
  84   my $e = $_[0];
  85
  86   # this is not strictly correct - an eval setting $@ to undef
  87   # is *not* the same as an eval setting $@ to ''
  88   # but for the sake of simplicity assume the following for
  89   # the time being
  90   return 0 unless defined $e;
  91
  92   my ($not_blank, $suberror);
  93   {
  94     local $@;
  95     eval {
  96       $not_blank = ($e ne '') ? 1 : 0;
  97       1;
  98     } or $suberror = $@;
  99   }
 100
 101   if (defined $suberror) {
 102     if (length (my $class = blessed($e) )) {
 103       carp_unique( sprintf(
 104         'External exception object %s=%s(%s) implements partial (broken) '
 105       . 'overloading preventing it from being used in simple ($x eq $y) '
 106       . 'comparisons. Given Perl\'s "globally cooperative" exception '
 107       . 'handling this type of brokenness is extremely dangerous on '
 108       . 'exception objects, as it may (and often does) result in silent '
 109       . '"exception substitution". DBIx::Class tries to work around this '
 110       . 'as much as possible, but other parts of your software stack may '
 111       . 'not be even aware of this. Please submit a bugreport against the '
 112       . 'distribution containing %s and in the meantime apply a fix similar '
 113       . 'to the one shown at %s, in order to ensure your exception handling '
 114       . 'is saner application-wide. What follows is the actual error text '
 115       . "as generated by Perl itself:\n\n%s\n ",
 116         $class,
 117         reftype $e,
 118         hrefaddr $e,
 119         $class,
 120         'http://v.gd/DBIC_overload_tempfix/',
 121         $suberror,
 122       ));
 123
 124       # workaround, keeps spice flowing
 125       $not_blank = ("$e" ne '') ? 1 : 0;
 126     }
 127     else {
 128       # not blessed yet failed the 'ne'... this makes 0 sense...
 129       # just throw further
 130       die $suberror
 131     }
 132   }
 133
 134   return $not_blank;
 135 }
 136
 137 sub modver_gt_or_eq ($$) {
 138   my ($mod, $ver) = @_;
 139
 140   croak "Nonsensical module name supplied"
 141     if ! defined $mod or ! length $mod;
 142
 143   croak "Nonsensical minimum version supplied"
 144     if ! defined $ver or $ver =~ /[^0-9\.\_]/;
 145
 146   local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
 147     if SPURIOUS_VERSION_CHECK_WARNINGS;
 148
 149   croak "$mod does not seem to provide a version (perhaps it never loaded)"
 150     unless $mod->VERSION;
 151
 152   local $@;
 153   eval { $mod->VERSION($ver) } ? 1 : 0;
 154 }
 155
 156 {
 157   my $list_ctx_ok_stack_marker;
 158
 159   sub fail_on_internal_wantarray {
 160     return if $list_ctx_ok_stack_marker;
 161
 162     if (! defined wantarray) {
 163       croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
 164     }
 165
 166     my $cf = 1;
 167     while ( ( (caller($cf+1))[3] || '' ) =~ / :: (?:
 168
 169       # these are public API parts that alter behavior on wantarray
 170       search | search_related | slice | search_literal
 171
 172         |
 173
 174       # these are explicitly prefixed, since we only recognize them as valid
 175       # escapes when they come from the guts of CDBICompat
 176       CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
 177
 178     ) $/x ) {
 179       $cf++;
 180     }
 181
 182     if (
 183       (caller($cf))[0] =~ /^(?:DBIx::Class|DBICx::)/
 184     ) {
 185       my $obj = shift;
 186
 187       DBIx::Class::Exception->throw( sprintf (
 188         "Improper use of %s(%s) instance in list context at %s line %d\n\n\tStacktrace starts",
 189         ref($obj), hrefaddr($obj), (caller($cf))[1,2]
 190       ), 'with_stacktrace');
 191     }
 192
 193     my $mark = [];
 194     weaken ( $list_ctx_ok_stack_marker = $mark );
 195     $mark;
 196   }
 197 }
 198
 199 1;