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) = @_;
147 ### !!! IMPORTANT !!!
149 ### *DO NOT* yield to the temptation of using free-form-argument attributes.
150 ### The technique was proven instrumental in Catalyst a decade ago, and
151 ### was more recently revived in Sub::Attributes. Yet, while on the surface
152 ### they seem immensely useful, per-attribute argument lists are in fact an
153 ### architectural dead end.
155 ### In other words: you are *very strongly urged* to ensure the regex below
156 ### does not allow anything beyond qr/^ DBIC_method_is_ [A-Z_a-z0-9]+ $/x
159 $_[1] =~ /^ DBIC_method_is_ (?:
164 sub FETCH_CODE_ATTRIBUTES {
165 #my ($class,$code) = @_;
168 @{ $_[0]->_attr_cache->{$_[1]} || [] },
169 ( defined( $attr_cref_registry->{$_[1]}{ weakref } )
170 ? @{ $attr_cref_registry->{$_[1]}{attrs} || [] }
179 %{ $self->can('__attr_cache') ? $self->__attr_cache : {} },
180 %{ $self->maybe::next::method || {} },
190 DBIx::Class::MethodAttributes - DBIC-specific handling of CODE attributes
194 my @attrlist = attributes::get( \&My::App::Schema::Result::some_method )
198 This class provides the L<DBIx::Class> inheritance chain with the bits
199 necessary for L<attribute|attributes> support on methods.
201 Historically DBIC has accepted any string as a C<CODE> attribute and made
202 such strings available via the semi-private L</_attr_cache> method. This
203 was used for e.g. the long-deprecated L<DBIx::Class::ResultSetManager>,
204 but also has evidence of use on both C<CPAN> and C<DarkPAN>.
206 Starting mid-2016 DBIC treats any method attribute starting with C<DBIC_>
207 as an I<internal boolean decorator> for various DBIC-related methods.
208 Unlike the general attribute naming policy, strict whitelisting is imposed
209 on attribute names starting with C<DBIC_> as described in
210 L</VALID_DBIC_CODE_ATTRIBUTE> below.
212 =head2 DBIC-specific method attributes
214 The following method attributes are currently recognized under the C<DBIC_*>
217 =head3 DBIC_method_is_indirect_sugar
219 The presence of this attribute indicates a helper "sugar" method. Overriding
220 such methods in your subclasses will be of limited success at best, as DBIC
221 itself and various plugins are much more likely to invoke alternative direct
222 call paths, bypassing your override entirely. Good examples of this are
223 L<DBIx::Class::ResultSet/create> and L<DBIx::Class::Schema/connect>.
227 =head2 MODIFY_CODE_ATTRIBUTES
229 See L<attributes/MODIFY_type_ATTRIBUTES>.
231 =head2 FETCH_CODE_ATTRIBUTES
233 See L<attributes/FETCH_type_ATTRIBUTES>. Always returns the combination of
234 all attributes: both the free-form strings registered via the
235 L<legacy system|/_attr_cache> and the DBIC-specific ones.
237 =head2 VALID_DBIC_CODE_ATTRIBUTE
241 =item Arguments: $attribute_string
243 =item Return Value: ( true| false )
247 This method is invoked when processing each DBIC-specific attribute (the ones
248 starting with C<DBIC_>). An attribute is considered invalid and an exception
249 is thrown unless this method returns a C<truthy> value.
255 =item Arguments: none
257 =item Return Value: B<purposefully undocumented>
261 The legacy method of retrieving attributes declared on DBIC methods
262 (L</FETCH_CODE_ATTRIBUTES> was not defined until mid-2016). This method
263 B<does not return any DBIC-specific attributes>, and is kept for backwards
266 In order to query the attributes of a particular method use
267 L<attributes::get()|attributes/get> as shown in the L</SYNOPSIS>.
269 =head1 FURTHER QUESTIONS?
271 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
273 =head1 COPYRIGHT AND LICENSE
275 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
276 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
277 redistribute it and/or modify it under the same terms as the
278 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.