blob: f774923ee6cd7a488fad42e6e3de1096ae9e3cb7 [file] [log] [blame]
// Copyright (c) 2012 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_UI_WEBUI_NTP_APP_LAUNCHER_HANDLER_H_
#define CHROME_BROWSER_UI_WEBUI_NTP_APP_LAUNCHER_HANDLER_H_
#include <memory>
#include <set>
#include <string>
#include "apps/metrics_names.h"
#include "base/macros.h"
#include "base/task/cancelable_task_tracker.h"
#include "chrome/browser/extensions/extension_uninstall_dialog.h"
#include "chrome/browser/ui/extensions/extension_enable_flow_delegate.h"
#include "chrome/common/extensions/extension_constants.h"
#include "components/favicon/core/favicon_service.h"
#include "components/prefs/pref_change_registrar.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
#include "content/public/browser/web_ui_message_handler.h"
#include "extensions/browser/extension_registry_observer.h"
#include "extensions/common/extension.h"
#include "sync/api/string_ordinal.h"
class ExtensionEnableFlow;
class ExtensionService;
class PrefChangeRegistrar;
class Profile;
namespace favicon_base {
struct FaviconImageResult;
}
namespace user_prefs {
class PrefRegistrySyncable;
}
// The handler for Javascript messages related to the "apps" view.
class AppLauncherHandler
: public content::WebUIMessageHandler,
public extensions::ExtensionUninstallDialog::Delegate,
public ExtensionEnableFlowDelegate,
public content::NotificationObserver,
public extensions::ExtensionRegistryObserver {
public:
explicit AppLauncherHandler(ExtensionService* extension_service);
~AppLauncherHandler() override;
// Populate a dictionary with the information from an extension.
static void CreateAppInfo(
const extensions::Extension* extension,
ExtensionService* service,
base::DictionaryValue* value);
// Registers values (strings etc.) for the page.
static void GetLocalizedValues(Profile* profile,
base::DictionaryValue* values);
// Register per-profile preferences.
static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
// WebUIMessageHandler:
void RegisterMessages() override;
// content::NotificationObserver:
void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) override;
// extensions::ExtensionRegistryObserver:
void OnExtensionLoaded(content::BrowserContext* browser_context,
const extensions::Extension* extension) override;
void OnExtensionUnloaded(
content::BrowserContext* browser_context,
const extensions::Extension* extension,
extensions::UnloadedExtensionInfo::Reason reason) override;
void OnExtensionUninstalled(content::BrowserContext* browser_context,
const extensions::Extension* extension,
extensions::UninstallReason reason) override;
// Populate the given dictionary with all installed app info.
void FillAppDictionary(base::DictionaryValue* value);
// Create a dictionary value for the given extension. May return NULL, e.g. if
// the given extension is not an app. If non-NULL, the caller assumes
// ownership of the pointer.
base::DictionaryValue* GetAppInfo(const extensions::Extension* extension);
// Populate the given dictionary with the web store promo content.
void FillPromoDictionary(base::DictionaryValue* value);
// Handles the "launchApp" message with unused |args|.
void HandleGetApps(const base::ListValue* args);
// Handles the "launchApp" message with |args| containing [extension_id,
// source] with optional [url, disposition], |disposition| defaulting to
// CURRENT_TAB.
void HandleLaunchApp(const base::ListValue* args);
// Handles the "setLaunchType" message with args containing [extension_id,
// launch_type].
void HandleSetLaunchType(const base::ListValue* args);
// Handles the "uninstallApp" message with |args| containing [extension_id]
// and an optional bool to not confirm the uninstall when true, defaults to
// false.
void HandleUninstallApp(const base::ListValue* args);
// Handles the "createAppShortcut" message with |args| containing
// [extension_id].
void HandleCreateAppShortcut(const base::ListValue* args);
// Handles the "showAppInfo" message with |args| containing [extension_id].
void HandleShowAppInfo(const base::ListValue* args);
// Handles the "reorderApps" message with |args| containing [dragged_app_id,
// app_order].
void HandleReorderApps(const base::ListValue* args);
// Handles the "setPageIndex" message with |args| containing [extension_id,
// page_index].
void HandleSetPageIndex(const base::ListValue* args);
// Handles "saveAppPageName" message with |args| containing [name,
// page_index].
void HandleSaveAppPageName(const base::ListValue* args);
// Handles "generateAppForLink" message with |args| containing [url, title,
// page_index].
void HandleGenerateAppForLink(const base::ListValue* args);
// Handles "stopShowingAppLauncherPromo" message with unused |args|.
void HandleStopShowingAppLauncherPromo(const base::ListValue* args);
// Handles "learnMore" message with unused |args|.
void HandleOnLearnMore(const base::ListValue* args);
// Handles "pageSelected" message with |args| containing [page_index].
void HandlePageSelected(const base::ListValue* args);
private:
struct AppInstallInfo {
AppInstallInfo();
~AppInstallInfo();
base::string16 title;
GURL app_url;
syncer::StringOrdinal page_ordinal;
};
// Reset some instance flags we use to track the currently uninstalling app.
void CleanupAfterUninstall();
// Prompts the user to re-enable the app for |extension_id|.
void PromptToEnableApp(const std::string& extension_id);
// ExtensionUninstallDialog::Delegate:
void OnExtensionUninstallDialogClosed(bool did_start_uninstall,
const base::string16& error) override;
// ExtensionEnableFlowDelegate:
void ExtensionEnableFlowFinished() override;
void ExtensionEnableFlowAborted(bool user_initiated) override;
// Returns the ExtensionUninstallDialog object for this class, creating it if
// needed.
extensions::ExtensionUninstallDialog* GetExtensionUninstallDialog();
// Continuation for installing a bookmark app after favicon lookup.
void OnFaviconForApp(std::unique_ptr<AppInstallInfo> install_info,
const favicon_base::FaviconImageResult& image_result);
// Sends |highlight_app_id_| to the js.
void SetAppToBeHighlighted();
void OnExtensionPreferenceChanged();
void OnLocalStatePreferenceChanged();
// Called when an app is removed (unloaded or uninstalled). Updates the UI.
void AppRemoved(const extensions::Extension* extension, bool is_uninstall);
// True if the extension should be displayed.
bool ShouldShow(const extensions::Extension* extension) const;
// The apps are represented in the extensions model, which
// outlives us since it's owned by our containing profile.
ExtensionService* const extension_service_;
// We monitor changes to the extension system so that we can reload the apps
// when necessary.
content::NotificationRegistrar registrar_;
// Monitor extension preference changes so that the Web UI can be notified.
PrefChangeRegistrar extension_pref_change_registrar_;
// Monitor the local state pref to control the app launcher promo.
PrefChangeRegistrar local_state_pref_change_registrar_;
// Used to show confirmation UI for uninstalling extensions in incognito mode.
std::unique_ptr<extensions::ExtensionUninstallDialog>
extension_uninstall_dialog_;
// Used to show confirmation UI for enabling extensions.
std::unique_ptr<ExtensionEnableFlow> extension_enable_flow_;
// The ids of apps to show on the NTP.
std::set<std::string> visible_apps_;
// The id of the extension we are prompting the user about (either enable or
// uninstall).
std::string extension_id_prompting_;
// When true, we ignore changes to the underlying data rather than immediately
// refreshing. This is useful when making many batch updates to avoid flicker.
bool ignore_changes_;
// When true, we have attempted to install a bookmark app, and are still
// waiting to hear about success or failure from the extensions system.
bool attempted_bookmark_app_install_;
// True if we have executed HandleGetApps() at least once.
bool has_loaded_apps_;
// The ID of the app to be highlighted on the NTP (i.e. shown on the page
// and pulsed). This is done for new installs. The actual higlighting occurs
// when the app is added to the page (via getAppsCallback or appAdded).
std::string highlight_app_id_;
// Used for favicon loading tasks.
base::CancelableTaskTracker cancelable_task_tracker_;
DISALLOW_COPY_AND_ASSIGN(AppLauncherHandler);
};
#endif // CHROME_BROWSER_UI_WEBUI_NTP_APP_LAUNCHER_HANDLER_H_