blob: cfdae6e57ceb9ebb3e8b162025b27f53b5246e7a (
plain)
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
|
// Copyright 2020 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_CONVERSIONS_CONVERSION_STORAGE_H_
#define CONTENT_BROWSER_CONVERSIONS_CONVERSION_STORAGE_H_
#include <stdint.h>
#include <vector>
#include "base/time/time.h"
#include "content/browser/conversions/conversion_report.h"
#include "content/browser/conversions/storable_conversion.h"
#include "content/browser/conversions/storable_impression.h"
namespace content {
// This class provides an interface for persisting impression/conversion data to
// disk, and performing queries on it.
class ConversionStorage {
public:
// Storage delegate that can supplied to extend basic conversion storage
// functionality like annotating conversion reports.
class Delegate {
public:
virtual ~Delegate() = default;
// New conversions will be sent through this callback for
// pruning/modification before they are added to storage. This will be
// called during the execution of
// ConversionStorage::MaybeCreateAndStoreConversionReports(). |reports| will
// contain a report for each matching impression for a given conversion
// event. Each report will be pre-populated from storage with the conversion
// event data.
virtual void ProcessNewConversionReports(
std::vector<ConversionReport>* reports) = 0;
// This limit is used to determine if an impression is allowed to schedule
// a new conversion reports. When an impression reaches this limit it is
// marked inactive and no new conversion reports will be created for it.
// Impressions will be checked against this limit after they schedule a new
// report.
virtual int GetMaxConversionsPerImpression() const = 0;
};
virtual ~ConversionStorage() = default;
// Initializes the storage. Returns true on success, otherwise the storage
// should not be used.
virtual bool Initialize() = 0;
// Add |impression| to storage. Two impressions are considered
// matching when they share a <reporting_origin, conversion_origin> pair. When
// an impression is stored, all matching impressions that have
// already converted are marked as inactive, and are no longer eligible for
// reporting. Unconverted matching impressions are not modified.
virtual void StoreImpression(const StorableImpression& impression) = 0;
// Finds all stored impressions matching a given |conversion|, and stores new
// associated conversion reports. The delegate will receive a call
// to Delegate::ProcessNewConversionReports() before the reports are added to
// storage. Only active impressions will receive new conversions. Returns the
// number of new conversion reports that have been scheduled/added to storage.
virtual int MaybeCreateAndStoreConversionReports(
const StorableConversion& conversion) = 0;
// Returns all of the conversion reports that should be sent before
// |max_report_time|. This call is logically const, and does not modify the
// underlying storage.
virtual std::vector<ConversionReport> GetConversionsToReport(
base::Time max_report_time) = 0;
// Deletes all impressions that have expired and have no pending conversion
// reports. Returns the number of impressions that were deleted.
virtual int DeleteExpiredImpressions() = 0;
// Deletes the conversion report with the given |conversion_id|. Returns
// whether the deletion was successful.
virtual bool DeleteConversion(int64_t conversion_id) = 0;
// TODO(johnidel): Add an API to ConversionStorage that removes site data, and
// hook it into the data remover. This should be added before the API is
// enabled.
};
} // namespace content
#endif // CONTENT_BROWSER_CONVERSIONS_CONVERSION_STORAGE_H_
|
