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
|
// Copyright 2015 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 CHROME_BROWSER_ANDROID_DATA_USAGE_TAB_DATA_USE_ENTRY_H_
#define CHROME_BROWSER_ANDROID_DATA_USAGE_TAB_DATA_USE_ENTRY_H_
#include <deque>
#include <string>
#include "base/gtest_prod_util.h"
#include "base/macros.h"
#include "base/time/time.h"
namespace chrome {
namespace android {
class DataUseTabModel;
// TabDataUseTrackingSession maintains the information about a single tracking
// session within a browser tab.
struct TabDataUseTrackingSession {
TabDataUseTrackingSession(const std::string& label,
const base::TimeTicks& start_time)
: label(label), start_time(start_time) {}
// Tracking label to be associated with the data usage of this session.
const std::string label;
// Time the data use tracking session started.
const base::TimeTicks start_time;
// Time the data use tracking session ended. |end_time| will be null if the
// tracking session is currently active.
base::TimeTicks end_time;
};
// TabDataUseEntry contains the history of the disjoint tracking sessions for a
// single browser tab.
class TabDataUseEntry {
public:
explicit TabDataUseEntry(DataUseTabModel* tab_model);
TabDataUseEntry(const TabDataUseEntry& other);
virtual ~TabDataUseEntry();
TabDataUseEntry& operator=(const TabDataUseEntry& other) = default;
// Initiates a new tracking session with the given |label|. Returns false if a
// tracking session is already active, and true otherwise.
bool StartTracking(const std::string& label);
// Ends the active tracking session. Returns false if there is no active
// tracking session, and true otherwise.
bool EndTracking();
// Ends the active tracking session if it is labeled with |label| and returns
// true.
bool EndTrackingWithLabel(const std::string& label);
// Records that the tab has been closed, in preparation for deletion.
void OnTabCloseEvent();
// Gets the label of the session in history that was active at
// |data_use_time|. |output_label| must not be null. If a session is found,
// returns true and |output_label| is populated. Otherwise returns false and
// |output_label| is set to empty string.
bool GetLabel(const base::TimeTicks& data_use_time,
std::string* output_label) const;
// Returns true if the tracking session is currently active.
bool IsTrackingDataUse() const;
// Returns true if the tab has expired. A closed tab entry expires
// |kClosedTabExpirationDurationSeconds| seconds after it was closed. An open
// tab entry expires |kOpenTabExpirationDurationSeconds| seconds after the
// most recent tracking session start or end event.
bool IsExpired() const;
// Returns the latest time a tracking session was started or ended. Returned
// time will be null if no tracking session was ever started or ended.
const base::TimeTicks GetLatestStartOrEndTime() const;
// Returns the tracking label for the active tracking session. Empty string is
// returned if tracking session is not active.
const std::string GetActiveTrackingSessionLabel() const;
bool is_custom_tab_package_match() const {
return is_custom_tab_package_match_;
}
void set_custom_tab_package_match(bool is_custom_tab_package_match);
private:
friend class TabDataUseEntryTest;
FRIEND_TEST_ALL_PREFIXES(TabDataUseEntryTest, MultipleTabSessionCloseEvent);
FRIEND_TEST_ALL_PREFIXES(TabDataUseEntryTest, SingleTabSessionCloseEvent);
FRIEND_TEST_ALL_PREFIXES(DataUseTabModelTest,
ExpiredInactiveTabEntryRemovaltimeHistogram);
FRIEND_TEST_ALL_PREFIXES(DataUseTabModelTest, TabCloseEvent);
typedef std::deque<TabDataUseTrackingSession> TabSessions;
// Compacts the history of tracking sessions by removing oldest sessions to
// keep the size of |sessions_| within |kMaxSessionsPerTab| entries.
void CompactSessionHistory();
// Contains the history of sessions in chronological order. Oldest sessions
// will be at the front of the queue, and new sessions will get added to the
// end of the queue.
TabSessions sessions_;
// Indicates the time the tab was closed. |tab_close_time_| will be null if
// the tab is still open.
base::TimeTicks tab_close_time_;
// True if tracking was started in a custom tab due to package name match.
bool is_custom_tab_package_match_;
// Pointer to the DataUseTabModel that owns |this|.
const DataUseTabModel* tab_model_;
};
} // namespace android
} // namespace chrome
#endif // CHROME_BROWSER_ANDROID_DATA_USAGE_TAB_DATA_USE_ENTRY_H_
|
