build_webui.py

# pyright: reportUndefinedVariable=false

import os, glob, re, shutil, configparser
from jinja2 import Environment, FileSystemLoader
from yaml import load, Loader

def prep_dst(fname, build_platform, prefix, data_dir=None):
    rel_path = fname.replace(prefix, '')
    if data_dir is None:
        destination = os.path.join('data', build_platform, rel_path) # e.g. data/BUILD_APPLE/...
    else:
        destination = os.path.join(data_dir, rel_path) # e.g. /fujinet-pc/build/windows-x64/APPLE/data/...
    dest_dir = os.path.dirname(destination)
    if not os.path.exists(dest_dir):
        os.makedirs(dest_dir)
    return destination


def process_template(fname, build_platform, template_env, config, prefix, build_data_dir=None):
    print(f"processing template file {fname}")
    # jinja2 insists on '/' as the path separator even on windows. see https://github.com/pallets/jinja/issues/767
    template = template_env.get_template(fname.replace(prefix, '').replace('\\', '/'))
    r = template.render(config)
    destination = prep_dst(fname, build_platform, prefix, build_data_dir).replace('.tmpl.', '.')
    with open(destination, 'w') as f:
        f.write(r)

def copy_file(fname, build_platform, prefix, build_data_dir=None):
    destination = prep_dst(fname, build_platform, prefix, build_data_dir)
    shutil.copy(fname, destination)

# collect environment variables
build_board = os.environ.get("FUJINET_BUILD_BOARD")
build_platform = os.environ.get("FUJINET_BUILD_PLATFORM")
build_data_dir = os.environ.get("BUILD_DATA_DIR")

# PROJECT_CONFIG is set by pio when passed the -i param to choose a specific ini file, and also build.sh uses same variable name too for consistency
ini_file = os.environ.get("PROJECT_CONFIG")

try:
    Import("env")
    # print(env.Dump())
except NameError:
    print("Running build_webui.py outside the PlatformIO environment.")
    env = None

# Still default to the old name if the user is manually running this script
if ini_file is None:
    ini_file = 'platformio.ini'

if env is not None:
    if build_board is None:
        build_board = env["PIOENV"]
    # PROGRAM_ARGS is a list of args provided by pio with "-a" switch
    if 'dev' in env["PROGRAM_ARGS"]:
        build_board = "dev"

    # this is set by "pio" if it is running the build
    if env["PROJECT_CONFIG"] is not None:
        ini_file = env["PROJECT_CONFIG"]

    if build_platform is None:
        pio_config = configparser.ConfigParser()
        pio_config.read(ini_file)
        build_platform = pio_config['fujinet']['build_platform']

if build_data_dir is None:
    build_data_dir = os.path.join("data", build_platform)

print(f"Building webUI into {build_data_dir}")
print(f"  build_platform: {build_platform}")
print(f"  build_board: {build_board}")
print(f"  config file: {ini_file}")

template_env = Environment(loader=FileSystemLoader("data/webui/template"))
config = load(open(os.path.join('data', 'webui', 'config', f'{build_board}.yaml')), Loader=Loader)

if not build_platform.startswith('BUILD_'):
    raise Exception(f"build_platform does not match BUILD_*, aborting")

data_build_platform_path = build_data_dir
if (os.path.isdir(data_build_platform_path)):
    shutil.rmtree(data_build_platform_path)

# copy common files not in www dir - these are files that do not need templating, e.g. binary files
common_prefix = os.path.join('data', 'webui', 'common', '')
for filename in glob.iglob(f'{common_prefix}**', recursive=True):
    if os.path.isfile(filename):
        copy_file(filename, build_platform, common_prefix, build_data_dir)

# copy template files, rendering if name matches *.tmpl.*
template_matcher = re.compile(r'^.*\.tmpl\.[a-zA-Z0-9_]+$')
webui_template_prefix = os.path.join('data', 'webui', 'template', '')
for filename in glob.iglob(f'{webui_template_prefix}**', recursive=True):
    if os.path.isfile(filename):
        if (template_matcher.search(filename)):
            process_template(filename, build_platform, template_env, config, webui_template_prefix, build_data_dir)
        else:
            copy_file(filename, build_platform, webui_template_prefix, build_data_dir)

# copy additional files from appropriate BUILD_* data dir, which is stored in the ini file under fujinet.build_platform
# if there are file clashes, these will override the above, so it allows for device specific overrides

dev_specific_prefix = os.path.join('data', 'webui', 'device_specific', build_platform, '')
for filename in glob.iglob(f"{dev_specific_prefix}**", recursive=True):
    if os.path.isfile(filename) and filename != '.keep':
        copy_file(filename, build_platform, dev_specific_prefix, build_data_dir)