moved build scripts to new build directory

build/imgen.py

@@ -0,0 +1,137 @@
+import json
+import os
+import sys
+
+# list files in a directory
+def list_files(path):
+    list = []
+
+    for (root, dirs, files) in os.walk(path):
+        for f in files:
+            list.append((root[2:] + "/" + f).replace('\\','/'))
+
+    return list
+
+# get size of all files in a directory
+def dir_size(path):
+    total = 0
+
+    for (root, dirs, files) in os.walk(path):
+        for f in files:
+            total += os.path.getsize(root + "/" + f)
+
+    return total
+
+# get the version of an application at the provided path
+def get_version(path, is_lib = False):
+    ver = ""
+    string = ".version = \""
+
+    if not is_lib:
+        string = "_VERSION = \""
+
+    f = open(path, "r")
+
+    for line in f:
+        pos = line.find(string)
+        if pos >= 0:
+            ver = line[(pos + len(string)):(len(line) - 2)]
+            break
+
+    f.close()
+
+    return ver
+
+# generate installation manifest object
+def make_manifest(size):
+    os.chdir('./_minified')
+
+    manifest = {
+        "versions" : {
+            "installer" : get_version("../ccmsi.lua"),
+            "bootloader" : get_version("./startup.lua"),
+            "common" : get_version("./scada-common/util.lua", True),
+            "comms" : get_version("./scada-common/comms.lua", True),
+            "graphics" : get_version("./graphics/core.lua", True),
+            "lockbox" : get_version("./lockbox/init.lua", True),
+            "reactor-plc" : get_version("./reactor-plc/startup.lua"),
+            "rtu" : get_version("./rtu/startup.lua"),
+            "supervisor" : get_version("./supervisor/startup.lua"),
+            "coordinator" : get_version("./coordinator/startup.lua"),
+            "pocket" : get_version("./pocket/startup.lua")
+        },
+        "files" : {
+            # common files
+            "system" : [ "initenv.lua", "startup.lua", "configure.lua", "LICENSE" ],
+            "common" : list_files("./scada-common"),
+            "graphics" : list_files("./graphics"),
+            "lockbox" : list_files("./lockbox"),
+            # platform files
+            "reactor-plc" : list_files("./reactor-plc"),
+            "rtu" : list_files("./rtu"),
+            "supervisor" : list_files("./supervisor"),
+            "coordinator" : list_files("./coordinator"),
+            "pocket" : list_files("./pocket"),
+        },
+        "depends" : {
+            "reactor-plc" : [ "system", "common", "graphics", "lockbox" ],
+            "rtu" : [ "system", "common", "graphics", "lockbox" ],
+            "supervisor" : [ "system", "common", "graphics", "lockbox" ],
+            "coordinator" : [ "system", "common", "graphics", "lockbox" ],
+            "pocket" : [ "system", "common", "graphics", "lockbox" ]
+        },
+        "sizes" : {
+            # manifest file estimate
+            "manifest" : size,
+            # common files
+            "system" : os.path.getsize("initenv.lua") + os.path.getsize("startup.lua") + os.path.getsize("configure.lua"),
+            "common" : dir_size("./scada-common"),
+            "graphics" : dir_size("./graphics"),
+            "lockbox" : dir_size("./lockbox"),
+            # platform files
+            "reactor-plc" : dir_size("./reactor-plc"),
+            "rtu" : dir_size("./rtu"),
+            "supervisor" : dir_size("./supervisor"),
+            "coordinator" : dir_size("./coordinator"),
+            "pocket" : dir_size("./pocket"),
+        }
+    }
+
+    os.chdir('../')
+
+    return manifest
+
+# write initial manifest with placeholder size
+f = open("install_manifest.json", "w")
+json.dump(make_manifest("-----"), f)
+f.close()
+
+manifest_size = os.path.getsize("install_manifest.json")
+
+final_manifest = make_manifest(manifest_size)
+
+# calculate file size then regenerate with embedded size
+f = open("install_manifest.json", "w")
+json.dump(final_manifest, f)
+f.close()
+
+if len(sys.argv) > 1 and sys.argv[1] == "shields":
+    # write all the JSON files for shields.io
+    for key, version in final_manifest["versions"].items():
+        f = open("./deploy/" + key + ".json", "w")
+
+        if version.find("alpha") >= 0:
+            color = "yellow"
+        elif version.find("beta") >= 0:
+            color = "orange"
+        else:
+            color = "blue"
+
+        json.dump({
+            "schemaVersion": 1,
+            "label": key,
+            "message": "" + version,
+            "color": color
+        }, f)
+
+        f.close()

build/safemin.py

@@ -0,0 +1,72 @@
+import os
+import re
+
+# minify files in a directory
+def min_files(path):
+    start_sum, end_sum = 0, 0
+
+    for (root, _, files) in os.walk(path):
+        os.makedirs('_minified/' + root, exist_ok=True)
+
+        for f in files:
+            start, end = minify(root + "/" + f)
+
+            start_sum = start_sum + start
+            end_sum = end_sum + end
+
+    delta = start_sum - end_sum
+
+    print(f"> done with '{path}': shrunk from {start_sum} bytes to {end_sum} bytes (saved {delta} bytes, or {(100*delta/start_sum):.2f}%)")
+
+    return list
+
+# minify a file
+def minify(path: str):
+    size_start = os.stat(path).st_size
+
+    f = open(path, "r")
+    contents = f.read()
+    f.close()
+
+    if re.search(r'--+\[+', contents) != None:
+        # absolutely not dealing with lua multiline comments
+        # - there are more important things to do
+        # - this minification is intended to be 100% safe, so working with multiline comments is asking for trouble
+        # - the project doesn't use them as of writing this (except in test/), and it might as well stay that way
+        raise Exception(f"no multiline comments allowed! (offending file: {path})")
+    
+    if re.search(r'\\$', contents, flags=re.MULTILINE) != None:
+        # '\' allows for multiline strings, which would require reverting to processing syntax line by line to support them
+        raise Exception(f"no escaping newlines! (offending file: {path})")
+
+    # drop the comments
+    # -> whitespace before '--' and anything after that, which includes '---' comments
+    minified = re.sub(r'\s*--+(?!.*[\'"]).*', '', contents)
+
+    # drop leading whitespace on each line
+    minified = re.sub(r'^ +', '', minified, flags=re.MULTILINE)
+
+    # drop blank lines
+    while minified != re.sub(r'\n\n', '\n', minified):
+        minified = re.sub(r'\n\n', '\n', minified)
+
+    # write the minified file
+    f_min = open(f"_minified/{path}", "w")
+    f_min.write(minified)
+    f_min.close()
+
+    size_end = os.stat(f"_minified/{path}").st_size
+
+    print(f">> shrunk '{path}' from {size_start} bytes to {size_end} bytes (saved {size_start-size_end} bytes)")
+
+    return size_start, size_end
+
+# minify applications and libraries
+dirs = [ 'scada-common', 'graphics', 'lockbox', 'reactor-plc', 'rtu', 'supervisor', 'coordinator', 'pocket' ]
+for _, d in enumerate(dirs):
+    min_files(d)
+
+# minify root files
+minify("startup.lua")
+minify("initenv.lua")
+minify("configure.lua")