blob: f54cf219debef45230551fddd28f4c86590dec4b [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.
#include <set>
#include <string>
#include <vector>
#include "extensions/common/extension_id.h"
#include "url/gurl.h"
namespace base {
class FilePath;
namespace extensions {
class ExtensionSet;
// This class is used by the WarningService to represent warnings if extensions
// misbehave. Note that the WarningService deals only with specific warnings
// that should trigger a badge on the Chrome menu button.
class Warning {
enum WarningType {
// Don't use this, it is only intended for the default constructor and
// does not have localized warning messages for the UI.
kInvalid = 0,
// An extension caused excessive network delays.
// The extension repeatedly flushed WebKit's in-memory cache, which slows
// down the overall performance.
// The extension failed to determine the filename of a download because
// another extension with higher precedence determined a different filename.
// The declarative net request ruleset for the extension failed to load.
// We allow copy&assign for passing containers of Warnings between threads.
Warning(const Warning& other);
Warning& operator=(const Warning& other);
// Factory methods for various warning types.
static Warning CreateNetworkDelayWarning(
const std::string& extension_id);
static Warning CreateRepeatedCacheFlushesWarning(
const std::string& extension_id);
static Warning CreateDownloadFilenameConflictWarning(
const std::string& losing_extension_id,
const std::string& winning_extension_id,
const base::FilePath& losing_filename,
const base::FilePath& winning_filename);
static Warning CreateReloadTooFrequentWarning(
const std::string& extension_id);
static Warning CreateRulesetFailedToLoadWarning(
const ExtensionId& extension_id);
// Returns the specific warning type.
WarningType warning_type() const { return type_; }
// Returns the id of the extension for which this warning is valid.
const std::string& extension_id() const { return extension_id_; }
// Returns a localized warning message.
std::string GetLocalizedMessage(const ExtensionSet* extensions) const;
// Constructs a warning of type |type| for extension |extension_id|. This
// could indicate for example the fact that an extension conflicted with
// others. The |message_id| refers to an IDS_ string ID. The
// |message_parameters| are filled into the message template.
Warning(WarningType type,
const std::string& extension_id,
int message_id,
const std::vector<std::string>& message_parameters);
WarningType type_;
std::string extension_id_;
// IDS_* resource ID.
int message_id_;
// Parameters to be filled into the string identified by |message_id_|.
std::vector<std::string> message_parameters_;
// Compare Warnings based on the tuple of (extension_id, type).
// The message associated with Warnings is purely informational
// and does not contribute to distinguishing extensions.
bool operator<(const Warning& a, const Warning& b);
typedef std::set<Warning> WarningSet;
} // namespace extensions