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