Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebKit / Shared / API / Cocoa / _WKRemoteObjectInterface.mm
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "_WKRemoteObjectInterfaceInternal.h"
28
29 #if WK_API_ENABLED
30
31 #import <objc/runtime.h>
32 #import <wtf/HashMap.h>
33 #import <wtf/NeverDestroyed.h>
34 #import <wtf/Optional.h>
35 #import <wtf/RetainPtr.h>
36 #import <wtf/Vector.h>
37 #import <wtf/text/CString.h>
38
39 extern "C"
40 const char *_protocol_getMethodTypeEncoding(Protocol *p, SEL sel, BOOL isRequiredMethod, BOOL isInstanceMethod);
41
42 @interface NSMethodSignature ()
43 - (NSMethodSignature *)_signatureForBlockAtArgumentIndex:(NSInteger)idx;
44 - (Class)_classForObjectAtArgumentIndex:(NSInteger)idx;
45 - (NSString *)_typeString;
46 @end
47
48 struct MethodInfo {
49     Vector<HashSet<Class>> allowedArgumentClasses;
50
51     struct ReplyInfo {
52         NSUInteger replyPosition;
53         CString replySignature;
54         Vector<HashSet<Class>> allowedReplyClasses;
55     };
56     std::optional<ReplyInfo> replyInfo;
57 };
58
59 @implementation _WKRemoteObjectInterface {
60     RetainPtr<NSString> _identifier;
61
62     HashMap<SEL, MethodInfo> _methods;
63 }
64
65 static bool isContainerClass(Class objectClass)
66 {
67     // FIXME: Add more classes here if needed.
68     static Class arrayClass = [NSArray class];
69     static Class dictionaryClass = [NSDictionary class];
70     return objectClass == arrayClass || objectClass == dictionaryClass;
71 }
72
73 static HashSet<Class>& propertyListClasses()
74 {
75     static LazyNeverDestroyed<HashSet<Class>> propertyListClasses;
76     static dispatch_once_t onceToken;
77     dispatch_once(&onceToken, ^{
78         propertyListClasses.construct(std::initializer_list<Class> { [NSArray class], [NSDictionary class], [NSNumber class], [NSString class] });
79     });
80
81     return propertyListClasses;
82 }
83
84 static void initializeMethod(MethodInfo& methodInfo, Protocol *protocol, SEL selector, NSMethodSignature *methodSignature, bool forReplyBlock)
85 {
86     Vector<HashSet<Class>> allowedClasses;
87
88     NSUInteger firstArgument = forReplyBlock ? 1 : 2;
89     NSUInteger argumentCount = methodSignature.numberOfArguments;
90
91     bool foundBlock = false;
92     for (NSUInteger i = firstArgument; i < argumentCount; ++i) {
93         const char* argumentType = [methodSignature getArgumentTypeAtIndex:i];
94
95         if (*argumentType != '@') {
96             // This is a non-object type; we won't allow any classes to be decoded for it.
97             allowedClasses.append({ });
98             continue;
99         }
100
101         if (*(argumentType + 1) == '?') {
102             if (forReplyBlock)
103                 [NSException raise:NSInvalidArgumentException format:@"Blocks as arguments to the reply block of method (%s / %s) are not allowed", protocol_getName(protocol), sel_getName(selector)];
104
105             if (foundBlock)
106                 [NSException raise:NSInvalidArgumentException format:@"Only one reply block is allowed per method (%s / %s)", protocol_getName(protocol), sel_getName(selector)];
107             foundBlock = true;
108             NSMethodSignature *blockSignature = [methodSignature _signatureForBlockAtArgumentIndex:i];
109             ASSERT(blockSignature._typeString);
110
111             methodInfo.replyInfo = MethodInfo::ReplyInfo();
112             methodInfo.replyInfo->replyPosition = i;
113             methodInfo.replyInfo->replySignature = blockSignature._typeString.UTF8String;
114
115             initializeMethod(methodInfo, protocol, selector, blockSignature, true);
116         }
117
118         Class objectClass = [methodSignature _classForObjectAtArgumentIndex:i];
119         if (!objectClass) {
120             allowedClasses.append({ });
121             continue;
122         }
123
124         if (isContainerClass(objectClass)) {
125             // For container classes, we allow all simple property list classes.
126             allowedClasses.append(propertyListClasses());
127             continue;
128         }
129
130         allowedClasses.append({ objectClass });
131     }
132
133     if (forReplyBlock)
134         methodInfo.replyInfo->allowedReplyClasses = WTFMove(allowedClasses);
135     else
136         methodInfo.allowedArgumentClasses = WTFMove(allowedClasses);
137 }
138
139 static void initializeMethods(_WKRemoteObjectInterface *interface, Protocol *protocol, bool requiredMethods)
140 {
141     unsigned methodCount;
142     struct objc_method_description *methods = protocol_copyMethodDescriptionList(protocol, requiredMethods, true, &methodCount);
143
144     for (unsigned i = 0; i < methodCount; ++i) {
145         SEL selector = methods[i].name;
146
147         ASSERT(!interface->_methods.contains(selector));
148         MethodInfo& methodInfo = interface->_methods.add(selector, MethodInfo()).iterator->value;
149
150         const char* methodTypeEncoding = _protocol_getMethodTypeEncoding(protocol, selector, requiredMethods, true);
151         if (!methodTypeEncoding)
152             [NSException raise:NSInvalidArgumentException format:@"Could not find method type encoding for method \"%s\"", sel_getName(selector)];
153
154         NSMethodSignature *methodSignature = [NSMethodSignature signatureWithObjCTypes:methodTypeEncoding];
155
156         initializeMethod(methodInfo, protocol, selector, methodSignature, false);
157     }
158
159     free(methods);
160 }
161
162 static void initializeMethods(_WKRemoteObjectInterface *interface, Protocol *protocol)
163 {
164     unsigned conformingProtocolCount;
165     Protocol** conformingProtocols = protocol_copyProtocolList(interface->_protocol, &conformingProtocolCount);
166
167     for (unsigned i = 0; i < conformingProtocolCount; ++i) {
168         Protocol* conformingProtocol = conformingProtocols[i];
169
170         if (conformingProtocol == @protocol(NSObject))
171             continue;
172
173         initializeMethods(interface, conformingProtocol);
174     }
175
176     free(conformingProtocols);
177
178     initializeMethods(interface, protocol, true);
179     initializeMethods(interface, protocol, false);
180 }
181
182 - (id)initWithProtocol:(Protocol *)protocol identifier:(NSString *)identifier
183 {
184     if (!(self = [super init]))
185         return nil;
186
187     _protocol = protocol;
188     _identifier = adoptNS([identifier copy]);
189
190     initializeMethods(self, _protocol);
191
192     return self;
193 }
194
195 + (instancetype)remoteObjectInterfaceWithProtocol:(Protocol *)protocol
196 {
197     return [[[self alloc] initWithProtocol:protocol identifier:NSStringFromProtocol(protocol)] autorelease];
198 }
199
200 - (NSString *)identifier
201 {
202     return _identifier.get();
203 }
204
205 - (NSString *)debugDescription
206 {
207     auto result = adoptNS([[NSMutableString alloc] initWithFormat:@"<%@: %p; protocol = \"%@\"; identifier = \"%@\"\n", NSStringFromClass(self.class), self, _identifier.get(), NSStringFromProtocol(_protocol)]);
208
209     auto descriptionForClasses = [](auto& allowedClasses) {
210         auto result = adoptNS([[NSMutableString alloc] initWithString:@"["]);
211         bool needsComma = false;
212
213         auto descriptionForArgument = [](auto& allowedArgumentClasses) {
214             auto result = adoptNS([[NSMutableString alloc] initWithString:@"{"]);
215
216             Vector<Class> orderedArgumentClasses;
217             copyToVector(allowedArgumentClasses, orderedArgumentClasses);
218
219             std::sort(orderedArgumentClasses.begin(), orderedArgumentClasses.end(), [](Class a, Class b) {
220                 return CString(class_getName(a)) < CString(class_getName(b));
221             });
222
223             bool needsComma = false;
224             for (auto& argumentClass : orderedArgumentClasses) {
225                 if (needsComma)
226                     [result appendString:@", "];
227
228                 [result appendFormat:@"%s", class_getName(argumentClass)];
229                 needsComma = true;
230             }
231
232             [result appendString:@"}"];
233             return result.autorelease();
234         };
235
236         for (auto& argumentClasses : allowedClasses) {
237             if (needsComma)
238                 [result appendString:@", "];
239
240             [result appendString:descriptionForArgument(argumentClasses)];
241             needsComma = true;
242         }
243
244         [result appendString:@"]"];
245         return result.autorelease();
246     };
247
248     for (auto& selectorAndMethod : _methods) {
249         [result appendFormat:@" selector = %s\n  argument classes = %@\n", sel_getName(selectorAndMethod.key), descriptionForClasses(selectorAndMethod.value.allowedArgumentClasses)];
250
251         if (auto replyInfo = selectorAndMethod.value.replyInfo)
252             [result appendFormat:@"  reply block = (argument #%lu '%s') %@\n", static_cast<unsigned long>(replyInfo->replyPosition), replyInfo->replySignature.data(), descriptionForClasses(replyInfo->allowedReplyClasses)];
253     }
254
255     [result appendString:@">\n"];
256     return result.autorelease();
257 }
258
259 static HashSet<Class>& classesForSelectorArgument(_WKRemoteObjectInterface *interface, SEL selector, NSUInteger argumentIndex, bool replyBlock)
260 {
261     auto it = interface->_methods.find(selector);
262     if (it == interface->_methods.end())
263         [NSException raise:NSInvalidArgumentException format:@"Interface does not contain selector \"%s\"", sel_getName(selector)];
264
265     MethodInfo& methodInfo = it->value;
266     if (replyBlock) {
267         if (!methodInfo.replyInfo)
268             [NSException raise:NSInvalidArgumentException format:@"Selector \"%s\" does not have a reply block", sel_getName(selector)];
269
270         if (argumentIndex >= methodInfo.replyInfo->allowedReplyClasses.size())
271             [NSException raise:NSInvalidArgumentException format:@"Argument index %ld is out of range for reply block of selector \"%s\"", (unsigned long)argumentIndex, sel_getName(selector)];
272
273         return methodInfo.replyInfo->allowedReplyClasses[argumentIndex];
274     }
275
276     if (argumentIndex >= methodInfo.allowedArgumentClasses.size())
277         [NSException raise:NSInvalidArgumentException format:@"Argument index %ld is out of range for selector \"%s\"", (unsigned long)argumentIndex, sel_getName(selector)];
278
279     return methodInfo.allowedArgumentClasses[argumentIndex];
280 }
281
282 - (NSSet *)classesForSelector:(SEL)selector argumentIndex:(NSUInteger)argumentIndex ofReply:(BOOL)ofReply
283 {
284     auto result = adoptNS([[NSMutableSet alloc] init]);
285
286     for (auto allowedClass : classesForSelectorArgument(self, selector, argumentIndex, ofReply))
287         [result addObject:allowedClass];
288
289     return result.autorelease();
290 }
291
292 - (void)setClasses:(NSSet *)classes forSelector:(SEL)selector argumentIndex:(NSUInteger)argumentIndex ofReply:(BOOL)ofReply
293 {
294     HashSet<Class> allowedClasses;
295     for (Class allowedClass in classes)
296         allowedClasses.add(allowedClass);
297
298     classesForSelectorArgument(self, selector, argumentIndex, ofReply) = WTFMove(allowedClasses);
299 }
300
301 - (NSSet *)classesForSelector:(SEL)selector argumentIndex:(NSUInteger)argumentIndex
302 {
303     return [self classesForSelector:selector argumentIndex:argumentIndex ofReply:NO];
304 }
305
306 - (void)setClasses:(NSSet *)classes forSelector:(SEL)selector argumentIndex:(NSUInteger)argumentIndex
307 {
308     [self setClasses:classes forSelector:selector argumentIndex:argumentIndex ofReply:NO];
309 }
310
311 static const char* methodArgumentTypeEncodingForSelector(Protocol *protocol, SEL selector)
312 {
313     // First look at required methods.
314     struct objc_method_description method = protocol_getMethodDescription(protocol, selector, YES, YES);
315     if (method.name)
316         return method.types;
317
318     // Then look at optional methods.
319     method = protocol_getMethodDescription(protocol, selector, NO, YES);
320     if (method.name)
321         return method.types;
322
323     return nullptr;
324 }
325
326 - (NSMethodSignature *)_methodSignatureForSelector:(SEL)selector
327 {
328     if (!_methods.contains(selector))
329         return nil;
330
331     const char* types = methodArgumentTypeEncodingForSelector(_protocol, selector);
332     if (!types)
333         return nil;
334
335     return [NSMethodSignature signatureWithObjCTypes:types];
336 }
337
338 - (NSMethodSignature *)_methodSignatureForReplyBlockOfSelector:(SEL)selector
339 {
340     auto it = _methods.find(selector);
341     if (it  == _methods.end())
342         return nil;
343
344     auto& methodInfo = it->value;
345     if (!methodInfo.replyInfo)
346         return nil;
347
348     return [NSMethodSignature signatureWithObjCTypes:methodInfo.replyInfo->replySignature.data()];
349 }
350
351 - (const Vector<HashSet<Class>>&)_allowedArgumentClassesForSelector:(SEL)selector
352 {
353     ASSERT(_methods.contains(selector));
354
355     return _methods.find(selector)->value.allowedArgumentClasses;
356 }
357
358 - (const Vector<HashSet<Class>>&)_allowedArgumentClassesForReplyBlockOfSelector:(SEL)selector
359 {
360     ASSERT(_methods.contains(selector));
361
362     return _methods.find(selector)->value.replyInfo->allowedReplyClasses;
363 }
364
365 @end
366
367 #endif // WK_API_ENABLED