// 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.

// Defines the Chrome Extensions BrowsingData API functions, which entail
// clearing browsing data, and clearing the browser's cache (which, let's be
// honest, are the same thing), as specified in the extension API JSON.

#ifndef CHROME_BROWSER_EXTENSIONS_API_BROWSING_DATA_BROWSING_DATA_API_H_
#define CHROME_BROWSER_EXTENSIONS_API_BROWSING_DATA_BROWSING_DATA_API_H_
#pragma once

#include <string>

#include "chrome/browser/browsing_data_remover.h"
#include "chrome/browser/extensions/extension_function.h"

class PluginPrefs;

namespace extension_browsing_data_api_constants {

// Type keys.
extern const char kAppCacheKey[];
extern const char kCacheKey[];
extern const char kCookiesKey[];
extern const char kDownloadsKey[];
extern const char kFileSystemsKey[];
extern const char kFormDataKey[];
extern const char kHistoryKey[];
extern const char kIndexedDBKey[];
extern const char kPluginDataKey[];
extern const char kLocalStorageKey[];
extern const char kPasswordsKey[];
extern const char kWebSQLKey[];

// Option keys.
extern const char kExtensionsKey[];
extern const char kOriginTypesKey[];
extern const char kProtectedWebKey[];
extern const char kSinceKey[];
extern const char kUnprotectedWebKey[];

// Errors!
extern const char kOneAtATimeError[];

}  // namespace extension_browsing_data_api_constants

// This serves as a base class from which the browsing data API functions will
// inherit. Each needs to be an observer of BrowsingDataRemover events, and each
// will handle those events in the same way (by calling the passed-in callback
// function).
//
// Each child class must implement GetRemovalMask(), which returns the bitmask
// of data types to remove.
class BrowsingDataExtensionFunction : public AsyncExtensionFunction,
                                      public BrowsingDataRemover::Observer {
 public:
  // BrowsingDataRemover::Observer interface method.
  virtual void OnBrowsingDataRemoverDone() OVERRIDE;

  // ExtensionFunction:
  virtual bool RunImpl() OVERRIDE;

 protected:
  virtual ~BrowsingDataExtensionFunction() {}

  // Children should override this method to provide the proper removal mask
  // based on the API call they represent.
  virtual int GetRemovalMask() const = 0;

 private:
  // Updates the removal bitmask according to whether removing plugin data is
  // supported or not.
  void CheckRemovingPluginDataSupported(
      scoped_refptr<PluginPrefs> plugin_prefs);

  // Parse the developer-provided |origin_types| object into an origin_set_mask
  // that can be used with the BrowsingDataRemover.
  int ParseOriginSetMask(const base::DictionaryValue& options);

  // Called when we're ready to start removing data.
  void StartRemoving();

  base::Time remove_since_;
  int removal_mask_;
  int origin_set_mask_;
};

class RemoveAppCacheFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeAppcache")

 protected:
  virtual ~RemoveAppCacheFunction() {}

  // BrowsingDataTypeExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveBrowsingDataFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.remove")

 protected:
  virtual ~RemoveBrowsingDataFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveCacheFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeCache")

 protected:
  virtual ~RemoveCacheFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveCookiesFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeCookies")

 protected:
  virtual ~RemoveCookiesFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveDownloadsFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeDownloads")

 protected:
  virtual ~RemoveDownloadsFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveFileSystemsFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeFileSystems")

 protected:
  virtual ~RemoveFileSystemsFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveFormDataFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeFormData")

 protected:
  virtual ~RemoveFormDataFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveHistoryFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeHistory")

 protected:
  virtual ~RemoveHistoryFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveIndexedDBFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeIndexedDB")

 protected:
  virtual ~RemoveIndexedDBFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveLocalStorageFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeLocalStorage")

 protected:
  virtual ~RemoveLocalStorageFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveServerBoundCertsFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeServerBoundCertificates")

 protected:
  virtual ~RemoveServerBoundCertsFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemovePluginDataFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removePluginData")

 protected:
  virtual ~RemovePluginDataFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemovePasswordsFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removePasswords")

 protected:
  virtual ~RemovePasswordsFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

class RemoveWebSQLFunction : public BrowsingDataExtensionFunction {
 public:
  DECLARE_EXTENSION_FUNCTION_NAME("browsingData.removeWebSQL")

 protected:
  virtual ~RemoveWebSQLFunction() {}

  // BrowsingDataExtensionFunction:
  virtual int GetRemovalMask() const OVERRIDE;
};

#endif  // CHROME_BROWSER_EXTENSIONS_API_BROWSING_DATA_BROWSING_DATA_API_H_