chrome/browser/extensions/api/media_galleries/media_galleries_api.h

   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
   3 // found in the LICENSE file.
   4
   5 // Defines the Chrome Extensions Media Galleries API functions for accessing
   6 // user's media files, as specified in the extension API IDL.
   7
   8 #ifndef CHROME_BROWSER_EXTENSIONS_API_MEDIA_GALLERIES_MEDIA_GALLERIES_API_H_
   9 #define CHROME_BROWSER_EXTENSIONS_API_MEDIA_GALLERIES_MEDIA_GALLERIES_API_H_
  10
  11 #include <string>
  12 #include <vector>
  13
  14 #include "base/callback_forward.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/memory/weak_ptr.h"
  17 #include "chrome/browser/extensions/chrome_extension_function.h"
  18 #include "chrome/browser/media_galleries/gallery_watch_manager_observer.h"
  19 #include "chrome/browser/media_galleries/media_file_system_registry.h"
  20 #include "chrome/browser/media_galleries/media_scan_manager_observer.h"
  21 #include "chrome/common/extensions/api/media_galleries.h"
  22 #include "chrome/common/media_galleries/metadata_types.h"
  23 #include "components/storage_monitor/media_storage_util.h"
  24 #include "extensions/browser/browser_context_keyed_api_factory.h"
  25 #include "extensions/browser/event_router.h"
  26 #include "extensions/browser/extension_event_histogram_value.h"
  27
  28 namespace MediaGalleries = extensions::api::media_galleries;
  29
  30 class MediaGalleriesScanResultController;
  31
  32 namespace content {
  33 class BlobHandle;
  34 class WebContents;
  35 }
  36
  37 namespace metadata {
  38 class SafeMediaMetadataParser;
  39 }
  40
  41 namespace extensions {
  42
  43 class Extension;
  44
  45 // The profile-keyed service that manages the media galleries extension API.
  46 // Created at the same time as the Profile. This is also the event router.
  47 class MediaGalleriesEventRouter : public BrowserContextKeyedAPI,
  48                                   public GalleryWatchManagerObserver,
  49                                   public MediaScanManagerObserver,
  50                                   public extensions::EventRouter::Observer {
  51  public:
  52   // KeyedService implementation.
  53   void Shutdown() override;
  54
  55   // BrowserContextKeyedAPI implementation.
  56   static BrowserContextKeyedAPIFactory<MediaGalleriesEventRouter>*
  57       GetFactoryInstance();
  58
  59   // Convenience method to get the MediaGalleriesAPI for a profile.
  60   static MediaGalleriesEventRouter* Get(content::BrowserContext* context);
  61
  62   bool ExtensionHasGalleryChangeListener(const std::string& extension_id) const;
  63   bool ExtensionHasScanProgressListener(const std::string& extension_id) const;
  64
  65   // MediaScanManagerObserver implementation.
  66   void OnScanStarted(const std::string& extension_id) override;
  67   void OnScanCancelled(const std::string& extension_id) override;
  68   void OnScanFinished(const std::string& extension_id,
  69                       int gallery_count,
  70                       const MediaGalleryScanResult& file_counts) override;
  71   void OnScanError(const std::string& extension_id) override;
  72
  73  private:
  74   friend class BrowserContextKeyedAPIFactory<MediaGalleriesEventRouter>;
  75
  76   void DispatchEventToExtension(const std::string& extension_id,
  77                                 events::HistogramValue histogram_value,
  78                                 const std::string& event_name,
  79                                 scoped_ptr<base::ListValue> event_args);
  80
  81   explicit MediaGalleriesEventRouter(content::BrowserContext* context);
  82   ~MediaGalleriesEventRouter() override;
  83
  84   // BrowserContextKeyedAPI implementation.
  85   static const char* service_name() {
  86     return "MediaGalleriesAPI";
  87   }
  88   static const bool kServiceIsNULLWhileTesting = true;
  89
  90   // GalleryWatchManagerObserver
  91   void OnGalleryChanged(const std::string& extension_id,
  92                         MediaGalleryPrefId gallery_id) override;
  93   void OnGalleryWatchDropped(const std::string& extension_id,
  94                              MediaGalleryPrefId gallery_id) override;
  95
  96   // extensions::EventRouter::Observer implementation.
  97   void OnListenerRemoved(const EventListenerInfo& details) override;
  98
  99   // Current profile.
 100   Profile* profile_;
 101
 102   base::WeakPtrFactory<MediaGalleriesEventRouter> weak_ptr_factory_;
 103
 104   DISALLOW_COPY_AND_ASSIGN(MediaGalleriesEventRouter);
 105 };
 106
 107 class MediaGalleriesGetMediaFileSystemsFunction
 108     : public ChromeAsyncExtensionFunction {
 109  public:
 110   DECLARE_EXTENSION_FUNCTION("mediaGalleries.getMediaFileSystems",
 111                              MEDIAGALLERIES_GETMEDIAFILESYSTEMS)
 112
 113  protected:
 114   ~MediaGalleriesGetMediaFileSystemsFunction() override;
 115   bool RunAsync() override;
 116
 117  private:
 118   // Bottom half for RunAsync, invoked after the preferences is initialized.
 119   void OnPreferencesInit(
 120       MediaGalleries::GetMediaFileSystemsInteractivity interactive);
 121
 122   // Always show the dialog.
 123   void AlwaysShowDialog(const std::vector<MediaFileSystemInfo>& filesystems);
 124
 125   // If no galleries are found, show the dialog, otherwise return them.
 126   void ShowDialogIfNoGalleries(
 127       const std::vector<MediaFileSystemInfo>& filesystems);
 128
 129   // Grabs galleries from the media file system registry and passes them to
 130   // |ReturnGalleries|.
 131   void GetAndReturnGalleries();
 132
 133   // Returns galleries to the caller.
 134   void ReturnGalleries(const std::vector<MediaFileSystemInfo>& filesystems);
 135
 136   // Shows the configuration dialog to edit gallery preferences.
 137   void ShowDialog();
 138
 139   // A helper method that calls
 140   // MediaFileSystemRegistry::GetMediaFileSystemsForExtension().
 141   void GetMediaFileSystemsForExtension(const MediaFileSystemsCallback& cb);
 142 };
 143
 144 class MediaGalleriesGetAllMediaFileSystemMetadataFunction
 145     : public ChromeAsyncExtensionFunction {
 146  public:
 147   DECLARE_EXTENSION_FUNCTION("mediaGalleries.getAllMediaFileSystemMetadata",
 148                              MEDIAGALLERIES_GETALLMEDIAFILESYSTEMMETADATA)
 149
 150  protected:
 151   ~MediaGalleriesGetAllMediaFileSystemMetadataFunction() override;
 152   bool RunAsync() override;
 153
 154  private:
 155   // Bottom half for RunAsync, invoked after the preferences is initialized.
 156   // Gets the list of permitted galleries and checks if they are available.
 157   void OnPreferencesInit();
 158
 159   // Callback to run upon getting the list of available devices.
 160   // Sends the list of media filesystem metadata back to the extension.
 161   void OnGetGalleries(
 162       const MediaGalleryPrefIdSet& permitted_gallery_ids,
 163       const storage_monitor::MediaStorageUtil::DeviceIdSet* available_devices);
 164 };
 165
 166 class MediaGalleriesAddUserSelectedFolderFunction
 167     : public ChromeAsyncExtensionFunction {
 168  public:
 169   DECLARE_EXTENSION_FUNCTION("mediaGalleries.addUserSelectedFolder",
 170                              MEDIAGALLERIES_ADDUSERSELECTEDFOLDER)
 171
 172  protected:
 173   ~MediaGalleriesAddUserSelectedFolderFunction() override;
 174   bool RunAsync() override;
 175
 176  private:
 177   // Bottom half for RunAsync, invoked after the preferences is initialized.
 178   void OnPreferencesInit();
 179
 180   // Callback for the directory prompt request, with the input from the user.
 181   // If |selected_directory| is empty, then the user canceled.
 182   // Either handle the user canceled case or add the selected gallery.
 183   void OnDirectorySelected(const base::FilePath& selected_directory);
 184
 185   // Callback for the directory prompt request. |pref_id| is for the gallery
 186   // the user just added. |filesystems| is the entire list of file systems.
 187   // The fsid for the file system that corresponds to |pref_id| will be
 188   // appended to the list of file systems returned to the caller. The
 189   // Javascript binding for this API will interpret the list appropriately.
 190   void ReturnGalleriesAndId(
 191       MediaGalleryPrefId pref_id,
 192       const std::vector<MediaFileSystemInfo>& filesystems);
 193
 194   // A helper method that calls
 195   // MediaFileSystemRegistry::GetMediaFileSystemsForExtension().
 196   void GetMediaFileSystemsForExtension(const MediaFileSystemsCallback& cb);
 197 };
 198
 199 class MediaGalleriesDropPermissionForMediaFileSystemFunction
 200     : public ChromeAsyncExtensionFunction {
 201  public:
 202   DECLARE_EXTENSION_FUNCTION("mediaGalleries.dropPermissionForMediaFileSystem",
 203                              MEDIAGALLERIES_DROPPERMISSIONFORMEDIAFILESYSTEM)
 204
 205  protected:
 206   ~MediaGalleriesDropPermissionForMediaFileSystemFunction() override;
 207   bool RunAsync() override;
 208
 209  private:
 210   // Bottom half for RunAsync, invoked after the preferences is initialized.
 211   void OnPreferencesInit(MediaGalleryPrefId pref_id);
 212 };
 213
 214 class MediaGalleriesStartMediaScanFunction
 215     : public ChromeAsyncExtensionFunction {
 216  public:
 217   DECLARE_EXTENSION_FUNCTION("mediaGalleries.startMediaScan",
 218                              MEDIAGALLERIES_STARTMEDIASCAN)
 219
 220  protected:
 221   ~MediaGalleriesStartMediaScanFunction() override;
 222   bool RunAsync() override;
 223
 224  private:
 225   // Bottom half for RunAsync, invoked after the preferences is initialized.
 226   void OnPreferencesInit();
 227 };
 228
 229 class MediaGalleriesCancelMediaScanFunction
 230     : public ChromeAsyncExtensionFunction {
 231  public:
 232   DECLARE_EXTENSION_FUNCTION("mediaGalleries.cancelMediaScan",
 233                              MEDIAGALLERIES_CANCELMEDIASCAN)
 234
 235  protected:
 236   ~MediaGalleriesCancelMediaScanFunction() override;
 237   bool RunAsync() override;
 238
 239  private:
 240   // Bottom half for RunAsync, invoked after the preferences is initialized.
 241   void OnPreferencesInit();
 242 };
 243
 244 class MediaGalleriesAddScanResultsFunction
 245     : public ChromeAsyncExtensionFunction {
 246  public:
 247   DECLARE_EXTENSION_FUNCTION("mediaGalleries.addScanResults",
 248                              MEDIAGALLERIES_ADDSCANRESULTS)
 249
 250  protected:
 251   ~MediaGalleriesAddScanResultsFunction() override;
 252   bool RunAsync() override;
 253
 254   // Pulled out for testing.
 255   virtual MediaGalleriesScanResultController* MakeDialog(
 256       content::WebContents* web_contents,
 257       const extensions::Extension& extension,
 258       const base::Closure& on_finish);
 259
 260  private:
 261   // Bottom half for RunAsync, invoked after the preferences is initialized.
 262   void OnPreferencesInit();
 263
 264   // Grabs galleries from the media file system registry and passes them to
 265   // ReturnGalleries().
 266   void GetAndReturnGalleries();
 267
 268   // Returns galleries to the caller.
 269   void ReturnGalleries(const std::vector<MediaFileSystemInfo>& filesystems);
 270 };
 271
 272 class MediaGalleriesGetMetadataFunction : public ChromeAsyncExtensionFunction {
 273  public:
 274   DECLARE_EXTENSION_FUNCTION("mediaGalleries.getMetadata",
 275                              MEDIAGALLERIES_GETMETADATA)
 276
 277  protected:
 278   ~MediaGalleriesGetMetadataFunction() override;
 279   bool RunAsync() override;
 280
 281  private:
 282   // Bottom half for RunAsync, invoked after the preferences is initialized.
 283   void OnPreferencesInit(MediaGalleries::GetMetadataType metadata_type,
 284                          const std::string& blob_uuid);
 285
 286   void GetMetadata(MediaGalleries::GetMetadataType metadata_type,
 287                    const std::string& blob_uuid,
 288                    scoped_ptr<std::string> blob_header,
 289                    int64 total_blob_length);
 290
 291   void OnSafeMediaMetadataParserDone(
 292       bool parse_success, scoped_ptr<base::DictionaryValue> result_dictionary,
 293       scoped_ptr<std::vector<metadata::AttachedImage> > attached_images);
 294
 295   void ConstructNextBlob(
 296       scoped_ptr<base::DictionaryValue> result_dictionary,
 297       scoped_ptr<std::vector<metadata::AttachedImage> > attached_images,
 298       scoped_ptr<std::vector<std::string> > blob_uuids,
 299       scoped_ptr<content::BlobHandle> current_blob);
 300 };
 301
 302 class MediaGalleriesAddGalleryWatchFunction
 303     : public ChromeAsyncExtensionFunction {
 304  public:
 305   DECLARE_EXTENSION_FUNCTION("mediaGalleries.addGalleryWatch",
 306                              MEDIAGALLERIES_ADDGALLERYWATCH);
 307
 308  protected:
 309   ~MediaGalleriesAddGalleryWatchFunction() override;
 310   bool RunAsync() override;
 311
 312  private:
 313   void OnPreferencesInit(const std::string& pref_id);
 314
 315   // Gallery watch request handler.
 316   void HandleResponse(MediaGalleryPrefId gallery_id, const std::string& error);
 317 };
 318
 319 class MediaGalleriesRemoveGalleryWatchFunction
 320     : public ChromeAsyncExtensionFunction {
 321  public:
 322   DECLARE_EXTENSION_FUNCTION("mediaGalleries.removeGalleryWatch",
 323                              MEDIAGALLERIES_REMOVEGALLERYWATCH);
 324
 325  protected:
 326   ~MediaGalleriesRemoveGalleryWatchFunction() override;
 327   bool RunAsync() override;
 328
 329  private:
 330   void OnPreferencesInit(const std::string& pref_id);
 331 };
 332
 333 class MediaGalleriesGetAllGalleryWatchFunction
 334     : public ChromeAsyncExtensionFunction {
 335  public:
 336   DECLARE_EXTENSION_FUNCTION("mediaGalleries.getAllGalleryWatch",
 337                              MEDIAGALLERIES_GETALLGALLERYWATCH);
 338
 339  protected:
 340   ~MediaGalleriesGetAllGalleryWatchFunction() override;
 341   bool RunAsync() override;
 342
 343  private:
 344   void OnPreferencesInit();
 345 };
 346
 347 class MediaGalleriesRemoveAllGalleryWatchFunction
 348     : public ChromeAsyncExtensionFunction {
 349  public:
 350   DECLARE_EXTENSION_FUNCTION("mediaGalleries.removeAllGalleryWatch",
 351                              MEDIAGALLERIES_REMOVEALLGALLERYWATCH);
 352
 353  protected:
 354   ~MediaGalleriesRemoveAllGalleryWatchFunction() override;
 355   bool RunAsync() override;
 356
 357  private:
 358   void OnPreferencesInit();
 359 };
 360
 361 }  // namespace extensions
 362
 363 #endif  // CHROME_BROWSER_EXTENSIONS_API_MEDIA_GALLERIES_MEDIA_GALLERIES_API_H_