Clearing Website data for a given session should not shut down cached processes for...
[WebKit.git] / Source / WebKit / UIProcess / WebBackForwardCache.cpp
1 /*
2  * Copyright (C) 2019 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "WebBackForwardCache.h"
28
29 #include "SuspendedPageProxy.h"
30 #include "WebBackForwardListItem.h"
31 #include "WebPageProxy.h"
32 #include "WebProcessProxy.h"
33 #include "WebsiteDataStore.h"
34
35 namespace WebKit {
36
37 WebBackForwardCache::WebBackForwardCache() = default;
38
39 WebBackForwardCache::~WebBackForwardCache() = default;
40
41 inline void WebBackForwardCache::removeOldestEntry()
42 {
43     ASSERT(!m_itemsWithCachedPage.isEmpty());
44     removeEntry(*m_itemsWithCachedPage.first());
45 }
46
47 void WebBackForwardCache::setCapacity(unsigned capacity)
48 {
49     m_capacity = capacity;
50     while (size() > capacity)
51         removeOldestEntry();
52 }
53
54 void WebBackForwardCache::addEntry(WebBackForwardListItem& item, std::unique_ptr<SuspendedPageProxy>&& suspendedPage)
55 {
56     ASSERT(capacity());
57
58     item.setSuspendedPage(WTFMove(suspendedPage));
59     m_itemsWithCachedPage.add(&item);
60
61     if (size() > capacity())
62         removeOldestEntry();
63     ASSERT(size() <= capacity());
64 }
65
66 void WebBackForwardCache::removeEntry(WebBackForwardListItem& item)
67 {
68     ASSERT(m_itemsWithCachedPage.contains(&item));
69     m_itemsWithCachedPage.remove(&item);
70     item.setSuspendedPage(nullptr);
71 }
72
73 std::unique_ptr<SuspendedPageProxy> WebBackForwardCache::takeEntry(WebBackForwardListItem& item)
74 {
75     ASSERT(m_itemsWithCachedPage.contains(&item));
76     m_itemsWithCachedPage.remove(&item);
77     return item.takeSuspendedPage();
78 }
79
80 void WebBackForwardCache::removeEntriesForProcess(WebProcessProxy& process)
81 {
82     removeEntriesMatching([&process](auto& item) {
83         return &item.suspendedPage()->process() == &process;
84     });
85 }
86
87 void WebBackForwardCache::removeEntriesForSession(PAL::SessionID sessionID)
88 {
89     removeEntriesMatching([sessionID](auto& item) {
90         return item.suspendedPage()->process().websiteDataStore().sessionID() == sessionID;
91     });
92 }
93
94 void WebBackForwardCache::removeEntriesForPage(WebPageProxy& page)
95 {
96     removeEntriesMatching([pageID = page.identifier()](auto& item) {
97         return item.pageID() == pageID;
98     });
99 }
100
101 void WebBackForwardCache::removeEntriesMatching(const Function<bool(WebBackForwardListItem&)>& matches)
102 {
103     for (auto it = m_itemsWithCachedPage.begin(); it != m_itemsWithCachedPage.end();) {
104         auto current = it;
105         ++it;
106         if (matches(**current)) {
107             (*current)->setSuspendedPage(nullptr);
108             m_itemsWithCachedPage.remove(current);
109         }
110     }
111 }
112
113 void WebBackForwardCache::clear()
114 {
115     auto itemsWithCachedPage = WTFMove(m_itemsWithCachedPage);
116     for (auto* item : itemsWithCachedPage)
117         item->setSuspendedPage(nullptr);
118 }
119
120 } // namespace WebKit.