From 9fafba484a420eb6acbc4fa7d92220a621f6e96e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20H=C3=BCsers?= Date: Sun, 9 Jun 2024 21:58:06 +0200 Subject: [PATCH] upgpkg: discord 0.0.55-2: refactor, fix autostart, add deps, use wayland * Slightly refactor PKGBUILD * Fix autostart desktop file * Add optional dependency used in official arch package * Include patcher to allow Krisp noise suppression support * Add install file to inform user about this change * Use Wayland instead of Xwayland in a Wayland session by setting Electron flag `ozone-platform-hint` to auto (default is X11) --- .SRCINFO | 18 ++++--- PKGBUILD | 92 +++++++++++++++++++++++------------ discord-launcher.sh | 30 +++++++++--- discord_arch_electron.install | 19 ++++++++ krisp-patcher.py | 83 +++++++++++++++++++++++++++++++ update-package.sh | 57 ++++++++++++++++++++++ 6 files changed, 252 insertions(+), 47 deletions(-) create mode 100644 discord_arch_electron.install create mode 100644 krisp-patcher.py create mode 100755 update-package.sh diff --git a/.SRCINFO b/.SRCINFO index a9b5877..0fd1275 100644 --- a/.SRCINFO +++ b/.SRCINFO @@ -1,25 +1,29 @@ pkgbase = discord_arch_electron - pkgdesc = Discord (popular voice + video app) using the system provided electron for increased security and performance + pkgdesc = Discord using system provided electron29 for increased security and performance pkgver = 0.0.55 - pkgrel = 1 + pkgrel = 2 url = https://discord.com + install = discord_arch_electron.install arch = any license = custom makedepends = asar + makedepends = curl depends = electron29 depends = libxss + depends = python optdepends = libpulse: Pulseaudio support + optdepends = libappindicator-gtk3: Systray indicator support optdepends = xdg-utils: Open files + optdepends = python-pyelftools: Required for Krisp patcher + optdepends = python-capstone: Required for Krisp patcher provides = discord conflicts = discord options = !strip source = https://dl.discordapp.net/apps/linux/0.0.55/discord-0.0.55.tar.gz source = discord-launcher.sh - source = LICENSE.html::https://discord.com/terms - source = OSS-LICENSES.html::https://discord.com/licenses + source = krisp-patcher.py sha512sums = c12365109cb4db94033fda101073d2a3d6af7bdc9728e025494ee8d44ebf5f27623861879ec38bb7dd88d40de7cddede268e0f5e44bfeb586fc12713a3758c5b - sha512sums = d398351b209cd89432d8e9cebe9122f152484236d8ca4dd91e5679d3853fe2f082625d35a9ac3f450f1f08250736bf3a23db9926311e8271730d884b57d12dbc - sha512sums = SKIP - sha512sums = SKIP + sha512sums = 88d8b7ae7efc4cb7173de1b0a209c3ae844e43685b1c042e6fe993099ce869dc0d072aa6a13bd5e56e2ebdaa2609ae5c90c6c93333ee2ec912e2d74d9c59f42a + sha512sums = 3c1021592fa856f3561072c76b5ee0b5a34a53bc230336e6d36827efb4866c9d801ef7abb24650d3a7210c61dd57f35e2812ae89226fc157cc8d9ffce032155f pkgname = discord_arch_electron diff --git a/PKGBUILD b/PKGBUILD index b0549a7..3b2e72c 100644 --- a/PKGBUILD +++ b/PKGBUILD @@ -1,60 +1,88 @@ # Maintainer: Zoddo # Contributor: Thaodan +# Contributor: Manuel Hüsers # Contributor: huyizheng # Contributor: johnnyapol + # Based off the discord community repo PKGBUILD by Filipe Laíns (FFY00) + _pkgname=discord _electron=electron29 pkgname=${_pkgname}_arch_electron pkgver=0.0.55 -pkgrel=1 -pkgdesc="Discord (popular voice + video app) using the system provided electron for increased security and performance" +pkgrel=2 +pkgdesc="Discord using system provided ${_electron} for increased security and performance" arch=('any') provides=("${_pkgname}") conflicts=("${_pkgname}") url='https://discord.com' license=('custom') -options=(!strip) -depends=("${_electron}" 'libxss') -makedepends=('asar') +options=('!strip') +install="$pkgname.install" +depends=("${_electron}" 'libxss' 'python') +makedepends=('asar' 'curl') optdepends=('libpulse: Pulseaudio support' - 'xdg-utils: Open files') -source=("https://dl.discordapp.net/apps/linux/$pkgver/$_pkgname-$pkgver.tar.gz" + 'libappindicator-gtk3: Systray indicator support' + 'xdg-utils: Open files' + 'python-pyelftools: Required for Krisp patcher' + 'python-capstone: Required for Krisp patcher') +source=("https://dl.discordapp.net/apps/linux/${pkgver}/${_pkgname}-${pkgver}.tar.gz" 'discord-launcher.sh' - 'LICENSE.html::https://discord.com/terms' - 'OSS-LICENSES.html::https://discord.com/licenses') + 'krisp-patcher.py') # original: https://github.com/sersorrel/sys/blob/main/hm/discord/krisp-patcher.py sha512sums=('c12365109cb4db94033fda101073d2a3d6af7bdc9728e025494ee8d44ebf5f27623861879ec38bb7dd88d40de7cddede268e0f5e44bfeb586fc12713a3758c5b' - 'd398351b209cd89432d8e9cebe9122f152484236d8ca4dd91e5679d3853fe2f082625d35a9ac3f450f1f08250736bf3a23db9926311e8271730d884b57d12dbc' - SKIP - SKIP) + '88d8b7ae7efc4cb7173de1b0a209c3ae844e43685b1c042e6fe993099ce869dc0d072aa6a13bd5e56e2ebdaa2609ae5c90c6c93333ee2ec912e2d74d9c59f42a' + '3c1021592fa856f3561072c76b5ee0b5a34a53bc230336e6d36827efb4866c9d801ef7abb24650d3a7210c61dd57f35e2812ae89226fc157cc8d9ffce032155f') prepare() { - sed -i "s|@PKGNAME@|${_pkgname}|;s|@ELECTRON@|${_electron}|" discord-launcher.sh - sed -i "s|Exec=.*|Exec=/usr/bin/$_pkgname|" Discord/discord.desktop + # prepare launcher script + sed -i -e "s|@PKGNAME@|${_pkgname}|" \ + -e "s|@PKGVER@|${pkgver}|" \ + -e "s|@ELECTRON@|${_electron}|" \ + discord-launcher.sh - # HACKS FOR SYSTEM ELECTRON - asar e Discord/resources/app.asar Discord/resources/app - rm Discord/resources/app.asar - sed -i "s|process.resourcesPath|'/usr/share/${_pkgname}/resources'|" Discord/resources/app/app_bootstrap/buildInfo.js - sed -i "s|exeDir,|'/usr/share/pixmaps',|" Discord/resources/app/app_bootstrap/autoStart/linux.js - sed -i -E "s|resourcesPath = _path.+;|resourcesPath = '/usr/share/${_pkgname}/resources';|" Discord/resources/app/common/paths.js - asar p Discord/resources/app Discord/resources/app.asar - rm -rf Discord/resources/app + # fix the .desktop file + sed -i -e "s|Exec=.*|Exec=/usr/bin/${_pkgname}|" ${_pkgname^}/$_pkgname.desktop + + # create the license files + curl -o "${srcdir}/LICENSE.html" https://discord.com/terms + curl -o "${srcdir}/OSS-LICENSES.html" https://discord.com/licenses +} + +build() { + cd "${srcdir}/${_pkgname^}" + + # use system electron + asar e resources/app.asar resources/app + rm resources/app.asar + sed -i -e "s|resourcesPath = _path.*;|resourcesPath = '/usr/share/${_pkgname}/resources';|" resources/app/common/paths.js + sed -i -e "s|process.resourcesPath|'/usr/share/${_pkgname}/resources'|" resources/app/app_bootstrap/buildInfo.js + sed -i -e "/^const appName/d" -e "/^const exePath/d" -e "/^const exeDir/d" -e "/^const iconPath/d" \ + -e "s|^Exec=\${exePath}$|Exec=/usr/bin/${_pkgname}|" \ + -e "s|^Name=\${appName}$|Name=${_pkgname^}|" \ + -e "s|^Icon=\${iconPath}$|Icon=/usr/share/pixmaps/${_pkgname}.png|" \ + resources/app/app_bootstrap/autoStart/linux.js + asar p resources/app resources/app.asar + rm -rf resources/app } package() { - # Install the app - install -d "${pkgdir}/usr/share/${_pkgname}/resources" + # create necessary directories + install -d "${pkgdir}/usr/share/${_pkgname}" - # Copy Relevanat data - cp -r Discord/resources/* "${pkgdir}/usr/share/${_pkgname}/resources/" + # copy relevant data + cp -r ${_pkgname^}/resources "${pkgdir}/usr/share/${_pkgname}/" - install -Dm 755 "${srcdir}/discord-launcher.sh" "${pkgdir}/usr/bin/${_pkgname}" + # intall icon and desktop file + install -Dm 644 ${_pkgname^}/$_pkgname.png "${pkgdir}/usr/share/pixmaps/${_pkgname}.png" + install -Dm 644 ${_pkgname^}/$_pkgname.desktop "${pkgdir}/usr/share/applications/${_pkgname}.desktop" - install -Dm 644 Discord/discord.png "${pkgdir}/usr/share/pixmaps/${_pkgname}.png" - install -Dm 644 Discord/discord.desktop "${pkgdir}/usr/share/applications/${_pkgname}.desktop" + # install the launch script + install -Dm 755 discord-launcher.sh "${pkgdir}/usr/bin/${_pkgname}" - # Licenses - install -Dm 644 LICENSE.html "$pkgdir"/usr/share/licenses/$pkgname/LICENSE.html - install -Dm 644 OSS-LICENSES.html "$pkgdir"/usr/share/licenses/$pkgname/OSS-LICENSES.html + # install krisp patcher + install -Dm 644 krisp-patcher.py "${pkgdir}/usr/share/${_pkgname}/" + + # install licenses + install -Dm 644 LICENSE.html "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE.html" + install -Dm 644 OSS-LICENSES.html "${pkgdir}/usr/share/licenses/${pkgname}/OSS-LICENSES.html" } diff --git a/discord-launcher.sh b/discord-launcher.sh index 6e6f47e..e7652df 100755 --- a/discord-launcher.sh +++ b/discord-launcher.sh @@ -1,21 +1,35 @@ -#!/usr/bin/bash +#!/usr/bin/env bash set -euo pipefail name=@PKGNAME@ +ver=@PKGVER@ electron=@ELECTRON@ -flags_file="${XDG_CONFIG_HOME:-$HOME/.config}/${name}-flags.conf" declare -a flags +declare -l PATCH_KRISP -if [[ -f "${flags_file}" ]]; then - mapfile -t < "${flags_file}" +[[ -r "${XDG_CONFIG_HOME:-$HOME/.config}/${name}.conf" ]] && source "${XDG_CONFIG_HOME:-$HOME/.config}/${name}.conf" + +flags_file="${XDG_CONFIG_HOME:-$HOME/.config}/${name}-flags.conf" +krisp_bin="${DISCORD_USER_DATA_DIR:-${XDG_CONFIG_HOME:-$HOME/.config}/${name}}/${ver}/modules/${name}_krisp/${name}_krisp.node" + +if [[ "${PATCH_KRISP}" == true ]] && [[ -w "${krisp_bin}" ]] && python -c "import capstone; import elftools" &> /dev/null; then + # Patch Krisp binary to ignore signature check + python /usr/share/${name}/krisp-patcher.py "${krisp_bin}" +fi + +if [[ -r "${flags_file}" ]]; then + mapfile -t < "${flags_file}" fi for line in "${MAPFILE[@]}"; do - if [[ ! "${line}" =~ ^[[:space:]]*#.* ]] && [[ -n "${line}" ]]; then - flags+=("${line}") - fi + if [[ ! "${line}" =~ ^[[:space:]]*#.* ]] && [[ -n "${line}" ]]; then + flags+=("${line}") + fi done -exec /usr/bin/${electron} /usr/share/${name}/resources/app.asar "${flags[@]}" "$@" +exec /usr/bin/${electron} \ + /usr/share/${name}/resources/app.asar \ + --ozone-platform-hint=auto \ + "${flags[@]}" "$@" diff --git a/discord_arch_electron.install b/discord_arch_electron.install new file mode 100644 index 0000000..f400a05 --- /dev/null +++ b/discord_arch_electron.install @@ -0,0 +1,19 @@ +post_upgrade() { + # return if old package version is greater than or equal to 0.0.55-2... + (( $(vercmp $2 '0.0.55-2') >= 0 )) && return + + cat < In order to patch Krisp noise suppression support set 'PATCH_KRISP=true' + in '~/.config/discord.conf' and install the necessary optional dependencies. +EOF +} + +post_install() { + cat < For Krisp noise suppression support consider installing the necessary optional + dependencies and setting 'PATCH_KRISP=true' in '~/.config/discord.conf'. + Restart your Discord client afterwards to apply the patch. +==> In case of performance problems consider setting additional flags + in '~/.config/discord-flags.conf'. +EOF +} diff --git a/krisp-patcher.py b/krisp-patcher.py new file mode 100644 index 0000000..5597290 --- /dev/null +++ b/krisp-patcher.py @@ -0,0 +1,83 @@ +import sys +import shutil + +from elftools.elf.elffile import ELFFile +from capstone import * +from capstone.x86 import * + +if len(sys.argv) < 2: + print(f"Usage: {sys.argv[0]} [path to discord_krisp.node]") + # "Unix programs generally use 2 for command line syntax errors and 1 for all other kind of errors." + sys.exit(2) + +executable = sys.argv[1] + +elf = ELFFile(open(executable, "rb")) +symtab = elf.get_section_by_name('.symtab') + +krisp_initialize_address = symtab.get_symbol_by_name("_ZN7discord15KrispInitializeEv")[0].entry.st_value +isSignedByDiscord_address = symtab.get_symbol_by_name("_ZN7discord4util17IsSignedByDiscordERKNSt4__Cr12basic_stringIcNS1_11char_traitsIcEENS1_9allocatorIcEEEE")[0].entry.st_value + +text = elf.get_section_by_name('.text') +text_start = text['sh_addr'] +text_start_file = text['sh_offset'] +# This seems to always be zero (.text starts at the right offset in the file). Do it just in case? +address_to_file = text_start_file - text_start + +# Done with the ELF now. +# elf.close() + +krisp_initialize_offset = krisp_initialize_address - address_to_file +isSignedByDiscord_offset = krisp_initialize_address - address_to_file + +f = open(executable, "rb") +f.seek(krisp_initialize_offset) +krisp_initialize = f.read(64) +f.close() + +# States +found_issigned_by_discord_call = False +found_issigned_by_discord_test = False +found_issigned_by_discord_je = False +found_already_patched = False +je_location = None + +# We are looking for a call to IsSignedByDiscord, followed by a test, followed by a je. +# Then we patch the je into a two byte nop. + +md = Cs(CS_ARCH_X86, CS_MODE_64) +md.detail = True +for i in md.disasm(krisp_initialize, krisp_initialize_address): + if i.id == X86_INS_CALL: + if i.operands[0].type == X86_OP_IMM: + if i.operands[0].imm == isSignedByDiscord_address: + found_issigned_by_discord_call = True + + if i.id == X86_INS_TEST: + if found_issigned_by_discord_call: + found_issigned_by_discord_test = True + + if i.id == X86_INS_JE: + if found_issigned_by_discord_test: + found_issigned_by_discord_je = True + je_location = i.address + break + + if i.id == X86_INS_NOP: + if found_issigned_by_discord_test: + found_already_patched = True + break + +if je_location: + print(f"Found patch location: 0x{je_location:x}") + + shutil.copyfile(executable, executable + ".orig") + f = open(executable, 'rb+') + f.seek(je_location - address_to_file) + f.write(b'\x66\x90') # Two byte NOP + f.close() +else: + if found_already_patched: + print("Couldn't find patch location - already patched.") + else: + print("Couldn't find patch location - review manually. Sorry.") diff --git a/update-package.sh b/update-package.sh new file mode 100755 index 0000000..90cdc1e --- /dev/null +++ b/update-package.sh @@ -0,0 +1,57 @@ +#!/usr/bin/env bash + +set -euo pipefail + +readonly all_off="$(tput sgr0)" +readonly bold="${all_off}$(tput bold)" +readonly white="${bold}$(tput setaf 7)" +readonly blue="${bold}$(tput setaf 4)" +readonly red="${bold}$(tput setaf 1)" + +msg() { + printf "${blue}::${white} $1${all_off}\n" +} + +error() { + printf "${red}::${white} $1${all_off}\n" +} + +msgbegin() { + printf "${blue}::${white} $1" +} + +msgend() { + printf "$1${all_off}\n" +} + + +readonly krisp_zip='discord_krisp-1.zip' +readonly krisp_bin='discord_krisp.node' + +# head to directory of this script +cd $(dirname "$0") + +# update package to version used in PKGBUILD +source PKGBUILD + +msg "Running updpkgsums (Updating checksums)" +updpkgsums + +msg "Running mksrcinfo (Updating SRCINFO file)" +makepkg --printsrcinfo > .SRCINFO + +msg "Getting Krisp module" +curl -O "https://dl.discordapp.net/apps/linux/${_pkgver:-${pkgver}}/modules/${krisp_zip}" +unzip "${krisp_zip}" "${krisp_bin}" + +msg "Checking if Krisp module is patchable (watch output)" +python krisp-patcher.py "${krisp_bin}" + +#msg "Updating Krisp module checksum" +#readonly chcksm=$(b2sum "${krisp_bin}.orig" | head -c 128) +#sed -i "s/^_krisp_b2sum='.*'$/_krisp_b2sum='${chcksm}'/" PKGBUILD + +msgbegin "Cleaning up... " +rm -f "${krisp_zip}" "${krisp_bin}" "${krisp_bin}.orig" + +msgend "Done"