[Web IDL] Pass even more types by reference
[WebKit-https.git] / Source / WebCore / Modules / encryptedmedia / MediaKeySession.cpp
1 /*
2  * Copyright (C) 2013 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 "MediaKeySession.h"
28
29 #if ENABLE(ENCRYPTED_MEDIA_V2)
30
31 #include "CDM.h"
32 #include "CDMSession.h"
33 #include "Document.h"
34 #include "Event.h"
35 #include "GenericEventQueue.h"
36 #include "MediaKeyError.h"
37 #include "MediaKeyMessageEvent.h"
38 #include "MediaKeys.h"
39 #include "Settings.h"
40
41 namespace WebCore {
42
43 Ref<MediaKeySession> MediaKeySession::create(ScriptExecutionContext& context, MediaKeys* keys, const String& keySystem)
44 {
45     auto session = adoptRef(*new MediaKeySession(context, keys, keySystem));
46     session->suspendIfNeeded();
47     return session;
48 }
49
50 MediaKeySession::MediaKeySession(ScriptExecutionContext& context, MediaKeys* keys, const String& keySystem)
51     : ActiveDOMObject(&context)
52     , m_keys(keys)
53     , m_keySystem(keySystem)
54     , m_asyncEventQueue(*this)
55     , m_session(keys->cdm()->createSession(this))
56     , m_keyRequestTimer(*this, &MediaKeySession::keyRequestTimerFired)
57     , m_addKeyTimer(*this, &MediaKeySession::addKeyTimerFired)
58 {
59 }
60
61 MediaKeySession::~MediaKeySession()
62 {
63     if (m_session) {
64         m_session->setClient(nullptr);
65         m_session = nullptr;
66     }
67
68     m_asyncEventQueue.cancelAllEvents();
69 }
70
71 void MediaKeySession::setError(MediaKeyError* error)
72 {
73     m_error = error;
74 }
75
76 void MediaKeySession::close()
77 {
78     if (m_session)
79         m_session->releaseKeys();
80 }
81
82 RefPtr<ArrayBuffer> MediaKeySession::cachedKeyForKeyId(const String& keyId) const
83 {
84     return m_session ? m_session->cachedKeyForKeyID(keyId) : nullptr;
85 }
86
87 const String& MediaKeySession::sessionId() const
88 {
89     return m_session->sessionId();
90 }
91
92 void MediaKeySession::generateKeyRequest(const String& mimeType, Ref<Uint8Array>&& initData)
93 {
94     m_pendingKeyRequests.append({ mimeType, WTFMove(initData) });
95     m_keyRequestTimer.startOneShot(0);
96 }
97
98 void MediaKeySession::keyRequestTimerFired()
99 {
100     ASSERT(m_pendingKeyRequests.size());
101     if (!m_session)
102         return;
103
104     while (!m_pendingKeyRequests.isEmpty()) {
105         PendingKeyRequest request = m_pendingKeyRequests.takeFirst();
106
107         // NOTE: Continued from step 5 in MediaKeys::createSession().
108         // The user agent will asynchronously execute the following steps in the task:
109
110         // 1. Let cdm be the cdm loaded in the MediaKeys constructor.
111         // 2. Let destinationURL be null.
112         String destinationURL;
113         MediaKeyError::Code errorCode = 0;
114         uint32_t systemCode = 0;
115
116         // 3. Use cdm to generate a key request and follow the steps for the first matching condition from the following list:
117
118         RefPtr<Uint8Array> keyRequest = m_session->generateKeyRequest(request.mimeType, request.initData.ptr(), destinationURL, errorCode, systemCode);
119
120         // Otherwise [if a request is not successfully generated]:
121         if (errorCode) {
122             // 3.1. Create a new MediaKeyError object with the following attributes:
123             //      code = the appropriate MediaKeyError code
124             //      systemCode = a Key System-specific value, if provided, and 0 otherwise
125             // 3.2. Set the MediaKeySession object's error attribute to the error object created in the previous step.
126             // 3.3. queue a task to fire a simple event named keyerror at the MediaKeySession object.
127             sendError(errorCode, systemCode);
128             // 3.4. Abort the task.
129             continue;
130         }
131
132         // 4. queue a task to fire a simple event named keymessage at the new object
133         //    The event is of type MediaKeyMessageEvent and has:
134         //    message = key request
135         //    destinationURL = destinationURL
136         if (keyRequest)
137             sendMessage(keyRequest.get(), destinationURL);
138     }
139 }
140
141 void MediaKeySession::update(Ref<Uint8Array>&& key, ExceptionCode& ec)
142 {
143     // From <http://dvcs.w3.org/hg/html-media/raw-file/tip/encrypted-media/encrypted-media.html#dom-addkey>:
144     // The addKey(key) method must run the following steps:
145     // 1. If the first or second argument [sic] is an empty array, throw an INVALID_ACCESS_ERR.
146     // NOTE: the reference to a "second argument" is a spec bug.
147     if (!key->length()) {
148         ec = INVALID_ACCESS_ERR;
149         return;
150     }
151
152     // 2. Schedule a task to handle the call, providing key.
153     m_pendingKeys.append(WTFMove(key));
154     m_addKeyTimer.startOneShot(0);
155 }
156
157 void MediaKeySession::addKeyTimerFired()
158 {
159     ASSERT(m_pendingKeys.size());
160     if (!m_session)
161         return;
162
163     while (!m_pendingKeys.isEmpty()) {
164         auto pendingKey = m_pendingKeys.takeFirst();
165         unsigned short errorCode = 0;
166         uint32_t systemCode = 0;
167
168         // NOTE: Continued from step 2. of MediaKeySession::update()
169         // 2.1. Let cdm be the cdm loaded in the MediaKeys constructor.
170         // NOTE: This is m_session.
171         // 2.2. Let 'did store key' be false.
172         bool didStoreKey = false;
173         // 2.3. Let 'next message' be null.
174         RefPtr<Uint8Array> nextMessage;
175         // 2.4. Use cdm to handle key.
176         didStoreKey = m_session->update(pendingKey.ptr(), nextMessage, errorCode, systemCode);
177         // 2.5. If did store key is true and the media element is waiting for a key, queue a task to attempt to resume playback.
178         // TODO: Find and restart the media element
179
180         // 2.6. If next message is not null, queue a task to fire a simple event named keymessage at the MediaKeySession object.
181         //      The event is of type MediaKeyMessageEvent and has:
182         //      message = next message
183         //      destinationURL = null
184         if (nextMessage)
185             sendMessage(nextMessage.get(), emptyString());
186
187         // 2.7. If did store key is true, queue a task to fire a simple event named keyadded at the MediaKeySession object.
188         if (didStoreKey) {
189             RefPtr<Event> keyaddedEvent = Event::create(eventNames().webkitkeyaddedEvent, false, false);
190             keyaddedEvent->setTarget(this);
191             m_asyncEventQueue.enqueueEvent(keyaddedEvent.release());
192
193             keys()->keyAdded();
194         }
195
196         // 2.8. If any of the preceding steps in the task failed
197         if (errorCode) {
198             // 2.8.1. Create a new MediaKeyError object with the following attributes:
199             //        code = the appropriate MediaKeyError code
200             //        systemCode = a Key System-specific value, if provided, and 0 otherwise
201             // 2.8.2. Set the MediaKeySession object's error attribute to the error object created in the previous step.
202             // 2.8.3. queue a task to fire a simple event named keyerror at the MediaKeySession object.
203             sendError(errorCode, systemCode);
204             // 2.8.4. Abort the task.
205             // NOTE: no-op
206         }
207     }
208 }
209
210 void MediaKeySession::sendMessage(Uint8Array* message, String destinationURL)
211 {
212     RefPtr<MediaKeyMessageEvent> event = MediaKeyMessageEvent::create(eventNames().webkitkeymessageEvent, message, destinationURL);
213     event->setTarget(this);
214     m_asyncEventQueue.enqueueEvent(event.release());
215 }
216
217 void MediaKeySession::sendError(CDMSessionClient::MediaKeyErrorCode errorCode, uint32_t systemCode)
218 {
219     Ref<MediaKeyError> error = MediaKeyError::create(errorCode, systemCode).get();
220     setError(error.ptr());
221
222     RefPtr<Event> keyerrorEvent = Event::create(eventNames().webkitkeyerrorEvent, false, false);
223     keyerrorEvent->setTarget(this);
224     m_asyncEventQueue.enqueueEvent(keyerrorEvent.release());
225 }
226
227 String MediaKeySession::mediaKeysStorageDirectory() const
228 {
229     Document* document = downcast<Document>(scriptExecutionContext());
230     if (!document)
231         return emptyString();
232
233     Settings* settings = document->settings();
234     if (!settings)
235         return emptyString();
236
237     String storageDirectory = settings->mediaKeysStorageDirectory();
238     if (storageDirectory.isEmpty())
239         return emptyString();
240
241     SecurityOrigin* origin = document->securityOrigin();
242     if (!origin)
243         return emptyString();
244
245     return pathByAppendingComponent(storageDirectory, origin->databaseIdentifier());
246 }
247
248 bool MediaKeySession::hasPendingActivity() const
249 {
250     return (m_keys && !isClosed()) || m_asyncEventQueue.hasPendingEvents();
251 }
252
253 void MediaKeySession::stop()
254 {
255     close();
256 }
257
258 const char* MediaKeySession::activeDOMObjectName() const
259 {
260     return "MediaKeySession";
261 }
262
263 bool MediaKeySession::canSuspendForDocumentSuspension() const
264 {
265     // FIXME: We should try and do better here.
266     return false;
267 }
268
269 }
270
271 #endif