1 package # hide from PAUSE
4 # load es early as we can, usually a noop
5 use DBIx::Class::StartupCheck;
10 # For the love of everything that is crab-like: DO NOT reach into this
11 # The entire thing is really fragile and should not be screwed with
12 # unless absolutely and unavoidably necessary
13 our $__describe_class_query_cache;
16 package # hide from pause
29 BROKEN_FORK => (OS_NAME eq 'MSWin32') ? 1 : 0,
31 BROKEN_GOTO => ( PERL_VERSION < 5.008003 ) ? 1 : 0,
33 # perl -MScalar::Util=weaken -e 'weaken( $hash{key} = \"value" )'
34 BROKEN_WEAK_SCALARREF_VALUES => ( PERL_VERSION < 5.008003 ) ? 1 : 0,
36 HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
38 TAINT_MODE => 0 + ${^TAINT}, # tri-state: 0, 1, -1
40 UNSTABLE_DOLLARAT => ( PERL_VERSION < 5.013002 ) ? 1 : 0,
44 # the "DBIC_" prefix below is crucial - this is what makes CI pick up
45 # all envvars without further adjusting its scripts
46 # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) }
48 { substr($_, 5) => !!( $ENV{$_} ) }
50 DBIC_SHUFFLE_UNORDERED_RESULTSETS
51 DBIC_ASSERT_NO_INTERNAL_WANTARRAY
52 DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS
53 DBIC_ASSERT_NO_ERRONEOUS_METAINSTANCE_USE
54 DBIC_ASSERT_NO_FAILING_SANITY_CHECKS
55 DBIC_ASSERT_NO_INCONSISTENT_RELATIONSHIP_RESOLUTION
56 DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE
57 DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE
61 IV_SIZE => $Config{ivsize},
64 if ( PERL_VERSION < 5.009_005) {
66 constant->import( OLD_MRO => 1 );
69 # Yes, I know this is a rather PHP-ish name, but please first read
70 # https://metacpan.org/source/BOBTFISH/MRO-Compat-0.12/lib/MRO/Compat.pm#L363-368
72 # Even if we are using Class::C3::XS it still won't work, as doing
73 # defined( *{ "SubClass::"->{$_} }{CODE} )
74 # will set pkg_gen to the same value for SubClass and *ALL PARENTS*
76 *DBIx::Class::_Util::get_real_pkg_gen = sub ($) {
83 # the non-assign-unless-there-is-a-hash is deliberate
84 ( $__describe_class_query_cache->{'!internal!'} || {} )->{$_[0]}{gen} ||= (
85 Math::BigInt->new( '0x' . ( Digest::MD5::md5_hex( join "\0", map {
87 ( $__describe_class_query_cache->{'!internal!'} || {} )->{$_}{methlist} ||= (
93 # RV to be hashed up and turned into a number
98 # stringification should be sufficient, ignore names/refaddr entirely
103 local $SIG{__DIE__} if $SIG{__DIE__};
104 # attributes::get may throw on blessed-false crefs :/
105 eval { @attrs = attributes::get( $_ ); 1 }
106 or warn "Unable to determine attributes of coderef $_ due to the following error: $@";
112 # skip dummy C::C3 helper crefs
113 ! ( ( $Class::C3::MRO{$cur_class} || {} )->{methods}{$_} )
116 ref(\ "${cur_class}::"->{$_} ) ne 'GLOB'
118 defined( *{ "${cur_class}::"->{$_} }{CODE} )
121 ? ( \&{"${cur_class}::$_"} )
124 keys %{ "${cur_class}::" }
130 ( $__describe_class_query_cache->{'!internal!'} || {} )->{$_[0]}{linear_isa}
132 mro::get_linear_isa($_[0])
136 ( $__describe_class_query_cache->{'!internal!'} || {} )->{$_[0]}{is_universal}
138 mro::is_universal($_[0])
140 ( $__describe_class_query_cache->{'!internal!'} || {} )->{UNIVERSAL}{linear_isa}
142 mro::get_linear_isa("UNIVERSAL")
151 constant->import( OLD_MRO => 0 );
152 *DBIx::Class::_Util::get_real_pkg_gen = \&mro::get_pkg_gen;
155 # Both of these are no longer used for anything. However bring
156 # them back after they were purged in 08a8d8f1, as there appear
157 # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/*
158 # in their production codebases. There is no point in breaking these
159 # if whatever they used actually continues to work
161 DBIx::Class::_Util::emit_loud_diag(
163 msg => "The @{[ (caller(1))[3] ]} constant is no more - adjust your code"
168 sub DBICTEST () { &$sigh }
169 sub PEEPEENESS () { &$sigh }
172 use constant SPURIOUS_VERSION_CHECK_WARNINGS => ( DBIx::Class::_ENV_::PERL_VERSION < 5.010 ? 1 : 0);
174 # FIXME - this is not supposed to be here
175 # Carp::Skip to the rescue soon
176 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
178 # Ensure it is always there, in case we need to do a $schema-less throw()
179 use DBIx::Class::Exception ();
183 use Storable 'nfreeze';
184 use Scalar::Util qw(weaken blessed reftype refaddr);
188 # Usually versions are not specified anywhere aside the Makefile.PL
189 # (writing them out in-code is extremely obnoxious)
190 # However without a recent enough Moo the quote_sub override fails
191 # in very puzzling and hard to detect ways: so add a version check
193 use Sub::Quote qw(qsub);
194 BEGIN { Sub::Quote->VERSION('2.002002') }
196 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
197 BEGIN { *deep_clone = \&Storable::dclone }
201 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
202 fail_on_internal_wantarray fail_on_internal_call
203 refdesc refcount hrefaddr set_subname get_subname describe_class_methods
204 scope_guard detected_reinvoked_destructor emit_loud_diag
206 is_exception dbic_internal_try dbic_internal_catch visit_namespaces
207 quote_sub qsub perlstring serialize deep_clone dump_value uniq
209 UNRESOLVABLE_CONDITION DUMMY_ALIASPAIR
212 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
214 use constant DUMMY_ALIASPAIR => (
215 foreign_alias => "!!!\xFF()!!!_DUMMY_FOREIGN_ALIAS_SHOULD_NEVER_BE_SEEN_IN_USE_!!!()\xFF!!!",
216 self_alias => "!!!\xFE()!!!_DUMMY_SELF_ALIAS_SHOULD_NEVER_BE_SEEN_IN_USE_!!!()\xFE!!!",
219 # Override forcing no_defer, and adding naming consistency checks
220 our %refs_closed_over_by_quote_sub_installed_crefs;
222 Carp::confess( "Anonymous quoting not supported by the DBIC quote_sub override - supply a sub name" ) if
230 Carp::confess( "The DBIC quote_sub override expects sub name '$_[0]' to be fully qualified" )
231 unless (my $stash) = $_[0] =~ /^(.+)::/;
234 "The DBIC sub_quote override does not support 'no_install'"
242 'The DBIC quote_sub override expects the namespace-part of sub name '
243 . "'$_[0]' to match the supplied package argument '$_[3]->{package}'"
247 defined $_[3]->{package}
249 $stash ne $_[3]->{package}
252 my @caller = caller(0);
254 package => $caller[0],
256 warning_bits => $caller[9],
257 hintshash => $caller[10],
260 # explicitly forced for everything
265 # just use a growing counter, no need to perform neither compaction
266 # nor any special ithread-level handling
267 $refs_closed_over_by_quote_sub_installed_crefs
268 { scalar keys %refs_closed_over_by_quote_sub_installed_crefs }
274 ! DBIx::Class::_ENV_::BROKEN_WEAK_SCALARREF_VALUES
278 } values %{ $_[2] || {} };
280 Sub::Quote::quote_sub( $_[0], $_[1], $_[2]||{}, $sq_opts );
283 sub sigwarn_silencer ($) {
286 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
288 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
290 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
293 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
295 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
298 croak "Expecting a reference" if ! length ref $_[0];
300 # be careful not to trigger stringification,
301 # reuse @_ as a scratch-pad
302 sprintf '%s%s(0x%x)',
303 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
310 croak "Expecting a reference" if ! length ref $_[0];
312 # No tempvars - must operate on $_[0], otherwise the pad
313 # will count as an extra ref
314 B::svref_2object($_[0])->REFCNT;
317 sub visit_namespaces {
318 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
320 my $visited_count = 1;
322 # A package and a namespace are subtly different things
323 $args->{package} ||= 'main';
324 $args->{package} = 'main' if $args->{package} =~ /^ :: (?: main )? $/x;
325 $args->{package} =~ s/^:://;
327 if ( $args->{action}->($args->{package}) ) {
329 ( ($args->{package} eq 'main') ? '' : $args->{package} )
334 $visited_count += visit_namespaces( %$args, package => $_ ) for
336 # this happens sometimes on %:: traversal
339 { $_ =~ /^(.+?)::$/ ? "$ns$1" : () }
340 do { no strict 'refs'; keys %$ns }
347 # FIXME In another life switch these to a polyfill like the ones in namespace::clean
348 sub get_subname ($) {
349 my $gv = B::svref_2object( $_[0] )->GV;
351 ? ( $gv->STASH->NAME, $gv->NAME )
352 : ( join '::', $gv->STASH->NAME, $gv->NAME )
355 sub set_subname ($$) {
358 splice @_, 0, 1, caller(0) . "::$_[0]"
366 local $Storable::canonical = 1;
368 # explicitly false - there is nothing sensible that can come out of
369 # an attempt at CODE serialization
370 local $Storable::Deparse;
373 local $Storable::forgive_me;
376 # A number of codepaths *expect* this to be Storable.pm-based so that
377 # the STORABLE_freeze hooks in the metadata subtree get executed properly
382 my( %seen, $seen_undef, $numeric_preserving_copy );
385 ? $seen{ $numeric_preserving_copy = $_ }++
392 local $Data::Dumper::Indent = 1
393 unless defined $Data::Dumper::Indent;
399 require Data::Dumper;
400 my $d = Data::Dumper->new([])
413 # FIXME - this is kinda ridiculous - there ought to be a
414 # Data::Dumper->new_with_defaults or somesuch...
416 if( modver_gt_or_eq ( 'Data::Dumper', '2.136' ) ) {
419 if( modver_gt_or_eq ( 'Data::Dumper', '2.153' ) ) {
420 $d->Maxrecurse(1000);
422 if( modver_gt_or_eq ( 'Data::Dumper', '2.160' ) ) {
423 $d->Trailingcomma(1);
430 )->Values([$_[0]])->Dump;
432 $dd_obj->Reset->Values([]);
437 my $seen_loud_screams;
439 my $args = { ref $_[0] eq 'HASH' ? %{$_[0]} : @_ };
441 unless ( defined $args->{msg} and length $args->{msg} ) {
443 msg => "No 'msg' value supplied to emit_loud_diag()"
448 my $msg = "\n" . join( ': ',
449 ( $0 eq '-e' ? () : $0 ),
453 # when we die - we usually want to keep doing it
454 $args->{emit_dups} = !!$args->{confess}
455 unless exists $args->{emit_dups};
457 local $Carp::CarpLevel =
458 ( $args->{skip_frames} || 0 )
466 my $longmess = Carp::longmess();
468 # different object references will thwart deduplication without this
469 ( my $key = "${msg}\n${longmess}" ) =~ s/\b0x[0-9a-f]+\b/0x.../gi;
471 return $seen_loud_screams->{$key} if
472 $seen_loud_screams->{$key}++
478 unless $msg =~ /\n\z/;
480 print STDERR "$msg\n"
482 print STDOUT "\n!!!STDERR ISN'T WRITABLE!!!:$msg\n";
484 return $seen_loud_screams->{$key}
485 unless $args->{confess};
487 # increment *again*, because... Carp.
490 # not $msg - Carp will reapply the longmess on its own
491 Carp::confess($args->{msg});
496 ### This is *NOT* boolean.pm - deliberately not using a singleton
499 package # hide from pause
500 DBIx::Class::_Util::_Bool;
502 bool => sub { ${$_[0]} },
506 sub true () { my $x = 1; bless \$x, "DBIx::Class::_Util::_Bool" }
507 sub false () { my $x = 0; bless \$x, "DBIx::Class::_Util::_Bool" }
509 sub scope_guard (&) {
510 croak 'Calling scope_guard() in void context makes no sense'
511 if ! defined wantarray;
513 # no direct blessing of coderefs - DESTROY is buggy on those
514 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
518 DBIx::Class::_Util::ScopeGuard;
521 &DBIx::Class::_Util::detected_reinvoked_destructor;
523 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
530 DBIx::Class::_Util::emit_loud_diag(
532 msg => "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@\n "
538 sub is_exception ($) {
542 # this is not strictly correct - an eval setting $@ to undef
543 # is *not* the same as an eval setting $@ to ''
544 # but for the sake of simplicity assume the following for
546 return 0 unless defined $e;
548 my ($not_blank, $suberror);
550 local $SIG{__DIE__} if $SIG{__DIE__};
553 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
554 # will entirely obviate the need for the encolsing eval{}, as the
555 # condition we guard against is a missing fallback overload
556 $not_blank = ( $e ne '' );
561 if (defined $suberror) {
562 if (length (my $class = blessed($e) )) {
563 carp_unique( sprintf(
564 'External exception class %s implements partial (broken) overloading '
565 . 'preventing its instances from being used in simple ($x eq $y) '
566 . 'comparisons. Given Perl\'s "globally cooperative" exception '
567 . 'handling this type of brokenness is extremely dangerous on '
568 . 'exception objects, as it may (and often does) result in silent '
569 . '"exception substitution". DBIx::Class tries to work around this '
570 . 'as much as possible, but other parts of your software stack may '
571 . 'not be even aware of this. Please submit a bugreport against the '
572 . 'distribution containing %s and in the meantime apply a fix similar '
573 . 'to the one shown at %s, in order to ensure your exception handling '
574 . 'is saner application-wide. What follows is the actual error text '
575 . "as generated by Perl itself:\n\n%s\n ",
578 'http://v.gd/DBIC_overload_tempfix/',
582 # workaround, keeps spice flowing
583 $not_blank = !!( length $e );
586 # not blessed yet failed the 'ne'... this makes 0 sense...
592 # a ref evaluating to '' is definitively a "null object"
595 length( my $class = ref $e )
598 "Objects of external exception class '$class' stringify to '' (the "
599 . 'empty string), implementing the so called null-object-pattern. '
600 . 'Given Perl\'s "globally cooperative" exception handling using this '
601 . 'class of exceptions is extremely dangerous, as it may (and often '
602 . 'does) result in silent discarding of errors. DBIx::Class tries to '
603 . 'work around this as much as possible, but other parts of your '
604 . 'software stack may not be even aware of the problem. Please submit '
605 . "a bugreport against the distribution containing '$class'",
617 # Recreate the logic of Try::Tiny, but without the crazy Sub::Name
618 # invocations and without support for finally() altogether
619 # ( yes, these days Try::Tiny is so "tiny" it shows *ON TOP* of most
620 # random profiles https://youtu.be/PYCbumw0Fis?t=1919 )
621 sub dbic_internal_try (&;@) {
623 my $try_cref = shift;
624 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
628 croak 'dbic_internal_try() may not be followed by multiple dbic_internal_catch() blocks'
631 ($catch_cref = $$arg), next
632 if ref($arg) eq 'DBIx::Class::_Util::Catch';
634 croak( 'Mixing dbic_internal_try() with Try::Tiny::catch() is not supported' )
635 if ref($arg) eq 'Try::Tiny::Catch';
637 croak( 'dbic_internal_try() does not support finally{}' )
638 if ref($arg) eq 'Try::Tiny::Finally';
641 'dbic_internal_try() encountered an unexpected argument '
642 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
643 . 'a missing semi-colon before or ' # trailing space important
647 my $wantarray = wantarray;
648 my $preexisting_exception = $@;
651 my $saul_goodman = eval {
652 $@ = $preexisting_exception;
654 local $callstack_state->{in_internal_try} = 1
655 unless $callstack_state->{in_internal_try};
657 # always unset - someone may have snuck it in
658 local $SIG{__DIE__} if $SIG{__DIE__};
661 @ret = $try_cref->();
663 elsif( defined $wantarray ) {
664 $ret[0] = $try_cref->();
674 $@ = $preexisting_exception;
676 if ( $saul_goodman ) {
677 return $wantarray ? @ret : $ret[0]
679 elsif ( $catch_cref ) {
681 return $catch_cref->($exception);
688 sub dbic_internal_catch (&;@) {
690 croak( 'Useless use of bare dbic_internal_catch()' )
693 croak( 'dbic_internal_catch() must receive exactly one argument at end of expression' )
698 'DBIx::Class::_Util::Catch'
702 sub in_internal_try () {
703 !! $callstack_state->{in_internal_try}
708 my $destruction_registry = {};
710 sub DBIx::Class::__Util_iThreads_handler__::CLONE {
711 %$destruction_registry = map {
713 ? ( refaddr($_) => $_ )
715 } values %$destruction_registry;
717 weaken($_) for values %$destruction_registry;
719 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
720 # collected before leaving this scope. Depending on the code above, this
721 # may very well be just a preventive measure guarding future modifications
725 # This is almost invariably invoked from within DESTROY
726 # throwing exceptions won't work
727 sub detected_reinvoked_destructor {
729 # quick "garbage collection" pass - prevents the registry
730 # from slowly growing with a bunch of undef-valued keys
731 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
732 for keys %$destruction_registry;
734 if (! length ref $_[0]) {
737 msg => (caller(0))[3] . '() expects a blessed reference'
739 return undef; # don't know wtf to do
741 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
742 weaken( $destruction_registry->{$addr} = $_[0] );
746 emit_loud_diag( msg => sprintf (
747 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
748 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
749 . 'application, affecting *ALL* classes without active protection against '
750 . 'this. Diagnose and fix the root cause ASAP!!!%s',
752 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
753 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
763 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
764 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
766 sub modver_gt_or_eq ($$) {
767 my ($mod, $ver) = @_;
769 croak "Nonsensical module name supplied"
770 if ! defined $mod or $mod !~ $module_name_rx;
772 croak "Nonsensical minimum version supplied"
773 if ! defined $ver or $ver !~ $ver_rx;
777 ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= {}
780 ! defined $ver_cache->{$ver}
782 $ver_cache->{$ver} = do {
784 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
785 if SPURIOUS_VERSION_CHECK_WARNINGS;
787 # prevent captures by potential __WARN__ hooks or the like:
788 # there is nothing of value that can be happening here, and
789 # leaving a hook in-place can only serve to fail some test
790 local $SIG{__WARN__} if (
791 ! SPURIOUS_VERSION_CHECK_WARNINGS
796 croak "$mod does not seem to provide a version (perhaps it never loaded)"
797 unless $mod->VERSION;
799 local $SIG{__DIE__} if $SIG{__DIE__};
801 eval { $mod->VERSION($ver) } ? 1 : 0;
807 sub modver_gt_or_eq_and_lt ($$$) {
808 my ($mod, $v_ge, $v_lt) = @_;
810 croak "Nonsensical maximum version supplied"
811 if ! defined $v_lt or $v_lt !~ $ver_rx;
814 modver_gt_or_eq($mod, $v_ge)
816 ! modver_gt_or_eq($mod, $v_lt)
822 sub describe_class_methods {
824 ref $_[0] eq 'HASH' ? $_[0]
825 : ( @_ == 1 and ! length ref $_[0] ) ? { class => $_[0] }
829 my ($class, $requested_mro) = @{$args}{qw( class use_mro )};
831 croak "Expecting a class name either as the sole argument or a 'class' option"
832 if not defined $class or $class !~ $module_name_rx;
835 "The supplied 'class' argument is tainted: this is *extremely* "
836 . 'dangerous, fix your code ASAP!!! ( for more details read through '
837 . 'https://is.gd/perl_mro_taint_wtf )'
839 DBIx::Class::_ENV_::TAINT_MODE
841 Scalar::Util::tainted($class)
844 $requested_mro ||= mro::get_mro($class);
846 # mro::set_mro() does not bump pkg_gen - WHAT THE FUCK?!
847 my $query_cache_key = "$class|$requested_mro";
849 my $internal_cache_key =
850 ( mro::get_mro($class) eq $requested_mro )
855 # use a cache on old MRO, since while we are recursing in this function
856 # nothing can possibly change (the speedup is immense)
857 # (yes, people could be tie()ing the stash and adding methods on access
858 # but there is a limit to how much crazy can be supported here)
860 # we use the cache for linear_isa lookups on new MRO as well - it adds
861 # a *tiny* speedup, and simplifies the code a lot
863 local $__describe_class_query_cache->{'!internal!'} = {}
864 unless $__describe_class_query_cache->{'!internal!'};
868 $my_gen += get_real_pkg_gen($_) for ( my @full_ISA = (
871 $__describe_class_query_cache->{'!internal!'}{$internal_cache_key}{linear_isa}
873 mro::get_linear_isa($class, $requested_mro)
877 $__describe_class_query_cache->{'!internal!'}{$class}{is_universal}
879 mro::is_universal($class)
881 $__describe_class_query_cache->{'!internal!'}{UNIVERSAL}{linear_isa}
883 mro::get_linear_isa("UNIVERSAL")
888 my $slot = $__describe_class_query_cache->{$query_cache_key} ||= {};
890 unless ( ($slot->{cumulative_gen}||0) == $my_gen ) {
895 isa => { map { $_ => 1 } @full_ISA },
897 @{ $__describe_class_query_cache->{'!internal!'}{$internal_cache_key}{linear_isa} }
898 [ 1 .. $#{$__describe_class_query_cache->{'!internal!'}{$internal_cache_key}{linear_isa}} ]
901 type => $requested_mro,
902 is_c3 => ( ($requested_mro eq 'c3') ? 1 : 0 ),
904 cumulative_gen => $my_gen,
907 # remove ourselves from ISA
910 # ensure the cache is populated for the parents, code below can then
911 # efficiently operate over the query_cache directly
912 describe_class_methods($_) for reverse @full_ISA;
916 # combine full ISA-order inherited and local method list into a
920 unshift @{ $slot->{methods}{$_->{name}} }, $_
925 $_->{via_class} ne $class
927 $slot->{methods_defined_in_class}{$_->{name}} = $_
932 @{ $slot->{methods}{$_->{name}} } > 1
936 $slot->{methods_with_supers}{$_->{name}} = $slot->{methods}{$_->{name}}
940 # what describe_class_methods for @full_ISA produced above
942 $__describe_class_query_cache->{$_}{methods_defined_in_class} || {}
943 } } map { "$_|" . mro::get_mro($_) } reverse @full_ISA ),
945 # our own non-cleaned subs + their attributes
948 # need to account for dummy helper crefs under OLD_MRO
950 ! DBIx::Class::_ENV_::OLD_MRO
952 ! ( ( $Class::C3::MRO{$class} || {} )->{methods}{$_} )
955 # these 2 OR-ed checks are sufficient for 5.10+
957 ref(\ "${class}::"->{$_} ) ne 'GLOB'
959 defined( *{ "${class}::"->{$_} }{CODE} )
964 attributes => { map { $_ => 1 } do {
967 local $SIG{__DIE__} if $SIG{__DIE__};
968 # attributes::get may throw on blessed-false crefs :/
969 eval { @attrs = attributes::get( \&{"${class}::${_}"} ); 1 }
970 or warn "Unable to determine attributes of the \\&${class}::$_ method due to following error: $@";
975 } keys %{"${class}::"} )
979 # recalculate the pkg_gen on newer perls under Taint mode,
980 # because of shit like:
981 # perl -T -Mmro -e 'package Foo; sub bar {}; defined( *{ "Foo::"->{bar}}{CODE} ) and warn mro::get_pkg_gen("Foo") for (1,2,3)'
984 ! DBIx::Class::_ENV_::OLD_MRO
986 DBIx::Class::_ENV_::TAINT_MODE
989 $slot->{cumulative_gen} = 0;
990 $slot->{cumulative_gen} += get_real_pkg_gen($_)
991 for $class, @full_ISA;
1002 # Why not just use some higher-level module or at least File::Spec here?
1004 # 1) This is a *very* rarely used function, and the deptree is large
1005 # enough already as it is
1007 # 2) (more importantly) Our tooling is utter shit in this area. There
1008 # is no comprehensive support for UNC paths in PathTools and there
1009 # are also various small bugs in representation across different
1010 # path-manipulation CPAN offerings.
1012 # Since this routine is strictly used for logical path processing (it
1013 # *must* be able to work with not-yet-existing paths), use this seemingly
1014 # simple but I *think* complete implementation to feed to other consumers
1016 # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST*
1017 # the impulse to bring in an external dependency. During runtime there
1018 # is exactly one spot that could potentially maybe once in a blue moon
1019 # use this function. Keep it lean.
1021 sub parent_dir ($) {
1022 ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x )
1026 ( ( length($1) and ! length($2) ) ? '/' : '' )
1033 File::Spec->catpath (
1034 ( File::Spec->splitpath( "$_[0]" ) )[0,1],
1043 # do not ask for a recent version, use 1.x API calls
1044 File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects
1049 my $list_ctx_ok_stack_marker;
1051 sub fail_on_internal_wantarray () {
1052 return if $list_ctx_ok_stack_marker;
1054 if (! defined wantarray) {
1055 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
1059 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
1061 # these are public API parts that alter behavior on wantarray
1062 search | search_related | slice | search_literal
1066 # these are explicitly prefixed, since we only recognize them as valid
1067 # escapes when they come from the guts of CDBICompat
1068 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
1074 my ($fr, $want, $argdesc);
1077 $fr = [ CORE::caller($cf) ];
1078 $want = ( CORE::caller($cf-1) )[5];
1079 $argdesc = ref $DB::args[0]
1080 ? DBIx::Class::_Util::refdesc($DB::args[0])
1086 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
1088 DBIx::Class::Exception->throw( sprintf (
1089 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
1090 $argdesc, @{$fr}[1,2]
1091 ), 'with_stacktrace');
1094 weaken( $list_ctx_ok_stack_marker = my $mark = [] );
1100 sub fail_on_internal_call {
1104 $fr = [ CORE::caller(1) ];
1106 ( not defined $DB::args[0] ) ? 'UNAVAILABLE'
1107 : ( length ref $DB::args[0] ) ? DBIx::Class::_Util::refdesc($DB::args[0])
1113 # need to make allowance for a proxy-yet-direct call
1115 $fr->[0] eq 'DBIx::Class::ResultSourceProxy'
1117 @fr2 = (CORE::caller(2))
1120 ( $fr->[3] =~ /([^:])+$/ )[0]
1122 ( $fr2[3] =~ /([^:])+$/ )[0]
1130 die "\nMethod $fr->[3] is not marked with the 'DBIC_method_is_indirect_sugar' attribute\n\n" unless (
1132 # unlikely but who knows...
1137 # This is a weird-ass double-purpose method, only one branch of which is marked
1138 # as an illegal indirect call
1139 # Hence the 'indirect' attribute makes no sense
1140 # FIXME - likely need to mark this in some other manner
1141 $fr->[3] eq 'DBIx::Class::ResultSet::new'
1145 # RsrcProxy stuff is special and not attr-annotated on purpose
1146 # Yet it is marked (correctly) as fail_on_internal_call(), as DBIC
1147 # itself should not call these methods as first-entry
1148 $fr->[3] =~ /^DBIx::Class::ResultSourceProxy::[^:]+$/
1152 # FIXME - there is likely a more fine-graned way to escape "foreign"
1153 # callers, based on annotations... (albeit a slower one)
1154 # For the time being just skip in a dumb way
1155 $fr->[3] !~ /^DBIx::Class|^DBICx::|^DBICTest::/
1160 { $_ eq 'DBIC_method_is_indirect_sugar' }
1161 do { no strict 'refs'; attributes::get( \&{ $fr->[3] }) }
1168 $check_fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
1170 $check_fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
1172 DBIx::Class::Exception->throw( sprintf (
1173 "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",
1174 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
1177 B::Deparse->new->coderef2text(\&{$fr->[3]})
1179 ), 'with_stacktrace');
1183 if (DBIx::Class::_ENV_::ASSERT_NO_ERRONEOUS_METAINSTANCE_USE) {
1185 no warnings 'redefine';
1187 my $next_bless = defined(&CORE::GLOBAL::bless)
1188 ? \&CORE::GLOBAL::bless
1189 : sub { CORE::bless($_[0], $_[1]) }
1192 *CORE::GLOBAL::bless = sub {
1193 my $class = (@_ > 1) ? $_[1] : CORE::caller();
1195 # allow for reblessing (role application)
1196 return $next_bless->( $_[0], $class )
1197 if defined blessed $_[0];
1199 my $obj = $next_bless->( $_[0], $class );
1201 my $calling_sub = (CORE::caller(1))[3] || '';
1204 # before 5.18 ->isa() will choke on the "0" package
1205 # which we test for in several obscure cases, sigh...
1206 !( DBIx::Class::_ENV_::PERL_VERSION < 5.018 )
1213 $calling_sub !~ /^ (?:
1214 DBIx::Class::Schema::clone
1216 DBIx::Class::DB::setup_schema_instance
1219 $class->isa("DBIx::Class::Schema")
1223 $calling_sub ne 'DBIx::Class::ResultSource::new'
1225 $class->isa("DBIx::Class::ResultSource")
1229 local $Carp::CarpLevel = $Carp::CarpLevel + 1
1231 Carp::confess("Improper instantiation of '$obj': you *MUST* call the corresponding constructor");