File: external_constants_builder.h

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 (118 lines) | stat: -rw-r--r-- 4,082 bytes parent folder | download | duplicates (3)
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
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_UPDATER_EXTERNAL_CONSTANTS_BUILDER_H_
#define CHROME_UPDATER_EXTERNAL_CONSTANTS_BUILDER_H_

#include <optional>
#include <string>
#include <vector>

#include "base/files/file_path.h"
#include "base/values.h"

namespace base {
class TimeDelta;
}

namespace crx_file {
enum class VerifierFormat;
}

namespace updater {

struct EventLoggingPermissionProvider;

// ExternalConstantsBuilder uses the Builder design pattern to write a set of
// overrides for default constant values to the file loaded by
// ExternalConstantsOverrider. It is not thread-safe.
//
// When writing an overrides file, unset values (either because they were never
// set or because they were cleared) are not included in the file, so the
// "real" value would be used instead. An ExternalConstantsBuilder with
// no values set would write an empty JSON object, which is a valid override
// file that overrides nothing.
//
// If an ExternalConstantsBuilder is destroyed with no calls to Overwrite(),
// it logs an error.
class ExternalConstantsBuilder {
 public:
  ExternalConstantsBuilder() = default;
  ~ExternalConstantsBuilder();

  ExternalConstantsBuilder& SetUpdateURL(const std::vector<std::string>& urls);
  ExternalConstantsBuilder& ClearUpdateURL();

  ExternalConstantsBuilder& SetCrashUploadURL(const std::string& url);
  ExternalConstantsBuilder& ClearCrashUploadURL();

  ExternalConstantsBuilder& SetAppLogoURL(const std::string& url);
  ExternalConstantsBuilder& ClearAppLogoURL();

  ExternalConstantsBuilder& SetEventLoggingUrl(const std::string& url);
  ExternalConstantsBuilder& ClearEventLoggingUrl();

  ExternalConstantsBuilder& SetEventLoggingPermissionProvider(
      std::optional<EventLoggingPermissionProvider>
          event_logging_permission_provider);
  ExternalConstantsBuilder& ClearEventLoggingPermissionProvider();

  ExternalConstantsBuilder& SetMinimumEventLoggingCooldown(
      base::TimeDelta cooldown);
  ExternalConstantsBuilder& ClearMinimumEventLoggingCooldown();

  ExternalConstantsBuilder& SetUseCUP(bool use_cup);
  ExternalConstantsBuilder& ClearUseCUP();

  ExternalConstantsBuilder& SetInitialDelay(base::TimeDelta initial_delay);
  ExternalConstantsBuilder& ClearInitialDelay();

  ExternalConstantsBuilder& SetServerKeepAliveTime(
      base::TimeDelta server_keep_alive_seconds);
  ExternalConstantsBuilder& ClearServerKeepAliveSeconds();

  ExternalConstantsBuilder& SetCrxVerifierFormat(
      crx_file::VerifierFormat crx_verifier_format);
  ExternalConstantsBuilder& ClearCrxVerifierFormat();

  ExternalConstantsBuilder& SetDictPolicies(
      const base::Value::Dict& dict_policies);
  ExternalConstantsBuilder& ClearDictPolicies();

  ExternalConstantsBuilder& SetOverinstallTimeout(
      base::TimeDelta overinstall_timeout);
  ExternalConstantsBuilder& ClearOverinstallTimeout();

  ExternalConstantsBuilder& SetIdleCheckPeriod(
      base::TimeDelta idle_check_period);
  ExternalConstantsBuilder& ClearIdleCheckPeriod();

  ExternalConstantsBuilder& SetMachineManaged(
      std::optional<bool> is_managed_device);
  ExternalConstantsBuilder& ClearMachineManaged();

  ExternalConstantsBuilder& SetCecaConnectionTimeout(
      base::TimeDelta ceca_connection_timeout);
  ExternalConstantsBuilder& ClearCecaConnectionTimeout();

  // Write the external constants overrides file in the default location
  // with the values that have been previously set, replacing any file
  // previously there. The builder remains usable, does not forget its state,
  // and subsequent calls to Overwrite will once again replace the file.
  //
  // Returns true on success, false on failure.
  bool Overwrite();

  // Blend the set values in this instance with the external constants overrides
  // file in the default location.
  bool Modify();

 private:
  base::Value::Dict overrides_;
  bool written_ = false;
};

}  // namespace updater

#endif  // CHROME_UPDATER_EXTERNAL_CONSTANTS_BUILDER_H_