Changeset 168625 in webkit

Timestamp:

May 12, 2014 10:56:42 AM (10 years ago)

Author:

andersca@apple.com

Message:

Replace WKContextSetLocalStorageDirectory with a context configuration getter/setter
​https://bugs.webkit.org/show_bug.cgi?id=132809

Reviewed by Dan Bernstein.

Source/WebKit2:

• UIProcess/API/C/WKContext.cpp:

(WKContextSetLocalStorageDirectory): Deleted.

• UIProcess/API/C/WKContextConfigurationRef.cpp:

(WKContextConfigurationCopyLocalStorageDirectory):
(WKContextConfigurationSetLocalStorageDirectory):

• UIProcess/API/C/WKContextConfigurationRef.h:

Add getters and setters for the local storage directory.

• UIProcess/API/C/WKContextPrivate.h:

Remove WKContextSetLocalStorageDirectory.

• UIProcess/API/Cocoa/WKProcessGroup.mm:

(-[WKProcessGroup initWithInjectedBundleURL:]):
Call WebContext::applyPlatformSpecificConfigurationDefaults.

• UIProcess/API/Cocoa/WKProcessPool.mm:

(-[WKProcessPool _initWithConfiguration:]):
Call WebContext::applyPlatformSpecificConfigurationDefaults (for now).

• UIProcess/APIContextConfiguration.cpp:

(API::ContextConfiguration::webContextConfiguration):
Set the local storage. Also, call WebContext::applyPlatformSpecificConfigurationDefaults.

• UIProcess/APIContextConfiguration.h:

(API::ContextConfiguration::injectedBundlePath):
This should be const.

(API::ContextConfiguration::localStorageDirectory):
(API::ContextConfiguration::setLocalStorageDirectory):
Add getter and setter.

• UIProcess/Storage/StorageManager.cpp:

(WebKit::StorageManager::setLocalStorageDirectory):
ASSERT that the path isn't null.

• UIProcess/WebContext.cpp:

(WebKit::WebContext::applyPlatformSpecificConfigurationDefaults):
New helper function that will fill in platform specific defaults for empty parameters.

(WebKit::WebContext::WebContext):
Get the local storage directory from the configuration.

(WebKit::WebContext::setLocalStorageDirectory): Deleted.
(WebKit::WebContext::localStorageDirectory): Deleted.
These are no longer needed.

• UIProcess/mac/WebContextMac.mm:

(WebKit::WebContext::platformDefaultLocalStorageDirectory):
This should be a static member function.

Tools:

• WebKitTestRunner/TestController.cpp:

(WTR::TestController::initialize):
Set the local storage directory using WKContextConfigurationSetLocalStorageDirectory.

Location:

trunk

Files:

