Improvements to usability for PA source build script

2 files changed, 245 insertions, 6 deletions

diff --git a/scripts/install_pulseaudio_sources.sh b/scripts/install_pulseaudio_sources.sh
index 4fc3d8f..c5cf024 100755
--- a/scripts/install_pulseaudio_sources.sh
+++ b/scripts/install_pulseaudio_sources.sh
@@ -1,17 +1,79 @@
-#!/usr/bin/env bash
+#!/bin/sh
+#
+# xrdp: A Remote Desktop Protocol server.
+#
+# Copyright (C) 2021 Matt Burt, all xrdp contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Builds the pulseaudio sources on Debian/Ubuntu and writes the internal
+# pulseaudio files needed to build the xrdp pulseaudio module into a
+# single directory
+
+# This script will pollute the machine with all the pulseaudio dependencies
+# needed to build the pulseaudio dpkg. If this isn't acceptable, consider
+# running this script in a schroot (or similar) wrapper.
+
+# Use '-d <dir>' to specify an alternate directory
+
 
 set -e  ; # Exit on any error
-cd $HOME
 
-if [ ! -d pulseaudio.src ]; then
-    sudo sed -i.bak -e 's|^# deb-src|deb-src|' /etc/apt/sources.list
+# Target directory for output files
+PULSE_DIR="$HOME/pulseaudio.src"   ; # Default if nothing is specified
+
+# Argument processing
+while [ $# -gt 0 ]; do
+    arg="$1"
+    shift
+
+    case "$arg" in
+        -d) if [ $# -gt 0 ]; then
+                PULSE_DIR="$1"
+                shift
+            else
+                echo "** $arg needs an argument" >&2
+            fi
+            ;;
+        *)  echo "** Unrecognised argument '$arg'" >&2
+    esac
+done
+
+if [ ! -d $PULSE_DIR ]; then
+    # Operating system release ?
+    RELEASE="$(lsb_release -si)-$(lsb_release -sr)"
+    echo "Building for : $RELEASE"
+
+    # Make sure sources are available
+    if ! grep -q '^ *deb-src' /etc/apt/sources.list; then
+        sudo sed -i.bak -e 's|^# deb-src|deb-src|' /etc/apt/sources.list
+    fi
 
     sudo apt-get update
 
     sudo apt-get build-dep -y pulseaudio
+    # Install any missing dependencies for this software release
+    case "$RELEASE" in
+        Ubuntu-16.04)
+            sudo apt-get install -y libjson-c-dev
+            ;;
+    esac
+
+    cd $(dirname $PULSE_DIR)
     apt-get source pulseaudio
 
-    pulse_dir=$(find . -maxdepth 1 -name pulseaudio-\*)
+    pulse_dir=$(find . -maxdepth 1 -name pulseaudio-[0-9]\*)
     if [[ -z $pulse_dir ]]; then
         echo "** Can't find pulse dir in $(ls)" >&2
         exit 1
@@ -19,8 +81,14 @@ if [ ! -d pulseaudio.src ]; then
 
     cd $pulse_dir
     ./configure
+
+    # We only need the src/ directory and config.h
+    echo "- Removing unnecessary files"
+    find . -mindepth 1 -maxdepth 1 -name src -o -name config.h -o -exec rm -rf {} +
+
+    echo "- Renaming $(pwd)/$pulse_dir as $PULSE_DIR"
     cd ..
-    mv $pulse_dir pulseaudio.src
+    mv $pulse_dir $PULSE_DIR
 fi
 
 exit 0
