Make a controller interface for media galleries dialogs.

chrome/browser/media_galleries/media_galleries_permission_controller.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_GALLERIES_MEDIA_GALLERIES_DIALOG_CONTROLLER_H_
-#define CHROME_BROWSER_MEDIA_GALLERIES_MEDIA_GALLERIES_DIALOG_CONTROLLER_H_
+#ifndef CHROME_BROWSER_MEDIA_GALLERIES_MEDIA_GALLERIES_PERMISSION_CONTROLLER_H_
+#define CHROME_BROWSER_MEDIA_GALLERIES_MEDIA_GALLERIES_PERMISSION_CONTROLLER_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/strings/string16.h"
+#include "chrome/browser/media_galleries/media_galleries_dialog_controller.h"
 #include "chrome/browser/media_galleries/media_galleries_preferences.h"
 #include "components/storage_monitor/removable_storage_observer.h"
 #include "ui/gfx/native_widget_types.h"
 #include "ui/shell_dialogs/select_file_dialog.h"
 
 namespace content {
 class WebContents;
 }
 
 namespace extensions {
@@ skipping 10 matching lines @@
 
 // Newly added galleries are not added to preferences until the dialog commits,
 // so they do not have a pref id while the dialog is open; leading to
 // complicated code in the dialogs. To solve this complication, the controller
 // maps pref ids into a new space where it can also assign ids to new galleries.
 // The new number space is only valid for the lifetime of the controller. To
 // make it more clear where real pref ids are used and where the fake ids are
 // used, the GalleryDialogId type is used where fake ids are needed.
 typedef MediaGalleryPrefId GalleryDialogId;
 
-// The view.
-class MediaGalleriesDialog {
- public:
-  virtual ~MediaGalleriesDialog();
-
-  // Tell the dialog to update its display list of galleries.
-  virtual void UpdateGalleries() = 0;
-
-  // Constructs a platform-specific dialog owned and controlled by |controller|.
-  static MediaGalleriesDialog* Create(
-      MediaGalleriesDialogController* controller);
-};
-
-// The controller is responsible for handling the logic of the dialog and
-// interfacing with the model (i.e., MediaGalleriesPreferences). It shows
-// the dialog and owns itself.
-class MediaGalleriesDialogController
-    : public ui::SelectFileDialog::Listener,
+class MediaGalleriesPermissionController
+    : public MediaGalleriesDialogController,
+      public ui::SelectFileDialog::Listener,
       public storage_monitor::RemovableStorageObserver,
       public MediaGalleriesPreferences::GalleryChangeObserver {
  public:
-  struct GalleryPermission {
-    GalleryPermission(GalleryDialogId gallery_id,
-                      const MediaGalleryPrefInfo& pref_info,
-                      bool allowed)
-        : gallery_id(gallery_id),
-          pref_info(pref_info),
-          allowed(allowed) {
-    }
-    GalleryPermission() {}
+  // The constructor creates a dialog controller which owns itself.
+  MediaGalleriesPermissionController(content::WebContents* web_contents,
+                                     const extensions::Extension& extension,
+                                     const base::Closure& on_finish);
 
-    GalleryDialogId gallery_id;
-    MediaGalleryPrefInfo pref_info;
-    bool allowed;
-  };
-
-  typedef std::vector<GalleryPermission> GalleryPermissionsVector;
-
-  // The constructor creates a dialog controller which owns itself.
-  MediaGalleriesDialogController(content::WebContents* web_contents,
-                                 const extensions::Extension& extension,
-                                 const base::Closure& on_finish);
-
-  // The title of the dialog view.
-  base::string16 GetHeader() const;
-
-  // Explanatory text directly below the title.
-  base::string16 GetSubtext() const;
-
-  // Header for unattached devices part of the dialog.
-  base::string16 GetUnattachedLocationsHeader() const;
-
-  // Initial state of whether the dialog's confirmation button will be enabled.
-  bool IsAcceptAllowed() const;
-
-  // Get the set of permissions to attached galleries.
-  virtual GalleryPermissionsVector AttachedPermissions() const;
-
-  // Get the set of permissions to unattached galleries.
-  virtual GalleryPermissionsVector UnattachedPermissions() const;
-
-  // Called when the add-folder button in the dialog is clicked.
-  virtual void OnAddFolderClicked();
-
-  // A checkbox beside a gallery permission was checked. The full set
-  // of gallery permissions checkbox settings is sent on every checkbox toggle.
-  virtual void DidToggleGallery(GalleryDialogId gallery_id, bool enabled);
-
-  // The forget command in the context menu was selected.
-  virtual void DidForgetGallery(GalleryDialogId gallery_id);
-
-  // The dialog is being deleted.
-  virtual void DialogFinished(bool accepted);
-
-  virtual content::WebContents* web_contents();
-
-  ui::MenuModel* GetContextMenu(GalleryDialogId gallery_id);
+  // MediaGalleriesDialogController implementation.
+  virtual base::string16 GetHeader() const OVERRIDE;
+  virtual base::string16 GetSubtext() const OVERRIDE;
+  virtual bool IsAcceptAllowed() const OVERRIDE;
+  virtual bool ShouldShowFolderViewer(const Entry& entry) const OVERRIDE;
+  virtual std::vector<base::string16> GetSectionHeaders() const OVERRIDE;
+  virtual Entries GetSectionEntries(size_t index) const OVERRIDE;
+  // Auxiliary button for this dialog is the 'Add Folder' button.
+  virtual base::string16 GetAuxiliaryButtonText() const OVERRIDE;
+  virtual void DidClickAuxiliaryButton() OVERRIDE;
+  virtual void DidToggleEntry(GalleryDialogId gallery_id,
+                              bool selected) OVERRIDE;
+  virtual void DidClickOpenFolderViewer(GalleryDialogId gallery_id) OVERRIDE;
+  virtual void DidForgetEntry(GalleryDialogId gallery_id) OVERRIDE;
+  virtual base::string16 GetAcceptButtonText() const OVERRIDE;
+  virtual void DialogFinished(bool accepted) OVERRIDE;
+  virtual ui::MenuModel* GetContextMenu(GalleryDialogId gallery_id) OVERRIDE;
+  virtual content::WebContents* WebContents() OVERRIDE;
 
  protected:
-  friend class MediaGalleriesDialogControllerTest;
+  friend class MediaGalleriesPermissionControllerTest;
 
   typedef base::Callback<MediaGalleriesDialog* (
       MediaGalleriesDialogController*)> CreateDialogCallback;
 
   // For use with tests.
-  MediaGalleriesDialogController(
+  MediaGalleriesPermissionController(
       const extensions::Extension& extension,
       MediaGalleriesPreferences* preferences,
       const CreateDialogCallback& create_dialog_callback,
       const base::Closure& on_finish);
 
-  virtual ~MediaGalleriesDialogController();
+  virtual ~MediaGalleriesPermissionController();
 
  private:
   // This type keeps track of media galleries already known to the prefs system.
-  typedef std::map<GalleryDialogId, GalleryPermission>
-      GalleryPermissionsMap;
+  typedef std::map<GalleryDialogId, Entry> GalleryPermissionsMap;
 
   class DialogIdMap {
    public:
     DialogIdMap();
     ~DialogIdMap();
     GalleryDialogId GetDialogId(MediaGalleryPrefId pref_id);
+    MediaGalleryPrefId GetPrefId(GalleryDialogId id);
 
    private:
     GalleryDialogId next_dialog_id_;
-    std::map<GalleryDialogId, MediaGalleryPrefId> mapping_;
+    std::map<MediaGalleryPrefId, GalleryDialogId> back_map_;
+    std::vector<MediaGalleryPrefId> forward_mapping_;
     DISALLOW_COPY_AND_ASSIGN(DialogIdMap);
   };
 
 
   // Bottom half of constructor -- called when |preferences_| is initialized.
   void OnPreferencesInitialized();
 
   // SelectFileDialog::Listener implementation:
   virtual void FileSelected(const base::FilePath& path,
                             int index,
@@ skipping 41 matching lines @@
   void SavePermissions();
 
   // Updates the model and view when |preferences_| changes. Some of the
   // possible changes includes a gallery getting blacklisted, or a new
   // auto detected gallery becoming available.
   void UpdateGalleriesOnPreferencesEvent();
 
   // Updates the model and view when a device is attached or detached.
   void UpdateGalleriesOnDeviceEvent(const std::string& device_id);
 
-  // Return a sorted vector of either attached or unattached gallery
-  // permissions.
-  GalleryPermissionsVector FillPermissions(bool attached) const;
-
   GalleryDialogId GetDialogId(MediaGalleryPrefId pref_id);
+  MediaGalleryPrefId GetPrefId(GalleryDialogId id);
 
   Profile* GetProfile();
 
   // The web contents from which the request originated.
   content::WebContents* web_contents_;
 
   // This is just a reference, but it's assumed that it won't become invalid
   // while the dialog is showing.
   const extensions::Extension* extension_;
 
@@ skipping 24 matching lines @@
   // The view that's showing.
   scoped_ptr<MediaGalleriesDialog> dialog_;
 
   scoped_refptr<ui::SelectFileDialog> select_folder_dialog_;
 
   scoped_ptr<MediaGalleryContextMenu> context_menu_;
 
   // Creates the dialog. Only changed for unit tests.
   CreateDialogCallback create_dialog_callback_;
 
-  DISALLOW_COPY_AND_ASSIGN(MediaGalleriesDialogController);
+  DISALLOW_COPY_AND_ASSIGN(MediaGalleriesPermissionController);
 };
 
-#endif  // CHROME_BROWSER_MEDIA_GALLERIES_MEDIA_GALLERIES_DIALOG_CONTROLLER_H_
+#endif  // CHROME_BROWSER_MEDIA_GALLERIES_MEDIA_GALLERIES_PERMISSION_CONTROLLER_H_