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.
128 lines
4.4 KiB
JavaScript
128 lines
4.4 KiB
JavaScript
/* Copyright 2021 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.
|
||
*/
|
||
|
||
/**
|
||
* A subset of the l10n strings in the `l10n/en-US/viewer.properties` file.
|
||
*/
|
||
const DEFAULT_L10N_STRINGS = {
|
||
of_pages: "of {{pagesCount}}",
|
||
page_of_pages: "({{pageNumber}} of {{pagesCount}})",
|
||
|
||
document_properties_kb: "{{size_kb}} KB ({{size_b}} bytes)",
|
||
document_properties_mb: "{{size_mb}} MB ({{size_b}} bytes)",
|
||
document_properties_date_string: "{{date}}, {{time}}",
|
||
document_properties_page_size_unit_inches: "in",
|
||
document_properties_page_size_unit_millimeters: "mm",
|
||
document_properties_page_size_orientation_portrait: "portrait",
|
||
document_properties_page_size_orientation_landscape: "landscape",
|
||
document_properties_page_size_name_a3: "A3",
|
||
document_properties_page_size_name_a4: "A4",
|
||
document_properties_page_size_name_letter: "Letter",
|
||
document_properties_page_size_name_legal: "Legal",
|
||
document_properties_page_size_dimension_string:
|
||
"{{width}} × {{height}} {{unit}} ({{orientation}})",
|
||
document_properties_page_size_dimension_name_string:
|
||
"{{width}} × {{height}} {{unit}} ({{name}}, {{orientation}})",
|
||
document_properties_linearized_yes: "Yes",
|
||
document_properties_linearized_no: "No",
|
||
|
||
print_progress_percent: "{{progress}}%",
|
||
|
||
"toggle_sidebar.title": "Toggle Sidebar",
|
||
"toggle_sidebar_notification2.title":
|
||
"Toggle Sidebar (document contains outline/attachments/layers)",
|
||
|
||
additional_layers: "Additional Layers",
|
||
page_canvas: "Page {{page}}",
|
||
thumb_page_title: "Page {{page}}",
|
||
thumb_page_canvas: "Thumbnail of Page {{page}}",
|
||
|
||
find_reached_top: "Reached top of document, continued from bottom",
|
||
find_reached_bottom: "Reached end of document, continued from top",
|
||
"find_match_count[one]": "{{current}} of {{total}} match",
|
||
"find_match_count[other]": "{{current}} of {{total}} matches",
|
||
"find_match_count_limit[one]": "More than {{limit}} match",
|
||
"find_match_count_limit[other]": "More than {{limit}} matches",
|
||
find_not_found: "Phrase not found",
|
||
|
||
error_version_info: "PDF.js v{{version}} (build: {{build}})",
|
||
error_message: "Message: {{message}}",
|
||
error_stack: "Stack: {{stack}}",
|
||
error_file: "File: {{file}}",
|
||
error_line: "Line: {{line}}",
|
||
rendering_error: "An error occurred while rendering the page.",
|
||
|
||
page_scale_width: "Page Width",
|
||
page_scale_fit: "Page Fit",
|
||
page_scale_auto: "Automatic Zoom",
|
||
page_scale_actual: "Actual Size",
|
||
page_scale_percent: "{{scale}}%",
|
||
|
||
loading_error: "An error occurred while loading the PDF.",
|
||
invalid_file_error: "Invalid or corrupted PDF file.",
|
||
missing_file_error: "Missing PDF file.",
|
||
unexpected_response_error: "Unexpected server response.",
|
||
|
||
printing_not_supported:
|
||
"Warning: Printing is not fully supported by this browser.",
|
||
printing_not_ready: "Warning: The PDF is not fully loaded for printing.",
|
||
web_fonts_disabled:
|
||
"Web fonts are disabled: unable to use embedded PDF fonts.",
|
||
};
|
||
|
||
function getL10nFallback(key, args) {
|
||
switch (key) {
|
||
case "find_match_count":
|
||
key = `find_match_count[${args.total === 1 ? "one" : "other"}]`;
|
||
break;
|
||
case "find_match_count_limit":
|
||
key = `find_match_count_limit[${args.limit === 1 ? "one" : "other"}]`;
|
||
break;
|
||
}
|
||
return DEFAULT_L10N_STRINGS[key] || "";
|
||
}
|
||
|
||
// Replaces {{arguments}} with their values.
|
||
function formatL10nValue(text, args) {
|
||
if (!args) {
|
||
return text;
|
||
}
|
||
return text.replace(/\{\{\s*(\w+)\s*\}\}/g, (all, name) => {
|
||
return name in args ? args[name] : "{{" + name + "}}";
|
||
});
|
||
}
|
||
|
||
/**
|
||
* No-op implementation of the localization service.
|
||
* @implements {IL10n}
|
||
*/
|
||
const NullL10n = {
|
||
async getLanguage() {
|
||
return "en-us";
|
||
},
|
||
|
||
async getDirection() {
|
||
return "ltr";
|
||
},
|
||
|
||
async get(key, args = null, fallback = getL10nFallback(key, args)) {
|
||
return formatL10nValue(fallback, args);
|
||
},
|
||
|
||
async translate(element) {},
|
||
};
|
||
|
||
export { getL10nFallback, NullL10n };
|