File: valuables_table.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 (92 lines) | stat: -rw-r--r-- 3,737 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
// Copyright 2025 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_AUTOFILL_CORE_BROWSER_WEBDATA_VALUABLES_VALUABLES_TABLE_H_
#define COMPONENTS_AUTOFILL_CORE_BROWSER_WEBDATA_VALUABLES_VALUABLES_TABLE_H_

#include <optional>
#include <vector>

#include "components/autofill/core/browser/data_model/valuables/loyalty_card.h"
#include "components/webdata/common/web_database_table.h"

class WebDatabase;

namespace autofill {

// This class manages non-payments data types coming from Google Wallet within
// the SQLite database passed in the constructor. It expects the following
// schema:
//
// -----------------------------------------------------------------------------
// loyalty_cards
//
//   loyalty_card_id      Uniquely identifies the loyalty card instance (primary
//                        key).
//   merchant_name        The name of the loyalty card provider e.g.
//                        "Deutsche Bahn".
//   program_name         The name of the program from the loyalty card provider
//                        e.g. "BahnBonus".
//   program_logo         The url of the logo icon for the card.
//   loyalty_card_number  A string representation of the unmasked loyalty card
//                        number suffix.
// -----------------------------------------------------------------------------
// loyalty_card_merchant_domain
//                      Contains the mapping of merchant domains and card linked
//                      offers.
//
//   loyalty_card_id    Identifies the relevant loyalty card. Matches the
//                      `loyalty_card_id` in the loyalty_cards table.
//   merchant_domain    List of full origins for merchant websites on which
//                      this card would apply.
// -----------------------------------------------------------------------------
class ValuablesTable : public WebDatabaseTable {
 public:
  ValuablesTable();

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

  ~ValuablesTable() override;

  // Retrieves the ValuablesTable* owned by `db`.
  static ValuablesTable* FromWebDatabase(WebDatabase* db);

  // WebDatabaseTable:
  WebDatabaseTable::TypeKey GetTypeKey() const override;
  bool CreateTablesIfNecessary() override;
  bool MigrateToVersion(int version, bool* update_compatible_version) override;

  // Returns all loyalty cards stored in the database.
  std::vector<LoyaltyCard> GetLoyaltyCards() const;

  // Overwrites the existing set of loyalty cards in the DB with those in
  // `loyalty_cards`. Returns `true` if the database operation succeeded with no
  // errors.
  bool SetLoyaltyCards(const std::vector<LoyaltyCard>& loyalty_cards) const;

  // Attempts to retrieve a loyalty card from the database using the
  // `loyalty_card_id` as a unique identifier. Returns `std::nullopt` if there's
  // no loyalty card with `loyalty_card_id` in the database.
  std::optional<LoyaltyCard> GetLoyaltyCardById(
      ValuableId loyalty_card_id) const;

  // Removes the loyalty card from the database using `loyalty_card_id` as a
  // unique identifier. Returns `true` if the operation succeeded.
  bool RemoveLoyaltyCard(ValuableId loyalty_card_id);

 private:
  bool InitLoyaltyCardsTable();
  bool InitLoyaltyCardMerchantDomainTable();

  // Renames the database table from `loyalty_card` to `loyalty_cards` and
  // renames the following columns:
  //   * `guid` to `loyalty_card_id`.
  //   * `unmasked_loyalty_card_suffix` to `loyalty_card_number`.
  bool MigrateToVersion138();
};

}  // namespace autofill

#endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_WEBDATA_VALUABLES_VALUABLES_TABLE_H_