initial FB Click to Load (WIP)

DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -3,10 +3,10 @@
     "pins": [
       {
         "package": "BrowserServicesKit",
-        "repositoryURL": "https://github.com/duckduckgo/BrowserServicesKit.git",
+        "repositoryURL": "https://github.com/duckduckgo/BrowserServicesKit",
         "state": {
           "branch": null,
-          "revision": "31f7e314e484bc4aa17f9dd87142a4fee346e158",
+          "revision": "da3f840edb7d9adf681c3fed0b4da6ad841fd288",
           "version": null
         }
       },

DuckDuckGo/BrowserTab/Model/Tab.swift

@@ -21,6 +21,7 @@ import WebKit
 import os
 import Combine
 import BrowserServicesKit
+import TrackerRadarKit
 
 protocol TabDelegate: FileDownloadManagerDelegate {
     func tabWillStartNavigation(_ tab: Tab, isUserInitiated: Bool)
@@ -95,6 +96,7 @@ final class Tab: NSObject {
          webViewConfiguration: WebViewConfiguration? = nil,
          historyCoordinating: HistoryCoordinating = HistoryCoordinator.shared,
          scriptsSource: ScriptSourceProviding = DefaultScriptSourceProvider.shared,
+         contentBlockingManager: ContentBlockerRulesManager = ContentBlocking.contentBlockingManager,
          visitedDomains: Set<String> = Set<String>(),
          title: String? = nil,
          error: Error? = nil,
@@ -108,6 +110,7 @@ final class Tab: NSObject {
         self.faviconManagement = faviconManagement
         self.historyCoordinating = historyCoordinating
         self.scriptsSource = scriptsSource
+        self.contentBlockingManager = contentBlockingManager
         self.visitedDomains = visitedDomains
         self.title = title
         self.error = error
@@ -142,7 +145,9 @@ final class Tab: NSObject {
     var userEnteredUrl = true
 
     var contentChangeEnabled = true
-
+
+    var fbBlockingEnabled = true
+
     @Published private(set) var content: TabContent {
         didSet {
             handleFavicon(oldContent: oldValue)
@@ -296,6 +301,33 @@ final class Tab: NSObject {
         }
     }
 
+    @discardableResult
+    private func setFBProtection(enabled: Bool) -> Bool {
+        guard self.fbBlockingEnabled != enabled else {
+            return false
+        }
+
+        if let fbRules = contentBlockingManager.currentRules.first(where: {
+            $0.name == ContentBlockerRulesLists.Constants.clickToLoadRulesListName
+        }) {
+            if self.fbBlockingEnabled {
+                self.fbBlockingEnabled = false
+                webView.configuration.userContentController.remove(fbRules.rulesList)
+            } else {
+                self.fbBlockingEnabled = true
+                webView.configuration.userContentController.add(fbRules.rulesList)
+            }
+            return true
+        } else {
+            assertionFailure("Missing FB List")
+        }
+        return false
+    }
+
+    private func clickToLoadBlockFB() {
+        setFBProtection(enabled: true)
+    }
+
     private func reloadIfNeeded(shouldLoadInBackground: Bool = false) {
         let url: URL
         switch self.content {
@@ -399,6 +431,8 @@ final class Tab: NSObject {
 
     let scriptsSource: ScriptSourceProviding
     private var userScriptsUpdatedCancellable: AnyCancellable?
+
+    let contentBlockingManager: ContentBlockerRulesManager
 
     lazy var emailManager: EmailManager = {
         let emailManager = EmailManager()
@@ -424,6 +458,7 @@ final class Tab: NSObject {
             userScripts.contextMenuScript.delegate = self
             userScripts.surrogatesScript.delegate = self
             userScripts.contentBlockerRulesScript.delegate = self
+            userScripts.clickToLoadScript.delegate = self
             userScripts.autofillScript.emailDelegate = emailManager
             userScripts.autofillScript.vaultDelegate = vaultManager
             userScripts.pageObserverScript.delegate = self
@@ -591,16 +626,35 @@ extension Tab: ContentBlockerRulesUserScriptDelegate {
         return true
     }
 
+    func contentBlockerRulesUserScriptShouldProcessCTLTrackers(_ script: ContentBlockerRulesUserScript) -> Bool {
+        return fbBlockingEnabled
+    }
+
     func contentBlockerRulesUserScript(_ script: ContentBlockerRulesUserScript, detectedTracker tracker: DetectedTracker) {
         trackerInfo?.add(detectedTracker: tracker)
     }
 
 }
 
-extension Tab: SurrogatesUserScriptDelegate {
+extension Tab: ClickToLoadUserScriptDelegate {
 
+    func clickToLoadUserScriptAllowFB(_ script: UserScript, replyHandler: @escaping (Bool) -> Void) {
+        guard self.fbBlockingEnabled else {
+            replyHandler(true)
+            return
+        }
+
+        if setFBProtection(enabled: false) {
+            replyHandler(true)
+        } else {
+            replyHandler(false)
+        }
+    }
+}
+
+extension Tab: SurrogatesUserScriptDelegate {
     func surrogatesUserScriptShouldProcessTrackers(_ script: SurrogatesUserScript) -> Bool {
-        return true
+         return true
     }
 
     func surrogatesUserScript(_ script: SurrogatesUserScript, detectedTracker tracker: DetectedTracker, withSurrogate host: String) {
@@ -796,6 +850,7 @@ extension Tab: WKNavigationDelegate {
     }
 
     func webView(_ webView: WKWebView, didStartProvisionalNavigation navigation: WKNavigation!) {
+        self.clickToLoadBlockFB()
         delegate?.tabDidStartNavigation(self)
 
         // Unnecessary assignment triggers publishing

DuckDuckGo/BrowserTab/Model/UserContentController.swift

@@ -47,7 +47,9 @@ final class UserContentController: WKUserContentController {
 
             self.removeAllContentRuleLists()
             if self.privacyConfigurationManager.privacyConfig.isEnabled(featureKey: .contentBlocking) {
-                self.add(newRules.rules.rulesList)
+                for rules in newRules.rules {
+                    self.add(rules.rulesList)
+                }
             }
         }
     }

DuckDuckGo/BrowserTab/Model/UserScripts.swift

@@ -30,6 +30,7 @@ final class UserScripts {
     let hoverUserScript = HoverUserScript()
     let debugScript = DebugUserScript()
     let autofillScript = AutofillUserScript()
+    let clickToLoadScript = ClickToLoadUserScript()
 
     let contentBlockerRulesScript: ContentBlockerRulesUserScript
     let surrogatesScript: SurrogatesUserScript
@@ -55,6 +56,7 @@ final class UserScripts {
         pageObserverScript,
         printingUserScript,
         hoverUserScript,
+        clickToLoadScript,
         contentScopeUserScript,
         autofillScript
     ]

DuckDuckGo/Common/Utilities/UserDefaultsWrapper.swift

@@ -30,7 +30,8 @@ public struct UserDefaultsWrapper<T> {
         case configStorageBloomFilterExclusionsEtag = "config.storage.bloomfilter.exclusions.etag"
         case configStorageSurrogatesEtag = "config.storage.surrogates.etag"
         case configStoragePrivacyConfigurationEtag = "config.storage.privacyconfiguration.etag"
-
+        case configFBConfigEtag = "config.storage.fbconfig.etag"
+
         case fireproofDomains = "com.duckduckgo.fireproofing.allowedDomains"
         case unprotectedDomains = "com.duckduckgo.contentblocker.unprotectedDomains"
 

DuckDuckGo/Configuration/ConfigurationDownloading.swift

@@ -43,7 +43,9 @@ enum ConfigurationLocation: String, CaseIterable {
     case surrogates = "https://duckduckgo.com/contentblocking.js?l=surrogates"
     case trackerRadar = "https://staticcdn.duckduckgo.com/trackerblocking/v2.1/tds.json"
     case privacyConfiguration = "https://staticcdn.duckduckgo.com/trackerblocking/config/v1/macos-config.json"
-
+    // In archived repo, to be refactored shortly (https://staticcdn.duckduckgo.com/useragents/social_ctp_configuration.json)
+    case FBConfig = "https://staticcdn.duckduckgo.com/useragents/"
+
 }
 
 final class DefaultConfigurationDownloader: ConfigurationDownloading {

DuckDuckGo/Configuration/ConfigurationStoring.swift

@@ -37,7 +37,8 @@ final class DefaultConfigurationStorage: ConfigurationStoring {
         .bloomFilterSpec: "smarterEncryptionSpec.json",
         .surrogates: "surrogates.txt",
         .privacyConfiguration: "macos-config.json",
-        .trackerRadar: "tracker-radar.json"
+        .trackerRadar: "tracker-radar.json",
+        .FBConfig: "social_ctp_configuration.json"
     ]
 
     static let shared = DefaultConfigurationStorage()
@@ -58,7 +59,10 @@ final class DefaultConfigurationStorage: ConfigurationStoring {
     private var surrogatesEtag: String?
 
     @UserDefaultsWrapper(key: .configStoragePrivacyConfigurationEtag, defaultValue: nil)
-    private var privacyConfigruationEtag: String?
+    private var privacyConfigurationEtag: String?
+
+    @UserDefaultsWrapper(key: .configFBConfigEtag, defaultValue: nil)
+    private var FBConfigEtag: String?
 
     private init() { }
 
@@ -80,7 +84,10 @@ final class DefaultConfigurationStorage: ConfigurationStoring {
             return trackerRadarEtag
 
         case .privacyConfiguration:
-            return privacyConfigruationEtag
+            return privacyConfigurationEtag
+
+        case .FBConfig:
+            return FBConfigEtag
         }
     }
 
@@ -102,7 +109,10 @@ final class DefaultConfigurationStorage: ConfigurationStoring {
             trackerRadarEtag = etag
 
         case .privacyConfiguration:
-            privacyConfigruationEtag = etag
+            privacyConfigurationEtag = etag
+
+        case .FBConfig:
+            return FBConfigEtag = etag
         }
     }
 
@@ -127,7 +137,8 @@ final class DefaultConfigurationStorage: ConfigurationStoring {
         os_log("bloomFilterExcludedDomainsEtag %{public}s", log: .config, type: .default, bloomFilterExcludedDomainsEtag ?? "")
         os_log("surrogatesEtag %{public}s", log: .config, type: .default, surrogatesEtag ?? "")
         os_log("trackerRadarEtag %{public}s", log: .config, type: .default, trackerRadarEtag ?? "")
-        os_log("privacyConfigurationEtag %{public}s", log: .config, type: .default, privacyConfigruationEtag ?? "")
+        os_log("privacyConfigurationEtag %{public}s", log: .config, type: .default, privacyConfigurationEtag ?? "")
+        os_log("FBConfigEtag %{public}s", log: .config, type: .default, FBConfigEtag ?? "")
     }
 
     func fileUrl(for config: ConfigurationLocation) -> URL {

DuckDuckGo/ContentBlocker/ClickToLoadModel.swift

@@ -0,0 +1,55 @@
+//
+//  ClickToLoadModel.swift
+//
+//  Copyright © 2021 DuckDuckGo. All rights reserved.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import Foundation
+
+struct ClickToLoadModel {
+
+    private static func loadFile(name: String) -> String? {
+        let pathPrefix = "social_images/"
+        let fileArgs = name.split(separator: ".")
+        let fileName = String(fileArgs[0])
+        let fileExt = String(fileArgs[1])
+
+        let filePath = pathPrefix + fileName
+
+        let imgURL = Bundle.main.url(
+            forResource: filePath,
+            withExtension: fileExt
+        )
+        if imgURL == nil {
+            return nil
+        }
+        guard let base64String = try? Data(contentsOf: imgURL!).base64EncodedString() else { return nil }
+        let image = "data:image/" + (fileExt == "svg" ? "svg+xml" : fileExt) + ";base64," + base64String
+        return image
+    }
+
+    static let getImage: [String: String] = {
+        return [
+            "dax.png": Self.loadFile(name: "dax.png")!,
+            "loading_light.svg": Self.loadFile(name: "loading_light.svg")!,
+            "loading_dark.svg": Self.loadFile(name: "loading_dark.svg")!,
+            "blocked_facebook_logo.svg": Self.loadFile(name: "blocked_facebook_logo.svg")!,
+            "blocked_group.svg": Self.loadFile(name: "blocked_group.svg")!,
+            "blocked_page.svg": Self.loadFile(name: "blocked_page.svg")!,
+            "blocked_post.svg": Self.loadFile(name: "blocked_post.svg")!,
+            "blocked_video.svg": Self.loadFile(name: "blocked_video.svg")!
+        ]
+    }()
+}

DuckDuckGo/ContentBlocker/ClickToLoadUserScript.swift

@@ -0,0 +1,88 @@
+//
+//  ClickToLoadUserScript.swift
+//
+//  Copyright © 2021 DuckDuckGo. All rights reserved.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import WebKit
+import BrowserServicesKit
+
+protocol ClickToLoadUserScriptDelegate: AnyObject {
+
+    func clickToLoadUserScriptAllowFB(_ script: UserScript, replyHandler: @escaping (Bool) -> Void)
+}
+
+final class ClickToLoadUserScript: NSObject, UserScript, WKScriptMessageHandlerWithReply {
+
+    var injectionTime: WKUserScriptInjectionTime { .atDocumentStart }
+    var forMainFrameOnly: Bool { false }
+    var messageNames: [String] { ["getImage", "enableFacebook", "initClickToLoad" ] }
+    let source: String
+
+    init(scriptSource: ScriptSourceProviding = DefaultScriptSourceProvider.shared) {
+        source = scriptSource.clickToLoadSource
+    }
+
+    weak var delegate: ClickToLoadUserScriptDelegate?
+
+    func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage,
+                               replyHandler: @escaping (Any?, String?) -> Void) {
+        if message.name == "initClickToLoad" {
+            let controller = userContentController as? UserContentController
+            let privacyConfigurationManager = controller!.privacyConfigurationManager
+            let privacyConfiguration = privacyConfigurationManager.privacyConfig
+
+            let protected = privacyConfiguration.isProtected(domain: message.body as? String)
+            if protected {
+                replyHandler(true, nil)
+            } else {
+                replyHandler(false, nil)
+            }
+            return
+        }
+        if message.name == "enableFacebook" {
+            guard let delegate = delegate else { return }
+            delegate.clickToLoadUserScriptAllowFB(self) { (_) -> Void in
+                guard let isLogin = message.body as? Bool else {
+                    replyHandler(nil, nil)
+                    return
+                }
+
+                replyHandler(isLogin, nil)
+            }
+
+            return
+        }
+
+        var image: String
+
+        guard let arg = message.body as? String else {
+            replyHandler(nil, nil)
+            return
+        }
+        if message.name == "getImage" {
+            image = ClickToLoadModel.getImage[arg]!
+        } else {
+            assertionFailure("Uknown message type")
+            replyHandler(nil, nil)
+            return
+        }
+        replyHandler(image, nil)
+    }
+
+    func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
+        assertionFailure("SHOULDN'T BE HERE!")
+    }
+}