[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / _Util.pm

package # hide from PAUSE
  DBIx::Class::_Util;

use warnings;
use strict;

use constant SPURIOUS_VERSION_CHECK_WARNINGS => ( "$]" < 5.010 ? 1 : 0);

BEGIN {
  package # hide from pause
    DBIx::Class::_ENV_;

  use Config;

  use constant {

    # but of course
    BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0,

    BROKEN_GOTO => ( "$]" < 5.008003 ) ? 1 : 0,

    HAS_ITHREADS => $Config{useithreads} ? 1 : 0,

    UNSTABLE_DOLLARAT => ( "$]" < 5.013002 ) ? 1 : 0,

    DBICTEST => $INC{"DBICTest/Util.pm"} ? 1 : 0,

    # During 5.13 dev cycle HELEMs started to leak on copy
    # add an escape for these perls ON SMOKERS - a user will still get death
    PEEPEENESS => ( eval { DBICTest::RunMode->is_smoker } && ( "$]" >= 5.013005 and "$]" <= 5.013006) ),

    SHUFFLE_UNORDERED_RESULTSETS => $ENV{DBIC_SHUFFLE_UNORDERED_RESULTSETS} ? 1 : 0,

    ASSERT_NO_INTERNAL_WANTARRAY => $ENV{DBIC_ASSERT_NO_INTERNAL_WANTARRAY} ? 1 : 0,

    ASSERT_NO_INTERNAL_INDIRECT_CALLS => $ENV{DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS} ? 1 : 0,

    STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE => $ENV{DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE} ? 1 : 0,

    STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE => $ENV{DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE} ? 1 : 0,

    IV_SIZE => $Config{ivsize},

    OS_NAME => $^O,
  };

  if ( "$]" < 5.009_005) {
    require MRO::Compat;
    constant->import( OLD_MRO => 1 );
  }
  else {
    require mro;
    constant->import( OLD_MRO => 0 );
  }
}

# FIXME - this is not supposed to be here
# Carp::Skip to the rescue soon
use DBIx::Class::Carp '^DBIx::Class|^DBICTest';

use B ();
use Carp 'croak';
use Storable 'nfreeze';
use Scalar::Util qw(weaken blessed reftype refaddr);
use List::Util qw(first);
use Sub::Quote qw(qsub quote_sub);

# Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
BEGIN { *deep_clone = \&Storable::dclone }

use base 'Exporter';
our @EXPORT_OK = qw(
  sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
  fail_on_internal_wantarray fail_on_internal_call
  refdesc refcount hrefaddr
  scope_guard is_exception detected_reinvoked_destructor
  quote_sub qsub perlstring serialize deep_clone
  UNRESOLVABLE_CONDITION
);

use constant UNRESOLVABLE_CONDITION => \ '1 = 0';

sub sigwarn_silencer ($) {
  my $pattern = shift;

  croak "Expecting a regexp" if ref $pattern ne 'Regexp';

  my $orig_sig_warn = $SIG{__WARN__} || sub { CORE::warn(@_) };

  return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
}

sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };

sub hrefaddr ($) { sprintf '0x%x', &refaddr||0 }

sub refdesc ($) {
  croak "Expecting a reference" if ! length ref $_[0];

  # be careful not to trigger stringification,
  # reuse @_ as a scratch-pad
  sprintf '%s%s(0x%x)',
    ( defined( $_[1] = blessed $_[0]) ? "$_[1]=" : '' ),
    reftype $_[0],
    refaddr($_[0]),
  ;
}

sub refcount ($) {
  croak "Expecting a reference" if ! length ref $_[0];

  # No tempvars - must operate on $_[0], otherwise the pad
  # will count as an extra ref
  B::svref_2object($_[0])->REFCNT;
}

sub serialize ($) {
  local $Storable::canonical = 1;
  nfreeze($_[0]);
}

