File: recently_used_folders_combo_model.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (279 lines) | stat: -rw-r--r-- 9,476 bytes parent folder | download | duplicates (5)
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ui/bookmarks/recently_used_folders_combo_model.h"

#include <stddef.h>

#include <algorithm>

#include "base/feature_list.h"
#include "base/memory/raw_ptr.h"
#include "base/metrics/user_metrics.h"
#include "base/observer_list.h"
#include "chrome/grit/generated_resources.h"
#include "components/bookmarks/browser/bookmark_model.h"
#include "components/bookmarks/browser/bookmark_utils.h"
#include "components/signin/public/base/signin_switches.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/models/combobox_model_observer.h"

using bookmarks::BookmarkModel;
using bookmarks::BookmarkNode;

struct RecentlyUsedFoldersComboModel::Item {
  enum Type {
    TYPE_NODE,
    TYPE_ALL_BOOKMARKS_NODE,
    TYPE_SEPARATOR,
    TYPE_ACCOUNT_BOOKMARK_HEADING,
    TYPE_DEVICE_BOOKMARK_HEADING,
    TYPE_CHOOSE_ANOTHER_FOLDER
  };

  Item(const BookmarkNode* node, Type type);
  ~Item();

  bool operator==(const Item& item) const;

  raw_ptr<const BookmarkNode> node;
  Type type;
};

RecentlyUsedFoldersComboModel::Item::Item(const BookmarkNode* node, Type type)
    : node(node), type(type) {}

RecentlyUsedFoldersComboModel::Item::~Item() = default;

bool RecentlyUsedFoldersComboModel::Item::operator==(const Item& item) const {
  return item.node == node && item.type == type;
}

RecentlyUsedFoldersComboModel::RecentlyUsedFoldersComboModel(
    BookmarkModel* model,
    const BookmarkNode* node)
    : bookmark_model_(model), parent_node_(node->parent()) {
  bookmark_model_->AddObserver(this);

  const bookmarks::BookmarkNodesSplitByAccountAndLocal mru_bookmarks =
      bookmarks::GetMostRecentlyUsedFoldersForDisplay(model, node);

  if (!mru_bookmarks.account_nodes.empty()) {
    const bool show_labels = !mru_bookmarks.local_nodes.empty();

    // Add account nodes to `items_`.
    if (show_labels) {
      items_.emplace_back(nullptr, Item::TYPE_ACCOUNT_BOOKMARK_HEADING);
    }

    for (const BookmarkNode* mru_node : mru_bookmarks.account_nodes) {
      items_.emplace_back(mru_node, mru_node == model->account_other_node()
                                        ? Item::TYPE_ALL_BOOKMARKS_NODE
                                        : Item::TYPE_NODE);
    }

    // Add local nodes to `items_`.
    if (show_labels) {
      items_.emplace_back(nullptr, Item::TYPE_DEVICE_BOOKMARK_HEADING);
    }

    for (const BookmarkNode* mru_node : mru_bookmarks.local_nodes) {
      items_.emplace_back(mru_node, mru_node == model->other_node()
                                        ? Item::TYPE_ALL_BOOKMARKS_NODE
                                        : Item::TYPE_NODE);
    }
  } else {
    for (const BookmarkNode* mru_node : mru_bookmarks.local_nodes) {
      items_.emplace_back(mru_node, Item::TYPE_NODE);
    }
  }

  // Add a separator + choose another folder last regardless of account/local.
  items_.emplace_back(nullptr, Item::TYPE_SEPARATOR);
  items_.emplace_back(nullptr, Item::TYPE_CHOOSE_ANOTHER_FOLDER);
}

RecentlyUsedFoldersComboModel::~RecentlyUsedFoldersComboModel() {
  bookmark_model_->RemoveObserver(this);
}

size_t RecentlyUsedFoldersComboModel::GetItemCount() const {
  return items_.size();
}

std::u16string RecentlyUsedFoldersComboModel::GetItemAt(size_t index) const {
  switch (items_[index].type) {
    case Item::TYPE_NODE:
      return items_[index].node->GetTitle();
    case Item::TYPE_ACCOUNT_BOOKMARK_HEADING:
      return l10n_util::GetStringUTF16(IDS_BOOKMARKS_ACCOUNT_BOOKMARKS);
    case Item::TYPE_DEVICE_BOOKMARK_HEADING:
      return l10n_util::GetStringUTF16(IDS_BOOKMARKS_DEVICE_BOOKMARKS);
    case Item::TYPE_ALL_BOOKMARKS_NODE:
      return l10n_util::GetStringUTF16(IDS_BOOKMARKS_ALL_BOOKMARKS);
    case Item::TYPE_SEPARATOR:
      // This function should not be called for separators.
      NOTREACHED();
    case Item::TYPE_CHOOSE_ANOTHER_FOLDER:
      return l10n_util::GetStringUTF16(
          IDS_BOOKMARK_BUBBLE_CHOOSER_ANOTHER_FOLDER);
  }
  NOTREACHED();
}

bool RecentlyUsedFoldersComboModel::IsItemSeparatorAt(size_t index) const {
  return items_[index].type == Item::TYPE_SEPARATOR;
}

bool RecentlyUsedFoldersComboModel::IsItemTitleAt(size_t index) const {
  switch (items_[index].type) {
    case Item::TYPE_ACCOUNT_BOOKMARK_HEADING:
    case Item::TYPE_DEVICE_BOOKMARK_HEADING:
      return true;
    case Item::TYPE_NODE:
    case Item::TYPE_SEPARATOR:
    case Item::TYPE_ALL_BOOKMARKS_NODE:
    case Item::TYPE_CHOOSE_ANOTHER_FOLDER:
      return false;
  }
  NOTREACHED();
}

