123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585 |
- // Copyright 2014 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.
- #include "components/bookmarks/browser/bookmark_utils.h"
- #include <stdint.h>
- #include <memory>
- #include <unordered_set>
- #include <utility>
- #include "base/bind.h"
- #include "base/containers/contains.h"
- #include "base/feature_list.h"
- #include "base/files/file_path.h"
- #include "base/guid.h"
- #include "base/i18n/case_conversion.h"
- #include "base/i18n/string_search.h"
- #include "base/metrics/user_metrics_action.h"
- #include "base/strings/string_util.h"
- #include "base/strings/stringprintf.h"
- #include "base/strings/utf_string_conversions.h"
- #include "base/time/time.h"
- #include "build/build_config.h"
- #include "components/bookmarks/browser/bookmark_client.h"
- #include "components/bookmarks/browser/bookmark_model.h"
- #include "components/bookmarks/browser/scoped_group_bookmark_actions.h"
- #include "components/bookmarks/common/bookmark_pref_names.h"
- #include "components/pref_registry/pref_registry_syncable.h"
- #include "components/prefs/pref_service.h"
- #include "components/query_parser/query_parser.h"
- #include "components/url_formatter/url_formatter.h"
- #include "ui/base/clipboard/clipboard.h"
- #include "ui/base/data_transfer_policy/data_transfer_endpoint.h"
- #include "ui/base/models/tree_node_iterator.h"
- #include "url/gurl.h"
- using base::Time;
- namespace bookmarks {
- namespace {
- // The maximum length of URL or title returned by the Cleanup functions.
- const size_t kCleanedUpUrlMaxLength = 1024u;
- const size_t kCleanedUpTitleMaxLength = 1024u;
- void CloneBookmarkNodeImpl(BookmarkModel* model,
- const BookmarkNodeData::Element& element,
- const BookmarkNode* parent,
- size_t index_to_add_at,
- bool reset_node_times) {
- // Make sure to not copy non clonable keys.
- BookmarkNode::MetaInfoMap meta_info_map = element.meta_info_map;
- for (const std::string& key : model->non_cloned_keys())
- meta_info_map.erase(key);
- if (element.is_url) {
- Time date_added = reset_node_times ? Time::Now() : element.date_added;
- DCHECK(!date_added.is_null());
- const BookmarkNode* node = model->AddNewURL(
- parent, index_to_add_at, element.title, element.url, &meta_info_map);
- model->SetDateAdded(node, date_added);
- } else {
- const BookmarkNode* cloned_node = model->AddFolder(
- parent, index_to_add_at, element.title, &meta_info_map);
- if (!reset_node_times) {
- DCHECK(!element.date_folder_modified.is_null());
- model->SetDateFolderModified(cloned_node, element.date_folder_modified);
- }
- for (int i = 0; i < static_cast<int>(element.children.size()); ++i)
- CloneBookmarkNodeImpl(model, element.children[i], cloned_node, i,
- reset_node_times);
- }
- }
- // Comparison function that compares based on date modified of the two nodes.
- bool MoreRecentlyModified(const BookmarkNode* n1, const BookmarkNode* n2) {
- return n1->date_folder_modified() > n2->date_folder_modified();
- }
- // Returns true if |text| contains each string in |words|. This is used when
- // searching for bookmarks.
- bool DoesBookmarkTextContainWords(const std::u16string& text,
- const std::vector<std::u16string>& words) {
- for (size_t i = 0; i < words.size(); ++i) {
- if (!base::i18n::StringSearchIgnoringCaseAndAccents(words[i], text, nullptr,
- nullptr)) {
- return false;
- }
- }
- return true;
- }
- // This is used with a tree iterator to skip subtrees which are not visible.
- bool PruneInvisibleFolders(const BookmarkNode* node) {
- return !node->IsVisible();
- }
- // This traces parents up to root, determines if node is contained in a
- // selected folder.
- bool HasSelectedAncestor(BookmarkModel* model,
- const std::vector<const BookmarkNode*>& selected_nodes,
- const BookmarkNode* node) {
- if (!node || model->is_permanent_node(node))
- return false;
- for (size_t i = 0; i < selected_nodes.size(); ++i)
- if (node->id() == selected_nodes[i]->id())
- return true;
- return HasSelectedAncestor(model, selected_nodes, node->parent());
- }
- const BookmarkNode* GetNodeByID(const BookmarkNode* node, int64_t id) {
- if (node->id() == id)
- return node;
- for (const auto& child : node->children()) {
- const BookmarkNode* result = GetNodeByID(child.get(), id);
- if (result)
- return result;
- }
- return nullptr;
- }
- // Attempts to shorten a URL safely (i.e., by preventing the end of the URL
- // from being in the middle of an escape sequence) to no more than
- // kCleanedUpUrlMaxLength characters, returning the result.
- std::string TruncateUrl(const std::string& url) {
- if (url.length() <= kCleanedUpUrlMaxLength)
- return url;
- // If we're in the middle of an escape sequence, truncate just before it.
- if (url[kCleanedUpUrlMaxLength - 1] == '%')
- return url.substr(0, kCleanedUpUrlMaxLength - 1);
- if (url[kCleanedUpUrlMaxLength - 2] == '%')
- return url.substr(0, kCleanedUpUrlMaxLength - 2);
- return url.substr(0, kCleanedUpUrlMaxLength);
- }
- // Returns the URL from the clipboard. If there is no URL an empty URL is
- // returned.
- GURL GetUrlFromClipboard(bool notify_if_restricted) {
- std::u16string url_text;
- #if !BUILDFLAG(IS_IOS)
- ui::DataTransferEndpoint data_dst = ui::DataTransferEndpoint(
- ui::EndpointType::kDefault, notify_if_restricted);
- ui::Clipboard::GetForCurrentThread()->ReadText(
- ui::ClipboardBuffer::kCopyPaste, &data_dst, &url_text);
- #endif
- return GURL(url_text);
- }
- template <class type>
- void GetBookmarksMatchingPropertiesImpl(
- type& iterator,
- BookmarkModel* model,
- const QueryFields& query,
- const std::vector<std::u16string>& query_words,
- size_t max_count,
- std::vector<const BookmarkNode*>* nodes) {
- while (iterator.has_next()) {
- const BookmarkNode* node = iterator.Next();
- if ((!query_words.empty() &&
- !DoesBookmarkContainWords(node->GetTitle(), node->url(),
- query_words)) ||
- model->is_permanent_node(node)) {
- continue;
- }
- if (query.title && node->GetTitle() != *query.title)
- continue;
- nodes->push_back(node);
- if (nodes->size() == max_count)
- return;
- }
- }
- #if BUILDFLAG(IS_ANDROID)
- // Returns whether or not a bookmark model contains any bookmarks aside of the
- // permanent nodes.
- bool HasUserCreatedBookmarks(BookmarkModel* model) {
- const BookmarkNode* root_node = model->root_node();
- return std::any_of(
- root_node->children().cbegin(), root_node->children().cend(),
- [](const auto& node) { return !node->children().empty(); });
- }
- #endif
- } // namespace
- QueryFields::QueryFields() {}
- QueryFields::~QueryFields() {}
- VectorIterator::VectorIterator(std::vector<const BookmarkNode*>* nodes)
- : nodes_(nodes), current_(nodes->begin()) {}
- VectorIterator::~VectorIterator() = default;
- bool VectorIterator::has_next() {
- return (current_ != nodes_->end());
- }
- const BookmarkNode* VectorIterator::Next() {
- const BookmarkNode* result = *current_;
- ++current_;
- return result;
- }
- void CloneBookmarkNode(BookmarkModel* model,
- const std::vector<BookmarkNodeData::Element>& elements,
- const BookmarkNode* parent,
- size_t index_to_add_at,
- bool reset_node_times) {
- if (!parent->is_folder() || !model) {
- NOTREACHED();
- return;
- }
- for (size_t i = 0; i < elements.size(); ++i) {
- CloneBookmarkNodeImpl(model, elements[i], parent, index_to_add_at + i,
- reset_node_times);
- }
- }
- void CopyToClipboard(BookmarkModel* model,
- const std::vector<const BookmarkNode*>& nodes,
- bool remove_nodes) {
- if (nodes.empty())
- return;
- // Create array of selected nodes with descendants filtered out.
- std::vector<const BookmarkNode*> filtered_nodes;
- for (const auto* node : nodes) {
- if (!HasSelectedAncestor(model, nodes, node->parent()))
- filtered_nodes.push_back(node);
- }
- BookmarkNodeData(filtered_nodes).WriteToClipboard();
- if (remove_nodes) {
- ScopedGroupBookmarkActions group_cut(model);
- for (const auto* node : filtered_nodes)
- model->Remove(node);
- }
- }
- // Updates |title| such that |url| and |title| pair are unique among the
- // children of |parent|.
- void MakeTitleUnique(const BookmarkModel* model,
- const BookmarkNode* parent,
- const GURL& url,
- std::u16string* title) {
- std::unordered_set<std::u16string> titles;
- std::u16string original_title_lower = base::i18n::ToLower(*title);
- for (const auto& node : parent->children()) {
- if (node->is_url() && (url == node->url()) &&
- base::StartsWith(base::i18n::ToLower(node->GetTitle()),
- original_title_lower,
- base::CompareCase::SENSITIVE)) {
- titles.insert(node->GetTitle());
- }
- }
- if (titles.find(*title) == titles.end())
- return;
- for (size_t i = 0; i < titles.size(); i++) {
- const std::u16string new_title(*title +
- base::ASCIIToUTF16(base::StringPrintf(
- " (%lu)", (unsigned long)(i + 1))));
- if (titles.find(new_title) == titles.end()) {
- *title = new_title;
- return;
- }
- }
- NOTREACHED();
- }
- void PasteFromClipboard(BookmarkModel* model,
- const BookmarkNode* parent,
- size_t index) {
- if (!parent)
- return;
- BookmarkNodeData bookmark_data;
- if (!bookmark_data.ReadFromClipboard(ui::ClipboardBuffer::kCopyPaste)) {
- GURL url = GetUrlFromClipboard(/*notify_if_restricted=*/true);
- if (!url.is_valid())
- return;
- BookmarkNode node(/*id=*/0, base::GUID::GenerateRandomV4(), url);
- node.SetTitle(base::ASCIIToUTF16(url.spec()));
- bookmark_data = BookmarkNodeData(&node);
- }
- DCHECK_LE(index, parent->children().size());
- ScopedGroupBookmarkActions group_paste(model);
- if (bookmark_data.size() == 1 &&
- model->IsBookmarked(bookmark_data.elements[0].url)) {
- MakeTitleUnique(model,
- parent,
- bookmark_data.elements[0].url,
- &bookmark_data.elements[0].title);
- }
- CloneBookmarkNode(model, bookmark_data.elements, parent, index, true);
- }
- bool CanPasteFromClipboard(BookmarkModel* model, const BookmarkNode* node) {
- if (!node || !model->client()->CanBeEditedByUser(node))
- return false;
- return (BookmarkNodeData::ClipboardContainsBookmarks() ||
- GetUrlFromClipboard(/*notify_if_restricted=*/false).is_valid());
- }
- std::vector<const BookmarkNode*> GetMostRecentlyModifiedUserFolders(
- BookmarkModel* model,
- size_t max_count) {
- std::vector<const BookmarkNode*> nodes;
- ui::TreeNodeIterator<const BookmarkNode> iterator(
- model->root_node(), base::BindRepeating(&PruneInvisibleFolders));
- while (iterator.has_next()) {
- const BookmarkNode* parent = iterator.Next();
- if (!model->client()->CanBeEditedByUser(parent))
- continue;
- if (parent->is_folder() && parent->date_folder_modified() > Time()) {
- if (max_count == 0) {
- nodes.push_back(parent);
- } else {
- auto i = std::upper_bound(nodes.begin(), nodes.end(), parent,
- &MoreRecentlyModified);
- if (nodes.size() < max_count || i != nodes.end()) {
- nodes.insert(i, parent);
- while (nodes.size() > max_count)
- nodes.pop_back();
- }
- }
- } // else case, the root node, which we don't care about or imported nodes
- // (which have a time of 0).
- }
- if (nodes.size() < max_count) {
- // Add the permanent nodes if there is space. The permanent nodes are the
- // only children of the root_node.
- const BookmarkNode* root_node = model->root_node();
- for (const auto& node : root_node->children()) {
- if (node->IsVisible() && model->client()->CanBeEditedByUser(node.get()) &&
- !base::Contains(nodes, node.get())) {
- nodes.push_back(node.get());
- if (nodes.size() == max_count)
- break;
- }
- }
- }
- return nodes;
- }
- void GetMostRecentlyAddedEntries(BookmarkModel* model,
- size_t count,
- std::vector<const BookmarkNode*>* nodes) {
- ui::TreeNodeIterator<const BookmarkNode> iterator(model->root_node());
- while (iterator.has_next()) {
- const BookmarkNode* node = iterator.Next();
- if (node->is_url()) {
- auto insert_position = std::upper_bound(nodes->begin(), nodes->end(),
- node, &MoreRecentlyAdded);
- if (nodes->size() < count || insert_position != nodes->end()) {
- nodes->insert(insert_position, node);
- while (nodes->size() > count)
- nodes->pop_back();
- }
- }
- }
- }
- bool MoreRecentlyAdded(const BookmarkNode* n1, const BookmarkNode* n2) {
- return n1->date_added() > n2->date_added();
- }
- void GetBookmarksMatchingProperties(BookmarkModel* model,
- const QueryFields& query,
- size_t max_count,
- std::vector<const BookmarkNode*>* nodes) {
- std::vector<std::u16string> query_words = ParseBookmarkQuery(query);
- if (query.word_phrase_query && query_words.empty())
- return;
- if (query.url) {
- // Shortcut into the BookmarkModel if searching for URL.
- GURL url(*query.url);
- std::vector<const BookmarkNode*> url_matched_nodes;
- if (url.is_valid())
- model->GetNodesByURL(url, &url_matched_nodes);
- VectorIterator iterator(&url_matched_nodes);
- GetBookmarksMatchingPropertiesImpl<VectorIterator>(
- iterator, model, query, query_words, max_count, nodes);
- } else {
- ui::TreeNodeIterator<const BookmarkNode> iterator(model->root_node());
- GetBookmarksMatchingPropertiesImpl<
- ui::TreeNodeIterator<const BookmarkNode>>(
- iterator, model, query, query_words, max_count, nodes);
- }
- }
- // Parses the provided query and returns a vector of query words.
- std::vector<std::u16string> ParseBookmarkQuery(
- const bookmarks::QueryFields& query) {
- std::vector<std::u16string> query_words;
- if (query.word_phrase_query) {
- query_parser::QueryParser::ParseQueryWords(
- base::i18n::ToLower(*query.word_phrase_query),
- query_parser::MatchingAlgorithm::DEFAULT, &query_words);
- }
- return query_words;
- }
- // Returns true if |node|s title or url contains the strings in |words|.
- bool DoesBookmarkContainWords(const std::u16string& title,
- const GURL& url,
- const std::vector<std::u16string>& words) {
- return DoesBookmarkTextContainWords(title, words) ||
- DoesBookmarkTextContainWords(base::UTF8ToUTF16(url.spec()), words) ||
- DoesBookmarkTextContainWords(
- url_formatter::FormatUrl(url, url_formatter::kFormatUrlOmitNothing,
- base::UnescapeRule::NORMAL, nullptr,
- nullptr, nullptr),
- words);
- }
- void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry) {
- registry->RegisterBooleanPref(
- prefs::kShowBookmarkBar, false,
- user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
- registry->RegisterBooleanPref(prefs::kEditBookmarksEnabled, true);
- registry->RegisterBooleanPref(
- prefs::kShowAppsShortcutInBookmarkBar, false,
- user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
- registry->RegisterBooleanPref(
- prefs::kShowManagedBookmarksInBookmarkBar, true,
- user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
- RegisterManagedBookmarksPrefs(registry);
- }
- void RegisterManagedBookmarksPrefs(PrefRegistrySimple* registry) {
- // Don't sync this, as otherwise, due to a limitation in sync, it
- // will cause a deadlock (see http://crbug.com/97955). If we truly
- // want to sync the expanded state of folders, it should be part of
- // bookmark sync itself (i.e., a property of the sync folder nodes).
- registry->RegisterListPref(prefs::kBookmarkEditorExpandedNodes);
- registry->RegisterListPref(prefs::kManagedBookmarks);
- registry->RegisterStringPref(
- prefs::kManagedBookmarksFolderName, std::string());
- }
- const BookmarkNode* GetParentForNewNodes(
- const BookmarkNode* parent,
- const std::vector<const BookmarkNode*>& selection,
- size_t* index) {
- const BookmarkNode* real_parent = parent;
- if (selection.size() == 1 && selection[0]->is_folder())
- real_parent = selection[0];
- if (index) {
- if (selection.size() == 1 && selection[0]->is_url()) {
- absl::optional<size_t> selection_index =
- real_parent->GetIndexOf(selection[0]);
- DCHECK(selection_index.has_value());
- *index = selection_index.value() + 1;
- } else {
- *index = real_parent->children().size();
- }
- }
- return real_parent;
- }
- void DeleteBookmarkFolders(BookmarkModel* model,
- const std::vector<int64_t>& ids) {
- // Remove the folders that were removed. This has to be done after all the
- // other changes have been committed.
- for (auto iter = ids.begin(); iter != ids.end(); ++iter) {
- const BookmarkNode* node = GetBookmarkNodeByID(model, *iter);
- if (!node)
- continue;
- model->Remove(node);
- }
- }
- const BookmarkNode* AddIfNotBookmarked(BookmarkModel* model,
- const GURL& url,
- const std::u16string& title) {
- // Nothing to do, a user bookmark with that url already exists.
- if (IsBookmarkedByUser(model, url))
- return nullptr;
- model->client()->RecordAction(base::UserMetricsAction("BookmarkAdded"));
- const BookmarkNode* parent = GetParentForNewNodes(model);
- return model->AddNewURL(parent, parent->children().size(), title, url);
- }
- void RemoveAllBookmarks(BookmarkModel* model, const GURL& url) {
- std::vector<const BookmarkNode*> bookmarks;
- model->GetNodesByURL(url, &bookmarks);
- // Remove all the user bookmarks.
- for (size_t i = 0; i < bookmarks.size(); ++i) {
- const BookmarkNode* node = bookmarks[i];
- if (model->client()->CanBeEditedByUser(node))
- model->Remove(node);
- }
- }
- std::u16string CleanUpUrlForMatching(
- const GURL& gurl,
- base::OffsetAdjuster::Adjustments* adjustments) {
- base::OffsetAdjuster::Adjustments tmp_adjustments;
- return base::i18n::ToLower(url_formatter::FormatUrlWithAdjustments(
- GURL(TruncateUrl(gurl.spec())),
- url_formatter::kFormatUrlOmitUsernamePassword,
- base::UnescapeRule::SPACES | base::UnescapeRule::PATH_SEPARATORS |
- base::UnescapeRule::URL_SPECIAL_CHARS_EXCEPT_PATH_SEPARATORS,
- nullptr, nullptr, adjustments ? adjustments : &tmp_adjustments));
- }
- std::u16string CleanUpTitleForMatching(const std::u16string& title) {
- return base::i18n::ToLower(title.substr(0u, kCleanedUpTitleMaxLength));
- }
- bool CanAllBeEditedByUser(BookmarkClient* client,
- const std::vector<const BookmarkNode*>& nodes) {
- for (size_t i = 0; i < nodes.size(); ++i) {
- if (!client->CanBeEditedByUser(nodes[i]))
- return false;
- }
- return true;
- }
- bool IsBookmarkedByUser(BookmarkModel* model, const GURL& url) {
- std::vector<const BookmarkNode*> nodes;
- model->GetNodesByURL(url, &nodes);
- for (size_t i = 0; i < nodes.size(); ++i) {
- if (model->client()->CanBeEditedByUser(nodes[i]))
- return true;
- }
- return false;
- }
- const BookmarkNode* GetBookmarkNodeByID(const BookmarkModel* model,
- int64_t id) {
- // TODO(sky): TreeNode needs a method that visits all nodes using a predicate.
- return GetNodeByID(model->root_node(), id);
- }
- bool IsDescendantOf(const BookmarkNode* node, const BookmarkNode* root) {
- return node && node->HasAncestor(root);
- }
- bool HasDescendantsOf(const std::vector<const BookmarkNode*>& list,
- const BookmarkNode* root) {
- for (const BookmarkNode* node : list) {
- if (IsDescendantOf(node, root))
- return true;
- }
- return false;
- }
- const BookmarkNode* GetParentForNewNodes(BookmarkModel* model) {
- #if BUILDFLAG(IS_ANDROID)
- if (!HasUserCreatedBookmarks(model))
- return model->mobile_node();
- #endif
- std::vector<const BookmarkNode*> nodes =
- GetMostRecentlyModifiedUserFolders(model, 1);
- DCHECK(!nodes.empty()); // This list is always padded with default folders.
- return nodes[0];
- }
- } // namespace bookmarks
|