-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f41b365
commit a64d9ed
Showing
5 changed files
with
308 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
173 changes: 173 additions & 0 deletions
173
...ckages/DataBrokerProtection/Sources/DataBrokerProtection/DebugUI/DebugScanOperation.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| // | ||
| // DebugScanOperation.swift | ||
| // | ||
| // Copyright © 2023 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 | ||
| import WebKit | ||
| import BrowserServicesKit | ||
| import UserScript | ||
| import Common | ||
|
|
||
| struct DebugScanReturnValue { | ||
| let brokerURL: String | ||
| let extractedProfiles: [ExtractedProfile] | ||
| let error: Error? | ||
|
|
||
| init(brokerURL: String, | ||
| extractedProfiles: [ExtractedProfile] = [ExtractedProfile](), | ||
| error: Error? = nil) { | ||
| self.brokerURL = brokerURL | ||
| self.extractedProfiles = extractedProfiles | ||
| self.error = error | ||
| } | ||
| } | ||
|
|
||
| final class DebugScanOperation: DataBrokerOperation { | ||
| typealias ReturnValue = DebugScanReturnValue | ||
| typealias InputValue = Void | ||
|
|
||
| let privacyConfig: PrivacyConfigurationManaging | ||
| let prefs: ContentScopeProperties | ||
| let query: BrokerProfileQueryData | ||
| let emailService: EmailServiceProtocol | ||
| let captchaService: CaptchaServiceProtocol | ||
| var webViewHandler: WebViewHandler? | ||
| var actionsHandler: ActionsHandler? | ||
| var continuation: CheckedContinuation<DebugScanReturnValue, Error>? | ||
| var extractedProfile: ExtractedProfile? | ||
| var stageCalculator: StageDurationCalculator? | ||
| private let operationAwaitTime: TimeInterval | ||
| let shouldRunNextStep: () -> Bool | ||
| var retriesCountOnError: Int = 0 | ||
| var scanURL: String? | ||
|
|
||
| private let fileManager = FileManager.default | ||
| private let debugScanContentPath: String? | ||
|
|
||
| init(privacyConfig: PrivacyConfigurationManaging, | ||
| prefs: ContentScopeProperties, | ||
| query: BrokerProfileQueryData, | ||
| emailService: EmailServiceProtocol = EmailService(), | ||
| captchaService: CaptchaServiceProtocol = CaptchaService(), | ||
| operationAwaitTime: TimeInterval = 3, | ||
| shouldRunNextStep: @escaping () -> Bool | ||
| ) { | ||
| self.privacyConfig = privacyConfig | ||
| self.prefs = prefs | ||
| self.query = query | ||
| self.emailService = emailService | ||
| self.captchaService = captchaService | ||
| self.operationAwaitTime = operationAwaitTime | ||
| self.shouldRunNextStep = shouldRunNextStep | ||
| if let desktopPath = fileManager.urls(for: .desktopDirectory, in: .userDomainMask).first?.relativePath { | ||
| self.debugScanContentPath = desktopPath + "/PIR-Debug" | ||
| } else { | ||
| self.debugScanContentPath = nil | ||
| } | ||
| } | ||
|
|
||
| func run(inputValue: Void, | ||
| webViewHandler: WebViewHandler? = nil, | ||
| actionsHandler: ActionsHandler? = nil, | ||
| stageCalculator: StageDurationCalculator, // We do not need it for scans - for now. | ||
| showWebView: Bool) async throws -> DebugScanReturnValue { | ||
| try await withCheckedThrowingContinuation { continuation in | ||
| self.continuation = continuation | ||
| Task { | ||
| await initialize(handler: webViewHandler, isFakeBroker: query.dataBroker.isFakeBroker, showWebView: showWebView) | ||
|
|
||
| do { | ||
| let scanStep = try query.dataBroker.scanStep() | ||
| if let actionsHandler = actionsHandler { | ||
| self.actionsHandler = actionsHandler | ||
| } else { | ||
| self.actionsHandler = ActionsHandler(step: scanStep) | ||
| } | ||
| if self.shouldRunNextStep() { | ||
| await executeNextStep() | ||
| } else { | ||
| failed(with: DataBrokerProtectionError.cancelled) | ||
| } | ||
| } catch { | ||
| failed(with: DataBrokerProtectionError.unknown(error.localizedDescription)) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func runNextAction(_ action: Action) async { | ||
| if action as? ExtractAction != nil { | ||
| do { | ||
| if let path = self.debugScanContentPath { | ||
| try await webViewHandler?.takeSnaphost(path: path, fileName: "\(query.dataBroker.name).png") | ||
| try await webViewHandler?.saveHTML(path: path, fileName: "\(query.dataBroker.name).html") | ||
| } | ||
| } catch { | ||
| print("Error: \(error)") | ||
| } | ||
| } | ||
|
|
||
| if let extractedProfile = self.extractedProfile { | ||
| await webViewHandler?.execute(action: action, data: .extractedProfile(extractedProfile)) | ||
| } else { | ||
| await webViewHandler?.execute(action: action, data: .profile(query.profileQuery)) | ||
| } | ||
| } | ||
|
|
||
| func extractedProfiles(profiles: [ExtractedProfile]) async { | ||
| if let scanURL = self.scanURL { | ||
| let debugScanReturnValue = DebugScanReturnValue(brokerURL: scanURL, extractedProfiles: profiles) | ||
| complete(debugScanReturnValue) | ||
| } | ||
|
|
||
| await executeNextStep() | ||
| } | ||
|
|
||
| func completeWith(error: Error) async { | ||
| if let scanURL = self.scanURL { | ||
| let debugScanReturnValue = DebugScanReturnValue(brokerURL: scanURL, error: error) | ||
| complete(debugScanReturnValue) | ||
| } | ||
|
|
||
| await executeNextStep() | ||
| } | ||
|
|
||
| func executeNextStep() async { | ||
| retriesCountOnError = 0 // We reset the retries on error when it is successful | ||
| os_log("SCAN Waiting %{public}f seconds...", log: .action, operationAwaitTime) | ||
|
|
||
| try? await Task.sleep(nanoseconds: UInt64(operationAwaitTime) * 1_000_000_000) | ||
|
|
||
| if let action = actionsHandler?.nextAction() { | ||
| os_log("Next action: %{public}@", log: .action, String(describing: action.actionType.rawValue)) | ||
| await runNextAction(action) | ||
| } else { | ||
| os_log("Releasing the web view", log: .action) | ||
| await webViewHandler?.finish() // If we executed all steps we release the web view | ||
| } | ||
| } | ||
|
|
||
| func loadURL(url: URL) async { | ||
| do { | ||
| self.scanURL = url.absoluteString | ||
| try await webViewHandler?.load(url: url) | ||
| await executeNextStep() | ||
| } catch { | ||
| await completeWith(error: error) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters