Merge branch 'jamulussoftware:main' into master

Author: ignotus666

.editorconfig

@@ -27,3 +27,7 @@ function_next_line = false
 
 [libs/**]
 ignore = true
+
+[*.py]
+# This is the widest that is still PEP-8 compliant
+max_line_length = 99

.github/ISSUE_TEMPLATE/feature_request.md

@@ -14,7 +14,7 @@ assignees: ''
 
 <!--
 List possible approaches with pros and cons, reference any relevant discussion threads if possible, and consider tagging the main participants.
-Please note the contribution guidelines (https://github.com/jamulussoftware/jamulus/blob/master/CONTRIBUTING.md), especially the part about "keeping it simple and stupid".
+Please note the contribution guidelines (https://github.com/jamulussoftware/jamulus/blob/main/CONTRIBUTING.md), especially the part about "keeping it simple and stupid".
 -->
 
 <!-- Describe the solution you'd like -->

.github/autobuild/android.sh

@@ -1,4 +1,29 @@
 #!/bin/bash
+##############################################################################
+# Copyright (c) 2022-2024
+#
+# Author(s):
+#  Christian Hoffmann
+#  The Jamulus Development Team
+#
+##############################################################################
+#
+# 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 2 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+#
+##############################################################################
+
 set -eu
 
 # Some of the following version pinnings are semi-automatically checked for
@@ -7,7 +32,7 @@ COMMANDLINETOOLS_VERSION=6858069
 ANDROID_NDK_VERSION=r21d
 ANDROID_PLATFORM=android-30
 ANDROID_BUILD_TOOLS=30.0.2
-AQTINSTALL_VERSION=3.0.2
+AQTINSTALL_VERSION=3.1.15
 QT_VERSION=5.15.2
 
 # Only variables which are really needed by sub-commands are exported.

.github/autobuild/extractVersionChangelog.pl

@@ -1,4 +1,29 @@
 #!/usr/bin/env perl
+##############################################################################
+# Copyright (c) 2021-2024
+#
+# Author(s):
+#  ann0see
+#  Christian Hoffmann
+#  The Jamulus Development Team
+#
+##############################################################################
+#
+# 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 2 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+#
+##############################################################################
 
 use strict;
 use warnings;

.github/autobuild/get_build_vars.py

@@ -1,9 +1,36 @@
 #!/usr/bin/env python3
-# This script is trigged from the Github Autobuild workflow.
-# It analyzes Jamulus.pro and git push details (tag vs. branch, etc.) to decide
-#   - whether a release should be created,
-#   - whether it is a pre-release, and
-#   - what its title should be.
+##############################################################################
+# Copyright (c) 2022-2024
+#
+# Author(s):
+#  Christian Hoffmann
+#  The Jamulus Development Team
+#
+##############################################################################
+#
+# 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 2 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+#
+##############################################################################
+
+"""
+This script is triggered from the GitHub Autobuild workflow.
+It analyzes Jamulus.pro and git push details (tag vs. branch, etc.) to decide
+  - whether a release should be created,
+  - whether it is a pre-release, and
+  - what its title should be.
+"""
 
 import os
 import re
@@ -15,10 +42,10 @@
 def get_version_from_jamulus_pro():
     with open(REPO_PATH + '/Jamulus.pro', 'r') as f:
         pro_content = f.read()
-    m = re.search(r'^VERSION\s*=\s*(\S+)$', pro_content, re.MULTILINE)
-    if not m:
-        raise Exception("Unable to determine Jamulus.pro VERSION")
-    return m.group(1)
+    matches = re.search(r'^VERSION\s*=\s*(\S+)$', pro_content, re.MULTILINE)
+    if not matches:
+        raise ValueError("Unable to determine Jamulus.pro VERSION")
+    return matches.group(1)
 
 
 def get_git_hash():
@@ -34,26 +61,26 @@ def get_git_hash():
 
 def get_build_version(jamulus_pro_version):
     if "dev" in jamulus_pro_version:
-        version = "{}-{}".format(jamulus_pro_version, get_git_hash())
+        version = f"{jamulus_pro_version}-{get_git_hash()}"
         return 'intermediate', version
 
     version = jamulus_pro_version
     return 'release', version
 
 
 def set_github_variable(varname, varval):
-    print("{}='{}'".format(varname, varval))  # console output
-    outputfile = os.getenv('GITHUB_OUTPUT')
-    with open(outputfile, "a") as ghout:
+    print(f"{varname}='{varval}'")  # console output
+    output_file = os.getenv('GITHUB_OUTPUT')
+    with open(output_file, "a") as ghout:
         ghout.write(f"{varname}={varval}\n")
 
 jamulus_pro_version = get_version_from_jamulus_pro()
 set_github_variable("JAMULUS_PRO_VERSION", jamulus_pro_version)
 build_type, build_version = get_build_version(jamulus_pro_version)
 print(f'building a version of type "{build_type}": {build_version}')
 
-fullref = os.environ['GITHUB_REF']
-publish_to_release = bool(re.match(r'^refs/tags/r\d+_\d+_\d+\S*$', fullref))
+full_ref = os.environ['GITHUB_REF']
+publish_to_release = bool(re.match(r'^refs/tags/r\d+_\d+_\d+\S*$', full_ref))
 
 # BUILD_VERSION is required for all builds including branch pushes
 # and PRs:
@@ -65,12 +92,12 @@ def set_github_variable(varname, varval):
 set_github_variable("PUBLISH_TO_RELEASE", str(publish_to_release).lower())
 
 if publish_to_release:
-    reflist = fullref.split("/", 2)
-    release_tag = reflist[2]
+    ref_list = full_ref.split("/", 2)
+    release_tag = ref_list[2]
     release_title = f"Release {build_version}  ({release_tag})"
     is_prerelease = not re.match(r'^r\d+_\d+_\d+$', release_tag)
     if not is_prerelease and build_version != release_tag[1:].replace('_', '.'):
-        raise Exception(f"non-pre-release tag {release_tag} doesn't match Jamulus.pro VERSION = {build_version}")
+        raise ValueError(f"non-pre-release tag {release_tag} doesn't match Jamulus.pro VERSION = {build_version}")
 
     # Those variables are only used when a release is created at all:
     set_github_variable("IS_PRERELEASE", str(is_prerelease).lower())

.github/autobuild/ios.sh

@@ -1,10 +1,35 @@
 #!/bin/bash
+##############################################################################
+# Copyright (c) 2022-2024
+#
+# Author(s):
+#  Christian Hoffmann
+#  The Jamulus Development Team
+#
+##############################################################################
+#
+# 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 2 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+#
+##############################################################################
+
 set -eu
 
 QT_DIR=/usr/local/opt/qt
 # The following version pinnings are semi-automatically checked for
 # updates. Verify .github/workflows/bump-dependencies.yaml when changing those manually:
-AQTINSTALL_VERSION=3.0.2
+AQTINSTALL_VERSION=3.1.15
 
 if [[ ! ${QT_VERSION:-} =~ [0-9]+\.[0-9]+\..* ]]; then
     echo "Environment variable QT_VERSION must be set to a valid Qt version"
@@ -23,14 +48,14 @@ setup() {
         python3 -m pip install "aqtinstall==${AQTINSTALL_VERSION}"
         # Install actual ios Qt:
         local qtmultimedia=()
-        if [[ ! "${QT_VERSION}" =~ 5\..* ]]; then
+        if [[ ! "${QT_VERSION}" =~ 5\.[0-9]+\.[0-9]+ ]]; then
             # From Qt6 onwards, qtmultimedia is a module and cannot be installed
             # as an archive anymore.
             qtmultimedia=("--modules")
         fi
         qtmultimedia+=("qtmultimedia")
         python3 -m aqt install-qt --outputdir "${QT_DIR}" mac ios "${QT_VERSION}" --archives qtbase qttools qttranslations "${qtmultimedia[@]}"
-        if [[ ! "${QT_VERSION}" =~ 5\..* ]]; then
+        if [[ ! "${QT_VERSION}" =~ 5\.[0-9]+\.[0-9]+  ]]; then
             # Starting with Qt6, ios' qtbase install does no longer include a real qmake binary.
             # Instead, it is a script which invokes the mac desktop qmake.
             # As of aqtinstall 2.1.0 / 04/2022, desktop qtbase has to be installed manually:

.github/autobuild/linux_deb.sh

@@ -1,4 +1,29 @@
 #!/bin/bash
+##############################################################################
+# Copyright (c) 2022-2024
+#
+# Author(s):
+#  Christian Hoffmann
+#  The Jamulus Development Team
+#
+##############################################################################
+#
+# 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 2 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+#
+##############################################################################
+
 set -eu
 
 if [[ ! ${JAMULUS_BUILD_VERSION:-} =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
@@ -50,7 +75,7 @@ setup_cross_compiler() {
     if [[ "${TARGET_ARCH}" == amd64 ]]; then
         return
     fi
-    local GCC_VERSION=7  # 7 is the default on 18.04, there is no reason not to update once 18.04 is out of support
+    local GCC_VERSION=9  # 9 is the default on 20.04, there is no reason not to update once 20.04 is out of support
     sudo apt install -qq -y --no-install-recommends "g++-${GCC_VERSION}-${ABI_NAME}" "qt5-qmake:${TARGET_ARCH}" "qtbase5-dev:${TARGET_ARCH}" "libjack-jackd2-dev:${TARGET_ARCH}" "qtmultimedia5-dev:${TARGET_ARCH}"
     sudo update-alternatives --install "/usr/bin/${ABI_NAME}-g++" g++ "/usr/bin/${ABI_NAME}-g++-${GCC_VERSION}" 10
     sudo update-alternatives --install "/usr/bin/${ABI_NAME}-gcc" gcc "/usr/bin/${ABI_NAME}-gcc-${GCC_VERSION}" 10

.github/autobuild/mac.sh

@@ -1,10 +1,35 @@
 #!/bin/bash
+##############################################################################
+# Copyright (c) 2022-2024
+#
+# Author(s):
+#  Christian Hoffmann
+#  The Jamulus Development Team
+#
+##############################################################################
+#
+# 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 2 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+#
+##############################################################################
+
 set -eu
 
 QT_DIR=/usr/local/opt/qt
 # The following version pinnings are semi-automatically checked for
 # updates. Verify .github/workflows/bump-dependencies.yaml when changing those manually:
-AQTINSTALL_VERSION=3.0.2
+AQTINSTALL_VERSION=3.1.15
 
 TARGET_ARCHS="${TARGET_ARCHS:-}"
 
@@ -24,7 +49,7 @@ setup() {
         echo "Installing Qt..."
         python3 -m pip install "aqtinstall==${AQTINSTALL_VERSION}"
         local qtmultimedia=()
-        if [[ ! "${QT_VERSION}" =~ 5\..* ]]; then
+        if [[ ! "${QT_VERSION}" =~ 5\.[0-9]+\.[0-9]+ ]]; then
             # From Qt6 onwards, qtmultimedia is a module and cannot be installed
             # as an archive anymore.
             qtmultimedia=("--modules")
@@ -41,14 +66,27 @@ prepare_signing() {
     [[ -n "${MACOS_CERTIFICATE:-}" ]] || return 1
     [[ -n "${MACOS_CERTIFICATE_ID:-}" ]] || return 1
     [[ -n "${MACOS_CERTIFICATE_PWD:-}" ]] || return 1
-    [[ -n "${NOTARIZATION_PASSWORD:-}" ]] || return 1
     [[ -n "${KEYCHAIN_PASSWORD:-}" ]] || return 1
 
+    # Check for notarization (not wanted on self signed build)
+    if [[ -z "${NOTARIZATION_PASSWORD}" ]]; then
+        echo "Notarization password not found or empty. This suggests we might run a self signed build."
+        if [[ -z "${MACOS_CA_PUBLICKEY}" ]]; then
+            echo "Warning: The CA public key wasn't set or is empty. Skipping signing."
+            return 1
+        fi
+    fi
+
     echo "Signing was requested and all dependencies are satisfied"
 
     # Put the cert to a file
     echo "${MACOS_CERTIFICATE}" | base64 --decode > certificate.p12
 
+    # If set, put the CA public key into a file
+    if [[ -n "${MACOS_CA_PUBLICKEY}" ]]; then
+        echo "${MACOS_CA_PUBLICKEY}" | base64 --decode > CA.cer
+    fi
+
     # Set up a keychain for the build:
     security create-keychain -p "${KEYCHAIN_PASSWORD}" build.keychain
     security default-keychain -s build.keychain
@@ -58,8 +96,24 @@ prepare_signing() {
     security import certificate.p12 -k build.keychain -P "${MACOS_CERTIFICATE_PWD}" -T /usr/bin/codesign
     security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "${KEYCHAIN_PASSWORD}" build.keychain
 
-    # Tell Github Workflow that we need notarization & stapling:
+    # Tell Github Workflow that we want signing
     echo "macos_signed=true" >> "$GITHUB_OUTPUT"
+
+    # If set, import CA key to allow self signed key
+    if [[ -n "${MACOS_CA_PUBLICKEY}" ]]; then
+        # bypass any GUI related trusting prompt (https://developer.apple.com/forums/thread/671582)
+        echo "Importing development only CA"
+        # shellcheck disable=SC2024
+        sudo security authorizationdb read com.apple.trust-settings.admin > rights
+        sudo security authorizationdb write com.apple.trust-settings.admin allow
+        sudo security add-trusted-cert -d -r trustRoot -k "build.keychain" CA.cer
+        # shellcheck disable=SC2024
+        sudo security authorizationdb write com.apple.trust-settings.admin < rights
+    else
+        # Tell Github Workflow that we need notarization & stapling (non self signed build)
+        echo "macos_notarize=true" >> "$GITHUB_OUTPUT"
+    fi
+
     return 0
 }