mapcomplete/scripts/generateLayouts.ts

import { appendFileSync, existsSync, mkdirSync, readFileSync, writeFile, writeFileSync } from "fs"
import Locale from "../UI/i18n/Locale"
import Translations from "../UI/i18n/Translations"
import { Translation } from "../UI/i18n/Translation"
import all_known_layouts from "../assets/generated/known_themes.json"
import { LayoutConfigJson } from "../Models/ThemeConfig/Json/LayoutConfigJson"
import LayoutConfig from "../Models/ThemeConfig/LayoutConfig"
import xml2js from "xml2js"
import ScriptUtils from "./ScriptUtils"
import { Utils } from "../Utils"

const sharp = require("sharp")
const template = readFileSync("theme.html", "utf8")
const codeTemplate = readFileSync("index_theme.ts.template", "utf8")

function enc(str: string): string {
    return encodeURIComponent(str.toLowerCase())
}

async function createIcon(iconPath: string, size: number, alreadyWritten: string[]) {
    let name = iconPath.split(".").slice(0, -1).join(".") // drop svg suffix
    if (name.startsWith("./")) {
        name = name.substr(2)
    }

    const newname = `assets/generated/images/${name.replace(/\//g, "_")}${size}.png`
    const targetpath = `public/${newname}`
    if (alreadyWritten.indexOf(newname) >= 0) {
        return newname
    }
    alreadyWritten.push(newname)
    if (existsSync(newname)) {
        return newname
    }

    if (!existsSync(iconPath)) {
        throw "No file at " + iconPath
    }

    try {
        // We already read to file, in order to crash here if the file is not found
        let img = await sharp(iconPath)
        let resized = await img.resize(size)
        await resized.toFile(targetpath)
        console.log("Created png version at ", newname)
    } catch (e) {
        console.error("Could not read icon", iconPath, " to create a PNG due to", e)
    }

    return newname
}

async function createSocialImage(layout: LayoutConfig, template: "" | "Wide"): Promise<string> {
    if (!layout.icon.endsWith(".svg")) {
        console.warn(
            "Not creating a social image for " +
                layout.id +
                " as it is _not_ a .svg: " +
                layout.icon
        )
        return undefined
    }
    const path = `./public/assets/generated/images/social_image_${layout.id}_${template}.svg`
    if (existsSync(path)) {
        return path
    }
    const svg = await ScriptUtils.ReadSvg(layout.icon)
    let width: string = svg.$.width
    if (width === undefined) {
        throw "The logo at " + layout.icon + " does not have a defined width"
    }
    if (width?.endsWith("px")) {
        width = width.substring(0, width.length - 2)
    }
    if (width?.endsWith("%")) {
        throw "The logo at " + layout.icon + " has a relative width; this is not supported"
    }
    delete svg["defs"]
    delete svg["$"]
    let templateSvg = await ScriptUtils.ReadSvg("./assets/SocialImageTemplate" + template + ".svg")
    templateSvg = Utils.WalkJson(
        templateSvg,
        (leaf) => {
            const { cx, cy, r } = leaf["circle"][0].$
            return {
                $: {
                    id: "icon",
                    transform: `translate(${cx - r},${cy - r}) scale(${(r * 2) / Number(width)}) `,
                },
                g: [svg],
            }
        },
        (mightBeTokenToReplace) => {
            if (mightBeTokenToReplace?.circle === undefined) {
                return false
            }
            return mightBeTokenToReplace.circle[0]?.$?.style?.indexOf("fill:#ff00ff") >= 0
        }
    )

    const builder = new xml2js.Builder()
    const xml = builder.buildObject({ svg: templateSvg })
    writeFileSync(path, xml)
    console.log("Created social image at ", path)
    return path
}

