pdf.js/external/importL10n/locales.js

/* 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.
 */

"use strict";

const fs = require("fs");
const https = require("https");
const path = require("path");

// Fetches all languages that have an *active* translation in mozilla-central.
// This is used in gulpfile.js for the `importl10n` command.

const DEFAULT_LOCALE = "en-US";

const EXCLUDE_LANG_CODES = ["ca-valencia", "ja-JP-mac"];

function normalizeText(s) {
  return s.replaceAll(/\r\n?/g, "\n").replaceAll("\uFEFF", "");
}

function downloadLanguageCodes() {
  console.log("Downloading language codes...\n");

  const ALL_LOCALES =
    "https://hg.mozilla.org/mozilla-central/raw-file/tip/browser/locales/all-locales";

  return new Promise(function (resolve) {
    https.get(ALL_LOCALES, function (response) {
      if (response.statusCode === 200) {
        let content = "";
        response.setEncoding("utf8");
        response.on("data", function (chunk) {
          content += chunk;
        });
        response.on("end", function () {
          content = content.trim(); // Remove any leading/trailing white-space.
          const langCodes = normalizeText(content).split("\n");
          // Remove all locales that we don't want to download below.
          for (const langCode of [DEFAULT_LOCALE, ...EXCLUDE_LANG_CODES]) {
            const i = langCodes.indexOf(langCode);
            if (i > -1) {
              langCodes.splice(i, 1);
            }
          }
          resolve(langCodes);
        });
      } else {
        resolve([]);
      }
    });
  });
}

function downloadLanguageFiles(root, langCode) {
  console.log("Downloading " + langCode + "...");

  // Constants for constructing the URLs. Translations are taken from the
  // Nightly channel as those are the most recent ones.
  const MOZ_CENTRAL_ROOT = "https://hg.mozilla.org/l10n-central/";
  const MOZ_CENTRAL_PDFJS_DIR = "/raw-file/default/browser/pdfviewer/";

  // Defines which files to download for each language.
  const files = ["viewer.properties"];
  let downloadsLeft = files.length;

  const outputDir = path.join(root, langCode);
  if (!fs.existsSync(outputDir)) {
    fs.mkdirSync(outputDir);
  }

  return new Promise(function (resolve) {
    // Download the necessary files for this language.
    files.forEach(function (fileName) {
      const outputPath = path.join(outputDir, fileName);
      const url =
        MOZ_CENTRAL_ROOT + langCode + MOZ_CENTRAL_PDFJS_DIR + fileName;

      https.get(url, function (response) {
        // Not all files exist for each language. Files without translations
        // have been removed (https://bugzilla.mozilla.org/show_bug.cgi?id=1443175).
        if (response.statusCode === 200) {
          let content = "";
          response.setEncoding("utf8");
          response.on("data", function (chunk) {
            content += chunk;
          });
          response.on("end", function () {
            fs.writeFileSync(outputPath, normalizeText(content), "utf8");
            if (--downloadsLeft === 0) {
              resolve();
            }
          });
        } else {
          if (--downloadsLeft === 0) {
            resolve();
          }
        }
      });
    });
  });
}

async function downloadL10n(root, callback) {
  const langCodes = await downloadLanguageCodes();

  for (const langCode of langCodes) {
    if (!langCode) {
      continue;
    }
    await downloadLanguageFiles(root, langCode);
  }

  const removeCodes = [];
  for (const entry of fs.readdirSync(root)) {
    const dirPath = path.join(root, entry),
      stat = fs.lstatSync(dirPath);

    if (
      stat.isDirectory() &&
      entry !== DEFAULT_LOCALE &&
      !langCodes.includes(entry)
    ) {
      removeCodes.push(entry);
    }
  }
  if (removeCodes.length) {
    console.log(
      "\nConsider removing the following unmaintained locales:\n" +
        removeCodes.join(", ") +
        "\n"
    );
  }

  if (callback) {
    callback();
  }
}

exports.downloadL10n = downloadL10n;