forked from jhump/protoreflect
/
extension_registry.go
241 lines (221 loc) · 7.24 KB
/
extension_registry.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
package dynamic
import (
"fmt"
"reflect"
"sync"
"github.com/golang/protobuf/proto"
"github.com/phpstudyer/protoreflect/desc"
)
// ExtensionRegistry is a registry of known extension fields. This is used to parse
// extension fields encountered when de-serializing a dynamic message.
type ExtensionRegistry struct {
includeDefault bool
mu sync.RWMutex
exts map[string]map[int32]*desc.FieldDescriptor
}
// NewExtensionRegistryWithDefaults is a registry that includes all "default" extensions,
// which are those that are statically linked into the current program (e.g. registered by
// protoc-generated code via proto.RegisterExtension). Extensions explicitly added to the
// registry will override any default extensions that are for the same extendee and have the
// same tag number and/or name.
func NewExtensionRegistryWithDefaults() *ExtensionRegistry {
return &ExtensionRegistry{includeDefault: true}
}
// AddExtensionDesc adds the given extensions to the registry.
func (r *ExtensionRegistry) AddExtensionDesc(exts ...*proto.ExtensionDesc) error {
flds := make([]*desc.FieldDescriptor, len(exts))
for i, ext := range exts {
fd, err := desc.LoadFieldDescriptorForExtension(ext)
if err != nil {
return err
}
flds[i] = fd
}
r.mu.Lock()
defer r.mu.Unlock()
if r.exts == nil {
r.exts = map[string]map[int32]*desc.FieldDescriptor{}
}
for _, fd := range flds {
r.putExtensionLocked(fd)
}
return nil
}
// AddExtension adds the given extensions to the registry. The given extensions
// will overwrite any previously added extensions that are for the same extendee
// message and same extension tag number.
func (r *ExtensionRegistry) AddExtension(exts ...*desc.FieldDescriptor) error {
for _, ext := range exts {
if !ext.IsExtension() {
return fmt.Errorf("given field is not an extension: %s", ext.GetFullyQualifiedName())
}
}
r.mu.Lock()
defer r.mu.Unlock()
if r.exts == nil {
r.exts = map[string]map[int32]*desc.FieldDescriptor{}
}
for _, ext := range exts {
r.putExtensionLocked(ext)
}
return nil
}
// AddExtensionsFromFile adds to the registry all extension fields defined in the given file descriptor.
func (r *ExtensionRegistry) AddExtensionsFromFile(fd *desc.FileDescriptor) {
r.mu.Lock()
defer r.mu.Unlock()
r.addExtensionsFromFileLocked(fd, false, nil)
}
// AddExtensionsFromFileRecursively adds to the registry all extension fields defined in the give file
// descriptor and also recursively adds all extensions defined in that file's dependencies. This adds
// extensions from the entire transitive closure for the given file.
func (r *ExtensionRegistry) AddExtensionsFromFileRecursively(fd *desc.FileDescriptor) {
r.mu.Lock()
defer r.mu.Unlock()
already := map[*desc.FileDescriptor]struct{}{}
r.addExtensionsFromFileLocked(fd, true, already)
}
func (r *ExtensionRegistry) addExtensionsFromFileLocked(fd *desc.FileDescriptor, recursive bool, alreadySeen map[*desc.FileDescriptor]struct{}) {
if _, ok := alreadySeen[fd]; ok {
return
}
if r.exts == nil {
r.exts = map[string]map[int32]*desc.FieldDescriptor{}
}
for _, ext := range fd.GetExtensions() {
r.putExtensionLocked(ext)
}
for _, msg := range fd.GetMessageTypes() {
r.addExtensionsFromMessageLocked(msg)
}
if recursive {
alreadySeen[fd] = struct{}{}
for _, dep := range fd.GetDependencies() {
r.addExtensionsFromFileLocked(dep, recursive, alreadySeen)
}
}
}
func (r *ExtensionRegistry) addExtensionsFromMessageLocked(md *desc.MessageDescriptor) {
for _, ext := range md.GetNestedExtensions() {
r.putExtensionLocked(ext)
}
for _, msg := range md.GetNestedMessageTypes() {
r.addExtensionsFromMessageLocked(msg)
}
}
func (r *ExtensionRegistry) putExtensionLocked(fd *desc.FieldDescriptor) {
msgName := fd.GetOwner().GetFullyQualifiedName()
m := r.exts[msgName]
if m == nil {
m = map[int32]*desc.FieldDescriptor{}
r.exts[msgName] = m
}
m[fd.GetNumber()] = fd
}
// FindExtension queries for the extension field with the given extendee name (must be a fully-qualified
// message name) and tag number. If no extension is known, nil is returned.
func (r *ExtensionRegistry) FindExtension(messageName string, tagNumber int32) *desc.FieldDescriptor {
if r == nil {
return nil
}
r.mu.RLock()
defer r.mu.RUnlock()
fd := r.exts[messageName][tagNumber]
if fd == nil && r.includeDefault {
ext := getDefaultExtensions(messageName)[tagNumber]
if ext != nil {
fd, _ = desc.LoadFieldDescriptorForExtension(ext)
}
}
return fd
}
// FindExtensionByName queries for the extension field with the given extendee name (must be a fully-qualified
// message name) and field name (must also be a fully-qualified extension name). If no extension is known, nil
// is returned.
func (r *ExtensionRegistry) FindExtensionByName(messageName string, fieldName string) *desc.FieldDescriptor {
if r == nil {
return nil
}
r.mu.RLock()
defer r.mu.RUnlock()
for _, fd := range r.exts[messageName] {
if fd.GetFullyQualifiedName() == fieldName {
return fd
}
}
if r.includeDefault {
for _, ext := range getDefaultExtensions(messageName) {
fd, _ := desc.LoadFieldDescriptorForExtension(ext)
if fd.GetFullyQualifiedName() == fieldName {
return fd
}
}
}
return nil
}
// FindExtensionByJSONName queries for the extension field with the given extendee name (must be a fully-qualified
// message name) and JSON field name (must also be a fully-qualified name). If no extension is known, nil is returned.
// The fully-qualified JSON name is the same as the extension's normal fully-qualified name except that the last
// component uses the field's JSON name (if present).
func (r *ExtensionRegistry) FindExtensionByJSONName(messageName string, fieldName string) *desc.FieldDescriptor {
if r == nil {
return nil
}
r.mu.RLock()
defer r.mu.RUnlock()
for _, fd := range r.exts[messageName] {
if fd.GetFullyQualifiedJSONName() == fieldName {
return fd
}
}
if r.includeDefault {
for _, ext := range getDefaultExtensions(messageName) {
fd, _ := desc.LoadFieldDescriptorForExtension(ext)
if fd.GetFullyQualifiedJSONName() == fieldName {
return fd
}
}
}
return nil
}
func getDefaultExtensions(messageName string) map[int32]*proto.ExtensionDesc {
t := proto.MessageType(messageName)
if t != nil {
msg := reflect.Zero(t).Interface().(proto.Message)
return proto.RegisteredExtensions(msg)
}
return nil
}
// AllExtensionsForType returns all known extension fields for the given extendee name (must be a
// fully-qualified message name).
func (r *ExtensionRegistry) AllExtensionsForType(messageName string) []*desc.FieldDescriptor {
if r == nil {
return []*desc.FieldDescriptor(nil)
}
r.mu.RLock()
defer r.mu.RUnlock()
flds := r.exts[messageName]
var ret []*desc.FieldDescriptor
if r.includeDefault {
exts := getDefaultExtensions(messageName)
if len(exts) > 0 || len(flds) > 0 {
ret = make([]*desc.FieldDescriptor, 0, len(exts)+len(flds))
}
for tag, ext := range exts {
if _, ok := flds[tag]; ok {
// skip default extension and use the one explicitly registered instead
continue
}
fd, _ := desc.LoadFieldDescriptorForExtension(ext)
if fd != nil {
ret = append(ret, fd)
}
}
} else if len(flds) > 0 {
ret = make([]*desc.FieldDescriptor, 0, len(flds))
}
for _, ext := range flds {
ret = append(ret, ext)
}
return ret
}