[WebGPU] Move swap chain methods from GPUDevice to GPUCanvasContext
[WebKit-https.git] / Source / WebKit / WebProcess / InjectedBundle / mac / InjectedBundleMac.mm
1 /*
2  * Copyright (C) 2010-2019 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 "InjectedBundle.h"
28
29 #import "APIArray.h"
30 #import "APIData.h"
31 #import "ObjCObjectGraph.h"
32 #import "WKBundleAPICast.h"
33 #import "WKBundleInitialize.h"
34 #import "WKWebProcessBundleParameters.h"
35 #import "WKWebProcessPlugInInternal.h"
36 #import "WebProcessCreationParameters.h"
37 #import <CoreFoundation/CFURL.h>
38 #import <Foundation/NSBundle.h>
39 #import <WebCore/PlatformKeyboardEvent.h>
40 #import <dlfcn.h>
41 #import <objc/runtime.h>
42 #import <pal/spi/cocoa/NSKeyedArchiverSPI.h>
43 #import <stdio.h>
44 #import <wtf/RetainPtr.h>
45 #import <wtf/text/CString.h>
46 #import <wtf/text/WTFString.h>
47
48 @interface NSBundle (WKAppDetails)
49 - (CFBundleRef)_cfBundle;
50 @end
51
52 namespace WebKit {
53 using namespace WebCore;
54
55 #if ENABLE(WEBPROCESS_WINDOWSERVER_BLOCKING)
56 static NSEventModifierFlags currentModifierFlags(id self, SEL _cmd)
57 {
58     auto currentModifiers = PlatformKeyboardEvent::currentStateOfModifierKeys();
59     NSEventModifierFlags modifiers = 0;
60     
61     if (currentModifiers.contains(PlatformEvent::Modifier::ShiftKey))
62         modifiers |= NSEventModifierFlagShift;
63     if (currentModifiers.contains(PlatformEvent::Modifier::ControlKey))
64         modifiers |= NSEventModifierFlagControl;
65     if (currentModifiers.contains(PlatformEvent::Modifier::AltKey))
66         modifiers |= NSEventModifierFlagOption;
67     if (currentModifiers.contains(PlatformEvent::Modifier::MetaKey))
68         modifiers |= NSEventModifierFlagCommand;
69     if (currentModifiers.contains(PlatformEvent::Modifier::CapsLockKey))
70         modifiers |= NSEventModifierFlagCapsLock;
71     
72     return modifiers;
73 }
74 #endif
75
76 bool InjectedBundle::decodeBundleParameters(API::Data* bundleParameterDataPtr)
77 {
78     if (!bundleParameterDataPtr)
79         return true;
80
81     auto bundleParameterData = adoptNS([[NSData alloc] initWithBytesNoCopy:const_cast<void*>(static_cast<const void*>(bundleParameterDataPtr->bytes())) length:bundleParameterDataPtr->size() freeWhenDone:NO]);
82     
83     auto unarchiver = secureUnarchiverFromData(bundleParameterData.get());
84     
85     NSDictionary *dictionary = nil;
86     @try {
87         dictionary = [unarchiver.get() decodeObjectOfClasses:classesForCoder() forKey:@"parameters"];
88         ASSERT([dictionary isKindOfClass:[NSDictionary class]]);
89     } @catch (NSException *exception) {
90         LOG_ERROR("Failed to decode bundle parameters: %@", exception);
91         return false;
92     }
93     
94     ASSERT(!m_bundleParameters || m_bundleParameters.get());
95     m_bundleParameters = adoptNS([[WKWebProcessBundleParameters alloc] initWithDictionary:dictionary]);
96     return true;
97 }
98
99 bool InjectedBundle::initialize(const WebProcessCreationParameters& parameters, API::Object* initializationUserData)
100 {
101     if (m_sandboxExtension) {
102         if (!m_sandboxExtension->consumePermanently()) {
103             WTFLogAlways("InjectedBundle::load failed - Could not consume bundle sandbox extension for [%s].\n", m_path.utf8().data());
104             return false;
105         }
106
107         m_sandboxExtension = nullptr;
108     }
109     
110     RetainPtr<CFStringRef> injectedBundlePathStr = m_path.createCFString();
111     if (!injectedBundlePathStr) {
112         WTFLogAlways("InjectedBundle::load failed - Could not create the path string.\n");
113         return false;
114     }
115     
116     RetainPtr<CFURLRef> bundleURL = adoptCF(CFURLCreateWithFileSystemPath(0, injectedBundlePathStr.get(), kCFURLPOSIXPathStyle, false));
117     if (!bundleURL) {
118         WTFLogAlways("InjectedBundle::load failed - Could not create the url from the path string.\n");
119         return false;
120     }
121
122     m_platformBundle = [[NSBundle alloc] initWithURL:(__bridge NSURL *)bundleURL.get()];
123     if (!m_platformBundle) {
124         WTFLogAlways("InjectedBundle::load failed - Could not create the bundle.\n");
125         return false;
126     }
127
128     WKBundleInitializeFunctionPtr initializeFunction = nullptr;
129     if (RetainPtr<CFURLRef> executableURL = adoptCF(CFBundleCopyExecutableURL([m_platformBundle _cfBundle]))) {
130         static constexpr size_t maxPathSize = 4096;
131         char pathToExecutable[maxPathSize];
132         if (CFURLGetFileSystemRepresentation(executableURL.get(), true, bitwise_cast<uint8_t*>(pathToExecutable), maxPathSize)) {
133             // We don't hold onto this handle anywhere more permanent since we never dlcose.
134             if (void* handle = dlopen(pathToExecutable, RTLD_LAZY | RTLD_GLOBAL | RTLD_FIRST))
135                 initializeFunction = bitwise_cast<WKBundleInitializeFunctionPtr>(dlsym(handle, "WKBundleInitialize"));
136         }
137     }
138         
139     if (!initializeFunction) {
140         if (![m_platformBundle load]) {
141             WTFLogAlways("InjectedBundle::load failed - Could not load the executable from the bundle.\n");
142             return false;
143         }
144     }
145
146     bool successfullyDecoded = decodeBundleParameters(parameters.bundleParameterData.get());
147
148 #if ENABLE(WEBPROCESS_WINDOWSERVER_BLOCKING)
149     // Swizzle [NSEvent modiferFlags], since it always returns 0 when the WindowServer is blocked.
150     Method method = class_getClassMethod([NSEvent class], @selector(modifierFlags));
151     method_setImplementation(method, reinterpret_cast<IMP>(currentModifierFlags));
152 #endif
153     
154     if (!initializeFunction)
155         initializeFunction = bitwise_cast<WKBundleInitializeFunctionPtr>(CFBundleGetFunctionPointerForName([m_platformBundle _cfBundle], CFSTR("WKBundleInitialize")));
156
157     // First check to see if the bundle has a WKBundleInitialize function.
158     if (initializeFunction) {
159         initializeFunction(toAPI(this), toAPI(initializationUserData));
160         if (!successfullyDecoded)
161             decodeBundleParameters(parameters.bundleParameterData.get());
162         return true;
163     }
164
165     // Otherwise, look to see if the bundle has a principal class
166     Class principalClass = [m_platformBundle principalClass];
167     if (!principalClass) {
168         WTFLogAlways("InjectedBundle::load failed - No initialize function or principal class found in the bundle executable.\n");
169         return false;
170     }
171
172     if (![principalClass conformsToProtocol:@protocol(WKWebProcessPlugIn)]) {
173         WTFLogAlways("InjectedBundle::load failed - Principal class does not conform to the WKWebProcessPlugIn protocol.\n");
174         return false;
175     }
176
177     id <WKWebProcessPlugIn> instance = (id <WKWebProcessPlugIn>)[(NSObject *)[principalClass alloc] init];
178     if (!instance) {
179         WTFLogAlways("InjectedBundle::load failed - Could not initialize an instance of the principal class.\n");
180         return false;
181     }
182
183     WKWebProcessPlugInController* plugInController = WebKit::wrapper(*this);
184     [plugInController _setPrincipalClassInstance:instance];
185
186     if ([instance respondsToSelector:@selector(additionalClassesForParameterCoder)]) {
187         [plugInController extendClassesForParameterCoder:[instance additionalClassesForParameterCoder]];
188         decodeBundleParameters(parameters.bundleParameterData.get());
189     }
190
191     if ([instance respondsToSelector:@selector(webProcessPlugIn:initializeWithObject:)]) {
192         RetainPtr<id> objCInitializationUserData;
193         if (initializationUserData && initializationUserData->type() == API::Object::Type::ObjCObjectGraph)
194             objCInitializationUserData = static_cast<ObjCObjectGraph*>(initializationUserData)->rootObject();
195         [instance webProcessPlugIn:plugInController initializeWithObject:objCInitializationUserData.get()];
196     }
197
198     return true;
199 }
200
201 WKWebProcessBundleParameters *InjectedBundle::bundleParameters()
202 {
203     // We must not return nil even if no parameters are currently set, in order to allow the client
204     // to use KVO.
205     if (!m_bundleParameters)
206         m_bundleParameters = adoptNS([[WKWebProcessBundleParameters alloc] initWithDictionary:@{ }]);
207
208     return m_bundleParameters.get();
209 }
210
211 void InjectedBundle::extendClassesForParameterCoder(API::Array& classes)
212 {
213     size_t size = classes.size();
214
215     auto mutableSet = adoptNS([classesForCoder() mutableCopy]);
216
217     for (size_t i = 0; i < size; ++i) {
218         API::String* classNameString = classes.at<API::String>(i);
219         if (!classNameString) {
220             WTFLogAlways("InjectedBundle::extendClassesForParameterCoder - No class provided as argument %d.\n", i);
221             break;
222         }
223     
224         CString className = classNameString->string().utf8();
225         Class objectClass = objc_lookUpClass(className.data());
226         if (!objectClass) {
227             WTFLogAlways("InjectedBundle::extendClassesForParameterCoder - Class %s is not a valid Objective C class.\n", className.data());
228             break;
229         }
230
231         [mutableSet.get() addObject:objectClass];
232     }
233
234     m_classesForCoder = mutableSet;
235 }
236
237 NSSet* InjectedBundle::classesForCoder()
238 {
239     if (!m_classesForCoder)
240         m_classesForCoder = retainPtr([NSSet setWithObjects:[NSArray class], [NSData class], [NSDate class], [NSDictionary class], [NSNull class], [NSNumber class], [NSSet class], [NSString class], [NSTimeZone class], [NSURL class], [NSUUID class], nil]);
241
242     return m_classesForCoder.get();
243 }
244
245 void InjectedBundle::setBundleParameter(const String& key, const IPC::DataReference& value)
246 {
247     auto bundleParameterData = adoptNS([[NSData alloc] initWithBytesNoCopy:const_cast<void*>(static_cast<const void*>(value.data())) length:value.size() freeWhenDone:NO]);
248
249     auto unarchiver = secureUnarchiverFromData(bundleParameterData.get());
250
251     id parameter = nil;
252     @try {
253         parameter = [unarchiver decodeObjectOfClasses:classesForCoder() forKey:@"parameter"];
254     } @catch (NSException *exception) {
255         LOG_ERROR("Failed to decode bundle parameter: %@", exception);
256         return;
257     }
258
259     if (!m_bundleParameters && parameter)
260         m_bundleParameters = adoptNS([[WKWebProcessBundleParameters alloc] initWithDictionary:[NSDictionary dictionary]]);
261
262     [m_bundleParameters setParameter:parameter forKey:key];
263 }
264
265 void InjectedBundle::setBundleParameters(const IPC::DataReference& value)
266 {
267     auto bundleParametersData = adoptNS([[NSData alloc] initWithBytesNoCopy:const_cast<void*>(static_cast<const void*>(value.data())) length:value.size() freeWhenDone:NO]);
268
269     auto unarchiver = secureUnarchiverFromData(bundleParametersData.get());
270
271     NSDictionary *parameters = nil;
272     @try {
273         parameters = [unarchiver decodeObjectOfClasses:classesForCoder() forKey:@"parameters"];
274     } @catch (NSException *exception) {
275         LOG_ERROR("Failed to decode bundle parameter: %@", exception);
276     }
277
278     if (!parameters)
279         return;
280
281     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION([parameters isKindOfClass:[NSDictionary class]]);
282
283     if (!m_bundleParameters) {
284         m_bundleParameters = adoptNS([[WKWebProcessBundleParameters alloc] initWithDictionary:parameters]);
285         return;
286     }
287
288     [m_bundleParameters setParametersForKeyWithDictionary:parameters];
289 }
290
291 } // namespace WebKit