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_UTILS_H_ 6 #define COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_UTILS_H_ 7 8 #include <string> 9 #include <vector> 10 11 #include "base/strings/string16.h" 12 #include "base/strings/utf_offset_string_conversions.h" 13 #include "components/bookmarks/browser/bookmark_node_data.h" 14 15 class BookmarkClient; 16 class BookmarkModel; 17 class BookmarkNode; 18 class GURL; 19 20 namespace user_prefs { 21 class PrefRegistrySyncable; 22 } 23 24 // A collection of bookmark utility functions used by various parts of the UI 25 // that show bookmarks (bookmark manager, bookmark bar view, ...) and other 26 // systems that involve indexing and searching bookmarks. 27 namespace bookmark_utils { 28 29 // Fields to use when finding matching bookmarks. 30 struct QueryFields { 31 QueryFields(); 32 ~QueryFields(); 33 34 scoped_ptr<base::string16> word_phrase_query; 35 scoped_ptr<base::string16> url; 36 scoped_ptr<base::string16> title; 37 }; 38 39 // Clones bookmark node, adding newly created nodes to |parent| starting at 40 // |index_to_add_at|. If |reset_node_times| is true cloned bookmarks and 41 // folders will receive new creation times and folder modification times 42 // instead of using the values stored in |elements|. 43 void CloneBookmarkNode(BookmarkModel* model, 44 const std::vector<BookmarkNodeData::Element>& elements, 45 const BookmarkNode* parent, 46 int index_to_add_at, 47 bool reset_node_times); 48 49 // Copies nodes onto the clipboard. If |remove_nodes| is true the nodes are 50 // removed after copied to the clipboard. The nodes are copied in such a way 51 // that if pasted again copies are made. 52 void CopyToClipboard(BookmarkModel* model, 53 const std::vector<const BookmarkNode*>& nodes, 54 bool remove_nodes); 55 56 // Pastes from the clipboard. The new nodes are added to |parent|, unless 57 // |parent| is null in which case this does nothing. The nodes are inserted 58 // at |index|. If |index| is -1 the nodes are added to the end. 59 void PasteFromClipboard(BookmarkModel* model, 60 const BookmarkNode* parent, 61 int index); 62 63 // Returns true if the user can copy from the pasteboard. 64 bool CanPasteFromClipboard(BookmarkModel* model, const BookmarkNode* node); 65 66 // Returns a vector containing up to |max_count| of the most recently modified 67 // user folders. This never returns an empty vector. 68 std::vector<const BookmarkNode*> GetMostRecentlyModifiedUserFolders( 69 BookmarkModel* model, size_t max_count); 70 71 // Returns the most recently added bookmarks. This does not return folders, 72 // only nodes of type url. 73 void GetMostRecentlyAddedEntries(BookmarkModel* model, 74 size_t count, 75 std::vector<const BookmarkNode*>* nodes); 76 77 // Returns true if |n1| was added more recently than |n2|. 78 bool MoreRecentlyAdded(const BookmarkNode* n1, const BookmarkNode* n2); 79 80 // Returns up to |max_count| bookmarks from |model| whose url or title contain 81 // the text |query.word_phrase_query| and exactly match |query.url| and 82 // |query.title|, for all of the preceding fields that are not NULL. 83 // |languages| is user's accept-language setting to decode IDN. 84 void GetBookmarksMatchingProperties(BookmarkModel* model, 85 const QueryFields& query, 86 size_t max_count, 87 const std::string& languages, 88 std::vector<const BookmarkNode*>* nodes); 89 90 // Register user preferences for Bookmarks Bar. 91 void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry); 92 93 // Returns the parent for newly created folders/bookmarks. If |selection| has 94 // one element and it is a folder, |selection[0]| is returned, otherwise 95 // |parent| is returned. If |index| is non-null it is set to the index newly 96 // added nodes should be added at. 97 const BookmarkNode* GetParentForNewNodes( 98 const BookmarkNode* parent, 99 const std::vector<const BookmarkNode*>& selection, 100 int* index); 101 102 // Deletes the bookmark folders for the given list of |ids|. 103 void DeleteBookmarkFolders(BookmarkModel* model, const std::vector<int64>& ids); 104 105 // If there are no user bookmarks for url, a bookmark is created. 106 void AddIfNotBookmarked(BookmarkModel* model, 107 const GURL& url, 108 const base::string16& title); 109 110 // Removes all bookmarks for the given |url|. 111 void RemoveAllBookmarks(BookmarkModel* model, const GURL& url); 112 113 // Truncates an overly-long URL, unescapes it and interprets the characters 114 // as UTF-8 (both via net::FormatUrl()), and lower-cases it, returning the 115 // result. |languages| is passed to net::FormatUrl(). |adjustments|, if 116 // non-NULL, is set to reflect the transformations the URL spec underwent to 117 // become the return value. If a caller computes offsets (e.g., for the 118 // position of matched text) in this cleaned-up string, it can use 119 // |adjustments| to calculate the location of these offsets in the original 120 // string (via base::OffsetAdjuster::UnadjustOffsets()). This is useful if 121 // later the original string gets formatted in a different way for displaying. 122 // In this case, knowing the offsets in the original string will allow them to 123 // be properly translated to offsets in the newly-formatted string. 124 // 125 // The unescaping done by this function makes it possible to match substrings 126 // that were originally escaped for navigation; for example, if the user 127 // searched for "a&p", the query would be escaped as "a%26p", so without 128 // unescaping, an input string of "a&p" would no longer match this URL. Note 129 // that the resulting unescaped URL may not be directly navigable (which is 130 // why it was escaped to begin with). 131 base::string16 CleanUpUrlForMatching( 132 const GURL& gurl, 133 const std::string& languages, 134 base::OffsetAdjuster::Adjustments* adjustments); 135 136 // Returns the lower-cased title, possibly truncated if the original title 137 // is overly-long. 138 base::string16 CleanUpTitleForMatching(const base::string16& title); 139 140 // Returns true if all the |nodes| can be edited by the user, 141 // as determined by BookmarkClient::CanBeEditedByUser(). 142 bool CanAllBeEditedByUser(BookmarkClient* client, 143 const std::vector<const BookmarkNode*>& nodes); 144 145 // Returns true if |url| has a bookmark in the |model| that can be edited 146 // by the user. 147 bool IsBookmarkedByUser(BookmarkModel* model, const GURL& url); 148 149 } // namespace bookmark_utils 150 151 // Returns the node with |id|, or NULL if there is no node with |id|. 152 const BookmarkNode* GetBookmarkNodeByID(const BookmarkModel* model, int64 id); 153 154 #endif // COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_UTILS_H_ 155