1 package # hide from PAUSE
7 use constant SPURIOUS_VERSION_CHECK_WARNINGS => ( "$]" < 5.010 ? 1 : 0);
10 package # hide from pause
18 BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0,
20 BROKEN_GOTO => ( "$]" < 5.008003 ) ? 1 : 0,
22 HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
24 UNSTABLE_DOLLARAT => ( "$]" < 5.013002 ) ? 1 : 0,
26 DBICTEST => $INC{"DBICTest/Util.pm"} ? 1 : 0,
28 # During 5.13 dev cycle HELEMs started to leak on copy
29 # add an escape for these perls ON SMOKERS - a user will still get death
30 PEEPEENESS => ( eval { DBICTest::RunMode->is_smoker } && ( "$]" >= 5.013005 and "$]" <= 5.013006) ),
32 SHUFFLE_UNORDERED_RESULTSETS => $ENV{DBIC_SHUFFLE_UNORDERED_RESULTSETS} ? 1 : 0,
34 ASSERT_NO_INTERNAL_WANTARRAY => $ENV{DBIC_ASSERT_NO_INTERNAL_WANTARRAY} ? 1 : 0,
36 ASSERT_NO_INTERNAL_INDIRECT_CALLS => $ENV{DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS} ? 1 : 0,
38 STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE => $ENV{DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE} ? 1 : 0,
40 STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE => $ENV{DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE} ? 1 : 0,
42 IV_SIZE => $Config{ivsize},
47 if ( "$]" < 5.009_005) {
49 constant->import( OLD_MRO => 1 );
53 constant->import( OLD_MRO => 0 );
57 # FIXME - this is not supposed to be here
58 # Carp::Skip to the rescue soon
59 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
63 use Storable 'nfreeze';
64 use Scalar::Util qw(weaken blessed reftype refaddr);
65 use List::Util qw(first);
66 use Sub::Quote qw(qsub quote_sub);
68 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
69 BEGIN { *deep_clone = \&Storable::dclone }
73 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
74 fail_on_internal_wantarray fail_on_internal_call
75 refdesc refcount hrefaddr
76 scope_guard is_exception detected_reinvoked_destructor
77 quote_sub qsub perlstring serialize deep_clone
78 UNRESOLVABLE_CONDITION
81 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
83 sub sigwarn_silencer ($) {
86 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
88 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
90 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
93 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
95 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
98 croak "Expecting a reference" if ! length ref $_[0];
100 # be careful not to trigger stringification,
101 # reuse @_ as a scratch-pad
102 sprintf '%s%s(0x%x)',
103 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
110 croak "Expecting a reference" if ! length ref $_[0];
112 # No tempvars - must operate on $_[0], otherwise the pad
113 # will count as an extra ref
114 B::svref_2object($_[0])->REFCNT;
118 local $Storable::canonical = 1;
122 sub scope_guard (&) {
123 croak 'Calling scope_guard() in void context makes no sense'
124 if ! defined wantarray;
126 # no direct blessing of coderefs - DESTROY is buggy on those
127 bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
131 DBIx::Class::_Util::ScopeGuard;
134 &DBIx::Class::_Util::detected_reinvoked_destructor;
136 local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
142 Carp::cluck "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@";
148 sub is_exception ($) {
151 # this is not strictly correct - an eval setting $@ to undef
152 # is *not* the same as an eval setting $@ to ''
153 # but for the sake of simplicity assume the following for
155 return 0 unless defined $e;
157 my ($not_blank, $suberror);
161 $not_blank = ($e ne '') ? 1 : 0;
166 if (defined $suberror) {
167 if (length (my $class = blessed($e) )) {
168 carp_unique( sprintf(
169 'External exception class %s implements partial (broken) overloading '
170 . 'preventing its instances from being used in simple ($x eq $y) '
171 . 'comparisons. Given Perl\'s "globally cooperative" exception '
172 . 'handling this type of brokenness is extremely dangerous on '
173 . 'exception objects, as it may (and often does) result in silent '
174 . '"exception substitution". DBIx::Class tries to work around this '
175 . 'as much as possible, but other parts of your software stack may '
176 . 'not be even aware of this. Please submit a bugreport against the '
177 . 'distribution containing %s and in the meantime apply a fix similar '
178 . 'to the one shown at %s, in order to ensure your exception handling '
179 . 'is saner application-wide. What follows is the actual error text '
180 . "as generated by Perl itself:\n\n%s\n ",
183 'http://v.gd/DBIC_overload_tempfix/',
187 # workaround, keeps spice flowing
188 $not_blank = ("$e" ne '') ? 1 : 0;
191 # not blessed yet failed the 'ne'... this makes 0 sense...
197 # a ref evaluating to '' is definitively a "null object"
200 length( my $class = ref $e )
202 carp_unique( sprintf(
203 "Objects of external exception class '%s' stringify to '' (the "
204 . 'empty string), implementing the so called null-object-pattern. '
205 . 'Given Perl\'s "globally cooperative" exception handling using this '
206 . 'class of exceptions is extremely dangerous, as it may (and often '
207 . 'does) result in silent discarding of errors. DBIx::Class tries to '
208 . 'work around this as much as possible, but other parts of your '
209 . 'software stack may not be even aware of the problem. Please submit '
210 . 'a bugreport against the distribution containing %s.',
222 my $destruction_registry = {};
225 $destruction_registry = { map
226 { defined $_ ? ( refaddr($_) => $_ ) : () }
227 values %$destruction_registry
231 # This is almost invariably invoked from within DESTROY
232 # throwing exceptions won't work
233 sub detected_reinvoked_destructor {
235 # quick "garbage collection" pass - prevents the registry
236 # from slowly growing with a bunch of undef-valued keys
237 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
238 for keys %$destruction_registry;
240 if (! length ref $_[0]) {
241 printf STDERR '%s() expects a blessed reference %s',
245 return undef; # don't know wtf to do
247 elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
248 weaken( $destruction_registry->{$addr} = $_[0] );
252 carp_unique ( sprintf (
253 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
254 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
255 . 'application, affecting *ALL* classes without active protection against '
256 . 'this. Diagnose and fix the root cause ASAP!!!%s',
258 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
259 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
269 sub modver_gt_or_eq ($$) {
270 my ($mod, $ver) = @_;
272 croak "Nonsensical module name supplied"
273 if ! defined $mod or ! length $mod;
275 croak "Nonsensical minimum version supplied"
276 if ! defined $ver or $ver =~ /[^0-9\.\_]/;
278 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
279 if SPURIOUS_VERSION_CHECK_WARNINGS;
281 croak "$mod does not seem to provide a version (perhaps it never loaded)"
282 unless $mod->VERSION;
285 eval { $mod->VERSION($ver) } ? 1 : 0;
288 sub modver_gt_or_eq_and_lt ($$$) {
289 my ($mod, $v_ge, $v_lt) = @_;
291 croak "Nonsensical maximum version supplied"
292 if ! defined $v_lt or $v_lt =~ /[^0-9\.\_]/;
295 modver_gt_or_eq($mod, $v_ge)
297 ! modver_gt_or_eq($mod, $v_lt)
302 my $list_ctx_ok_stack_marker;
304 sub fail_on_internal_wantarray () {
305 return if $list_ctx_ok_stack_marker;
307 if (! defined wantarray) {
308 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
312 while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:
314 # these are public API parts that alter behavior on wantarray
315 search | search_related | slice | search_literal
319 # these are explicitly prefixed, since we only recognize them as valid
320 # escapes when they come from the guts of CDBICompat
321 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
327 my ($fr, $want, $argdesc);
330 $fr = [ CORE::caller($cf) ];
331 $want = ( CORE::caller($cf-1) )[5];
332 $argdesc = ref $DB::args[0]
333 ? DBIx::Class::_Util::refdesc($DB::args[0])
339 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
341 DBIx::Class::Exception->throw( sprintf (
342 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
343 $argdesc, @{$fr}[1,2]
344 ), 'with_stacktrace');
348 weaken ( $list_ctx_ok_stack_marker = $mark );
353 sub fail_on_internal_call {
357 $fr = [ CORE::caller(1) ];
358 $argdesc = ref $DB::args[0]
359 ? DBIx::Class::_Util::refdesc($DB::args[0])
367 $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
369 $fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
371 DBIx::Class::Exception->throw( sprintf (
372 "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",
373 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
376 B::Deparse->new->coderef2text(\&{$fr->[3]})
378 ), 'with_stacktrace');