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