1 package # hide from PAUSE
7 use constant SPURIOUS_VERSION_CHECK_WARNINGS => ( "$]" < 5.010 ? 1 : 0);
10 package # hide from pause
18 BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0,
20 BROKEN_GOTO => ( "$]" < 5.008003 ) ? 1 : 0,
22 HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
24 UNSTABLE_DOLLARAT => ( "$]" < 5.013002 ) ? 1 : 0,
26 DBICTEST => $INC{"DBICTest/Util.pm"} ? 1 : 0,
28 # During 5.13 dev cycle HELEMs started to leak on copy
29 # add an escape for these perls ON SMOKERS - a user will still get death
30 PEEPEENESS => ( eval { DBICTest::RunMode->is_smoker } && ( "$]" >= 5.013005 and "$]" <= 5.013006) ),
34 # the "DBIC_" prefix below is crucial - this is what makes CI pick up
35 # all envvars without further adjusting its scripts
36 # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) }
38 { substr($_, 5) => !!( $ENV{$_} ) }
40 DBIC_SHUFFLE_UNORDERED_RESULTSETS
41 DBIC_ASSERT_NO_INTERNAL_WANTARRAY
42 DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS
43 DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE
44 DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE
48 IV_SIZE => $Config{ivsize},
53 if ( "$]" < 5.009_005) {
55 constant->import( OLD_MRO => 1 );
59 constant->import( OLD_MRO => 0 );
63 # FIXME - this is not supposed to be here
64 # Carp::Skip to the rescue soon
65 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
69 use Storable 'nfreeze';
70 use Scalar::Util qw(weaken blessed reftype refaddr);
71 use List::Util qw(first);
72 use Sub::Quote qw(qsub quote_sub);
74 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
75 BEGIN { *deep_clone = \&Storable::dclone }
79 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
80 fail_on_internal_wantarray fail_on_internal_call
81 refdesc refcount hrefaddr
82 scope_guard detected_reinvoked_destructor
83 is_exception dbic_internal_try
84 quote_sub qsub perlstring serialize deep_clone
85 UNRESOLVABLE_CONDITION
88 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
90 sub sigwarn_silencer ($) {
93 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
95 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
97 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
100 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
102 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
105 croak "Expecting a reference" if ! length ref $_[0];
107 # be careful not to trigger stringification,
108 # reuse @_ as a scratch-pad
109 sprintf '%s%s(0x%x)',
110 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
117 croak "Expecting a reference" if ! length ref $_[0];
119 # No tempvars - must operate on $_[0], otherwise the pad
120 # will count as an extra ref
121 B::svref_2object($_[0])->REFCNT;
125 local $Storable::canonical = 1;
129 sub scope_guard (&) {
130 croak 'Calling scope_guard() in void context makes no sense'
131 if ! defined wantarray;
133 # no direct blessing of coderefs - DESTROY is buggy on those
134 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
138 DBIx::Class::_Util::ScopeGuard;
141 &DBIx::Class::_Util::detected_reinvoked_destructor;
143 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
149 Carp::cluck "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@";
155 sub is_exception ($) {
159 # this is not strictly correct - an eval setting $@ to undef
160 # is *not* the same as an eval setting $@ to ''
161 # but for the sake of simplicity assume the following for
163 return 0 unless defined $e;
165 my ($not_blank, $suberror);
169 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
170 # will entirely obviate the need for the encolsing eval{}, as the
171 # condition we guard against is a missing fallback overload
172 $not_blank = ( $e ne '' );
177 if (defined $suberror) {
178 if (length (my $class = blessed($e) )) {
179 carp_unique( sprintf(
180 'External exception class %s implements partial (broken) overloading '
181 . 'preventing its instances from being used in simple ($x eq $y) '
182 . 'comparisons. Given Perl\'s "globally cooperative" exception '
183 . 'handling this type of brokenness is extremely dangerous on '
184 . 'exception objects, as it may (and often does) result in silent '
185 . '"exception substitution". DBIx::Class tries to work around this '
186 . 'as much as possible, but other parts of your software stack may '
187 . 'not be even aware of this. Please submit a bugreport against the '
188 . 'distribution containing %s and in the meantime apply a fix similar '
189 . 'to the one shown at %s, in order to ensure your exception handling '
190 . 'is saner application-wide. What follows is the actual error text '
191 . "as generated by Perl itself:\n\n%s\n ",
194 'http://v.gd/DBIC_overload_tempfix/',
198 # workaround, keeps spice flowing
199 $not_blank = !!( length $e );
202 # not blessed yet failed the 'ne'... this makes 0 sense...
208 # a ref evaluating to '' is definitively a "null object"
211 length( my $class = ref $e )
213 carp_unique( sprintf(
214 "Objects of external exception class '%s' stringify to '' (the "
215 . 'empty string), implementing the so called null-object-pattern. '
216 . 'Given Perl\'s "globally cooperative" exception handling using this '
217 . 'class of exceptions is extremely dangerous, as it may (and often '
218 . 'does) result in silent discarding of errors. DBIx::Class tries to '
219 . 'work around this as much as possible, but other parts of your '
220 . 'software stack may not be even aware of the problem. Please submit '
221 . 'a bugreport against the distribution containing %s',
235 # Recreate the logic of try(), while reusing the catch()/finally() as-is
237 # FIXME: We need to move away from Try::Tiny entirely (way too heavy and
238 # yes, shows up ON TOP of profiles) but this is a batle for another maint
239 sub dbic_internal_try (&;@) {
241 my $try_cref = shift;
242 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
246 if( ref($arg) eq 'Try::Tiny::Catch' ) {
248 croak 'dbic_internal_try() may not be followed by multiple catch() blocks'
253 elsif ( ref($arg) eq 'Try::Tiny::Finally' ) {
254 croak 'dbic_internal_try() does not support finally{}';
258 'dbic_internal_try() encountered an unexpected argument '
259 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
260 . 'a missing semi-colon before or ' # trailing space important
265 my $wantarray = wantarray;
266 my $preexisting_exception = $@;
269 my $all_good = eval {
270 $@ = $preexisting_exception;
272 local $callstack_state->{in_internal_try} = 1
273 unless $callstack_state->{in_internal_try};
275 # always unset - someone may have snuck it in
281 @ret = $try_cref->();
283 elsif( defined $wantarray ) {
284 $ret[0] = $try_cref->();
294 $@ = $preexisting_exception;
297 return $wantarray ? @ret : $ret[0]
299 elsif ( $catch_cref ) {
301 return $catch_cref->($exception);
308 sub in_internal_try { !! $callstack_state->{in_internal_try} }
312 my $destruction_registry = {};
315 $destruction_registry = { map
316 { defined $_ ? ( refaddr($_) => $_ ) : () }
317 values %$destruction_registry
321 # This is almost invariably invoked from within DESTROY
322 # throwing exceptions won't work
323 sub detected_reinvoked_destructor {
325 # quick "garbage collection" pass - prevents the registry
326 # from slowly growing with a bunch of undef-valued keys
327 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
328 for keys %$destruction_registry;
330 if (! length ref $_[0]) {
331 printf STDERR '%s() expects a blessed reference %s',
335 return undef; # don't know wtf to do
337 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
338 weaken( $destruction_registry->{$addr} = $_[0] );
342 carp_unique ( sprintf (
343 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
344 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
345 . 'application, affecting *ALL* classes without active protection against '
346 . 'this. Diagnose and fix the root cause ASAP!!!%s',
348 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
349 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
359 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
360 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
362 sub modver_gt_or_eq ($$) {
363 my ($mod, $ver) = @_;
365 croak "Nonsensical module name supplied"
366 if ! defined $mod or $mod !~ $module_name_rx;
368 croak "Nonsensical minimum version supplied"
369 if ! defined $ver or $ver !~ $ver_rx;
372 my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
374 : croak "$mod does not seem to provide a version (perhaps it never loaded)"
377 ! defined $ver_cache->{$ver}
379 $ver_cache->{$ver} = do {
381 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
382 if SPURIOUS_VERSION_CHECK_WARNINGS;
386 eval { $mod->VERSION($ver) } ? 1 : 0;
392 sub modver_gt_or_eq_and_lt ($$$) {
393 my ($mod, $v_ge, $v_lt) = @_;
395 croak "Nonsensical maximum version supplied"
396 if ! defined $v_lt or $v_lt !~ $ver_rx;
399 modver_gt_or_eq($mod, $v_ge)
401 ! modver_gt_or_eq($mod, $v_lt)
406 my $list_ctx_ok_stack_marker;
408 sub fail_on_internal_wantarray () {
409 return if $list_ctx_ok_stack_marker;
411 if (! defined wantarray) {
412 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
416 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
418 # these are public API parts that alter behavior on wantarray
419 search | search_related | slice | search_literal
423 # these are explicitly prefixed, since we only recognize them as valid
424 # escapes when they come from the guts of CDBICompat
425 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
431 my ($fr, $want, $argdesc);
434 $fr = [ CORE::caller($cf) ];
435 $want = ( CORE::caller($cf-1) )[5];
436 $argdesc = ref $DB::args[0]
437 ? DBIx::Class::_Util::refdesc($DB::args[0])
443 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
445 DBIx::Class::Exception->throw( sprintf (
446 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
447 $argdesc, @{$fr}[1,2]
448 ), 'with_stacktrace');
452 weaken ( $list_ctx_ok_stack_marker = $mark );
457 sub fail_on_internal_call {
461 $fr = [ CORE::caller(1) ];
462 $argdesc = ref $DB::args[0]
463 ? DBIx::Class::_Util::refdesc($DB::args[0])
471 $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
473 $fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
475 DBIx::Class::Exception->throw( sprintf (
476 "Illegal internal call of indirect proxy-method %s() with argument %s: examine the last lines of the proxy method deparse below to determine what to call directly instead at %s on line %d\n\n%s\n\n Stacktrace starts",
477 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
480 B::Deparse->new->coderef2text(\&{$fr->[3]})
482 ), 'with_stacktrace');