sub scope_guard (&) {
  croak 'Calling scope_guard() in void context makes no sense'
    if ! defined wantarray;

  # no direct blessing of coderefs - DESTROY is buggy on those
  bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
}
{
  package #
    DBIx::Class::_Util::ScopeGuard;

  sub DESTROY {
    &DBIx::Class::_Util::detected_reinvoked_destructor;

    local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;

    eval {
      $_[0]->[0]->();
      1;
    } or do {
      Carp::cluck "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@";
    };
  }
}


sub is_exception ($) {
  my $e = $_[0];

  # FIXME
  # this is not strictly correct - an eval setting $@ to undef
  # is *not* the same as an eval setting $@ to ''
  # but for the sake of simplicity assume the following for
  # the time being
  return 0 unless defined $e;

  my ($not_blank, $suberror);
  {
    local $@;
    eval {
      # The ne() here is deliberate - a plain length($e), or worse "$e" ne
      # will entirely obviate the need for the encolsing eval{}, as the
      # condition we guard against is a missing fallback overload
      $not_blank = ( $e ne '' );
      1;
    } or $suberror = $@;
  }

  if (defined $suberror) {
    if (length (my $class = blessed($e) )) {
      carp_unique( sprintf(
        'External exception class %s implements partial (broken) overloading '
      . 'preventing its instances from being used in simple ($x eq $y) '
      . 'comparisons. Given Perl\'s "globally cooperative" exception '
      . 'handling this type of brokenness is extremely dangerous on '
      . 'exception objects, as it may (and often does) result in silent '
      . '"exception substitution". DBIx::Class tries to work around this '
      . 'as much as possible, but other parts of your software stack may '
      . 'not be even aware of this. Please submit a bugreport against the '
      . 'distribution containing %s and in the meantime apply a fix similar '
      . 'to the one shown at %s, in order to ensure your exception handling '
      . 'is saner application-wide. What follows is the actual error text '
      . "as generated by Perl itself:\n\n%s\n ",
        $class,
        $class,
        'http://v.gd/DBIC_overload_tempfix/',
        $suberror,
      ));

      # workaround, keeps spice flowing
      $not_blank = !!( length $e );
    }
    else {
      # not blessed yet failed the 'ne'... this makes 0 sense...
      # just throw further
      die $suberror
    }
  }
  elsif (
    # a ref evaluating to '' is definitively a "null object"
    ( not $not_blank )
      and
    length( my $class = ref $e )
  ) {
    carp_unique( sprintf(
      "Objects of external exception class '%s' stringify to '' (the "
    . 'empty string), implementing the so called null-object-pattern. '
    . 'Given Perl\'s "globally cooperative" exception handling using this '
    . 'class of exceptions is extremely dangerous, as it may (and often '
    . 'does) result in silent discarding of errors. DBIx::Class tries to '
    . 'work around this as much as possible, but other parts of your '
    . 'software stack may not be even aware of the problem. Please submit '
    . 'a bugreport against the distribution containing %s',

      ($class) x 2,
    ));

    $not_blank = 1;
  }

  return $not_blank;
}

{
  my $destruction_registry = {};

  sub CLONE {
    $destruction_registry = { map
      { defined $_ ? ( refaddr($_) => $_ ) : () }
      values %$destruction_registry
    };
  }

  # This is almost invariably invoked from within DESTROY
  # throwing exceptions won't work
  sub detected_reinvoked_destructor {

    # quick "garbage collection" pass - prevents the registry
    # from slowly growing with a bunch of undef-valued keys
    defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
      for keys %$destruction_registry;

    if (! length ref $_[0]) {
      printf STDERR '%s() expects a blessed reference %s',
        (caller(0))[3],
        Carp::longmess,
      ;
      return undef; # don't know wtf to do
    }
    elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
      weaken( $destruction_registry->{$addr} = $_[0] );
      return 0;
    }
    else {
      carp_unique ( sprintf (
        'Preventing *MULTIPLE* DESTROY() invocations on %s - an *EXTREMELY '
      . 'DANGEROUS* condition which is *ALMOST CERTAINLY GLOBAL* within your '
      . 'application, affecting *ALL* classes without active protection against '
      . 'this. Diagnose and fix the root cause ASAP!!!%s',
      refdesc $_[0],
        ( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
          ? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
          : ''
        )
      ));

      return 1;
    }
  }
}

