bd9f1f5e7c54449d540cbf6e6da3801bcd150685
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadStatistics.h
1 /*
2  * Copyright (C) 2016-2017 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "URL.h"
29 #include <wtf/HashCountedSet.h>
30 #include <wtf/WallTime.h>
31 #include <wtf/text/StringHash.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35
36 class KeyedDecoder;
37 class KeyedEncoder;
38
39 struct ResourceLoadStatistics {
40     explicit ResourceLoadStatistics(const String& primaryDomain)
41         : highLevelDomain(primaryDomain)
42     {
43     }
44
45     ResourceLoadStatistics() = default;
46
47     ResourceLoadStatistics(const ResourceLoadStatistics&) = delete;
48     ResourceLoadStatistics& operator=(const ResourceLoadStatistics&) = delete;
49     ResourceLoadStatistics(ResourceLoadStatistics&&) = default;
50     ResourceLoadStatistics& operator=(ResourceLoadStatistics&&) = default;
51
52     WEBCORE_EXPORT static String primaryDomain(const URL&);
53     WEBCORE_EXPORT static String primaryDomain(const String& host);
54
55     WEBCORE_EXPORT void encode(KeyedEncoder&) const;
56     WEBCORE_EXPORT bool decode(KeyedDecoder&);
57
58     String toString() const;
59
60     WEBCORE_EXPORT void merge(const ResourceLoadStatistics&);
61
62     String highLevelDomain;
63
64     WallTime lastSeen;
65     
66     // User interaction
67     bool hadUserInteraction { false };
68     // Timestamp. Default value is negative, 0 means it was reset.
69     WallTime mostRecentUserInteractionTime { WallTime::fromRawSeconds(-1) };
70     bool grandfathered { false };
71     
72     // Subframe stats
73     HashCountedSet<String> subframeUnderTopFrameOrigins;
74     
75     // Subresource stats
76     HashCountedSet<String> subresourceUnderTopFrameOrigins;
77     HashCountedSet<String> subresourceUniqueRedirectsTo;
78     
79     // Prevalent resource stats
80     bool isPrevalentResource { false };
81     unsigned dataRecordsRemoved { 0 };
82
83     // In-memory only
84     bool isMarkedForCookiePartitioning { false };
85 };
86
87 } // namespace WebCore