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 # ::Runmode would only be loaded by DBICTest, which in turn implies t/
25 DBICTEST => eval { DBICTest::RunMode->is_author } ? 1 : 0,
27 # During 5.13 dev cycle HELEMs started to leak on copy
28 # add an escape for these perls ON SMOKERS - a user will still get death
29 PEEPEENESS => ( eval { DBICTest::RunMode->is_smoker } && ($] >= 5.013005 and $] <= 5.013006) ),
31 SHUFFLE_UNORDERED_RESULTSETS => $ENV{DBIC_SHUFFLE_UNORDERED_RESULTSETS} ? 1 : 0,
33 ASSERT_NO_INTERNAL_WANTARRAY => $ENV{DBIC_ASSERT_NO_INTERNAL_WANTARRAY} ? 1 : 0,
35 ASSERT_NO_INTERNAL_INDIRECT_CALLS => $ENV{DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS} ? 1 : 0,
37 STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE => $ENV{DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE} ? 1 : 0,
39 STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE => $ENV{DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE} ? 1 : 0,
41 IV_SIZE => $Config{ivsize},
48 constant->import( OLD_MRO => 1 );
52 constant->import( OLD_MRO => 0 );
56 # FIXME - this is not supposed to be here
57 # Carp::Skip to the rescue soon
58 use DBIx::Class::Carp '^DBIx::Class|^DBICTest';
62 use Storable 'nfreeze';
63 use Scalar::Util qw(weaken blessed reftype refaddr);
64 use List::Util qw(first);
65 use Sub::Quote qw(qsub quote_sub);
67 # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
68 BEGIN { *deep_clone = \&Storable::dclone }
72 sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
73 fail_on_internal_wantarray fail_on_internal_call
74 refdesc refcount hrefaddr is_exception detect_reinvoked_destructor
75 quote_sub qsub perlstring serialize deep_clone
76 UNRESOLVABLE_CONDITION
79 use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
81 sub sigwarn_silencer ($) {
84 croak "Expecting a regexp" if ref $pattern ne 'Regexp';
86 my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };
88 return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
91 sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
93 sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }
96 croak "Expecting a reference" if ! length ref $_[0];
98 # be careful not to trigger stringification,
99 # reuse @_ as a scratch-pad
100 sprintf '%s%s(0x%x)',
101 ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
108 croak "Expecting a reference" if ! length ref $_[0];
110 # No tempvars - must operate on $_[0], otherwise the pad
111 # will count as an extra ref
112 B::svref_2object($_[0])->REFCNT;
116 local $Storable::canonical = 1;
120 sub is_exception ($) {
123 # this is not strictly correct - an eval setting $@ to undef
124 # is *not* the same as an eval setting $@ to ''
125 # but for the sake of simplicity assume the following for
127 return 0 unless defined $e;
129 my ($not_blank, $suberror);
133 $not_blank = ($e ne '') ? 1 : 0;
138 if (defined $suberror) {
139 if (length (my $class = blessed($e) )) {
140 carp_unique( sprintf(
141 'External exception class %s implements partial (broken) overloading '
142 . 'preventing its instances from being used in simple ($x eq $y) '
143 . 'comparisons. Given Perl\'s "globally cooperative" exception '
144 . 'handling this type of brokenness is extremely dangerous on '
145 . 'exception objects, as it may (and often does) result in silent '
146 . '"exception substitution". DBIx::Class tries to work around this '
147 . 'as much as possible, but other parts of your software stack may '
148 . 'not be even aware of this. Please submit a bugreport against the '
149 . 'distribution containing %s and in the meantime apply a fix similar '
150 . 'to the one shown at %s, in order to ensure your exception handling '
151 . 'is saner application-wide. What follows is the actual error text '
152 . "as generated by Perl itself:\n\n%s\n ",
155 'http://v.gd/DBIC_overload_tempfix/',
159 # workaround, keeps spice flowing
160 $not_blank = ("$e" ne '') ? 1 : 0;
163 # not blessed yet failed the 'ne'... this makes 0 sense...
173 my $destruction_registry = {};
176 $destruction_registry = { map
177 { defined $_ ? ( refaddr($_) => $_ ) : () }
178 values %$destruction_registry
182 # This is almost invariably invoked from within DESTROY
183 # throwing exceptions won't work
184 sub detect_reinvoked_destructor {
186 # quick "garbage collection" pass - prevents the registry
187 # from slowly growing with a bunch of undef-valued keys
188 defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
189 for keys %$destruction_registry;
191 unless (length ref $_[0]) {
192 printf STDERR '%s() expects a reference %s',
196 return undef; # don't know wtf to do
199 if (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
200 weaken( $destruction_registry->{$addr} = $_[0] );
204 carp_unique ( sprintf (
205 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
206 . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
207 . 'application, affecting *ALL* classes without active protection against '
208 . 'this. Diagnose and fix the root cause ASAP!!!%s',
210 ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
211 ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
221 sub modver_gt_or_eq ($$) {
222 my ($mod, $ver) = @_;
224 croak "Nonsensical module name supplied"
225 if ! defined $mod or ! length $mod;
227 croak "Nonsensical minimum version supplied"
228 if ! defined $ver or $ver =~ /[^0-9\.\_]/;
230 local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
231 if SPURIOUS_VERSION_CHECK_WARNINGS;
233 croak "$mod does not seem to provide a version (perhaps it never loaded)"
234 unless $mod->VERSION;
237 eval { $mod->VERSION($ver) } ? 1 : 0;
240 sub modver_gt_or_eq_and_lt ($$$) {
241 my ($mod, $v_ge, $v_lt) = @_;
243 croak "Nonsensical maximum version supplied"
244 if ! defined $v_lt or $v_lt =~ /[^0-9\.\_]/;
247 modver_gt_or_eq($mod, $v_ge)
249 ! modver_gt_or_eq($mod, $v_lt)
254 my $list_ctx_ok_stack_marker;
256 sub fail_on_internal_wantarray () {
257 return if $list_ctx_ok_stack_marker;
259 if (! defined wantarray) {
260 croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
264 while ( ( (caller($cf+1))[3] || '' ) =~ / :: (?:
266 # these are public API parts that alter behavior on wantarray
267 search | search_related | slice | search_literal
271 # these are explicitly prefixed, since we only recognize them as valid
272 # escapes when they come from the guts of CDBICompat
273 CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )
279 my ($fr, $want, $argdesc);
282 $fr = [ caller($cf) ];
283 $want = ( caller($cf-1) )[5];
284 $argdesc = ref $DB::args[0]
285 ? DBIx::Class::_Util::refdesc($DB::args[0])
291 $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
293 DBIx::Class::Exception->throw( sprintf (
294 "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
295 $argdesc, @{$fr}[1,2]
296 ), 'with_stacktrace');
300 weaken ( $list_ctx_ok_stack_marker = $mark );
305 sub fail_on_internal_call {
310 $argdesc = ref $DB::args[0]
311 ? DBIx::Class::_Util::refdesc($DB::args[0])
319 $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
321 $fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there
323 DBIx::Class::Exception->throw( sprintf (
324 "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",
325 $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
328 B::Deparse->new->coderef2text(\&{$fr->[3]})
330 ), 'with_stacktrace');