Daisuke Akatsuka
31e276101e
Add a `getDataIfSmallerThan()` API to `nsIClipboard`. This API allows data to be retrieved only if the size of clipboard's contents is smaller than the specified threshold. The parameters are `aTransferable`, `aWhichClipboard` and `aRequestingWindowContext`, similar to [nsIClipboard.getData()](https://searchfox.org/firefox-main/rev/7709f0a26aeb3c39a5fd86e794425530f0d0b528/widget/nsIClipboard.idl#165-181). In addition, it takes `aThreshold`, which defines the threshold value. (Currently, it only targets plain/text content and checks its character count.) The reason I want to add this is for use in the urlbar and places modules. For example, we currently want to change the context menu items based on the clipboard's content. However, when the content is very large, it takes a significant amount of time to retrieve and parse it. [1] Additionally, while there is a feature to suggest URLs when the clipboard contains a URL[2], we cannot enable this feature by default due to the same reason. To resolve them, adds the above API, we want to make very large content ignorable. [1] https://bugzilla.mozilla.org/show_bug.cgi?id=1874203 [2] https://bugzilla.mozilla.org/show_bug.cgi?id=1842230 Differential Revision: https://phabricator.services.mozilla.com/D280552
323 lines
13 KiB
C++
323 lines
13 KiB
C++
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "ContentAnalysis.h"
|
|
#include "mozilla/ClipboardContentAnalysisParent.h"
|
|
#include "mozilla/ClipboardReadRequestParent.h"
|
|
#include "mozilla/dom/ContentParent.h"
|
|
#include "mozilla/dom/WindowContext.h"
|
|
#include "mozilla/dom/WindowGlobalParent.h"
|
|
#include "mozilla/MozPromise.h"
|
|
#include "nsBaseClipboard.h"
|
|
#include "nsIClipboard.h"
|
|
#include "nsID.h"
|
|
#include "nsITransferable.h"
|
|
|
|
namespace mozilla {
|
|
namespace {
|
|
using ClipboardResultPromise =
|
|
MozPromise<dom::IPCTransferableData, nsresult, true>;
|
|
|
|
static RefPtr<ClipboardResultPromise> GetClipboardImpl(
|
|
const nsTArray<nsCString>& aTypes,
|
|
nsIClipboard::ClipboardType aWhichClipboard,
|
|
uint64_t aRequestingWindowContextId, bool aCheckAllContent,
|
|
dom::ThreadsafeContentParentHandle* aRequestingContentParent) {
|
|
AssertIsOnMainThread();
|
|
|
|
RefPtr<dom::WindowGlobalParent> window =
|
|
dom::WindowGlobalParent::GetByInnerWindowId(aRequestingWindowContextId);
|
|
|
|
// We expect content processes to always pass a non-null window so
|
|
// Content Analysis can analyze it. (if Content Analysis is
|
|
// active) There may be some cases when a window is closing, etc.,
|
|
// in which case returning no clipboard content should not be a
|
|
// problem.
|
|
if (!window) {
|
|
return ClipboardResultPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
|
|
}
|
|
|
|
if (window->IsDiscarded()) {
|
|
NS_WARNING(
|
|
"discarded window passed to RecvGetClipboard(); returning "
|
|
"no clipboard "
|
|
"content");
|
|
return ClipboardResultPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
|
|
}
|
|
|
|
if (aRequestingContentParent->ChildID() != window->ContentParentId()) {
|
|
NS_WARNING("incorrect content process passing window to GetClipboard");
|
|
return ClipboardResultPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
|
|
}
|
|
|
|
// Retrieve clipboard
|
|
nsCOMPtr<nsIClipboard> clipboard =
|
|
do_GetService("@mozilla.org/widget/clipboard;1");
|
|
if (!clipboard) {
|
|
return ClipboardResultPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
|
|
}
|
|
|
|
auto transferableToCheck =
|
|
dom::ContentParent::CreateClipboardTransferable(aTypes);
|
|
if (transferableToCheck.isErr()) {
|
|
return ClipboardResultPromise::CreateAndReject(
|
|
transferableToCheck.unwrapErr(), __func__);
|
|
}
|
|
nsCOMPtr<nsITransferable> transferable = transferableToCheck.unwrap();
|
|
if (aCheckAllContent) {
|
|
for (const auto& type : aTypes) {
|
|
AutoTArray<nsCString, 1> singleTypeArray{type};
|
|
auto singleTransferableToCheck =
|
|
dom::ContentParent::CreateClipboardTransferable(singleTypeArray);
|
|
if (singleTransferableToCheck.isErr()) {
|
|
return ClipboardResultPromise::CreateAndReject(
|
|
singleTransferableToCheck.unwrapErr(), __func__);
|
|
}
|
|
|
|
// Pass nullptr for the window here because we will be doing
|
|
// content analysis ourselves asynchronously (so it doesn't block
|
|
// main thread we're running on now)
|
|
nsCOMPtr singleTransferable = singleTransferableToCheck.unwrap();
|
|
// Ideally we would be calling GetDataSnapshot() here to avoid blocking
|
|
// the main thread (and this would mean we could also pass in the window
|
|
// here so we wouldn't have to duplicate the Content Analysis code below).
|
|
// See bug 1908280.
|
|
nsresult rv =
|
|
clipboard->GetData(singleTransferable, aWhichClipboard, nullptr);
|
|
if (NS_FAILED(rv)) {
|
|
return ClipboardResultPromise::CreateAndReject(rv, __func__);
|
|
}
|
|
nsCOMPtr<nsISupports> data;
|
|
rv =
|
|
singleTransferable->GetTransferData(type.get(), getter_AddRefs(data));
|
|
// This call will fail if the data is null
|
|
if (NS_SUCCEEDED(rv)) {
|
|
rv = transferable->SetTransferData(type.get(), data);
|
|
if (NS_FAILED(rv)) {
|
|
return ClipboardResultPromise::CreateAndReject(rv, __func__);
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
// Pass nullptr for the window here because we will be doing
|
|
// content analysis ourselves asynchronously (so it doesn't block
|
|
// main thread we're running on now)
|
|
//
|
|
// Ideally we would be calling GetDataSnapshot() here to avoid blocking the
|
|
// main thread (and this would mean we could also pass in the window here so
|
|
// we wouldn't have to duplicate the Content Analysis code below). See
|
|
// bug 1908280.
|
|
nsresult rv = clipboard->GetData(transferable, aWhichClipboard, nullptr);
|
|
if (NS_FAILED(rv)) {
|
|
return ClipboardResultPromise::CreateAndReject(rv, __func__);
|
|
}
|
|
}
|
|
auto resultPromise = MakeRefPtr<ClipboardResultPromise::Private>(__func__);
|
|
|
|
auto contentAnalysisCallback =
|
|
mozilla::MakeRefPtr<mozilla::contentanalysis::ContentAnalysisCallback>(
|
|
[transferable, resultPromise,
|
|
cpHandle = RefPtr{aRequestingContentParent}](
|
|
nsIContentAnalysisResult* aResult) {
|
|
// Needed to call cpHandle->GetContentParent()
|
|
AssertIsOnMainThread();
|
|
|
|
if (!aResult->GetShouldAllowContent()) {
|
|
resultPromise->Reject(NS_ERROR_CONTENT_BLOCKED, __func__);
|
|
return;
|
|
}
|
|
dom::IPCTransferableData transferableData;
|
|
RefPtr<dom::ContentParent> contentParent =
|
|
cpHandle->GetContentParent();
|
|
nsContentUtils::TransferableToIPCTransferableData(
|
|
transferable, &transferableData, true /* aInSyncMessage */,
|
|
contentParent);
|
|
resultPromise->Resolve(std::move(transferableData), __func__);
|
|
});
|
|
|
|
contentanalysis::ContentAnalysis::CheckClipboardContentAnalysis(
|
|
static_cast<nsBaseClipboard*>(clipboard.get()), window, transferable,
|
|
aWhichClipboard, contentAnalysisCallback, aCheckAllContent);
|
|
return resultPromise;
|
|
}
|
|
|
|
static RefPtr<ClipboardResultPromise> GetClipboardDataIfSmallerThanImpl(
|
|
const nsTArray<nsCString>& aTypes, uint64_t aThreshold,
|
|
const nsIClipboard::ClipboardType aWhichClipboard,
|
|
const uint64_t aRequestingWindowContextId,
|
|
dom::ThreadsafeContentParentHandle* aRequestingContentParent) {
|
|
AssertIsOnMainThread();
|
|
|
|
RefPtr<dom::WindowGlobalParent> window =
|
|
dom::WindowGlobalParent::GetByInnerWindowId(aRequestingWindowContextId);
|
|
if (!window) {
|
|
return ClipboardResultPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
|
|
}
|
|
if (window->IsDiscarded()) {
|
|
NS_WARNING(
|
|
"discarded window passed to RecvGetClipboardIfSmallerThan(); returning "
|
|
"no clipboard "
|
|
"content");
|
|
return ClipboardResultPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
|
|
}
|
|
if (aRequestingContentParent->ChildID() != window->ContentParentId()) {
|
|
NS_WARNING(
|
|
"incorrect content process passing window to "
|
|
"GetClipboardIfSmallerThan");
|
|
return ClipboardResultPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
|
|
}
|
|
|
|
nsCOMPtr<nsIClipboard> clipboard =
|
|
do_GetService("@mozilla.org/widget/clipboard;1");
|
|
if (!clipboard) {
|
|
return ClipboardResultPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
|
|
}
|
|
|
|
auto transferableToCheck =
|
|
dom::ContentParent::CreateClipboardTransferable(aTypes);
|
|
if (transferableToCheck.isErr()) {
|
|
return ClipboardResultPromise::CreateAndReject(
|
|
transferableToCheck.unwrapErr(), __func__);
|
|
}
|
|
nsCOMPtr<nsITransferable> transferable = transferableToCheck.unwrap();
|
|
|
|
nsresult rv = clipboard->GetDataIfSmallerThanNative(transferable, aThreshold,
|
|
aWhichClipboard, window);
|
|
if (NS_FAILED(rv)) {
|
|
return ClipboardResultPromise::CreateAndReject(rv, __func__);
|
|
}
|
|
|
|
dom::IPCTransferableData ipcData;
|
|
auto cpHandle = RefPtr{aRequestingContentParent};
|
|
RefPtr<dom::ContentParent> contentParent = cpHandle->GetContentParent();
|
|
nsContentUtils::TransferableToIPCTransferableData(
|
|
transferable, &ipcData, true /* aInSyncMessage */, contentParent);
|
|
return ClipboardResultPromise::CreateAndResolve(std::move(ipcData), __func__);
|
|
}
|
|
} // namespace
|
|
|
|
ipc::IPCResult ClipboardContentAnalysisParent::GetSomeClipboardData(
|
|
nsTArray<nsCString>&& aTypes,
|
|
const nsIClipboard::ClipboardType& aWhichClipboard,
|
|
const uint64_t& aRequestingWindowContextId, bool aCheckAllContent,
|
|
IPCTransferableDataOrError* aTransferableDataOrError) {
|
|
Monitor mon("ClipboardContentAnalysisParent::GetSomeClipboardData");
|
|
InvokeAsync(GetMainThreadSerialEventTarget(), __func__,
|
|
[&]() {
|
|
return GetClipboardImpl(
|
|
aTypes, aWhichClipboard, aRequestingWindowContextId,
|
|
aCheckAllContent, mThreadsafeContentParentHandle);
|
|
})
|
|
->Then(GetMainThreadSerialEventTarget(), __func__,
|
|
[&](ClipboardResultPromise::ResolveOrRejectValue&& aResult) {
|
|
// Acquire the lock, pass the data back to the background
|
|
// thread, and notify the background thread that work is
|
|
// complete.
|
|
MonitorAutoLock lock(mon);
|
|
auto monitor = MakeScopeExit([&]() { mon.Notify(); });
|
|
if (aResult.IsReject()) {
|
|
*aTransferableDataOrError = aResult.RejectValue();
|
|
return;
|
|
}
|
|
|
|
if (aCheckAllContent) {
|
|
// Content Analysis succeeded on everything
|
|
// Just return the flavors that were asked for
|
|
IPCTransferableData analyzedData =
|
|
std::move(aResult.ResolveValue());
|
|
nsTArray<IPCTransferableDataItem> dataItems;
|
|
for (auto& item : analyzedData.items()) {
|
|
if (aTypes.Contains(item.flavor())) {
|
|
dataItems.AppendElement(std::move(item));
|
|
}
|
|
}
|
|
IPCTransferableData data(std::move(dataItems));
|
|
*aTransferableDataOrError = std::move(data);
|
|
} else {
|
|
*aTransferableDataOrError = std::move(aResult.ResolveValue());
|
|
}
|
|
});
|
|
|
|
{
|
|
MonitorAutoLock lock(mon);
|
|
while (aTransferableDataOrError->type() ==
|
|
IPCTransferableDataOrError::T__None) {
|
|
mon.Wait();
|
|
}
|
|
}
|
|
|
|
if (aTransferableDataOrError->type() ==
|
|
IPCTransferableDataOrError::Tnsresult) {
|
|
nsresult rv = aTransferableDataOrError->get_nsresult();
|
|
// don't show a warning if the content was just blocked
|
|
if (rv != NS_ERROR_CONTENT_BLOCKED) {
|
|
NS_WARNING(nsPrintfCString("ClipboardContentAnalysisParent::"
|
|
"GetSomeClipboardData got error %x",
|
|
static_cast<int>(rv))
|
|
.get());
|
|
}
|
|
}
|
|
|
|
return IPC_OK();
|
|
}
|
|
|
|
ipc::IPCResult ClipboardContentAnalysisParent::RecvGetClipboard(
|
|
nsTArray<nsCString>&& aTypes,
|
|
const nsIClipboard::ClipboardType& aWhichClipboard,
|
|
const uint64_t& aRequestingWindowContextId,
|
|
IPCTransferableDataOrError* aTransferableDataOrError) {
|
|
// The whole point of having this actor is that it runs on a background thread
|
|
// and so waiting for the content analysis result won't cause the main thread
|
|
// to use SpinEventLoopUntil() which can cause a shutdownhang per bug 1901197.
|
|
MOZ_ASSERT(!NS_IsMainThread());
|
|
|
|
return GetSomeClipboardData(
|
|
std::move(aTypes), aWhichClipboard, aRequestingWindowContextId,
|
|
/* aCheckAllContent */ false, aTransferableDataOrError);
|
|
}
|
|
|
|
ipc::IPCResult ClipboardContentAnalysisParent::RecvGetAllClipboardDataSync(
|
|
nsTArray<nsCString>&& aTypes,
|
|
const nsIClipboard::ClipboardType& aWhichClipboard,
|
|
const uint64_t& aRequestingWindowContextId,
|
|
IPCTransferableDataOrError* aTransferableDataOrError) {
|
|
MOZ_ASSERT(!NS_IsMainThread());
|
|
|
|
return GetSomeClipboardData(
|
|
std::move(aTypes), aWhichClipboard, aRequestingWindowContextId,
|
|
/* aCheckAllContent */ true, aTransferableDataOrError);
|
|
}
|
|
|
|
ipc::IPCResult
|
|
ClipboardContentAnalysisParent::RecvGetClipboardDataIfSmallerThan(
|
|
nsTArray<nsCString>&& aTypes, uint64_t aThreshold,
|
|
const nsIClipboard::ClipboardType& aWhichClipboard,
|
|
const uint64_t& aRequestingWindowContextId,
|
|
GetClipboardDataIfSmallerThanResolver&& aResolver) {
|
|
MOZ_ASSERT(!NS_IsMainThread());
|
|
|
|
auto types = std::move(aTypes);
|
|
auto resolver = std::move(aResolver);
|
|
|
|
InvokeAsync(GetMainThreadSerialEventTarget(), __func__,
|
|
[types = std::move(types), threshold = aThreshold,
|
|
whichClipboard = aWhichClipboard,
|
|
windowContextId = aRequestingWindowContextId,
|
|
handle = mThreadsafeContentParentHandle]() {
|
|
return GetClipboardDataIfSmallerThanImpl(
|
|
types, threshold, whichClipboard, windowContextId, handle);
|
|
})
|
|
->Then(GetCurrentSerialEventTarget(), __func__,
|
|
[resolver = std::move(resolver)](
|
|
ClipboardResultPromise::ResolveOrRejectValue&& aResult) {
|
|
if (aResult.IsReject()) {
|
|
resolver(aResult.RejectValue());
|
|
return;
|
|
}
|
|
resolver(std::move(aResult.ResolveValue()));
|
|
});
|
|
return IPC_OK();
|
|
}
|
|
} // namespace mozilla
|