| OLD | NEW |
| 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef CHROME_BROWSER_EXTENSIONS_EXTERNAL_EXTENSION_LOADER_H_ | 5 #ifndef CHROME_BROWSER_EXTENSIONS_EXTERNAL_LOADER_H_ |
| 6 #define CHROME_BROWSER_EXTENSIONS_EXTERNAL_EXTENSION_LOADER_H_ | 6 #define CHROME_BROWSER_EXTENSIONS_EXTERNAL_LOADER_H_ |
| 7 | 7 |
| 8 #include "base/file_path.h" | 8 #include "base/file_path.h" |
| 9 #include "base/memory/ref_counted.h" | 9 #include "base/memory/ref_counted.h" |
| 10 #include "base/memory/scoped_ptr.h" | 10 #include "base/memory/scoped_ptr.h" |
| 11 | 11 |
| 12 class ExternalExtensionProviderImpl; | |
| 13 | |
| 14 namespace base { | 12 namespace base { |
| 15 class DictionaryValue; | 13 class DictionaryValue; |
| 16 } | 14 } |
| 17 | 15 |
| 16 namespace extensions { |
| 17 class ExternalProviderImpl; |
| 18 |
| 18 // Base class for gathering a list of external extensions. Subclasses | 19 // Base class for gathering a list of external extensions. Subclasses |
| 19 // implement loading from registry, JSON file, policy. | 20 // implement loading from registry, JSON file, policy. |
| 20 // Instances are owned by ExternalExtensionProviderImpl objects. | 21 // Instances are owned by ExternalProviderImpl objects. |
| 21 // Instances are created on the UI thread and expect public method calls from | 22 // Instances are created on the UI thread and expect public method calls from |
| 22 // the UI thread. Some subclasses introduce new methods that are executed on the | 23 // the UI thread. Some subclasses introduce new methods that are executed on the |
| 23 // FILE thread. | 24 // FILE thread. |
| 24 // The sequence of loading the extension list: | 25 // The sequence of loading the extension list: |
| 25 // 1.) StartLoading() - checks if a loading task is already running | 26 // 1.) StartLoading() - checks if a loading task is already running |
| 26 // 2.) Load() - implemented in subclasses | 27 // 2.) Load() - implemented in subclasses |
| 27 // 3.) LoadFinished() | 28 // 3.) LoadFinished() |
| 28 // 4.) owner_->SetPrefs() | 29 // 4.) owner_->SetPrefs() |
| 29 class ExternalExtensionLoader | 30 class ExternalLoader : public base::RefCountedThreadSafe<ExternalLoader> { |
| 30 : public base::RefCountedThreadSafe<ExternalExtensionLoader> { | |
| 31 public: | 31 public: |
| 32 explicit ExternalExtensionLoader(); | 32 ExternalLoader(); |
| 33 | 33 |
| 34 // Specifies the provider that owns this object. | 34 // Specifies the provider that owns this object. |
| 35 void Init(ExternalExtensionProviderImpl* owner); | 35 void Init(ExternalProviderImpl* owner); |
| 36 | 36 |
| 37 // Called by the owner before it gets deleted. | 37 // Called by the owner before it gets deleted. |
| 38 void OwnerShutdown(); | 38 void OwnerShutdown(); |
| 39 | 39 |
| 40 // Initiates the possibly asynchronous loading of extension list. | 40 // Initiates the possibly asynchronous loading of extension list. |
| 41 // It is the responsibility of the caller to ensure that calls to | 41 // It is the responsibility of the caller to ensure that calls to |
| 42 // this method do not overlap with each other. | 42 // this method do not overlap with each other. |
| 43 // Implementations of this method should save the loaded results | 43 // Implementations of this method should save the loaded results |
| 44 // in prefs_ and then call LoadFinished. | 44 // in prefs_ and then call LoadFinished. |
| 45 virtual void StartLoading() = 0; | 45 virtual void StartLoading() = 0; |
| 46 | 46 |
| 47 // Some external providers allow relative file paths to local CRX files. | 47 // Some external providers allow relative file paths to local CRX files. |
| 48 // Subclasses that want this behavior should override this method to | 48 // Subclasses that want this behavior should override this method to |
| 49 // return the absolute path from which relative paths should be resolved. | 49 // return the absolute path from which relative paths should be resolved. |
| 50 // By default, return an empty path, which indicates that relative paths | 50 // By default, return an empty path, which indicates that relative paths |
| 51 // are not allowed. | 51 // are not allowed. |
| 52 virtual const FilePath GetBaseCrxFilePath(); | 52 virtual const FilePath GetBaseCrxFilePath(); |
| 53 | 53 |
| 54 protected: | 54 protected: |
| 55 virtual ~ExternalExtensionLoader(); | 55 virtual ~ExternalLoader(); |
| 56 | 56 |
| 57 // Notifies the provider that the list of extensions has been loaded. | 57 // Notifies the provider that the list of extensions has been loaded. |
| 58 void LoadFinished(); | 58 void LoadFinished(); |
| 59 | 59 |
| 60 // Used for passing the list of extensions from the method that loads them | 60 // Used for passing the list of extensions from the method that loads them |
| 61 // to |LoadFinished|. To ensure thread safety, the rules are the following: | 61 // to |LoadFinished|. To ensure thread safety, the rules are the following: |
| 62 // if this value is written on another thread than the UI, then it should | 62 // if this value is written on another thread than the UI, then it should |
| 63 // only be written in a task that was posted from |StartLoading|. After that, | 63 // only be written in a task that was posted from |StartLoading|. After that, |
| 64 // this task should invoke |LoadFinished| with a PostTask. This scheme of | 64 // this task should invoke |LoadFinished| with a PostTask. This scheme of |
| 65 // posting tasks will avoid concurrent access and imply the necessary memory | 65 // posting tasks will avoid concurrent access and imply the necessary memory |
| 66 // barriers. | 66 // barriers. |
| 67 scoped_ptr<base::DictionaryValue> prefs_; | 67 scoped_ptr<base::DictionaryValue> prefs_; |
| 68 | 68 |
| 69 private: | 69 private: |
| 70 friend class base::RefCountedThreadSafe<ExternalExtensionLoader>; | 70 friend class base::RefCountedThreadSafe<ExternalLoader>; |
| 71 | 71 |
| 72 ExternalExtensionProviderImpl* owner_; // weak | 72 ExternalProviderImpl* owner_; // weak |
| 73 | 73 |
| 74 // Set to true if loading the extensions is already running. New requests | 74 // Set to true if loading the extensions is already running. New requests |
| 75 // are ignored while this is set true. | 75 // are ignored while this is set true. |
| 76 bool running_; | 76 bool running_; |
| 77 | 77 |
| 78 DISALLOW_COPY_AND_ASSIGN(ExternalExtensionLoader); | 78 DISALLOW_COPY_AND_ASSIGN(ExternalLoader); |
| 79 }; | 79 }; |
| 80 | 80 |
| 81 #endif // CHROME_BROWSER_EXTENSIONS_EXTERNAL_EXTENSION_LOADER_H_ | 81 } // namespace extensions |
| 82 |
| 83 #endif // CHROME_BROWSER_EXTENSIONS_EXTERNAL_LOADER_H_ |
| OLD | NEW |