• Source/WebKit2/ChangeLog (modified) (1 diff)
• Source/WebKit2/UIProcess/API/C/WKContext.cpp (modified) (1 diff)
• Source/WebKit2/UIProcess/API/C/WKContextConfigurationRef.cpp (modified) (1 diff)
• Source/WebKit2/UIProcess/API/C/WKContextConfigurationRef.h (modified) (1 diff)
• Source/WebKit2/UIProcess/API/C/WKContextPrivate.h (modified) (1 diff)
• Source/WebKit2/UIProcess/API/Cocoa/WKProcessGroup.mm (modified) (1 diff)
• Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.mm (modified) (1 diff)
• Source/WebKit2/UIProcess/APIContextConfiguration.cpp (modified) (2 diffs)
• Source/WebKit2/UIProcess/APIContextConfiguration.h (modified) (2 diffs)
• Source/WebKit2/UIProcess/Storage/StorageManager.cpp (modified) (1 diff)
• Source/WebKit2/UIProcess/WebContext.cpp (modified) (3 diffs)
• Source/WebKit2/UIProcess/WebContext.h (modified) (5 diffs)
• Source/WebKit2/UIProcess/mac/WebContextMac.mm (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/WebKitTestRunner/TestController.cpp (modified) (2 diffs)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2014-05-11  Anders Carlsson  <andersca@apple.com>
+
+        Replace WKContextSetLocalStorageDirectory with a context configuration getter/setter
+        https://bugs.webkit.org/show_bug.cgi?id=132809
+
+        Reviewed by Dan Bernstein.
+
+        * UIProcess/API/C/WKContext.cpp:
+        (WKContextSetLocalStorageDirectory): Deleted.
+
+        * UIProcess/API/C/WKContextConfigurationRef.cpp:
+        (WKContextConfigurationCopyLocalStorageDirectory):
+        (WKContextConfigurationSetLocalStorageDirectory):
+        * UIProcess/API/C/WKContextConfigurationRef.h:
+        Add getters and setters for the local storage directory.
+
+        * UIProcess/API/C/WKContextPrivate.h:
+        Remove WKContextSetLocalStorageDirectory.
+
+        * UIProcess/API/Cocoa/WKProcessGroup.mm:
+        (-[WKProcessGroup initWithInjectedBundleURL:]):
+        Call WebContext::applyPlatformSpecificConfigurationDefaults.
+
+        * UIProcess/API/Cocoa/WKProcessPool.mm:
+        (-[WKProcessPool _initWithConfiguration:]):
+        Call WebContext::applyPlatformSpecificConfigurationDefaults (for now).
+
+        * UIProcess/APIContextConfiguration.cpp:
+        (API::ContextConfiguration::webContextConfiguration):
+        Set the local storage. Also, call WebContext::applyPlatformSpecificConfigurationDefaults.
+
+        * UIProcess/APIContextConfiguration.h:
+        (API::ContextConfiguration::injectedBundlePath):
+        This should be const.
+
+        (API::ContextConfiguration::localStorageDirectory):
+        (API::ContextConfiguration::setLocalStorageDirectory):
+        Add getter and setter.
+
+        * UIProcess/Storage/StorageManager.cpp:
+        (WebKit::StorageManager::setLocalStorageDirectory):
+        ASSERT that the path isn't null.
+
+        * UIProcess/WebContext.cpp:
+        (WebKit::WebContext::applyPlatformSpecificConfigurationDefaults):
+        New helper function that will fill in platform specific defaults for empty parameters.
+
+        (WebKit::WebContext::WebContext):
+        Get the local storage directory from the configuration.
+
+        (WebKit::WebContext::setLocalStorageDirectory): Deleted.
+        (WebKit::WebContext::localStorageDirectory): Deleted.
+        These are no longer needed.
+
+        * UIProcess/mac/WebContextMac.mm:
+        (WebKit::WebContext::platformDefaultLocalStorageDirectory):
+        This should be a static member function.
+
 2014-05-12  Martin Hodovan  <mhodovan.u-szeged@partner.samsung.com>
 

trunk/Source/WebKit2/UIProcess/API/C/WKContext.cpp

@@ -493 +493 @@
 }
 
-void WKContextSetLocalStorageDirectory(WKContextRef contextRef, WKStringRef localStorageDirectory)
-{
-    toImpl(contextRef)->setLocalStorageDirectory(toImpl(localStorageDirectory)->string());
-}
-
 WK_EXPORT void WKContextSetDiskCacheDirectory(WKContextRef contextRef, WKStringRef diskCacheDirectory)
 {

trunk/Source/WebKit2/UIProcess/API/C/WKContextConfigurationRef.cpp

@@ -46 +46 @@
     toImpl(configuration)->setInjectedBundlePath(toImpl(injectedBundlePath)->string());
 }
+
+WKStringRef WKContextConfigurationCopyLocalStorageDirectory(WKContextConfigurationRef configuration)
+{
+    return toCopiedAPI(toImpl(configuration)->localStorageDirectory());
+}
+
+void WKContextConfigurationSetLocalStorageDirectory(WKContextConfigurationRef configuration, WKStringRef localStorageDirectory)
+{
+    toImpl(configuration)->setLocalStorageDirectory(toImpl(localStorageDirectory)->string());
+}

trunk/Source/WebKit2/UIProcess/API/C/WKContextConfigurationRef.h

@@ -38 +38 @@
 WK_EXPORT void WKContextConfigurationSetInjectedBundlePath(WKContextConfigurationRef configuration, WKStringRef injectedBundlePath);
 
+WK_EXPORT WKStringRef WKContextConfigurationCopyLocalStorageDirectory(WKContextConfigurationRef configuration);
+WK_EXPORT void WKContextConfigurationSetLocalStorageDirectory(WKContextConfigurationRef configuration, WKStringRef localStorageDirectory);
+
 #ifdef __cplusplus
 }

trunk/Source/WebKit2/UIProcess/API/C/WKContextPrivate.h