my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
my $ver_rx =         qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )*        \z /x;

sub modver_gt_or_eq ($$) {
  my ($mod, $ver) = @_;

  croak "Nonsensical module name supplied"
    if ! defined $mod or $mod !~ $module_name_rx;

  croak "Nonsensical minimum version supplied"
    if ! defined $ver or $ver !~ $ver_rx;

  no strict 'refs';
  my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} ||= ( $mod->VERSION
    ? {}
    : croak "$mod does not seem to provide a version (perhaps it never loaded)"
  );

  ! defined $ver_cache->{$ver}
    and
  $ver_cache->{$ver} = do {

    local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
      if SPURIOUS_VERSION_CHECK_WARNINGS;

    local $@;
    local $SIG{__DIE__};
    eval { $mod->VERSION($ver) } ? 1 : 0;
  };

  $ver_cache->{$ver};
}

sub modver_gt_or_eq_and_lt ($$$) {
  my ($mod, $v_ge, $v_lt) = @_;

  croak "Nonsensical maximum version supplied"
    if ! defined $v_lt or $v_lt !~ $ver_rx;

  return (
    modver_gt_or_eq($mod, $v_ge)
      and
    ! modver_gt_or_eq($mod, $v_lt)
  ) ? 1 : 0;
}

{
  my $list_ctx_ok_stack_marker;

  sub fail_on_internal_wantarray () {
    return if $list_ctx_ok_stack_marker;

    if (! defined wantarray) {
      croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
    }

    my $cf = 1;
    while ( ( (CORE::caller($cf+1))[3] || '' ) =~ / :: (?:

      # these are public API parts that alter behavior on wantarray
      search | search_related | slice | search_literal

        |

      # these are explicitly prefixed, since we only recognize them as valid
      # escapes when they come from the guts of CDBICompat
      CDBICompat .*? :: (?: search_where | retrieve_from_sql | retrieve_all )

    ) $/x ) {
      $cf++;
    }

    my ($fr, $want, $argdesc);
    {
      package DB;
      $fr = [ CORE::caller($cf) ];
      $want = ( CORE::caller($cf-1) )[5];
      $argdesc = ref $DB::args[0]
        ? DBIx::Class::_Util::refdesc($DB::args[0])
        : 'non '
      ;
    };

    if (
      $want and $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
    ) {
      DBIx::Class::Exception->throw( sprintf (
        "Improper use of %s instance in list context at %s line %d\n\n    Stacktrace starts",
        $argdesc, @{$fr}[1,2]
      ), 'with_stacktrace');
    }

    my $mark = [];
    weaken ( $list_ctx_ok_stack_marker = $mark );
    $mark;
  }
}

sub fail_on_internal_call {
  my ($fr, $argdesc);
  {
    package DB;
    $fr = [ CORE::caller(1) ];
    $argdesc = ref $DB::args[0]
      ? DBIx::Class::_Util::refdesc($DB::args[0])
      : undef
    ;
  };

  if (
    $argdesc
      and
    $fr->[0] =~ /^(?:DBIx::Class|DBICx::)/
      and
    $fr->[1] !~ /\b(?:CDBICompat|ResultSetProxy)\b/  # no point touching there
  ) {
    DBIx::Class::Exception->throw( sprintf (
      "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",
      $fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] || do {
        require B::Deparse;
        no strict 'refs';
        B::Deparse->new->coderef2text(\&{$fr->[3]})
      }),
    ), 'with_stacktrace');
  }
}

1;
Commit	Line	Data
b1dbf716	1	package # hide from PAUSE
	2	DBIx::Class::_Util;
	3
	4	use warnings;
	5	use strict;
	6
