Commit | Line | Data |
b1dbf716 |
1 | package # hide from PAUSE |
2 | DBIx::Class::_Util; |
3 | |
399b9455 |
4 | use DBIx::Class::StartupCheck; # load es early as we can, usually a noop |
5 | |
b1dbf716 |
6 | use warnings; |
7 | use strict; |
8 | |
953f8eb0 |
9 | # For the love of everything that is crab-like: DO NOT reach into this |
10 | # The entire thing is really fragile and should not be screwed with |
11 | # unless absolutely and unavoidably necessary |
12 | our $__describe_class_query_cache; |
296248c3 |
13 | |
37873f78 |
14 | BEGIN { |
15 | package # hide from pause |
16 | DBIx::Class::_ENV_; |
17 | |
18 | use Config; |
19 | |
20 | use constant { |
3605497b |
21 | PERL_VERSION => "$]", |
22 | OS_NAME => "$^O", |
23 | }; |
24 | |
25 | use constant { |
37873f78 |
26 | |
27 | # but of course |
3605497b |
28 | BROKEN_FORK => (OS_NAME eq 'MSWin32') ? 1 : 0, |
37873f78 |
29 | |
3605497b |
30 | BROKEN_GOTO => ( PERL_VERSION < 5.008003 ) ? 1 : 0, |
8d73fcd4 |
31 | |
7bba735d |
32 | # perl -MScalar::Util=weaken -e 'weaken( $hash{key} = \"value" )' |
3605497b |
33 | BROKEN_WEAK_SCALARREF_VALUES => ( PERL_VERSION < 5.008003 ) ? 1 : 0, |
7bba735d |
34 | |
37873f78 |
35 | HAS_ITHREADS => $Config{useithreads} ? 1 : 0, |
36 | |
3605497b |
37 | UNSTABLE_DOLLARAT => ( PERL_VERSION < 5.013002 ) ? 1 : 0, |
bbf6a9a5 |
38 | |
db83437e |
39 | ( map |
40 | # |
41 | # the "DBIC_" prefix below is crucial - this is what makes CI pick up |
42 | # all envvars without further adjusting its scripts |
43 | # DO NOT CHANGE to the more logical { $_ => !!( $ENV{"DBIC_$_"} ) } |
44 | # |
45 | { substr($_, 5) => !!( $ENV{$_} ) } |
46 | qw( |
47 | DBIC_SHUFFLE_UNORDERED_RESULTSETS |
48 | DBIC_ASSERT_NO_INTERNAL_WANTARRAY |
49 | DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS |
50 | DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE |
51 | DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE |
52 | ) |
53 | ), |
f45dc928 |
54 | |
37873f78 |
55 | IV_SIZE => $Config{ivsize}, |
56 | }; |
57 | |
3605497b |
58 | if ( PERL_VERSION < 5.009_005) { |
37873f78 |
59 | require MRO::Compat; |
60 | constant->import( OLD_MRO => 1 ); |
296248c3 |
61 | |
62 | # |
63 | # Yes, I know this is a rather PHP-ish name, but please first read |
64 | # https://metacpan.org/source/BOBTFISH/MRO-Compat-0.12/lib/MRO/Compat.pm#L363-368 |
65 | # |
66 | # Even if we are using Class::C3::XS it still won't work, as doing |
67 | # defined( *{ "SubClass::"->{$_} }{CODE} ) |
68 | # will set pkg_gen to the same value for SubClass and *ALL PARENTS* |
69 | # |
70 | *DBIx::Class::_Util::get_real_pkg_gen = sub ($) { |
71 | require Digest::MD5; |
72 | require Math::BigInt; |
73 | |
953f8eb0 |
74 | my $cur_class; |
75 | no strict 'refs'; |
76 | |
296248c3 |
77 | # the non-assign-unless-there-is-a-hash is deliberate |
953f8eb0 |
78 | ( $__describe_class_query_cache->{'!internal!'} || {} )->{$_[0]}{gen} ||= ( |
296248c3 |
79 | Math::BigInt->new( '0x' . ( Digest::MD5::md5_hex( join "\0", map { |
80 | |
953f8eb0 |
81 | ( $__describe_class_query_cache->{'!internal!'} || {} )->{$_}{methlist} ||= ( |
82 | |
83 | $cur_class = $_ |
296248c3 |
84 | |
953f8eb0 |
85 | and |
1c179556 |
86 | |
87 | # RV to be hashed up and turned into a number |
88 | join "\0", ( |
953f8eb0 |
89 | $cur_class, |
296248c3 |
90 | map |
1c179556 |
91 | {( |
92 | # stringification should be sufficient, ignore names/refaddr entirely |
93 | $_, |
92705f7f |
94 | do { |
95 | my @attrs; |
96 | local $@; |
97 | local $SIG{__DIE__} if $SIG{__DIE__}; |
98 | # attributes::get may throw on blessed-false crefs :/ |
99 | eval { @attrs = attributes::get( $_ ); 1 } |
100 | or warn "Unable to determine attributes of coderef $_ due to the following error: $@"; |
101 | @attrs; |
102 | }, |
1c179556 |
103 | )} |
296248c3 |
104 | map |
1c179556 |
105 | {( |
106 | # skip dummy C::C3 helper crefs |
953f8eb0 |
107 | ! ( ( $Class::C3::MRO{$cur_class} || {} )->{methods}{$_} ) |
1c179556 |
108 | and |
296248c3 |
109 | ( |
953f8eb0 |
110 | ref(\ "${cur_class}::"->{$_} ) ne 'GLOB' |
296248c3 |
111 | or |
953f8eb0 |
112 | defined( *{ "${cur_class}::"->{$_} }{CODE} ) |
296248c3 |
113 | ) |
1c179556 |
114 | ) |
953f8eb0 |
115 | ? ( \&{"${cur_class}::$_"} ) |
296248c3 |
116 | : () |
117 | } |
953f8eb0 |
118 | keys %{ "${cur_class}::" } |
119 | ) |
120 | ) |
d01688cc |
121 | } ( |
122 | |
123 | @{ |
953f8eb0 |
124 | ( $__describe_class_query_cache->{'!internal!'} || {} )->{$_[0]}{linear_isa} |
d01688cc |
125 | ||= |
126 | mro::get_linear_isa($_[0]) |
127 | }, |
128 | |
129 | (( |
953f8eb0 |
130 | ( $__describe_class_query_cache->{'!internal!'} || {} )->{$_[0]}{is_universal} |
d01688cc |
131 | ||= |
132 | mro::is_universal($_[0]) |
133 | ) ? () : @{ |
953f8eb0 |
134 | ( $__describe_class_query_cache->{'!internal!'} || {} )->{UNIVERSAL}{linear_isa} |
d01688cc |
135 | ||= |
136 | mro::get_linear_isa("UNIVERSAL") |
137 | } ), |
138 | |
139 | ) ) ) ) |
296248c3 |
140 | ); |
141 | }; |
37873f78 |
142 | } |
143 | else { |
144 | require mro; |
145 | constant->import( OLD_MRO => 0 ); |
296248c3 |
146 | *DBIx::Class::_Util::get_real_pkg_gen = \&mro::get_pkg_gen; |
37873f78 |
147 | } |
4b1b44c1 |
148 | |
149 | # Both of these are no longer used for anything. However bring |
150 | # them back after they were purged in 08a8d8f1, as there appear |
151 | # to be outfits with *COPY PASTED* pieces of lib/DBIx/Class/Storage/* |
152 | # in their production codebases. There is no point in breaking these |
153 | # if whatever they used actually continues to work |
154 | my $warned; |
155 | my $sigh = sub { |
156 | |
157 | require Carp; |
158 | my $cluck = "The @{[ (caller(1))[3] ]} constant is no more - adjust your code" . Carp::longmess(); |
159 | |
160 | warn $cluck unless $warned->{$cluck}++; |
161 | |
162 | 0; |
163 | }; |
164 | sub DBICTEST () { &$sigh } |
165 | sub PEEPEENESS () { &$sigh } |
37873f78 |
166 | } |
167 | |
3605497b |
168 | use constant SPURIOUS_VERSION_CHECK_WARNINGS => ( DBIx::Class::_ENV_::PERL_VERSION < 5.010 ? 1 : 0); |
169 | |
841efcb3 |
170 | # FIXME - this is not supposed to be here |
171 | # Carp::Skip to the rescue soon |
172 | use DBIx::Class::Carp '^DBIx::Class|^DBICTest'; |
173 | |
d7d45bdc |
174 | use B (); |
841efcb3 |
175 | use Carp 'croak'; |
d7d45bdc |
176 | use Storable 'nfreeze'; |
3d56e026 |
177 | use Scalar::Util qw(weaken blessed reftype refaddr); |
e85eb407 |
178 | use Sub::Quote qw(qsub); |
514b84f6 |
179 | use Sub::Name (); |
296248c3 |
180 | use attributes (); |
7f9a3f70 |
181 | |
1c30a2e4 |
182 | # Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone' |
183 | BEGIN { *deep_clone = \&Storable::dclone } |
184 | |
b1dbf716 |
185 | use base 'Exporter'; |
3705e3b2 |
186 | our @EXPORT_OK = qw( |
d634850b |
187 | sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt |
77c3a5dc |
188 | fail_on_internal_wantarray fail_on_internal_call |
296248c3 |
189 | refdesc refcount hrefaddr set_subname describe_class_methods |
ddcc02d1 |
190 | scope_guard detected_reinvoked_destructor |
293cb2f1 |
191 | true false |
10be570e |
192 | is_exception dbic_internal_try visit_namespaces |
193 | quote_sub qsub perlstring serialize deep_clone dump_value uniq |
439a7283 |
194 | parent_dir mkdir_p |
facd0e8e |
195 | UNRESOLVABLE_CONDITION |
3705e3b2 |
196 | ); |
052a832c |
197 | |
facd0e8e |
198 | use constant UNRESOLVABLE_CONDITION => \ '1 = 0'; |
199 | |
e85eb407 |
200 | # Override forcing no_defer, and adding naming consistency checks |
dc715747 |
201 | our %refs_closed_over_by_quote_sub_installed_crefs; |
e85eb407 |
202 | sub quote_sub { |
9642350a |
203 | Carp::confess( "Anonymous quoting not supported by the DBIC quote_sub override - supply a sub name" ) if |
e85eb407 |
204 | @_ < 2 |
205 | or |
206 | ! defined $_[1] |
207 | or |
208 | length ref $_[1] |
209 | ; |
210 | |
9642350a |
211 | Carp::confess( "The DBIC quote_sub override expects sub name '$_[0]' to be fully qualified" ) |
212 | unless (my $stash) = $_[0] =~ /^(.+)::/; |
213 | |
214 | Carp::confess( |
215 | "The DBIC sub_quote override does not support 'no_install'" |
216 | ) if ( |
217 | $_[3] |
218 | and |
219 | $_[3]->{no_install} |
220 | ); |
e85eb407 |
221 | |
9642350a |
222 | Carp::confess( |
223 | 'The DBIC quote_sub override expects the namespace-part of sub name ' |
224 | . "'$_[0]' to match the supplied package argument '$_[3]->{package}'" |
225 | ) if ( |
e85eb407 |
226 | $_[3] |
227 | and |
228 | defined $_[3]->{package} |
229 | and |
9642350a |
230 | $stash ne $_[3]->{package} |
231 | ); |
e85eb407 |
232 | |
233 | my @caller = caller(0); |
234 | my $sq_opts = { |
235 | package => $caller[0], |
236 | hints => $caller[8], |
237 | warning_bits => $caller[9], |
238 | hintshash => $caller[10], |
239 | %{ $_[3] || {} }, |
240 | |
241 | # explicitly forced for everything |
242 | no_defer => 1, |
243 | }; |
244 | |
dc715747 |
245 | weaken ( |
246 | # just use a growing counter, no need to perform neither compaction |
247 | # nor any special ithread-level handling |
248 | $refs_closed_over_by_quote_sub_installed_crefs |
249 | { scalar keys %refs_closed_over_by_quote_sub_installed_crefs } |
250 | = $_ |
251 | ) for grep { |
252 | length ref $_ |
253 | and |
254 | ( |
255 | ! DBIx::Class::_ENV_::BROKEN_WEAK_SCALARREF_VALUES |
256 | or |
257 | ref $_ ne 'SCALAR' |
258 | ) |
259 | } values %{ $_[2] || {} }; |
260 | |
9642350a |
261 | Sub::Quote::quote_sub( $_[0], $_[1], $_[2]||{}, $sq_opts ); |
e85eb407 |
262 | } |
263 | |
bf302897 |
264 | sub sigwarn_silencer ($) { |
052a832c |
265 | my $pattern = shift; |
266 | |
267 | croak "Expecting a regexp" if ref $pattern ne 'Regexp'; |
268 | |
269 | my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) }; |
270 | |
271 | return sub { &$orig_sig_warn unless $_[0] =~ $pattern }; |
272 | } |
b1dbf716 |
273 | |
01b25f12 |
274 | sub perlstring ($) { q{"}. quotemeta( shift ). q{"} }; |
275 | |
3d56e026 |
276 | sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 } |
8433421f |
277 | |
278 | sub refdesc ($) { |
279 | croak "Expecting a reference" if ! length ref $_[0]; |
280 | |
281 | # be careful not to trigger stringification, |
282 | # reuse @_ as a scratch-pad |
283 | sprintf '%s%s(0x%x)', |
284 | ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ), |
285 | reftype $_[0], |
3d56e026 |
286 | refaddr($_[0]), |
8433421f |
287 | ; |
288 | } |
bf302897 |
289 | |
290 | sub refcount ($) { |
dac7972a |
291 | croak "Expecting a reference" if ! length ref $_[0]; |
292 | |
dac7972a |
293 | # No tempvars - must operate on $_[0], otherwise the pad |
294 | # will count as an extra ref |
295 | B::svref_2object($_[0])->REFCNT; |
296 | } |
297 | |
10be570e |
298 | sub visit_namespaces { |
299 | my $args = { (ref $_[0]) ? %{$_[0]} : @_ }; |
300 | |
301 | my $visited_count = 1; |
302 | |
303 | # A package and a namespace are subtly different things |
304 | $args->{package} ||= 'main'; |
305 | $args->{package} = 'main' if $args->{package} =~ /^ :: (?: main )? $/x; |
306 | $args->{package} =~ s/^:://; |
307 | |
308 | if ( $args->{action}->($args->{package}) ) { |
309 | my $ns = |
310 | ( ($args->{package} eq 'main') ? '' : $args->{package} ) |
311 | . |
312 | '::' |
313 | ; |
314 | |
315 | $visited_count += visit_namespaces( %$args, package => $_ ) for |
316 | grep |
317 | # this happens sometimes on %:: traversal |
318 | { $_ ne '::main' } |
319 | map |
320 | { $_ =~ /^(.+?)::$/ ? "$ns$1" : () } |
321 | do { no strict 'refs'; keys %$ns } |
322 | ; |
323 | } |
324 | |
325 | $visited_count; |
326 | } |
327 | |
514b84f6 |
328 | # FIXME In another life switch this to a polyfill like the one in namespace::clean |
329 | sub set_subname ($$) { |
330 | |
331 | # fully qualify name |
332 | splice @_, 0, 1, caller(0) . "::$_[0]" |
333 | if $_[0] !~ /::|'/; |
334 | |
335 | &Sub::Name::subname; |
336 | } |
337 | |
b34d9331 |
338 | sub serialize ($) { |
b34d9331 |
339 | local $Storable::canonical = 1; |
d7d45bdc |
340 | nfreeze($_[0]); |
b34d9331 |
341 | } |
342 | |
10be570e |
343 | sub uniq { |
344 | my( %seen, $seen_undef, $numeric_preserving_copy ); |
345 | grep { not ( |
346 | defined $_ |
347 | ? $seen{ $numeric_preserving_copy = $_ }++ |
348 | : $seen_undef++ |
349 | ) } @_; |
350 | } |
351 | |
2d5ac3cf |
352 | my $dd_obj; |
8fc4291e |
353 | sub dump_value ($) { |
354 | local $Data::Dumper::Indent = 1 |
355 | unless defined $Data::Dumper::Indent; |
356 | |
2d5ac3cf |
357 | my $dump_str = ( |
8fc4291e |
358 | $dd_obj |
359 | ||= |
360 | do { |
361 | require Data::Dumper; |
362 | my $d = Data::Dumper->new([]) |
363 | ->Purity(0) |
364 | ->Pad('') |
365 | ->Useqq(1) |
366 | ->Terse(1) |
367 | ->Freezer('') |
368 | ->Quotekeys(0) |
369 | ->Bless('bless') |
370 | ->Pair(' => ') |
371 | ->Sortkeys(1) |
372 | ->Deparse(1) |
373 | ; |
374 | |
375 | $d->Sparseseen(1) if modver_gt_or_eq ( |
376 | 'Data::Dumper', '2.136' |
377 | ); |
378 | |
379 | $d; |
380 | } |
381 | )->Values([$_[0]])->Dump; |
382 | |
383 | $dd_obj->Reset->Values([]); |
384 | |
385 | $dump_str; |
386 | } |
387 | |
293cb2f1 |
388 | ### |
389 | ### This is *NOT* boolean.pm - deliberately not using a singleton |
390 | ### |
391 | { |
392 | package # hide from pause |
393 | DBIx::Class::_Util::_Bool; |
394 | use overload |
395 | bool => sub { ${$_[0]} }, |
396 | fallback => 1, |
397 | ; |
398 | } |
399 | sub true () { my $x = 1; bless \$x, "DBIx::Class::_Util::_Bool" } |
400 | sub false () { my $x = 0; bless \$x, "DBIx::Class::_Util::_Bool" } |
401 | |
bbf6a9a5 |
402 | sub scope_guard (&) { |
403 | croak 'Calling scope_guard() in void context makes no sense' |
404 | if ! defined wantarray; |
405 | |
406 | # no direct blessing of coderefs - DESTROY is buggy on those |
407 | bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard'; |
408 | } |
409 | { |
410 | package # |
411 | DBIx::Class::_Util::ScopeGuard; |
412 | |
413 | sub DESTROY { |
414 | &DBIx::Class::_Util::detected_reinvoked_destructor; |
415 | |
416 | local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT; |
417 | |
418 | eval { |
419 | $_[0]->[0]->(); |
420 | 1; |
118b2c36 |
421 | } |
422 | or |
423 | Carp::cluck( |
424 | "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@" |
425 | ); |
bbf6a9a5 |
426 | } |
427 | } |
428 | |
429 | |
841efcb3 |
430 | sub is_exception ($) { |
431 | my $e = $_[0]; |
432 | |
35cf7d1a |
433 | # FIXME |
a0414138 |
434 | # this is not strictly correct - an eval setting $@ to undef |
435 | # is *not* the same as an eval setting $@ to '' |
436 | # but for the sake of simplicity assume the following for |
437 | # the time being |
438 | return 0 unless defined $e; |
439 | |
841efcb3 |
440 | my ($not_blank, $suberror); |
441 | { |
5c33c8be |
442 | local $SIG{__DIE__} if $SIG{__DIE__}; |
841efcb3 |
443 | local $@; |
444 | eval { |
d52c4a75 |
445 | # The ne() here is deliberate - a plain length($e), or worse "$e" ne |
446 | # will entirely obviate the need for the encolsing eval{}, as the |
447 | # condition we guard against is a missing fallback overload |
448 | $not_blank = ( $e ne '' ); |
841efcb3 |
449 | 1; |
450 | } or $suberror = $@; |
451 | } |
452 | |
453 | if (defined $suberror) { |
454 | if (length (my $class = blessed($e) )) { |
455 | carp_unique( sprintf( |
9bea2000 |
456 | 'External exception class %s implements partial (broken) overloading ' |
457 | . 'preventing its instances from being used in simple ($x eq $y) ' |
841efcb3 |
458 | . 'comparisons. Given Perl\'s "globally cooperative" exception ' |
459 | . 'handling this type of brokenness is extremely dangerous on ' |
460 | . 'exception objects, as it may (and often does) result in silent ' |
461 | . '"exception substitution". DBIx::Class tries to work around this ' |
462 | . 'as much as possible, but other parts of your software stack may ' |
463 | . 'not be even aware of this. Please submit a bugreport against the ' |
464 | . 'distribution containing %s and in the meantime apply a fix similar ' |
465 | . 'to the one shown at %s, in order to ensure your exception handling ' |
466 | . 'is saner application-wide. What follows is the actual error text ' |
467 | . "as generated by Perl itself:\n\n%s\n ", |
9bea2000 |
468 | $class, |
841efcb3 |
469 | $class, |
470 | 'http://v.gd/DBIC_overload_tempfix/', |
471 | $suberror, |
472 | )); |
473 | |
474 | # workaround, keeps spice flowing |
d52c4a75 |
475 | $not_blank = !!( length $e ); |
841efcb3 |
476 | } |
477 | else { |
478 | # not blessed yet failed the 'ne'... this makes 0 sense... |
479 | # just throw further |
480 | die $suberror |
481 | } |
482 | } |
84e4e006 |
483 | elsif ( |
484 | # a ref evaluating to '' is definitively a "null object" |
485 | ( not $not_blank ) |
486 | and |
487 | length( my $class = ref $e ) |
488 | ) { |
489 | carp_unique( sprintf( |
490 | "Objects of external exception class '%s' stringify to '' (the " |
491 | . 'empty string), implementing the so called null-object-pattern. ' |
492 | . 'Given Perl\'s "globally cooperative" exception handling using this ' |
493 | . 'class of exceptions is extremely dangerous, as it may (and often ' |
494 | . 'does) result in silent discarding of errors. DBIx::Class tries to ' |
495 | . 'work around this as much as possible, but other parts of your ' |
496 | . 'software stack may not be even aware of the problem. Please submit ' |
35cf7d1a |
497 | . 'a bugreport against the distribution containing %s', |
84e4e006 |
498 | |
499 | ($class) x 2, |
500 | )); |
501 | |
502 | $not_blank = 1; |
503 | } |
841efcb3 |
504 | |
505 | return $not_blank; |
506 | } |
507 | |
3d56e026 |
508 | { |
ddcc02d1 |
509 | my $callstack_state; |
510 | |
511 | # Recreate the logic of try(), while reusing the catch()/finally() as-is |
512 | # |
513 | # FIXME: We need to move away from Try::Tiny entirely (way too heavy and |
514 | # yes, shows up ON TOP of profiles) but this is a batle for another maint |
515 | sub dbic_internal_try (&;@) { |
516 | |
517 | my $try_cref = shift; |
518 | my $catch_cref = undef; # apparently this is a thing... https://rt.perl.org/Public/Bug/Display.html?id=119311 |
519 | |
520 | for my $arg (@_) { |
521 | |
522 | if( ref($arg) eq 'Try::Tiny::Catch' ) { |
523 | |
524 | croak 'dbic_internal_try() may not be followed by multiple catch() blocks' |
525 | if $catch_cref; |
526 | |
527 | $catch_cref = $$arg; |
528 | } |
529 | elsif ( ref($arg) eq 'Try::Tiny::Finally' ) { |
530 | croak 'dbic_internal_try() does not support finally{}'; |
531 | } |
532 | else { |
533 | croak( |
534 | 'dbic_internal_try() encountered an unexpected argument ' |
535 | . "'@{[ defined $arg ? $arg : 'UNDEF' ]}' - perhaps " |
536 | . 'a missing semi-colon before or ' # trailing space important |
537 | ); |
538 | } |
539 | } |
540 | |
541 | my $wantarray = wantarray; |
542 | my $preexisting_exception = $@; |
543 | |
544 | my @ret; |
545 | my $all_good = eval { |
546 | $@ = $preexisting_exception; |
547 | |
548 | local $callstack_state->{in_internal_try} = 1 |
549 | unless $callstack_state->{in_internal_try}; |
550 | |
551 | # always unset - someone may have snuck it in |
5c33c8be |
552 | local $SIG{__DIE__} if $SIG{__DIE__}; |
ddcc02d1 |
553 | |
554 | if( $wantarray ) { |
555 | @ret = $try_cref->(); |
556 | } |
557 | elsif( defined $wantarray ) { |
558 | $ret[0] = $try_cref->(); |
559 | } |
560 | else { |
561 | $try_cref->(); |
562 | } |
563 | |
564 | 1; |
565 | }; |
566 | |
567 | my $exception = $@; |
568 | $@ = $preexisting_exception; |
569 | |
570 | if ( $all_good ) { |
571 | return $wantarray ? @ret : $ret[0] |
572 | } |
573 | elsif ( $catch_cref ) { |
574 | for ( $exception ) { |
575 | return $catch_cref->($exception); |
576 | } |
577 | } |
578 | |
579 | return; |
580 | } |
581 | |
582 | sub in_internal_try { !! $callstack_state->{in_internal_try} } |
583 | } |
584 | |
585 | { |
3d56e026 |
586 | my $destruction_registry = {}; |
587 | |
04c1a070 |
588 | sub DBIx::Class::__Util_iThreads_handler__::CLONE { |
d098704f |
589 | %$destruction_registry = map { |
590 | (defined $_) |
591 | ? ( refaddr($_) => $_ ) |
592 | : () |
593 | } values %$destruction_registry; |
d52fc26d |
594 | |
d098704f |
595 | weaken($_) for values %$destruction_registry; |
29211e03 |
596 | |
d52fc26d |
597 | # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage |
598 | # collected before leaving this scope. Depending on the code above, this |
599 | # may very well be just a preventive measure guarding future modifications |
600 | undef; |
3d56e026 |
601 | } |
602 | |
603 | # This is almost invariably invoked from within DESTROY |
604 | # throwing exceptions won't work |
e1d9e578 |
605 | sub detected_reinvoked_destructor { |
3d56e026 |
606 | |
607 | # quick "garbage collection" pass - prevents the registry |
608 | # from slowly growing with a bunch of undef-valued keys |
609 | defined $destruction_registry->{$_} or delete $destruction_registry->{$_} |
610 | for keys %$destruction_registry; |
611 | |
e1d9e578 |
612 | if (! length ref $_[0]) { |
613 | printf STDERR '%s() expects a blessed reference %s', |
3d56e026 |
614 | (caller(0))[3], |
615 | Carp::longmess, |
616 | ; |
617 | return undef; # don't know wtf to do |
618 | } |
e1d9e578 |
619 | elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) { |
3d56e026 |
620 | weaken( $destruction_registry->{$addr} = $_[0] ); |
621 | return 0; |
622 | } |
623 | else { |
624 | carp_unique ( sprintf ( |
625 | 'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY ' |
626 | . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your ' |
627 | . 'application, affecting *ALL* classes without active protection against ' |
628 | . 'this. Diagnose and fix the root cause ASAP!!!%s', |
629 | refdesc $_[0], |
630 | ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } ) |
631 | ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)" |
632 | : '' |
633 | ) |
634 | )); |
635 | |
636 | return 1; |
637 | } |
638 | } |
639 | } |
640 | |
7302b3e0 |
641 | my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x; |
642 | my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x; |
643 | |
bf302897 |
644 | sub modver_gt_or_eq ($$) { |
b1dbf716 |
645 | my ($mod, $ver) = @_; |
646 | |
647 | croak "Nonsensical module name supplied" |
7302b3e0 |
648 | if ! defined $mod or $mod !~ $module_name_rx; |
b1dbf716 |
649 | |
650 | croak "Nonsensical minimum version supplied" |
7302b3e0 |
651 | if ! defined $ver or $ver !~ $ver_rx; |
652 | |
653 | no strict 'refs'; |
654 | my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION |
655 | ? {} |
656 | : croak "$mod does not seem to provide a version (perhaps it never loaded)" |
657 | ); |
658 | |
659 | ! defined $ver_cache->{$ver} |
660 | and |
661 | $ver_cache->{$ver} = do { |
b1dbf716 |
662 | |
7302b3e0 |
663 | local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ ) |
664 | if SPURIOUS_VERSION_CHECK_WARNINGS; |
b1dbf716 |
665 | |
5c33c8be |
666 | local $SIG{__DIE__} if $SIG{__DIE__}; |
7302b3e0 |
667 | local $@; |
7302b3e0 |
668 | eval { $mod->VERSION($ver) } ? 1 : 0; |
669 | }; |
56270bba |
670 | |
7302b3e0 |
671 | $ver_cache->{$ver}; |
b1dbf716 |
672 | } |
673 | |
d634850b |
674 | sub modver_gt_or_eq_and_lt ($$$) { |
675 | my ($mod, $v_ge, $v_lt) = @_; |
676 | |
677 | croak "Nonsensical maximum version supplied" |
7302b3e0 |
678 | if ! defined $v_lt or $v_lt !~ $ver_rx; |
d634850b |
679 | |
680 | return ( |
681 | modver_gt_or_eq($mod, $v_ge) |
682 | and |
683 | ! modver_gt_or_eq($mod, $v_lt) |
684 | ) ? 1 : 0; |
685 | } |
686 | |
296248c3 |
687 | { |
296248c3 |
688 | |
689 | sub describe_class_methods { |
8eac247d |
690 | my $args = ( |
691 | ref $_[0] eq 'HASH' ? $_[0] |
692 | : ( @_ == 1 and ! length ref $_[0] ) ? { class => $_[0] } |
693 | : { @_ } |
694 | ); |
695 | |
696 | my ($class, $requested_mro) = @{$args}{qw( class use_mro )}; |
296248c3 |
697 | |
8eac247d |
698 | croak "Expecting a class name either as the sole argument or a 'class' option" |
5e67be26 |
699 | if not defined $class or $class !~ $module_name_rx; |
296248c3 |
700 | |
1cf2ad8b |
701 | $requested_mro ||= mro::get_mro($class); |
702 | |
703 | # mro::set_mro() does not bump pkg_gen - WHAT THE FUCK?! |
704 | my $query_cache_key = "$class|$requested_mro"; |
705 | |
953f8eb0 |
706 | my $internal_cache_key = |
1cf2ad8b |
707 | ( mro::get_mro($class) eq $requested_mro ) |
708 | ? $class |
709 | : $query_cache_key |
710 | ; |
711 | |
296248c3 |
712 | # use a cache on old MRO, since while we are recursing in this function |
713 | # nothing can possibly change (the speedup is immense) |
714 | # (yes, people could be tie()ing the stash and adding methods on access |
715 | # but there is a limit to how much crazy can be supported here) |
716 | # |
717 | # we use the cache for linear_isa lookups on new MRO as well - it adds |
718 | # a *tiny* speedup, and simplifies the code a lot |
719 | # |
953f8eb0 |
720 | local $__describe_class_query_cache->{'!internal!'} = {} |
721 | unless $__describe_class_query_cache->{'!internal!'}; |
296248c3 |
722 | |
723 | my $my_gen = 0; |
724 | |
d01688cc |
725 | $my_gen += get_real_pkg_gen($_) for ( my @full_ISA = ( |
726 | |
727 | @{ |
953f8eb0 |
728 | $__describe_class_query_cache->{'!internal!'}{$internal_cache_key}{linear_isa} |
296248c3 |
729 | ||= |
1cf2ad8b |
730 | mro::get_linear_isa($class, $requested_mro) |
d01688cc |
731 | }, |
732 | |
733 | (( |
953f8eb0 |
734 | $__describe_class_query_cache->{'!internal!'}{$class}{is_universal} |
d01688cc |
735 | ||= |
736 | mro::is_universal($class) |
737 | ) ? () : @{ |
953f8eb0 |
738 | $__describe_class_query_cache->{'!internal!'}{UNIVERSAL}{linear_isa} |
d01688cc |
739 | ||= |
740 | mro::get_linear_isa("UNIVERSAL") |
741 | }), |
742 | |
743 | )); |
296248c3 |
744 | |
953f8eb0 |
745 | my $slot = $__describe_class_query_cache->{$query_cache_key} ||= {}; |
296248c3 |
746 | |
747 | unless ( ($slot->{cumulative_gen}||0) == $my_gen ) { |
748 | |
749 | # reset |
750 | %$slot = ( |
751 | class => $class, |
2603b495 |
752 | isa => { map { $_ => 1 } @full_ISA }, |
753 | linear_isa => [ |
953f8eb0 |
754 | @{ $__describe_class_query_cache->{'!internal!'}{$internal_cache_key}{linear_isa} } |
755 | [ 1 .. $#{$__describe_class_query_cache->{'!internal!'}{$internal_cache_key}{linear_isa}} ] |
d01688cc |
756 | ], |
296248c3 |
757 | mro => { |
1cf2ad8b |
758 | type => $requested_mro, |
759 | is_c3 => ( ($requested_mro eq 'c3') ? 1 : 0 ), |
296248c3 |
760 | }, |
761 | cumulative_gen => $my_gen, |
762 | ); |
296248c3 |
763 | |
2603b495 |
764 | # remove ourselves from ISA |
765 | shift @full_ISA; |
766 | |
296248c3 |
767 | # ensure the cache is populated for the parents, code below can then |
768 | # efficiently operate over the query_cache directly |
d01688cc |
769 | describe_class_methods($_) for reverse @full_ISA; |
296248c3 |
770 | |
296248c3 |
771 | no strict 'refs'; |
772 | |
773 | # combine full ISA-order inherited and local method list into a |
774 | # "shadowing stack" |
775 | |
776 | ( |
085dbdd6 |
777 | unshift @{ $slot->{methods}{$_->{name}} }, $_ |
296248c3 |
778 | |
779 | and |
780 | |
085dbdd6 |
781 | ( |
782 | $_->{via_class} ne $class |
783 | or |
784 | $slot->{methods_defined_in_class}{$_->{name}} = $_ |
785 | ) |
296248c3 |
786 | |
787 | and |
788 | |
789 | @{ $slot->{methods}{$_->{name}} } > 1 |
790 | |
791 | and |
792 | |
793 | $slot->{methods_with_supers}{$_->{name}} = $slot->{methods}{$_->{name}} |
794 | |
795 | ) for ( |
796 | |
d01688cc |
797 | # what describe_class_methods for @full_ISA produced above |
085dbdd6 |
798 | ( map { values %{ |
953f8eb0 |
799 | $__describe_class_query_cache->{$_}{methods_defined_in_class} || {} |
1cf2ad8b |
800 | } } map { "$_|" . mro::get_mro($_) } reverse @full_ISA ), |
296248c3 |
801 | |
802 | # our own non-cleaned subs + their attributes |
803 | ( map { |
804 | ( |
1c179556 |
805 | # need to account for dummy helper crefs under OLD_MRO |
296248c3 |
806 | ( |
1c179556 |
807 | ! DBIx::Class::_ENV_::OLD_MRO |
296248c3 |
808 | or |
1c179556 |
809 | ! ( ( $Class::C3::MRO{$class} || {} )->{methods}{$_} ) |
296248c3 |
810 | ) |
811 | and |
1c179556 |
812 | # these 2 OR-ed checks are sufficient for 5.10+ |
296248c3 |
813 | ( |
1c179556 |
814 | ref(\ "${class}::"->{$_} ) ne 'GLOB' |
296248c3 |
815 | or |
1c179556 |
816 | defined( *{ "${class}::"->{$_} }{CODE} ) |
296248c3 |
817 | ) |
818 | ) ? { |
819 | via_class => $class, |
820 | name => $_, |
92705f7f |
821 | attributes => { map { $_ => 1 } do { |
822 | my @attrs; |
823 | local $@; |
824 | local $SIG{__DIE__} if $SIG{__DIE__}; |
825 | # attributes::get may throw on blessed-false crefs :/ |
826 | eval { @attrs = attributes::get( \&{"${class}::${_}"} ); 1 } |
827 | or warn "Unable to determine attributes of the \\&${class}::$_ method due to following error: $@"; |
828 | @attrs; |
829 | } }, |
296248c3 |
830 | } |
831 | : () |
832 | } keys %{"${class}::"} ) |
833 | ); |
834 | |
835 | |
836 | # recalculate the pkg_gen on newer perls under Taint mode, |
837 | # because of shit like: |
838 | # perl -T -Mmro -e 'package Foo; sub bar {}; defined( *{ "Foo::"->{bar}}{CODE} ) and warn mro::get_pkg_gen("Foo") for (1,2,3)' |
839 | # |
840 | if ( |
841 | ! DBIx::Class::_ENV_::OLD_MRO |
842 | and |
843 | ${^TAINT} |
844 | ) { |
845 | |
846 | $slot->{cumulative_gen} = 0; |
847 | $slot->{cumulative_gen} += get_real_pkg_gen($_) |
d01688cc |
848 | for $class, @full_ISA; |
296248c3 |
849 | } |
850 | } |
851 | |
852 | # RV |
853 | +{ %$slot }; |
854 | } |
855 | } |
856 | |
e3be2b6f |
857 | |
858 | # |
859 | # Why not just use some higher-level module or at least File::Spec here? |
860 | # Because: |
861 | # 1) This is a *very* rarely used function, and the deptree is large |
862 | # enough already as it is |
863 | # |
864 | # 2) (more importantly) Our tooling is utter shit in this area. There |
865 | # is no comprehensive support for UNC paths in PathTools and there |
866 | # are also various small bugs in representation across different |
867 | # path-manipulation CPAN offerings. |
868 | # |
869 | # Since this routine is strictly used for logical path processing (it |
870 | # *must* be able to work with not-yet-existing paths), use this seemingly |
871 | # simple but I *think* complete implementation to feed to other consumers |
872 | # |
873 | # If bugs are ever uncovered in this routine, *YOU ARE URGED TO RESIST* |
874 | # the impulse to bring in an external dependency. During runtime there |
875 | # is exactly one spot that could potentially maybe once in a blue moon |
876 | # use this function. Keep it lean. |
877 | # |
878 | sub parent_dir ($) { |
879 | ( $_[0] =~ m{ [\/\\] ( \.{0,2} ) ( [\/\\]* ) \z }x ) |
880 | ? ( |
881 | $_[0] |
882 | . |
883 | ( ( length($1) and ! length($2) ) ? '/' : '' ) |
884 | . |
885 | '../' |
886 | ) |
887 | : ( |
888 | require File::Spec |
889 | and |
890 | File::Spec->catpath ( |
891 | ( File::Spec->splitpath( "$_[0]" ) )[0,1], |
892 | '/', |
893 | ) |
894 | ) |
895 | ; |
896 | } |
897 | |
439a7283 |
898 | sub mkdir_p ($) { |
899 | require File::Path; |
900 | # do not ask for a recent version, use 1.x API calls |
901 | File::Path::mkpath([ "$_[0]" ]); # File::Path does not like objects |
902 | } |
903 | |
e3be2b6f |
904 | |
a9da9b6a |
905 | { |
906 | my $list_ctx_ok_stack_marker; |
907 | |
e89c7968 |
908 | sub fail_on_internal_wantarray () { |
a9da9b6a |
909 | return if $list_ctx_ok_stack_marker; |
910 | |
911 | if (! defined wantarray) { |
912 | croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard'); |
913 | } |
914 | |
915 | my $cf = 1; |
821edc09 |
916 | while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?: |
a9da9b6a |
917 | |
918 | # these are public API parts that alter behavior on wantarray |
919 | search | search_related | slice | search_literal |
920 | |
921 | | |
922 | |
923 | # these are explicitly prefixed, since we only recognize them as valid |
924 | # escapes when they come from the guts of CDBICompat |
925 | CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all ) |
926 | |
927 | ) $/x ) { |
928 | $cf++; |
929 | } |
930 | |
e89c7968 |
931 | my ($fr, $want, $argdesc); |
932 | { |
933 | package DB; |
821edc09 |
934 | $fr = [ CORE::caller($cf) ]; |
935 | $want = ( CORE::caller($cf-1) )[5]; |
e89c7968 |
936 | $argdesc = ref $DB::args[0] |
937 | ? DBIx::Class::_Util::refdesc($DB::args[0]) |
938 | : 'non ' |
939 | ; |
940 | }; |
941 | |
a9da9b6a |
942 | if ( |
e89c7968 |
943 | $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/ |
a9da9b6a |
944 | ) { |
a9da9b6a |
945 | DBIx::Class::Exception->throw( sprintf ( |
e89c7968 |
946 | "Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts", |
947 | $argdesc, @{$fr}[1,2] |
a9da9b6a |
948 | ), 'with_stacktrace'); |
949 | } |
950 | |
d098704f |
951 | weaken( $list_ctx_ok_stack_marker = my $mark = [] ); |
952 | |
a9da9b6a |
953 | $mark; |
954 | } |
955 | } |
956 | |
77c3a5dc |
957 | sub fail_on_internal_call { |
958 | my ($fr, $argdesc); |
959 | { |
960 | package DB; |
821edc09 |
961 | $fr = [ CORE::caller(1) ]; |
77c3a5dc |
962 | $argdesc = ref $DB::args[0] |
963 | ? DBIx::Class::_Util::refdesc($DB::args[0]) |
e5053694 |
964 | : ( $DB::args[0] . '' ) |
77c3a5dc |
965 | ; |
966 | }; |
967 | |
3b020224 |
968 | my @fr2; |
969 | # need to make allowance for a proxy-yet-direct call |
970 | my $check_fr = ( |
971 | $fr->[0] eq 'DBIx::Class::ResultSourceProxy' |
972 | and |
973 | @fr2 = (CORE::caller(2)) |
974 | and |
975 | ( |
976 | ( $fr->[3] =~ /([^:])+$/ )[0] |
977 | eq |
978 | ( $fr2[3] =~ /([^:])+$/ )[0] |
979 | ) |
980 | ) |
981 | ? \@fr2 |
982 | : $fr |
983 | ; |
984 | |
77c3a5dc |
985 | if ( |
986 | $argdesc |
987 | and |
3b020224 |
988 | $check_fr->[0] =~ /^(?:DBIx::Class|DBICx::)/ |
77c3a5dc |
989 | and |
3b020224 |
990 | $check_fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/ # no point touching there |
77c3a5dc |
991 | ) { |
992 | DBIx::Class::Exception->throw( sprintf ( |
e5053694 |
993 | "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", |
77c3a5dc |
994 | $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do { |
995 | require B::Deparse; |
996 | no strict 'refs'; |
997 | B::Deparse->new->coderef2text(\&{$fr->[3]}) |
998 | }), |
999 | ), 'with_stacktrace'); |
1000 | } |
1001 | } |
1002 | |
b1dbf716 |
1003 | 1; |