From 1c9fd09e099df23e87527dbe5346561925900f55 Mon Sep 17 00:00:00 2001
From: openoms <oms@tuta.io>
Date: Wed, 23 Jun 2021 11:29:04 +0100
Subject: [PATCH] make cln default plugin dir: cln-plugins-enabled

similar to the nginx model make 2 directories for plugins:
cln-plugins-enabled - symlinked to ~/.lightning/plugins
plugins from here are loaded automatically on cln start

cln-plugins-available: plugins are downloaded here to
be run until the next cln restart (or stopped with runonce)

note the disk is mounted with noexec so plugins can't
run from there

discuss in: https://github.com/rootzoll/raspiblitz/issues/2295
---
 .../config.scripts/cln-plugin.sparko.sh       |  9 ++--
 .../cln-plugin.standard-python.sh             | 11 ++---
 .../config.scripts/cln-plugin.summary.sh      | 16 +++----
 home.admin/config.scripts/cln.install.sh      | 44 +++++++------------
 4 files changed, 33 insertions(+), 47 deletions(-)

diff --git a/home.admin/config.scripts/cln-plugin.sparko.sh b/home.admin/config.scripts/cln-plugin.sparko.sh
index 11188c560..6406a1954 100644
--- a/home.admin/config.scripts/cln-plugin.sparko.sh
+++ b/home.admin/config.scripts/cln-plugin.sparko.sh
@@ -2,6 +2,7 @@
 
 # explanation on paths https://github.com/ElementsProject/lightning/issues/4223
 # built-in path dir: /usr/local/libexec/c-lightning/plugins/
+# added --plugin-dir=/home/bitcoin/cln-plugins-enabled
 
 SPARKOVERSION="v2.7"
 
@@ -55,9 +56,9 @@ if [ $1 = on ];then
   
   # download binary
   sudo wget https://github.com/fiatjaf/sparko/releases/download/${SPARKOVERSION}/sparko_${DISTRO}\
-   -O /usr/local/libexec/c-lightning/plugins/sparko
+   -O /home/bitcoin/cln-plugins-enabled/sparko
   # make executable
-  sudo chmod +x /usr/local/libexec/c-lightning/plugins/sparko
+  sudo chmod +x /home/bitcoin/cln-plugins-enabled/sparko
   
   echo "# Editing /home/bitcoin/.lightning/${netprefix}config"
   echo "# See: https://github.com/fiatjaf/sparko#how-to-use"
@@ -79,7 +80,7 @@ sparko-keys=${masterkeythatcandoeverything}; ${secretaccesskeythatcanreadstuff}:
   echo "# Editing /etc/systemd/system/${netprefix}lightningd.service"
   sudo sed -i "s#^ExecStart=.*#ExecStart=/usr/local/bin/lightningd\
  --conf=/home/bitcoin/.lightning/${netprefix}config\
- --plugin=/usr/local/libexec/c-lightning/plugins/sparko#g"\
+ --plugin=/home/bitcoin/cln-plugins-enabled/sparko#g"\
   /etc/systemd/system/${netprefix}lightningd.service
 
   sudo systemctl daemon-reload
@@ -121,7 +122,7 @@ if [ $1 = off ];then
   # purge
   if [ "$(echo "$@" | grep -c purge)" -gt 0 ];then
     echo "# Delete plugin"
-    sudo rm /usr/local/libexec/c-lightning/plugins/${netprefix}sparko
+    sudo rm /home/bitcoin/cln-plugins-enabled/${netprefix}sparko
   fi
   # setting value in raspi blitz config
   sudo sed -i "s/^${netprefix}sparko=.*/${netprefix}sparko=off/g" /mnt/hdd/raspiblitz.conf
diff --git a/home.admin/config.scripts/cln-plugin.standard-python.sh b/home.admin/config.scripts/cln-plugin.standard-python.sh
index a9a5ca9bc..b840fc9c4 100644
--- a/home.admin/config.scripts/cln-plugin.standard-python.sh
+++ b/home.admin/config.scripts/cln-plugin.standard-python.sh
@@ -24,14 +24,15 @@ alias lightningcli_alias="$lightningcli_alias"
 
 plugin=$1
 
-if [ ! -f "/home/bitcoin/plugins/${plugin}/${plugin}.py" ]; then
-  cd /home/bitcoin || exit 1
+if [ ! -f "/home/bitcoin/cln-plugins-available/plugins/${plugin}/${plugin}.py" ]; then
+  cd /home/bitcoin/cln-plugins-available || exit 1
   sudo -u bitcoin git clone https://github.com/lightningd/plugins.git
 fi