diff --git a/scripts/install_pulseaudio_sources_wrapper.sh b/scripts/install_pulseaudio_sources_wrapper.sh
new file mode 100755
index 0000000..96697f9
--- /dev/null
+++ b/scripts/install_pulseaudio_sources_wrapper.sh
@@ -0,0 +1,171 @@
+#!/bin/sh
+#
+# xrdp: A Remote Desktop Protocol server.
+#
+# Copyright (C) 2021 Matt Burt, all xrdp contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Wrapper to call install_pulseaudio_sources.sh and tidy up afterwards
+
+# ---------------------------------------------------------------------------
+# G L O B A L S
+# ---------------------------------------------------------------------------
+# Where the output files are going. Must be under $HOME as schroot
+# assumes this.
+PULSE_DIR=$HOME/pulseaudio.src
+
+# Absolute path to the script we're wrapping. This picks it up from
+# the same directory this file is in
+WRAPPED_SCRIPT=$(cd $(dirname $0) && pwd)/install_pulseaudio_sources.sh
+
+# The buildroot directory. Choose fast, temporary storage if available
+BUILDROOT=/var/lib/pa-build/$USER
+
+# Extra packages to install in the build root which the wrapped script
+# may be using. These are packages available by default when using
+# GitHub actions
+WRAPPED_SCRIPT_DEPS="sudo lsb-release"
+
+# -----------------------------------------------------------------------------
+# I N S T A L L   R E Q U I R E D   P A C K A G E S
+#
+# Installs packages required for the build on the host machine
+# -----------------------------------------------------------------------------
+InstallRequiredPackages()
+{
+    set -- \
+        /usr/sbin/debootstrap   debootstrap \
+        /usr/bin/schroot        schroot \
+        /usr/bin/lsb_release    lsb-release
+
+    pkgs=
+    while [ $# -ge 2 ]; do
+        if [ ! -x $1 ]; then
+            pkgs="$pkgs $2"
+        fi
+        shift 2
+    done
+
+    if [ -n "$pkgs" ]; then
+        echo "- Need to install packages :$pkgs"
+        echo
+        echo "  These can be removed when this script completes with:-"
+        echo "  sudo apt-get purge$pkgs && apt-get autoremove"
+        echo
+        sudo apt-get install -y $pkgs
+    fi
+}
+
+# -----------------------------------------------------------------------------
+# R U N   W R A P P E D   S C R I P T
+#
+# Runs the wrapped build script using schroot
+#
+# This function definition uses () rather than {} to create an extra
+# sub-process where we can run 'set -e' without affecting the parent
+# -----------------------------------------------------------------------------
+RunWrappedScript()
+(
+    # In this sub-process, fail on error
+    set -e
+
+    # Install extra dependencies
+    schroot -c pa-build-$USER -u root -- \
+        apt-get install -y $WRAPPED_SCRIPT_DEPS
+
+    # Allow normal user to sudo without a password
+    schroot -c pa-build-$USER -u root -- \
+        /bin/sh -c "echo '$USER ALL=(ALL) NOPASSWD:ALL'>/etc/sudoers.d/nopasswd-$USER"
+    schroot -c pa-build-$USER -u root -- chmod 400 /etc/sudoers.d/nopasswd-$USER
+
+    # Call the wrapped script
+    schroot -c pa-build-$USER -- /wrapped_script -d $PULSE_DIR
+)
+
+# -----------------------------------------------------------------------------
+# M A I N
+# -----------------------------------------------------------------------------
+
+# Start with a few sanity checks
+if [ -d $PULSE_DIR ]; then
+    echo "** Target directory $PULSE_DIR already exists" >&2
+    exit 0
+fi
+
+if [ ! -x $WRAPPED_SCRIPT ]; then
+    echo "** Can't find wrapped script $WRAPPED_SCRIPT" >&2
+    exit 1
+fi
+
+if [ -e $BUILDROOT ]; then
+    echo "** Remove old build root $BUILDROOT before running this script"
+    exit 1
+fi
+
+# Do we need extra packages?
+InstallRequiredPackages || exit $?
+
+# We should be able to determine the distro now
+distro=$(lsb_release -cs) ; # e.g. 'bullseye'
+if [ -z "$distro" ]; then
+    echo "** Can't determine current distro" >&2
+    exit 1
+fi
+
+# Create the build root
+log=/var/tmp/pa-build-$USER-debootstrap.log
+echo "- Creating $distro build root. Log file in $log"
+sudo debootstrap $distro $BUILDROOT >$log 2>&1 || {
+    echo "** debootstrap failed. Check log file" >&2
+    exit 1
+}
+
+# Create the config file for schroot
+schroot_conf=/etc/schroot/chroot.d/pa-build-$USER.conf
+echo "- Creating schroot config file $schroot_conf"
+{
+    echo "[pa-build-$USER]"
+    echo "description=Build PA on current system for $USER"
+    echo "directory=$BUILDROOT"
+    echo "root-users=$USER"
+    echo "users=$USER"
+    echo "type=directory"
+} | sudo tee $schroot_conf >/dev/null || exit $?
+
+# Copy some files to the build root
+for file in /etc/apt/sources.list; do
+    echo "- Copying $file to the root"
+    sudo cp $file $BUILDROOT/$file || exit $?
+done
+
+# Copy the wrapped script to the buildroot root
+echo "- Copying the wrapped script to the root"
+sudo cp $WRAPPED_SCRIPT $BUILDROOT/wrapped_script || exit $?
+sudo chmod +x $BUILDROOT/wrapped_script || exit $?
+
+# Run the wrapped script
+log=/var/tmp/pa-build-$USER-schroot.log
+echo "- Building PA sources. Log file in $log"
+RunWrappedScript >$log 2>&1 || {
+    echo "** schroot failed. Check log file" >&2
+    exit 1
+}
+
+# Done! Remove the schroot config file as its no longer needed
+echo "- Removing schroot config file and build root"
+sudo rm -rf $schroot_conf $BUILDROOT
+
+echo "- All done. Configure PA xrdp module with PULSE_DIR=$PULSE_DIR"
+exit 0