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
|
#!/usr/bin/env python3
# COPYRIGHT (C) 2021-2024 Nicotine+ Contributors
#
# GNU GENERAL PUBLIC LICENSE
# Version 3, 29 June 2007
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import glob
import os
import platform
import ssl
import subprocess
import sys
import tempfile
from cx_Freeze import Executable, setup # pylint: disable=import-error
from cx_Freeze.hooks import gi # pylint: disable=import-error
del gi.load_gi
# pylint: disable=duplicate-code
if sys.platform == "win32":
GUI_BASE = "Win32GUI"
SYS_BASE_PATH = sys.prefix
LIB_PATH = os.path.join(SYS_BASE_PATH, "bin")
LIB_EXTENSION = ".dll"
UNAVAILABLE_MODULES = [
"fcntl", "grp", "nis", "ossaudiodev", "posix", "pwd", "readline", "resource", "spwd", "syslog", "termios"
]
ICON_NAME = "icon.ico"
elif sys.platform == "darwin":
GUI_BASE = None
SYS_BASE_PATH = "/opt/homebrew" if platform.machine() == "arm64" else "/usr/local"
LIB_PATH = os.path.join(SYS_BASE_PATH, "lib")
LIB_EXTENSION = (".dylib", ".so")
UNAVAILABLE_MODULES = ["msvcrt", "nt", "nturl2path", "ossaudiodev", "spwd", "winreg", "winsound"]
ICON_NAME = "icon.icns"
else:
raise RuntimeError("Only Windows and macOS are supported")
TEMP_PATH = tempfile.mkdtemp()
CURRENT_PATH = os.path.dirname(os.path.abspath(__file__))
BUILD_PATH = os.path.join(CURRENT_PATH, "build")
PROJECT_PATH = os.path.abspath(os.path.join(CURRENT_PATH, "..", ".."))
sys.path.insert(0, PROJECT_PATH)
import pynicotine # noqa: E402 # pylint: disable=import-error,wrong-import-position
SCRIPT_NAME = "nicotine"
MODULE_NAME = "pynicotine"
MANIFEST_NAME = os.path.join(CURRENT_PATH, f"{SCRIPT_NAME}.manifest") if sys.platform == "win32" else None
# Include (almost) all standard library modules for plugins
EXCLUDED_MODULES = UNAVAILABLE_MODULES + [
f"{MODULE_NAME}.plugins.examplars", f"{MODULE_NAME}.tests",
"ctypes.test", "distutils", "ensurepip", "idlelib", "lib2to3", "msilib", "pip", "pydoc", "pydoc_data",
"pygtkcompat", "tkinter", "turtle", "turtledemo", "unittest.test", "venv", "zoneinfo"
]
INCLUDED_MODULES = [MODULE_NAME, "gi"] + list(
# pylint: disable=no-member
{module for module in sys.stdlib_module_names if not module.startswith("_")}.difference(EXCLUDED_MODULES)
)
include_files = []
def process_files(folder_path, callback, callback_data=None, starts_with=None, ends_with=None, recursive=False):
for full_path in glob.glob(os.path.join(folder_path, "**"), recursive=recursive):
short_path = os.path.relpath(full_path, folder_path)
if starts_with and not short_path.startswith(starts_with):
continue
if ends_with and not short_path.endswith(ends_with):
continue
callback(full_path, short_path, callback_data)
def add_file(file_path, output_path):
include_files.append((file_path, output_path))
def _add_files_callback(full_path, short_path, output_path):
add_file(full_path, os.path.join(output_path, short_path))
def add_files(folder_path, output_path, starts_with=None, ends_with=None, recursive=False):
process_files(
folder_path, _add_files_callback, callback_data=output_path,
starts_with=starts_with, ends_with=ends_with, recursive=recursive
)
def add_pixbuf_loaders():
loaders_file = "lib/gdk-pixbuf-2.0/2.10.0/loaders.cache"
temp_loaders_file = os.path.join(TEMP_PATH, "loaders.cache")
with open(temp_loaders_file, "w", encoding="utf-8") as temp_file_handle, \
open(os.path.join(SYS_BASE_PATH, loaders_file), "r", encoding="utf-8") as real_file_handle:
data = real_file_handle.read()
if sys.platform == "win32":
data = data.replace("lib\\\\gdk-pixbuf-2.0\\\\2.10.0\\\\loaders", "lib")
elif sys.platform == "darwin":
data = data.replace(
os.path.join(SYS_BASE_PATH, "lib/gdk-pixbuf-2.0/2.10.0/loaders"), "@executable_path/lib")
temp_file_handle.write(data)
add_file(file_path=temp_loaders_file, output_path="lib/pixbuf-loaders.cache")
add_files(
folder_path=os.path.join(SYS_BASE_PATH, "lib/gdk-pixbuf-2.0/2.10.0/loaders"), output_path="lib",
ends_with=LIB_EXTENSION
)
def _add_typelibs_callback(full_path, short_path, _callback_data=None):
from xml.etree import ElementTree
ElementTree.register_namespace("", "http://www.gtk.org/introspection/core/1.0")
ElementTree.register_namespace("c", "http://www.gtk.org/introspection/c/1.0")
ElementTree.register_namespace("glib", "http://www.gtk.org/introspection/glib/1.0")
temp_file_gir = os.path.join(TEMP_PATH, short_path)
temp_file_typelib = os.path.join(TEMP_PATH, short_path.replace(".gir", ".typelib"))
with open(temp_file_gir, "w", encoding="utf-8") as temp_file_handle, \
open(full_path, "r", encoding="utf-8") as real_file_handle:
xml = ElementTree.fromstring(real_file_handle.read())
for namespace in xml.findall(".//{*}namespace[@shared-library]"):
paths = []
for path in namespace.attrib["shared-library"].split(","):
updated_path = os.path.join("@loader_path", os.path.basename(path))
paths.append(updated_path)
namespace.attrib["shared-library"] = ",".join(paths)
data = ElementTree.tostring(xml, encoding="unicode")
temp_file_handle.write(data)
subprocess.check_call(["g-ir-compiler", f"--output={temp_file_typelib}", temp_file_gir])
def add_typelibs():
required_typelibs = [
"Adw-",
"Gtk-4",
"Gio-",
"Gdk-4",
"GLib-",
"Graphene-",
"Gsk-",
"HarfBuzz-",
"Pango-",
"PangoCairo-",
"GObject-",
"GdkPixbuf-",
"cairo-",
"GModule-",
"freetype2-"
]
if sys.platform == "win32":
required_typelibs.append("GdkWin32-4")
required_typelibs.append("win32-")
required_typelibs = tuple(required_typelibs)
folder_path = os.path.join(SYS_BASE_PATH, "lib/girepository-1.0")
if sys.platform == "darwin":
# Remove absolute paths added by Homebrew (macOS)
process_files(
folder_path=os.path.join(SYS_BASE_PATH, "share/gir-1.0"),
callback=_add_typelibs_callback, starts_with=required_typelibs, ends_with=".gir"
)
folder_path = TEMP_PATH
add_files(
folder_path=folder_path, output_path="lib/typelibs",
starts_with=required_typelibs, ends_with=".typelib"
)
def add_gtk():
# Libraries
if sys.platform == "win32":
add_file(
file_path=os.path.join(LIB_PATH, "libgtk-4-1.dll"),
output_path="lib/libgtk-4-1.dll"
)
add_file(
file_path=os.path.join(LIB_PATH, "libadwaita-1-0.dll"),
output_path="lib/libadwaita-1-0.dll"
)
# gdbus required for single-instance application (Windows)
add_file(file_path=os.path.join(LIB_PATH, "gdbus.exe"), output_path="lib/gdbus.exe")
elif sys.platform == "darwin":
add_file(
file_path=os.path.join(LIB_PATH, "libgtk-4.1.dylib"),
output_path="lib/libgtk-4.1.dylib"
)
add_file(
file_path=os.path.join(LIB_PATH, "libadwaita-1.0.dylib"),
output_path="lib/libadwaita-1.0.dylib"
)
# Schemas
add_file(
file_path=os.path.join(SYS_BASE_PATH, "share/glib-2.0/schemas/gschemas.compiled"),
output_path="lib/schemas/gschemas.compiled"
)
# Fontconfig
add_files(
folder_path=os.path.join(SYS_BASE_PATH, "etc/fonts"), output_path="share/fonts",
ends_with=".conf", recursive=True
)
# Pixbuf loaders
add_pixbuf_loaders()
# Typelibs
add_typelibs()
def add_ssl_certs():
ssl_paths = ssl.get_default_verify_paths()
add_file(file_path=ssl_paths.openssl_cafile, output_path="lib/cert.pem")
def add_translations():
from setup import build_translations # noqa: E402 # pylint: disable=import-self,no-name-in-module
build_translations()
add_files(
folder_path=os.path.join(SYS_BASE_PATH, "share/locale"), output_path="share/locale",
starts_with=tuple(i[0] for i in pynicotine.i18n.LANGUAGES), ends_with="gtk40.mo", recursive=True
)
# GTK
add_gtk()
# SSL
add_ssl_certs()
# Translations
add_translations()
# Setup
setup(
name=pynicotine.__application_name__,
description=pynicotine.__application_name__,
author=pynicotine.__author__,
version=pynicotine.__version__,
options={
"build": {
"build_base": BUILD_PATH
},
"build_exe": {
"build_exe": os.path.join(BUILD_PATH, "package", pynicotine.__application_name__),
"packages": INCLUDED_MODULES,
"excludes": EXCLUDED_MODULES,
"include_files": include_files,
"zip_include_packages": ["*"],
"zip_exclude_packages": [MODULE_NAME],
"optimize": 2
},
"bdist_msi": {
"all_users": True,
"dist_dir": BUILD_PATH,
"install_icon": os.path.join(CURRENT_PATH, ICON_NAME),
"upgrade_code": "{8ffb9dbb-7106-41fc-9e8a-b2469aa1fe9f}"
},
"bdist_mac": {
"bundle_name": pynicotine.__application_name__,
"iconfile": os.path.join(CURRENT_PATH, ICON_NAME),
"plist_items": [
("CFBundleName", pynicotine.__application_name__),
("CFBundleIdentifier", pynicotine.__application_id__),
("CFBundleShortVersionString", pynicotine.__version__),
("CFBundleVersion", pynicotine.__version__),
("CFBundleInfoDictionaryVersion", "6.0"),
("NSHumanReadableCopyright", pynicotine.__copyright__)
],
"codesign_identity": "-",
"codesign_deep": True,
"codesign_entitlements": os.path.join(CURRENT_PATH, "codesign-entitlements.plist"),
"codesign_options": "runtime",
"codesign_strict": "all",
"codesign_timestamp": True,
"codesign_verify": True
},
"bdist_dmg": {
"applications_shortcut": True
}
},
data_files=[],
packages=[],
executables=[
Executable(
script=os.path.join(PROJECT_PATH, SCRIPT_NAME),
base=GUI_BASE,
target_name=pynicotine.__application_name__,
icon=os.path.join(CURRENT_PATH, ICON_NAME),
manifest=MANIFEST_NAME,
copyright=pynicotine.__copyright__,
shortcut_name=pynicotine.__application_name__,
shortcut_dir="ProgramMenuFolder"
)
],
)
|