update_module_builder.py

"""
This script downloads and updates the module builder.
"""


from __future__ import print_function

import os
import sys
import zipfile
import shutil

if sys.version_info.major >= 3:  # we are running Python 3.x
    from io import BytesIO as StringIO
    from urllib.request import urlopen
else:
    # Import cStringIO in case it's available, since it's faster
    try:
        from cStringIO import StringIO
    except ImportError:
        from StringIO import StringIO
    from urllib import urlopen

def download_submodule(author, module_name, dest_path, ignore_list):
    """ Downloads a submodule from the given author and module name, and extracts
    all files which are not on the ignore_list to the dest_path.

    Example: download_submodule("tobspr", "RenderPipeline", ".", ["README.md", "LICENSE"])
     """

    # Make directory, if it does not exist yet
    if not os.path.isdir(dest_path):
        os.makedirs(dest_path)

    # Construct download url
    source_url = "https://github.com/" + author + "/" + module_name + "/archive/master.zip"
    prefix = module_name + "-master"
    print("Fetching:", source_url)

    # Download the zip
    try:
        usock = urlopen(source_url)
        zip_data = usock.read()
        usock.close()
    except Exception as msg:
        print("ERROR: Could not fetch module", module_name, "! Reason:", msg, file=sys.stderr)
        sys.exit(2)

    # Extract the zip
    zip_ptr = StringIO(zip_data)

    try:
        zip_handle = zipfile.ZipFile(zip_ptr)
    except zipfile.BadZipfile:
        print("ERROR: Invalid zip file!", file=sys.stderr)
        sys.exit(3)

    if zip_handle.testzip() is not None:
        print("ERROR: Invalid zip file checksums!", file=sys.stderr)
        sys.exit(1)

    num_files, num_dirs = 0, 0

    for fname in zip_handle.namelist():
        rel_name = fname.replace(prefix, "").replace("\\", "/").lstrip("/")
        if not rel_name:
            continue

        is_file = not rel_name.endswith("/")
        rel_name = dest_path.rstrip("/\\") + "/" + rel_name

        # Files
        if is_file:
            for ignore in ignore_list:
                if ignore in rel_name:
                    break
            else:
                with zip_handle.open(fname, "r") as source, open(rel_name, "wb") as dest:
                    shutil.copyfileobj(source, dest)
                num_files += 1

        # Directories
        else:
            if not os.path.isdir(rel_name):
                os.makedirs(rel_name)
            num_dirs += 1

    print("Extracted", num_files, "files and", num_dirs, "directories")

if __name__ == "__main__":
    ignore = ("__init__.py LICENSE README.md config.ini source/config_module.cpp "
        "source/config_module.h .travis.yml").split()
    curr_dir = os.path.dirname(os.path.realpath(__file__)); os.chdir(curr_dir);
    download_submodule("tobspr", "P3DModuleBuilder", curr_dir, ignore)
    with open("scripts/__init__.py", "w") as handle: pass
    try: os.remove(".gitignore")
    except: pass
    os.rename("prefab.gitignore", ".gitignore")