Index: chrome/browser/safe_browsing/chrome_cleaner/chrome_cleaner_runner_win.h |
diff --git a/chrome/browser/safe_browsing/chrome_cleaner/chrome_cleaner_runner_win.h b/chrome/browser/safe_browsing/chrome_cleaner/chrome_cleaner_runner_win.h |
new file mode 100644 |
index 0000000000000000000000000000000000000000..ac4c4968b4bfa15da55ae83dbd4be14131e292d6 |
--- /dev/null |
+++ b/chrome/browser/safe_browsing/chrome_cleaner/chrome_cleaner_runner_win.h |
@@ -0,0 +1,158 @@ |
+// Copyright 2017 The Chromium Authors. All rights reserved. |
+// Use of this source code is governed by a BSD-style license that can be |
+// found in the LICENSE file. |
+ |
+#ifndef CHROME_BROWSER_SAFE_BROWSING_CHROME_CLEANER_CHROME_CLEANER_RUNNER_WIN_H_ |
+#define CHROME_BROWSER_SAFE_BROWSING_CHROME_CLEANER_CHROME_CLEANER_RUNNER_WIN_H_ |
+ |
+#include <limits> |
+#include <memory> |
+#include <set> |
+#include <string> |
+ |
+#include "base/callback.h" |
+#include "base/command_line.h" |
+#include "base/files/file_path.h" |
+#include "base/memory/ref_counted.h" |
+#include "base/process/launch.h" |
+#include "base/process/process.h" |
+#include "base/single_thread_task_runner.h" |
+#include "chrome/browser/safe_browsing/chrome_cleaner/reporter_runner_win.h" |
+#include "chrome/browser/safe_browsing/chrome_cleaner/srt_chrome_prompt_impl.h" |
+#include "components/chrome_cleaner/public/interfaces/chrome_prompt.mojom.h" |
+ |
+namespace safe_browsing { |
+ |
+// Class responsible for launching the cleaner process and waiting for its |
+// completion when the InBrowserCleanerUI feature is enabled. This object is |
+// also responsible for starting the ChromePromptImpl object on the IO thread |
+// and controlling its lifetime. |
+// |
+// Expected lifecycle of a ChromeCleanerRunner: |
+// |
+// - Instances are created via the static |
+// RunChromeCleanerAndReplyWithExitCode() function. Instances will not be |
+// destroyed before the Chrome Cleaner process has terminated _and_ a |
+// Mojo connection-closed callback has been received. Destruction can happen |
+// on any thread. |
+// - The private LaunchAndWaitForExitOnBackgroundThread() function launches the |
+// Chrome Cleaner process, creates a ChromePromptImpl object on the IO thread |
+// and waits for the Cleaner process to terminate. The static |
+// RunChromeCleanerAndReplyWithExitCode() function takes care of calling that |
+// function correctly on a sequence with the correct traits. |
+// - All callbacks registered with an instance are posted to run on the same |
+// thread on which the instance was originally created. |
+// - The ChromePromptImpl object is destroyed on the IO thread after a |
+// connection-closed has been received from Mojo. The runner instance will |
+// not be destroyed before the ChromePromptImpl object has been released. |
+class ChromeCleanerRunner |
+ : public base::RefCountedThreadSafe<ChromeCleanerRunner> { |
+ public: |
+ enum class ChromeMetricsStatus { |
+ kEnabled, |
+ kDisabled, |
+ }; |
+ |
+ enum class CleanerLogsStatus { |
+ kUploadEnabled, |
+ kUploadDisabled, |
+ }; |
+ |
+ struct LaunchStatus { |
+ // If false, indicates that either the Chrome Cleaner process handle |
+ // returned by base::LaunchProcess() was invalid or that something went |
+ // wrong while waiting for the process to exit. |
+ bool process_ok; |
+ // The exit code from the Chrome Cleaner process. Should not be used if |
+ // |process_ok| is false. |
+ int exit_code; |
+ }; |
+ |
+ using ProcessDoneCallback = base::OnceCallback<void(LaunchStatus)>; |
+ |
+ // Executes the Chrome Cleaner in the background, initializes the Mojo IPC |
+ // between Chrome and the Chrome Cleaner process, and forwards Mojo callbacks |
+ // via the callbacks that are passed to it. |
+ // |
+ // All callbacks are posted to run on the same thread that this function is |
+ // called from. |
+ // |
+ // More details: |
+ // |
+ // This function will pass command line flags to the Chrome Cleaner executable |
+ // as appropriate based on the flags in |reporter_invocation| and the |
+ // |metrics_status| and |cleaner_logs_status| parameters. The Cleaner process |
+ // will communicate with Chrome via a Mojo IPC interface and any IPC requests |
+ // or notifications are passed to the caller via the |on_prompt_user| and |
+ // |on_connection_closed| callbacks. Finally, when the Chrome Cleaner process |
+ // terminates, a LaunchStatus is passed along to |on_process_done|. |
+ // |
+ // The details of the mojo interface are documented in |
+ // "components/chrome_cleaner/public/interfaces/chrome_prompt.mojom.h". |
+ static void RunChromeCleanerAndReplyWithExitCode( |
+ const base::FilePath& executable_path, |
+ const SwReporterInvocation& reporter_invocation, |
+ ChromeMetricsStatus metrics_status, |
+ CleanerLogsStatus cleaner_logs_status, |
+ ChromePromptImpl::OnPromptUser on_prompt_user, |
+ base::OnceClosure on_connection_closed, |
+ ChromeCleanerRunner::ProcessDoneCallback on_process_done); |
+ |
+ private: |
+ friend class base::RefCountedThreadSafe<ChromeCleanerRunner>; |
+ |
+ ~ChromeCleanerRunner(); |
+ |
+ ChromeCleanerRunner(const base::FilePath& executable_path, |
+ const SwReporterInvocation& reporter_invocation, |
+ ChromeMetricsStatus metrics_status, |
+ CleanerLogsStatus cleaner_logs_status, |
+ ChromePromptImpl::OnPromptUser on_prompt_user, |
+ base::OnceClosure on_connection_closed, |
+ ChromeCleanerRunner::ProcessDoneCallback on_process_done, |
+ scoped_refptr<base::SingleThreadTaskRunner> task_runner); |
+ |
+ LaunchStatus LaunchAndWaitForExitOnBackgroundThread(); |
+ |
+ void CreateChromePromptImpl( |
+ chrome_cleaner::mojom::ChromePromptRequest chrome_prompt_request); |
+ void ReleaseChromePromptImpl(); |
+ |
+ // Callbacks received from the Mojo interface. |
+ void OnPromptUser(std::unique_ptr<std::set<base::FilePath>> files_to_delete, |
+ chrome_cleaner::mojom::ChromePrompt::PromptUserCallback |
+ prompt_user_callback); |
+ void OnConnectionClosed(); |
+ void OnProcessDone(LaunchStatus launch_status); |
+ |
+ scoped_refptr<base::SingleThreadTaskRunner> task_runner_; |
+ |
+ base::CommandLine command_line_; |
+ ChromePromptImpl::OnPromptUser on_prompt_user_; |
+ base::OnceClosure on_connection_closed_; |
+ ProcessDoneCallback on_process_done_; |
+ |
+ std::unique_ptr<ChromePromptImpl> chrome_prompt_impl_; |
+}; |
+ |
+// A delegate class used to override launching of the Cleaner proccess for |
+// tests. |
+class ChromeCleanerRunnerTestDelegate { |
+ public: |
+ virtual ~ChromeCleanerRunnerTestDelegate() = default; |
+ |
+ // Called instead of base::LaunchProcess() during testing. |
+ virtual base::Process LaunchTestProcess( |
+ const base::CommandLine& command_line, |
+ const base::LaunchOptions& launch_options) = 0; |
+ |
+ // Returns command line options that need to be set during testing. |
+ virtual base::CommandLine GetTestBaseCommandLine() = 0; |
+}; |
+ |
+void SetChromeCleanerRunnerTestDelegateForTesting( |
+ ChromeCleanerRunnerTestDelegate* test_delegate); |
+ |
+} // namespace safe_browsing |
+ |
+#endif // CHROME_BROWSER_SAFE_BROWSING_CHROME_CLEANER_CHROME_CLEANER_RUNNER_WIN_H_ |