mirror of
https://github.com/zen-browser/pdf.js.git
synced 2025-07-08 09:20:06 +02:00
This replaces our custom `PromiseCapability`-class with the new native `Promise.withResolvers()` functionality, which does *almost* the same thing[1]; please see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers The only difference is that `PromiseCapability` also had a `settled`-getter, which was however not widely used and the call-sites can either be removed or re-factored to avoid it. In particular: - In `src/display/api.js` we can tweak the `PDFObjects`-class to use a "special" initial data-value and just compare against that, in order to replace the `settled`-state. - In `web/app.js` we change the only case to manually track the `settled`-state, which should hopefully be OK given how this is being used. - In `web/pdf_outline_viewer.js` we can remove the `settled`-checks, since the code should work just fine without it. The only thing that could potentially happen is that we try to `resolve` a Promise multiple times, which is however *not* a problem since the value of a Promise cannot be changed once fulfilled or rejected. - In `web/pdf_viewer.js` we can remove the `settled`-checks, since the code should work fine without them: - For the `_onePageRenderedCapability` case the `settled`-check is used in a `EventBus`-listener which is *removed* on its first (valid) invocation. - For the `_pagesCapability` case the `settled`-check is used in a print-related helper that works just fine with "only" the other checks. - In `test/unit/api_spec.js` we can change the few relevant cases to manually track the `settled`-state, since this is both simple and *test-only* code. --- [1] In browsers/environments that lack native support, note [the compatibility data](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers#browser_compatibility), it'll be polyfilled via the `core-js` library (but only in `legacy` builds).
127 lines
3.8 KiB
JavaScript
127 lines
3.8 KiB
JavaScript
/* Copyright 2012 Mozilla Foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { PasswordResponses } from "pdfjs-lib";
|
|
|
|
/**
|
|
* @typedef {Object} PasswordPromptOptions
|
|
* @property {HTMLDialogElement} dialog - The overlay's DOM element.
|
|
* @property {HTMLParagraphElement} label - Label containing instructions for
|
|
* entering the password.
|
|
* @property {HTMLInputElement} input - Input field for entering the password.
|
|
* @property {HTMLButtonElement} submitButton - Button for submitting the
|
|
* password.
|
|
* @property {HTMLButtonElement} cancelButton - Button for cancelling password
|
|
* entry.
|
|
*/
|
|
|
|
class PasswordPrompt {
|
|
#activeCapability = null;
|
|
|
|
#updateCallback = null;
|
|
|
|
#reason = null;
|
|
|
|
/**
|
|
* @param {PasswordPromptOptions} options
|
|
* @param {OverlayManager} overlayManager - Manager for the viewer overlays.
|
|
* @param {boolean} [isViewerEmbedded] - If the viewer is embedded, in e.g.
|
|
* an <iframe> or an <object>. The default value is `false`.
|
|
*/
|
|
constructor(options, overlayManager, isViewerEmbedded = false) {
|
|
this.dialog = options.dialog;
|
|
this.label = options.label;
|
|
this.input = options.input;
|
|
this.submitButton = options.submitButton;
|
|
this.cancelButton = options.cancelButton;
|
|
this.overlayManager = overlayManager;
|
|
this._isViewerEmbedded = isViewerEmbedded;
|
|
|
|
// Attach the event listeners.
|
|
this.submitButton.addEventListener("click", this.#verify.bind(this));
|
|
this.cancelButton.addEventListener("click", this.close.bind(this));
|
|
this.input.addEventListener("keydown", e => {
|
|
if (e.keyCode === /* Enter = */ 13) {
|
|
this.#verify();
|
|
}
|
|
});
|
|
|
|
this.overlayManager.register(this.dialog, /* canForceClose = */ true);
|
|
|
|
this.dialog.addEventListener("close", this.#cancel.bind(this));
|
|
}
|
|
|
|
async open() {
|
|
await this.#activeCapability?.promise;
|
|
this.#activeCapability = Promise.withResolvers();
|
|
|
|
try {
|
|
await this.overlayManager.open(this.dialog);
|
|
} catch (ex) {
|
|
this.#activeCapability.resolve();
|
|
throw ex;
|
|
}
|
|
|
|
const passwordIncorrect =
|
|
this.#reason === PasswordResponses.INCORRECT_PASSWORD;
|
|
|
|
if (!this._isViewerEmbedded || passwordIncorrect) {
|
|
this.input.focus();
|
|
}
|
|
this.label.setAttribute(
|
|
"data-l10n-id",
|
|
`pdfjs-password-${passwordIncorrect ? "invalid" : "label"}`
|
|
);
|
|
}
|
|
|
|
async close() {
|
|
if (this.overlayManager.active === this.dialog) {
|
|
this.overlayManager.close(this.dialog);
|
|
}
|
|
}
|
|
|
|
#verify() {
|
|
const password = this.input.value;
|
|
if (password?.length > 0) {
|
|
this.#invokeCallback(password);
|
|
}
|
|
}
|
|
|
|
#cancel() {
|
|
this.#invokeCallback(new Error("PasswordPrompt cancelled."));
|
|
this.#activeCapability.resolve();
|
|
}
|
|
|
|
#invokeCallback(password) {
|
|
if (!this.#updateCallback) {
|
|
return; // Ensure that the callback is only invoked once.
|
|
}
|
|
this.close();
|
|
this.input.value = "";
|
|
|
|
this.#updateCallback(password);
|
|
this.#updateCallback = null;
|
|
}
|
|
|
|
async setUpdateCallback(updateCallback, reason) {
|
|
if (this.#activeCapability) {
|
|
await this.#activeCapability.promise;
|
|
}
|
|
this.#updateCallback = updateCallback;
|
|
this.#reason = reason;
|
|
}
|
|
}
|
|
|
|
export { PasswordPrompt };
|