ChromePrompt Mojo IPC interface

chrome_cleaner/mojom/chrome_prompt.mojom

Index: chrome_cleaner/mojom/chrome_prompt.mojom
diff --git a/chrome_cleaner/mojom/chrome_prompt.mojom b/chrome_cleaner/mojom/chrome_prompt.mojom
new file mode 100644
index 0000000000000000000000000000000000000000..70a21d14487431d63740e417ab4f6842b1217394
--- /dev/null
+++ b/chrome_cleaner/mojom/chrome_prompt.mojom
@@ -0,0 +1,67 @@
+// 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.
+
+module chrome_cleaner.mojom;
+
+[Extensible]
+enum ObservedBehaviour {

[Ken Rockot(use gerrit already), 2017/03/22 14:41:44]

Yeah, please don't use enums for bitfields. There's a reason enum classes don't
support this and a reason we use enum classes in the generated code.

A uint64 field with separate flag value constants is a reasonable option.

Another totally reasonable option IMHO is to use an explicit struct of bools:

struct ObservedBehaviorFlags {
  bool ads_injector;
  bool settings_hijacker;
  bool extension_injector;
  bool dropper;
};

And in fact you could just inline the bools in the UwS struct, eliminating the
(albeit tiny) extra overhead of a secondary struct.

bools in a struct are tightly packed into bitfields and therefore space
efficient. It's also probably easier to read, and it's naturally extensible.

[ftirelo, 2017/03/22 17:37:37]

I like this idea! Thanks!

+  UNSPECIFIED = 0,
+  ADS_INJECTOR = 1,
+  SETTINGS_HIJACKER = 2,
+  EXTENSION_INJECTOR = 4,
+  DROPPER = 8,
+  // Next tag: 16.
+};
+
+// Information about removable Unwanted Software matched by the Software
+// Reporter to be shown in the Chrome prompt.
+struct UwS {
+  // The id of this unwanted software.
+  int32 id;
+
+  // The name of this unwanted software.
+  string name;
+
+  // List of behaviors to be presented to the user represented as a bit field
+  // of ObservedBehaviour.
+  uint64 observed_behaviours;
+
+  // List of fully-qualified paths of the files that will be deleted by the
+  // Chrome Cleanup Tool for this unwanted software.
+  array<string> files_to_delete;
+};
+
+[Extensible]
+enum PromptAcceptance {
+  UNSPECIFIED = 0,
+  // The Chrome prompt was not shown to the user (for example, due to an
+  // experiment run that shouldn't prompt the user or because the user has
+  // been prompted recently).
+  NOT_SHOWN = 1,
+  // The user explicitly accepted the Chrome prompt, but didn't opt into
+  // uploading logs to Google.
+  ACCEPTED_WITHOUT_LOGS = 2,
+  // The user explicitly accepted the Chrome prompt and also opted into
+  // uploading logs to Google.
+  ACCEPTED_WITH_LOGS = 3,
+  // The user explicitly denied the Chrome prompt.
+  DENIED = 4,
+  // The user didn't interact with the Chrome prompt after a while.
+  IGNORED = 5,
+};
+
+// Service provided by Chrome to prompt the user to run the Chrome Cleanup Tool
+// if unwanted software is detected on the system. This service is used by the
+// Software Reporter Tool so that all user interaction is provided by Chrome.
+interface ChromePrompt {
+  // Params:
+  //  - removable_uws_found: the list of UwS detected by the reporter;
+  //  - elevation_required: if the cleaner will need to run in elevated mode.
+  // Returns:
+  //  - prompt_acceptance: indicates if the user accepted the prompt; if the
+  //                       prompt is accepted, it also indicates if logs
+  //                       uploading is allowed.
+  PromptUser(array<UwS> removable_uws_found, bool elevation_required)
+      => (PromptAcceptance prompt_acceptance);
+};