[Payment Request] Implement the "user aborts the payment request" algorithm
[WebKit-https.git] / Source / WebCore / Modules / paymentrequest / PaymentRequest.h
1 /*
2  * Copyright (C) 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. 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 #pragma once
27
28 #if ENABLE(PAYMENT_REQUEST)
29
30 #include "ActiveDOMObject.h"
31 #include "EventTarget.h"
32 #include "ExceptionOr.h"
33 #include "JSDOMPromiseDeferred.h"
34 #include "PaymentDetailsInit.h"
35 #include "PaymentOptions.h"
36 #include "URL.h"
37 #include <wtf/Variant.h>
38
39 namespace WebCore {
40
41 class Document;
42 class Event;
43 class PaymentAddress;
44 class PaymentHandler;
45 class PaymentResponse;
46 enum class PaymentComplete;
47 enum class PaymentShippingType;
48 struct PaymentMethodData;
49
50 class PaymentRequest final : public RefCounted<PaymentRequest>, public ActiveDOMObject, public EventTargetWithInlineData {
51 public:
52     using ShowPromise = DOMPromiseDeferred<IDLInterface<PaymentResponse>>;
53     using AbortPromise = DOMPromiseDeferred<void>;
54     using CanMakePaymentPromise = DOMPromiseDeferred<IDLBoolean>;
55
56     static ExceptionOr<Ref<PaymentRequest>> create(Document&, Vector<PaymentMethodData>&&, PaymentDetailsInit&&, PaymentOptions&&);
57     ~PaymentRequest();
58
59     void show(Document&, ShowPromise&&);
60     ExceptionOr<void> abort(AbortPromise&&);
61     void canMakePayment(Document&, CanMakePaymentPromise&&);
62
63     const String& id() const;
64     PaymentAddress* shippingAddress() const { return m_shippingAddress.get(); }
65     const String& shippingOption() const { return m_shippingOption; }
66     std::optional<PaymentShippingType> shippingType() const;
67
68     const PaymentOptions& paymentOptions() const { return m_options; }
69     const PaymentDetailsInit& paymentDetails() const { return m_details; }
70
71     void shippingAddressChanged(Ref<PaymentAddress>&&);
72     void shippingOptionChanged(const String& shippingOption);
73     ExceptionOr<void> updateWith(Event&, Ref<DOMPromise>&&);
74     void accept(const String& methodName, JSC::Strong<JSC::JSObject>&& details, Ref<PaymentAddress>&& shippingAddress, const String& payerName, const String& payerEmail, const String& payerPhone);
75     void complete(std::optional<PaymentComplete>&&);
76     void cancel();
77
78     // EventTarget
79     bool dispatchEvent(Event&) final;
80
81     using MethodIdentifier = Variant<String, URL>;
82     using RefCounted<PaymentRequest>::ref;
83     using RefCounted<PaymentRequest>::deref;
84
85 private:
86     enum class State {
87         Created,
88         Interactive,
89         Closed,
90     };
91
92     struct Method {
93         MethodIdentifier identifier;
94         String serializedData;
95     };
96
97     PaymentRequest(Document&, PaymentOptions&&, PaymentDetailsInit&&, Vector<String>&& serializedModifierData, Vector<Method>&& serializedMethodData, String&& selectedShippingOption);
98
99     void settleDetailsPromise(const AtomicString& type);
100     void abortWithException(Exception&&);
101
102     // ActiveDOMObject
103     const char* activeDOMObjectName() const final { return "PaymentRequest"; }
104     bool canSuspendForDocumentSuspension() const final;
105     void stop() final;
106
107     // EventTarget
108     EventTargetInterface eventTargetInterface() const final { return PaymentRequestEventTargetInterfaceType; }
109     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
110     void refEventTarget() final { ref(); }
111     void derefEventTarget() final { deref(); }
112
113     PaymentOptions m_options;
114     PaymentDetailsInit m_details;
115     Vector<String> m_serializedModifierData;
116     Vector<Method> m_serializedMethodData;
117     String m_shippingOption;
118     RefPtr<PaymentAddress> m_shippingAddress;
119     State m_state { State::Created };
120     std::optional<ShowPromise> m_showPromise;
121     RefPtr<PaymentHandler> m_activePaymentHandler;
122     RefPtr<DOMPromise> m_detailsPromise;
123     bool m_isUpdating { false };
124 };
125
126 std::optional<PaymentRequest::MethodIdentifier> convertAndValidatePaymentMethodIdentifier(const String& identifier);
127
128 } // namespace WebCore
129
130 #endif // ENABLE(PAYMENT_REQUEST)