async function createManifest(
    layout: LayoutConfig,
    alreadyWritten: string[]
): Promise<{
    manifest: any
    whiteIcons: string[]
}> {
    Translation.forcedLanguage = "en"
    const icons = []

    const whiteIcons: string[] = []
    let icon = layout.icon
    if (icon.endsWith(".svg") || icon.startsWith("<svg") || icon.startsWith("<?xml")) {
        // This is an svg. Lets create the needed pngs and do some checkes!

        const whiteBackgroundPath =
            "./public/assets/generated/images/theme_" + layout.id + "_white_background.svg"
        {
            const svg = await ScriptUtils.ReadSvg(icon)
            const width: string = svg.$.width
            const height: string = svg.$.height

            const builder = new xml2js.Builder()
            const withRect = { rect: { $: { width, height, style: "fill:#ffffff;" } }, ...svg }
            const xml = builder.buildObject({ svg: withRect })
            writeFileSync(whiteBackgroundPath, xml)
        }

        let path = layout.icon
        if (layout.icon.startsWith("<")) {
            // THis is already the svg
            path = "./public/assets/generated/images/" + layout.id + "_logo.svg"
            writeFileSync(path, layout.icon)
        }

        const sizes = [72, 96, 120, 128, 144, 152, 180, 192, 384, 512]
        for (const size of sizes) {
            const name = await createIcon(path, size, alreadyWritten)
            const whiteIcon = await createIcon(whiteBackgroundPath, size, alreadyWritten)
            whiteIcons.push(whiteIcon)
            icons.push({
                src: name,
                sizes: size + "x" + size,
                type: "image/png",
            })
        }
        icons.push({
            src: path,
            sizes: "513x513",
            type: "image/svg",
        })
    } else if (icon.endsWith(".png")) {
        icons.push({
            src: icon,
            sizes: "513x513",
            type: "image/png",
        })
    } else {
        console.log(icon)
        throw "Icon is not an svg for " + layout.id
    }
    const ogTitle = Translations.T(layout.title).txt
    const ogDescr = Translations.T(layout.description ?? "").txt

    const manifest = {
        name: ogTitle,
        short_name: ogTitle,
        start_url: `${layout.id.toLowerCase()}.html`,
        lang: "en",
        display: "standalone",
        background_color: "#fff",
        description: ogDescr,
        orientation: "portrait-primary, landscape-primary",
        icons: icons,
        categories: ["map", "navigation"],
    }
    return {
        manifest,
        whiteIcons,
    }
}