750a4ad2	7	use constant SPURIOUS_VERSION_CHECK_WARNINGS => ( "$]" < 5.010 ? 1 : 0);
b1dbf716	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
750a4ad2	20	BROKEN_GOTO => ( "$]" < 5.008003 ) ? 1 : 0,
8d73fcd4	21
37873f78	22	HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
37873f78	23
bbf6a9a5	24	UNSTABLE_DOLLARAT => ( "$]" < 5.013002 ) ? 1 : 0,
bbf6a9a5	25
69016f65	26	DBICTEST => $INC{"DBICTest/Util.pm"} ? 1 : 0,
37873f78	27
37873f78	28	# During 5.13 dev cycle HELEMs started to leak on copy
6cfb1d2f	29	# add an escape for these perls ON SMOKERS - a user will still get death
750a4ad2	30	PEEPEENESS => ( eval { DBICTest::RunMode->is_smoker } && ( "$]" >= 5.013005 and "$]" <= 5.013006) ),
37873f78	31
1b658919	32	SHUFFLE_UNORDERED_RESULTSETS => $ENV{DBIC_SHUFFLE_UNORDERED_RESULTSETS} ? 1 : 0,
1b658919	33
37873f78	34	ASSERT_NO_INTERNAL_WANTARRAY => $ENV{DBIC_ASSERT_NO_INTERNAL_WANTARRAY} ? 1 : 0,
37873f78	35
77c3a5dc	36	ASSERT_NO_INTERNAL_INDIRECT_CALLS => $ENV{DBIC_ASSERT_NO_INTERNAL_INDIRECT_CALLS} ? 1 : 0,
77c3a5dc	37
2fdeef65	38	STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE => $ENV{DBIC_STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE} ? 1 : 0,
2fdeef65	39
f45dc928	40	STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE => $ENV{DBIC_STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE} ? 1 : 0,
f45dc928	41
37873f78	42	IV_SIZE => $Config{ivsize},
00882d2c	43
00882d2c	44	OS_NAME => $^O,
37873f78	45	};
37873f78	46
750a4ad2	47	if ( "$]" < 5.009_005) {
37873f78	48	require MRO::Compat;
	49	constant->import( OLD_MRO => 1 );
	50	}
	51	else {
	52	require mro;
	53	constant->import( OLD_MRO => 0 );
	54	}
	55	}
	56
841efcb3	57	# FIXME - this is not supposed to be here
	58	# Carp::Skip to the rescue soon
	59	use DBIx::Class::Carp '^DBIx::Class\|^DBICTest';
	60
d7d45bdc	61	use B ();
841efcb3	62	use Carp 'croak';
d7d45bdc	63	use Storable 'nfreeze';
3d56e026	64	use Scalar::Util qw(weaken blessed reftype refaddr);
3705e3b2	65	use List::Util qw(first);
0020e364	66	use Sub::Quote qw(qsub quote_sub);
7f9a3f70	67
1c30a2e4	68	# Already correctly prototyped: perlbrew exec perl -MStorable -e 'warn prototype \&Storable::dclone'
	69	BEGIN { *deep_clone = \&Storable::dclone }
	70
b1dbf716	71	use base 'Exporter';
3705e3b2	72	our @EXPORT_OK = qw(
d634850b	73	sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt
77c3a5dc	74	fail_on_internal_wantarray fail_on_internal_call
bbf6a9a5	75	refdesc refcount hrefaddr
bbf6a9a5	76	scope_guard is_exception detected_reinvoked_destructor
1c30a2e4	77	quote_sub qsub perlstring serialize deep_clone
facd0e8e	78	UNRESOLVABLE_CONDITION
3705e3b2	79	);
052a832c	80
facd0e8e	81	use constant UNRESOLVABLE_CONDITION => \ '1 = 0';
facd0e8e	82
bf302897	83	sub sigwarn_silencer ($) {
052a832c	84	my $pattern = shift;
	85
	86	croak "Expecting a regexp" if ref $pattern ne 'Regexp';
	87
	88	my $orig_sig_warn = $SIG{__WARN__} \|\| sub { CORE::warn(@_) };
	89
	90	return sub { &$orig_sig_warn unless $_[0] =~ $pattern };
	91	}
b1dbf716	92
01b25f12	93	sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
01b25f12	94
3d56e026	95	sub hrefaddr ($) { sprintf '0x%x', &refaddr\|\|0 }
8433421f	96
	97	sub refdesc ($) {
	98	croak "Expecting a reference" if ! length ref $_[0];
	99
	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]=" : '' ),
	104	reftype $_[0],
