Changeset 287377 in webkit

Timestamp:

Dec 22, 2021, 3:55:10 PM (5 years ago)

Author:

sihui_liu@apple.com

Message:

WebsiteDataStore::excludeDirectoryFromBackup should set attribute for existing directories
​https://bugs.webkit.org/show_bug.cgi?id=234404

Reviewed by Youenn Fablet.

Source/WebKit:

createDirectoryAtURL returning false means directory cannot be created, but the cause can be that directory
already exists; so we should set exclude attribute on the directory no matter createDirectoryAtURL returns true
or false. Also, we can use existing FileSystem functions.

API test: WKWebView.LocalStorageDirectoryExcludedFromBackup

• UIProcess/WebsiteData/Cocoa/WebsiteDataStoreCocoa.mm:

(WebKit::WebsiteDataStore::excludeDirectoryFromBackup): Deleted.

• UIProcess/WebsiteData/WebsiteDataStore.cpp:

(WebKit::WebsiteDataStore::parameters):

• UIProcess/WebsiteData/WebsiteDataStore.h:

Source/WTF:

• wtf/FileSystem.cpp:

(WTF::FileSystemImpl::excludeFromBackup):
(WTF::FileSystemImpl::canExcludeFromBackup): Deleted.

• wtf/FileSystem.h:
• wtf/cocoa/FileSystemCocoa.mm:

(WTF::FileSystemImpl::excludeFromBackup):

• wtf/mac/FileSystemMac.mm:

(WTF::FileSystem::canExcludeFromBackup): Deleted.
(WTF::FileSystem::excludeFromBackup): Deleted.

Tools:

• TestWebKitAPI/Tests/WebKitCocoa/LocalStoragePersistence.mm:

(TEST):

Location:

trunk

Files:

• Source/WTF/ChangeLog (modified) (1 diff)
• Source/WTF/wtf/FileSystem.cpp (modified) (2 diffs)
• Source/WTF/wtf/FileSystem.h (modified) (1 diff)
• Source/WTF/wtf/cocoa/FileSystemCocoa.mm (modified) (1 diff)
• Source/WTF/wtf/mac/FileSystemMac.mm (modified) (1 diff)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/WebsiteData/Cocoa/WebsiteDataStoreCocoa.mm (modified) (1 diff)
• Source/WebKit/UIProcess/WebsiteData/WebsiteDataStore.cpp (modified) (1 diff)
• Source/WebKit/UIProcess/WebsiteData/WebsiteDataStore.h (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/LocalStoragePersistence.mm (modified) (2 diffs)

trunk/Source/WTF/ChangeLog

@@ +1 @@
+2021-12-22  Sihui Liu  <sihui_liu@apple.com>
+
+        WebsiteDataStore::excludeDirectoryFromBackup should set attribute for existing directories
+        https://bugs.webkit.org/show_bug.cgi?id=234404
+
+        Reviewed by Youenn Fablet.
+
+        * wtf/FileSystem.cpp:
+        (WTF::FileSystemImpl::excludeFromBackup):
+        (WTF::FileSystemImpl::canExcludeFromBackup): Deleted.
+        * wtf/FileSystem.h:
+        * wtf/cocoa/FileSystemCocoa.mm:
+        (WTF::FileSystemImpl::excludeFromBackup):
+        * wtf/mac/FileSystemMac.mm:
+        (WTF::FileSystem::canExcludeFromBackup): Deleted.
+        (WTF::FileSystem::excludeFromBackup): Deleted.
+
 2021-12-22  Commit Queue  <commit-queue@webkit.org>
 

trunk/Source/WTF/wtf/FileSystem.cpp

@@ -306 +306 @@
 }
 
-bool canExcludeFromBackup()
-{
-    return false;
-}
-
-bool excludeFromBackup(const String&)
-{
-    return false;
-}
-
 #endif
 
@@ -427 +417 @@
 
 #if !PLATFORM(COCOA)
+
 String createTemporaryZipArchive(const String&)
 {
     return { };
 }
