Source/WebCore/Modules/mediastream/UserMediaRequest.cpp - WebKit - Git at Google

 /*
  * Copyright (C) 2011 Ericsson AB. All rights reserved.
  * Copyright (C) 2012 Google Inc. All rights reserved.
  * Copyright (C) 2013-2018 Apple Inc. All rights reserved.
  * Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer
  *    in the documentation and/or other materials provided with the
  *    distribution.
  * 3. Neither the name of Ericsson nor the names of its contributors
  *    may be used to endorse or promote products derived from this
  *    software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */

 #include "config.h"
 #include "UserMediaRequest.h"

 #if ENABLE(MEDIA_STREAM)

 #include "DocumentInlines.h"
 #include "Frame.h"
 #include "JSDOMPromiseDeferred.h"
 #include "JSMediaStream.h"
 #include "JSOverconstrainedError.h"
 #include "Logging.h"
 #include "MediaConstraints.h"
 #include "PlatformMediaSessionManager.h"
 #include "RealtimeMediaSourceCenter.h"
 #include "Settings.h"
 #include "UserMediaController.h"
 #include "WindowEventLoop.h"
 #include <wtf/Scope.h>

 namespace WebCore {

 Ref<UserMediaRequest> UserMediaRequest::create(Document& document, MediaStreamRequest&& request, DOMPromiseDeferred<IDLInterface<MediaStream>>&& promise)
 {
     auto result = adoptRef(*new UserMediaRequest(document, WTFMove(request), WTFMove(promise)));
     result->suspendIfNeeded();
     return result;
 }

 UserMediaRequest::UserMediaRequest(Document& document, MediaStreamRequest&& request, DOMPromiseDeferred<IDLInterface<MediaStream>>&& promise)
     : ActiveDOMObject(document)
     , m_identifier(UserMediaRequestIdentifier::generate())
     , m_promise(makeUniqueRef<DOMPromiseDeferred<IDLInterface<MediaStream>>>(WTFMove(promise)))
     , m_request(WTFMove(request))
 {
 }

 UserMediaRequest::~UserMediaRequest()
 {
     if (m_allowCompletionHandler)
         m_allowCompletionHandler();
 }

 SecurityOrigin* UserMediaRequest::userMediaDocumentOrigin() const
 {
     auto* context = scriptExecutionContext();
     return context ? context->securityOrigin() : nullptr;
 }

 SecurityOrigin* UserMediaRequest::topLevelDocumentOrigin() const
 {
     auto* context = scriptExecutionContext();
     return context ? &context->topOrigin() : nullptr;
 }

 void UserMediaRequest::start()
 {
     auto* context = scriptExecutionContext();
     ASSERT(context);
     if (!context) {
         deny(MediaAccessDenialReason::UserMediaDisabled);
         return;
     }

     // 4. If the current settings object's responsible document is NOT allowed to use the feature indicated by
     //    attribute name allowusermedia, return a promise rejected with a DOMException object whose name
     //    attribute has the value SecurityError.
     auto& document = downcast<Document>(*context);
     auto* controller = UserMediaController::from(document.page());
     if (!controller) {
         deny(MediaAccessDenialReason::UserMediaDisabled);
         return;
     }

     // 6.3 Optionally, e.g., based on a previously-established user preference, for security reasons,
     //     or due to platform limitations, jump to the step labeled Permission Failure below.
     // ...
     // 6.10 Permission Failure: Reject p with a new DOMException object whose name attribute has
     //      the value NotAllowedError.

     switch (m_request.type) {
     case MediaStreamRequest::Type::DisplayMedia:
     case MediaStreamRequest::Type::DisplayMediaWithAudio:
         if (!isFeaturePolicyAllowedByDocumentAndAllOwners(FeaturePolicy::Type::DisplayCapture, document)) {
             deny(MediaAccessDenialReason::PermissionDenied);
             controller->logGetDisplayMediaDenial(document);
             return;
         }
         break;
     case MediaStreamRequest::Type::UserMedia:
         if (m_request.audioConstraints.isValid && !isFeaturePolicyAllowedByDocumentAndAllOwners(FeaturePolicy::Type::Microphone, document)) {
             deny(MediaAccessDenialReason::PermissionDenied);
             controller->logGetUserMediaDenial(document);
             return;
         }
         if (m_request.videoConstraints.isValid && !isFeaturePolicyAllowedByDocumentAndAllOwners(FeaturePolicy::Type::Camera, document)) {
             deny(MediaAccessDenialReason::PermissionDenied);
             controller->logGetUserMediaDenial(document);
             return;
         }
         break;
     }

     PlatformMediaSessionManager::sharedManager().prepareToSendUserMediaPermissionRequest();
     controller->requestUserMediaAccess(*this);
 }

 static inline bool isMediaStreamCorrectlyStarted(const MediaStream& stream)
 {
     if (stream.getTracks().isEmpty())
         return false;

     return WTF::allOf(stream.getTracks(), [](auto& track) {
         return !track->source().captureDidFail();
     });
 }

 void UserMediaRequest::allow(CaptureDevice&& audioDevice, CaptureDevice&& videoDevice, String&& deviceIdentifierHashSalt, CompletionHandler<void()>&& completionHandler)
 {
     RELEASE_LOG(MediaStream, "UserMediaRequest::allow %s %s", audioDevice ? audioDevice.persistentId().utf8().data() : "", videoDevice ? videoDevice.persistentId().utf8().data() : "");
     m_allowCompletionHandler = WTFMove(completionHandler);
     queueTaskKeepingObjectAlive(*this, TaskSource::UserInteraction, [this, audioDevice = WTFMove(audioDevice), videoDevice = WTFMove(videoDevice), deviceIdentifierHashSalt = WTFMove(deviceIdentifierHashSalt)]() mutable {
         auto callback = [this, protector = makePendingActivity(*this)](auto privateStreamOrError) mutable {
             auto scopeExit = makeScopeExit([completionHandler = WTFMove(m_allowCompletionHandler)]() mutable {
                 completionHandler();
             });
             if (isContextStopped())
                 return;

             if (!privateStreamOrError.has_value()) {
                 RELEASE_LOG(MediaStream, "UserMediaRequest::allow failed to create media stream!");
                 scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, privateStreamOrError.error());
                 deny(MediaAccessDenialReason::HardwareError);
                 return;
             }
             auto privateStream = WTFMove(privateStreamOrError).value();

             auto& document = downcast<Document>(*scriptExecutionContext());
             privateStream->monitorOrientation(document.orientationNotifier());

             auto stream = MediaStream::create(document, WTFMove(privateStream));
             stream->startProducingData();

             if (!isMediaStreamCorrectlyStarted(stream)) {
                 deny(MediaAccessDenialReason::HardwareError);
                 return;
             }

             ASSERT(document.isCapturing());
             stream->document()->setHasCaptureMediaStreamTrack();
             m_promise->resolve(WTFMove(stream));
         };

         auto& document = downcast<Document>(*scriptExecutionContext());
         RealtimeMediaSourceCenter::singleton().createMediaStream(document.logger(), WTFMove(callback), WTFMove(deviceIdentifierHashSalt), WTFMove(audioDevice), WTFMove(videoDevice), m_request);

         if (!scriptExecutionContext())
             return;

 #if ENABLE(WEB_RTC)
         if (auto* page = document.page())
             page->rtcController().disableICECandidateFilteringForDocument(document);
 #endif
     });
 }

 void UserMediaRequest::deny(MediaAccessDenialReason reason, const String& message)
 {
     if (!scriptExecutionContext())
         return;

     ExceptionCode code;
     switch (reason) {
     case MediaAccessDenialReason::NoConstraints:
         RELEASE_LOG(MediaStream, "UserMediaRequest::deny - no constraints");
         code = TypeError;
         break;
     case MediaAccessDenialReason::UserMediaDisabled:
         RELEASE_LOG(MediaStream, "UserMediaRequest::deny - user media disabled");
         code = SecurityError;
         break;
     case MediaAccessDenialReason::NoCaptureDevices:
         RELEASE_LOG(MediaStream, "UserMediaRequest::deny - no capture devices");
         code = NotFoundError;
         break;
     case MediaAccessDenialReason::InvalidConstraint:
         RELEASE_LOG(MediaStream, "UserMediaRequest::deny - invalid constraint - %s", message.utf8().data());
         m_promise->rejectType<IDLInterface<OverconstrainedError>>(OverconstrainedError::create(message, "Invalid constraint"_s).get());
         return;
     case MediaAccessDenialReason::HardwareError:
         RELEASE_LOG(MediaStream, "UserMediaRequest::deny - hardware error");
         code = NotReadableError;
         break;
     case MediaAccessDenialReason::OtherFailure:
         RELEASE_LOG(MediaStream, "UserMediaRequest::deny - other failure");
         code = AbortError;
         break;
     case MediaAccessDenialReason::PermissionDenied:
         RELEASE_LOG(MediaStream, "UserMediaRequest::deny - permission denied");
         code = NotAllowedError;
         break;
     case MediaAccessDenialReason::InvalidAccess:
         RELEASE_LOG(MediaStream, "UserMediaRequest::deny - invalid access");
         code = InvalidAccessError;
         break;
     }

     if (!message.isEmpty())
         m_promise->reject(code, message);
     else
         m_promise->reject(code);
 }

 void UserMediaRequest::stop()
 {
     auto& document = downcast<Document>(*scriptExecutionContext());
     if (auto* controller = UserMediaController::from(document.page()))
         controller->cancelUserMediaAccessRequest(*this);
 }

 const char* UserMediaRequest::activeDOMObjectName() const
 {
     return "UserMediaRequest";
 }

 Document* UserMediaRequest::document() const
 {
     return downcast<Document>(scriptExecutionContext());
 }

 void UserMediaRequest::mediaStreamDidFail(RealtimeMediaSource::Type type)
 {
     RELEASE_LOG(MediaStream, "UserMediaRequest::mediaStreamDidFail");
     const char* typeDescription = "";
     switch (type) {
     case RealtimeMediaSource::Type::Audio:
         typeDescription = "audio";
         break;
     case RealtimeMediaSource::Type::Video:
         typeDescription = "video";
         break;
     case RealtimeMediaSource::Type::None:
         typeDescription = "unknown";
         break;
     }
     m_promise->reject(NotReadableError, makeString("Failed starting capture of a "_s, typeDescription, " track"_s));
 }

 } // namespace WebCore

 #endif // ENABLE(MEDIA_STREAM)
	/*
	* Copyright (C) 2011 Ericsson AB. All rights reserved.
	* Copyright (C) 2012 Google Inc. All rights reserved.
	* Copyright (C) 2013-2018 Apple Inc. All rights reserved.
	* Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer
	* in the documentation and/or other materials provided with the
	* distribution.
	* 3. Neither the name of Ericsson nor the names of its contributors
	* may be used to endorse or promote products derived from this
	* software without specific prior written permission.
	*
	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#include "config.h"
	#include "UserMediaRequest.h"

	#if ENABLE(MEDIA_STREAM)

	#include "DocumentInlines.h"
	#include "Frame.h"
	#include "JSDOMPromiseDeferred.h"
	#include "JSMediaStream.h"
	#include "JSOverconstrainedError.h"
	#include "Logging.h"
	#include "MediaConstraints.h"
	#include "PlatformMediaSessionManager.h"
	#include "RealtimeMediaSourceCenter.h"
	#include "Settings.h"
	#include "UserMediaController.h"
	#include "WindowEventLoop.h"
	#include <wtf/Scope.h>

	namespace WebCore {

	Ref<UserMediaRequest> UserMediaRequest::create(Document& document, MediaStreamRequest&& request, DOMPromiseDeferred<IDLInterface<MediaStream>>&& promise)
	{
	auto result = adoptRef(*new UserMediaRequest(document, WTFMove(request), WTFMove(promise)));
	result->suspendIfNeeded();
	return result;
	}

	UserMediaRequest::UserMediaRequest(Document& document, MediaStreamRequest&& request, DOMPromiseDeferred<IDLInterface<MediaStream>>&& promise)
	: ActiveDOMObject(document)
	, m_identifier(UserMediaRequestIdentifier::generate())
	, m_promise(makeUniqueRef<DOMPromiseDeferred<IDLInterface<MediaStream>>>(WTFMove(promise)))
	, m_request(WTFMove(request))
	{
	}

	UserMediaRequest::~UserMediaRequest()
	{
	if (m_allowCompletionHandler)
	m_allowCompletionHandler();
	}

	SecurityOrigin* UserMediaRequest::userMediaDocumentOrigin() const
	{
	auto* context = scriptExecutionContext();
	return context ? context->securityOrigin() : nullptr;
	}

	SecurityOrigin* UserMediaRequest::topLevelDocumentOrigin() const
	{
	auto* context = scriptExecutionContext();
	return context ? &context->topOrigin() : nullptr;
	}

	void UserMediaRequest::start()
	{
	auto* context = scriptExecutionContext();
	ASSERT(context);
	if (!context) {
	deny(MediaAccessDenialReason::UserMediaDisabled);
	return;
	}

	// 4. If the current settings object's responsible document is NOT allowed to use the feature indicated by
	// attribute name allowusermedia, return a promise rejected with a DOMException object whose name
	// attribute has the value SecurityError.
	auto& document = downcast<Document>(*context);
	auto* controller = UserMediaController::from(document.page());
	if (!controller) {
	deny(MediaAccessDenialReason::UserMediaDisabled);
	return;
	}

	// 6.3 Optionally, e.g., based on a previously-established user preference, for security reasons,
	// or due to platform limitations, jump to the step labeled Permission Failure below.
	// ...
	// 6.10 Permission Failure: Reject p with a new DOMException object whose name attribute has
	// the value NotAllowedError.

	switch (m_request.type) {
	case MediaStreamRequest::Type::DisplayMedia:
	case MediaStreamRequest::Type::DisplayMediaWithAudio:
	if (!isFeaturePolicyAllowedByDocumentAndAllOwners(FeaturePolicy::Type::DisplayCapture, document)) {
	deny(MediaAccessDenialReason::PermissionDenied);
	controller->logGetDisplayMediaDenial(document);
	return;
	}
	break;
	case MediaStreamRequest::Type::UserMedia:
	if (m_request.audioConstraints.isValid && !isFeaturePolicyAllowedByDocumentAndAllOwners(FeaturePolicy::Type::Microphone, document)) {
	deny(MediaAccessDenialReason::PermissionDenied);
	controller->logGetUserMediaDenial(document);
	return;
	}
	if (m_request.videoConstraints.isValid && !isFeaturePolicyAllowedByDocumentAndAllOwners(FeaturePolicy::Type::Camera, document)) {
	deny(MediaAccessDenialReason::PermissionDenied);
	controller->logGetUserMediaDenial(document);
	return;
	}
	break;
	}

	PlatformMediaSessionManager::sharedManager().prepareToSendUserMediaPermissionRequest();
	controller->requestUserMediaAccess(*this);
	}

	static inline bool isMediaStreamCorrectlyStarted(const MediaStream& stream)
	{
	if (stream.getTracks().isEmpty())
	return false;

	return WTF::allOf(stream.getTracks(), [](auto& track) {
	return !track->source().captureDidFail();
	});
	}

	void UserMediaRequest::allow(CaptureDevice&& audioDevice, CaptureDevice&& videoDevice, String&& deviceIdentifierHashSalt, CompletionHandler<void()>&& completionHandler)
	{
	RELEASE_LOG(MediaStream, "UserMediaRequest::allow %s %s", audioDevice ? audioDevice.persistentId().utf8().data() : "", videoDevice ? videoDevice.persistentId().utf8().data() : "");
	m_allowCompletionHandler = WTFMove(completionHandler);
	queueTaskKeepingObjectAlive(*this, TaskSource::UserInteraction, [this, audioDevice = WTFMove(audioDevice), videoDevice = WTFMove(videoDevice), deviceIdentifierHashSalt = WTFMove(deviceIdentifierHashSalt)]() mutable {
	auto callback = [this, protector = makePendingActivity(*this)](auto privateStreamOrError) mutable {
	auto scopeExit = makeScopeExit([completionHandler = WTFMove(m_allowCompletionHandler)]() mutable {
	completionHandler();
	});
	if (isContextStopped())
	return;

	if (!privateStreamOrError.has_value()) {
	RELEASE_LOG(MediaStream, "UserMediaRequest::allow failed to create media stream!");
	scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, privateStreamOrError.error());
	deny(MediaAccessDenialReason::HardwareError);
	return;
	}
	auto privateStream = WTFMove(privateStreamOrError).value();

	auto& document = downcast<Document>(*scriptExecutionContext());
	privateStream->monitorOrientation(document.orientationNotifier());

	auto stream = MediaStream::create(document, WTFMove(privateStream));
	stream->startProducingData();

	if (!isMediaStreamCorrectlyStarted(stream)) {
	deny(MediaAccessDenialReason::HardwareError);
	return;
	}

	ASSERT(document.isCapturing());
	stream->document()->setHasCaptureMediaStreamTrack();
	m_promise->resolve(WTFMove(stream));
	};

	auto& document = downcast<Document>(*scriptExecutionContext());
	RealtimeMediaSourceCenter::singleton().createMediaStream(document.logger(), WTFMove(callback), WTFMove(deviceIdentifierHashSalt), WTFMove(audioDevice), WTFMove(videoDevice), m_request);

	if (!scriptExecutionContext())
	return;

	#if ENABLE(WEB_RTC)
	if (auto* page = document.page())
	page->rtcController().disableICECandidateFilteringForDocument(document);
	#endif
	});
	}

	void UserMediaRequest::deny(MediaAccessDenialReason reason, const String& message)
	{
	if (!scriptExecutionContext())
	return;

	ExceptionCode code;
	switch (reason) {
	case MediaAccessDenialReason::NoConstraints:
	RELEASE_LOG(MediaStream, "UserMediaRequest::deny - no constraints");
	code = TypeError;
	break;
	case MediaAccessDenialReason::UserMediaDisabled:
	RELEASE_LOG(MediaStream, "UserMediaRequest::deny - user media disabled");
	code = SecurityError;
	break;
	case MediaAccessDenialReason::NoCaptureDevices:
	RELEASE_LOG(MediaStream, "UserMediaRequest::deny - no capture devices");
	code = NotFoundError;
	break;
	case MediaAccessDenialReason::InvalidConstraint:
	RELEASE_LOG(MediaStream, "UserMediaRequest::deny - invalid constraint - %s", message.utf8().data());
	m_promise->rejectType<IDLInterface<OverconstrainedError>>(OverconstrainedError::create(message, "Invalid constraint"_s).get());
	return;
	case MediaAccessDenialReason::HardwareError:
	RELEASE_LOG(MediaStream, "UserMediaRequest::deny - hardware error");
	code = NotReadableError;
	break;
	case MediaAccessDenialReason::OtherFailure:
	RELEASE_LOG(MediaStream, "UserMediaRequest::deny - other failure");
	code = AbortError;
	break;
	case MediaAccessDenialReason::PermissionDenied:
	RELEASE_LOG(MediaStream, "UserMediaRequest::deny - permission denied");
	code = NotAllowedError;
	break;
	case MediaAccessDenialReason::InvalidAccess:
	RELEASE_LOG(MediaStream, "UserMediaRequest::deny - invalid access");
	code = InvalidAccessError;
	break;
	}

	if (!message.isEmpty())
	m_promise->reject(code, message);
	else
	m_promise->reject(code);
	}

	void UserMediaRequest::stop()
	{
	auto& document = downcast<Document>(*scriptExecutionContext());
	if (auto* controller = UserMediaController::from(document.page()))
	controller->cancelUserMediaAccessRequest(*this);
	}

	const char* UserMediaRequest::activeDOMObjectName() const
	{
	return "UserMediaRequest";
	}

	Document* UserMediaRequest::document() const
	{
	return downcast<Document>(scriptExecutionContext());
	}

	void UserMediaRequest::mediaStreamDidFail(RealtimeMediaSource::Type type)
	{
	RELEASE_LOG(MediaStream, "UserMediaRequest::mediaStreamDidFail");
	const char* typeDescription = "";
	switch (type) {
	case RealtimeMediaSource::Type::Audio:
	typeDescription = "audio";
	break;
	case RealtimeMediaSource::Type::Video:
	typeDescription = "video";
	break;
	case RealtimeMediaSource::Type::None:
	typeDescription = "unknown";
	break;
	}
	m_promise->reject(NotReadableError, makeString("Failed starting capture of a "_s, typeDescription, " track"_s));
	}

	} // namespace WebCore

	#endif // ENABLE(MEDIA_STREAM)