a0585ab17352da9d42c6047380564ed383bde678
[WebKit-https.git] / Source / WebCore / storage / StorageQuotaManager.h
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. ``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 "ClientOrigin.h"
29 #include <wtf/CompletionHandler.h>
30 #include <wtf/Deque.h>
31 #include <wtf/HashSet.h>
32 #include <wtf/WeakPtr.h>
33
34 namespace WebCore {
35
36 class StorageQuotaUser;
37
38 class StorageQuotaManager : public CanMakeWeakPtr<StorageQuotaManager> {
39     WTF_MAKE_FAST_ALLOCATED;
40 public:
41     using SpaceIncreaseRequester = WTF::Function<void(uint64_t quota, uint64_t currentSpace, uint64_t spaceIncrease, CompletionHandler<void(Optional<uint64_t>)>&&)>;
42     StorageQuotaManager(uint64_t quota, SpaceIncreaseRequester&& spaceIncreaseRequester)
43         : m_quota(quota)
44         , m_spaceIncreaseRequester(WTFMove(spaceIncreaseRequester))
45     {
46     }
47     WEBCORE_EXPORT ~StorageQuotaManager();
48
49     static constexpr uint64_t defaultQuota() { return 1000 * MB; }
50     static constexpr uint64_t defaultThirdPartyQuota() { return 100 * MB; }
51
52     WEBCORE_EXPORT void addUser(StorageQuotaUser&);
53     void removeUser(StorageQuotaUser& user)
54     {
55         ASSERT(m_users.contains(&user) || m_pendingInitializationUsers.contains(&user));
56         m_pendingInitializationUsers.remove(&user);
57         m_users.remove(&user);
58     }
59
60     enum class Decision { Deny, Grant };
61     using RequestCallback = CompletionHandler<void(Decision)>;
62     WEBCORE_EXPORT void requestSpace(uint64_t, RequestCallback&&);
63     void resetQuota(uint64_t newQuota) { m_quota = newQuota; }
64
65     WEBCORE_EXPORT void updateQuotaBasedOnSpaceUsage();
66
67 private:
68     uint64_t spaceUsage() const;
69     bool shouldAskForMoreSpace(uint64_t spaceIncrease) const;
70     void askForMoreSpace(uint64_t spaceIncrease);
71     void processPendingRequests(Optional<uint64_t>);
72
73     uint64_t m_quota { 0 };
74     SpaceIncreaseRequester m_spaceIncreaseRequester;
75     HashSet<const StorageQuotaUser*> m_pendingInitializationUsers;
76     HashSet<const StorageQuotaUser*> m_users;
77
78     struct PendingRequest {
79         uint64_t spaceIncrease;
80         RequestCallback callback;
81     };
82     Deque<PendingRequest> m_pendingRequests;
83 };
84
85 } // namespace WebCore