blob: 77a52da6d5faad7330f7db1f08919309dac87ebe [file] [log] [blame]
/*
* 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 "Document.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 <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() = default;
SecurityOrigin* UserMediaRequest::userMediaDocumentOrigin() const
{
if (!m_scriptExecutionContext)
return nullptr;
return m_scriptExecutionContext->securityOrigin();
}
SecurityOrigin* UserMediaRequest::topLevelDocumentOrigin() const
{
if (!m_scriptExecutionContext)
return nullptr;
return &m_scriptExecutionContext->topOrigin();
}
static bool hasInvalidGetDisplayMediaConstraint(const MediaConstraints& constraints)
{
// https://w3c.github.io/mediacapture-screen-share/#navigator-additions
// 1. Let constraints be the method's first argument.
// 2. For each member present in constraints whose value, value, is a dictionary, run the following steps:
// 1. If value contains a member named advanced, return a promise rejected with a newly created TypeError.
// 2. If value contains a member which in turn is a dictionary containing a member named either min or
// exact, return a promise rejected with a newly created TypeError.
if (!constraints.isValid)
return false;
if (!constraints.advancedConstraints.isEmpty())
return true;
bool invalid = false;
constraints.mandatoryConstraints.filter([&invalid] (const MediaConstraint& constraint) mutable {
switch (constraint.constraintType()) {
case MediaConstraintType::Width:
case MediaConstraintType::Height: {
auto& intConstraint = downcast<IntConstraint>(constraint);
int value;
invalid = intConstraint.getExact(value) || intConstraint.getMin(value);
break;
}
case MediaConstraintType::AspectRatio:
case MediaConstraintType::FrameRate: {
auto& doubleConstraint = downcast<DoubleConstraint>(constraint);
double value;
invalid = doubleConstraint.getExact(value) || doubleConstraint.getMin(value);
break;
}
case MediaConstraintType::DisplaySurface:
case MediaConstraintType::LogicalSurface: {
auto& boolConstraint = downcast<BooleanConstraint>(constraint);
bool value;
invalid = boolConstraint.getExact(value);
break;
}
case MediaConstraintType::FacingMode:
case MediaConstraintType::DeviceId:
case MediaConstraintType::GroupId: {
auto& stringConstraint = downcast<StringConstraint>(constraint);
Vector<String> values;
invalid = stringConstraint.getExact(values);
break;
}
case MediaConstraintType::SampleRate:
case MediaConstraintType::SampleSize:
case MediaConstraintType::Volume:
case MediaConstraintType::EchoCancellation:
// Ignored.
break;
case MediaConstraintType::Unknown:
ASSERT_NOT_REACHED();
break;
}
return invalid;
});
return invalid;
}
void UserMediaRequest::start()
{
ASSERT(m_scriptExecutionContext);
if (!m_scriptExecutionContext) {
deny(MediaAccessDenialReason::UserMediaDisabled);
return;
}
if (m_request.type == MediaStreamRequest::Type::DisplayMedia) {
if (hasInvalidGetDisplayMediaConstraint(m_request.videoConstraints)) {
deny(MediaAccessDenialReason::IllegalConstraint);
return;
}
}
// https://w3c.github.io/mediacapture-main/getusermedia.html#dom-mediadevices-getusermedia()
// 1. Let constraints be the method's first argument.
// 2. Let requestedMediaTypes be the set of media types in constraints with either a dictionary
// value or a value of "true".
// 3. If requestedMediaTypes is the empty set, return a promise rejected with a TypeError. The word
// "optional" occurs in the WebIDL due to WebIDL rules, but the argument must be supplied in order
// for the call to succeed.
if (!m_request.audioConstraints.isValid && !m_request.videoConstraints.isValid) {
deny(MediaAccessDenialReason::NoConstraints);
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>(*m_scriptExecutionContext);
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.
OptionSet<UserMediaController::CaptureType> types;
UserMediaController::BlockedCaller caller;
if (m_request.type == MediaStreamRequest::Type::DisplayMedia) {
types.add(UserMediaController::CaptureType::Display);
caller = UserMediaController::BlockedCaller::GetDisplayMedia;
} else {
if (m_request.audioConstraints.isValid)
types.add(UserMediaController::CaptureType::Microphone);
if (m_request.videoConstraints.isValid)
types.add(UserMediaController::CaptureType::Camera);
caller = UserMediaController::BlockedCaller::GetUserMedia;
}
auto access = controller->canCallGetUserMedia(document, types);
if (access != UserMediaController::GetUserMediaAccess::CanCall) {
deny(MediaAccessDenialReason::PermissionDenied);
controller->logGetUserMediaDenial(document, access, caller);
return;
}
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() : "");
auto callback = [this, protector = makePendingActivity(*this), completionHandler = WTFMove(completionHandler)](RefPtr<MediaStreamPrivate>&& privateStream) mutable {
auto scopeExit = makeScopeExit([completionHandler = WTFMove(completionHandler)]() mutable {
completionHandler();
});
if (isContextStopped())
return;
if (!privateStream) {
RELEASE_LOG(MediaStream, "UserMediaRequest::allow failed to create media stream!");
deny(MediaAccessDenialReason::HardwareError);
return;
}
auto& document = downcast<Document>(*m_scriptExecutionContext);
privateStream->monitorOrientation(document.orientationNotifier());
auto stream = MediaStream::create(document, privateStream.releaseNonNull());
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());
document.setDeviceIDHashSalt(deviceIdentifierHashSalt);
RealtimeMediaSourceCenter::singleton().createMediaStream(document.logger(), WTFMove(callback), WTFMove(deviceIdentifierHashSalt), WTFMove(audioDevice), WTFMove(videoDevice), m_request);
if (!m_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 (!m_scriptExecutionContext)
return;
ExceptionCode code;
switch (reason) {
case MediaAccessDenialReason::IllegalConstraint:
RELEASE_LOG(MediaStream, "UserMediaRequest::deny - invalid constraints");
code = TypeError;
break;
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>(*m_scriptExecutionContext);
if (auto* controller = UserMediaController::from(document.page()))
controller->cancelUserMediaAccessRequest(*this);
}
const char* UserMediaRequest::activeDOMObjectName() const
{
return "UserMediaRequest";
}
bool UserMediaRequest::canSuspendForDocumentSuspension() const
{
return !hasPendingActivity();
}
Document* UserMediaRequest::document() const
{
return downcast<Document>(m_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)