1 package # hide from PAUSE
4 use DBIx::Class::StartupCheck; # load es early as we can, usually a noop
9 my $mro_recursor_stack;
12 package # hide from pause
25 BROKEN_FORK => (OS_NAME eq 'MSWin32') ? 1 : 0,
27 BROKEN_GOTO => ( PERL_VERSION < 5.008003 ) ? 1 : 0,
29 # perl -MScalar::Util=weaken -e 'weaken( $hash{key} = \"value" )'
30 BROKEN_WEAK_SCALARREF_VALUES => ( PERL_VERSION < 5.008003 ) ? 1 : 0,
32 HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
34 UNSTABLE_DOLLARAT => ( PERL_VERSION < 5.013002 ) ? 1 : 0,
38 # the "DBIC_" prefix below is crucial - this is what makes CI pick up
39 # all envvars without further adjusting its scripts
40 # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) }
42 { substr($_, 5) => !!( $ENV{$_} ) }
44 DBIC_SHUFFLE_UNORDERED_RESULTSETS
45 DBIC_ASSERT_NO_INTERNAL_WANTARRAY
46 DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS
47 DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE
48 DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE
52 IV_SIZE => $Config{ivsize},
55 if ( PERL_VERSION < 5.009_005) {
57 constant->import( OLD_MRO => 1 );
60 # Yes, I know this is a rather PHP-ish name, but please first read
61 # https://metacpan.org/source/BOBTFISH/MRO-Compat-0.12/lib/MRO/Compat.pm#L363-368
63 # Even if we are using Class::C3::XS it still won't work, as doing
64 # defined( *{ "SubClass::"->{$_} }{CODE} )
65 # will set pkg_gen to the same value for SubClass and *ALL PARENTS*
67 *DBIx::Class::_Util::get_real_pkg_gen = sub ($) {
71 # the non-assign-unless-there-is-a-hash is deliberate
72 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{gen} ||= (
73 Math::BigInt->new( '0x' . ( Digest::MD5::md5_hex( join "\0", map {
75 ( $mro_recursor_stack->{cache} || {} )->{$_}{methlist} ||= do {
80 # RV to be hashed up and turned into a number
85 # stringification should be sufficient, ignore names/refaddr entirely
87 attributes::get( $_ ),
91 # skip dummy C::C3 helper crefs
92 ! ( ( $Class::C3::MRO{$class} || {} )->{methods}{$_} )
95 ref(\ "${class}::"->{$_} ) ne 'GLOB'
97 defined( *{ "${class}::"->{$_} }{CODE} )
100 ? ( \&{"${class}::$_"} )
103 keys %{ "${class}::" }
109 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{linear_isa}
111 mro::get_linear_isa($_[0])
115 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{is_universal}
117 mro::is_universal($_[0])
119 ( $mro_recursor_stack->{cache} || {} )->{UNIVERSAL}{linear_isa}
121 mro::get_linear_isa("UNIVERSAL")
130 constant->import( OLD_MRO => 0 );
131 *DBIx::Class::_Util::get_real_pkg_gen = \&mro::get_pkg_gen;
134 # Both of these are no longer used for anything. However bring
135 # them back after they were purged in 08a8d8f1, as there appear
136 # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/*
137 # in their production codebases. There is no point in breaking these
138 # if whatever they used actually continues to work
143 my $cluck = "The @{[ (caller(1))[3] ]} constant is no more - adjust your code" . Carp::longmess();
145 warn $cluck unless $warned->{$cluck}++;
149 sub DBICTEST () { &$sigh }
150 sub PEEPEENESS () { &$sigh }
153 use constant SPURIOUS_VERSION_CHECK_WARNINGS => ( DBIx::Class::_ENV_::PERL_VERSION < 5.010 ? 1 : 0);
155 # FIXME - this is not supposed to be here
156 # Carp::Skip to the rescue soon
157 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
161 use Storable 'nfreeze';
162 use Scalar::Util qw(weaken blessed reftype refaddr);
163 use Sub::Quote qw(qsub);
167 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
168 BEGIN { *deep_clone = \&Storable::dclone }
172 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
173 fail_on_internal_wantarray fail_on_internal_call
174 refdesc refcount hrefaddr set_subname describe_class_methods
175 scope_guard detected_reinvoked_destructor
176 is_exception dbic_internal_try visit_namespaces
177 quote_sub qsub perlstring serialize deep_clone dump_value uniq
179 UNRESOLVABLE_CONDITION
182 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
184 # Override forcing no_defer, and adding naming consistency checks
185 our %refs_closed_over_by_quote_sub_installed_crefs;
187 Carp::confess( "Anonymous quoting not supported by the DBIC quote_sub override - supply a sub name" ) if
195 Carp::confess( "The DBIC quote_sub override expects sub name '$_[0]' to be fully qualified" )
196 unless (my $stash) = $_[0] =~ /^(.+)::/;
199 "The DBIC sub_quote override does not support 'no_install'"
207 'The DBIC quote_sub override expects the namespace-part of sub name '
208 . "'$_[0]' to match the supplied package argument '$_[3]->{package}'"
212 defined $_[3]->{package}
214 $stash ne $_[3]->{package}
217 my @caller = caller(0);
219 package => $caller[0],
221 warning_bits => $caller[9],
222 hintshash => $caller[10],
225 # explicitly forced for everything
230 # just use a growing counter, no need to perform neither compaction
231 # nor any special ithread-level handling
232 $refs_closed_over_by_quote_sub_installed_crefs
233 { scalar keys %refs_closed_over_by_quote_sub_installed_crefs }
239 ! DBIx::Class::_ENV_::BROKEN_WEAK_SCALARREF_VALUES
243 } values %{ $_[2] || {} };
245 Sub::Quote::quote_sub( $_[0], $_[1], $_[2]||{}, $sq_opts );
248 sub sigwarn_silencer ($) {
251 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
253 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
255 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
258 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
260 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
263 croak "Expecting a reference" if ! length ref $_[0];
265 # be careful not to trigger stringification,
266 # reuse @_ as a scratch-pad
267 sprintf '%s%s(0x%x)',
268 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
275 croak "Expecting a reference" if ! length ref $_[0];
277 # No tempvars - must operate on $_[0], otherwise the pad
278 # will count as an extra ref
279 B::svref_2object($_[0])->REFCNT;
282 sub visit_namespaces {
283 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
285 my $visited_count = 1;
287 # A package and a namespace are subtly different things
288 $args->{package} ||= 'main';
289 $args->{package} = 'main' if $args->{package} =~ /^ :: (?: main )? $/x;
290 $args->{package} =~ s/^:://;
292 if ( $args->{action}->($args->{package}) ) {
294 ( ($args->{package} eq 'main') ? '' : $args->{package} )
299 $visited_count += visit_namespaces( %$args, package => $_ ) for
301 # this happens sometimes on %:: traversal
304 { $_ =~ /^(.+?)::$/ ? "$ns$1" : () }
305 do { no strict 'refs'; keys %$ns }
312 # FIXME In another life switch this to a polyfill like the one in namespace::clean
313 sub set_subname ($$) {
316 splice @_, 0, 1, caller(0) . "::$_[0]"
323 local $Storable::canonical = 1;
328 my( %seen, $seen_undef, $numeric_preserving_copy );
331 ? $seen{ $numeric_preserving_copy = $_ }++
338 local $Data::Dumper::Indent = 1
339 unless defined $Data::Dumper::Indent;
345 require Data::Dumper;
346 my $d = Data::Dumper->new([])
359 $d->Sparseseen(1) if modver_gt_or_eq (
360 'Data::Dumper', '2.136'
365 )->Values([$_[0]])->Dump;
367 $dd_obj->Reset->Values([]);
372 sub scope_guard (&) {
373 croak 'Calling scope_guard() in void context makes no sense'
374 if ! defined wantarray;
376 # no direct blessing of coderefs - DESTROY is buggy on those
377 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
381 DBIx::Class::_Util::ScopeGuard;
384 &DBIx::Class::_Util::detected_reinvoked_destructor;
386 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
394 "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@"
400 sub is_exception ($) {
404 # this is not strictly correct - an eval setting $@ to undef
405 # is *not* the same as an eval setting $@ to ''
406 # but for the sake of simplicity assume the following for
408 return 0 unless defined $e;
410 my ($not_blank, $suberror);
412 local $SIG{__DIE__} if $SIG{__DIE__};
415 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
416 # will entirely obviate the need for the encolsing eval{}, as the
417 # condition we guard against is a missing fallback overload
418 $not_blank = ( $e ne '' );
423 if (defined $suberror) {
424 if (length (my $class = blessed($e) )) {
425 carp_unique( sprintf(
426 'External exception class %s implements partial (broken) overloading '
427 . 'preventing its instances from being used in simple ($x eq $y) '
428 . 'comparisons. Given Perl\'s "globally cooperative" exception '
429 . 'handling this type of brokenness is extremely dangerous on '
430 . 'exception objects, as it may (and often does) result in silent '
431 . '"exception substitution". DBIx::Class tries to work around this '
432 . 'as much as possible, but other parts of your software stack may '
433 . 'not be even aware of this. Please submit a bugreport against the '
434 . 'distribution containing %s and in the meantime apply a fix similar '
435 . 'to the one shown at %s, in order to ensure your exception handling '
436 . 'is saner application-wide. What follows is the actual error text '
437 . "as generated by Perl itself:\n\n%s\n ",
440 'http://v.gd/DBIC_overload_tempfix/',
444 # workaround, keeps spice flowing
445 $not_blank = !!( length $e );
448 # not blessed yet failed the 'ne'... this makes 0 sense...
454 # a ref evaluating to '' is definitively a "null object"
457 length( my $class = ref $e )
459 carp_unique( sprintf(
460 "Objects of external exception class '%s' stringify to '' (the "
461 . 'empty string), implementing the so called null-object-pattern. '
462 . 'Given Perl\'s "globally cooperative" exception handling using this '
463 . 'class of exceptions is extremely dangerous, as it may (and often '
464 . 'does) result in silent discarding of errors. DBIx::Class tries to '
465 . 'work around this as much as possible, but other parts of your '
466 . 'software stack may not be even aware of the problem. Please submit '
467 . 'a bugreport against the distribution containing %s',
481 # Recreate the logic of try(), while reusing the catch()/finally() as-is
483 # FIXME: We need to move away from Try::Tiny entirely (way too heavy and
484 # yes, shows up ON TOP of profiles) but this is a batle for another maint
485 sub dbic_internal_try (&;@) {
487 my $try_cref = shift;
488 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
492 if( ref($arg) eq 'Try::Tiny::Catch' ) {
494 croak 'dbic_internal_try() may not be followed by multiple catch() blocks'
499 elsif ( ref($arg) eq 'Try::Tiny::Finally' ) {
500 croak 'dbic_internal_try() does not support finally{}';
504 'dbic_internal_try() encountered an unexpected argument '
505 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
506 . 'a missing semi-colon before or ' # trailing space important
511 my $wantarray = wantarray;
512 my $preexisting_exception = $@;
515 my $all_good = eval {
516 $@ = $preexisting_exception;
518 local $callstack_state->{in_internal_try} = 1
519 unless $callstack_state->{in_internal_try};
521 # always unset - someone may have snuck it in
522 local $SIG{__DIE__} if $SIG{__DIE__};
525 @ret = $try_cref->();
527 elsif( defined $wantarray ) {
528 $ret[0] = $try_cref->();
538 $@ = $preexisting_exception;
541 return $wantarray ? @ret : $ret[0]
543 elsif ( $catch_cref ) {
545 return $catch_cref->($exception);
552 sub in_internal_try { !! $callstack_state->{in_internal_try} }
556 my $destruction_registry = {};
558 sub DBIx::Class::__Util_iThreads_handler__::CLONE {
559 %$destruction_registry = map {
561 ? ( refaddr($_) => $_ )
563 } values %$destruction_registry;
565 weaken($_) for values %$destruction_registry;
567 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
568 # collected before leaving this scope. Depending on the code above, this
569 # may very well be just a preventive measure guarding future modifications
573 # This is almost invariably invoked from within DESTROY
574 # throwing exceptions won't work
575 sub detected_reinvoked_destructor {
577 # quick "garbage collection" pass - prevents the registry
578 # from slowly growing with a bunch of undef-valued keys
579 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
580 for keys %$destruction_registry;
582 if (! length ref $_[0]) {
583 printf STDERR '%s() expects a blessed reference %s',
587 return undef; # don't know wtf to do
589 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
590 weaken( $destruction_registry->{$addr} = $_[0] );
594 carp_unique ( sprintf (
595 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
596 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
597 . 'application, affecting *ALL* classes without active protection against '
598 . 'this. Diagnose and fix the root cause ASAP!!!%s',
600 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
601 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
611 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
612 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
614 sub modver_gt_or_eq ($$) {
615 my ($mod, $ver) = @_;
617 croak "Nonsensical module name supplied"
618 if ! defined $mod or $mod !~ $module_name_rx;
620 croak "Nonsensical minimum version supplied"
621 if ! defined $ver or $ver !~ $ver_rx;
624 my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
626 : croak "$mod does not seem to provide a version (perhaps it never loaded)"
629 ! defined $ver_cache->{$ver}
631 $ver_cache->{$ver} = do {
633 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
634 if SPURIOUS_VERSION_CHECK_WARNINGS;
636 local $SIG{__DIE__} if $SIG{__DIE__};
638 eval { $mod->VERSION($ver) } ? 1 : 0;
644 sub modver_gt_or_eq_and_lt ($$$) {
645 my ($mod, $v_ge, $v_lt) = @_;
647 croak "Nonsensical maximum version supplied"
648 if ! defined $v_lt or $v_lt !~ $ver_rx;
651 modver_gt_or_eq($mod, $v_ge)
653 ! modver_gt_or_eq($mod, $v_lt)
658 # FIXME - should be a private my(), but I'm too uncertain whether
659 # all bases are covered
660 our $describe_class_query_cache;
662 sub describe_class_methods {
663 my ($class, $requested_mro) = @_;
665 croak "Expecting a class name"
666 if not defined $class or $class !~ $module_name_rx;
668 $requested_mro ||= mro::get_mro($class);
670 # mro::set_mro() does not bump pkg_gen - WHAT THE FUCK?!
671 my $query_cache_key = "$class|$requested_mro";
673 my $stack_cache_key =
674 ( mro::get_mro($class) eq $requested_mro )
679 # use a cache on old MRO, since while we are recursing in this function
680 # nothing can possibly change (the speedup is immense)
681 # (yes, people could be tie()ing the stash and adding methods on access
682 # but there is a limit to how much crazy can be supported here)
684 # we use the cache for linear_isa lookups on new MRO as well - it adds
685 # a *tiny* speedup, and simplifies the code a lot
687 local $mro_recursor_stack->{cache} = {}
688 unless $mro_recursor_stack->{cache};
692 $my_gen += get_real_pkg_gen($_) for ( my @full_ISA = (
695 $mro_recursor_stack->{cache}{$stack_cache_key}{linear_isa}
697 mro::get_linear_isa($class, $requested_mro)
701 $mro_recursor_stack->{cache}{$class}{is_universal}
703 mro::is_universal($class)
705 $mro_recursor_stack->{cache}{UNIVERSAL}{linear_isa}
707 mro::get_linear_isa("UNIVERSAL")
712 my $slot = $describe_class_query_cache->{$query_cache_key} ||= {};
714 unless ( ($slot->{cumulative_gen}||0) == $my_gen ) {
716 # remove ourselves from ISA
723 @{ $mro_recursor_stack->{cache}{$stack_cache_key}{linear_isa} }
724 [ 1 .. $#{$mro_recursor_stack->{cache}{$stack_cache_key}{linear_isa}} ]
727 type => $requested_mro,
728 is_c3 => ( ($requested_mro eq 'c3') ? 1 : 0 ),
730 cumulative_gen => $my_gen,
733 # ensure the cache is populated for the parents, code below can then
734 # efficiently operate over the query_cache directly
735 describe_class_methods($_) for reverse @full_ISA;
739 # combine full ISA-order inherited and local method list into a
743 unshift @{ $slot->{methods}{$_->{name}} }, $_
748 $_->{via_class} ne $class
750 $slot->{methods_defined_in_class}{$_->{name}} = $_
755 @{ $slot->{methods}{$_->{name}} } > 1
759 $slot->{methods_with_supers}{$_->{name}} = $slot->{methods}{$_->{name}}
763 # what describe_class_methods for @full_ISA produced above
765 $describe_class_query_cache->{$_}{methods_defined_in_class} || {}
766 } } map { "$_|" . mro::get_mro($_) } reverse @full_ISA ),
768 # our own non-cleaned subs + their attributes
771 # need to account for dummy helper crefs under OLD_MRO
773 ! DBIx::Class::_ENV_::OLD_MRO
775 ! ( ( $Class::C3::MRO{$class} || {} )->{methods}{$_} )
778 # these 2 OR-ed checks are sufficient for 5.10+
780 ref(\ "${class}::"->{$_} ) ne 'GLOB'
782 defined( *{ "${class}::"->{$_} }{CODE} )
788 map { $_ => 1 } attributes::get( \&{"${class}::${_}"} )
792 } keys %{"${class}::"} )
796 # recalculate the pkg_gen on newer perls under Taint mode,
797 # because of shit like:
798 # perl -T -Mmro -e 'package Foo; sub bar {}; defined( *{ "Foo::"->{bar}}{CODE} ) and warn mro::get_pkg_gen("Foo") for (1,2,3)'
801 ! DBIx::Class::_ENV_::OLD_MRO
806 $slot->{cumulative_gen} = 0;
807 $slot->{cumulative_gen} += get_real_pkg_gen($_)
808 for $class, @full_ISA;
819 # Why not just use some higher-level module or at least File::Spec here?
821 # 1) This is a *very* rarely used function, and the deptree is large
822 # enough already as it is
824 # 2) (more importantly) Our tooling is utter shit in this area. There
825 # is no comprehensive support for UNC paths in PathTools and there
826 # are also various small bugs in representation across different
827 # path-manipulation CPAN offerings.
829 # Since this routine is strictly used for logical path processing (it
830 # *must* be able to work with not-yet-existing paths), use this seemingly
831 # simple but I *think* complete implementation to feed to other consumers
833 # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST*
834 # the impulse to bring in an external dependency. During runtime there
835 # is exactly one spot that could potentially maybe once in a blue moon
836 # use this function. Keep it lean.
839 ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x )
843 ( ( length($1) and ! length($2) ) ? '/' : '' )
850 File::Spec->catpath (
851 ( File::Spec->splitpath( "$_[0]" ) )[0,1],
860 # do not ask for a recent version, use 1.x API calls
861 File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects
866 my $list_ctx_ok_stack_marker;
868 sub fail_on_internal_wantarray () {
869 return if $list_ctx_ok_stack_marker;
871 if (! defined wantarray) {
872 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
876 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
878 # these are public API parts that alter behavior on wantarray
879 search | search_related | slice | search_literal
883 # these are explicitly prefixed, since we only recognize them as valid
884 # escapes when they come from the guts of CDBICompat
885 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
891 my ($fr, $want, $argdesc);
894 $fr = [ CORE::caller($cf) ];
895 $want = ( CORE::caller($cf-1) )[5];
896 $argdesc = ref $DB::args[0]
897 ? DBIx::Class::_Util::refdesc($DB::args[0])
903 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
905 DBIx::Class::Exception->throw( sprintf (
906 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
907 $argdesc, @{$fr}[1,2]
908 ), 'with_stacktrace');
911 weaken( $list_ctx_ok_stack_marker = my $mark = [] );
917 sub fail_on_internal_call {
921 $fr = [ CORE::caller(1) ];
922 $argdesc = ref $DB::args[0]
923 ? DBIx::Class::_Util::refdesc($DB::args[0])
924 : ( $DB::args[0] . '' )
929 # need to make allowance for a proxy-yet-direct call
931 $fr->[0] eq 'DBIx::Class::ResultSourceProxy'
933 @fr2 = (CORE::caller(2))
936 ( $fr->[3] =~ /([^:])+$/ )[0]
938 ( $fr2[3] =~ /([^:])+$/ )[0]
948 $check_fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
950 $check_fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
952 DBIx::Class::Exception->throw( sprintf (
953 "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",
954 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
957 B::Deparse->new->coderef2text(\&{$fr->[3]})
959 ), 'with_stacktrace');