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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_SYNC_BOOKMARKS_BOOKMARK_MODEL_VIEW_H_
#define COMPONENTS_SYNC_BOOKMARKS_BOOKMARK_MODEL_VIEW_H_
#include <string>
#include <vector>
#include "base/memory/weak_ptr.h"
#include "base/uuid.h"
#include "components/bookmarks/browser/bookmark_node.h"
namespace bookmarks {
class BookmarkModel;
class BookmarkModelObserver;
} // namespace bookmarks
namespace sync_bookmarks {
// A sync-specific abstraction mimic-ing the API in BookmarkModel that allows
// exposing the minimal API surface required for sync and customizing how local
// permanent folders map to server-side permanent folders.
class BookmarkModelView {
public:
// `bookmark_model` must not be null and must outlive any usage of this
// object.
explicit BookmarkModelView(bookmarks::BookmarkModel* bookmark_model);
BookmarkModelView(const BookmarkModelView&) = delete;
virtual ~BookmarkModelView();
BookmarkModelView& operator=(const BookmarkModelView&) = delete;
// Returns whether `node` is actually relevant in the context of this view,
// which allows filtering which subset of bookmarks should be sync-ed. Note
// that some other APIs, such as traversing root(), can expose nodes that are
// NOT meant to be sync-ed, hence the need for this predicate.
bool IsNodeSyncable(const bookmarks::BookmarkNode* node) const;
// Functions that allow influencing which bookmark tree is exposed to sync.
virtual const bookmarks::BookmarkNode* bookmark_bar_node() const = 0;
virtual const bookmarks::BookmarkNode* other_node() const = 0;
virtual const bookmarks::BookmarkNode* mobile_node() const = 0;
// Ensures that bookmark_bar_node(), other_node() and mobile_node() return
// non-null. This is always the case for local-or-syncable permanent folders,
// and the function a no-op, but for account permanent folders it is necessary
// to create them explicitly.
virtual void EnsurePermanentNodesExist() = 0;
// Deletes all nodes that would return true for IsNodeSyncable(). Permanent
// folders may or may not be deleted depending on precise mapping (only
// account permanent folders can be deleted).
virtual void RemoveAllSyncableNodes() = 0;
// Uses `uuid` to find a node that is relevant in the context of this view.
virtual const bookmarks::BookmarkNode* GetNodeByUuid(
const base::Uuid& uuid) const = 0;
// See bookmarks::BookmarkModel for documentation, as all functions below
// mimic the same API.
bool loaded() const;
const bookmarks::BookmarkNode* root_node() const;
bool is_permanent_node(const bookmarks::BookmarkNode* node) const;
void AddObserver(bookmarks::BookmarkModelObserver* observer);
void RemoveObserver(bookmarks::BookmarkModelObserver* observer);
void BeginExtensiveChanges();
void EndExtensiveChanges();
void Remove(const bookmarks::BookmarkNode* node,
const base::Location& location);
void Move(const bookmarks::BookmarkNode* node,
const bookmarks::BookmarkNode* new_parent,
size_t index);
const gfx::Image& GetFavicon(const bookmarks::BookmarkNode* node);
void SetTitle(const bookmarks::BookmarkNode* node,
const std::u16string& title);
void SetURL(const bookmarks::BookmarkNode* node, const GURL& url);
const bookmarks::BookmarkNode* AddFolder(
const bookmarks::BookmarkNode* parent,
size_t index,
const std::u16string& title,
const bookmarks::BookmarkNode::MetaInfoMap* meta_info,
std::optional<base::Time> creation_time,
std::optional<base::Uuid> uuid);
const bookmarks::BookmarkNode* AddURL(
const bookmarks::BookmarkNode* parent,
size_t index,
const std::u16string& title,
const GURL& url,
const bookmarks::BookmarkNode::MetaInfoMap* meta_info,
std::optional<base::Time> creation_time,
std::optional<base::Uuid> uuid);
void ReorderChildren(
const bookmarks::BookmarkNode* parent,
const std::vector<const bookmarks::BookmarkNode*>& ordered_nodes);
void UpdateLastUsedTime(const bookmarks::BookmarkNode* node,
const base::Time time,
bool just_opened);
void SetNodeMetaInfoMap(
const bookmarks::BookmarkNode* node,
const bookmarks::BookmarkNode::MetaInfoMap& meta_info_map);
protected:
bookmarks::BookmarkModel* underlying_model() { return bookmark_model_.get(); }
const bookmarks::BookmarkModel* underlying_model() const {
return bookmark_model_.get();
}
private:
// Using WeakPtr here allows detecting violations of the constructor
// precondition and CHECK fail if BookmarkModel is destroyed earlier.
// This also simplifies unit-testing, because using raw_ptr otherwise
// complicates the way to achieve a reasonable destruction order for
// TestBookmarkModelView.
const base::WeakPtr<bookmarks::BookmarkModel> bookmark_model_;
};
class BookmarkModelViewUsingLocalOrSyncableNodes : public BookmarkModelView {
public:
// `bookmark_model` must not be null and must outlive any usage of this
// object.
explicit BookmarkModelViewUsingLocalOrSyncableNodes(
bookmarks::BookmarkModel* bookmark_model);
~BookmarkModelViewUsingLocalOrSyncableNodes() override;
// BookmarkModelView overrides.
const bookmarks::BookmarkNode* bookmark_bar_node() const override;
const bookmarks::BookmarkNode* other_node() const override;
const bookmarks::BookmarkNode* mobile_node() const override;
void EnsurePermanentNodesExist() override;
void RemoveAllSyncableNodes() override;
const bookmarks::BookmarkNode* GetNodeByUuid(
const base::Uuid& uuid) const override;
};
class BookmarkModelViewUsingAccountNodes : public BookmarkModelView {
public:
// `bookmark_model` must not be null and must outlive any usage of this
// object.
explicit BookmarkModelViewUsingAccountNodes(
bookmarks::BookmarkModel* bookmark_model);
~BookmarkModelViewUsingAccountNodes() override;
// BookmarkModelView overrides.
const bookmarks::BookmarkNode* bookmark_bar_node() const override;
const bookmarks::BookmarkNode* other_node() const override;
const bookmarks::BookmarkNode* mobile_node() const override;
void EnsurePermanentNodesExist() override;
void RemoveAllSyncableNodes() override;
const bookmarks::BookmarkNode* GetNodeByUuid(
const base::Uuid& uuid) const override;
};
} // namespace sync_bookmarks
#endif // COMPONENTS_SYNC_BOOKMARKS_BOOKMARK_MODEL_VIEW_H_
|
