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,
28 # the "DBIC_" prefix below is crucial - this is what makes CI pick up
29 # all envvars without further adjusting its scripts
30 # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) }
32 { substr($_, 5) => !!( $ENV{$_} ) }
34 DBIC_SHUFFLE_UNORDERED_RESULTSETS
35 DBIC_ASSERT_NO_INTERNAL_WANTARRAY
36 DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS
37 DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE
38 DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE
42 IV_SIZE => $Config{ivsize},
47 if ( "$]" < 5.009_005) {
49 constant->import( OLD_MRO => 1 );
53 constant->import( OLD_MRO => 0 );
56 # Both of these are no longer used for anything. However bring
57 # them back after they were purged in 08a8d8f1, as there appear
58 # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/*
59 # in their production codebases. There is no point in breaking these
60 # if whatever they used actually continues to work
65 my $cluck = "The @{[ (caller(1))[3] ]} constant is no more - adjust your code" . Carp::longmess();
67 warn $cluck unless $warned->{$cluck}++;
71 sub DBICTEST () { &$sigh }
72 sub PEEPEENESS () { &$sigh }
75 # FIXME - this is not supposed to be here
76 # Carp::Skip to the rescue soon
77 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
81 use Storable 'nfreeze';
82 use Scalar::Util qw(weaken blessed reftype refaddr);
83 use List::Util qw(first);
84 use Sub::Quote qw(qsub quote_sub);
86 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
87 BEGIN { *deep_clone = \&Storable::dclone }
91 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
92 fail_on_internal_wantarray fail_on_internal_call
93 refdesc refcount hrefaddr
94 scope_guard detected_reinvoked_destructor
95 is_exception dbic_internal_try
96 quote_sub qsub perlstring serialize deep_clone dump_value
98 UNRESOLVABLE_CONDITION
101 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
103 sub sigwarn_silencer ($) {
106 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
108 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
110 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
113 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
115 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
118 croak "Expecting a reference" if ! length ref $_[0];
120 # be careful not to trigger stringification,
121 # reuse @_ as a scratch-pad
122 sprintf '%s%s(0x%x)',
123 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
130 croak "Expecting a reference" if ! length ref $_[0];
132 # No tempvars - must operate on $_[0], otherwise the pad
133 # will count as an extra ref
134 B::svref_2object($_[0])->REFCNT;
138 local $Storable::canonical = 1;
144 local $Data::Dumper::Indent = 1
145 unless defined $Data::Dumper::Indent;
151 require Data::Dumper;
152 my $d = Data::Dumper->new([])
165 $d->Sparseseen(1) if modver_gt_or_eq (
166 'Data::Dumper', '2.136'
171 )->Values([$_[0]])->Dump;
173 $dd_obj->Reset->Values([]);
178 sub scope_guard (&) {
179 croak 'Calling scope_guard() in void context makes no sense'
180 if ! defined wantarray;
182 # no direct blessing of coderefs - DESTROY is buggy on those
183 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
187 DBIx::Class::_Util::ScopeGuard;
190 &DBIx::Class::_Util::detected_reinvoked_destructor;
192 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
200 "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@"
206 sub is_exception ($) {
210 # this is not strictly correct - an eval setting $@ to undef
211 # is *not* the same as an eval setting $@ to ''
212 # but for the sake of simplicity assume the following for
214 return 0 unless defined $e;
216 my ($not_blank, $suberror);
218 local $SIG{__DIE__} if $SIG{__DIE__};
221 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
222 # will entirely obviate the need for the encolsing eval{}, as the
223 # condition we guard against is a missing fallback overload
224 $not_blank = ( $e ne '' );
229 if (defined $suberror) {
230 if (length (my $class = blessed($e) )) {
231 carp_unique( sprintf(
232 'External exception class %s implements partial (broken) overloading '
233 . 'preventing its instances from being used in simple ($x eq $y) '
234 . 'comparisons. Given Perl\'s "globally cooperative" exception '
235 . 'handling this type of brokenness is extremely dangerous on '
236 . 'exception objects, as it may (and often does) result in silent '
237 . '"exception substitution". DBIx::Class tries to work around this '
238 . 'as much as possible, but other parts of your software stack may '
239 . 'not be even aware of this. Please submit a bugreport against the '
240 . 'distribution containing %s and in the meantime apply a fix similar '
241 . 'to the one shown at %s, in order to ensure your exception handling '
242 . 'is saner application-wide. What follows is the actual error text '
243 . "as generated by Perl itself:\n\n%s\n ",
246 'http://v.gd/DBIC_overload_tempfix/',
250 # workaround, keeps spice flowing
251 $not_blank = !!( length $e );
254 # not blessed yet failed the 'ne'... this makes 0 sense...
260 # a ref evaluating to '' is definitively a "null object"
263 length( my $class = ref $e )
265 carp_unique( sprintf(
266 "Objects of external exception class '%s' stringify to '' (the "
267 . 'empty string), implementing the so called null-object-pattern. '
268 . 'Given Perl\'s "globally cooperative" exception handling using this '
269 . 'class of exceptions is extremely dangerous, as it may (and often '
270 . 'does) result in silent discarding of errors. DBIx::Class tries to '
271 . 'work around this as much as possible, but other parts of your '
272 . 'software stack may not be even aware of the problem. Please submit '
273 . 'a bugreport against the distribution containing %s',
287 # Recreate the logic of try(), while reusing the catch()/finally() as-is
289 # FIXME: We need to move away from Try::Tiny entirely (way too heavy and
290 # yes, shows up ON TOP of profiles) but this is a batle for another maint
291 sub dbic_internal_try (&;@) {
293 my $try_cref = shift;
294 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
298 if( ref($arg) eq 'Try::Tiny::Catch' ) {
300 croak 'dbic_internal_try() may not be followed by multiple catch() blocks'
305 elsif ( ref($arg) eq 'Try::Tiny::Finally' ) {
306 croak 'dbic_internal_try() does not support finally{}';
310 'dbic_internal_try() encountered an unexpected argument '
311 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
312 . 'a missing semi-colon before or ' # trailing space important
317 my $wantarray = wantarray;
318 my $preexisting_exception = $@;
321 my $all_good = eval {
322 $@ = $preexisting_exception;
324 local $callstack_state->{in_internal_try} = 1
325 unless $callstack_state->{in_internal_try};
327 # always unset - someone may have snuck it in
328 local $SIG{__DIE__} if $SIG{__DIE__};
331 @ret = $try_cref->();
333 elsif( defined $wantarray ) {
334 $ret[0] = $try_cref->();
344 $@ = $preexisting_exception;
347 return $wantarray ? @ret : $ret[0]
349 elsif ( $catch_cref ) {
351 return $catch_cref->($exception);
358 sub in_internal_try { !! $callstack_state->{in_internal_try} }
362 my $destruction_registry = {};
365 $destruction_registry = { map
366 { defined $_ ? ( refaddr($_) => $_ ) : () }
367 values %$destruction_registry
370 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
371 # collected before leaving this scope. Depending on the code above, this
372 # may very well be just a preventive measure guarding future modifications
376 # This is almost invariably invoked from within DESTROY
377 # throwing exceptions won't work
378 sub detected_reinvoked_destructor {
380 # quick "garbage collection" pass - prevents the registry
381 # from slowly growing with a bunch of undef-valued keys
382 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
383 for keys %$destruction_registry;
385 if (! length ref $_[0]) {
386 printf STDERR '%s() expects a blessed reference %s',
390 return undef; # don't know wtf to do
392 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
393 weaken( $destruction_registry->{$addr} = $_[0] );
397 carp_unique ( sprintf (
398 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
399 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
400 . 'application, affecting *ALL* classes without active protection against '
401 . 'this. Diagnose and fix the root cause ASAP!!!%s',
403 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
404 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
414 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
415 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
417 sub modver_gt_or_eq ($$) {
418 my ($mod, $ver) = @_;
420 croak "Nonsensical module name supplied"
421 if ! defined $mod or $mod !~ $module_name_rx;
423 croak "Nonsensical minimum version supplied"
424 if ! defined $ver or $ver !~ $ver_rx;
427 my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
429 : croak "$mod does not seem to provide a version (perhaps it never loaded)"
432 ! defined $ver_cache->{$ver}
434 $ver_cache->{$ver} = do {
436 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
437 if SPURIOUS_VERSION_CHECK_WARNINGS;
439 local $SIG{__DIE__} if $SIG{__DIE__};
441 eval { $mod->VERSION($ver) } ? 1 : 0;
447 sub modver_gt_or_eq_and_lt ($$$) {
448 my ($mod, $v_ge, $v_lt) = @_;
450 croak "Nonsensical maximum version supplied"
451 if ! defined $v_lt or $v_lt !~ $ver_rx;
454 modver_gt_or_eq($mod, $v_ge)
456 ! modver_gt_or_eq($mod, $v_lt)
462 # Why not just use some higher-level module or at least File::Spec here?
464 # 1) This is a *very* rarely used function, and the deptree is large
465 # enough already as it is
467 # 2) (more importantly) Our tooling is utter shit in this area. There
468 # is no comprehensive support for UNC paths in PathTools and there
469 # are also various small bugs in representation across different
470 # path-manipulation CPAN offerings.
472 # Since this routine is strictly used for logical path processing (it
473 # *must* be able to work with not-yet-existing paths), use this seemingly
474 # simple but I *think* complete implementation to feed to other consumers
476 # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST*
477 # the impulse to bring in an external dependency. During runtime there
478 # is exactly one spot that could potentially maybe once in a blue moon
479 # use this function. Keep it lean.
482 ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x )
486 ( ( length($1) and ! length($2) ) ? '/' : '' )
493 File::Spec->catpath (
494 ( File::Spec->splitpath( "$_[0]" ) )[0,1],
503 # do not ask for a recent version, use 1.x API calls
504 File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects
509 my $list_ctx_ok_stack_marker;
511 sub fail_on_internal_wantarray () {
512 return if $list_ctx_ok_stack_marker;
514 if (! defined wantarray) {
515 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
519 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
521 # these are public API parts that alter behavior on wantarray
522 search | search_related | slice | search_literal
526 # these are explicitly prefixed, since we only recognize them as valid
527 # escapes when they come from the guts of CDBICompat
528 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
534 my ($fr, $want, $argdesc);
537 $fr = [ CORE::caller($cf) ];
538 $want = ( CORE::caller($cf-1) )[5];
539 $argdesc = ref $DB::args[0]
540 ? DBIx::Class::_Util::refdesc($DB::args[0])
546 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
548 DBIx::Class::Exception->throw( sprintf (
549 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
550 $argdesc, @{$fr}[1,2]
551 ), 'with_stacktrace');
555 weaken ( $list_ctx_ok_stack_marker = $mark );
560 sub fail_on_internal_call {
564 $fr = [ CORE::caller(1) ];
565 $argdesc = ref $DB::args[0]
566 ? DBIx::Class::_Util::refdesc($DB::args[0])
574 $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
576 $fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
578 DBIx::Class::Exception->throw( sprintf (
579 "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",
580 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
583 B::Deparse->new->coderef2text(\&{$fr->[3]})
585 ), 'with_stacktrace');