summaryrefslogtreecommitdiffstats
path: root/chrome/browser/media_gallery/media_gallery_registry.h
blob: f6bebe5e49b9870ecc230cfdc2b7a60aa47e7df6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
// 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_GALLERY_REGISTRY_H_
#define CHROME_BROWSER_MEDIA_GALLERY_MEDIA_GALLERY_REGISTRY_H_

#include <list>
#include <string>

#include "base/basictypes.h"
#include "base/file_path.h"
#include "base/string16.h"
#include "chrome/browser/profiles/profile_keyed_service.h"

namespace base {
class DictionaryValue;
}

class PrefService;
class Profile;

struct MediaGallery {
  MediaGallery();
  ~MediaGallery();

  // The ID that uniquely, persistently identifies the gallery.
  uint64 id;

  // 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 user-visible name of this gallery.
  string16 display_name;
};

// 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?
class MediaGalleryRegistry : public ProfileKeyedService {
 public:
  explicit MediaGalleryRegistry(Profile* profile);
  virtual ~MediaGalleryRegistry();

  // 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);

  // Removes the gallery identified by |id| from the store.
  void ForgetGalleryById(uint64 id);

  typedef std::list<MediaGallery> MediaGalleries;

  const MediaGalleries& remembered_galleries() const {
    return remembered_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_;

  DISALLOW_COPY_AND_ASSIGN(MediaGalleryRegistry);
};

#endif  // CHROME_BROWSER_MEDIA_GALLERY_MEDIA_GALLERY_REGISTRY_H_