1 package DBIx::Class::MethodAttributes;
6 use DBIx::Class::_Util qw( uniq refdesc visit_namespaces );
7 use Scalar::Util qw( weaken refaddr );
11 my ( $attr_cref_registry, $attr_cache_active );
12 sub DBIx::Class::__Attr_iThreads_handler__::CLONE {
14 # This is disgusting, but the best we can do without even more surgery
15 # Note the if() at the end - we do not run this crap if we can help it
16 visit_namespaces( action => sub {
19 # skip dangerous namespaces
20 return 1 if $pkg =~ /^ (?:
21 DB | next | B | .+? ::::ISA (?: ::CACHE ) | Class::C3
27 exists ${"${pkg}::"}{__cag___attr_cache}
29 ref( my $attr_stash = ${"${pkg}::__cag___attr_cache"} ) eq 'HASH'
31 $attr_stash->{ $attr_cref_registry->{$_}{weakref} } = delete $attr_stash->{$_}
32 for keys %$attr_stash;
36 }) if $attr_cache_active;
38 # renumber the cref registry itself
39 %$attr_cref_registry = map {
40 ( defined $_->{weakref} )
42 # because of how __attr_cache works, ugh
43 "$_->{weakref}" => $_,
46 } values %$attr_cref_registry;
49 sub MODIFY_CODE_ATTRIBUTES {
55 $_ =~ /^[a-z]+$/ ? 'builtin'
56 : $_ =~ /^DBIC_/ ? 'dbic'
62 defined $attr_cref_registry->{$_}{weakref} or delete $attr_cref_registry->{$_}
63 for keys %$attr_cref_registry;
65 # The original misc-attr API used stringification instead of refaddr - can't change that now
66 if( $attr_cref_registry->{$code} ) {
67 Carp::confess( sprintf
68 "Coderefs '%s' and '%s' stringify to the same value '%s': nothing will work",
70 refdesc($attr_cref_registry->{$code}{weakref}),
72 ) if refaddr($attr_cref_registry->{$code}{weakref}) != refaddr($code);
75 weaken( $attr_cref_registry->{$code}{weakref} = $code )
79 # increment the pkg gen, this ensures the sanity checkers will re-evaluate
80 # this class when/if the time comes
81 mro::method_changed_in($class) if (
82 ! DBIx::Class::_ENV_::OLD_MRO
84 ( $attrs->{dbic} or $attrs->{misc} )
89 if( $attrs->{misc} ) {
91 # if the user never tickles this - we won't have to do a gross
92 # symtable scan in the ithread handler above, so:
94 # User - please don't tickle this
95 $attr_cache_active = 1;
97 $class->mk_classaccessor('__attr_cache' => {})
98 unless $class->can('__attr_cache');
100 $class->__attr_cache->{$code} = [ sort( uniq(
101 @{ $class->__attr_cache->{$code} || [] },
102 keys %{ $attrs->{misc} },
107 # handle DBIC_* attrs
108 if( $attrs->{dbic} ) {
109 my $slot = $attr_cref_registry->{$code};
111 $slot->{attrs} = [ uniq
112 @{ $slot->{attrs} || [] },
114 $class->VALID_DBIC_CODE_ATTRIBUTE($_)
116 Carp::confess( "DBIC-specific attribute '$_' did not pass validation by $class->VALID_DBIC_CODE_ATTRIBUTE() as described in DBIx::Class::MethodAttributes" )
117 } keys %{$attrs->{dbic}},
122 # FIXME - DBIC essentially gobbles up any attribute it can lay its hands on:
125 # There should be some sort of warning on unrecognized attributes or
126 # somesuch... OTOH people do use things in the wild hence the plan of action
127 # is anything but clear :/
129 # https://metacpan.org/source/ZIGOROU/DBIx-Class-Service-0.02/lib/DBIx/Class/Service.pm#L93-110
130 # https://metacpan.org/source/ZIGOROU/DBIx-Class-Service-0.02/t/lib/DBIC/Test/Service/User.pm#L29
131 # https://metacpan.org/source/ZIGOROU/DBIx-Class-Service-0.02/t/lib/DBIC/Test/Service/User.pm#L36
133 # For the time being reuse the old logic for any attribute we do not have
134 # explicit plans for (i.e. stuff that is neither reserved, nor DBIC-internal)
136 # Pass the "builtin attrs" onwards, as the DBIC internals can't possibly handle them
137 return sort keys %{ $attrs->{builtin} || {} };
140 # Address the above FIXME halfway - if something (e.g. DBIC::Helpers) wants to
141 # add extra attributes - it needs to override this in its base class to allow
142 # for 'return 1' on the newly defined attributes
143 sub VALID_DBIC_CODE_ATTRIBUTE {
144 #my ($class, $attr) = @_;
146 # initially no valid attributes
150 sub FETCH_CODE_ATTRIBUTES {
151 #my ($class,$code) = @_;
154 @{ $_[0]->_attr_cache->{$_[1]} || [] },
155 ( defined( $attr_cref_registry->{$_[1]}{ weakref } )
156 ? @{ $attr_cref_registry->{$_[1]}{attrs} || [] }
165 %{ $self->can('__attr_cache') ? $self->__attr_cache : {} },
166 %{ $self->maybe::next::method || {} },
176 DBIx::Class::MethodAttributes - DBIC-specific handling of CODE attributes
180 my @attrlist = attributes::get( \&My::App::Schema::Result::some_method )
184 This class provides the L<DBIx::Class> inheritance chain with the bits
185 necessary for L<attribute|attributes> support on methods.
187 Historically DBIC has accepted any string as a C<CODE> attribute and made
188 such strings available via the semi-private L</_attr_cache> method. This
189 was used for e.g. the long-deprecated L<DBIx::Class::ResultSetManager>,
190 but also has evidence of use on both C<CPAN> and C<DarkPAN>.
192 Starting mid-2016 DBIC treats any method attribute starting with C<DBIC_>
193 as an I<internal boolean decorator> for various DBIC-related methods.
194 Unlike the general attribute naming policy, strict whitelisting is imposed
195 on attribute names starting with C<DBIC_> as described in
196 L</VALID_DBIC_CODE_ATTRIBUTE> below.
198 =head2 DBIC-specific method attributes
200 The following method attributes are currently recognized under the C<DBIC_*>
211 =head2 MODIFY_CODE_ATTRIBUTES
213 See L<attributes/MODIFY_type_ATTRIBUTES>.
215 =head2 FETCH_CODE_ATTRIBUTES
217 See L<attributes/FETCH_type_ATTRIBUTES>. Always returns the combination of
218 all attributes: both the free-form strings registered via the
219 L<legacy system|/_attr_cache> and the DBIC-specific ones.
221 =head2 VALID_DBIC_CODE_ATTRIBUTE
225 =item Arguments: $attribute_string
227 =item Return Value: ( true| false )
231 This method is invoked when processing each DBIC-specific attribute (the ones
232 starting with C<DBIC_>). An attribute is considered invalid and an exception
233 is thrown unless this method returns a C<truthy> value.
239 =item Arguments: none
241 =item Return Value: B<purposefully undocumented>
245 The legacy method of retrieving attributes declared on DBIC methods
246 (L</FETCH_CODE_ATTRIBUTES> was not defined until mid-2016). This method
247 B<does not return any DBIC-specific attributes>, and is kept for backwards
250 In order to query the attributes of a particular method use
251 L<attributes::get()|attributes/get> as shown in the L</SYNOPSIS>.
253 =head1 FURTHER QUESTIONS?
255 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
257 =head1 COPYRIGHT AND LICENSE
259 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
260 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
261 redistribute it and/or modify it under the same terms as the
262 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.