File: permission_auditing_database.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (92 lines) | stat: -rw-r--r-- 3,710 bytes parent folder | download | duplicates (2)
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 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 COMPONENTS_PERMISSIONS_PERMISSION_AUDITING_DATABASE_H_
#define COMPONENTS_PERMISSIONS_PERMISSION_AUDITING_DATABASE_H_

#include <vector>

#include "base/time/time.h"
#include "components/content_settings/core/common/content_settings_types.h"
#include "components/permissions/permission_usage_session.h"
#include "sql/database.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "url/origin.h"

namespace base {
class FilePath;
}  // namespace base

namespace permissions {

// Stores permission usage sessions for specific url origin and
// ContentSettingType in an SQLite database. Additionally, handles the queries
// about the last permission usage time for a specific origin.
// Threading constraints:
// 1) This class is not thread-safe, so each instance must be used on the same
// sequence;
// 2) Instances must be used on a sequence that can execute blocking tasks.
class PermissionAuditingDatabase {
 public:
  PermissionAuditingDatabase();
  ~PermissionAuditingDatabase();

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

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

  // Opens an existing database at `path` or creates a new one if none exists,
  // and returns true on success.
  bool Init(const base::FilePath& path);

  // Appends a new permission usage `session` of the given permission `type` on
  // a given `origin`. The `session` must be valid according to IsValid().
  // Operation will fail if a session with the same primary key, that
  // is, origin, type, and usage start time, already exists in the database.
  // Returns if the operation was successful.
  bool StorePermissionUsage(const PermissionUsageSession& session);

  // Returns the detailed history stored for the permission `type` on a given
  // `origin` from the specified `start_time`. The `origin` must not be opaque.
  std::vector<PermissionUsageSession> GetPermissionUsageHistory(
      ContentSettingsType type,
      const url::Origin& origin,
      base::Time start_time);

  // Returns when the given permission `type` was last used on a given `origin`.
  // Returns nullopt if no permission usages match the given constraints. The
  // `origin` must not be opaque.
  absl::optional<base::Time> GetLastPermissionUsageTime(
      ContentSettingsType type,
      const url::Origin& origin);

  // Updates the usage end time for a specific usage session. The session is
  // identified by the primary key {`type`, `origin`, `start_time`}, and must
  // already exist. `start_time` must be less than or equal to `new_end_time`.
  // Operation will fail if `start_time` or `new_end_time` is null. Returns if
  // the operation was successful.
  bool UpdateEndTime(ContentSettingsType type,
                     const url::Origin& origin,
                     base::Time start_time,
                     base::Time new_end_time);

  // Deletes permission usage sessions, which started or ended in the given
  // time range. A null `start_time` or `end_time` time is treated as -inf and
  // +inf, respectively. Returns if the operation was successful.
  bool DeleteSessionsBetween(base::Time start_time, base::Time end_time);

 private:
  bool CreateSchema();

  // The SQL connection to database.
  sql::Database db_;
};

}  // namespace permissions

#endif  // COMPONENTS_PERMISSIONS_PERMISSION_AUDITING_DATABASE_H_