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);
12 package # hide from pause
20 BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0,
22 BROKEN_GOTO => ( "$]" < 5.008003 ) ? 1 : 0,
24 HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
26 UNSTABLE_DOLLARAT => ( "$]" < 5.013002 ) ? 1 : 0,
30 # the "DBIC_" prefix below is crucial - this is what makes CI pick up
31 # all envvars without further adjusting its scripts
32 # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) }
34 { substr($_, 5) => !!( $ENV{$_} ) }
36 DBIC_SHUFFLE_UNORDERED_RESULTSETS
37 DBIC_ASSERT_NO_INTERNAL_WANTARRAY
38 DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS
39 DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE
40 DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE
44 IV_SIZE => $Config{ivsize},
49 if ( "$]" < 5.009_005) {
51 constant->import( OLD_MRO => 1 );
55 constant->import( OLD_MRO => 0 );
58 # Both of these are no longer used for anything. However bring
59 # them back after they were purged in 08a8d8f1, as there appear
60 # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/*
61 # in their production codebases. There is no point in breaking these
62 # if whatever they used actually continues to work
67 my $cluck = "The @{[ (caller(1))[3] ]} constant is no more - adjust your code" . Carp::longmess();
69 warn $cluck unless $warned->{$cluck}++;
73 sub DBICTEST () { &$sigh }
74 sub PEEPEENESS () { &$sigh }
77 # FIXME - this is not supposed to be here
78 # Carp::Skip to the rescue soon
79 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
83 use Storable 'nfreeze';
84 use Scalar::Util qw(weaken blessed reftype refaddr);
85 use Sub::Quote qw(qsub);
88 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
89 BEGIN { *deep_clone = \&Storable::dclone }
93 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
94 fail_on_internal_wantarray fail_on_internal_call
95 refdesc refcount hrefaddr set_subname
96 scope_guard detected_reinvoked_destructor
97 is_exception dbic_internal_try visit_namespaces
98 quote_sub qsub perlstring serialize deep_clone dump_value uniq
100 UNRESOLVABLE_CONDITION
103 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
106 # add preliminary attribute support
108 # To be revisited when Moo with proper attr support ships
109 Sub::Quote->VERSION(2.002);
112 # Override forcing no_defer, and adding naming consistency checks
114 Carp::confess( "Anonymous quoting not supported by the DBIC sub_quote override - supply a sub name" ) if
122 Carp::confess( "The DBIC sub_quote override expects sub name '$_[0]' to be fully qualified" )
123 unless $_[0] =~ /::/;
125 Carp::confess( "The DBIC sub_quote override expects the sub name '$_[0]' to match the supplied 'package' argument" ) if
128 defined $_[3]->{package}
130 index( $_[0], $_[3]->{package} ) != 0
133 my @caller = caller(0);
135 package => $caller[0],
137 warning_bits => $caller[9],
138 hintshash => $caller[10],
141 # explicitly forced for everything
145 my $cref = Sub::Quote::quote_sub( $_[0], $_[1], $_[2]||{}, $sq_opts );
148 # To be revisited when Moo with proper attr support ships
150 # external application does not work on things like :prototype(...), :lvalue, etc
154 Carp::confess( "The DBIC sub_quote override does not support applying of reserved attribute '$_'" )
155 } @{ $sq_opts->{attributes} || []}
157 Carp::confess( "The DBIC sub_quote override does not allow mixing 'attributes' with 'no_install'" )
158 if $sq_opts->{no_install};
160 # might be different from $sq_opts->{package};
161 my ($install_into) = $_[0] =~ /(.+)::[^:]+$/;
163 attributes->import( $install_into, $cref, @attrs );
169 sub sigwarn_silencer ($) {
172 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
174 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
176 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
179 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
181 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
184 croak "Expecting a reference" if ! length ref $_[0];
186 # be careful not to trigger stringification,
187 # reuse @_ as a scratch-pad
188 sprintf '%s%s(0x%x)',
189 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
196 croak "Expecting a reference" if ! length ref $_[0];
198 # No tempvars - must operate on $_[0], otherwise the pad
199 # will count as an extra ref
200 B::svref_2object($_[0])->REFCNT;
203 sub visit_namespaces {
204 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
206 my $visited_count = 1;
208 # A package and a namespace are subtly different things
209 $args->{package} ||= 'main';
210 $args->{package} = 'main' if $args->{package} =~ /^ :: (?: main )? $/x;
211 $args->{package} =~ s/^:://;
213 if ( $args->{action}->($args->{package}) ) {
215 ( ($args->{package} eq 'main') ? '' : $args->{package} )
220 $visited_count += visit_namespaces( %$args, package => $_ ) for
222 # this happens sometimes on %:: traversal
225 { $_ =~ /^(.+?)::$/ ? "$ns$1" : () }
226 do { no strict 'refs'; keys %$ns }
233 # FIXME In another life switch this to a polyfill like the one in namespace::clean
234 sub set_subname ($$) {
237 splice @_, 0, 1, caller(0) . "::$_[0]"
244 local $Storable::canonical = 1;
249 my( %seen, $seen_undef, $numeric_preserving_copy );
252 ? $seen{ $numeric_preserving_copy = $_ }++
259 local $Data::Dumper::Indent = 1
260 unless defined $Data::Dumper::Indent;
266 require Data::Dumper;
267 my $d = Data::Dumper->new([])
280 $d->Sparseseen(1) if modver_gt_or_eq (
281 'Data::Dumper', '2.136'
286 )->Values([$_[0]])->Dump;
288 $dd_obj->Reset->Values([]);
293 sub scope_guard (&) {
294 croak 'Calling scope_guard() in void context makes no sense'
295 if ! defined wantarray;
297 # no direct blessing of coderefs - DESTROY is buggy on those
298 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
302 DBIx::Class::_Util::ScopeGuard;
305 &DBIx::Class::_Util::detected_reinvoked_destructor;
307 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
315 "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@"
321 sub is_exception ($) {
325 # this is not strictly correct - an eval setting $@ to undef
326 # is *not* the same as an eval setting $@ to ''
327 # but for the sake of simplicity assume the following for
329 return 0 unless defined $e;
331 my ($not_blank, $suberror);
333 local $SIG{__DIE__} if $SIG{__DIE__};
336 # The ne() here is deliberate - a plain length($e), or worse "$e" ne
337 # will entirely obviate the need for the encolsing eval{}, as the
338 # condition we guard against is a missing fallback overload
339 $not_blank = ( $e ne '' );
344 if (defined $suberror) {
345 if (length (my $class = blessed($e) )) {
346 carp_unique( sprintf(
347 'External exception class %s implements partial (broken) overloading '
348 . 'preventing its instances from being used in simple ($x eq $y) '
349 . 'comparisons. Given Perl\'s "globally cooperative" exception '
350 . 'handling this type of brokenness is extremely dangerous on '
351 . 'exception objects, as it may (and often does) result in silent '
352 . '"exception substitution". DBIx::Class tries to work around this '
353 . 'as much as possible, but other parts of your software stack may '
354 . 'not be even aware of this. Please submit a bugreport against the '
355 . 'distribution containing %s and in the meantime apply a fix similar '
356 . 'to the one shown at %s, in order to ensure your exception handling '
357 . 'is saner application-wide. What follows is the actual error text '
358 . "as generated by Perl itself:\n\n%s\n ",
361 'http://v.gd/DBIC_overload_tempfix/',
365 # workaround, keeps spice flowing
366 $not_blank = !!( length $e );
369 # not blessed yet failed the 'ne'... this makes 0 sense...
375 # a ref evaluating to '' is definitively a "null object"
378 length( my $class = ref $e )
380 carp_unique( sprintf(
381 "Objects of external exception class '%s' stringify to '' (the "
382 . 'empty string), implementing the so called null-object-pattern. '
383 . 'Given Perl\'s "globally cooperative" exception handling using this '
384 . 'class of exceptions is extremely dangerous, as it may (and often '
385 . 'does) result in silent discarding of errors. DBIx::Class tries to '
386 . 'work around this as much as possible, but other parts of your '
387 . 'software stack may not be even aware of the problem. Please submit '
388 . 'a bugreport against the distribution containing %s',
402 # Recreate the logic of try(), while reusing the catch()/finally() as-is
404 # FIXME: We need to move away from Try::Tiny entirely (way too heavy and
405 # yes, shows up ON TOP of profiles) but this is a batle for another maint
406 sub dbic_internal_try (&;@) {
408 my $try_cref = shift;
409 my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311
413 if( ref($arg) eq 'Try::Tiny::Catch' ) {
415 croak 'dbic_internal_try() may not be followed by multiple catch() blocks'
420 elsif ( ref($arg) eq 'Try::Tiny::Finally' ) {
421 croak 'dbic_internal_try() does not support finally{}';
425 'dbic_internal_try() encountered an unexpected argument '
426 . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps "
427 . 'a missing semi-colon before or ' # trailing space important
432 my $wantarray = wantarray;
433 my $preexisting_exception = $@;
436 my $all_good = eval {
437 $@ = $preexisting_exception;
439 local $callstack_state->{in_internal_try} = 1
440 unless $callstack_state->{in_internal_try};
442 # always unset - someone may have snuck it in
443 local $SIG{__DIE__} if $SIG{__DIE__};
446 @ret = $try_cref->();
448 elsif( defined $wantarray ) {
449 $ret[0] = $try_cref->();
459 $@ = $preexisting_exception;
462 return $wantarray ? @ret : $ret[0]
464 elsif ( $catch_cref ) {
466 return $catch_cref->($exception);
473 sub in_internal_try { !! $callstack_state->{in_internal_try} }
477 my $destruction_registry = {};
479 sub DBIx::Class::__Util_iThreads_handler__::CLONE {
480 %$destruction_registry = map {
482 ? ( refaddr($_) => $_ )
484 } values %$destruction_registry;
486 weaken($_) for values %$destruction_registry;
488 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
489 # collected before leaving this scope. Depending on the code above, this
490 # may very well be just a preventive measure guarding future modifications
494 # This is almost invariably invoked from within DESTROY
495 # throwing exceptions won't work
496 sub detected_reinvoked_destructor {
498 # quick "garbage collection" pass - prevents the registry
499 # from slowly growing with a bunch of undef-valued keys
500 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
501 for keys %$destruction_registry;
503 if (! length ref $_[0]) {
504 printf STDERR '%s() expects a blessed reference %s',
508 return undef; # don't know wtf to do
510 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
511 weaken( $destruction_registry->{$addr} = $_[0] );
515 carp_unique ( sprintf (
516 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
517 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
518 . 'application, affecting *ALL* classes without active protection against '
519 . 'this. Diagnose and fix the root cause ASAP!!!%s',
521 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
522 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
532 my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
533 my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
535 sub modver_gt_or_eq ($$) {
536 my ($mod, $ver) = @_;
538 croak "Nonsensical module name supplied"
539 if ! defined $mod or $mod !~ $module_name_rx;
541 croak "Nonsensical minimum version supplied"
542 if ! defined $ver or $ver !~ $ver_rx;
545 my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
547 : croak "$mod does not seem to provide a version (perhaps it never loaded)"
550 ! defined $ver_cache->{$ver}
552 $ver_cache->{$ver} = do {
554 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
555 if SPURIOUS_VERSION_CHECK_WARNINGS;
557 local $SIG{__DIE__} if $SIG{__DIE__};
559 eval { $mod->VERSION($ver) } ? 1 : 0;
565 sub modver_gt_or_eq_and_lt ($$$) {
566 my ($mod, $v_ge, $v_lt) = @_;
568 croak "Nonsensical maximum version supplied"
569 if ! defined $v_lt or $v_lt !~ $ver_rx;
572 modver_gt_or_eq($mod, $v_ge)
574 ! modver_gt_or_eq($mod, $v_lt)
580 # Why not just use some higher-level module or at least File::Spec here?
582 # 1) This is a *very* rarely used function, and the deptree is large
583 # enough already as it is
585 # 2) (more importantly) Our tooling is utter shit in this area. There
586 # is no comprehensive support for UNC paths in PathTools and there
587 # are also various small bugs in representation across different
588 # path-manipulation CPAN offerings.
590 # Since this routine is strictly used for logical path processing (it
591 # *must* be able to work with not-yet-existing paths), use this seemingly
592 # simple but I *think* complete implementation to feed to other consumers
594 # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST*
595 # the impulse to bring in an external dependency. During runtime there
596 # is exactly one spot that could potentially maybe once in a blue moon
597 # use this function. Keep it lean.
600 ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x )
604 ( ( length($1) and ! length($2) ) ? '/' : '' )
611 File::Spec->catpath (
612 ( File::Spec->splitpath( "$_[0]" ) )[0,1],
621 # do not ask for a recent version, use 1.x API calls
622 File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects
627 my $list_ctx_ok_stack_marker;
629 sub fail_on_internal_wantarray () {
630 return if $list_ctx_ok_stack_marker;
632 if (! defined wantarray) {
633 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
637 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
639 # these are public API parts that alter behavior on wantarray
640 search | search_related | slice | search_literal
644 # these are explicitly prefixed, since we only recognize them as valid
645 # escapes when they come from the guts of CDBICompat
646 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
652 my ($fr, $want, $argdesc);
655 $fr = [ CORE::caller($cf) ];
656 $want = ( CORE::caller($cf-1) )[5];
657 $argdesc = ref $DB::args[0]
658 ? DBIx::Class::_Util::refdesc($DB::args[0])
664 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
666 DBIx::Class::Exception->throw( sprintf (
667 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
668 $argdesc, @{$fr}[1,2]
669 ), 'with_stacktrace');
672 weaken( $list_ctx_ok_stack_marker = my $mark = [] );
678 sub fail_on_internal_call {
682 $fr = [ CORE::caller(1) ];
683 $argdesc = ref $DB::args[0]
684 ? DBIx::Class::_Util::refdesc($DB::args[0])
685 : ( $DB::args[0] . '' )
692 $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
694 $fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
696 DBIx::Class::Exception->throw( sprintf (
697 "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",
698 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
701 B::Deparse->new->coderef2text(\&{$fr->[3]})
703 ), 'with_stacktrace');