1 package # hide from PAUSE
4 use DBIx::Class::StartupCheck; # load es early as we can, usually a noop
9 use constant SPURIOUS_VERSION_CHECK_WARNINGS => ( "$]" < 5.010 ? 1 : 0);
12 package # hide from pause
20 BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0,
22 BROKEN_GOTO => ( "$]" < 5.008003 ) ? 1 : 0,
24 HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
26 UNSTABLE_DOLLARAT => ( "$]" < 5.013002 ) ? 1 : 0,
30 # the "DBIC_" prefix below is crucial - this is what makes CI pick up
31 # all envvars without further adjusting its scripts
32 # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) }
34 { substr($_, 5) => !!( $ENV{$_} ) }
36 DBIC_SHUFFLE_UNORDERED_RESULTSETS
37 DBIC_ASSERT_NO_INTERNAL_WANTARRAY
38 DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS
39 DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE
40 DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE
44 IV_SIZE => $Config{ivsize},
49 if ( "$]" < 5.009_005) {
51 constant->import( OLD_MRO => 1 );
55 constant->import( OLD_MRO => 0 );
58 # Both of these are no longer used for anything. However bring
59 # them back after they were purged in 08a8d8f1, as there appear
60 # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/*
61 # in their production codebases. There is no point in breaking these
62 # if whatever they used actually continues to work
67 my $cluck = "The @{[ (caller(1))[3] ]} constant is no more - adjust your code" . Carp::longmess();
69 warn $cluck unless $warned->{$cluck}++;
73 sub DBICTEST () { &$sigh }
74 sub PEEPEENESS () { &$sigh }
77 # FIXME - this is not supposed to be here
78 # Carp::Skip to the rescue soon
79 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
83 use Storable 'nfreeze';
84 use Scalar::Util qw(weaken blessed reftype refaddr);
85 use Sub::Quote qw(qsub);
88 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
89 BEGIN { *deep_clone = \&Storable::dclone }
93 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
94 fail_on_internal_wantarray fail_on_internal_call
95 refdesc refcount hrefaddr set_subname
96 scope_guard detected_reinvoked_destructor
97 is_exception dbic_internal_try
98 quote_sub qsub perlstring serialize deep_clone dump_value
100 UNRESOLVABLE_CONDITION
103 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
106 Sub::Quote->VERSION(2.002);
108 # Override forcing no_defer, and adding naming consistency checks
110 Carp::confess( "Anonymous quoting not supported by the DBIC sub_quote override - supply a sub name" ) if
118 Carp::confess( "The DBIC sub_quote override expects sub name '$_[0]' to be fully qualified" )
119 unless $_[0] =~ /::/;
121 Carp::confess( "The DBIC sub_quote override expects the sub name '$_[0]' to match the supplied 'package' argument" ) if
124 defined $_[3]->{package}
126 index( $_[0], $_[3]->{package} ) != 0
129 my @caller = caller(0);
131 package => $caller[0],
133 warning_bits => $caller[9],
134 hintshash => $caller[10],
137 # explicitly forced for everything
141 my $cref = Sub::Quote::quote_sub( $_[0], $_[1], $_[2]||{}, $sq_opts );
144 sub sigwarn_silencer ($) {
147 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
149 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
151 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
154 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
156 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
159 croak "Expecting a reference" if ! length ref $_[0];
161 # be careful not to trigger stringification,
162 # reuse @_ as a scratch-pad
163 sprintf '%s%s(0x%x)',
164 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
171 croak "Expecting a reference" if ! length ref $_[0];
173 # No tempvars - must operate on $_[0], otherwise the pad
174 # will count as an extra ref
175 B::svref_2object($_[0])->REFCNT;
178 # FIXME In another life switch this to a polyfill like the one in namespace::clean
179 sub set_subname ($$) {
182 splice @_, 0, 1, caller(0) . "::$_[0]"
189 local $Storable::canonical = 1;
195 local $Data::Dumper::Indent = 1
196 unless defined $Data::Dumper::Indent;
202 require Data::Dumper;
203 my $d = Data::Dumper->new([])
216 $d->Sparseseen(1) if modver_gt_or_eq (
217 'Data::Dumper', '2.136'
222 )->Values([$_[0]])->Dump;
224 $dd_obj->Reset->Values([]);
229 sub scope_guard (&) {
230 croak 'Calling scope_guard() in void context makes no sense'
231 if ! defined wantarray;
233 # no direct blessing of coderefs - DESTROY is buggy on those
234 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
238 DBIx::Class::_Util::ScopeGuard;
241 &DBIx::Class::_Util::detected_reinvoked_destructor;
243 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
251 "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@"
257 sub is_exception ($) {
261 # this is not strictly correct - an eval setting $@ to undef
262 # is *not* the same as an eval setting $@ to ''
263 # but for the sake of simplicity assume the following for
265 return 0 unless defined $e;
267 my ($not_blank, $suberror);
269 local $SIG{__DIE__} if $SIG{__DIE__};
272 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
273 # will entirely obviate the need for the encolsing eval{}, as the
274 # condition we guard against is a missing fallback overload
275 $not_blank = ( $e ne '' );
280 if (defined $suberror) {
281 if (length (my $class = blessed($e) )) {
282 carp_unique( sprintf(
283 'External exception class %s implements partial (broken) overloading '
284 . 'preventing its instances from being used in simple ($x eq $y) '
285 . 'comparisons. Given Perl\'s "globally cooperative" exception '
286 . 'handling this type of brokenness is extremely dangerous on '
287 . 'exception objects, as it may (and often does) result in silent '
288 . '"exception substitution". DBIx::Class tries to work around this '
289 . 'as much as possible, but other parts of your software stack may '
290 . 'not be even aware of this. Please submit a bugreport against the '
291 . 'distribution containing %s and in the meantime apply a fix similar '
292 . 'to the one shown at %s, in order to ensure your exception handling '
293 . 'is saner application-wide. What follows is the actual error text '
294 . "as generated by Perl itself:\n\n%s\n ",
297 'http://v.gd/DBIC_overload_tempfix/',
301 # workaround, keeps spice flowing
302 $not_blank = !!( length $e );
305 # not blessed yet failed the 'ne'... this makes 0 sense...
311 # a ref evaluating to '' is definitively a "null object"
314 length( my $class = ref $e )
316 carp_unique( sprintf(
317 "Objects of external exception class '%s' stringify to '' (the "
318 . 'empty string), implementing the so called null-object-pattern. '
319 . 'Given Perl\'s "globally cooperative" exception handling using this '
320 . 'class of exceptions is extremely dangerous, as it may (and often '
321 . 'does) result in silent discarding of errors. DBIx::Class tries to '
322 . 'work around this as much as possible, but other parts of your '
323 . 'software stack may not be even aware of the problem. Please submit '
324 . 'a bugreport against the distribution containing %s',
338 # Recreate the logic of try(), while reusing the catch()/finally() as-is
340 # FIXME: We need to move away from Try::Tiny entirely (way too heavy and
341 # yes, shows up ON TOP of profiles) but this is a batle for another maint
342 sub dbic_internal_try (&;@) {
344 my $try_cref = shift;
345 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
349 if( ref($arg) eq 'Try::Tiny::Catch' ) {
351 croak 'dbic_internal_try() may not be followed by multiple catch() blocks'
356 elsif ( ref($arg) eq 'Try::Tiny::Finally' ) {
357 croak 'dbic_internal_try() does not support finally{}';
361 'dbic_internal_try() encountered an unexpected argument '
362 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
363 . 'a missing semi-colon before or ' # trailing space important
368 my $wantarray = wantarray;
369 my $preexisting_exception = $@;
372 my $all_good = eval {
373 $@ = $preexisting_exception;
375 local $callstack_state->{in_internal_try} = 1
376 unless $callstack_state->{in_internal_try};
378 # always unset - someone may have snuck it in
379 local $SIG{__DIE__} if $SIG{__DIE__};
382 @ret = $try_cref->();
384 elsif( defined $wantarray ) {
385 $ret[0] = $try_cref->();
395 $@ = $preexisting_exception;
398 return $wantarray ? @ret : $ret[0]
400 elsif ( $catch_cref ) {
402 return $catch_cref->($exception);
409 sub in_internal_try { !! $callstack_state->{in_internal_try} }
413 my $destruction_registry = {};
416 %$destruction_registry = map {
418 ? ( refaddr($_) => $_ )
420 } values %$destruction_registry;
422 weaken($_) for values %$destruction_registry;
424 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
425 # collected before leaving this scope. Depending on the code above, this
426 # may very well be just a preventive measure guarding future modifications
430 # This is almost invariably invoked from within DESTROY
431 # throwing exceptions won't work
432 sub detected_reinvoked_destructor {
434 # quick "garbage collection" pass - prevents the registry
435 # from slowly growing with a bunch of undef-valued keys
436 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
437 for keys %$destruction_registry;
439 if (! length ref $_[0]) {
440 printf STDERR '%s() expects a blessed reference %s',
444 return undef; # don't know wtf to do
446 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
447 weaken( $destruction_registry->{$addr} = $_[0] );
451 carp_unique ( sprintf (
452 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
453 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
454 . 'application, affecting *ALL* classes without active protection against '
455 . 'this. Diagnose and fix the root cause ASAP!!!%s',
457 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
458 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
468 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
469 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
471 sub modver_gt_or_eq ($$) {
472 my ($mod, $ver) = @_;
474 croak "Nonsensical module name supplied"
475 if ! defined $mod or $mod !~ $module_name_rx;
477 croak "Nonsensical minimum version supplied"
478 if ! defined $ver or $ver !~ $ver_rx;
481 my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
483 : croak "$mod does not seem to provide a version (perhaps it never loaded)"
486 ! defined $ver_cache->{$ver}
488 $ver_cache->{$ver} = do {
490 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
491 if SPURIOUS_VERSION_CHECK_WARNINGS;
493 local $SIG{__DIE__} if $SIG{__DIE__};
495 eval { $mod->VERSION($ver) } ? 1 : 0;
501 sub modver_gt_or_eq_and_lt ($$$) {
502 my ($mod, $v_ge, $v_lt) = @_;
504 croak "Nonsensical maximum version supplied"
505 if ! defined $v_lt or $v_lt !~ $ver_rx;
508 modver_gt_or_eq($mod, $v_ge)
510 ! modver_gt_or_eq($mod, $v_lt)
516 # Why not just use some higher-level module or at least File::Spec here?
518 # 1) This is a *very* rarely used function, and the deptree is large
519 # enough already as it is
521 # 2) (more importantly) Our tooling is utter shit in this area. There
522 # is no comprehensive support for UNC paths in PathTools and there
523 # are also various small bugs in representation across different
524 # path-manipulation CPAN offerings.
526 # Since this routine is strictly used for logical path processing (it
527 # *must* be able to work with not-yet-existing paths), use this seemingly
528 # simple but I *think* complete implementation to feed to other consumers
530 # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST*
531 # the impulse to bring in an external dependency. During runtime there
532 # is exactly one spot that could potentially maybe once in a blue moon
533 # use this function. Keep it lean.
536 ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x )
540 ( ( length($1) and ! length($2) ) ? '/' : '' )
547 File::Spec->catpath (
548 ( File::Spec->splitpath( "$_[0]" ) )[0,1],
557 # do not ask for a recent version, use 1.x API calls
558 File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects
563 my $list_ctx_ok_stack_marker;
565 sub fail_on_internal_wantarray () {
566 return if $list_ctx_ok_stack_marker;
568 if (! defined wantarray) {
569 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
573 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
575 # these are public API parts that alter behavior on wantarray
576 search | search_related | slice | search_literal
580 # these are explicitly prefixed, since we only recognize them as valid
581 # escapes when they come from the guts of CDBICompat
582 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
588 my ($fr, $want, $argdesc);
591 $fr = [ CORE::caller($cf) ];
592 $want = ( CORE::caller($cf-1) )[5];
593 $argdesc = ref $DB::args[0]
594 ? DBIx::Class::_Util::refdesc($DB::args[0])
600 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
602 DBIx::Class::Exception->throw( sprintf (
603 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
604 $argdesc, @{$fr}[1,2]
605 ), 'with_stacktrace');
608 weaken( $list_ctx_ok_stack_marker = my $mark = [] );
614 sub fail_on_internal_call {
618 $fr = [ CORE::caller(1) ];
619 $argdesc = ref $DB::args[0]
620 ? DBIx::Class::_Util::refdesc($DB::args[0])
621 : ( $DB::args[0] . '' )
628 $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
630 $fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
632 DBIx::Class::Exception->throw( sprintf (
633 "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",
634 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
637 B::Deparse->new->coderef2text(\&{$fr->[3]})
639 ), 'with_stacktrace');