1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
|
"""
PC-BASIC - make.windows
Windows packaging
(c) 2015--2023 Rob Hagemans
This file is released under the GNU GPL version 3 or later.
"""
import os
import distutils
import msilib
import shutil
import cx_Freeze
from cx_Freeze import Executable
from .common import NAME, VERSION, AUTHOR, COPYRIGHT
from .common import build_icon, prune, remove, mkdir, make_ready
from .common import RESOURCE_PATH
from .freeze import SETUP_OPTIONS, SHORT_VERSION, EXCLUDE_EXTERNAL_PACKAGES, PLATFORM_TAG
UPGRADE_CODE = '{714d23a9-aa94-4b17-87a5-90e72d0c5b8f}'
PRODUCT_CODE = msilib.gen_uuid()
class BuildExeCommand(cx_Freeze.build_exe):
"""Custom build_exe command."""
def run(self):
"""Run build_exe command."""
mkdir(RESOURCE_PATH)
build_icon()
# only include 32-bit DLLs
cx_Freeze.build_exe.run(self)
build_dir = 'build/exe.{}/'.format(PLATFORM_TAG)
# build_exe just includes everything inside the directory
# so remove some stuff we don't need
for root, _, files in os.walk(build_dir + 'lib'):
testing = set(root.split(os.sep)) & set(('test', 'tests', 'testing', 'examples'))
for fname in files:
name = os.path.join(root, fname)
if (
# remove superfluous copies of python dll in lib/
# as there is a copy in the package root already
fname.lower() == 'python37.dll'
# remove tests and examples
or testing
# we're only producing packages for win32_x86
or 'win32_x64' in name or name.endswith('.dylib')
):
remove(name)
# chunky libs on python3.7 that I don't think we use
remove(build_dir + 'lib/libcrypto-1_1.dll')
remove(build_dir + 'lib/libssl-1_1.dll')
# unneeded sdl2 bits
remove(build_dir + 'lib/sdl2dll/dll/SDL2_image.dll')
remove(build_dir + 'lib/sdl2dll/dll/SDL2_mixer.dll')
remove(build_dir + 'lib/sdl2dll/dll/SDL2_ttf.dll')
remove(build_dir + 'lib/sdl2dll/dll/libwebp-7.dll')
remove(build_dir + 'lib/sdl2dll/dll/libtiff-5.dll')
remove(build_dir + 'lib/sdl2dll/dll/libopus-0.dll')
remove(build_dir + 'lib/sdl2dll/dll/libopusfile-0.dll')
remove(build_dir + 'lib/sdl2dll/dll/libogg-0.dll')
remove(build_dir + 'lib/sdl2dll/dll/libmodplug-1.dll')
# add msvcr - we can't count on cx_freeze to do it even with include_msvcr=True set
shutil.copy('c:/windows/system32/vcruntime140.dll', build_dir)
class BdistMsiCommand(cx_Freeze.bdist_msi):
"""Custom bdist_msi command."""
def run(self):
"""Run build_msi command."""
name = '{}-{}'.format(NAME, VERSION)
remove('dist/{}.msi'.format(name))
cx_Freeze.bdist_msi.run(self)
# close the database file so we can rename the file
del self.db
os.rename('dist/{}-win32.msi'.format(name), 'dist/{}.msi'.format(name))
#make_clean()
def add_config(self):
"""Override cx_Freeze add_config."""
# mostly copy-paste from cxfreeze source, wich some changes
if self.directories:
msilib.add_data(self.db, "Directory", self.directories)
msilib.add_data(
self.db, 'CustomAction',
[("A_SET_TARGET_DIR", 256 + 51, "TARGETDIR", self.initial_target_dir)]
)
if self.add_to_path:
msilib.add_data(
self.db, 'Environment', [("E_PATH", "=-*Path", r"[~];[TARGETDIR]", "TARGETDIR")]
)
msilib.add_data(self.db, 'InstallUISequence', [
("PrepareDlg", None, 140),
# this is new
# sould probably be conditional on "not already installed" or smth
("WhichUsersDlg", "not Installed", 400),
("A_SET_TARGET_DIR", 'TARGETDIR=""', 401),
("SelectDirectoryDlg", "not Installed", 1230),
("MaintenanceTypeDlg", "Installed and not Resume and not Preselected", 1250),
("ProgressDlg", None, 1280),
])
msilib.add_data(self.db, 'InstallExecuteSequence', [
("A_SET_TARGET_DIR", 'TARGETDIR=""', 401),
('WriteEnvironmentStrings', 'MSIINSTALLPERUSER=""', 5200),
])
for index, executable in enumerate(self.distribution.executables):
if executable.shortcut_name is not None and executable.shortcut_dir is not None:
base_name = os.path.basename(executable.target_name)
msilib.add_data(
self.db, "Shortcut", [(
"S_APP_%s" % index, executable.shortcut_dir, executable.shortcut_name,
"TARGETDIR", "[TARGETDIR]%s" % base_name,
None, None, None, None, None, None, None
)]
)
for table_name, data in self.data.items():
col = self._binary_columns.get(table_name)
if col is not None:
data = [
(*row[:col], msilib.Binary(row[col].name), *row[col + 1 :])
for row in data
]
msilib.add_data(self.db, table_name, data)
def add_properties(self):
"""Override cx_Freeze add_properties."""
# mostly copy-paste from cxfreeze
metadata = self.distribution.metadata
props = [
('DistVersion', metadata.get_version()),
('DefaultUIFont', 'DlgFont8'),
('ErrorDialog', 'ErrorDlg'),
('Progress1', 'Install'),
('Progress2', 'installs'),
('MaintenanceForm_Action', 'Repair'),
('ALLUSERS', '2'),
('MSIINSTALLPERUSER', '1'),
]
email = metadata.author_email or metadata.maintainer_email
if email:
props.append(("ARPCONTACT", email))
if metadata.url:
props.append(("ARPURLINFOABOUT", metadata.url))
if self.upgrade_code is not None:
props.append(("UpgradeCode", self.upgrade_code))
msilib.add_data(self.db, 'Property', props)
def _add_whichusers_dialog(self):
"""Per-user or per-machine install dialog."""
# based on dialog from cpython 2.7 source code
# https://svn.python.org/projects/python/trunk/Tools/msi/msi.py
whichusers = cx_Freeze.command.bdist_msi.PyDialog(
self.db, "WhichUsersDlg", self.x, self.y, self.width, self.height,
self.modal, self.title, "AdminInstall", "Next", "Cancel"
)
whichusers.title(
"Select for which users to install [ProductName]."
)
# A radio group with two options: allusers, justme
radio = whichusers.radiogroup(
"AdminInstall", 135, 60, 235, 80, 3, "WhichUsers", "", "Next"
)
radio.condition("Disable", "VersionNT=600") # Not available on Vista and Windows 2008
radio.add("ALL", 0, 5, 150, 20, "Install for all users")
radio.add("JUSTME", 0, 25, 235, 20, "Install just for me")
whichusers.backbutton("Back", None, active=0)
button = whichusers.nextbutton("Next >", "Cancel")
# SetProperty events
# https://docs.microsoft.com/en-us/windows/desktop/Msi/setproperty-controlevent
button.event("[MSIINSTALLPERUSER]", "{}", 'WhichUsers="ALL"', 1)
button.event("[MSIINSTALLPERUSER]", "1", 'WhichUsers="JUSTME"', 1)
# set the target dir to the default location for per-user/per-machine installs
button.event(
"[TARGETDIR]",
"[ProgramFilesFolder]\\%s %s" % (NAME, SHORT_VERSION),
'WhichUsers="JUSTME"', 1
)
button.event("EndDialog", "Return", 3)
button = whichusers.cancelbutton("Cancel", "AdminInstall")
button.event("SpawnDialog", "CancelDlg")
def add_ui(self):
self._add_whichusers_dialog()
cx_Freeze.bdist_msi.add_ui(self)
def package():
"""Build a Windows .MSI package."""
setup_options = SETUP_OPTIONS
make_ready()
# remove the WriteEnvironmentStrings action from the default list
# since cx_Freeze picks up the default list and puts it into the MSI
# but we can't have environment changes for per-user installs (?)
sequence = msilib.sequence.InstallExecuteSequence
for index, info in enumerate(sequence):
if info[0] == u'WriteEnvironmentStrings':
break
del sequence[index]
# setup commands
setup_options['cmdclass'] = dict(
build_exe=BuildExeCommand,
bdist_msi=BdistMsiCommand,
)
numversion = '.'.join(v for v in VERSION.split('.') if v.isdigit())
# these must be bytes for cx_Freeze bdist_msi
setup_options['name'] = NAME
setup_options['author'] = AUTHOR
setup_options['version'] = numversion
# compile separately, as they end up in the wrong place anyway
setup_options['ext_modules'] = []
# gui launcher
setup_options['entry_points']['gui_scripts'] = ['pcbasicw=pcbasic:main']
directory_table = [
(
'StartMenuFolder',
'TARGETDIR',
'.',
),
(
'MyProgramMenu',
'StartMenuFolder',
'PCBASI~1|PC-BASIC {}'.format(SHORT_VERSION),
),
]
# https://stackoverflow.com/questions/15734703/use-cx-freeze-to-create-an-msi-that-adds-a-shortcut-to-the-desktop#15736406
shortcut_table = [
(
'ProgramShortcut', # Shortcut
'MyProgramMenu', # Directory_
'PC-BASIC %s' % VERSION, # Name
'TARGETDIR', # Component_
'[TARGETDIR]pcbasicw.exe',# Target
None, # Arguments
None, # Description
None, # Hotkey
None, # Icon
None, # IconIndex
None, # ShowCmd
# PersonalFolder is My Documents, use as Start In folder
'PersonalFolder' # WkDir
),
(
'DocShortcut', # Shortcut
'MyProgramMenu', # Directory_
'Documentation', # Name
'TARGETDIR', # Component_
'[TARGETDIR]PC-BASIC_documentation.html', # Target
None, # Arguments
None, # Description
None, # Hotkey
None, # Icon
None, # IconIndex
None, # ShowCmd
'TARGETDIR' # WkDir
),
(
'SettingsShortcut', # Shortcut
'MyProgramMenu', # Directory_
'Settings', # Name
'TARGETDIR', # Component_
'[AppDataFolder]pcbasic-{}\\PCBASIC.INI'.format(SHORT_VERSION), # Target
None, # Arguments
None, # Description
None, # Hotkey
None, # Icon
None, # IconIndex
None, # ShowCmd
'TARGETDIR' # WkDir
),
(
'UninstallShortcut', # Shortcut
'MyProgramMenu', # Directory_
'Uninstall', # Name
'TARGETDIR', # Component_
'[SystemFolder]msiexec.exe', # Target
'/x %s' % PRODUCT_CODE, # Arguments
None, # Description
None, # Hotkey
None, # Icon
None, # IconIndex
None, # ShowCmd
# PersonalFolder is My Documents, use as Start In folder
'TARGETDIR' # WkDir
),
]
msi_data = {
'Directory': directory_table,
'Shortcut': shortcut_table,
'Icon': [('PC-BASIC-Icon', msilib.Binary('./build/resources/pcbasic.ico')),],
'Property': [('ARPPRODUCTICON', 'PC-BASIC-Icon'),],
}
# cx_Freeze options
setup_options['options'] = {
'build_exe': {
'excludes': EXCLUDE_EXTERNAL_PACKAGES,
'include_files': ['build/doc/PC-BASIC_documentation.html'],
# optimize removes:
# - asserts (which we don't have as only in th eomitted tests package)
# - docstrings (which we may be using in error messages)
#'optimize': 2,
},
'bdist_msi': {
'data': msi_data,
# add console entry points to PATH
'add_to_path': True,
# enforce removal of old versions
'upgrade_code': UPGRADE_CODE,
'product_code': PRODUCT_CODE,
'initial_target_dir': 'c:\\Program Files\\%s %s' % (NAME, SHORT_VERSION),
},
}
setup_options['executables'] = [
Executable(
'run-pcbasic.py', base='Console', targetName='pcbasic.exe', icon='build/resources/pcbasic.ico',
copyright=COPYRIGHT),
Executable(
'run-pcbasic.py', base='Win32GUI', targetName='pcbasicw.exe', icon='build/resources/pcbasic.ico',
#shortcutName='PC-BASIC %s' % VERSION, shortcutDir='MyProgramMenu',
copyright=COPYRIGHT),
]
# call cx_Freeze's setup() with command bdist_msi
cx_Freeze.setup(script_args=['bdist_msi'], **setup_options)
|