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);
11 my $mro_recursor_stack;
14 package # hide from pause
22 BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0,
24 BROKEN_GOTO => ( "$]" < 5.008003 ) ? 1 : 0,
26 # perl -MScalar::Util=weaken -e 'weaken( $hash{key} = \"value" )'
27 BROKEN_WEAK_SCALARREF_VALUES => ( "$]" < 5.008003 ) ? 1 : 0,
29 HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
31 UNSTABLE_DOLLARAT => ( "$]" < 5.013002 ) ? 1 : 0,
35 # the "DBIC_" prefix below is crucial - this is what makes CI pick up
36 # all envvars without further adjusting its scripts
37 # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) }
39 { substr($_, 5) => !!( $ENV{$_} ) }
41 DBIC_SHUFFLE_UNORDERED_RESULTSETS
42 DBIC_ASSERT_NO_INTERNAL_WANTARRAY
43 DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS
44 DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE
45 DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE
49 IV_SIZE => $Config{ivsize},
54 if ( "$]" < 5.009_005) {
56 constant->import( OLD_MRO => 1 );
59 # Yes, I know this is a rather PHP-ish name, but please first read
60 # https://metacpan.org/source/BOBTFISH/MRO-Compat-0.12/lib/MRO/Compat.pm#L363-368
62 # Even if we are using Class::C3::XS it still won't work, as doing
63 # defined( *{ "SubClass::"->{$_} }{CODE} )
64 # will set pkg_gen to the same value for SubClass and *ALL PARENTS*
66 *DBIx::Class::_Util::get_real_pkg_gen = sub ($) {
70 # the non-assign-unless-there-is-a-hash is deliberate
71 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{gen} ||= (
72 Math::BigInt->new( '0x' . ( Digest::MD5::md5_hex( join "\0", map {
74 ( $mro_recursor_stack->{cache} || {} )->{$_}{methlist} ||= do {
79 # RV to be hashed up and turned into a number
84 # stringification should be sufficient, ignore names/refaddr entirely
86 attributes::get( $_ ),
90 # skip dummy C::C3 helper crefs
91 ! ( ( $Class::C3::MRO{$class} || {} )->{methods}{$_} )
94 ref(\ "${class}::"->{$_} ) ne 'GLOB'
96 defined( *{ "${class}::"->{$_} }{CODE} )
99 ? ( \&{"${class}::$_"} )
102 keys %{ "${class}::" }
108 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{linear_isa}
110 mro::get_linear_isa($_[0])
114 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{is_universal}
116 mro::is_universal($_[0])
118 ( $mro_recursor_stack->{cache} || {} )->{UNIVERSAL}{linear_isa}
120 mro::get_linear_isa("UNIVERSAL")
129 constant->import( OLD_MRO => 0 );
130 *DBIx::Class::_Util::get_real_pkg_gen = \&mro::get_pkg_gen;
133 # Both of these are no longer used for anything. However bring
134 # them back after they were purged in 08a8d8f1, as there appear
135 # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/*
136 # in their production codebases. There is no point in breaking these
137 # if whatever they used actually continues to work
142 my $cluck = "The @{[ (caller(1))[3] ]} constant is no more - adjust your code" . Carp::longmess();
144 warn $cluck unless $warned->{$cluck}++;
148 sub DBICTEST () { &$sigh }
149 sub PEEPEENESS () { &$sigh }
152 # FIXME - this is not supposed to be here
153 # Carp::Skip to the rescue soon
154 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
158 use Storable 'nfreeze';
159 use Scalar::Util qw(weaken blessed reftype refaddr);
160 use Sub::Quote qw(qsub);
164 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
165 BEGIN { *deep_clone = \&Storable::dclone }
169 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
170 fail_on_internal_wantarray fail_on_internal_call
171 refdesc refcount hrefaddr set_subname describe_class_methods
172 scope_guard detected_reinvoked_destructor
173 is_exception dbic_internal_try visit_namespaces
174 quote_sub qsub perlstring serialize deep_clone dump_value uniq
176 UNRESOLVABLE_CONDITION
179 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
181 # Override forcing no_defer, and adding naming consistency checks
182 our %refs_closed_over_by_quote_sub_installed_crefs;
184 Carp::confess( "Anonymous quoting not supported by the DBIC quote_sub override - supply a sub name" ) if
192 Carp::confess( "The DBIC quote_sub override expects sub name '$_[0]' to be fully qualified" )
193 unless (my $stash) = $_[0] =~ /^(.+)::/;
196 "The DBIC sub_quote override does not support 'no_install'"
204 'The DBIC quote_sub override expects the namespace-part of sub name '
205 . "'$_[0]' to match the supplied package argument '$_[3]->{package}'"
209 defined $_[3]->{package}
211 $stash ne $_[3]->{package}
214 my @caller = caller(0);
216 package => $caller[0],
218 warning_bits => $caller[9],
219 hintshash => $caller[10],
222 # explicitly forced for everything
227 # just use a growing counter, no need to perform neither compaction
228 # nor any special ithread-level handling
229 $refs_closed_over_by_quote_sub_installed_crefs
230 { scalar keys %refs_closed_over_by_quote_sub_installed_crefs }
236 ! DBIx::Class::_ENV_::BROKEN_WEAK_SCALARREF_VALUES
240 } values %{ $_[2] || {} };
242 Sub::Quote::quote_sub( $_[0], $_[1], $_[2]||{}, $sq_opts );
245 sub sigwarn_silencer ($) {
248 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
250 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
252 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
255 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
257 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
260 croak "Expecting a reference" if ! length ref $_[0];
262 # be careful not to trigger stringification,
263 # reuse @_ as a scratch-pad
264 sprintf '%s%s(0x%x)',
265 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
272 croak "Expecting a reference" if ! length ref $_[0];
274 # No tempvars - must operate on $_[0], otherwise the pad
275 # will count as an extra ref
276 B::svref_2object($_[0])->REFCNT;
279 sub visit_namespaces {
280 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
282 my $visited_count = 1;
284 # A package and a namespace are subtly different things
285 $args->{package} ||= 'main';
286 $args->{package} = 'main' if $args->{package} =~ /^ :: (?: main )? $/x;
287 $args->{package} =~ s/^:://;
289 if ( $args->{action}->($args->{package}) ) {
291 ( ($args->{package} eq 'main') ? '' : $args->{package} )
296 $visited_count += visit_namespaces( %$args, package => $_ ) for
298 # this happens sometimes on %:: traversal
301 { $_ =~ /^(.+?)::$/ ? "$ns$1" : () }
302 do { no strict 'refs'; keys %$ns }
309 # FIXME In another life switch this to a polyfill like the one in namespace::clean
310 sub set_subname ($$) {
313 splice @_, 0, 1, caller(0) . "::$_[0]"
320 local $Storable::canonical = 1;
325 my( %seen, $seen_undef, $numeric_preserving_copy );
328 ? $seen{ $numeric_preserving_copy = $_ }++
335 local $Data::Dumper::Indent = 1
336 unless defined $Data::Dumper::Indent;
342 require Data::Dumper;
343 my $d = Data::Dumper->new([])
356 $d->Sparseseen(1) if modver_gt_or_eq (
357 'Data::Dumper', '2.136'
362 )->Values([$_[0]])->Dump;
364 $dd_obj->Reset->Values([]);
369 sub scope_guard (&) {
370 croak 'Calling scope_guard() in void context makes no sense'
371 if ! defined wantarray;
373 # no direct blessing of coderefs - DESTROY is buggy on those
374 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
378 DBIx::Class::_Util::ScopeGuard;
381 &DBIx::Class::_Util::detected_reinvoked_destructor;
383 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
391 "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@"
397 sub is_exception ($) {
401 # this is not strictly correct - an eval setting $@ to undef
402 # is *not* the same as an eval setting $@ to ''
403 # but for the sake of simplicity assume the following for
405 return 0 unless defined $e;
407 my ($not_blank, $suberror);
409 local $SIG{__DIE__} if $SIG{__DIE__};
412 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
413 # will entirely obviate the need for the encolsing eval{}, as the
414 # condition we guard against is a missing fallback overload
415 $not_blank = ( $e ne '' );
420 if (defined $suberror) {
421 if (length (my $class = blessed($e) )) {
422 carp_unique( sprintf(
423 'External exception class %s implements partial (broken) overloading '
424 . 'preventing its instances from being used in simple ($x eq $y) '
425 . 'comparisons. Given Perl\'s "globally cooperative" exception '
426 . 'handling this type of brokenness is extremely dangerous on '
427 . 'exception objects, as it may (and often does) result in silent '
428 . '"exception substitution". DBIx::Class tries to work around this '
429 . 'as much as possible, but other parts of your software stack may '
430 . 'not be even aware of this. Please submit a bugreport against the '
431 . 'distribution containing %s and in the meantime apply a fix similar '
432 . 'to the one shown at %s, in order to ensure your exception handling '
433 . 'is saner application-wide. What follows is the actual error text '
434 . "as generated by Perl itself:\n\n%s\n ",
437 'http://v.gd/DBIC_overload_tempfix/',
441 # workaround, keeps spice flowing
442 $not_blank = !!( length $e );
445 # not blessed yet failed the 'ne'... this makes 0 sense...
451 # a ref evaluating to '' is definitively a "null object"
454 length( my $class = ref $e )
456 carp_unique( sprintf(
457 "Objects of external exception class '%s' stringify to '' (the "
458 . 'empty string), implementing the so called null-object-pattern. '
459 . 'Given Perl\'s "globally cooperative" exception handling using this '
460 . 'class of exceptions is extremely dangerous, as it may (and often '
461 . 'does) result in silent discarding of errors. DBIx::Class tries to '
462 . 'work around this as much as possible, but other parts of your '
463 . 'software stack may not be even aware of the problem. Please submit '
464 . 'a bugreport against the distribution containing %s',
478 # Recreate the logic of try(), while reusing the catch()/finally() as-is
480 # FIXME: We need to move away from Try::Tiny entirely (way too heavy and
481 # yes, shows up ON TOP of profiles) but this is a batle for another maint
482 sub dbic_internal_try (&;@) {
484 my $try_cref = shift;
485 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
489 if( ref($arg) eq 'Try::Tiny::Catch' ) {
491 croak 'dbic_internal_try() may not be followed by multiple catch() blocks'
496 elsif ( ref($arg) eq 'Try::Tiny::Finally' ) {
497 croak 'dbic_internal_try() does not support finally{}';
501 'dbic_internal_try() encountered an unexpected argument '
502 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
503 . 'a missing semi-colon before or ' # trailing space important
508 my $wantarray = wantarray;
509 my $preexisting_exception = $@;
512 my $all_good = eval {
513 $@ = $preexisting_exception;
515 local $callstack_state->{in_internal_try} = 1
516 unless $callstack_state->{in_internal_try};
518 # always unset - someone may have snuck it in
519 local $SIG{__DIE__} if $SIG{__DIE__};
522 @ret = $try_cref->();
524 elsif( defined $wantarray ) {
525 $ret[0] = $try_cref->();
535 $@ = $preexisting_exception;
538 return $wantarray ? @ret : $ret[0]
540 elsif ( $catch_cref ) {
542 return $catch_cref->($exception);
549 sub in_internal_try { !! $callstack_state->{in_internal_try} }
553 my $destruction_registry = {};
555 sub DBIx::Class::__Util_iThreads_handler__::CLONE {
556 %$destruction_registry = map {
558 ? ( refaddr($_) => $_ )
560 } values %$destruction_registry;
562 weaken($_) for values %$destruction_registry;
564 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
565 # collected before leaving this scope. Depending on the code above, this
566 # may very well be just a preventive measure guarding future modifications
570 # This is almost invariably invoked from within DESTROY
571 # throwing exceptions won't work
572 sub detected_reinvoked_destructor {
574 # quick "garbage collection" pass - prevents the registry
575 # from slowly growing with a bunch of undef-valued keys
576 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
577 for keys %$destruction_registry;
579 if (! length ref $_[0]) {
580 printf STDERR '%s() expects a blessed reference %s',
584 return undef; # don't know wtf to do
586 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
587 weaken( $destruction_registry->{$addr} = $_[0] );
591 carp_unique ( sprintf (
592 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
593 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
594 . 'application, affecting *ALL* classes without active protection against '
595 . 'this. Diagnose and fix the root cause ASAP!!!%s',
597 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
598 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
608 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
609 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
611 sub modver_gt_or_eq ($$) {
612 my ($mod, $ver) = @_;
614 croak "Nonsensical module name supplied"
615 if ! defined $mod or $mod !~ $module_name_rx;
617 croak "Nonsensical minimum version supplied"
618 if ! defined $ver or $ver !~ $ver_rx;
621 my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
623 : croak "$mod does not seem to provide a version (perhaps it never loaded)"
626 ! defined $ver_cache->{$ver}
628 $ver_cache->{$ver} = do {
630 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
631 if SPURIOUS_VERSION_CHECK_WARNINGS;
633 local $SIG{__DIE__} if $SIG{__DIE__};
635 eval { $mod->VERSION($ver) } ? 1 : 0;
641 sub modver_gt_or_eq_and_lt ($$$) {
642 my ($mod, $v_ge, $v_lt) = @_;
644 croak "Nonsensical maximum version supplied"
645 if ! defined $v_lt or $v_lt !~ $ver_rx;
648 modver_gt_or_eq($mod, $v_ge)
650 ! modver_gt_or_eq($mod, $v_lt)
655 # FIXME - should be a private my(), but I'm too uncertain whether
656 # all bases are covered
657 our $describe_class_query_cache;
659 sub describe_class_methods {
660 my ($class, $requested_mro) = @_;
662 croak "Expecting a class name"
663 if not defined $class or $class !~ $module_name_rx;
665 $requested_mro ||= mro::get_mro($class);
667 # mro::set_mro() does not bump pkg_gen - WHAT THE FUCK?!
668 my $query_cache_key = "$class|$requested_mro";
670 my $stack_cache_key =
671 ( mro::get_mro($class) eq $requested_mro )
676 # use a cache on old MRO, since while we are recursing in this function
677 # nothing can possibly change (the speedup is immense)
678 # (yes, people could be tie()ing the stash and adding methods on access
679 # but there is a limit to how much crazy can be supported here)
681 # we use the cache for linear_isa lookups on new MRO as well - it adds
682 # a *tiny* speedup, and simplifies the code a lot
684 local $mro_recursor_stack->{cache} = {}
685 unless $mro_recursor_stack->{cache};
689 $my_gen += get_real_pkg_gen($_) for ( my @full_ISA = (
692 $mro_recursor_stack->{cache}{$stack_cache_key}{linear_isa}
694 mro::get_linear_isa($class, $requested_mro)
698 $mro_recursor_stack->{cache}{$class}{is_universal}
700 mro::is_universal($class)
702 $mro_recursor_stack->{cache}{UNIVERSAL}{linear_isa}
704 mro::get_linear_isa("UNIVERSAL")
709 my $slot = $describe_class_query_cache->{$query_cache_key} ||= {};
711 unless ( ($slot->{cumulative_gen}||0) == $my_gen ) {
713 # remove ourselves from ISA
720 @{ $mro_recursor_stack->{cache}{$stack_cache_key}{linear_isa} }
721 [ 1 .. $#{$mro_recursor_stack->{cache}{$stack_cache_key}{linear_isa}} ]
724 type => $requested_mro,
725 is_c3 => ( ($requested_mro eq 'c3') ? 1 : 0 ),
727 cumulative_gen => $my_gen,
730 # ensure the cache is populated for the parents, code below can then
731 # efficiently operate over the query_cache directly
732 describe_class_methods($_) for reverse @full_ISA;
736 # combine full ISA-order inherited and local method list into a
740 unshift @{ $slot->{methods}{$_->{name}} }, $_
745 $_->{via_class} ne $class
747 $slot->{methods_defined_in_class}{$_->{name}} = $_
752 @{ $slot->{methods}{$_->{name}} } > 1
756 $slot->{methods_with_supers}{$_->{name}} = $slot->{methods}{$_->{name}}
760 # what describe_class_methods for @full_ISA produced above
762 $describe_class_query_cache->{$_}{methods_defined_in_class} || {}
763 } } map { "$_|" . mro::get_mro($_) } reverse @full_ISA ),
765 # our own non-cleaned subs + their attributes
768 # need to account for dummy helper crefs under OLD_MRO
770 ! DBIx::Class::_ENV_::OLD_MRO
772 ! ( ( $Class::C3::MRO{$class} || {} )->{methods}{$_} )
775 # these 2 OR-ed checks are sufficient for 5.10+
777 ref(\ "${class}::"->{$_} ) ne 'GLOB'
779 defined( *{ "${class}::"->{$_} }{CODE} )
785 map { $_ => 1 } attributes::get( \&{"${class}::${_}"} )
789 } keys %{"${class}::"} )
793 # recalculate the pkg_gen on newer perls under Taint mode,
794 # because of shit like:
795 # perl -T -Mmro -e 'package Foo; sub bar {}; defined( *{ "Foo::"->{bar}}{CODE} ) and warn mro::get_pkg_gen("Foo") for (1,2,3)'
798 ! DBIx::Class::_ENV_::OLD_MRO
803 $slot->{cumulative_gen} = 0;
804 $slot->{cumulative_gen} += get_real_pkg_gen($_)
805 for $class, @full_ISA;
816 # Why not just use some higher-level module or at least File::Spec here?
818 # 1) This is a *very* rarely used function, and the deptree is large
819 # enough already as it is
821 # 2) (more importantly) Our tooling is utter shit in this area. There
822 # is no comprehensive support for UNC paths in PathTools and there
823 # are also various small bugs in representation across different
824 # path-manipulation CPAN offerings.
826 # Since this routine is strictly used for logical path processing (it
827 # *must* be able to work with not-yet-existing paths), use this seemingly
828 # simple but I *think* complete implementation to feed to other consumers
830 # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST*
831 # the impulse to bring in an external dependency. During runtime there
832 # is exactly one spot that could potentially maybe once in a blue moon
833 # use this function. Keep it lean.
836 ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x )
840 ( ( length($1) and ! length($2) ) ? '/' : '' )
847 File::Spec->catpath (
848 ( File::Spec->splitpath( "$_[0]" ) )[0,1],
857 # do not ask for a recent version, use 1.x API calls
858 File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects
863 my $list_ctx_ok_stack_marker;
865 sub fail_on_internal_wantarray () {
866 return if $list_ctx_ok_stack_marker;
868 if (! defined wantarray) {
869 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
873 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
875 # these are public API parts that alter behavior on wantarray
876 search | search_related | slice | search_literal
880 # these are explicitly prefixed, since we only recognize them as valid
881 # escapes when they come from the guts of CDBICompat
882 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
888 my ($fr, $want, $argdesc);
891 $fr = [ CORE::caller($cf) ];
892 $want = ( CORE::caller($cf-1) )[5];
893 $argdesc = ref $DB::args[0]
894 ? DBIx::Class::_Util::refdesc($DB::args[0])
900 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
902 DBIx::Class::Exception->throw( sprintf (
903 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
904 $argdesc, @{$fr}[1,2]
905 ), 'with_stacktrace');
908 weaken( $list_ctx_ok_stack_marker = my $mark = [] );
914 sub fail_on_internal_call {
918 $fr = [ CORE::caller(1) ];
919 $argdesc = ref $DB::args[0]
920 ? DBIx::Class::_Util::refdesc($DB::args[0])
921 : ( $DB::args[0] . '' )
926 # need to make allowance for a proxy-yet-direct call
928 $fr->[0] eq 'DBIx::Class::ResultSourceProxy'
930 @fr2 = (CORE::caller(2))
933 ( $fr->[3] =~ /([^:])+$/ )[0]
935 ( $fr2[3] =~ /([^:])+$/ )[0]
945 $check_fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
947 $check_fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
949 DBIx::Class::Exception->throw( sprintf (
950 "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",
951 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
954 B::Deparse->new->coderef2text(\&{$fr->[3]})
956 ), 'with_stacktrace');