extensions/browser/api/management/management_api.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef EXTENSIONS_BROWSER_API_MANAGEMENT_MANAGEMENT_API_H_
   6 #define EXTENSIONS_BROWSER_API_MANAGEMENT_MANAGEMENT_API_H_
   7
   8 #include "base/compiler_specific.h"
   9 #include "base/scoped_observer.h"
  10 #include "components/keyed_service/core/keyed_service.h"
  11 #include "extensions/browser/api/management/management_api_delegate.h"
  12 #include "extensions/browser/browser_context_keyed_api_factory.h"
  13 #include "extensions/browser/event_router.h"
  14 #include "extensions/browser/extension_function.h"
  15 #include "extensions/browser/extension_registry_observer.h"
  16
  17 class ExtensionRegistry;
  18 class ExtensionUninstallDialog;
  19 struct WebApplicationInfo;
  20
  21 namespace extensions {
  22 class ExtensionRegistry;
  23 class RequirementsChecker;
  24
  25 class ManagementFunction : public SyncExtensionFunction {
  26  protected:
  27   ~ManagementFunction() override {}
  28 };
  29
  30 class AsyncManagementFunction : public AsyncExtensionFunction {
  31  protected:
  32   ~AsyncManagementFunction() override {}
  33 };
  34
  35 class ManagementGetAllFunction : public ManagementFunction {
  36  public:
  37   DECLARE_EXTENSION_FUNCTION("management.getAll", MANAGEMENT_GETALL)
  38
  39  protected:
  40   ~ManagementGetAllFunction() override {}
  41
  42   // ExtensionFunction:
  43   bool RunSync() override;
  44 };
  45
  46 class ManagementGetFunction : public ManagementFunction {
  47  public:
  48   DECLARE_EXTENSION_FUNCTION("management.get", MANAGEMENT_GET)
  49
  50  protected:
  51   ~ManagementGetFunction() override {}
  52
  53   // ExtensionFunction:
  54   bool RunSync() override;
  55 };
  56
  57 class ManagementGetSelfFunction : public ManagementFunction {
  58  public:
  59   DECLARE_EXTENSION_FUNCTION("management.getSelf", MANAGEMENT_GETSELF)
  60
  61  protected:
  62   ~ManagementGetSelfFunction() override {}
  63
  64   // ExtensionFunction:
  65   bool RunSync() override;
  66 };
  67
  68 class ManagementGetPermissionWarningsByIdFunction : public ManagementFunction {
  69  public:
  70   DECLARE_EXTENSION_FUNCTION("management.getPermissionWarningsById",
  71                              MANAGEMENT_GETPERMISSIONWARNINGSBYID)
  72
  73  protected:
  74   ~ManagementGetPermissionWarningsByIdFunction() override {}
  75
  76   // ExtensionFunction:
  77   bool RunSync() override;
  78 };
  79
  80 class ManagementGetPermissionWarningsByManifestFunction
  81     : public AsyncExtensionFunction {
  82  public:
  83   DECLARE_EXTENSION_FUNCTION("management.getPermissionWarningsByManifest",
  84                              MANAGEMENT_GETPERMISSIONWARNINGSBYMANIFEST);
  85
  86   // Called when utility process finishes.
  87   void OnParseSuccess(scoped_ptr<base::Value> value);
  88   void OnParseFailure(const std::string& error);
  89
  90  protected:
  91   ~ManagementGetPermissionWarningsByManifestFunction() override {}
  92
  93   // ExtensionFunction:
  94   bool RunAsync() override;
  95 };
  96
  97 class ManagementLaunchAppFunction : public ManagementFunction {
  98  public:
  99   DECLARE_EXTENSION_FUNCTION("management.launchApp", MANAGEMENT_LAUNCHAPP)
 100
 101  protected:
 102   ~ManagementLaunchAppFunction() override {}
 103
 104   // ExtensionFunction:
 105   bool RunSync() override;
 106 };
 107
 108 class ManagementSetEnabledFunction : public UIThreadExtensionFunction {
 109  public:
 110   DECLARE_EXTENSION_FUNCTION("management.setEnabled", MANAGEMENT_SETENABLED)
 111
 112   ManagementSetEnabledFunction();
 113
 114   void InstallUIProceed();
 115   void InstallUIAbort(bool user_initiated);
 116
 117  protected:
 118   ~ManagementSetEnabledFunction() override;
 119
 120   // ExtensionFunction:
 121   ResponseAction Run() override;
 122
 123  private:
 124   void OnRequirementsChecked(const std::vector<std::string>& requirements);
 125
 126   std::string extension_id_;
 127
 128   scoped_ptr<InstallPromptDelegate> install_prompt_;
 129
 130   scoped_ptr<RequirementsChecker> requirements_checker_;
 131 };
 132
 133 class ManagementUninstallFunctionBase : public AsyncManagementFunction {
 134  public:
 135   ManagementUninstallFunctionBase();
 136
 137   static void SetAutoConfirmForTest(bool should_proceed);
 138
 139   void ExtensionUninstallAccepted();
 140   void ExtensionUninstallCanceled();
 141
 142  protected:
 143   ~ManagementUninstallFunctionBase() override;
 144
 145   bool Uninstall(const std::string& extension_id, bool show_confirm_dialog);
 146
 147  private:
 148   // If should_uninstall is true, this method does the actual uninstall.
 149   // If |show_uninstall_dialog|, then this function will be called by one of the
 150   // Accepted/Canceled callbacks. Otherwise, it's called directly from RunAsync.
 151   void Finish(bool should_uninstall);
 152
 153   std::string extension_id_;
 154
 155   scoped_ptr<UninstallDialogDelegate> uninstall_dialog_;
 156 };
 157
 158 class ManagementUninstallFunction : public ManagementUninstallFunctionBase {
 159  public:
 160   DECLARE_EXTENSION_FUNCTION("management.uninstall", MANAGEMENT_UNINSTALL)
 161
 162   ManagementUninstallFunction();
 163
 164  private:
 165   ~ManagementUninstallFunction() override;
 166
 167   bool RunAsync() override;
 168 };
 169
 170 class ManagementUninstallSelfFunction : public ManagementUninstallFunctionBase {
 171  public:
 172   DECLARE_EXTENSION_FUNCTION("management.uninstallSelf",
 173                              MANAGEMENT_UNINSTALLSELF);
 174
 175   ManagementUninstallSelfFunction();
 176
 177  private:
 178   ~ManagementUninstallSelfFunction() override;
 179
 180   bool RunAsync() override;
 181 };
 182
 183 class ManagementCreateAppShortcutFunction : public AsyncManagementFunction {
 184  public:
 185   DECLARE_EXTENSION_FUNCTION("management.createAppShortcut",
 186                              MANAGEMENT_CREATEAPPSHORTCUT);
 187
 188   ManagementCreateAppShortcutFunction();
 189
 190   void OnCloseShortcutPrompt(bool created);
 191
 192   static void SetAutoConfirmForTest(bool should_proceed);
 193
 194  protected:
 195   ~ManagementCreateAppShortcutFunction() override;
 196
 197   bool RunAsync() override;
 198 };
 199
 200 class ManagementSetLaunchTypeFunction : public ManagementFunction {
 201  public:
 202   DECLARE_EXTENSION_FUNCTION("management.setLaunchType",
 203                              MANAGEMENT_SETLAUNCHTYPE);
 204
 205  protected:
 206   ~ManagementSetLaunchTypeFunction() override {}
 207
 208   bool RunSync() override;
 209 };
 210
 211 class ManagementGenerateAppForLinkFunction : public AsyncManagementFunction {
 212  public:
 213   DECLARE_EXTENSION_FUNCTION("management.generateAppForLink",
 214                              MANAGEMENT_GENERATEAPPFORLINK);
 215
 216   ManagementGenerateAppForLinkFunction();
 217
 218   void FinishCreateBookmarkApp(const Extension* extension,
 219                                const WebApplicationInfo& web_app_info);
 220
 221  protected:
 222   ~ManagementGenerateAppForLinkFunction() override;
 223
 224   bool RunAsync() override;
 225
 226  private:
 227   scoped_ptr<AppForLinkDelegate> app_for_link_delegate_;
 228 };
 229
 230 class ManagementEventRouter : public ExtensionRegistryObserver {
 231  public:
 232   explicit ManagementEventRouter(content::BrowserContext* context);
 233   ~ManagementEventRouter() override;
 234
 235  private:
 236   // ExtensionRegistryObserver implementation.
 237   void OnExtensionLoaded(content::BrowserContext* browser_context,
 238                          const Extension* extension) override;
 239   void OnExtensionUnloaded(content::BrowserContext* browser_context,
 240                            const Extension* extension,
 241                            UnloadedExtensionInfo::Reason reason) override;
 242   void OnExtensionInstalled(content::BrowserContext* browser_context,
 243                             const Extension* extension,
 244                             bool is_update) override;
 245   void OnExtensionUninstalled(content::BrowserContext* browser_context,
 246                               const Extension* extension,
 247                               extensions::UninstallReason reason) override;
 248
 249   // Dispatches management api events to listening extensions.
 250   void BroadcastEvent(const Extension* extension, const char* event_name);
 251
 252   content::BrowserContext* browser_context_;
 253
 254   ScopedObserver<ExtensionRegistry, ExtensionRegistryObserver>
 255       extension_registry_observer_;
 256
 257   DISALLOW_COPY_AND_ASSIGN(ManagementEventRouter);
 258 };
 259
 260 class ManagementAPI : public BrowserContextKeyedAPI,
 261                       public EventRouter::Observer {
 262  public:
 263   explicit ManagementAPI(content::BrowserContext* context);
 264   ~ManagementAPI() override;
 265
 266   // KeyedService implementation.
 267   void Shutdown() override;
 268
 269   // BrowserContextKeyedAPI implementation.
 270   static BrowserContextKeyedAPIFactory<ManagementAPI>* GetFactoryInstance();
 271
 272   // EventRouter::Observer implementation.
 273   void OnListenerAdded(const EventListenerInfo& details) override;
 274
 275   // Returns the ManagementAPI delegate.
 276   const ManagementAPIDelegate* GetDelegate() const { return delegate_.get(); }
 277
 278  private:
 279   friend class BrowserContextKeyedAPIFactory<ManagementAPI>;
 280
 281   content::BrowserContext* browser_context_;
 282
 283   // BrowserContextKeyedAPI implementation.
 284   static const char* service_name() { return "ManagementAPI"; }
 285   static const bool kServiceIsNULLWhileTesting = true;
 286   static const bool kServiceRedirectedInIncognito = true;
 287
 288   // Created lazily upon OnListenerAdded.
 289   scoped_ptr<ManagementEventRouter> management_event_router_;
 290
 291   scoped_ptr<ManagementAPIDelegate> delegate_;
 292
 293   DISALLOW_COPY_AND_ASSIGN(ManagementAPI);
 294 };
 295
 296 }  // namespace extensions
 297
 298 #endif  // EXTENSIONS_BROWSER_API_MANAGEMENT_MANAGEMENT_API_H_