std::optional<size_t> RecentlyUsedFoldersComboModel::GetDefaultIndex() const {
  // TODO(pbos): Ideally we shouldn't have to handle `parent_node_` removal
  // here, the dialog should instead close immediately (and destroy `this`).
  // If that can be resolved, this should DCHECK that it != items_.end() and
  // a DCHECK should be added in the BookmarkModel observer methods to ensure
  // that we don't remove `parent_node_`.
  // TODO(pbos): Look at returning -1 here if there's no default index. Right
  // now a lot of code in Combobox assumes an index within `items_` bounds.
  auto it = std::ranges::find(items_, Item(parent_node_, Item::TYPE_NODE));
  if (it == items_.end()) {
    it = std::ranges::find(items_,
                           Item(parent_node_, Item::TYPE_ALL_BOOKMARKS_NODE));
  }
  return it == items_.end() ? 0 : static_cast<int>(it - items_.begin());
}

std::optional<ui::ColorId>
RecentlyUsedFoldersComboModel::GetDropdownForegroundColorIdAt(
    size_t index) const {
  switch (items_[index].type) {
    case Item::TYPE_ACCOUNT_BOOKMARK_HEADING:
    case Item::TYPE_DEVICE_BOOKMARK_HEADING:
      return ui::kColorDisabledForeground;
    case Item::TYPE_NODE:
    case Item::TYPE_SEPARATOR:
    case Item::TYPE_ALL_BOOKMARKS_NODE:
    case Item::TYPE_CHOOSE_ANOTHER_FOLDER:
      return std::nullopt;
  }
  NOTREACHED();
}

ui::ComboboxModel::ItemCheckmarkConfig
RecentlyUsedFoldersComboModel::GetCheckmarkConfig() const {
  if (base::FeatureList::IsEnabled(
          switches::kSyncEnableBookmarksInTransportMode)) {
    // Explicitly enable checkmarks for all folder entries to visually
    // distinguish them from titles.
    return ItemCheckmarkConfig::kEnabled;
  }
  return ItemCheckmarkConfig::kDefault;
}

void RecentlyUsedFoldersComboModel::BookmarkModelLoaded(bool ids_reassigned) {}

void RecentlyUsedFoldersComboModel::BookmarkModelBeingDeleted() {}

void RecentlyUsedFoldersComboModel::BookmarkNodeMoved(
    const BookmarkNode* old_parent,
    size_t old_index,
    const BookmarkNode* new_parent,
    size_t new_index) {}

void RecentlyUsedFoldersComboModel::BookmarkNodeAdded(
    const BookmarkNode* parent,
    size_t index,
    bool added_by_user) {}

void RecentlyUsedFoldersComboModel::OnWillRemoveBookmarks(
    const BookmarkNode* parent,
    size_t old_index,
    const BookmarkNode* node,
    const base::Location& location) {
  // Changing is rare enough that we don't attempt to readjust the contents.
  // Update |items_| so we aren't left pointing to a deleted node.
  bool changed = false;
  for (auto i = items_.begin(); i != items_.end();) {
    if (i->type == Item::TYPE_NODE && i->node->HasAncestor(node)) {
      i = items_.erase(i);
      changed = true;
    } else {
      ++i;
    }
  }
  if (changed) {
    for (ui::ComboboxModelObserver& observer : observers()) {
      observer.OnComboboxModelChanged(this);
    }
  }
}

void RecentlyUsedFoldersComboModel::BookmarkNodeRemoved(
    const BookmarkNode* parent,
    size_t old_index,
    const BookmarkNode* node,
    const std::set<GURL>& removed_urls,
    const base::Location& location) {}

void RecentlyUsedFoldersComboModel::BookmarkNodeChanged(
    const BookmarkNode* node) {}

void RecentlyUsedFoldersComboModel::BookmarkNodeFaviconChanged(
    const BookmarkNode* node) {}

void RecentlyUsedFoldersComboModel::BookmarkNodeChildrenReordered(
    const BookmarkNode* node) {}

void RecentlyUsedFoldersComboModel::BookmarkAllUserNodesRemoved(
    const std::set<GURL>& removed_urls,
    const base::Location& location) {
  // Changing is rare enough that we don't attempt to readjust the contents.
  // Update |items_| so we aren't left pointing to a deleted node.
  bool changed = false;
  for (auto i = items_.begin(); i != items_.end();) {
    if (i->type == Item::TYPE_NODE &&
        !bookmark_model_->is_permanent_node(i->node)) {
      i = items_.erase(i);
      changed = true;
    } else {
      ++i;
    }
  }
  if (changed) {
    for (ui::ComboboxModelObserver& observer : observers()) {
      observer.OnComboboxModelChanged(this);
    }
  }
}

void RecentlyUsedFoldersComboModel::MaybeChangeParent(const BookmarkNode* node,
                                                      size_t selected_index) {
  DCHECK_LT(selected_index, items_.size());
  if (items_[selected_index].type != Item::TYPE_NODE &&
      items_[selected_index].type != Item::TYPE_ALL_BOOKMARKS_NODE) {
    return;
  }

  const BookmarkNode* new_parent = GetNodeAt(selected_index);
  if (new_parent != node->parent()) {
    base::RecordAction(base::UserMetricsAction("BookmarkBubble_ChangeParent"));
    bookmark_model_->Move(node, new_parent, new_parent->children().size());
  }
}

const BookmarkNode* RecentlyUsedFoldersComboModel::GetNodeAt(size_t index) {
  return (index < items_.size()) ? items_[index].node.get() : nullptr;
}