@@ -65 +65 @@
 WK_EXPORT void WKContextSetApplicationCacheDirectory(WKContextRef context, WKStringRef applicationCacheDirectory);
 WK_EXPORT void WKContextSetDatabaseDirectory(WKContextRef context, WKStringRef databaseDirectory);
-WK_EXPORT void WKContextSetLocalStorageDirectory(WKContextRef context, WKStringRef localStorageDirectory);
 WK_EXPORT void WKContextSetDiskCacheDirectory(WKContextRef context, WKStringRef diskCacheDirectory);
 WK_EXPORT void WKContextSetCookieStorageDirectory(WKContextRef context, WKStringRef cookieStorageDirectory);

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessGroup.mm

@@ -193 +193 @@
     webContextConfiguration.injectedBundlePath = bundleURL ? String(bundleURL.path) : String();
 
+    WebContext::applyPlatformSpecificConfigurationDefaults(webContextConfiguration);
+
     _context = WebContext::create(std::move(webContextConfiguration));
 

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.mm

@@ -126 +126 @@
     }
 
+    // FIXME: These are legacy configuration defaults and should not be applied when creating a WKProcessPool.
+    WebKit::WebContext::applyPlatformSpecificConfigurationDefaults(webContextConfiguration);
+
     API::Object::constructInWrapper<WebKit::WebContext>(self, std::move(webContextConfiguration));
     _context->setHistoryClient(std::make_unique<WebKit::HistoryClient>());

trunk/Source/WebKit2/UIProcess/APIContextConfiguration.cpp

@@ -28 +28 @@
 
 #include "WebContext.h"
+
 namespace API {
 
@@ -43 +44 @@
 
     configuration.injectedBundlePath = m_injectedBundlePath;
+    configuration.localStorageDirectory = m_localStorageDirectory;
+
+    WebKit::WebContext::applyPlatformSpecificConfigurationDefaults(configuration);
 
     return configuration;

trunk/Source/WebKit2/UIProcess/APIContextConfiguration.h

@@ -44 +44 @@
     virtual ~ContextConfiguration();
 
-    String injectedBundlePath() { return m_injectedBundlePath; }
+    String injectedBundlePath() const { return m_injectedBundlePath; }
     void setInjectedBundlePath(const String& injectedBundlePath) { m_injectedBundlePath = injectedBundlePath; }
+
+    String localStorageDirectory() const { return m_localStorageDirectory; }
+    void setLocalStorageDirectory(const String& localStorageDirectory) { m_localStorageDirectory = localStorageDirectory; }
 
     WebKit::WebContextConfiguration webContextConfiguration() const;
@@ -53 +56 @@
 
     String m_injectedBundlePath;
+    String m_localStorageDirectory;
 };
 

trunk/Source/WebKit2/UIProcess/Storage/StorageManager.cpp

@@ -388 +388 @@
 void StorageManager::setLocalStorageDirectory(const String& localStorageDirectory)
 {
+    ASSERT(!localStorageDirectory.isNull());
+
     m_localStorageDatabaseTracker->setLocalStorageDirectory(localStorageDirectory);
 }

trunk/Source/WebKit2/UIProcess/WebContext.cpp

@@ -118 +118 @@
 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, webContextCounter, ("WebContext"));
 
+void WebContext::applyPlatformSpecificConfigurationDefaults(WebContextConfiguration& configuration)
+{
+    // FIXME: This function should not be needed; all ports should make sure that the configuration has the right
+    // values, and then we should get rid of the platform specific defaults inside WebContext.
+
+    if (!configuration.localStorageDirectory)
+        configuration.localStorageDirectory = platformDefaultLocalStorageDirectory();
+}
+
 PassRefPtr<WebContext> WebContext::create(WebContextConfiguration configuration)
 {
@@ -215 +224 @@
 #endif
 
-    m_storageManager->setLocalStorageDirectory(localStorageDirectory());
+    m_storageManager->setLocalStorageDirectory(configuration.localStorageDirectory);
 }
 
@@ -1140 +1149 @@
 }
 
