Add APIs for customizing the user agent
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKWebViewConfiguration.mm
1 /*
2  * Copyright (C) 2014 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 "WKWebViewConfigurationInternal.h"
28
29 #if WK_API_ENABLED
30
31 #import "WKPreferences.h"
32 #import "WKProcessPool.h"
33 #import "WKUserContentController.h"
34 #import "WKWebViewContentProviderRegistry.h"
35 #import "WeakObjCPtr.h"
36 #import "_WKVisitedLinkProvider.h"
37 #import "_WKWebsiteDataStore.h"
38 #import <wtf/RetainPtr.h>
39
40 template<typename T> class LazyInitialized {
41 public:
42     template<typename F>
43     T* get(F&& f)
44     {
45         if (!m_isInitialized) {
46             m_value = f();
47             m_isInitialized = true;
48         }
49
50         return m_value.get();
51     }
52
53     void set(T* t)
54     {
55         m_value = t;
56         m_isInitialized = true;
57     }
58
59     void set(RetainPtr<T>&& t)
60     {
61         m_value = WTF::move(t);
62         m_isInitialized = true;
63     }
64
65     T* peek()
66     {
67         return m_value.get();
68     }
69
70 private:
71     bool m_isInitialized = false;
72     RetainPtr<T> m_value;
73 };
74
75 @implementation WKWebViewConfiguration {
76     LazyInitialized<WKProcessPool> _processPool;
77     LazyInitialized<WKPreferences> _preferences;
78     LazyInitialized<WKUserContentController> _userContentController;
79     LazyInitialized<_WKVisitedLinkProvider> _visitedLinkProvider;
80     LazyInitialized<_WKWebsiteDataStore> _websiteDataStore;
81     WebKit::WeakObjCPtr<WKWebView> _relatedWebView;
82     WebKit::WeakObjCPtr<WKWebView> _alternateWebViewForNavigationGestures;
83     RetainPtr<NSString> _groupIdentifier;
84     LazyInitialized<NSString> _applicationNameForUserAgent;
85
86 #if PLATFORM(IOS)
87     LazyInitialized<WKWebViewContentProviderRegistry> _contentProviderRegistry;
88     BOOL _allowsAlternateFullscreen;
89 #endif
90 }
91
92 - (instancetype)init
93 {
94     if (!(self = [super init]))
95         return nil;
96     
97 #if PLATFORM(IOS)
98     _mediaPlaybackRequiresUserAction = YES;
99     _mediaPlaybackAllowsAirPlay = YES;
100     _allowsAlternateFullscreen = YES;
101 #endif
102     
103     return self;
104 }
105
106 - (NSString *)description
107 {
108     return [NSString stringWithFormat:@"<%@: %p; processPool = %@; preferences = %@>", NSStringFromClass(self.class), self, self.processPool, self.preferences];
109 }
110
111 - (id)copyWithZone:(NSZone *)zone
112 {
113     WKWebViewConfiguration *configuration = [[[self class] allocWithZone:zone] init];
114
115     configuration.processPool = self.processPool;
116     configuration.preferences = self.preferences;
117     configuration.userContentController = self.userContentController;
118     configuration._visitedLinkProvider = self._visitedLinkProvider;
119     configuration._websiteDataStore = self._websiteDataStore;
120     configuration._relatedWebView = _relatedWebView.get().get();
121     configuration._alternateWebViewForNavigationGestures = _alternateWebViewForNavigationGestures.get().get();
122 #if PLATFORM(IOS)
123     configuration._contentProviderRegistry = self._contentProviderRegistry;
124 #endif
125
126     configuration->_suppressesIncrementalRendering = self->_suppressesIncrementalRendering;
127     configuration.applicationNameForUserAgent = self.applicationNameForUserAgent;
128
129 #if PLATFORM(IOS)
130     configuration->_allowsInlineMediaPlayback = self->_allowsInlineMediaPlayback;
131     configuration->_allowsAlternateFullscreen = self->_allowsAlternateFullscreen;
132     configuration->_mediaPlaybackRequiresUserAction = self->_mediaPlaybackRequiresUserAction;
133     configuration->_mediaPlaybackAllowsAirPlay = self->_mediaPlaybackAllowsAirPlay;
134     configuration->_selectionGranularity = self->_selectionGranularity;
135 #endif
136
137     return configuration;
138 }
139
140 - (WKProcessPool *)processPool
141 {
142     return _processPool.get([] { return adoptNS([[WKProcessPool alloc] init]); });
143 }
144
145 - (void)setProcessPool:(WKProcessPool *)processPool
146 {
147     _processPool.set(processPool);
148 }
149
150 - (WKPreferences *)preferences
151 {
152     return _preferences.get([] { return adoptNS([[WKPreferences alloc] init]); });
153 }
154
155 - (void)setPreferences:(WKPreferences *)preferences
156 {
157     _preferences.set(preferences);
158 }
159
160 - (WKUserContentController *)userContentController
161 {
162     return _userContentController.get([] { return adoptNS([[WKUserContentController alloc] init]); });
163 }
164
165 - (void)setUserContentController:(WKUserContentController *)userContentController
166 {
167     _userContentController.set(userContentController);
168 }
169
170 static NSString *defaultApplicationNameForUserAgent()
171 {
172 #if PLATFORM(IOS)
173     return [@"Mobile/" stringByAppendingString:[UIDevice currentDevice].buildVersion];
174 #else
175     return nil;
176 #endif
177 }
178
179 - (NSString *)applicationNameForUserAgent
180 {
181     return _applicationNameForUserAgent.get([] { return defaultApplicationNameForUserAgent(); });
182 }
183
184 - (void)setApplicationNameForUserAgent:(NSString *)applicationNameForUserAgent
185 {
186     _applicationNameForUserAgent.set(adoptNS([applicationNameForUserAgent copy]));
187 }
188
189 - (_WKVisitedLinkProvider *)_visitedLinkProvider
190 {
191     return _visitedLinkProvider.get([] { return adoptNS([[_WKVisitedLinkProvider alloc] init]); });
192 }
193
194 - (void)_setVisitedLinkProvider:(_WKVisitedLinkProvider *)visitedLinkProvider
195 {
196     _visitedLinkProvider.set(visitedLinkProvider);
197 }
198
199 - (_WKWebsiteDataStore *)_websiteDataStore
200 {
201     return _websiteDataStore.get([] { return [_WKWebsiteDataStore defaultDataStore]; });
202 }
203
204 - (void)_setWebsiteDataStore:(_WKWebsiteDataStore *)websiteDataStore
205 {
206     _websiteDataStore.set(websiteDataStore);
207 }
208
209 #if PLATFORM(IOS)
210 - (WKWebViewContentProviderRegistry *)_contentProviderRegistry
211 {
212     return _contentProviderRegistry.get([] { return adoptNS([[WKWebViewContentProviderRegistry alloc] init]); });
213 }
214
215 - (void)_setContentProviderRegistry:(WKWebViewContentProviderRegistry *)registry
216 {
217     _contentProviderRegistry.set(registry);
218 }
219 #endif
220
221 - (void)_validate
222 {
223     if (!self.processPool)
224         [NSException raise:NSInvalidArgumentException format:@"configuration.processPool is nil"];
225
226     if (!self.preferences)
227         [NSException raise:NSInvalidArgumentException format:@"configuration.preferences is nil"];
228
229     if (!self.userContentController)
230         [NSException raise:NSInvalidArgumentException format:@"configuration.userContentController is nil"];
231
232     if (!self._visitedLinkProvider)
233         [NSException raise:NSInvalidArgumentException format:@"configuration._visitedLinkProvider is nil"];
234
235     if (!self._websiteDataStore)
236         [NSException raise:NSInvalidArgumentException format:@"configuration._websiteDataStore is nil"];
237
238 #if PLATFORM(IOS)
239     if (!self._contentProviderRegistry)
240         [NSException raise:NSInvalidArgumentException format:@"configuration._contentProviderRegistry is nil"];
241 #endif
242 }
243
244 @end
245
246 @implementation WKWebViewConfiguration (WKPrivate)
247
248 - (WKWebView *)_relatedWebView
249 {
250     return _relatedWebView.getAutoreleased();
251 }
252
253 - (void)_setRelatedWebView:(WKWebView *)relatedWebView
254 {
255     _relatedWebView = relatedWebView;
256 }
257
258 - (WKWebView *)_alternateWebViewForNavigationGestures
259 {
260     return _alternateWebViewForNavigationGestures.getAutoreleased();
261 }
262
263 - (void)_setAlternateWebViewForNavigationGestures:(WKWebView *)alternateView
264 {
265     _alternateWebViewForNavigationGestures = alternateView;
266 }
267
268 - (NSString *)_groupIdentifier
269 {
270     return _groupIdentifier.get();
271 }
272
273 - (void)_setGroupIdentifier:(NSString *)groupIdentifier
274 {
275     _groupIdentifier = groupIdentifier;
276 }
277
278 #if PLATFORM(IOS)
279 - (BOOL) _allowsAlternateFullscreen
280 {
281     return _allowsAlternateFullscreen;
282 }
283
284 - (void)_setAllowsAlternateFullscreen:(BOOL)allowed
285 {
286     _allowsAlternateFullscreen = allowed;
287 }
288 #endif
289
290 @end
291
292 #endif // WK_API_ENABLED