File: policy_statistics_collector.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 (176 lines) | stat: -rw-r--r-- 5,963 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
// 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 "components/policy/core/common/policy_statistics_collector.h"

#include <algorithm>
#include <string>

#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/location.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/task/task_runner.h"
#include "base/time/time.h"
#include "components/policy/core/common/cloud/enterprise_metrics.h"
#include "components/policy/core/common/policy_map.h"
#include "components/policy/core/common/policy_pref_names.h"
#include "components/policy/core/common/policy_service.h"
#include "components/policy/core/common/policy_types.h"
#include "components/policy/policy_constants.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"

namespace policy {

namespace {

constexpr char kPoliciesSourceMetricsName[] = "Enterprise.Policies.Sources";

constexpr const char* kCBCMEnrollmentPolicies[] = {
    "CloudManagementEnrollmentToken", "CloudManagementEnrollmentMandatory"};

enum SimplePolicySource {
  kNone = 0,
  kCloud = 1 << 0,
  kPlatform = 1 << 1,
  kMerge = kCloud | kPlatform,
  kEnrollment = 1 << 2,
};

SimplePolicySource SimplifyPolicySource(PolicySource source,
                                        const std::string& policy_name) {
  switch (source) {
    case POLICY_SOURCE_CLOUD:
    case POLICY_SOURCE_CLOUD_FROM_ASH:
      return kCloud;
    case POLICY_SOURCE_PLATFORM:
    case POLICY_SOURCE_ACTIVE_DIRECTORY:
      // Adjust for enrollment policies which can never be set from cloud.
      // Count them as cloud policy so that a device is considered as cloud
      // managed even if there is enrollment token only.
      for (const char* enrollment_policy : kCBCMEnrollmentPolicies) {
        if (policy_name == enrollment_policy)
          return kEnrollment;
      }
      return kPlatform;
    case POLICY_SOURCE_MERGED:
      return kMerge;
    default:
      // Other sources are only used for speicial cases and will not be counted.
      return kNone;
  }
}

void RecordPoliciesSources(SimplePolicySource source) {
  if ((source & kMerge) == kMerge) {
    base::UmaHistogramEnumeration(kPoliciesSourceMetricsName,
                                  PoliciesSources::kHybrid);
  } else if (source & kPlatform) {
    base::UmaHistogramEnumeration(kPoliciesSourceMetricsName,
                                  PoliciesSources::kPlatformOnly);
  } else if (source & kCloud) {
    if (source & kEnrollment) {
      base::UmaHistogramEnumeration(
          kPoliciesSourceMetricsName,
          PoliciesSources::kCloudOnlyExceptEnrollment);
    } else {
      base::UmaHistogramEnumeration(kPoliciesSourceMetricsName,
                                    PoliciesSources::kCloudOnly);
    }
  } else if (source & kEnrollment) {
    base::UmaHistogramEnumeration(kPoliciesSourceMetricsName,
                                  PoliciesSources::kEnrollmentOnly);
  }
}
}  // namespace

const base::TimeDelta PolicyStatisticsCollector::kStatisticsUpdateRate =
    base::Days(1);

PolicyStatisticsCollector::PolicyStatisticsCollector(
    const GetChromePolicyDetailsCallback& get_details,
    const Schema& chrome_schema,
    PolicyService* policy_service,
    PrefService* prefs,
    const scoped_refptr<base::TaskRunner>& task_runner)
    : get_details_(get_details),
      chrome_schema_(chrome_schema),
      policy_service_(policy_service),
      prefs_(prefs),
      task_runner_(task_runner) {}

PolicyStatisticsCollector::~PolicyStatisticsCollector() = default;

void PolicyStatisticsCollector::Initialize() {
  base::Time last_update =
      prefs_->GetTime(policy_prefs::kLastPolicyStatisticsUpdate);
  base::TimeDelta delay =
      std::max(base::Time::Now() - last_update, base::TimeDelta());
  if (delay >= kStatisticsUpdateRate)
    CollectStatistics();
  else
    ScheduleUpdate(kStatisticsUpdateRate - delay);
}

// static
void PolicyStatisticsCollector::RegisterPrefs(PrefRegistrySimple* registry) {
  registry->RegisterInt64Pref(policy_prefs::kLastPolicyStatisticsUpdate, 0);
}

void PolicyStatisticsCollector::RecordPolicyUse(int id, Condition condition) {
  std::string suffix;
  switch (condition) {
    case kDefault:
      break;
    case kMandatory:
      suffix = ".Mandatory";
      break;
    case kRecommended:
      suffix = ".Recommended";
      break;
  }
  base::UmaHistogramSparse("Enterprise.Policies" + suffix, id);
}

void PolicyStatisticsCollector::CollectStatistics() {
  const PolicyMap& policies = policy_service_->GetPolicies(
      PolicyNamespace(POLICY_DOMAIN_CHROME, std::string()));

  int source = kNone;
  // Collect statistics.
  for (Schema::Iterator it(chrome_schema_.GetPropertiesIterator());
       !it.IsAtEnd(); it.Advance()) {
    const PolicyMap::Entry* policy_entry = policies.Get(it.key());
    if (!policy_entry)
      continue;
    const PolicyDetails* details = get_details_.Run(it.key());
    if (details) {
      RecordPolicyUse(details->id, kDefault);
      if (policies.Get(it.key())->level == POLICY_LEVEL_MANDATORY) {
        RecordPolicyUse(details->id, kMandatory);
      } else {
        RecordPolicyUse(details->id, kRecommended);
      }
    } else {
      NOTREACHED();
    }
    source |= SimplifyPolicySource(policy_entry->source, it.key());
  }

  RecordPoliciesSources(static_cast<SimplePolicySource>(source));

  // Take care of next update.
  prefs_->SetTime(policy_prefs::kLastPolicyStatisticsUpdate, base::Time::Now());
  ScheduleUpdate(kStatisticsUpdateRate);
}

void PolicyStatisticsCollector::ScheduleUpdate(base::TimeDelta delay) {
  update_callback_.Reset(base::BindOnce(
      &PolicyStatisticsCollector::CollectStatistics, base::Unretained(this)));
  task_runner_->PostDelayedTask(FROM_HERE, update_callback_.callback(), delay);
}

}  // namespace policy