+
+bool excludeFromBackup(const String&)
+{
+    return false;
+}
+
 #endif
 

trunk/Source/WTF/wtf/FileSystem.h

@@ -135 +135 @@
 
 WTF_EXPORT_PRIVATE void setMetadataURL(const String& path, const String& urlString, const String& referrer = { });
-
-bool canExcludeFromBackup(); // Returns true if any file can ever be excluded from backup.
-bool excludeFromBackup(const String&); // Returns true if successful.
+WTF_EXPORT_PRIVATE bool excludeFromBackup(const String&); // Returns true if successful.
 
 WTF_EXPORT_PRIVATE Vector<String> listDirectory(const String& path); // Returns file names, not full paths.

trunk/Source/WTF/wtf/cocoa/FileSystemCocoa.mm

@@ -223 +223 @@
 #endif
 
+bool excludeFromBackup(const String& path)
+{
+    NSError *error;
+    if (![[NSURL fileURLWithPath:(NSString *)path isDirectory:YES] setResourceValue:@YES forKey:NSURLIsExcludedFromBackupKey error:&error]) {
+        LOG_ERROR("Cannot exclude path '%s' from backup with error '%@'", path.utf8().data(), error.localizedDescription);
+        return false;
+    }
+
+    return true;
+}
+
 } // namespace FileSystemImpl
 } // namespace WTF

trunk/Source/WTF/wtf/mac/FileSystemMac.mm

@@ -58 +58 @@
 }
 
-bool FileSystem::canExcludeFromBackup()
-{
-    return true;
-}
-
-bool FileSystem::excludeFromBackup(const String& path)
-{
-    // It is critical to pass FALSE for excludeByPath because excluding by path requires root privileges.
-    CSBackupSetItemExcluded(FileSystem::pathAsURL(path).get(), TRUE, FALSE);
-    return true;
-}
-
 } // namespace WTF
 

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-12-22  Sihui Liu  <sihui_liu@apple.com>
+
+        WebsiteDataStore::excludeDirectoryFromBackup should set attribute for existing directories
+        https://bugs.webkit.org/show_bug.cgi?id=234404
+
+        Reviewed by Youenn Fablet.
+
+        createDirectoryAtURL returning false means directory cannot be created, but the cause can be that directory 
+        already exists; so we should set exclude attribute on the directory no matter createDirectoryAtURL returns true
+        or false. Also, we can use existing FileSystem functions. 
+
+        API test: WKWebView.LocalStorageDirectoryExcludedFromBackup
+
+        * UIProcess/WebsiteData/Cocoa/WebsiteDataStoreCocoa.mm:
+        (WebKit::WebsiteDataStore::excludeDirectoryFromBackup): Deleted.
+        * UIProcess/WebsiteData/WebsiteDataStore.cpp:
+        (WebKit::WebsiteDataStore::parameters):
+        * UIProcess/WebsiteData/WebsiteDataStore.h:
+
 2021-12-22  Alex Christensen  <achristensen@webkit.org>
 

trunk/Source/WebKit/UIProcess/WebsiteData/Cocoa/WebsiteDataStoreCocoa.mm

@@ -641 +641 @@
 }
 
-#if PLATFORM(IOS_FAMILY)
-
-void WebsiteDataStore::excludeDirectoryFromBackup(const String& directory)
-{
-    NSURL *url = [NSURL fileURLWithPath:(NSString *)directory isDirectory:YES];
-    if ([[NSFileManager defaultManager] createDirectoryAtURL:url withIntermediateDirectories:YES attributes:nil error:nullptr])
-        [url setResourceValue:@YES forKey:NSURLIsExcludedFromBackupKey error:nil];
-}
-
-#endif
-
-}
+}

trunk/Source/WebKit/UIProcess/WebsiteData/WebsiteDataStore.cpp

