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