Add gallery permissions to Media Galleries Preferences

chrome/browser/media_gallery/media_galleries_preferences.h

 // 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.
 
 #ifndef CHROME_BROWSER_MEDIA_GALLERY_MEDIA_GALLERIES_PREFERENCES_H_
 #define CHROME_BROWSER_MEDIA_GALLERY_MEDIA_GALLERIES_PREFERENCES_H_
 
-#include <list>
+#include <map>
 #include <string>
+#include <vector>
 
 #include "base/basictypes.h"
 #include "base/file_path.h"
 #include "base/string16.h"
 #include "chrome/browser/profiles/profile_keyed_service.h"
 
 class PrefService;
 class Profile;
 
 namespace base {
 class DictionaryValue;
 }
 
+namespace extensions {
+class Extension;
+class ExtensionPrefs;
+}
+
+namespace chrome {
+
 typedef uint64 MediaGalleryPrefId;
 
 struct MediaGalleryPermission {
   MediaGalleryPrefId pref_id;
   bool has_permission;
 };
 
-struct MediaGallery {
-  MediaGallery();
-  ~MediaGallery();
+struct MediaGalleryPrefInfo {
+  enum Type {
+    kAutoDetected,  // Auto added to the list of galleries.
+    kUserAdded,     // Explicitly added by the user.
+    kBlackListed,   // Auto added but then removed by the user.
+  };
 
-  // The ID that uniquely, persistently identifies the gallery.
-  uint64 id;
+  MediaGalleryPrefInfo();
+  ~MediaGalleryPrefInfo();
 
-  // The directory where the gallery is located, relative to the base path
-  // for the device.
-  FilePath path;
-
-  // The base path of the device.
-  FilePath base_path;
-
-  // A string which identifies the device that the gallery lives on.
-  std::string identifier;
+  // The ID that identifies this gallery in this Profile.
+  MediaGalleryPrefId pref_id;
 
   // The user-visible name of this gallery.
   string16 display_name;
+
+  // A string which uniquely and persistently identifies the device that the
+  // gallery lives on.
+  std::string device_id;
+
+  // The root of the gallery, relative to the root of the device.
+  FilePath path;
+
+  // The type of gallery.
+  Type type;
 };
 
-// A class to manage the media galleries that the user has added, explicitly or
-// otherwise. There is one registry per user profile.
-// TODO(estade): should MediaFileSystemRegistry be merged into this class?
+typedef std::map<MediaGalleryPrefId, MediaGalleryPrefInfo>
+    MediaGalleriesPrefInfoMap;
+
+// A class to manage the media gallery preferences.  There is one registry per
+// user profile.
 class MediaGalleriesPreferences : public ProfileKeyedService {
  public:
-  typedef std::list<MediaGallery> MediaGalleries;
 
   explicit MediaGalleriesPreferences(Profile* profile);
   virtual ~MediaGalleriesPreferences();
 
   // Builds |remembered_galleries_| from the persistent store.
   void InitFromPrefs();
 
-  // Teaches the registry about a new gallery defined by |path| (which should
-  // be a directory).
-  void AddGalleryByPath(const FilePath& path);
+  // Lookup a gallery and fill in information about it, or return false.
+  // TODO(vandebo) figure out if we want this to be async, in which case:
+  // void LookupGalleryByPath(FilePath&path, callback(const MediaGalleryInfo&))
+  bool LookupGalleryByPath(const FilePath& path,

[Evan Stade, 2012/08/02 17:47:31]

I thought we said that this would never fail, rather it fills in the
MediaGalleryPrefInfo as if for a new gallery.

[vandebo (ex-Chrome), 2012/08/02 17:51:38]

Oops... right, I'll fix that.

[vandebo (ex-Chrome), 2012/08/02 18:26:02]

Done.

+                           MediaGalleryPrefInfo* gallery) const;
+
+  // Teaches the registry about a new gallery.
+  MediaGalleryPrefId AddMediaGallery(const std::string& device_id,
+                                     const string16& display_name,
+                                     const FilePath& path,

[Evan Stade, 2012/08/02 17:47:31]

why take 3 of the members of a MediaGalleryPrefInfo struct, rather than the
struct itself?

[vandebo (ex-Chrome), 2012/08/02 17:51:38]

Because not all the fields can be valid and because some callers may not already
have the info in a struct, so they'd have to put it into one to call this
method, whereas if you have it it one, you just reference the fields at the call
site.

[Evan Stade, 2012/08/02 18:00:54]

are these "some callers" real or hypothetical?

[vandebo (ex-Chrome), 2012/08/02 18:26:02]

Doesn't matter, my point is that I think it's bad form to pass a partially
filled struct and doing it this way doesn't hurt the case where you already have
it in a struct.

[Evan Stade, 2012/08/02 18:36:35]

Technically, you could get rid of the AddMediaGalleryByPath function, but it's
preferable to leave it just for ease of use (as you have done). I see this as
the same thing.

+                                     bool user_added);
+
+  // Teach the registry about a user added registry simply from the path.
+  MediaGalleryPrefId AddMediaGalleryByPath(const FilePath& path);
 
   // Removes the gallery identified by |id| from the store.
-  void ForgetGalleryById(uint64 id);
+  void ForgetMediaGalleryById(MediaGalleryPrefId id);
 
-  const MediaGalleries& remembered_galleries() const {
-    return remembered_galleries_;
+  std::vector<MediaGalleryPrefId> MediaGalleriesForExtension(
+      const extensions::Extension& extension) const;
+
+  void SetMediaGalleryPermissionForExtension(
+      const extensions::Extension& extension,
+      MediaGalleryPrefId pref_id,
+      bool has_permission);
+
+  const MediaGalleriesPrefInfoMap& known_galleries() const {
+    return known_galleries_;
   }
 
   // ProfileKeyedService implementation:
   virtual void Shutdown() OVERRIDE;
 
   static void RegisterUserPrefs(PrefService* prefs);
 
   // Returns true if the media gallery UI is turned on.
   static bool UserInteractionIsEnabled();
 
  private:
   // The profile that owns |this|.
   Profile* profile_;
 
   // An in-memory cache of known galleries.
-  // TODO(estade): either actually use this, or remove it.
-  MediaGalleries remembered_galleries_;
+  MediaGalleriesPrefInfoMap known_galleries_;
+
+  extensions::ExtensionPrefs* GetExtensionPrefs() const;
 
   DISALLOW_COPY_AND_ASSIGN(MediaGalleriesPreferences);
 };
 
+}  // namespace chrome
+
 #endif  // CHROME_BROWSER_MEDIA_GALLERY_MEDIA_GALLERIES_PREFERENCES_H_