summaryrefslogtreecommitdiffstats
path: root/chrome/browser/extensions/extension_file_util.h
diff options
context:
space:
mode:
Diffstat (limited to 'chrome/browser/extensions/extension_file_util.h')
-rw-r--r--chrome/browser/extensions/extension_file_util.h83
1 files changed, 83 insertions, 0 deletions
diff --git a/chrome/browser/extensions/extension_file_util.h b/chrome/browser/extensions/extension_file_util.h
new file mode 100644
index 0000000..45d0b30
--- /dev/null
+++ b/chrome/browser/extensions/extension_file_util.h
@@ -0,0 +1,83 @@
+// Copyright (c) 2009 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_EXTENSION_FILE_UTIL_H_
+#define CHROME_BROWSER_EXTENSIONS_EXTENSION_FILE_UTIL_H_
+
+#include <string>
+
+#include "base/file_path.h"
+#include "chrome/common/extensions/extension.h"
+
+// Utilties for manipulating the on-disk storage of extensions.
+namespace extension_file_util {
+
+// The name of the directory inside the profile that we store installed
+// extension in.
+extern const char kInstallDirectoryName[];
+
+// The name of the file that contains the current version of an installed
+// extension.
+extern const char kCurrentVersionFileName[];
+
+// Move source_dir to dest_dir (it will actually be named dest_dir, not inside
+// dest_dir). If the parent path doesn't exixt, create it. If something else is
+// already there, remove it.
+bool MoveDirSafely(const FilePath& source_dir, const FilePath& dest_dir);
+
+// Updates the Current Version file inside the installed extension.
+bool SetCurrentVersion(const FilePath& dest_dir, const std::string& version,
+ std::string* error);
+
+// Reads the Current Version file.
+bool ReadCurrentVersion(const FilePath& dir, std::string* version_string);
+
+// Determine what type of install (new, upgrade, overinstall, downgrade) a given
+// id/version combination is. Also returns the current version, if any, in
+// current_version_str.
+Extension::InstallType CompareToInstalledVersion(
+ const FilePath& install_directory, const std::string& id,
+ const std::string& new_version_str, std::string *current_version_str);
+
+// Sanity check that the directory has the minimum files to be a working
+// extension.
+bool SanityCheckExtension(const FilePath& extension_root);
+
+// Installs an extension unpacked in |src_dir|. |extensions_dir| is the root
+// directory containing all extensions in the user profile. |extension_id| and
+// |extension_version| are the id and version of the extension contained in
+// |src_dir|.
+//
+// Returns the full path to the destination version directory and the type of
+// install that was attempted.
+//
+// On failure, also returns an error message.
+//
+// NOTE: |src_dir| is not actually copied in the case of downgrades or
+// overinstall of previous verisons of the extension. In that case, the function
+// returns true and install_type is populated.
+bool InstallExtension(const FilePath& src_dir,
+ const FilePath& extensions_dir,
+ const std::string& extension_id,
+ const std::string& extension_version,
+ FilePath* version_dir,
+ Extension::InstallType* install_type,
+ std::string* error);
+
+// Load an extension from the specified directory. Returns NULL on failure, with
+// a description of the error in |error|.
+Extension* LoadExtension(const FilePath& extension_root, bool require_key,
+ std::string* error);
+
+// Uninstalls the extension |id| from the install directory |extensions_dir|.
+void UninstallExtension(const std::string& id, const FilePath& extensions_dir);
+
+// Clean up directories that aren't valid extensions from the install directory.
+// TODO(aa): Also consider passing in a list of known current extensions and
+// removing others?
+void GarbageCollectExtensions(const FilePath& extensions_dir);
+
+} // extension_file_util
+
+#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_FILE_UTIL_H_