-void WebContext::setLocalStorageDirectory(const String& directory)
-{
-    m_overrideLocalStorageDirectory = directory;
-    m_storageManager->setLocalStorageDirectory(localStorageDirectory());
-}
-
-String WebContext::localStorageDirectory() const
-{
-    if (!m_overrideLocalStorageDirectory.isEmpty())
-        return m_overrideLocalStorageDirectory;
-
-    return platformDefaultLocalStorageDirectory();
-}
-
 String WebContext::diskCacheDirectory() const
 {

trunk/Source/WebKit2/UIProcess/WebContext.h

@@ -98 +98 @@
 struct WebContextConfiguration {
     String injectedBundlePath;
+    String localStorageDirectory;
 };
 
@@ -106 +107 @@
     {
 public:
+    static void applyPlatformSpecificConfigurationDefaults(WebContextConfiguration&);
+
     WebContext(WebContextConfiguration);
         
@@ -244 +247 @@
     void setIconDatabasePath(const String&);
     String iconDatabasePath() const;
-    void setLocalStorageDirectory(const String&);
     void setDiskCacheDirectory(const String& dir) { m_overrideDiskCacheDirectory = dir; }
     void setCookieStorageDirectory(const String& dir) { m_overrideCookieStorageDirectory = dir; }
@@ -413 +415 @@
     String platformDefaultIconDatabasePath() const;
 
-    String localStorageDirectory() const;
-    String platformDefaultLocalStorageDirectory() const;
+    static String platformDefaultLocalStorageDirectory();
 
     String diskCacheDirectory() const;
@@ -516 +517 @@
     String m_overrideDatabaseDirectory;
     String m_overrideIconDatabasePath;
-    String m_overrideLocalStorageDirectory;
     String m_overrideDiskCacheDirectory;
     String m_overrideCookieStorageDirectory;

trunk/Source/WebKit2/UIProcess/mac/WebContextMac.mm

@@ -277 +277 @@
 }
 
-String WebContext::platformDefaultLocalStorageDirectory() const
+String WebContext::platformDefaultLocalStorageDirectory()
 {
     NSString *localStorageDirectory = [[NSUserDefaults standardUserDefaults] objectForKey:WebStorageDirectoryDefaultsKey];

trunk/Tools/ChangeLog

@@ +1 @@
+2014-05-11  Anders Carlsson  <andersca@apple.com>
+
+        Replace WKContextSetLocalStorageDirectory with a context configuration getter/setter
+        https://bugs.webkit.org/show_bug.cgi?id=132809
+
+        Reviewed by Dan Bernstein.
+
+        * WebKitTestRunner/TestController.cpp:
+        (WTR::TestController::initialize):
+        Set the local storage directory using WKContextConfigurationSetLocalStorageDirectory.
+
 2014-05-12  Carlos Garcia Campos  <cgarcia@igalia.com>
 

trunk/Tools/WebKitTestRunner/TestController.cpp

@@ -331 +331 @@
     WKContextConfigurationSetInjectedBundlePath(configuration.get(), injectedBundlePath());
 
+    if (const char* dumpRenderTreeTemp = libraryPathForTesting()) {
+        String temporaryFolder = String::fromUTF8(dumpRenderTreeTemp);
+
+        const char separator = '/';
+
+        WKContextConfigurationSetLocalStorageDirectory(configuration.get(), toWK(temporaryFolder + separator + "LocalStorage").get());
+    }
+
     m_context = adoptWK(WKContextCreateWithConfiguration(configuration.get()));
     m_geolocationProvider = adoptPtr(new GeolocationProviderMock(m_context.get()));
@@ -342 +350 @@
         String temporaryFolder = String::fromUTF8(dumpRenderTreeTemp);
 
-        // WebCore::pathByAppendingComponent is not used here because of the namespace,
-        // which leads us to this ugly #ifdef and file path concatenation.
         const char separator = '/';
 
+        // FIXME: These should be migrated to WKContextConfigurationRef.
         WKContextSetApplicationCacheDirectory(m_context.get(), toWK(temporaryFolder + separator + "ApplicationCache").get());
         WKContextSetDatabaseDirectory(m_context.get(), toWK(temporaryFolder + separator + "Databases").get());
-        WKContextSetLocalStorageDirectory(m_context.get(), toWK(temporaryFolder + separator + "LocalStorage").get());
         WKContextSetDiskCacheDirectory(m_context.get(), toWK(temporaryFolder + separator + "Cache").get());
         WKContextSetCookieStorageDirectory(m_context.get(), toWK(temporaryFolder + separator + "Cookies").get());