// Copyright (c) 2011 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_EXTENSIONS_EXTENSIONS_UI_H_
#define CHROME_BROWSER_EXTENSIONS_EXTENSIONS_UI_H_
#pragma once
#include <string>
#include <vector>
#include "base/memory/scoped_ptr.h"
#include "chrome/browser/extensions/extension_uninstall_dialog.h"
#include "chrome/browser/extensions/pack_extension_job.h"
#include "chrome/browser/ui/shell_dialogs.h"
#include "chrome/browser/ui/webui/chrome_url_data_manager.h"
#include "chrome/common/extensions/extension_resource.h"
#include "content/browser/webui/web_ui.h"
#include "content/common/notification_observer.h"
#include "content/common/notification_registrar.h"
#include "googleurl/src/gurl.h"
class DictionaryValue;
class Extension;
class ExtensionService;
class FilePath;
class ListValue;
class PrefService;
class RenderProcessHost;
class UserScript;
// Information about a page running in an extension, for example a toolstrip,
// a background page, or a tab contents.
struct ExtensionPage {
ExtensionPage(const GURL& url, int render_process_id, int render_view_id,
bool incognito)
: url(url), render_process_id(render_process_id),
render_view_id(render_view_id), incognito(incognito) {}
GURL url;
int render_process_id;
int render_view_id;
bool incognito;
};
class ExtensionsUIHTMLSource : public ChromeURLDataManager::DataSource {
public:
ExtensionsUIHTMLSource();
// Called when the network layer has requested a resource underneath
// the path we registered.
virtual void StartDataRequest(const std::string& path,
bool is_incognito,
int request_id);
virtual std::string GetMimeType(const std::string&) const;
private:
~ExtensionsUIHTMLSource() {}
DISALLOW_COPY_AND_ASSIGN(ExtensionsUIHTMLSource);
};
// The handler for JavaScript messages related to the "extensions" view.
class ExtensionsDOMHandler : public WebUIMessageHandler,
public NotificationObserver,
public PackExtensionJob::Client,
public SelectFileDialog::Listener,
public ExtensionUninstallDialog::Delegate {
public:
explicit ExtensionsDOMHandler(ExtensionService* extension_service);
virtual ~ExtensionsDOMHandler();
// WebUIMessageHandler implementation.
virtual void RegisterMessages();
// Extension Detail JSON Struct for page. (static for ease of testing).
// Note: service can be NULL in unit tests.
static DictionaryValue* CreateExtensionDetailValue(
ExtensionService* service,
const Extension* extension,
const std::vector<ExtensionPage>& pages,
bool enabled,
bool terminated);
// ExtensionPackJob::Client
virtual void OnPackSuccess(const FilePath& crx_file,
const FilePath& key_file);
virtual void OnPackFailure(const std::string& error);
// ExtensionUninstallDialog::Delegate:
virtual void ExtensionDialogAccepted();
virtual void ExtensionDialogCanceled();
private:
// Callback for "requestExtensionsData" message.
void HandleRequestExtensionsData(const ListValue* args);
// Callback for "toggleDeveloperMode" message.
void HandleToggleDeveloperMode(const ListValue* args);
// Callback for "inspect" message.
void HandleInspectMessage(const ListValue* args);
// Callback for "reload" message.
void HandleReloadMessage(const ListValue* args);
// Callback for "enable" message.
void HandleEnableMessage(const ListValue* args);
// Callback for "enableIncognito" message.
void HandleEnableIncognitoMessage(const ListValue* args);
// Callback for "allowFileAcces" message.
void HandleAllowFileAccessMessage(const ListValue* args);
// Callback for "uninstall" message.
void HandleUninstallMessage(const ListValue* args);
// Callback for "options" message.
void HandleOptionsMessage(const ListValue* args);
// Callback for "showButton" message.
void HandleShowButtonMessage(const ListValue* args);
// Callback for "load" message.
void HandleLoadMessage(const ListValue* args);
// Callback for "pack" message.
void HandlePackMessage(const ListValue* args);
// Callback for "autoupdate" message.
void HandleAutoUpdateMessage(const ListValue* args);
// Utility for calling javascript window.alert in the page.
void ShowAlert(const std::string& message);
// Callback for "selectFilePath" message.
void HandleSelectFilePathMessage(const ListValue* args);
// Utility for callbacks that get an extension ID as the sole argument.
const Extension* GetExtension(const ListValue* args);
// Forces a UI update if appropriate after a notification is received.
void MaybeUpdateAfterNotification();
// Register for notifications that we need to reload the page.
void RegisterForNotifications();
// SelectFileDialog::Listener
virtual void FileSelected(const FilePath& path,
int index, void* params);
virtual void MultiFilesSelected(
const std::vector<FilePath>& files, void* params);
virtual void FileSelectionCanceled(void* params) {}
// NotificationObserver
virtual void Observe(NotificationType type,
const NotificationSource& source,
const NotificationDetails& details);
// Helper that lists the current active html pages for an extension.
std::vector<ExtensionPage> GetActivePagesForExtension(
const Extension* extension);
void GetActivePagesForExtensionProcess(
RenderProcessHost* process,
const Extension* extension,
std::vector<ExtensionPage> *result);
// Returns the ExtensionUninstallDialog object for this class, creating it if
// needed.
ExtensionUninstallDialog* GetExtensionUninstallDialog();
// Our model.
scoped_refptr<ExtensionService> extensions_service_;
// Used to pick the directory when loading an extension.
scoped_refptr<SelectFileDialog> load_extension_dialog_;
// Used to package the extension.
scoped_refptr<PackExtensionJob> pack_job_;
// Used to show confirmation UI for uninstalling extensions in incognito mode.
scoped_ptr<ExtensionUninstallDialog> extension_uninstall_dialog_;
// The id of the extension we are prompting the user about.
std::string extension_id_prompting_;
// We monitor changes to the extension system so that we can reload when
// necessary.
NotificationRegistrar registrar_;
// If true, we will ignore notifications in ::Observe(). This is needed
// to prevent reloading the page when we were the cause of the
// notification.
bool ignore_notifications_;
// The page may be refreshed in response to a RENDER_VIEW_HOST_DELETED,
// but the iteration over RenderViewHosts will include the host because the
// notification is sent when it is in the process of being deleted (and before
// it is removed from the process). Keep a pointer to it so we can exclude
// it from the active views.
RenderViewHost* deleting_rvh_;
DISALLOW_COPY_AND_ASSIGN(ExtensionsDOMHandler);
};
class ExtensionsUI : public WebUI {
public:
explicit ExtensionsUI(TabContents* contents);
static RefCountedMemory* GetFaviconResourceBytes();
static void RegisterUserPrefs(PrefService* prefs);
private:
DISALLOW_COPY_AND_ASSIGN(ExtensionsUI);
};
#endif // CHROME_BROWSER_EXTENSIONS_EXTENSIONS_UI_H_