Updated bundle process to avoid triggering AV products

Author: remyroy

BUILDING.md

@@ -17,6 +17,8 @@ Once you have Python installed and all the requirements, you can run the launche
 
 ## Building the launcher installer for distribution
 
+> This guide is outdated. A updated version should soon be added to replace this one.
+
 Once you have Python installed and all the requirements, you can build the launcher installer for distribution by going into the project directory and running `python setup.py create_installer`. This will use the PyInstaller package to create a frozen stand-alone executable with all the dependencies alongside. Afterwards, it will build the installer using Inno Setup. If you want the executable to support RAR archives, you will also need to have the [UnRAR command line tool](http://www.rarlab.com/rar_add.htm) in your PATH.
 
 The resulting launcher installer should be in the `dist\innosetup` directory.

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 Rémy Roy
+Copyright (c) 2015-2021 Rémy Roy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

alembic/README alembicrepo/README

@@ -33,7 +33,7 @@ def get_db_url():
 
 
 def init_config(basedir):
-    alembic_dir = os.path.join(basedir, 'alembic')
+    alembic_dir = os.path.join(basedir, 'alembicrepo')
 
     alembic_cfg = Config()
     alembic_cfg.set_main_option('sqlalchemy.url', get_db_url())

alembic/env.py alembicrepo/env.py

@@ -1094,8 +1094,20 @@ def analyse_new_build(self, build):
             self.exe_total_read = 0
 
             self.exe_sha256 = hashlib.sha256()
-            self.last_bytes = None
             self.game_version = ''
+
+            version_file = os.path.join(game_dir, 'VERSION.txt')
+            if os.path.isfile(version_file):
+                file_content = None
+                with open(version_file, 'r', encoding='utf8') as read_file:
+                    file_content = read_file.read(1024)
+                if file_content is not None:
+                    match = re.search(r'commit sha: (?P<commitsha>\S+)', file_content)
+                    if match:
+                        commit_sha = match.group('commitsha')
+                        if len(commit_sha) >= 7:
+                            self.game_version = commit_sha[:7]
+
             self.opened_exe = open(self.exe_path, 'rb')
 
             def timeout():
@@ -1143,22 +1155,9 @@ def timeout():
                     update_group_box.post_extraction()
 
                 else:
-                    last_frame = bytes
-                    if self.last_bytes is not None:
-                        last_frame = self.last_bytes + last_frame
-
-                    match = re.search(
-                        b'(?P<version>[01]\\.[A-F](-\\d+-g[0-9a-f]+)?)\\x00',
-                        last_frame)
-                    if match is not None:
-                        game_version = match.group('version').decode('ascii')
-                        if len(game_version) > len(self.game_version):
-                            self.game_version = game_version
-
                     self.exe_total_read += len(bytes)
                     self.reading_progress_bar.setValue(self.exe_total_read)
                     self.exe_sha256.update(bytes)
-                    self.last_bytes = bytes
 
             timer.timeout.connect(timeout)
             timer.start(0)

alembic/script.py.mako alembicrepo/script.py.mako

@@ -2,7 +2,8 @@
 #define MyAppVersion FileRead(FileOpen("cddagl\VERSION"))
 #define MyAppPublisher "Rémy Roy"
 #define MyAppURL "https://github.com/remyroy/CDDA-Game-Launcher"
-#define MyAppExeName "launcher.exe"
+#define MyExecutable "Launcher.bat"
+#define MyIcon "cddagl\resources\launcher.ico"
 
 
 [Setup]
@@ -32,7 +33,7 @@ LicenseFile=LICENSE
 
 ;;;; Installer Icon, Filename & Path
 UninstallDisplayIcon={uninstallexe}
-SetupIconFile=cddagl\resources\launcher.ico
+SetupIconFile={#MyIcon}
 OutputDir=dist\innosetup
 OutputBaseFilename=cddagl_installer_v{#SetupSetting("AppVersion")}
 
@@ -72,16 +73,16 @@ Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{
 
 
 [Files]
-Source: "dist\launcher\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
+Source: "build\archive\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
 
 
 [Icons]
-Name: "{autoprograms}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"
-Name: "{autodesktop}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"; Tasks: desktopicon
+Name: "{autoprograms}\{#MyAppName}"; Filename: "{app}\{#MyExecutable}"; IconFilename: "{app}\{#MyIcon}"
+Name: "{autodesktop}\{#MyAppName}"; Filename: "{app}\{#MyExecutable}"; IconFilename: "{app}\{#MyIcon}"; Tasks: desktopicon
 
 
 [Run]
-Filename: "{app}\{#MyAppExeName}"; Description: "{cm:LaunchProgram,{#StringChange(MyAppName, '&', '&&')}}"; Flags: nowait postinstall skipifsilent
+Filename: "{app}\{#MyExecutable}"; Description: "{cm:LaunchProgram,{#StringChange(MyAppName, '&', '&&')}}"; Flags: nowait postinstall skipifsilent
 
 
 [Code]

alembic/versions/0e35fff276f3_stable_versions.py alembicrepo/versions/0e35fff276f3_stable_versions.py

@@ -1,14 +1,11 @@
 SQLAlchemy
 alembic
 PyQt5
-html5lib
-cssselect
 arrow
 rarfile
 Babel
 pywinutils
 markdown2
 Werkzeug
 
-lxml
 pylzma

alembic/versions/402ce1583e3f_initial_config_model.py alembicrepo/versions/402ce1583e3f_initial_config_model.py

@@ -116,7 +116,6 @@ def run(self):
         download_path.mkdir(parents=True, exist_ok=True)
 
         # Download Python embeddable package
-
         python_embed_url = 'https://www.python.org/ftp/python/3.9.5/python-3.9.5-embed-amd64.zip'
         python_embed_name = 'python-3.9.5-embed-amd64.zip'
 
@@ -143,10 +142,22 @@ def run(self):
         with ZipFile(python_embed_archive, 'r') as zip_file:
             zip_file.extractall(archive_dir_path)
 
+        # Add mo files for localization
+        self.run_other_command('compile_catalog')
+
         # Copy package into archive dir
         archive_package_path = archive_dir_path.joinpath('cddagl')
         shutil.copytree(src_package_path, archive_package_path)
 
+        # Additional directories
+        src_data_path = Path('data')
+        target_data_path = archive_dir_path.joinpath('data')
+        shutil.copytree(src_data_path, target_data_path)
+
+        src_alembicrepo_path = Path('alembicrepo')
+        target_alembicrepo_path = archive_dir_path.joinpath('alembicrepo')
+        shutil.copytree(src_alembicrepo_path, target_alembicrepo_path)
+
         include_requirements(archive_dir_path)
 
         # Move pywin32_system32 dlls into archive root
@@ -158,6 +169,36 @@ def run(self):
 
         shutil.rmtree(pywin32_system32_path)
 
+        # Let's find and add unrar if available
+        try:
+            unrar_path = check_output(['where', 'unrar.exe'], stderr=DEVNULL)
+            unrar_path = unrar_path.strip().decode('cp437')
+            shutil.copy(unrar_path, archive_dir_path)
+        except CalledProcessError:
+            log("'unrar.exe' couldn't be found.")
+        
+        # Remove unneeded files in archive
+        paths_to_remove = [
+            ['bin'],
+            ['adodbapi'],
+            ['pythonwin'],
+            ['PyQt5', 'Qt5', 'qml']
+        ]
+        for path in paths_to_remove:
+            target_path = archive_dir_path.joinpath(*path)
+            if target_path.is_dir():
+                shutil.rmtree(target_path)
+        
+        # Create batch file for starting the launcher easily
+        batch_file_path = archive_dir_path.joinpath('Launcher.bat')
+        with open(batch_file_path, 'w', encoding='utf8') as batch_file:
+            batch_file.write(
+'''
+@echo off
+start pythonw.exe -m cddagl
+'''
+            )
+
 class FreezeWithPyInstaller(ExtendedCommand):
     description = 'Build CDDAGL with PyInstaller'
     user_options = [
@@ -279,7 +320,7 @@ def run(self):
         #### Make sure we are running Inno Setup from the project directory
         os.chdir(get_setup_dir())
 
-        self.run_other_command('freeze')
+        self.run_other_command('bundle')
         inno_call = [self.compiler, '/cc', 'launcher.iss']
         log(f'executing {inno_call}')
         call(inno_call)