File: persistent_bookmark_entity.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (94 lines) | stat: -rw-r--r-- 3,839 bytes parent folder | download | duplicates (6)
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
// 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_SYNC_ENGINE_LOOPBACK_SERVER_PERSISTENT_BOOKMARK_ENTITY_H_
#define COMPONENTS_SYNC_ENGINE_LOOPBACK_SERVER_PERSISTENT_BOOKMARK_ENTITY_H_

#include <stdint.h>

#include <map>
#include <memory>
#include <string>

#include "components/sync/base/data_type.h"
#include "components/sync/engine/loopback_server/loopback_server_entity.h"
#include "components/sync/protocol/unique_position.pb.h"

namespace sync_pb {
class SyncEntity;
class EntitySpecifics;
enum LoopbackServerEntity_Type : int;
}  // namespace sync_pb

namespace syncer {

// A bookmark version of LoopbackServerEntity. This type represents entities
// that are non-deleted, client-created, and not unique per client account.
class PersistentBookmarkEntity : public LoopbackServerEntity {
 public:
  ~PersistentBookmarkEntity() override;

  // Factory function for PersistentBookmarkEntity. This factory should be used
  // only for the first time that a specific bookmark is seen by the server.
  static std::unique_ptr<LoopbackServerEntity> CreateNew(
      const sync_pb::SyncEntity& client_entity,
      const std::string& parent_id,
      const std::string& originator_cache_guid);

  // Factory function for PersistentBookmarkEntity. The server's current entity
  // for this ID, `current_server_entity`, is passed here because the client
  // does not always send the complete entity over the wire. This requires
  // copying of some of the existing entity when creating a new entity.
  static std::unique_ptr<LoopbackServerEntity> CreateUpdatedVersion(
      const sync_pb::SyncEntity& client_entity,
      const LoopbackServerEntity& current_server_entity,
      const std::string& parent_id,
      const std::string& originator_cache_guid);

  // Factory function for PersistentBookmarkEntity used when de-serializing the
  // information stored in the persistent storage.
  static std::unique_ptr<LoopbackServerEntity> CreateFromEntity(
      const sync_pb::SyncEntity& client_entity);

  PersistentBookmarkEntity(const std::string& id,
                           int64_t version,
                           const std::string& name,
                           const std::string& originator_cache_guid,
                           const std::string& originator_client_item_id,
                           const std::string& client_tag_hash,
                           const sync_pb::UniquePosition& unique_position,
                           const sync_pb::EntitySpecifics& specifics,
                           bool is_folder,
                           const std::string& parent_id,
                           int64_t creation_time,
                           int64_t last_modified_time);

  void SetParentId(const std::string& parent_id);

  // LoopbackServerEntity implementation.
  bool RequiresParentId() const override;
  std::string GetParentId() const override;
  void SerializeAsProto(sync_pb::SyncEntity* proto) const override;
  bool IsFolder() const override;
  sync_pb::LoopbackServerEntity_Type GetLoopbackServerEntityType()
      const override;

 private:
  // All member values have equivalent fields in SyncEntity.
  const std::string originator_cache_guid_;
  const std::string originator_client_item_id_;
  // Whether a client tag hash was provided upon *creation*, or an empty string
  // otherwise. Takes precedence over the two fields above when exposing the
  // entity in the protocol.
  const std::string client_tag_hash_;
  const bool is_folder_;
  sync_pb::UniquePosition unique_position_;
  std::string parent_id_;
  int64_t creation_time_;
  int64_t last_modified_time_;
};

}  // namespace syncer

#endif  // COMPONENTS_SYNC_ENGINE_LOOPBACK_SERVER_PERSISTENT_BOOKMARK_ENTITY_H_