async function createLandingPage(layout: LayoutConfig, manifest, whiteIcons, alreadyWritten) {
    Locale.language.setData(layout.language[0])
    const targetLanguage = layout.language[0]
    const ogTitle = Translations.T(layout.title).textFor(targetLanguage).replace(/"/g, '\\"')
    const ogDescr = Translations.T(
        layout.shortDescription ?? "Easily add and edit geodata with OpenStreetMap"
    )
        .textFor(targetLanguage)
        .replace(/"/g, '\\"')
    let ogImage = layout.socialImage
    let twitterImage = ogImage
    if (ogImage === LayoutConfig.defaultSocialImage && layout.official) {
        ogImage = (await createSocialImage(layout, "")) ?? layout.socialImage
        twitterImage = (await createSocialImage(layout, "Wide")) ?? layout.socialImage
    }
    if (twitterImage.endsWith(".svg")) {
        // svgs are badly supported as social image, we use a generated svg instead
        twitterImage = await createIcon(twitterImage, 512, alreadyWritten)
    }

    if (ogImage.endsWith(".svg")) {
        ogImage = await createIcon(ogImage, 512, alreadyWritten)
    }

    let customCss = ""
    if (layout.customCss !== undefined && layout.customCss !== "") {
        try {
            const cssContent = readFileSync(layout.customCss)
            customCss = "<style>" + cssContent + "</style>"
        } catch (e) {
            customCss = `<link rel='stylesheet' href="${layout.customCss}"/>`
        }
    }

    const og = `
    <meta property="og:image" content="${ogImage ?? "assets/SocialImage.png"}">
    <meta property="og:title" content="${ogTitle}">
    <meta property="og:description" content="${ogDescr}">
    <meta name="twitter:card" content="summary_large_image">
    <meta name="twitter:site" content="@mapcomplete.osm.be">
    <meta name="twitter:creator" content="@pietervdvn">
    <meta name="twitter:title" content="${ogTitle}">
    <meta name="twitter:description" content="${ogDescr}">
    <meta name="twitter:image" content="${twitterImage}">`

    let icon = layout.icon
    if (icon.startsWith("<?xml") || icon.startsWith("<svg")) {
        // This already is an svg
        icon = `./public/assets/generated/images/${layout.id}_icon.svg`
        writeFileSync(icon, layout.icon)
    }

    const apple_icons = []
    for (const icon of whiteIcons) {
        if (!existsSync(icon)) {
            continue
        }
        const size = icon.replace(/[^0-9]/g, "")
        apple_icons.push(`<link rel="apple-touch-icon" sizes="${size}x${size}" href="${icon}">`)
    }

    let themeSpecific = [
        `<title>${ogTitle}</title>`,
        `<link rel="manifest" href="${enc(layout.id)}.webmanifest">`,
        og,
        customCss,
        `<link rel="icon" href="${icon}" sizes="any" type="image/svg+xml">`,
        ...apple_icons,
    ].join("\n")

    const loadingText = Translations.t.general.loadingTheme.Subs({ theme: ogTitle })
    let output = template
        .replace("Loading MapComplete, hang on...", loadingText.textFor(targetLanguage))
        .replace(
            "Powered by OpenStreetMap",
            Translations.t.general.poweredByOsm.textFor(targetLanguage)
        )
        .replace(/<!-- THEME-SPECIFIC -->.*<!-- THEME-SPECIFIC-END-->/s, themeSpecific)
        .replace(
            /<!-- DESCRIPTION START -->.*<!-- DESCRIPTION END -->/s,
            layout.shortDescription.textFor(targetLanguage)
        )
        .replace(
            '<script type="module" src="./index.ts"></script>',
            `<script type="module"  src='./index_${layout.id}.ts'></script>`
        )

    try {
        output = output
            .replace(
                /<!-- DECORATION 0 START -->.*<!-- DECORATION 0 END -->/s,
                `<img src='${icon}' width="100%" height="100%">`
            )
            .replace(
                /<!-- DECORATION 1 START -->.*<!-- DECORATION 1 END -->/s,
                `<img src='${icon}' width="100%" height="100%">`
            )
    } catch (e) {
        console.warn("Error while applying logo: ", e)
    }

    return output
}

async function createIndexFor(theme: LayoutConfig) {
    const filename = "index_" + theme.id + ".ts"
    writeFileSync(
        filename,
        `import themeConfig from "./assets/generated/themes/${theme.id}.json"\n`
    )
    appendFileSync(filename, codeTemplate)
}

function createDir(path) {
    if (!existsSync(path)) {
        mkdirSync(path)
    }
}

async function main(): Promise<void> {
    const alreadyWritten = []
    createDir("./assets/generated")
    createDir("./assets/generated/layers")
    createDir("./assets/generated/themes")
    createDir("./public/assets/")
    createDir("./public/assets/generated")
    createDir("./public/assets/generated/images")

    const blacklist = [
        "",
        "test",
        ".",
        "..",
        "manifest",
        "index",
        "land",
        "preferences",
        "account",
        "openstreetmap",
        "custom",
        "theme",
    ]
    // @ts-ignore
    const all: LayoutConfigJson[] = all_known_layouts.themes
    const args = process.argv
    const theme = args[2]
    if (theme !== undefined) {
        console.warn("Only generating layout " + theme)
    }
    for (const i in all) {
        const layoutConfigJson: LayoutConfigJson = all[i]
        if (theme !== undefined && layoutConfigJson.id !== theme) {
            continue
        }
        const layout = new LayoutConfig(layoutConfigJson, true)
        const layoutName = layout.id
        if (blacklist.indexOf(layoutName.toLowerCase()) >= 0) {
            console.log(`Skipping a layout with name${layoutName}, it is on the blacklist`)
            continue
        }
        const err = (err) => {
            if (err !== null) {
                console.log("Could not write manifest for ", layoutName, " because ", err)
            }
        }
        const { manifest, whiteIcons } = await createManifest(layout, alreadyWritten)
        const manif = JSON.stringify(manifest, undefined, 2)
        const manifestLocation = encodeURIComponent(layout.id.toLowerCase()) + ".webmanifest"
        writeFile("public/" + manifestLocation, manif, err)

        // Create a landing page for the given theme
        const landing = await createLandingPage(layout, manifest, whiteIcons, alreadyWritten)
        writeFile(enc(layout.id) + ".html", landing, err)
        await createIndexFor(layout)
    }

    const { manifest } = await createManifest(
        new LayoutConfig({
            icon: "./assets/svg/mapcomplete_logo.svg",
            id: "index",
            layers: [],
            socialImage: "assets/SocialImage.png",
            startLat: 0,
            startLon: 0,
            startZoom: 0,
            title: { en: "MapComplete" },
            description: { en: "A thematic map viewer and editor based on OpenStreetMap" },
        }),
        alreadyWritten
    )

    const manif = JSON.stringify(manifest, undefined, 2)
    writeFileSync("public/index.webmanifest", manif)
}

main().then(() => {
    console.log("All done!")
})