Update Resource Load Statistics
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadObserver.h
1 /*
2  * Copyright (C) 2016 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 #ifndef ResourceLoadObserver_h
27 #define ResourceLoadObserver_h
28
29 #include "ResourceLoadStatisticsStore.h"
30 #include <wtf/HashMap.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace WebCore {
34
35 class Document;
36 class Frame;
37 class Page;
38 class ResourceRequest;
39 class ResourceResponse;
40 class URL;
41
42 struct ResourceLoadStatistics;
43
44 class ResourceLoadObserver {
45     friend class NeverDestroyed<ResourceLoadObserver>;
46 public:
47     WEBCORE_EXPORT static ResourceLoadObserver& sharedObserver();
48     
49     void logFrameNavigation(const Frame& frame, const Frame& topFrame, const ResourceRequest& newRequest, const ResourceResponse& redirectResponse);
50     void logSubresourceLoading(const Frame*, const ResourceRequest& newRequest, const ResourceResponse& redirectResponse);
51     void logWebSocketLoading(const Frame*, const URL&);
52
53     void logUserInteraction(const Document&);
54     
55     WEBCORE_EXPORT void setStatisticsStore(Ref<ResourceLoadStatisticsStore>&&);
56
57     WEBCORE_EXPORT String statisticsForOrigin(const String&);
58
59 private:
60     bool shouldLog(Page*);
61     static String primaryDomain(const URL&);
62
63     RefPtr<ResourceLoadStatisticsStore> m_store;
64     HashMap<String, size_t> m_originsVisitedMap;
65 };
66     
67 } // namespace WebCore
68
69 #endif /* ResourceLoadObserver_h */