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     T* peek()
  60     {
  61         return m_value.get();
  62     }
  63
  64 private:
  65     bool m_isInitialized = false;
  66     RetainPtr<T> m_value;
  67 };
  68
  69 @implementation WKWebViewConfiguration {
  70     LazyInitialized<WKProcessPool> _processPool;
  71     LazyInitialized<WKPreferences> _preferences;
  72     LazyInitialized<WKUserContentController> _userContentController;
  73     LazyInitialized<_WKVisitedLinkProvider> _visitedLinkProvider;
  74     LazyInitialized<_WKWebsiteDataStore> _websiteDataStore;
  75     WebKit::WeakObjCPtr<WKWebView> _relatedWebView;
  76     WebKit::WeakObjCPtr<WKWebView> _alternateWebViewForNavigationGestures;
  77     RetainPtr<NSString> _groupIdentifier;
  78 #if PLATFORM(IOS)
  79     LazyInitialized<WKWebViewContentProviderRegistry> _contentProviderRegistry;
  80 #endif
  81 }
  82
  83 - (instancetype)init
  84 {
  85     if (!(self = [super init]))
  86         return nil;
  87
  88 #if PLATFORM(IOS)
  89     _mediaPlaybackRequiresUserAction = YES;
  90     _mediaPlaybackAllowsAirPlay = YES;
  91 #endif
  92
  93     return self;
  94 }
  95
  96 - (NSString *)description
  97 {
  98     return [NSString stringWithFormat:@"<%@: %p; processPool = %@; preferences = %@>", NSStringFromClass(self.class), self, self.processPool, self.preferences];
  99 }
 100
 101 - (id)copyWithZone:(NSZone *)zone
 102 {
 103     WKWebViewConfiguration *configuration = [[[self class] allocWithZone:zone] init];
 104
 105     configuration.processPool = self.processPool;
 106     configuration.preferences = self.preferences;
 107     configuration.userContentController = self.userContentController;
 108     configuration._visitedLinkProvider = self._visitedLinkProvider;
 109     configuration._websiteDataStore = self._websiteDataStore;
 110     configuration._relatedWebView = _relatedWebView.get().get();
 111     configuration._alternateWebViewForNavigationGestures = _alternateWebViewForNavigationGestures.get().get();
 112 #if PLATFORM(IOS)
 113     configuration._contentProviderRegistry = self._contentProviderRegistry;
 114 #endif
 115
 116     configuration->_suppressesIncrementalRendering = self->_suppressesIncrementalRendering;
 117 #if PLATFORM(IOS)
 118     configuration->_allowsInlineMediaPlayback = self->_allowsInlineMediaPlayback;
 119     configuration->_mediaPlaybackRequiresUserAction = self->_mediaPlaybackRequiresUserAction;
 120     configuration->_mediaPlaybackAllowsAirPlay = self->_mediaPlaybackAllowsAirPlay;
 121     configuration->_selectionGranularity = self->_selectionGranularity;
 122 #endif
 123
 124     return configuration;
 125 }
 126
 127 - (WKProcessPool *)processPool
 128 {
 129     return _processPool.get([] { return adoptNS([[WKProcessPool alloc] init]); });
 130 }
 131
 132 - (void)setProcessPool:(WKProcessPool *)processPool
 133 {
 134     _processPool.set(processPool);
 135 }
 136
 137 - (WKPreferences *)preferences
 138 {
 139     return _preferences.get([] { return adoptNS([[WKPreferences alloc] init]); });
 140 }
 141
 142 - (void)setPreferences:(WKPreferences *)preferences
 143 {
 144     _preferences.set(preferences);
 145 }
 146
 147 - (WKUserContentController *)userContentController
 148 {
 149     return _userContentController.get([] { return adoptNS([[WKUserContentController alloc] init]); });
 150 }
 151
 152 - (void)setUserContentController:(WKUserContentController *)userContentController
 153 {
 154     _userContentController.set(userContentController);
 155 }
 156
 157 - (_WKVisitedLinkProvider *)_visitedLinkProvider
 158 {
 159     return _visitedLinkProvider.get([] { return adoptNS([[_WKVisitedLinkProvider alloc] init]); });
 160 }
 161
 162 - (void)_setVisitedLinkProvider:(_WKVisitedLinkProvider *)visitedLinkProvider
 163 {
 164     _visitedLinkProvider.set(visitedLinkProvider);
 165 }
 166
 167 - (_WKWebsiteDataStore *)_websiteDataStore
 168 {
 169     return _websiteDataStore.get([] { return [_WKWebsiteDataStore defaultDataStore]; });
 170 }
 171
 172 - (void)_setWebsiteDataStore:(_WKWebsiteDataStore *)websiteDataStore
 173 {
 174     _websiteDataStore.set(websiteDataStore);
 175 }
 176
 177 #if PLATFORM(IOS)
 178 - (WKWebViewContentProviderRegistry *)_contentProviderRegistry
 179 {
 180     return _contentProviderRegistry.get([] { return adoptNS([[WKWebViewContentProviderRegistry alloc] init]); });
 181 }
 182
 183 - (void)_setContentProviderRegistry:(WKWebViewContentProviderRegistry *)registry
 184 {
 185     _contentProviderRegistry.set(registry);
 186 }
 187 #endif
 188
 189 - (void)_validate
 190 {
 191     if (!self.processPool)
 192         [NSException raise:NSInvalidArgumentException format:@"configuration.processPool is nil"];
 193
 194     if (!self.preferences)
 195         [NSException raise:NSInvalidArgumentException format:@"configuration.preferences is nil"];
 196
 197     if (!self.userContentController)
 198         [NSException raise:NSInvalidArgumentException format:@"configuration.userContentController is nil"];
 199
 200     if (!self._visitedLinkProvider)
 201         [NSException raise:NSInvalidArgumentException format:@"configuration._visitedLinkProvider is nil"];
 202
 203     if (!self._websiteDataStore)
 204         [NSException raise:NSInvalidArgumentException format:@"configuration._websiteDataStore is nil"];
 205
 206 #if PLATFORM(IOS)
 207     if (!self._contentProviderRegistry)
 208         [NSException raise:NSInvalidArgumentException format:@"configuration._contentProviderRegistry is nil"];
 209 #endif
 210 }
 211
 212 @end
 213
 214 @implementation WKWebViewConfiguration (WKPrivate)
 215
 216 - (WKWebView *)_relatedWebView
 217 {
 218     return _relatedWebView.getAutoreleased();
 219 }
 220
 221 - (void)_setRelatedWebView:(WKWebView *)relatedWebView
 222 {
 223     _relatedWebView = relatedWebView;
 224 }
 225
 226 - (WKWebView *)_alternateWebViewForNavigationGestures
 227 {
 228     return _alternateWebViewForNavigationGestures.getAutoreleased();
 229 }
 230
 231 - (void)_setAlternateWebViewForNavigationGestures:(WKWebView *)alternateView
 232 {
 233     _alternateWebViewForNavigationGestures = alternateView;
 234 }
 235
 236 - (NSString *)_groupIdentifier
 237 {
 238     return _groupIdentifier.get();
 239 }
 240
 241 - (void)_setGroupIdentifier:(NSString *)groupIdentifier
 242 {
 243     _groupIdentifier = groupIdentifier;
 244 }
 245
 246 @end
 247
 248 #endif // WK_API_ENABLED