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 {
76 # RV to be hashed up and turned into a number
81 # stringification should be sufficient, ignore names/refaddr entirely
83 attributes::get( $_ ),
87 # skip dummy C::C3 helper crefs
88 ! ( ( $Class::C3::MRO{$class} || {} )->{methods}{$_} )
91 ref(\ "${class}::"->{$_} ) ne 'GLOB'
93 defined( *{ "${class}::"->{$_} }{CODE} )
96 ? ( \&{"${class}::$_"} )
99 keys %{ "${class}::" }
105 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{linear_isa}
107 mro::get_linear_isa($_[0])
111 ( $mro_recursor_stack->{cache} || {} )->{$_[0]}{is_universal}
113 mro::is_universal($_[0])
115 ( $mro_recursor_stack->{cache} || {} )->{UNIVERSAL}{linear_isa}
117 mro::get_linear_isa("UNIVERSAL")
126 constant->import( OLD_MRO => 0 );
127 *DBIx::Class::_Util::get_real_pkg_gen = \&mro::get_pkg_gen;
130 # Both of these are no longer used for anything. However bring
131 # them back after they were purged in 08a8d8f1, as there appear
132 # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/*
133 # in their production codebases. There is no point in breaking these
134 # if whatever they used actually continues to work
139 my $cluck = "The @{[ (caller(1))[3] ]} constant is no more - adjust your code" . Carp::longmess();
141 warn $cluck unless $warned->{$cluck}++;
145 sub DBICTEST () { &$sigh }
146 sub PEEPEENESS () { &$sigh }
149 # FIXME - this is not supposed to be here
150 # Carp::Skip to the rescue soon
151 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
155 use Storable 'nfreeze';
156 use Scalar::Util qw(weaken blessed reftype refaddr);
157 use Sub::Quote qw(qsub);
161 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
162 BEGIN { *deep_clone = \&Storable::dclone }
166 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
167 fail_on_internal_wantarray fail_on_internal_call
168 refdesc refcount hrefaddr set_subname describe_class_methods
169 scope_guard detected_reinvoked_destructor
170 is_exception dbic_internal_try visit_namespaces
171 quote_sub qsub perlstring serialize deep_clone dump_value uniq
173 UNRESOLVABLE_CONDITION
176 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
179 # add preliminary attribute support
181 # To be revisited when Moo with proper attr support ships
182 Sub::Quote->VERSION(2.002);
184 # Override forcing no_defer, and adding naming consistency checks
186 Carp::confess( "Anonymous quoting not supported by the DBIC sub_quote override - supply a sub name" ) if
194 Carp::confess( "The DBIC sub_quote override expects sub name '$_[0]' to be fully qualified" )
195 unless $_[0] =~ /::/;
197 Carp::confess( "The DBIC sub_quote override expects the sub name '$_[0]' to match the supplied 'package' argument" ) if
200 defined $_[3]->{package}
202 index( $_[0], $_[3]->{package} ) != 0
205 my @caller = caller(0);
207 package => $caller[0],
209 warning_bits => $caller[9],
210 hintshash => $caller[10],
213 # explicitly forced for everything
217 my $cref = Sub::Quote::quote_sub( $_[0], $_[1], $_[2]||{}, $sq_opts );
220 # To be revisited when Moo with proper attr support ships
222 # external application does not work on things like :prototype(...), :lvalue, etc
226 Carp::confess( "The DBIC sub_quote override does not support applying of reserved attribute '$_'" )
227 } @{ $sq_opts->{attributes} || []}
229 Carp::confess( "The DBIC sub_quote override does not allow mixing 'attributes' with 'no_install'" )
230 if $sq_opts->{no_install};
232 # might be different from $sq_opts->{package};
233 my ($install_into) = $_[0] =~ /(.+)::[^:]+$/;
235 attributes->import( $install_into, $cref, @attrs );
241 sub sigwarn_silencer ($) {
244 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
246 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
248 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
251 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
253 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
256 croak "Expecting a reference" if ! length ref $_[0];
258 # be careful not to trigger stringification,
259 # reuse @_ as a scratch-pad
260 sprintf '%s%s(0x%x)',
261 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
268 croak "Expecting a reference" if ! length ref $_[0];
270 # No tempvars - must operate on $_[0], otherwise the pad
271 # will count as an extra ref
272 B::svref_2object($_[0])->REFCNT;
275 sub visit_namespaces {
276 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
278 my $visited_count = 1;
280 # A package and a namespace are subtly different things
281 $args->{package} ||= 'main';
282 $args->{package} = 'main' if $args->{package} =~ /^ :: (?: main )? $/x;
283 $args->{package} =~ s/^:://;
285 if ( $args->{action}->($args->{package}) ) {
287 ( ($args->{package} eq 'main') ? '' : $args->{package} )
292 $visited_count += visit_namespaces( %$args, package => $_ ) for
294 # this happens sometimes on %:: traversal
297 { $_ =~ /^(.+?)::$/ ? "$ns$1" : () }
298 do { no strict 'refs'; keys %$ns }
305 # FIXME In another life switch this to a polyfill like the one in namespace::clean
306 sub set_subname ($$) {
309 splice @_, 0, 1, caller(0) . "::$_[0]"
316 local $Storable::canonical = 1;
321 my( %seen, $seen_undef, $numeric_preserving_copy );
324 ? $seen{ $numeric_preserving_copy = $_ }++
331 local $Data::Dumper::Indent = 1
332 unless defined $Data::Dumper::Indent;
338 require Data::Dumper;
339 my $d = Data::Dumper->new([])
352 $d->Sparseseen(1) if modver_gt_or_eq (
353 'Data::Dumper', '2.136'
358 )->Values([$_[0]])->Dump;
360 $dd_obj->Reset->Values([]);
365 sub scope_guard (&) {
366 croak 'Calling scope_guard() in void context makes no sense'
367 if ! defined wantarray;
369 # no direct blessing of coderefs - DESTROY is buggy on those
370 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
374 DBIx::Class::_Util::ScopeGuard;
377 &DBIx::Class::_Util::detected_reinvoked_destructor;
379 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
387 "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@"
393 sub is_exception ($) {
397 # this is not strictly correct - an eval setting $@ to undef
398 # is *not* the same as an eval setting $@ to ''
399 # but for the sake of simplicity assume the following for
401 return 0 unless defined $e;
403 my ($not_blank, $suberror);
405 local $SIG{__DIE__} if $SIG{__DIE__};
408 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
409 # will entirely obviate the need for the encolsing eval{}, as the
410 # condition we guard against is a missing fallback overload
411 $not_blank = ( $e ne '' );
416 if (defined $suberror) {
417 if (length (my $class = blessed($e) )) {
418 carp_unique( sprintf(
419 'External exception class %s implements partial (broken) overloading '
420 . 'preventing its instances from being used in simple ($x eq $y) '
421 . 'comparisons. Given Perl\'s "globally cooperative" exception '
422 . 'handling this type of brokenness is extremely dangerous on '
423 . 'exception objects, as it may (and often does) result in silent '
424 . '"exception substitution". DBIx::Class tries to work around this '
425 . 'as much as possible, but other parts of your software stack may '
426 . 'not be even aware of this. Please submit a bugreport against the '
427 . 'distribution containing %s and in the meantime apply a fix similar '
428 . 'to the one shown at %s, in order to ensure your exception handling '
429 . 'is saner application-wide. What follows is the actual error text '
430 . "as generated by Perl itself:\n\n%s\n ",
433 'http://v.gd/DBIC_overload_tempfix/',
437 # workaround, keeps spice flowing
438 $not_blank = !!( length $e );
441 # not blessed yet failed the 'ne'... this makes 0 sense...
447 # a ref evaluating to '' is definitively a "null object"
450 length( my $class = ref $e )
452 carp_unique( sprintf(
453 "Objects of external exception class '%s' stringify to '' (the "
454 . 'empty string), implementing the so called null-object-pattern. '
455 . 'Given Perl\'s "globally cooperative" exception handling using this '
456 . 'class of exceptions is extremely dangerous, as it may (and often '
457 . 'does) result in silent discarding of errors. DBIx::Class tries to '
458 . 'work around this as much as possible, but other parts of your '
459 . 'software stack may not be even aware of the problem. Please submit '
460 . 'a bugreport against the distribution containing %s',
474 # Recreate the logic of try(), while reusing the catch()/finally() as-is
476 # FIXME: We need to move away from Try::Tiny entirely (way too heavy and
477 # yes, shows up ON TOP of profiles) but this is a batle for another maint
478 sub dbic_internal_try (&;@) {
480 my $try_cref = shift;
481 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
485 if( ref($arg) eq 'Try::Tiny::Catch' ) {
487 croak 'dbic_internal_try() may not be followed by multiple catch() blocks'
492 elsif ( ref($arg) eq 'Try::Tiny::Finally' ) {
493 croak 'dbic_internal_try() does not support finally{}';
497 'dbic_internal_try() encountered an unexpected argument '
498 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
499 . 'a missing semi-colon before or ' # trailing space important
504 my $wantarray = wantarray;
505 my $preexisting_exception = $@;
508 my $all_good = eval {
509 $@ = $preexisting_exception;
511 local $callstack_state->{in_internal_try} = 1
512 unless $callstack_state->{in_internal_try};
514 # always unset - someone may have snuck it in
515 local $SIG{__DIE__} if $SIG{__DIE__};
518 @ret = $try_cref->();
520 elsif( defined $wantarray ) {
521 $ret[0] = $try_cref->();
531 $@ = $preexisting_exception;
534 return $wantarray ? @ret : $ret[0]
536 elsif ( $catch_cref ) {
538 return $catch_cref->($exception);
545 sub in_internal_try { !! $callstack_state->{in_internal_try} }
549 my $destruction_registry = {};
551 sub DBIx::Class::__Util_iThreads_handler__::CLONE {
552 %$destruction_registry = map {
554 ? ( refaddr($_) => $_ )
556 } values %$destruction_registry;
558 weaken($_) for values %$destruction_registry;
560 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
561 # collected before leaving this scope. Depending on the code above, this
562 # may very well be just a preventive measure guarding future modifications
566 # This is almost invariably invoked from within DESTROY
567 # throwing exceptions won't work
568 sub detected_reinvoked_destructor {
570 # quick "garbage collection" pass - prevents the registry
571 # from slowly growing with a bunch of undef-valued keys
572 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
573 for keys %$destruction_registry;
575 if (! length ref $_[0]) {
576 printf STDERR '%s() expects a blessed reference %s',
580 return undef; # don't know wtf to do
582 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
583 weaken( $destruction_registry->{$addr} = $_[0] );
587 carp_unique ( sprintf (
588 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
589 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
590 . 'application, affecting *ALL* classes without active protection against '
591 . 'this. Diagnose and fix the root cause ASAP!!!%s',
593 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
594 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
604 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
605 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
607 sub modver_gt_or_eq ($$) {
608 my ($mod, $ver) = @_;
610 croak "Nonsensical module name supplied"
611 if ! defined $mod or $mod !~ $module_name_rx;
613 croak "Nonsensical minimum version supplied"
614 if ! defined $ver or $ver !~ $ver_rx;
617 my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
619 : croak "$mod does not seem to provide a version (perhaps it never loaded)"
622 ! defined $ver_cache->{$ver}
624 $ver_cache->{$ver} = do {
626 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
627 if SPURIOUS_VERSION_CHECK_WARNINGS;
629 local $SIG{__DIE__} if $SIG{__DIE__};
631 eval { $mod->VERSION($ver) } ? 1 : 0;
637 sub modver_gt_or_eq_and_lt ($$$) {
638 my ($mod, $v_ge, $v_lt) = @_;
640 croak "Nonsensical maximum version supplied"
641 if ! defined $v_lt or $v_lt !~ $ver_rx;
644 modver_gt_or_eq($mod, $v_ge)
646 ! modver_gt_or_eq($mod, $v_lt)
651 # FIXME - should be a private my(), but I'm too uncertain whether
652 # all bases are covered
653 our $describe_class_query_cache;
655 sub describe_class_methods {
658 croak "Expecting a class name"
659 if not defined $class or $class !~ $module_name_rx;
661 # use a cache on old MRO, since while we are recursing in this function
662 # nothing can possibly change (the speedup is immense)
663 # (yes, people could be tie()ing the stash and adding methods on access
664 # but there is a limit to how much crazy can be supported here)
666 # we use the cache for linear_isa lookups on new MRO as well - it adds
667 # a *tiny* speedup, and simplifies the code a lot
669 local $mro_recursor_stack->{cache} = {}
670 unless $mro_recursor_stack->{cache};
674 $my_gen += get_real_pkg_gen($_) for ( my @full_ISA = (
677 $mro_recursor_stack->{cache}{$class}{linear_isa}
679 mro::get_linear_isa($class)
683 $mro_recursor_stack->{cache}{$class}{is_universal}
685 mro::is_universal($class)
687 $mro_recursor_stack->{cache}{UNIVERSAL}{linear_isa}
689 mro::get_linear_isa("UNIVERSAL")
694 my $slot = $describe_class_query_cache->{$class} ||= {};
696 unless ( ($slot->{cumulative_gen}||0) == $my_gen ) {
698 # remove ourselves from ISA
705 @{ $mro_recursor_stack->{cache}{$class}{linear_isa} }
706 [ 1 .. $#{$mro_recursor_stack->{cache}{$class}{linear_isa}} ]
709 type => mro::get_mro($class),
711 cumulative_gen => $my_gen,
713 $slot->{mro}{is_c3} = ($slot->{mro}{type} eq 'c3') ? 1 : 0;
715 # ensure the cache is populated for the parents, code below can then
716 # efficiently operate over the query_cache directly
717 describe_class_methods($_) for reverse @full_ISA;
719 my $current_node_refaddr;
722 # combine full ISA-order inherited and local method list into a
726 $current_node_refaddr = refaddr($_)
730 unshift @{ $slot->{methods}{$_->{name}} }, $_
735 $_->{via_class} ne $class
737 $slot->{methods_defined_in_class}{$_->{name}} = $_
742 @{ $slot->{methods}{$_->{name}} } > 1
746 $slot->{methods_with_supers}{$_->{name}} = $slot->{methods}{$_->{name}}
750 # what describe_class_methods for @full_ISA produced above
752 $describe_class_query_cache->{$_}{methods_defined_in_class} || {}
753 } } reverse @full_ISA ),
755 # our own non-cleaned subs + their attributes
758 # need to account for dummy helper crefs under OLD_MRO
760 ! DBIx::Class::_ENV_::OLD_MRO
762 ! ( ( $Class::C3::MRO{$class} || {} )->{methods}{$_} )
765 # these 2 OR-ed checks are sufficient for 5.10+
767 ref(\ "${class}::"->{$_} ) ne 'GLOB'
769 defined( *{ "${class}::"->{$_} }{CODE} )
775 map { $_ => 1 } attributes::get( \&{"${class}::${_}"} )
779 } keys %{"${class}::"} )
783 # recalculate the pkg_gen on newer perls under Taint mode,
784 # because of shit like:
785 # perl -T -Mmro -e 'package Foo; sub bar {}; defined( *{ "Foo::"->{bar}}{CODE} ) and warn mro::get_pkg_gen("Foo") for (1,2,3)'
788 ! DBIx::Class::_ENV_::OLD_MRO
793 $slot->{cumulative_gen} = 0;
794 $slot->{cumulative_gen} += get_real_pkg_gen($_)
795 for $class, @full_ISA;
806 # Why not just use some higher-level module or at least File::Spec here?
808 # 1) This is a *very* rarely used function, and the deptree is large
809 # enough already as it is
811 # 2) (more importantly) Our tooling is utter shit in this area. There
812 # is no comprehensive support for UNC paths in PathTools and there
813 # are also various small bugs in representation across different
814 # path-manipulation CPAN offerings.
816 # Since this routine is strictly used for logical path processing (it
817 # *must* be able to work with not-yet-existing paths), use this seemingly
818 # simple but I *think* complete implementation to feed to other consumers
820 # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST*
821 # the impulse to bring in an external dependency. During runtime there
822 # is exactly one spot that could potentially maybe once in a blue moon
823 # use this function. Keep it lean.
826 ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x )
830 ( ( length($1) and ! length($2) ) ? '/' : '' )
837 File::Spec->catpath (
838 ( File::Spec->splitpath( "$_[0]" ) )[0,1],
847 # do not ask for a recent version, use 1.x API calls
848 File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects
853 my $list_ctx_ok_stack_marker;
855 sub fail_on_internal_wantarray () {
856 return if $list_ctx_ok_stack_marker;
858 if (! defined wantarray) {
859 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
863 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
865 # these are public API parts that alter behavior on wantarray
866 search | search_related | slice | search_literal
870 # these are explicitly prefixed, since we only recognize them as valid
871 # escapes when they come from the guts of CDBICompat
872 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
878 my ($fr, $want, $argdesc);
881 $fr = [ CORE::caller($cf) ];
882 $want = ( CORE::caller($cf-1) )[5];
883 $argdesc = ref $DB::args[0]
884 ? DBIx::Class::_Util::refdesc($DB::args[0])
890 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
892 DBIx::Class::Exception->throw( sprintf (
893 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
894 $argdesc, @{$fr}[1,2]
895 ), 'with_stacktrace');
898 weaken( $list_ctx_ok_stack_marker = my $mark = [] );
904 sub fail_on_internal_call {
908 $fr = [ CORE::caller(1) ];
909 $argdesc = ref $DB::args[0]
910 ? DBIx::Class::_Util::refdesc($DB::args[0])
911 : ( $DB::args[0] . '' )
916 # need to make allowance for a proxy-yet-direct call
918 $fr->[0] eq 'DBIx::Class::ResultSourceProxy'
920 @fr2 = (CORE::caller(2))
923 ( $fr->[3] =~ /([^:])+$/ )[0]
925 ( $fr2[3] =~ /([^:])+$/ )[0]
935 $check_fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
937 $check_fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
939 DBIx::Class::Exception->throw( sprintf (
940 "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",
941 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
944 B::Deparse->new->coderef2text(\&{$fr->[3]})
946 ), 'with_stacktrace');