зеркало из https://github.com/mozilla/gecko-dev.git
134 строки
4.4 KiB
C++
134 строки
4.4 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* 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/. */
|
|
|
|
#ifndef mozilla_dom_Clipboard_h_
|
|
#define mozilla_dom_Clipboard_h_
|
|
|
|
#include "nsString.h"
|
|
#include "nsStringFwd.h"
|
|
#include "mozilla/DOMEventTargetHelper.h"
|
|
#include "mozilla/Logging.h"
|
|
#include "mozilla/RefPtr.h"
|
|
#include "mozilla/UniquePtr.h"
|
|
#include "mozilla/dom/DataTransfer.h"
|
|
|
|
namespace mozilla::dom {
|
|
|
|
class Promise;
|
|
class ClipboardItem;
|
|
|
|
// https://www.w3.org/TR/clipboard-apis/#clipboard-interface
|
|
class Clipboard : public DOMEventTargetHelper {
|
|
public:
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(Clipboard, DOMEventTargetHelper)
|
|
|
|
IMPL_EVENT_HANDLER(message)
|
|
IMPL_EVENT_HANDLER(messageerror)
|
|
|
|
explicit Clipboard(nsPIDOMWindowInner* aWindow);
|
|
already_AddRefed<Promise> Read(nsIPrincipal& aSubjectPrincipal,
|
|
ErrorResult& aRv);
|
|
already_AddRefed<Promise> ReadText(nsIPrincipal& aSubjectPrincipal,
|
|
ErrorResult& aRv);
|
|
already_AddRefed<Promise> Write(
|
|
const Sequence<OwningNonNull<ClipboardItem>>& aData,
|
|
nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv);
|
|
already_AddRefed<Promise> WriteText(const nsAString& aData,
|
|
nsIPrincipal& aSubjectPrincipal,
|
|
ErrorResult& aRv);
|
|
|
|
// See documentation of the corresponding .webidl file.
|
|
void OnUserReactedToPasteMenuPopup(bool aAllowed);
|
|
|
|
static LogModule* GetClipboardLog();
|
|
|
|
// Check if the Clipboard.readText API should be enabled for this context.
|
|
// This API is only enabled for Extension and System contexts, as there is no
|
|
// way to request the required permission for web content. If the clipboard
|
|
// API testing pref is enabled, ReadText is enabled for web content for
|
|
// testing purposes.
|
|
static bool ReadTextEnabled(JSContext* aCx, JSObject* aGlobal);
|
|
|
|
virtual JSObject* WrapObject(JSContext* aCx,
|
|
JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
private:
|
|
enum class ReadRequestType {
|
|
eRead,
|
|
eReadText,
|
|
};
|
|
|
|
// Checks if dom.events.testing.asyncClipboard pref is enabled.
|
|
// The aforementioned pref allows automated tests to bypass the security
|
|
// checks when writing to
|
|
// or reading from the clipboard.
|
|
static bool IsTestingPrefEnabled();
|
|
|
|
static bool IsTestingPrefEnabledOrHasReadPermission(
|
|
nsIPrincipal& aSubjectPrincipal);
|
|
|
|
void CheckReadPermissionAndHandleRequest(Promise& aPromise,
|
|
nsIPrincipal& aSubjectPrincipal,
|
|
ReadRequestType aType);
|
|
|
|
void HandleReadRequestWhichRequiresPasteButton(Promise& aPromise,
|
|
ReadRequestType aType);
|
|
|
|
already_AddRefed<Promise> ReadHelper(nsIPrincipal& aSubjectPrincipal,
|
|
ReadRequestType aType, ErrorResult& aRv);
|
|
|
|
~Clipboard();
|
|
|
|
class ReadRequest final {
|
|
public:
|
|
ReadRequest(Promise& aPromise, ReadRequestType aType,
|
|
nsPIDOMWindowInner& aOwner)
|
|
: mType(aType), mPromise(&aPromise), mOwner(&aOwner) {}
|
|
|
|
// Clears the request too.
|
|
void Answer();
|
|
|
|
void MaybeRejectWithNotAllowedError(const nsACString& aMessage);
|
|
|
|
private:
|
|
ReadRequestType mType;
|
|
// Not cycle-collected, because it's nulled when the request is answered or
|
|
// destructed.
|
|
RefPtr<Promise> mPromise;
|
|
RefPtr<nsPIDOMWindowInner> mOwner;
|
|
};
|
|
|
|
AutoTArray<UniquePtr<ReadRequest>, 1> mReadRequests;
|
|
|
|
class TransientUserPasteState final {
|
|
public:
|
|
enum class Value {
|
|
Initial,
|
|
WaitingForUserReactionToPasteMenuPopup,
|
|
TransientlyForbiddenByUser,
|
|
TransientlyAllowedByUser,
|
|
};
|
|
|
|
// @param aWindowContext requires valid transient user gesture activation.
|
|
Value RefreshAndGet(WindowContext& aWindowContext);
|
|
|
|
void OnStartWaitingForUserReactionToPasteMenuPopup(
|
|
const TimeStamp& aUserGestureStart);
|
|
void OnUserReactedToPasteMenuPopup(bool aAllowed);
|
|
|
|
private:
|
|
TimeStamp mUserGestureStart;
|
|
|
|
Value mValue = Value::Initial;
|
|
};
|
|
|
|
TransientUserPasteState mTransientUserPasteState;
|
|
};
|
|
|
|
} // namespace mozilla::dom
|
|
#endif // mozilla_dom_Clipboard_h_
|