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 HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
28 UNSTABLE_DOLLARAT => ( "$]" < 5.013002 ) ? 1 : 0,
32 # the "DBIC_" prefix below is crucial - this is what makes CI pick up
33 # all envvars without further adjusting its scripts
34 # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) }
36 { substr($_, 5) => !!( $ENV{$_} ) }
38 DBIC_SHUFFLE_UNORDERED_RESULTSETS
39 DBIC_ASSERT_NO_INTERNAL_WANTARRAY
40 DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS
41 DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE
42 DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE
46 IV_SIZE => $Config{ivsize},
51 if ( "$]" < 5.009_005) {
53 constant->import( OLD_MRO => 1 );
56 # Yes, I know this is a rather PHP-ish name, but please first read
57 # https://metacpan.org/source/BOBTFISH/MRO-Compat-0.12/lib/MRO/Compat.pm#L363-368
59 # Even if we are using Class::C3::XS it still won't work, as doing
60 # defined( *{ "SubClass::"->{$_} }{CODE} )
61 # will set pkg_gen to the same value for SubClass and *ALL PARENTS*
63 *DBIx::Class::_Util::get_real_pkg_gen = sub ($) {
67 # the non-assign-unless-there-is-a-hash is deliberate
68 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{gen} ||= (
69 Math::BigInt->new( '0x' . ( Digest::MD5::md5_hex( join "\0", map {
71 ( $mro_recursor_stack->{cache} || {} )->{$_}{methlist} ||= do {
78 # this is essentially a uniq_by step
79 # it is crucial on OLD_MRO
80 {( Scalar::Util::refaddr($_) => $_ )}
84 ref(\ "${class}::"->{$_} ) ne 'GLOB'
86 defined( *{ "${class}::"->{$_} }{CODE} )
88 ? ( \&{"${class}::$_"} )
91 keys %{ "${class}::" }
94 # RV to be hashed up and turned into a number
98 $_, # refaddr is sufficient, ignore names entirely
99 attributes::get( $methlist{$_} )
100 )} sort keys %methlist
106 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{linear_isa}
108 mro::get_linear_isa($_[0])
112 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{is_universal}
114 mro::is_universal($_[0])
116 ( $mro_recursor_stack->{cache} || {} )->{UNIVERSAL}{linear_isa}
118 mro::get_linear_isa("UNIVERSAL")
127 constant->import( OLD_MRO => 0 );
128 *DBIx::Class::_Util::get_real_pkg_gen = \&mro::get_pkg_gen;
131 # Both of these are no longer used for anything. However bring
132 # them back after they were purged in 08a8d8f1, as there appear
133 # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/*
134 # in their production codebases. There is no point in breaking these
135 # if whatever they used actually continues to work
140 my $cluck = "The @{[ (caller(1))[3] ]} constant is no more - adjust your code" . Carp::longmess();
142 warn $cluck unless $warned->{$cluck}++;
146 sub DBICTEST () { &$sigh }
147 sub PEEPEENESS () { &$sigh }
150 # FIXME - this is not supposed to be here
151 # Carp::Skip to the rescue soon
152 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
156 use Storable 'nfreeze';
157 use Scalar::Util qw(weaken blessed reftype refaddr);
158 use Sub::Quote qw(qsub);
162 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
163 BEGIN { *deep_clone = \&Storable::dclone }
167 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
168 fail_on_internal_wantarray fail_on_internal_call
169 refdesc refcount hrefaddr set_subname describe_class_methods
170 scope_guard detected_reinvoked_destructor
171 is_exception dbic_internal_try visit_namespaces
172 quote_sub qsub perlstring serialize deep_clone dump_value uniq
174 UNRESOLVABLE_CONDITION
177 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
180 # add preliminary attribute support
182 # To be revisited when Moo with proper attr support ships
183 Sub::Quote->VERSION(2.002);
185 # Override forcing no_defer, and adding naming consistency checks
187 Carp::confess( "Anonymous quoting not supported by the DBIC sub_quote override - supply a sub name" ) if
195 Carp::confess( "The DBIC sub_quote override expects sub name '$_[0]' to be fully qualified" )
196 unless $_[0] =~ /::/;
198 Carp::confess( "The DBIC sub_quote override expects the sub name '$_[0]' to match the supplied 'package' argument" ) if
201 defined $_[3]->{package}
203 index( $_[0], $_[3]->{package} ) != 0
206 my @caller = caller(0);
208 package => $caller[0],
210 warning_bits => $caller[9],
211 hintshash => $caller[10],
214 # explicitly forced for everything
218 my $cref = Sub::Quote::quote_sub( $_[0], $_[1], $_[2]||{}, $sq_opts );
221 # To be revisited when Moo with proper attr support ships
223 # external application does not work on things like :prototype(...), :lvalue, etc
227 Carp::confess( "The DBIC sub_quote override does not support applying of reserved attribute '$_'" )
228 } @{ $sq_opts->{attributes} || []}
230 Carp::confess( "The DBIC sub_quote override does not allow mixing 'attributes' with 'no_install'" )
231 if $sq_opts->{no_install};
233 # might be different from $sq_opts->{package};
234 my ($install_into) = $_[0] =~ /(.+)::[^:]+$/;
236 attributes->import( $install_into, $cref, @attrs );
242 sub sigwarn_silencer ($) {
245 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
247 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
249 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
252 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
254 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
257 croak "Expecting a reference" if ! length ref $_[0];
259 # be careful not to trigger stringification,
260 # reuse @_ as a scratch-pad
261 sprintf '%s%s(0x%x)',
262 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
269 croak "Expecting a reference" if ! length ref $_[0];
271 # No tempvars - must operate on $_[0], otherwise the pad
272 # will count as an extra ref
273 B::svref_2object($_[0])->REFCNT;
276 sub visit_namespaces {
277 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
279 my $visited_count = 1;
281 # A package and a namespace are subtly different things
282 $args->{package} ||= 'main';
283 $args->{package} = 'main' if $args->{package} =~ /^ :: (?: main )? $/x;
284 $args->{package} =~ s/^:://;
286 if ( $args->{action}->($args->{package}) ) {
288 ( ($args->{package} eq 'main') ? '' : $args->{package} )
293 $visited_count += visit_namespaces( %$args, package => $_ ) for
295 # this happens sometimes on %:: traversal
298 { $_ =~ /^(.+?)::$/ ? "$ns$1" : () }
299 do { no strict 'refs'; keys %$ns }
306 # FIXME In another life switch this to a polyfill like the one in namespace::clean
307 sub set_subname ($$) {
310 splice @_, 0, 1, caller(0) . "::$_[0]"
317 local $Storable::canonical = 1;
322 my( %seen, $seen_undef, $numeric_preserving_copy );
325 ? $seen{ $numeric_preserving_copy = $_ }++
332 local $Data::Dumper::Indent = 1
333 unless defined $Data::Dumper::Indent;
339 require Data::Dumper;
340 my $d = Data::Dumper->new([])
353 $d->Sparseseen(1) if modver_gt_or_eq (
354 'Data::Dumper', '2.136'
359 )->Values([$_[0]])->Dump;
361 $dd_obj->Reset->Values([]);
366 sub scope_guard (&) {
367 croak 'Calling scope_guard() in void context makes no sense'
368 if ! defined wantarray;
370 # no direct blessing of coderefs - DESTROY is buggy on those
371 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
375 DBIx::Class::_Util::ScopeGuard;
378 &DBIx::Class::_Util::detected_reinvoked_destructor;
380 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
388 "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@"
394 sub is_exception ($) {
398 # this is not strictly correct - an eval setting $@ to undef
399 # is *not* the same as an eval setting $@ to ''
400 # but for the sake of simplicity assume the following for
402 return 0 unless defined $e;
404 my ($not_blank, $suberror);
406 local $SIG{__DIE__} if $SIG{__DIE__};
409 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
410 # will entirely obviate the need for the encolsing eval{}, as the
411 # condition we guard against is a missing fallback overload
412 $not_blank = ( $e ne '' );
417 if (defined $suberror) {
418 if (length (my $class = blessed($e) )) {
419 carp_unique( sprintf(
420 'External exception class %s implements partial (broken) overloading '
421 . 'preventing its instances from being used in simple ($x eq $y) '
422 . 'comparisons. Given Perl\'s "globally cooperative" exception '
423 . 'handling this type of brokenness is extremely dangerous on '
424 . 'exception objects, as it may (and often does) result in silent '
425 . '"exception substitution". DBIx::Class tries to work around this '
426 . 'as much as possible, but other parts of your software stack may '
427 . 'not be even aware of this. Please submit a bugreport against the '
428 . 'distribution containing %s and in the meantime apply a fix similar '
429 . 'to the one shown at %s, in order to ensure your exception handling '
430 . 'is saner application-wide. What follows is the actual error text '
431 . "as generated by Perl itself:\n\n%s\n ",
434 'http://v.gd/DBIC_overload_tempfix/',
438 # workaround, keeps spice flowing
439 $not_blank = !!( length $e );
442 # not blessed yet failed the 'ne'... this makes 0 sense...
448 # a ref evaluating to '' is definitively a "null object"
451 length( my $class = ref $e )
453 carp_unique( sprintf(
454 "Objects of external exception class '%s' stringify to '' (the "
455 . 'empty string), implementing the so called null-object-pattern. '
456 . 'Given Perl\'s "globally cooperative" exception handling using this '
457 . 'class of exceptions is extremely dangerous, as it may (and often '
458 . 'does) result in silent discarding of errors. DBIx::Class tries to '
459 . 'work around this as much as possible, but other parts of your '
460 . 'software stack may not be even aware of the problem. Please submit '
461 . 'a bugreport against the distribution containing %s',
475 # Recreate the logic of try(), while reusing the catch()/finally() as-is
477 # FIXME: We need to move away from Try::Tiny entirely (way too heavy and
478 # yes, shows up ON TOP of profiles) but this is a batle for another maint
479 sub dbic_internal_try (&;@) {
481 my $try_cref = shift;
482 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
486 if( ref($arg) eq 'Try::Tiny::Catch' ) {
488 croak 'dbic_internal_try() may not be followed by multiple catch() blocks'
493 elsif ( ref($arg) eq 'Try::Tiny::Finally' ) {
494 croak 'dbic_internal_try() does not support finally{}';
498 'dbic_internal_try() encountered an unexpected argument '
499 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
500 . 'a missing semi-colon before or ' # trailing space important
505 my $wantarray = wantarray;
506 my $preexisting_exception = $@;
509 my $all_good = eval {
510 $@ = $preexisting_exception;
512 local $callstack_state->{in_internal_try} = 1
513 unless $callstack_state->{in_internal_try};
515 # always unset - someone may have snuck it in
516 local $SIG{__DIE__} if $SIG{__DIE__};
519 @ret = $try_cref->();
521 elsif( defined $wantarray ) {
522 $ret[0] = $try_cref->();
532 $@ = $preexisting_exception;
535 return $wantarray ? @ret : $ret[0]
537 elsif ( $catch_cref ) {
539 return $catch_cref->($exception);
546 sub in_internal_try { !! $callstack_state->{in_internal_try} }
550 my $destruction_registry = {};
552 sub DBIx::Class::__Util_iThreads_handler__::CLONE {
553 %$destruction_registry = map {
555 ? ( refaddr($_) => $_ )
557 } values %$destruction_registry;
559 weaken($_) for values %$destruction_registry;
561 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
562 # collected before leaving this scope. Depending on the code above, this
563 # may very well be just a preventive measure guarding future modifications
567 # This is almost invariably invoked from within DESTROY
568 # throwing exceptions won't work
569 sub detected_reinvoked_destructor {
571 # quick "garbage collection" pass - prevents the registry
572 # from slowly growing with a bunch of undef-valued keys
573 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
574 for keys %$destruction_registry;
576 if (! length ref $_[0]) {
577 printf STDERR '%s() expects a blessed reference %s',
581 return undef; # don't know wtf to do
583 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
584 weaken( $destruction_registry->{$addr} = $_[0] );
588 carp_unique ( sprintf (
589 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
590 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
591 . 'application, affecting *ALL* classes without active protection against '
592 . 'this. Diagnose and fix the root cause ASAP!!!%s',
594 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
595 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
605 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
606 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
608 sub modver_gt_or_eq ($$) {
609 my ($mod, $ver) = @_;
611 croak "Nonsensical module name supplied"
612 if ! defined $mod or $mod !~ $module_name_rx;
614 croak "Nonsensical minimum version supplied"
615 if ! defined $ver or $ver !~ $ver_rx;
618 my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
620 : croak "$mod does not seem to provide a version (perhaps it never loaded)"
623 ! defined $ver_cache->{$ver}
625 $ver_cache->{$ver} = do {
627 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
628 if SPURIOUS_VERSION_CHECK_WARNINGS;
630 local $SIG{__DIE__} if $SIG{__DIE__};
632 eval { $mod->VERSION($ver) } ? 1 : 0;
638 sub modver_gt_or_eq_and_lt ($$$) {
639 my ($mod, $v_ge, $v_lt) = @_;
641 croak "Nonsensical maximum version supplied"
642 if ! defined $v_lt or $v_lt !~ $ver_rx;
645 modver_gt_or_eq($mod, $v_ge)
647 ! modver_gt_or_eq($mod, $v_lt)
652 # FIXME - should be a private my(), but I'm too uncertain whether
653 # all bases are covered
654 our $describe_class_query_cache;
656 sub describe_class_methods {
659 croak "Expecting a class name"
660 if not defined $class or $class !~ $module_name_rx;
662 # use a cache on old MRO, since while we are recursing in this function
663 # nothing can possibly change (the speedup is immense)
664 # (yes, people could be tie()ing the stash and adding methods on access
665 # but there is a limit to how much crazy can be supported here)
667 # we use the cache for linear_isa lookups on new MRO as well - it adds
668 # a *tiny* speedup, and simplifies the code a lot
670 local $mro_recursor_stack->{cache} = {}
671 unless $mro_recursor_stack->{cache};
675 $my_gen += get_real_pkg_gen($_) for ( my @full_ISA = (
678 $mro_recursor_stack->{cache}{$class}{linear_isa}
680 mro::get_linear_isa($class)
684 $mro_recursor_stack->{cache}{$class}{is_universal}
686 mro::is_universal($class)
688 $mro_recursor_stack->{cache}{UNIVERSAL}{linear_isa}
690 mro::get_linear_isa("UNIVERSAL")
695 my $slot = $describe_class_query_cache->{$class} ||= {};
697 unless ( ($slot->{cumulative_gen}||0) == $my_gen ) {
699 # remove ourselves from ISA
706 @{ $mro_recursor_stack->{cache}{$class}{linear_isa} }
707 [ 1 .. $#{$mro_recursor_stack->{cache}{$class}{linear_isa}} ]
710 type => mro::get_mro($class),
712 cumulative_gen => $my_gen,
714 $slot->{mro}{is_c3} = ($slot->{mro}{type} eq 'c3') ? 1 : 0;
716 # ensure the cache is populated for the parents, code below can then
717 # efficiently operate over the query_cache directly
718 describe_class_methods($_) for reverse @full_ISA;
720 my ($methods_seen_via_ISA_on_old_mro, $current_node_refaddr);
723 # combine full ISA-order inherited and local method list into a
727 $current_node_refaddr = refaddr($_)
731 unshift @{ $slot->{methods}{$_->{name}} }, $_
736 $_->{via_class} ne $class
738 $slot->{methods_defined_in_class}{$_->{name}} = $_
743 @{ $slot->{methods}{$_->{name}} } > 1
747 $slot->{methods_with_supers}{$_->{name}} = $slot->{methods}{$_->{name}}
751 # what describe_class_methods for @full_ISA produced above
753 $describe_class_query_cache->{$_}{methods_defined_in_class} || {}
754 } } reverse @full_ISA ),
756 # our own non-cleaned subs + their attributes
759 # these 2 OR-ed checks are sufficient for 5.10+
761 ref(\ "${class}::"->{$_} ) ne 'GLOB'
763 defined( *{ "${class}::"->{$_} }{CODE} )
766 # need to account for dummy helper crefs under OLD_MRO
768 ! DBIx::Class::_ENV_::OLD_MRO
771 $methods_seen_via_ISA_on_old_mro ||= do {
773 $rv->{$_->{name}}->{ refaddr( \&{ "$_->{via_class}::$_->{name}"} ) } = 1 for
775 { values %{ $describe_class_query_cache->{$_}{methods} } }
781 ! $methods_seen_via_ISA_on_old_mro->{$_}
783 ! $methods_seen_via_ISA_on_old_mro->{$_}{ refaddr( \&{"${class}::${_}"} ) }
791 map { $_ => 1 } attributes::get( \&{"${class}::${_}"} )
795 } keys %{"${class}::"} )
799 # recalculate the pkg_gen on newer perls under Taint mode,
800 # because of shit like:
801 # perl -T -Mmro -e 'package Foo; sub bar {}; defined( *{ "Foo::"->{bar}}{CODE} ) and warn mro::get_pkg_gen("Foo") for (1,2,3)'
804 ! DBIx::Class::_ENV_::OLD_MRO
809 $slot->{cumulative_gen} = 0;
810 $slot->{cumulative_gen} += get_real_pkg_gen($_)
811 for $class, @full_ISA;
822 # Why not just use some higher-level module or at least File::Spec here?
824 # 1) This is a *very* rarely used function, and the deptree is large
825 # enough already as it is
827 # 2) (more importantly) Our tooling is utter shit in this area. There
828 # is no comprehensive support for UNC paths in PathTools and there
829 # are also various small bugs in representation across different
830 # path-manipulation CPAN offerings.
832 # Since this routine is strictly used for logical path processing (it
833 # *must* be able to work with not-yet-existing paths), use this seemingly
834 # simple but I *think* complete implementation to feed to other consumers
836 # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST*
837 # the impulse to bring in an external dependency. During runtime there
838 # is exactly one spot that could potentially maybe once in a blue moon
839 # use this function. Keep it lean.
842 ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x )
846 ( ( length($1) and ! length($2) ) ? '/' : '' )
853 File::Spec->catpath (
854 ( File::Spec->splitpath( "$_[0]" ) )[0,1],
863 # do not ask for a recent version, use 1.x API calls
864 File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects
869 my $list_ctx_ok_stack_marker;
871 sub fail_on_internal_wantarray () {
872 return if $list_ctx_ok_stack_marker;
874 if (! defined wantarray) {
875 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
879 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
881 # these are public API parts that alter behavior on wantarray
882 search | search_related | slice | search_literal
886 # these are explicitly prefixed, since we only recognize them as valid
887 # escapes when they come from the guts of CDBICompat
888 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
894 my ($fr, $want, $argdesc);
897 $fr = [ CORE::caller($cf) ];
898 $want = ( CORE::caller($cf-1) )[5];
899 $argdesc = ref $DB::args[0]
900 ? DBIx::Class::_Util::refdesc($DB::args[0])
906 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
908 DBIx::Class::Exception->throw( sprintf (
909 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
910 $argdesc, @{$fr}[1,2]
911 ), 'with_stacktrace');
914 weaken( $list_ctx_ok_stack_marker = my $mark = [] );
920 sub fail_on_internal_call {
924 $fr = [ CORE::caller(1) ];
925 $argdesc = ref $DB::args[0]
926 ? DBIx::Class::_Util::refdesc($DB::args[0])
927 : ( $DB::args[0] . '' )
932 # need to make allowance for a proxy-yet-direct call
934 $fr->[0] eq 'DBIx::Class::ResultSourceProxy'
936 @fr2 = (CORE::caller(2))
939 ( $fr->[3] =~ /([^:])+$/ )[0]
941 ( $fr2[3] =~ /([^:])+$/ )[0]
951 $check_fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
953 $check_fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
955 DBIx::Class::Exception->throw( sprintf (
956 "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",
957 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
960 B::Deparse->new->coderef2text(\&{$fr->[3]})
962 ), 'with_stacktrace');