blob: b06e9c921e1f541e780d55e53eb863c08d4cf573 [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 <memory>
#include <string>
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "base/values.h"
#include "chrome/browser/extensions/external_loader.h"
class Profile;
namespace extensions {
// A specialization of the ExternalLoader that uses a json file to
// look up which external extensions are registered.
// Instances of this class are expected to be created and destroyed on the UI
// thread and they are expecting public method calls from the UI thread.
class ExternalPrefLoader : public ExternalLoader {
enum Options {
NONE = 0,
// Ensure that only root can force an external install by checking
// that all components of the path to external extensions files are
// owned by root and not writable by any non-root user.
// Delay external preference load. It delays default apps installation
// to not overload the system on first time user login.
// Use profile user type filter to load extensions.
// |base_path_id| is the directory containing the external_extensions.json
// file or the standalone extension manifest files. Relative file paths to
// extension files are resolved relative to this path. |profile| is used to
// wait priority sync if DELAY_LOAD_UNTIL_PRIORITY_SYNC set.
// |options| is combination of |Options|.
ExternalPrefLoader(int base_path_id, int options, Profile* profile);
const base::FilePath GetBaseCrxFilePath() override;
~ExternalPrefLoader() override;
void StartLoading() override;
bool IsOptionSet(Options option) {
return (options_ & option) != 0;
// The resource id of the base path with the information about the json
// file containing which extensions to load.
const int base_path_id_;
const int options_;
friend class base::RefCountedThreadSafe<ExternalLoader>;
friend class ExternalTestingLoader;
friend class TestExternalPrefLoader;
class PrioritySyncReadyWaiter;
// Extracts extension information from a json file serialized by |serializer|.
// |path| is only used for informational purposes (outputted when an error
// occurs). An empty dictionary is returned in case of failure (e.g. invalid
// path or json content).
static std::unique_ptr<base::DictionaryValue> ExtractExtensionPrefs(
base::ValueDeserializer* deserializer,
const base::FilePath& path);
// If priority sync ready posts LoadOnFileThread and return true.
bool PostLoadIfPrioritySyncReady();
// Post LoadOnFileThread and stop observing for sync service states.
void PostLoadAndRemoveObservers();
// Actually searches for and loads candidate standalone extension preference
// files in the path corresponding to |base_path_id|.
// Must be called on the file thread.
// Note: Overridden in tests.
virtual void LoadOnFileThread();
// Extracts the information contained in an external_extension.json file
// regarding which extensions to install. |prefs| will be modified to
// receive the extracted extension information.
// Must be called from the File thread.
void ReadExternalExtensionPrefFile(base::DictionaryValue* prefs);
// Extracts the information contained in standalone external extension
// json files (<extension id>.json) regarding what external extensions
// to install. |prefs| will be modified to receive the extracted extension
// information.
// Must be called from the File thread.
void ReadStandaloneExtensionPrefFiles(base::DictionaryValue* prefs);
void OnPrioritySyncReady(PrioritySyncReadyWaiter* waiter);
// The path (coresponding to |base_path_id_| containing the json files
// describing which extensions to load.
base::FilePath base_path_;
// Profile that loads these external prefs.
// Needed for waiting for waiting priority sync.
Profile* profile_;
// User type determined by |profile_|. Used to filter extensions. In some unit
// tests may not be set.
const std::string user_type_;
std::vector<std::unique_ptr<PrioritySyncReadyWaiter>> pending_waiter_list_;
} // namespace extensions