Merge pull request #50 from YIO-Remote/feature/app-plugin-update

Initial YIO app plugin update script to install GitHub binary releases.

Author: zehnm

overlay/opt/yio/scripts/app-plugin-update.sh

@@ -0,0 +1,200 @@
+#!/bin/bash
+#------------------------------------------------------------------------------
+# YIO app plugin updater script.
+# Called from main the update.sh script and remote-software.
+#
+# Copyright (C) 2020 Markus Zehnder <business@markuszehnder.ch>
+#
+# This file is part of the YIO-Remote software project.
+#
+# YIO-Remote software 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.
+#
+# YIO-Remote software 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 YIO-Remote software. If not, see <https://www.gnu.org/licenses/>.
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#------------------------------------------------------------------------------
+
+. /etc/profile.d/yio.sh
+. $(dirname $0)/lib/common.bash
+. $(dirname $0)/lib/util.bash
+
+#------------------------------------------------------------------------------
+# Start of script
+
+# check command line arguments
+if [ $# -eq 0 ]; then
+    echo "Usage: $0 update.(version|zip|tar)"
+    echo "  Updates a YIO remote app plugin with the provided update marker file or archive."
+    echo "  The archive may be a zip or tar archive. See wiki for update archive format."
+    echo "  The archive and optional marker file are deleted after a success update!"
+    exit 1
+fi
+
+if [[ $(id -u) -ne 0 ]] ; then
+  echo "Must be run as root"
+  exit 1
+fi
+
+# handle update marker file which contains a reference to the update archive
+if [[ $1 == *.version ]]; then
+  MARKER_FILE=$1
+  if [[ ! -f $MARKER_FILE ]]; then
+    echo "Update marker file not found: $MARKER_FILE"
+    exit 1
+  fi
+  UPDATE_FILE=$(cat "$MARKER_FILE" | awk '/^Update/{print $3}')
+  if [[ -z $UPDATE_FILE ]]; then
+    echo "Marker file doesn't contain update archive file reference!"
+    exit 1
+  fi
+else
+  UPDATE_FILE=$1
+fi
+
+# verify environment
+if [[ ! -f $UPDATE_FILE ]]; then
+  echo "Update archive file not found: $UPDATE_FILE"
+  exit 1
+fi
+
+if [[ $UPDATE_FILE != *.tar && $UPDATE_FILE != *.zip ]]; then
+  echo "Only tar and zip update archive files are supported: $UPDATE_FILE"
+  exit 1
+fi
+
+assertEnvVariable "YIO_HOME" $YIO_HOME
+assertEnvVariable "YIO_PLUGIN_DIR" $YIO_PLUGIN_DIR
+assertEnvVariable "YIO_LOG_DIR_UPDATE" $YIO_LOG_DIR_UPDATE
+
+if [[ ! -d $YIO_HOME ]]; then
+  echo "Installation target does not exist: $YIO_HOME"
+  exit 1
+fi
+
+# TODO check free space?
+
+YIO_SPLASH_DIR=${YIO_MEDIA_DIR}/splash
+# write update log into dedicated update log file
+mkdir -p $YIO_LOG_DIR_UPDATE
+LOGFILE=${YIO_LOG_DIR_UPDATE}/plugin-update.log
+
+echo "Writing update log file: $LOGFILE"
+echo "YIO Remote App Plugin Update Log" > $LOGFILE
+log "Update archive:         $UPDATE_FILE"
+log "Installation directory: $YIO_PLUGIN_DIR"
+
+#------------------------------------------------------------------------------
+# Start update process!
+#------------------------------------------------------------------------------
+
+ensureScreenIsOn "${YIO_SPLASH_DIR}/update.png"
+
+#------------------------------------------------------------------------------
+# Extract update archive to temp location
+#------------------------------------------------------------------------------
+
+# use ${YIO_HOME} base dir for atomic file operation (/tmp might be on another partition)
+TMPDIR=${YIO_HOME}/app-plugin-$(date +"%Y%m%d%H%M%S")
+log "Extracting archive to temporary folder: $TMPDIR"
+mkdir -p ${TMPDIR} >> $LOGFILE 2>&1
+
+if [[ $UPDATE_FILE == *.tar ]]; then
+    tar tf "$UPDATE_FILE" > /dev/null || {
+        log "Invalid tar archive: $UPDATE_FILE"
+        exit 1
+    }
+
+    tar -xf "$UPDATE_FILE" -C ${TMPDIR} >> $LOGFILE 2>&1
+elif [[ $UPDATE_FILE == *.zip ]]; then
+    unzip -l "$UPDATE_FILE" > /dev/null || {
+        log "Invalid zip archive: $UPDATE_FILE"
+        exit 1
+    }
+
+    unzip "$UPDATE_FILE" -d ${TMPDIR} >> $LOGFILE 2>&1
+else
+    log "Only tar and zip update archive files are supported: $UPDATE_FILE"
+    exit 1
+fi
+
+cd ${TMPDIR}
+if [[ ! -f md5sums || ! -f app.tar.gz ]]; then
+    log "Invalid app plugin update archive: $UPDATE_FILE"
+    exit 1
+fi
+
+md5sum -c md5sums >> $LOGFILE 2>&1
+gunzip -c app.tar.gz | tar -x >> $LOGFILE 2>&1
+#cp version.txt app/ >> $LOGFILE 2>&1
+rm app.tar.gz
+
+if [[ ! -d ${TMPDIR}/app/plugins ]]; then
+    log "Missing plugins folder in app plugin update archive: $UPDATE_FILE"
+    exit 1
+fi
+
+if [[ -f ${TMPDIR}/hooks/pre-install.sh ]]; then
+    log "Running pre-install script: ${TMPDIR}/hooks/pre-install.sh"
+    ${TMPDIR}/pre-install.sh  >> $LOGFILE 2>&1
+fi
+
+#------------------------------------------------------------------------------
+# Replace old backup with the current app version
+#------------------------------------------------------------------------------
+log "Stopping remote app..."
+killall -9 remote >> $LOGFILE 2>&1 && sleep 2 || true
+#stopService app >> $LOGFILE 2>&1#
+
+#fbv -d 1 "${YIO_SPLASH_DIR}/update.png"
+
+if [[ -d $YIO_PLUGIN_DIR ]]; then
+  YIO_BACKUP=${YIO_HOME}/app-plugins-previous
+
+  if [[ -d $YIO_BACKUP ]]; then
+      log "Removing previous app plugins backup: '$YIO_BACKUP'"
+      rm -rf "${YIO_BACKUP}" >> $LOGFILE 2>&1
+  fi
+
+  log "Backing up current plugins to: '$YIO_BACKUP'"
+  cp -r "$YIO_PLUGIN_DIR" "$YIO_BACKUP" >> $LOGFILE 2>&1
+else
+  log "Remote app plugin directory doesn't exist: '$YIO_PLUGIN_DIR'. Skipping backup."
+fi
+
+mkdir -p $YIO_PLUGIN_DIR >> $LOGFILE 2>&1
+
+#------------------------------------------------------------------------------
+# Activate new plugin
+#------------------------------------------------------------------------------
+mv ${TMPDIR}/app/plugins/* "$YIO_PLUGIN_DIR" >> $LOGFILE 2>&1
+log "Update ($TMPDIR) is now available in the plugin directory ($YIO_PLUGIN_DIR)"
+
+if [[ -f ${TMPDIR}/hooks/post-install.sh ]]; then
+    log "Running post-install script: ${TMPDIR}/hooks/post-install.sh"
+    ${TMPDIR}/post-install.sh >> $LOGFILE 2>&1
+fi
+
+log "Deleting update archive files and temporary folder"
+rm -rf $TMPDIR >> $LOGFILE 2>&1
+rm "$UPDATE_FILE" >> $LOGFILE 2>&1
+if [[ -f $MARKER_FILE ]]; then
+  rm -f $MARKER_FILE
+fi
+
+fbv -d 1 "${YIO_SPLASH_DIR}/splash.png"
+
+#TODO rather reboot? If yes: it would be a good time to check & repair file systems
+log "Update finished! Launching app..."
+
+# 'systemctl start app' doesn't work reliably!?
+# startService app
+$YIO_HOME/app-launch.sh >> /dev/null 2>&1

overlay/opt/yio/scripts/app-update.sh

@@ -27,25 +27,6 @@
 . /etc/profile.d/yio.sh
 . $(dirname $0)/lib/common.bash
 
-ensureScreenIsOn() {
-  # TODO improve sledge hammer approach
-  # FIXME this doesn't fully work if screen is put in standby from the YIO app.
-  #       It's not waking up instantly but much later when the update is almost finished!?
-
-  # make sure the screen and backlight are on, otherwise we'll end up with a dark screen!
-  ${YIO_HOME}/scripts/sharp-init
-
-  if [[ -f $1 ]]; then
-      fbv -d 1 "$1"
-  fi
-
-  gpio -g mode 12 pwm
-  gpio pwm-ms
-  gpio pwmc 1000
-  gpio pwmr 100
-  gpio -g pwm 12 100
-}
-
 # TODO function to clean up in case of update error!
 # We don't want to end up in an update loop trying to install a corrupt archive
 
@@ -208,4 +189,4 @@ log "Update finished! Launching app..."
 
 fbv -d 1 "${YIO_SPLASH_DIR}/splash.png"
 
-$YIO_HOME/app-launch.sh &
+$YIO_HOME/app-launch.sh >> /dev/null 2>&1

overlay/opt/yio/scripts/lib/common.bash

@@ -35,6 +35,13 @@ assertEnvVariable() {
   fi
 }
 
+assertInstalled() {
+  command -v $1 >/dev/null 2>&1 || { 
+    echo >&2 "Program $1 not installed. Aborting.";
+    exit 1;
+  }
+}
+
 # Retrieve the latest release version from GitHub for the given repository.
 # Parameters:
 # $1: YIO GitHub repository. E.g. web-configurator, remote-software, etc.
@@ -117,3 +124,22 @@ confirm() {
             ;;
     esac
 }
+
+ensureScreenIsOn() {
+  # TODO improve sledge hammer approach
+  # FIXME this doesn't fully work if screen is put in standby from the YIO app.
+  #       It's not waking up instantly but much later when the update is almost finished!?
+
+  # make sure the screen and backlight are on, otherwise we'll end up with a dark screen!
+  ${YIO_HOME}/scripts/sharp-init
+
+  if [[ -f $1 ]]; then
+      fbv -d 1 "$1"
+  fi
+
+  gpio -g mode 12 pwm
+  gpio pwm-ms
+  gpio pwmc 1000
+  gpio pwmr 100
+  gpio -g pwm 12 100
+}

overlay/opt/yio/scripts/update.sh

@@ -40,8 +40,8 @@ $0 COMPONENT PARAMETERS
   COMPONENT:
     app     remote-software application
     web     web-configurator
+    plugin  integration plugin
     os      remote-os (NOT YET IMPLEMENTED)
-    plugin  integration plugin (NOT YET IMPLEMTED)
 
   PARAMETERS:
     FILE.(version|zip|tar)  update marker file or archive
@@ -88,14 +88,23 @@ appendReleaseInfo() {
     getLatestRelease $2
     if [[ ! -z $3 && -f ${3}/version.txt ]]; then
         LOCAL_VERSION=$(< ${3}/version.txt)
-    elif [[ ! -z $4 && -f $4 ]]; then
-        # TODO query plugin metadata. Probably need to write a little qt utility...
-        LOCAL_VERSION=x
+    fi
+    echo "$2,$LATEST_RELEASE,$LOCAL_VERSION" >> $1
+}
+
+appendPluginReleaseInfo() {
+    local LOCAL_VERSION=-
+    getLatestRelease $2
+    if [[ -f $3 ]]; then
+        LOCAL_VERSION=`qtplugininfo --full-json -f compact $3 | jq '.MetaData.version' | tr -d '"'`
     fi
     echo "$2,$LATEST_RELEASE,$LOCAL_VERSION" >> $1
 }
 
 checkReleases() {
+    assertInstalled qtplugininfo
+    assertInstalled jq
+
     echo "Retrieving version information from GitHub..."
     local VERSION_FILE=/tmp/versions.txt
     echo "Component,GitHub,Installed" > $VERSION_FILE
@@ -108,7 +117,7 @@ checkReleases() {
         local PROJECT=$(awk -F, '{print $1}' <<< $item)
         local LIBFILE=${YIO_PLUGIN_DIR}/$(awk -F, '{print $2}' <<< $item)
 
-        appendReleaseInfo $VERSION_FILE $PROJECT "" $LIBFILE
+        appendPluginReleaseInfo $VERSION_FILE $PROJECT $LIBFILE
     done
 
     echo ""
@@ -203,8 +212,8 @@ case "$COMPONENT" in
     exit 1
     ;;
   plugin)
-    echo "plugin NOT YET IMPLEMENTED!"
-    exit 1
+    $DIR/app-plugin-update.sh $@ || exit $?
+    exit 0
     ;;
   *)
     echo "Invalid component: $COMPONENT"

rpi0/defconfig

@@ -27,9 +27,11 @@ BR2_LINUX_KERNEL_LZO=y
 BR2_LINUX_KERNEL_DTS_SUPPORT=y
 BR2_LINUX_KERNEL_INTREE_DTS_NAME="bcm2708-rpi-0-w"
 BR2_PACKAGE_FFMPEG=y
+BR2_PACKAGE_JQ=y
 BR2_PACKAGE_FBV=y
 BR2_PACKAGE_QT5=y
 BR2_PACKAGE_QT5BASE_DEFAULT_QPA="eglfs"
+BR2_PACKAGE_QT5TOOLS_QTPLUGININFO=y
 BR2_PACKAGE_RPI_BT_FIRMWARE=y
 BR2_PACKAGE_RPI_FIRMWARE=y
 BR2_PACKAGE_RPI_FIRMWARE_INSTALL_VCDBG=y

yio-remote/Config.in

@@ -31,34 +31,34 @@ if BR2_PACKAGE_YIO_REMOTE
 # Custom versions can be enabled with: BR2_PACKAGE_YIO_REMOTE_CUSTOM_VERSION
 config BR2_PACKAGE_YIO_REMOTE_SOFTWARE_VERSION_DEF
 	string
-	default "v0.4.3"
+	default "v0.5.2"
 config BR2_PACKAGE_YIO_WEB_CONFIGURATOR_VERSION_DEF
 	string
-	default "v0.1.8"
+	default "v0.2.0"
 config BR2_PACKAGE_YIO_INTEGRATION_DOCK_VERSION_DEF
 	string
-	default "v0.5.2"
+	default "v0.6.0"
 config BR2_PACKAGE_YIO_INTEGRATION_HOMEASSISTANT_VERSION_DEF
 	string
-	default "v0.4.7"
+	default "v0.5.0"
 config BR2_PACKAGE_YIO_INTEGRATION_HOMEY_VERSION_DEF
 	string
-	default "v0.4.2"
+	default "v0.5.0"
 config BR2_PACKAGE_YIO_INTEGRATION_OPENHAB_VERSION_DEF
 	string
-	default "v0.4.1"
+	default "v0.5.0"
 config BR2_PACKAGE_YIO_INTEGRATION_SPOTIFY_VERSION_DEF
 	string
-	default "v0.4.1"
+	default "v0.5.0"
 config BR2_PACKAGE_YIO_INTEGRATION_BANGOLUFSEN_VERSION_DEF
 	string
-	default "v0.1.0"
+	default "v0.2.0"
 config BR2_PACKAGE_YIO_INTEGRATION_OPENWEATHER_VERSION_DEF
 	string
-	default "v0.4.1"
+	default "v0.5.0"
 config BR2_PACKAGE_YIO_INTEGRATION_ROON_VERSION_DEF
 	string
-	default "v0.3.1"
+	default "v0.4.0"
 
 choice
 	prompt "Source"

yio-remote/yio-integration-dock/v0.6.0/yio-integration-dock.hash

@@ -0,0 +1,2 @@
+sha256  d9dbf6800113a607226fa62b3da6caaee4365d2896527e8804ff14dc340b9bd9  YIO-integration.dock-v0.6.0-RPi0-debug.tar
+sha256  a9f1f197aae9c4f9f2646e83e4208377c6f80fd1033bdd1ed2b6bd39ae09c414  YIO-integration.dock-v0.6.0-RPi0-release.tar

yio-remote/yio-integration-homeassistant/v0.5.0/yio-integration-homeassistant.hash

@@ -0,0 +1,2 @@
+sha256  6e991f1a78ac48bdc7f4746cc64da516bcc797ead0c5d6fe9e3e02a24570b124  YIO-integration.home-assistant-v0.5.0-RPi0-debug.tar
+sha256  0edb033d3edef1e67e87a24a77b75a0e4907fbef16208fbb0a4217be406613ea  YIO-integration.home-assistant-v0.5.0-RPi0-release.tar

yio-remote/yio-integration-homey/v0.5.0/yio-integration-homey.hash

@@ -0,0 +1,2 @@
+sha256  7ec1c979f42709fae1044a5fff8deb10e579809dafbd03802b6380b914ad1880  YIO-integration.homey-v0.5.0-RPi0-debug.tar
+sha256  be75d7ebf4171849061abcada2811816e3b1fec3b1dfebc29f351a6eec90200a  YIO-integration.homey-v0.5.0-RPi0-release.tar

yio-remote/yio-integration-openweather/v0.5.0/yio-integration-openweather.hash

@@ -0,0 +1,2 @@
+sha256  b805d883a8c8b7d9486d1917c80dc55b6872be42684bda7507c679651013f116  YIO-integration.openweather-v0.5.0-RPi0-debug.tar
+sha256  42d2176701f37a1913f7248aa7c8869c78590b240e314120a8d9174ca9e59db3  YIO-integration.openweather-v0.5.0-RPi0-release.tar

yio-remote/yio-integration-roon/v0.4.0/yio-integration-roon.hash

@@ -0,0 +1,2 @@
+sha256  544a598c52bf022a404b5d977065da42305fa9cd4699398c04815bfe5391e3bc  YIO-integration.roon-v0.4.0-RPi0-debug.tar
+sha256  5eb03192426e6211bd8fa314fc14c6aa9f7b2b8a6e75ed2b16322f51628b9418  YIO-integration.roon-v0.4.0-RPi0-release.tar