@@ -1915 +1915 @@
     if (!localStorageDirectory.isEmpty()) {
         parameters.localStorageDirectory = localStorageDirectory;
-#if PLATFORM(IOS_FAMILY)
-        excludeDirectoryFromBackup(localStorageDirectory);
-#endif
         // FIXME: SandboxExtension::createHandleForReadWriteDirectory resolves the directory, but that has already been done. Remove this duplicate work.
         if (auto handle = SandboxExtension::createHandleForReadWriteDirectory(localStorageDirectory))
             parameters.localStorageDirectoryExtensionHandle = WTFMove(*handle);
+#if PLATFORM(IOS_FAMILY)
+        FileSystem::makeAllDirectories(localStorageDirectory);
+        FileSystem::excludeFromBackup(localStorageDirectory);
+#endif
     }
 

trunk/Source/WebKit/UIProcess/WebsiteData/WebsiteDataStore.h

@@ -373 +373 @@
     void countNonDefaultSessionSets(CompletionHandler<void(size_t)>&&);
 
-#if PLATFORM(IOS_FAMILY)
-    void excludeDirectoryFromBackup(const String& directory);
-#endif
-
 private:
     enum class ForceReinitialization : bool { No, Yes };

trunk/Tools/ChangeLog

@@ +1 @@
+2021-12-22  Sihui Liu  <sihui_liu@apple.com>
+
+        WebsiteDataStore::excludeDirectoryFromBackup should set attribute for existing directories
+        https://bugs.webkit.org/show_bug.cgi?id=234404
+
+        Reviewed by Youenn Fablet.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/LocalStoragePersistence.mm:
+        (TEST):
+
 2021-12-22  Alex Christensen  <achristensen@webkit.org>
 

trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/LocalStoragePersistence.mm

@@ -40 +40 @@
 #import <WebKit/_WKProcessPoolConfiguration.h>
 #import <WebKit/_WKUserStyleSheet.h>
+#import <WebKit/_WKWebsiteDataStoreConfiguration.h>
 #import <wtf/RetainPtr.h>
 #import <wtf/text/WTFString.h>
@@ -453 +454 @@
     runTest(false);
 }
+
+#if PLATFORM(IOS_FAMILY)
+
+TEST(WKWebView, LocalStorageDirectoryExcludedFromBackup)
+{
+    auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]);
+    RetainPtr<NSURL> url = [[[configuration websiteDataStore] _configuration] _webStorageDirectory];
+    // Create a directory and make it not excluded.
+    [[NSFileManager defaultManager] createDirectoryAtURL:url.get() withIntermediateDirectories:YES attributes:nil error:nullptr];
+    [url.get() setResourceValue:@NO forKey:NSURLIsExcludedFromBackupKey error:nil];
+    NSNumber *isDirectoryExcluded = nil;
+    EXPECT_TRUE([url.get() getResourceValue:&isDirectoryExcluded forKey:NSURLIsExcludedFromBackupKey error:nil]);
+    EXPECT_FALSE(isDirectoryExcluded.boolValue);
+
+    auto delegate = adoptNS([[LocalStorageNavigationDelegate alloc] init]);
+    auto webView = adoptNS([[WKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]);
+    [webView setNavigationDelegate:delegate.get()];
+    didFinishNavigationBoolean = false;
+    NSURLRequest *request = [NSURLRequest requestWithURL:[[NSBundle mainBundle] URLForResource:@"simple" withExtension:@"html" subdirectory:@"TestWebKitAPI.resources"]];
+    [webView loadRequest:request];
+    TestWebKitAPI::Util::run(&didFinishNavigationBoolean);
+
+    bool finishedRunningScript = false;
+    [webView evaluateJavaScript:@"localStorage.getItem('key');" completionHandler: [&] (id result, NSError *) {
+        finishedRunningScript = true;
+    }];
+    TestWebKitAPI::Util::run(&finishedRunningScript);
+
+    // Create new url that has updated value.
+    url = [[[configuration websiteDataStore] _configuration] _webStorageDirectory];
+    EXPECT_TRUE([url.get() getResourceValue:&isDirectoryExcluded forKey:NSURLIsExcludedFromBackupKey error:nil]);
+    EXPECT_TRUE(isDirectoryExcluded.boolValue);
+}
+
+#endif