Commit | Line | Data |
b1dbf716 |
1 | package # hide from PAUSE |
2 | DBIx::Class::_Util; |
3 | |
4 | use warnings; |
5 | use strict; |
6 | |
7 | use constant SPURIOUS_VERSION_CHECK_WARNINGS => ($] < 5.010 ? 1 : 0); |
8 | |
37873f78 |
9 | BEGIN { |
10 | package # hide from pause |
11 | DBIx::Class::_ENV_; |
12 | |
13 | use Config; |
14 | |
15 | use constant { |
16 | |
17 | # but of course |
18 | BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0, |
19 | |
8d73fcd4 |
20 | BROKEN_GOTO => ($] < '5.008003') ? 1 : 0, |
21 | |
37873f78 |
22 | HAS_ITHREADS => $Config{useithreads} ? 1 : 0, |
23 | |
24 | # ::Runmode would only be loaded by DBICTest, which in turn implies t/ |
25 | DBICTEST => eval { DBICTest::RunMode->is_author } ? 1 : 0, |
26 | |
27 | # During 5.13 dev cycle HELEMs started to leak on copy |
6cfb1d2f |
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) ), |
37873f78 |
30 | |
1b658919 |
31 | SHUFFLE_UNORDERED_RESULTSETS => $ENV{DBIC_SHUFFLE_UNORDERED_RESULTSETS} ? 1 : 0, |
32 | |
37873f78 |
33 | ASSERT_NO_INTERNAL_WANTARRAY => $ENV{DBIC_ASSERT_NO_INTERNAL_WANTARRAY} ? 1 : 0, |
34 | |
77c3a5dc |
35 | ASSERT_NO_INTERNAL_INDIRECT_CALLS => $ENV{DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS} ? 1 : 0, |
36 | |
2fdeef65 |
37 | STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE => $ENV{DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE} ? 1 : 0, |
38 | |
f45dc928 |
39 | STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE => $ENV{DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE} ? 1 : 0, |
40 | |
37873f78 |
41 | IV_SIZE => $Config{ivsize}, |
00882d2c |
42 | |
43 | OS_NAME => $^O, |
37873f78 |
44 | }; |
45 | |
46 | if ($] < 5.009_005) { |
47 | require MRO::Compat; |
48 | constant->import( OLD_MRO => 1 ); |
49 | } |
50 | else { |
51 | require mro; |
52 | constant->import( OLD_MRO => 0 ); |
53 | } |
54 | } |
55 | |
841efcb3 |
56 | # FIXME - this is not supposed to be here |
57 | # Carp::Skip to the rescue soon |
58 | use DBIx::Class::Carp '^DBIx::Class|^DBICTest'; |
59 | |
d7d45bdc |
60 | use B (); |
841efcb3 |
61 | use Carp 'croak'; |
d7d45bdc |
62 | use Storable 'nfreeze'; |
d63c9e64 |
63 | use Scalar::Util qw(weaken blessed reftype refaddr); |
3705e3b2 |
64 | use List::Util qw(first); |
0020e364 |
65 | use Sub::Quote qw(qsub quote_sub); |
7f9a3f70 |
66 | |
1c30a2e4 |
67 | # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone' |
68 | BEGIN { *deep_clone = \&Storable::dclone } |
69 | |
b1dbf716 |
70 | use base 'Exporter'; |
3705e3b2 |
71 | our @EXPORT_OK = qw( |
d634850b |
72 | sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt |
77c3a5dc |
73 | fail_on_internal_wantarray fail_on_internal_call |
d63c9e64 |
74 | refdesc refcount hrefaddr is_exception detected_reinvoked_destructor |
1c30a2e4 |
75 | quote_sub qsub perlstring serialize deep_clone |
facd0e8e |
76 | UNRESOLVABLE_CONDITION |
3705e3b2 |
77 | ); |
052a832c |
78 | |
facd0e8e |
79 | use constant UNRESOLVABLE_CONDITION => \ '1 = 0'; |
80 | |
bf302897 |
81 | sub sigwarn_silencer ($) { |
052a832c |
82 | my $pattern = shift; |
83 | |
84 | croak "Expecting a regexp" if ref $pattern ne 'Regexp'; |
85 | |
86 | my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) }; |
87 | |
88 | return sub { &$orig_sig_warn unless $_[0] =~ $pattern }; |
89 | } |
b1dbf716 |
90 | |
01b25f12 |
91 | sub perlstring ($) { q{"}. quotemeta( shift ). q{"} }; |
92 | |
d63c9e64 |
93 | sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 } |
8433421f |
94 | |
95 | sub refdesc ($) { |
96 | croak "Expecting a reference" if ! length ref $_[0]; |
97 | |
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]=" : '' ), |
102 | reftype $_[0], |
d63c9e64 |
103 | refaddr($_[0]), |
8433421f |
104 | ; |
105 | } |
bf302897 |
106 | |
107 | sub refcount ($) { |
dac7972a |
108 | croak "Expecting a reference" if ! length ref $_[0]; |
109 | |
dac7972a |
110 | # No tempvars - must operate on $_[0], otherwise the pad |
111 | # will count as an extra ref |
112 | B::svref_2object($_[0])->REFCNT; |
113 | } |
114 | |
b34d9331 |
115 | sub serialize ($) { |
b34d9331 |
116 | local $Storable::canonical = 1; |
d7d45bdc |
117 | nfreeze($_[0]); |
b34d9331 |
118 | } |
119 | |
841efcb3 |
120 | sub is_exception ($) { |
121 | my $e = $_[0]; |
122 | |
a0414138 |
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 |
126 | # the time being |
127 | return 0 unless defined $e; |
128 | |
841efcb3 |
129 | my ($not_blank, $suberror); |
130 | { |
131 | local $@; |
132 | eval { |
133 | $not_blank = ($e ne '') ? 1 : 0; |
134 | 1; |
135 | } or $suberror = $@; |
136 | } |
137 | |
138 | if (defined $suberror) { |
139 | if (length (my $class = blessed($e) )) { |
140 | carp_unique( sprintf( |
9bea2000 |
141 | 'External exception class %s implements partial (broken) overloading ' |
142 | . 'preventing its instances from being used in simple ($x eq $y) ' |
841efcb3 |
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 ", |
9bea2000 |
153 | $class, |
841efcb3 |
154 | $class, |
155 | 'http://v.gd/DBIC_overload_tempfix/', |
156 | $suberror, |
157 | )); |
158 | |
159 | # workaround, keeps spice flowing |
160 | $not_blank = ("$e" ne '') ? 1 : 0; |
161 | } |
162 | else { |
163 | # not blessed yet failed the 'ne'... this makes 0 sense... |
164 | # just throw further |
165 | die $suberror |
166 | } |
167 | } |
168 | |
169 | return $not_blank; |
170 | } |
171 | |
d63c9e64 |
172 | { |
173 | my $destruction_registry = {}; |
174 | |
175 | sub CLONE { |
176 | $destruction_registry = { map |
177 | { defined $_ ? ( refaddr($_) => $_ ) : () } |
178 | values %$destruction_registry |
179 | }; |
180 | } |
181 | |
182 | # This is almost invariably invoked from within DESTROY |
183 | # throwing exceptions won't work |
184 | sub detected_reinvoked_destructor { |
185 | |
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; |
190 | |
191 | if (! length ref $_[0]) { |
192 | printf STDERR '%s() expects a blessed reference %s', |
193 | (caller(0))[3], |
194 | Carp::longmess, |
195 | ; |
196 | return undef; # don't know wtf to do |
197 | } |
198 | elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) { |
199 | weaken( $destruction_registry->{$addr} = $_[0] ); |
200 | return 0; |
201 | } |
202 | else { |
203 | carp_unique ( sprintf ( |
204 | 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY ' |
205 | . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your ' |
206 | . 'application, affecting *ALL* classes without active protection against ' |
207 | . 'this. Diagnose and fix the root cause ASAP!!!%s', |
208 | refdesc $_[0], |
209 | ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } ) |
210 | ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)" |
211 | : '' |
212 | ) |
213 | )); |
214 | |
215 | return 1; |
216 | } |
217 | } |
218 | } |
219 | |
bf302897 |
220 | sub modver_gt_or_eq ($$) { |
b1dbf716 |
221 | my ($mod, $ver) = @_; |
222 | |
223 | croak "Nonsensical module name supplied" |
224 | if ! defined $mod or ! length $mod; |
225 | |
226 | croak "Nonsensical minimum version supplied" |
227 | if ! defined $ver or $ver =~ /[^0-9\.\_]/; |
228 | |
052a832c |
229 | local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ ) |
230 | if SPURIOUS_VERSION_CHECK_WARNINGS; |
b1dbf716 |
231 | |
56270bba |
232 | croak "$mod does not seem to provide a version (perhaps it never loaded)" |
233 | unless $mod->VERSION; |
234 | |
b1dbf716 |
235 | local $@; |
236 | eval { $mod->VERSION($ver) } ? 1 : 0; |
237 | } |
238 | |
d634850b |
239 | sub modver_gt_or_eq_and_lt ($$$) { |
240 | my ($mod, $v_ge, $v_lt) = @_; |
241 | |
242 | croak "Nonsensical maximum version supplied" |
243 | if ! defined $v_lt or $v_lt =~ /[^0-9\.\_]/; |
244 | |
245 | return ( |
246 | modver_gt_or_eq($mod, $v_ge) |
247 | and |
248 | ! modver_gt_or_eq($mod, $v_lt) |
249 | ) ? 1 : 0; |
250 | } |
251 | |
a9da9b6a |
252 | { |
253 | my $list_ctx_ok_stack_marker; |
254 | |
e89c7968 |
255 | sub fail_on_internal_wantarray () { |
a9da9b6a |
256 | return if $list_ctx_ok_stack_marker; |
257 | |
258 | if (! defined wantarray) { |
259 | croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard'); |
260 | } |
261 | |
262 | my $cf = 1; |
263 | while ( ( (caller($cf+1))[3] || '' ) =~ / :: (?: |
264 | |
265 | # these are public API parts that alter behavior on wantarray |
266 | search | search_related | slice | search_literal |
267 | |
268 | | |
269 | |
270 | # these are explicitly prefixed, since we only recognize them as valid |
271 | # escapes when they come from the guts of CDBICompat |
272 | CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all ) |
273 | |
274 | ) $/x ) { |
275 | $cf++; |
276 | } |
277 | |
e89c7968 |
278 | my ($fr, $want, $argdesc); |
279 | { |
280 | package DB; |
281 | $fr = [ caller($cf) ]; |
282 | $want = ( caller($cf-1) )[5]; |
283 | $argdesc = ref $DB::args[0] |
284 | ? DBIx::Class::_Util::refdesc($DB::args[0]) |
285 | : 'non ' |
286 | ; |
287 | }; |
288 | |
a9da9b6a |
289 | if ( |
e89c7968 |
290 | $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/ |
a9da9b6a |
291 | ) { |
a9da9b6a |
292 | DBIx::Class::Exception->throw( sprintf ( |
e89c7968 |
293 | "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts", |
294 | $argdesc, @{$fr}[1,2] |
a9da9b6a |
295 | ), 'with_stacktrace'); |
296 | } |
297 | |
298 | my $mark = []; |
299 | weaken ( $list_ctx_ok_stack_marker = $mark ); |
300 | $mark; |
301 | } |
302 | } |
303 | |
77c3a5dc |
304 | sub fail_on_internal_call { |
305 | my ($fr, $argdesc); |
306 | { |
307 | package DB; |
308 | $fr = [ caller(1) ]; |
309 | $argdesc = ref $DB::args[0] |
310 | ? DBIx::Class::_Util::refdesc($DB::args[0]) |
311 | : undef |
312 | ; |
313 | }; |
314 | |
315 | if ( |
316 | $argdesc |
317 | and |
318 | $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/ |
319 | and |
320 | $fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there |
321 | ) { |
322 | DBIx::Class::Exception->throw( sprintf ( |
323 | "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", |
324 | $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do { |
325 | require B::Deparse; |
326 | no strict 'refs'; |
327 | B::Deparse->new->coderef2text(\&{$fr->[3]}) |
328 | }), |
329 | ), 'with_stacktrace'); |
330 | } |
331 | } |
332 | |
b1dbf716 |
333 | 1; |