+
 if [ $(lightningcli_alias | grep -c "${plugin}") -eq 0 ];then
   echo "# Starting the ${plugin} plugin"
-  sudo -u bitcoin pip install -r /home/bitcoin/plugins/${plugin}/requirements.txt
-  lightningcli_alias plugin start /home/bitcoin/plugins/${plugin}/${plugin}.py
+  sudo -u bitcoin pip install -r /home/bitcoin/cln-plugins-available/plugins/${plugin}/requirements.txt
+  lightningcli_alias plugin start /home/bitcoin/cln-plugins-available/plugins/${plugin}/${plugin}.py
 fi
 
 echo
@@ -49,5 +50,5 @@ lightningcli_alias ${plugin}
 echo
 
 if [ "$(echo "$@" | grep -c "runonce")" -gt 0 ];then
-  lightningcli_alias plugin stop /home/bitcoin/plugins/${plugin}/${plugin}.py
+  lightningcli_alias plugin stop /home/bitcoin/cln-plugins-available/plugins/${plugin}/${plugin}.py
 fi
\ No newline at end of file
diff --git a/home.admin/config.scripts/cln-plugin.summary.sh b/home.admin/config.scripts/cln-plugin.summary.sh
index 6d4a58c23..3883638c6 100644
--- a/home.admin/config.scripts/cln-plugin.summary.sh
+++ b/home.admin/config.scripts/cln-plugin.summary.sh
@@ -11,22 +11,18 @@ if [ $# -eq 0 ] || [ "$1" = "-h" ] || [ "$1" = "-help" ];then
 fi
 
 source <(/home/admin/config.scripts/network.aliases.sh getvars cln $1)
-shopt -s expand_aliases
-alias bitcoincli_alias="$bitcoincli_alias"
-alias lncli_alias="$lncli_alias"
-alias lightningcli_alias="$lightningcli_alias"
 
-if [ ! -f "/home/bitcoin/plugins/summary/summary.py" ]; then
+if [ ! -f "/home/bitcoin/cln-plugins-available/plugins/summary/summary.py" ]; then
   cd /home/bitcoin || exit 1
   sudo -u bitcoin git clone https://github.com/lightningd/plugins.git
 fi
-if [ $(lightningcli_alias | grep -c "summary") -eq 0 ];then
+if [ $($lightningcli_alias | grep -c "summary") -eq 0 ];then
   echo "# Starting the summary plugin"
   # https://github.com/ElementsProject/lightning/tree/master/contrib/pylightning
   sudo -u bitcoin pip install pylightning 1>/dev/null
   # https://github.com/lightningd/plugins#dynamic-plugin-initialization
-  sudo -u bitcoin pip install -r /home/bitcoin/plugins/summary/requirements.txt 1>/dev/null
-  lightningcli_alias plugin start -H /home/bitcoin/plugins/summary/summary.py 1>/dev/null
+  sudo -u bitcoin pip install -r /home/bitcoin/cln-plugins-available/plugins/summary/requirements.txt 1>/dev/null
+  $lightningcli_alias plugin start -H /home/bitcoin/cln-plugins-available/plugins/summary/summary.py 1>/dev/null
 fi
 
 echo
@@ -40,9 +36,9 @@ echo
 echo "# Running:"
 echo "${netprefix}lightning-cli -H summary"
 echo 
-lightningcli_alias -H summary
+$lightningcli_alias -H summary
 echo
 
 if [ "$(echo "$@" | grep -c "runonce")" -gt 0 ];then
-  lightningcli_alias plugin stop -H /home/bitcoin/plugins/summary/summary.py
+  $lightningcli_alias plugin stop -H /home/bitcoin/cln-plugins-available/plugins/summary/summary.py
 fi
\ No newline at end of file
diff --git a/home.admin/config.scripts/cln.install.sh b/home.admin/config.scripts/cln.install.sh
index c6f5f61f4..b64c9f0f8 100644
--- a/home.admin/config.scripts/cln.install.sh
+++ b/home.admin/config.scripts/cln.install.sh
@@ -27,31 +27,10 @@ fi
 # Tor
 TORGROUP="debian-tor"
 
-# bitcoin mainnet / signet / testnet
-if [ "$1" = on ] || [ "$1" = off ] && [ $# -gt 1 ];then
-  NETWORK=$2
-else 
-  if [ $chain = main ];then
-    NETWORK=${network}
-  else
-    NETWORK=${chain}net
-  fi
-fi
-
-# prefix for parallel testnetwork services
-if [ $NETWORK = testnet ];then
-  netprefix="t"
-  portprefix=1
-elif [ $NETWORK = signet ];then
-  netprefix="s"
-  portprefix=3
-else
-  netprefix=""
-  portprefix=""
-fi
+source <(/home/admin/config.scripts/network.aliases.sh getvars cln $2)
 
 echo "# Running: 'cln.install.sh $*'"
-echo "# Using the settings for: ${NETWORK} "
+echo "# Using the settings for: ${network} ${CHAIN}"
 
 # add default value to raspi config if needed
 if ! grep -Eq "^${netprefix}cln=" /mnt/hdd/raspiblitz.conf; then
@@ -136,6 +115,14 @@ if [ "$1" = on ]||[ "$1" = update ]||[ "$1" = experimental ]||[ "$1" = testPR ];
   echo "# Make sure bitcoin is in the ${TORGROUP} group"
   sudo usermod -a -G ${TORGROUP} bitcoin
 
+  echo "# Add plugin-dir: /home/bitcoin/cln-plugins-enabled"
+  echo "# Add plugin-dir: /home/bitcoin/cln-plugins-available"
+  # note that the disk is mounted with noexec
+  sudo -u bitcoin mkdir /home/bitcoin/cln-plugins-enabled
+  sudo -u bitcoin mkdir /home/bitcoin/cln-plugins-available
+  echo "# symlink to /home/bitcoin/cln-plugins-enabled to /home/bitcoin/.lightning/plugins"
+  sudo ln -s /home/bitcoin/cln-plugins-enabled /home/bitcoin/.lightning/plugins
+  
   echo "# Store the lightning data in /mnt/hdd/app-data/.lightning"
   echo "# Symlink to /home/bitcoin/"
   sudo rm -rf /home/bitcoin/.lightning # not a symlink, delete
@@ -144,12 +131,13 @@ if [ "$1" = on ]||[ "$1" = update ]||[ "$1" = experimental ]||[ "$1" = testPR ];
   echo "# Create /home/bitcoin/.lightning/${netprefix}config"
   if [ ! -f /home/bitcoin/.lightning/${netprefix}config ];then
     echo "
-# lightningd configuration for $NETWORK
+# lightningd configuration for ${network} ${CHAIN}
 
-network=$NETWORK
+network=${CLNETWORK}
 announce-addr=127.0.0.1:${portprefix}9736
 log-file=cl.log
 log-level=debug
+plugin-dir=/home/bitcoin/cln-plugins-enabled
 
 # Tor settings
 proxy=127.0.0.1:9050
@@ -161,7 +149,7 @@ always-use-proxy=true
     echo "# The file /home/bitcoin/.lightning/${netprefix}config is already present"
     #TODO look for plugin configs and clear or install
     if [ $(grep -c "^sparko" < /home/bitcoin/.lightning/${netprefix}config) -gt 0 ];then
-      /home/admin/config.scripts/cln-plugin.sparko.sh on $NETWORK
+      /home/admin/config.scripts/cln-plugin.sparko.sh on $CHAIN
     fi
   fi
   sudo chown -R bitcoin:bitcoin /mnt/hdd/app-data/.lightning
@@ -173,7 +161,7 @@ always-use-proxy=true
   echo "# Create /etc/systemd/system/${netprefix}lightningd.service"
   echo "
 [Unit]
-Description=c-lightning daemon on $NETWORK
+Description=c-lightning daemon on $CHAIN
 
 [Service]
 User=bitcoin
@@ -222,7 +210,7 @@ alias ${netprefix}cl=\"sudo -u bitcoin /usr/local/bin/lightning-cli\
   echo "sudo journalctl -fu ${netprefix}lightningd"
   echo "sudo systemctl status ${netprefix}lightningd"
   echo "# logs:"
-  echo "sudo tail -f /home/bitcoin/.lightning/${NETWORK}/cl.log"
+  echo "sudo tail -f /home/bitcoin/.lightning/${CLNETWORK}/cl.log"
   echo "# for the command line options use"
   echo "${netprefix}lightning-cli help"
   echo