crowdin.js

// ----------------------------------------------------------------------------------------------------------------- //

// Nano Core 2 - An adblocker
// Copyright (C) 2018-2019  Nano Core 2 contributors
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

// ----------------------------------------------------------------------------------------------------------------- //

// Crowdin project helper

// ----------------------------------------------------------------------------------------------------------------- //

"use strict";

// ----------------------------------------------------------------------------------------------------------------- //

const fs = require("fs-extra");
const https = require("https");
const path = require("path");
const url = require("url");
const yauzl = require("yauzl");

// ----------------------------------------------------------------------------------------------------------------- //

// Supported locales
// Crowdin key to Chromium key
const locales = new Map([
    ["es-ES", "es"],
    ["de", "de"],
    ["fi", "fi"],
    ["it", "it"],
    ["ja", "ja"],
    ["nb", "nb"],
    ["pl", "pl"],
    ["pt-BR", "pt_BR"],
    ["ru", "ru"],
    ["sv-SE", "sv"],
    ["tr", "tr"],
    ["zh-CN", "zh_CN"],
    ["zh-TW", "zh_TW"],
]);

// ----------------------------------------------------------------------------------------------------------------- //

const stream_to_buffer = (stream, on_done, on_error) => {
    const data = [];

    stream.on("data", (chunk) => {
        data.push(chunk);
    });

    stream.on("end", () => {
        on_done(Buffer.concat(data));
    });

    stream.on("error", on_error);
};

const download = (link, on_done, on_error, no_redir = false) => {
    const opt = url.parse(link);

    const req = https.request(opt, (res) => {
        if (res.statusCode === 301 || res.statusCode === 302 || res.statusCode === 307 || res.statusCode === 308) {
            const new_link = res.headers["location"];

            if (no_redir)
                on_error(new Error("Too many redirects."));
            else if (typeof new_link !== "string" || !new_link.startsWith("https://"))
                on_error(new Error("Bad server response."));
            else
                download(new_link, on_done, on_error, true);

            res.resume();

            return;
        }

        if (res.statusCode !== 200) {
            on_error(new Error("Connection error."));

            res.resume();

            return;
        }

        stream_to_buffer(res, on_done, on_error);
    });

    req.on("error", on_error);

    req.end();
};

// Validates JSON
const validated_write = (file, stream, on_done, on_error) => {
    let data = "";

    stream.setEncoding("utf8");

    stream.on("data", (c) => {
        data += c;
    });

    const on_end = () => {
        try {
            data = JSON.parse(data);
        } catch (err) {
            return void on_error(err);
        }

        fs.writeFile(file, JSON.stringify(data, null, 2), on_wrote);
    };

    const on_wrote = (err) => {
        if (err)
            on_error(err);
        else
            on_done();
    };

    stream.on("end", on_end);

    stream.on("error", on_error);
};

// ----------------------------------------------------------------------------------------------------------------- //

// Download, safely unpack, validate, then build supported non-English locales from Crowdin
// Note that you still have to manually build the project on Crowdin when there are changes
exports.sync = async () => {
    const file = await new Promise((resolve, reject) => {
        download("https://crowdin.com/backend/download/project/nano-adblocker.zip", resolve, reject);
    });

    await new Promise((resolve, reject) => {
        const done = new Set();

        yauzl.fromBuffer(file, { lazyEntries: true }, (err, zip) => {
            if (err)
                return void reject(err);

            const next = () => {
                zip.readEntry();
            };

            zip.on("entry", (entry) => {
                const name = entry.fileName;

                if (name.endsWith("/"))
                    return void next();

                const [key, messages, ...rest] = name.split("/");

                if (messages !== "messages.json" || rest.length !== 0)
                    return void reject(new Error("Unexpected file '" + name + "'"));
                if (!locales.has(key))
                    return void reject(new Error("Locale '" + key + "' is not recognized."));

                const norm_key = locales.get(key);

                done.add(key);

                const outdir = path.resolve("./src/_locales", norm_key);

                fs.mkdirp(outdir, (err) => {
                    if (err)
                        return void reject(err);

                    zip.openReadStream(entry, (err, stream) => {
                        if (err)
                            return void reject(err);

                        validated_write(path.resolve(outdir, "messages.json"), stream, next, reject);
                    });
                });
            });

            zip.on("end", () => {
                if (locales.size !== done.size)
                    reject(new Error("Some locale files are missing."));
                else
                    resolve();
            });

            zip.on("error", reject);

            next();
        });
    });
};

// ----------------------------------------------------------------------------------------------------------------- //