components/bookmarks/managed/managed_bookmarks_tracker.h

// Copyright 2014 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_BOOKMARKS_MANAGED_MANAGED_BOOKMARKS_TRACKER_H_
#define COMPONENTS_BOOKMARKS_MANAGED_MANAGED_BOOKMARKS_TRACKER_H_

#include <stddef.h>
#include <stdint.h>

#include <memory>
#include <string>

#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/values.h"
#include "components/prefs/pref_change_registrar.h"

class GURL;
class PrefService;

namespace bookmarks {

class BookmarkModel;
class BookmarkNode;
class BookmarkPermanentNode;

// Tracks either the Managed Bookmarks pref (set by policy) and makes the
// managed_node() in the BookmarkModel follow the policy-defined bookmark tree.
class ManagedBookmarksTracker {
 public:
  using GetManagementDomainCallback = base::RepeatingCallback<std::string()>;

  // Shared constants used in the policy configuration.
  static const char kName[];
  static const char kUrl[];
  static const char kChildren[];
  static const char kFolderName[];

  ManagedBookmarksTracker(BookmarkModel* model,
                          PrefService* prefs,
                          GetManagementDomainCallback callback);

  ManagedBookmarksTracker(const ManagedBookmarksTracker&) = delete;
  ManagedBookmarksTracker& operator=(const ManagedBookmarksTracker&) = delete;

  ~ManagedBookmarksTracker();

  // Returns the initial list of managed bookmarks, which can be passed to
  // LoadInitial() to do the initial load.
  base::Value::List GetInitialManagedBookmarks();

  // Loads the initial managed bookmarks in `list` into `folder`.
  // New nodes will be assigned IDs starting at `next_node_id`.
  // Returns the next node ID to use.
  static int64_t LoadInitial(BookmarkNode* folder,
                             const base::Value::List& list,
                             int64_t next_node_id);

  // Starts tracking the pref for updates to the managed bookmarks.
  // Should be called after loading the initial bookmarks.
  void Init(BookmarkPermanentNode* managed_node);

 private:
  std::u16string GetBookmarksFolderTitle() const;

  void ReloadManagedBookmarksFolderTitle();
  void ReloadManagedBookmarks();

  void UpdateBookmarks(const BookmarkNode* folder,
                       const base::Value::List& list);
  static bool LoadBookmark(const base::Value::List& list,
                           size_t index,
                           std::u16string* title,
                           GURL* url,
                           const base::Value::List** children);

  raw_ptr<BookmarkModel> model_;
  raw_ptr<BookmarkPermanentNode> managed_node_;
  raw_ptr<PrefService> prefs_;
  PrefChangeRegistrar registrar_;
  GetManagementDomainCallback get_management_domain_callback_;
};

}  // namespace bookmarks

#endif  // COMPONENTS_BOOKMARKS_MANAGED_MANAGED_BOOKMARKS_TRACKER_H_