3d56e026	105	refaddr($_[0]),
8433421f	106	;
8433421f	107	}
bf302897	108
bf302897	109	sub refcount ($) {
dac7972a	110	croak "Expecting a reference" if ! length ref $_[0];
dac7972a	111
dac7972a	112	# No tempvars - must operate on $_[0], otherwise the pad
	113	# will count as an extra ref
	114	B::svref_2object($_[0])->REFCNT;
	115	}
	116
b34d9331	117	sub serialize ($) {
b34d9331	118	local $Storable::canonical = 1;
d7d45bdc	119	nfreeze($_[0]);
b34d9331	120	}
b34d9331	121
bbf6a9a5	122	sub scope_guard (&) {
	123	croak 'Calling scope_guard() in void context makes no sense'
	124	if ! defined wantarray;
	125
	126	# no direct blessing of coderefs - DESTROY is buggy on those
	127	bless [ $_[0] ], 'DBIx::Class::_Util::ScopeGuard';
	128	}
	129	{
	130	package #
	131	DBIx::Class::_Util::ScopeGuard;
	132
	133	sub DESTROY {
	134	&DBIx::Class::_Util::detected_reinvoked_destructor;
	135
	136	local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
	137
	138	eval {
	139	$_[0]->[0]->();
	140	1;
	141	} or do {
	142	Carp::cluck "Execution of scope guard $_[0] resulted in the non-trappable exception:\n\n$@";
	143	};
	144	}
	145	}
	146
	147
841efcb3	148	sub is_exception ($) {
	149	my $e = $_[0];
	150
35cf7d1a	151	# FIXME
a0414138	152	# this is not strictly correct - an eval setting $@ to undef
	153	# is not the same as an eval setting $@ to ''
	154	# but for the sake of simplicity assume the following for
	155	# the time being
	156	return 0 unless defined $e;
	157
841efcb3	158	my ($not_blank, $suberror);
	159	{
	160	local $@;
	161	eval {
d52c4a75	162	# The ne() here is deliberate - a plain length($e), or worse "$e" ne
	163	# will entirely obviate the need for the encolsing eval{}, as the
	164	# condition we guard against is a missing fallback overload
	165	$not_blank = ( $e ne '' );
841efcb3	166	1;
	167	} or $suberror = $@;
	168	}
	169
	170	if (defined $suberror) {
	171	if (length (my $class = blessed($e) )) {
	172	carp_unique( sprintf(
9bea2000	173	'External exception class %s implements partial (broken) overloading '
9bea2000	174	. 'preventing its instances from being used in simple ($x eq $y) '
841efcb3	175	. 'comparisons. Given Perl\'s "globally cooperative" exception '
	176	. 'handling this type of brokenness is extremely dangerous on '
	177	. 'exception objects, as it may (and often does) result in silent '
	178	. '"exception substitution". DBIx::Class tries to work around this '
	179	. 'as much as possible, but other parts of your software stack may '
	180	. 'not be even aware of this. Please submit a bugreport against the '
	181	. 'distribution containing %s and in the meantime apply a fix similar '
	182	. 'to the one shown at %s, in order to ensure your exception handling '
	183	. 'is saner application-wide. What follows is the actual error text '
	184	. "as generated by Perl itself:\n\n%s\n ",
9bea2000	185	$class,
841efcb3	186	$class,
	187	'http://v.gd/DBIC_overload_tempfix/',
	188	$suberror,
	189	));
	190
	191	# workaround, keeps spice flowing
d52c4a75	192	$not_blank = !!( length $e );
841efcb3	193	}
	194	else {
	195	# not blessed yet failed the 'ne'... this makes 0 sense...
	196	# just throw further
	197	die $suberror
	198	}
	199	}
84e4e006	200	elsif (
	201	# a ref evaluating to '' is definitively a "null object"
	202	( not $not_blank )
	203	and
	204	length( my $class = ref $e )
	205	) {
	206	carp_unique( sprintf(
	207	"Objects of external exception class '%s' stringify to '' (the "
	208	. 'empty string), implementing the so called null-object-pattern. '
	209	. 'Given Perl\'s "globally cooperative" exception handling using this '
	210	. 'class of exceptions is extremely dangerous, as it may (and often '
	211	. 'does) result in silent discarding of errors. DBIx::Class tries to '
	212	. 'work around this as much as possible, but other parts of your '
	213	. 'software stack may not be even aware of the problem. Please submit '
35cf7d1a	214	. 'a bugreport against the distribution containing %s',
84e4e006	215
	216	($class) x 2,
	217	));
	218
	219	$not_blank = 1;
	220	}
841efcb3	221
	222	return $not_blank;
	223	}
	224
