components/bookmarks/browser/bookmark_node_data.h

   1 // Copyright 2014 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 #ifndef COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_NODE_DATA_H_
   6 #define COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_NODE_DATA_H_
   7
   8 #include <vector>
   9
  10 #include "base/files/file_path.h"
  11 #include "base/strings/string16.h"
  12 #include "base/time/time.h"
  13 #include "components/bookmarks/browser/bookmark_node.h"
  14 #include "ui/base/clipboard/clipboard_types.h"
  15 #include "url/gurl.h"
  16
  17 #if defined(TOOLKIT_VIEWS)
  18 #include "ui/base/dragdrop/os_exchange_data.h"
  19 #endif
  20
  21 namespace base {
  22 class Pickle;
  23 class PickleIterator;
  24 }
  25
  26 namespace bookmarks {
  27
  28 class BookmarkModel;
  29
  30 // BookmarkNodeData is used to represent the following:
  31 //
  32 // . A single URL.
  33 // . A single node from the bookmark model.
  34 // . A set of nodes from the bookmark model.
  35 //
  36 // BookmarkNodeData is used by bookmark related views to represent a dragged
  37 // bookmark or bookmarks.
  38 //
  39 // Typical usage when writing data for a drag is:
  40 //   BookmarkNodeData data(node_user_is_dragging);
  41 //   data.Write(os_exchange_data_for_drag);
  42 //
  43 // Typical usage to read is:
  44 //   BookmarkNodeData data;
  45 //   if (data.Read(os_exchange_data))
  46 //     // data is valid, contents are in elements.
  47
  48 struct BookmarkNodeData {
  49   // Element represents a single node.
  50   struct Element {
  51     Element();
  52     explicit Element(const BookmarkNode* node);
  53     ~Element();
  54
  55     // If true, this element represents a URL.
  56     bool is_url;
  57
  58     // The URL, only valid if is_url is true.
  59     GURL url;
  60
  61     // Title of the entry, used for both urls and folders.
  62     base::string16 title;
  63
  64     // Date of when this node was created.
  65     base::Time date_added;
  66
  67     // Date of the last modification. Only used for folders.
  68     base::Time date_folder_modified;
  69
  70     // Children, only used for non-URL nodes.
  71     std::vector<Element> children;
  72
  73     // Meta info for the bookmark node.
  74     BookmarkNode::MetaInfoMap meta_info_map;
  75
  76     int64 id() const { return id_; }
  77
  78    private:
  79     friend struct BookmarkNodeData;
  80
  81     // For reading/writing this Element.
  82     void WriteToPickle(base::Pickle* pickle) const;
  83     bool ReadFromPickle(base::PickleIterator* iterator);
  84
  85     // ID of the node.
  86     int64 id_;
  87   };
  88
  89   // The MIME type for the clipboard format for BookmarkNodeData.
  90   static const char* kClipboardFormatString;
  91
  92   BookmarkNodeData();
  93
  94   // Created a BookmarkNodeData populated from the arguments.
  95   explicit BookmarkNodeData(const BookmarkNode* node);
  96   explicit BookmarkNodeData(const std::vector<const BookmarkNode*>& nodes);
  97
  98   ~BookmarkNodeData();
  99
 100 #if defined(TOOLKIT_VIEWS)
 101   static const ui::OSExchangeData::CustomFormat& GetBookmarkCustomFormat();
 102 #endif
 103
 104   static bool ClipboardContainsBookmarks();
 105
 106   // Reads bookmarks from the given vector.
 107   bool ReadFromVector(const std::vector<const BookmarkNode*>& nodes);
 108
 109   // Creates a single-bookmark DragData from url/title pair.
 110   bool ReadFromTuple(const GURL& url, const base::string16& title);
 111
 112   // Writes bookmarks to the specified clipboard.
 113   void WriteToClipboard(ui::ClipboardType type);
 114
 115   // Reads bookmarks from the specified clipboard. Prefers data written via
 116   // WriteToClipboard() but will also attempt to read a plain bookmark.
 117   bool ReadFromClipboard(ui::ClipboardType type);
 118
 119 #if defined(TOOLKIT_VIEWS)
 120   // Writes elements to data. If there is only one element and it is a URL
 121   // the URL and title are written to the clipboard in a format other apps can
 122   // use.
 123   // |profile_path| is used to identify which profile the data came from. Use an
 124   // empty path to indicate that the data is not associated with any profile.
 125   void Write(const base::FilePath& profile_path,
 126              ui::OSExchangeData* data) const;
 127
 128   // Restores this data from the clipboard, returning true on success.
 129   bool Read(const ui::OSExchangeData& data);
 130 #endif
 131
 132   // Writes the data for a drag to |pickle|.
 133   void WriteToPickle(const base::FilePath& profile_path,
 134                      base::Pickle* pickle) const;
 135
 136   // Reads the data for a drag from a |pickle|.
 137   bool ReadFromPickle(base::Pickle* pickle);
 138
 139   // Returns the nodes represented by this DragData. If this DragData was
 140   // created from the same profile then the nodes from the model are returned.
 141   // If the nodes can't be found (may have been deleted), an empty vector is
 142   // returned.
 143   std::vector<const BookmarkNode*> GetNodes(
 144       BookmarkModel* model,
 145       const base::FilePath& profile_path) const;
 146
 147   // Convenience for getting the first node. Returns NULL if the data doesn't
 148   // match any nodes or there is more than one node.
 149   const BookmarkNode* GetFirstNode(BookmarkModel* model,
 150                                    const base::FilePath& profile_path) const;
 151
 152   // Do we contain valid data?
 153   bool is_valid() const { return !elements.empty(); }
 154
 155   // Returns true if there is a single url.
 156   bool has_single_url() const { return size() == 1 && elements[0].is_url; }
 157
 158   // Number of elements.
 159   size_t size() const { return elements.size(); }
 160
 161   // Clears the data.
 162   void Clear();
 163
 164   // Sets |profile_path_|. This is useful for the constructors/readers that
 165   // don't set it. This should only be called if the profile path is not
 166   // already set.
 167   void SetOriginatingProfilePath(const base::FilePath& profile_path);
 168
 169   // Returns true if this data is from the specified profile path.
 170   bool IsFromProfilePath(const base::FilePath& profile_path) const;
 171
 172   // The actual elements written to the clipboard.
 173   std::vector<Element> elements;
 174
 175  private:
 176   // Path of the profile we originated from.
 177   base::FilePath profile_path_;
 178 };
 179
 180 }  // namespace bookmarks
 181
 182 #endif  // COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_NODE_DATA_H_