038668bf8c
Rather than having to spell out the English fallback strings at *every* single `IL10n.get` call-site throughout the viewer, we can simplify things by collecting them in *one* central spot. This provides a much better overview of the fallback l10n strings used, which makes future changes easier and ensures that fallback strings occuring in multiple places cannot accidentally get out of sync. Furthermore, by making the `fallback` parameter of the `IL10n.get` method *optional*[1] many of the call-sites (and their surrounding code) become a lot less verbose. --- [1] It's obviously still possible to pass in a fallback string, it's just not required.
105 lines
3.3 KiB
JavaScript
105 lines
3.3 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 {string} overlayName - Name of the overlay for the overlay manager.
|
|
* @property {HTMLDivElement} container - Div container for the overlay.
|
|
* @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 {
|
|
/**
|
|
* @param {PasswordPromptOptions} options
|
|
* @param {OverlayManager} overlayManager - Manager for the viewer overlays.
|
|
* @param {IL10n} l10n - Localization service.
|
|
* @param {boolean} [isViewerEmbedded] - If the viewer is embedded, in e.g.
|
|
* an <iframe> or an <object>. The default value is `false`.
|
|
*/
|
|
constructor(options, overlayManager, l10n, isViewerEmbedded = false) {
|
|
this.overlayName = options.overlayName;
|
|
this.container = options.container;
|
|
this.label = options.label;
|
|
this.input = options.input;
|
|
this.submitButton = options.submitButton;
|
|
this.cancelButton = options.cancelButton;
|
|
this.overlayManager = overlayManager;
|
|
this.l10n = l10n;
|
|
this._isViewerEmbedded = isViewerEmbedded;
|
|
|
|
this.updateCallback = null;
|
|
this.reason = null;
|
|
|
|
// 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.overlayName,
|
|
this.container,
|
|
this.close.bind(this),
|
|
true
|
|
);
|
|
}
|
|
|
|
async open() {
|
|
await this.overlayManager.open(this.overlayName);
|
|
|
|
const passwordIncorrect =
|
|
this.reason === PasswordResponses.INCORRECT_PASSWORD;
|
|
|
|
if (!this._isViewerEmbedded || passwordIncorrect) {
|
|
this.input.focus();
|
|
}
|
|
this.label.textContent = await this.l10n.get(
|
|
`password_${passwordIncorrect ? "invalid" : "label"}`
|
|
);
|
|
}
|
|
|
|
close() {
|
|
this.overlayManager.close(this.overlayName).then(() => {
|
|
this.input.value = "";
|
|
});
|
|
}
|
|
|
|
verify() {
|
|
const password = this.input.value;
|
|
if (password?.length > 0) {
|
|
this.close();
|
|
this.updateCallback(password);
|
|
}
|
|
}
|
|
|
|
setUpdateCallback(updateCallback, reason) {
|
|
this.updateCallback = updateCallback;
|
|
this.reason = reason;
|
|
}
|
|
}
|
|
|
|
export { PasswordPrompt };
|