3d56e026	225	{
	226	my $destruction_registry = {};
	227
	228	sub CLONE {
	229	$destruction_registry = { map
	230	{ defined $_ ? ( refaddr($_) => $_ ) : () }
	231	values %$destruction_registry
	232	};
	233	}
	234
	235	# This is almost invariably invoked from within DESTROY
	236	# throwing exceptions won't work
e1d9e578	237	sub detected_reinvoked_destructor {
3d56e026	238
	239	# quick "garbage collection" pass - prevents the registry
	240	# from slowly growing with a bunch of undef-valued keys
	241	defined $destruction_registry->{$_} or delete $destruction_registry->{$_}
	242	for keys %$destruction_registry;
	243
e1d9e578	244	if (! length ref $_[0]) {
e1d9e578	245	printf STDERR '%s() expects a blessed reference %s',
3d56e026	246	(caller(0))[3],
	247	Carp::longmess,
	248	;
	249	return undef; # don't know wtf to do
	250	}
e1d9e578	251	elsif (! defined $destruction_registry->{ my $addr = refaddr($_[0]) } ) {
3d56e026	252	weaken( $destruction_registry->{$addr} = $_[0] );
	253	return 0;
	254	}
	255	else {
	256	carp_unique ( sprintf (
	257	'Preventing MULTIPLE DESTROY() invocations on %s - an *EXTREMELY '
	258	. 'DANGEROUS* condition which is ALMOST CERTAINLY GLOBAL within your '
	259	. 'application, affecting ALL classes without active protection against '
	260	. 'this. Diagnose and fix the root cause ASAP!!!%s',
	261	refdesc $_[0],
	262	( ( $INC{'Devel/StackTrace.pm'} and ! do { local $@; eval { Devel::StackTrace->VERSION(2) } } )
	263	? " (likely culprit Devel::StackTrace\@@{[ Devel::StackTrace->VERSION ]} found in %INC, http://is.gd/D_ST_refcap)"
	264	: ''
	265	)
	266	));
	267
	268	return 1;
	269	}
	270	}
	271	}
	272
7302b3e0	273	my $module_name_rx = qr/ \A [A-Z_a-z] [0-9A-Z_a-z]* (?: :: [0-9A-Z_a-z]+ )* \z /x;
	274	my $ver_rx = qr/ \A [0-9]+ (?: \. [0-9]+ )* (?: \_ [0-9]+ )* \z /x;
	275
bf302897	276	sub modver_gt_or_eq ($$) {
b1dbf716	277	my ($mod, $ver) = @_;
	278
	279	croak "Nonsensical module name supplied"
7302b3e0	280	if ! defined $mod or $mod !~ $module_name_rx;
b1dbf716	281
b1dbf716	282	croak "Nonsensical minimum version supplied"
7302b3e0	283	if ! defined $ver or $ver !~ $ver_rx;
	284
	285	no strict 'refs';
	286	my $ver_cache = ${"${mod}::__DBIC_MODULE_VERSION_CHECKS__"} \|\|= ( $mod->VERSION
	287	? {}
	288	: croak "$mod does not seem to provide a version (perhaps it never loaded)"
	289	);
	290
	291	! defined $ver_cache->{$ver}
	292	and
	293	$ver_cache->{$ver} = do {
b1dbf716	294
7302b3e0	295	local $SIG{__WARN__} = sigwarn_silencer( qr/\Qisn't numeric in subroutine entry/ )
7302b3e0	296	if SPURIOUS_VERSION_CHECK_WARNINGS;
b1dbf716	297
7302b3e0	298	local $@;
	299	local $SIG{__DIE__};
	300	eval { $mod->VERSION($ver) } ? 1 : 0;
	301	};
56270bba	302
7302b3e0	303	$ver_cache->{$ver};
b1dbf716	304	}
b1dbf716	305
d634850b	306	sub modver_gt_or_eq_and_lt ($$$) {
	307	my ($mod, $v_ge, $v_lt) = @_;
	308
	309	croak "Nonsensical maximum version supplied"
7302b3e0	310	if ! defined $v_lt or $v_lt !~ $ver_rx;
d634850b	311
	312	return (
	313	modver_gt_or_eq($mod, $v_ge)
	314	and
	315	! modver_gt_or_eq($mod, $v_lt)
	316	) ? 1 : 0;
	317	}
	318
a9da9b6a	319	{
	320	my $list_ctx_ok_stack_marker;
	321
e89c7968	322	sub fail_on_internal_wantarray () {
a9da9b6a	323	return if $list_ctx_ok_stack_marker;
	324
	325	if (! defined wantarray) {
	326	croak('fail_on_internal_wantarray() needs a tempvar to save the stack marker guard');
	327	}
	328
	329	my $cf = 1;
821edc09	330	while ( ( (CORE::caller($cf+1))[3] \|\| '' ) =~ / :: (?:
a9da9b6a	331
	332	# these are public API parts that alter behavior on wantarray
	333	search \| search_related \| slice \| search_literal
	334
	335	\|
	336
	337	# these are explicitly prefixed, since we only recognize them as valid
	338	# escapes when they come from the guts of CDBICompat
	339	CDBICompat .*? :: (?: search_where \| retrieve_from_sql \| retrieve_all )
	340
	341	) $/x ) {
	342	$cf++;
	343	}
	344
e89c7968	345	my ($fr, $want, $argdesc);
	346	{
	347	package DB;
821edc09	348	$fr = [ CORE::caller($cf) ];
821edc09	349	$want = ( CORE::caller($cf-1) )[5];
e89c7968	350	$argdesc = ref $DB::args[0]
	351	? DBIx::Class::_Util::refdesc($DB::args[0])
	352	: 'non '
	353	;
	354	};
	355
a9da9b6a	356	if (
e89c7968	357	$want and $fr->[0] =~ /^(?:DBIx::Class\|DBICx::)/
a9da9b6a	358	) {
a9da9b6a	359	DBIx::Class::Exception->throw( sprintf (
e89c7968	360	"Improper use of %s instance in list context at %s line %d\n\n Stacktrace starts",
e89c7968	361	$argdesc, @{$fr}[1,2]
a9da9b6a	362	), 'with_stacktrace');
	363	}
	364
	365	my $mark = [];
	366	weaken ( $list_ctx_ok_stack_marker = $mark );
	367	$mark;
	368	}
	369	}
	370
77c3a5dc	371	sub fail_on_internal_call {
	372	my ($fr, $argdesc);
	373	{
	374	package DB;
821edc09	375	$fr = [ CORE::caller(1) ];
77c3a5dc	376	$argdesc = ref $DB::args[0]
	377	? DBIx::Class::_Util::refdesc($DB::args[0])
	378	: undef
	379	;
	380	};
	381
	382	if (
	383	$argdesc
	384	and
	385	$fr->[0] =~ /^(?:DBIx::Class\|DBICx::)/
	386	and
	387	$fr->[1] !~ /\b(?:CDBICompat\|ResultSetProxy)\b/ # no point touching there
	388	) {
	389	DBIx::Class::Exception->throw( sprintf (
	390	"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",
	391	$fr->[3], $argdesc, @{$fr}[1,2], ( $fr->[6] \|\| do {
	392	require B::Deparse;
	393	no strict 'refs';
	394	B::Deparse->new->coderef2text(\&{$fr->[3]})
	395	}),
	396	), 'with_stacktrace');
	397	}
	398	}
	399
b1dbf716	400	1;