From fe2079ee8f0dd57bb1d8d435060e23bfedaea64a Mon Sep 17 00:00:00 2001
From: downtownallday <downtownallday@gmail.com>
Date: Fri, 25 Feb 2022 19:32:29 -0500
Subject: [PATCH] Add setup mods for testing the latest version of roundcube

---
 setup/mods.available/rcmcarddav-composer.sh |  46 ++++++++
 setup/mods.available/roundcube-debug.sh     |  28 +++++
 setup/mods.available/roundcube-master.sh    | 120 +++++++++++++++++++
 tools/editconf.php                          | 124 ++++++++++++++++++++
 4 files changed, 318 insertions(+)
 create mode 100755 setup/mods.available/rcmcarddav-composer.sh
 create mode 100755 setup/mods.available/roundcube-debug.sh
 create mode 100755 setup/mods.available/roundcube-master.sh
 create mode 100644 tools/editconf.php

diff --git a/setup/mods.available/rcmcarddav-composer.sh b/setup/mods.available/rcmcarddav-composer.sh
new file mode 100755
index 00000000..dda159f4
--- /dev/null
+++ b/setup/mods.available/rcmcarddav-composer.sh
@@ -0,0 +1,46 @@
+#!/bin/bash
+
+#
+# this mod will run composer on rcmcarddav to update its dependencies
+#
+
+source setup/functions.sh # load our functions
+source /etc/mailinabox.conf # load global vars
+
+echo "Updating rcmcarddav's dependencies"
+
+# where webmail.sh installs roundcube
+RCM_DIR=/usr/local/lib/roundcubemail
+
+
+install_composer() {
+    # https://getcomposer.org/doc/faqs/how-to-install-composer-programmatically.md
+    local EXPECTED_CHECKSUM="$(wget -q -O - https://composer.github.io/installer.sig)"
+    php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+    local ACTUAL_CHECKSUM="$(php -r "echo hash_file('sha384', 'composer-setup.php');")"
+
+    if [ "$EXPECTED_CHECKSUM" != "$ACTUAL_CHECKSUM" ]
+    then
+        >&2 echo 'ERROR: Invalid installer checksum'
+        rm composer-setup.php
+        return 1
+    fi
+
+    php composer-setup.php --quiet
+    local RESULT=$?
+    rm composer-setup.php
+    [ $RESULT -eq 0 ] && return 0
+    return 1
+}
+
+
+cd "$RCM_DIR"
+
+# install composer into root of roundcubemail
+if [ ! -e "composer.phar" ]; then
+    install_composer
+fi
+
+# update dependencies
+cd "plugins/carddav"
+../../composer.phar install --no-interaction --no-plugins --no-dev
diff --git a/setup/mods.available/roundcube-debug.sh b/setup/mods.available/roundcube-debug.sh
new file mode 100755
index 00000000..6bea6c43
--- /dev/null
+++ b/setup/mods.available/roundcube-debug.sh
@@ -0,0 +1,28 @@
+#!/bin/bash
+
+#
+# this mod will enable roundcube debugging output. output goes
+# /var/log/roundcubemail
+#
+
+source setup/functions.sh # load our functions
+source /etc/mailinabox.conf # load global vars
+
+# where webmail.sh installs roundcube
+RCM_DIR=/usr/local/lib/roundcubemail
+CONF=${1:-$RCM_DIR/config/config.inc.php}
+
+php tools/editconf.php $CONF config \
+    'log_driver' 'file' \
+    'syslog_facility' 'constant("LOG_MAIL")' \
+    'debug_level' '4' \
+    'imap_debug' 'true' \
+    'imap_log_session' 'true' \
+    'sql_debug' 'true' \
+    'smtp_debug' 'true' \
+    'session_debug' 'true' \
+    'log_logins' 'true' \
+    'log_errors' 'true' \
+    'per_user_logging' 'false' \
+    'session_lifetime' '2'
+
diff --git a/setup/mods.available/roundcube-master.sh b/setup/mods.available/roundcube-master.sh
new file mode 100755
index 00000000..fc9febc5
--- /dev/null
+++ b/setup/mods.available/roundcube-master.sh
@@ -0,0 +1,120 @@
+#!/bin/bash
+
+#
+# this mod will install the latest master branch version of roundcube
+#
+
+source setup/functions.sh # load our functions
+source /etc/mailinabox.conf # load global vars
+
+echo "Installing latest Roundcube master branch"
+
+# where webmail.sh installs roundcube
+RCM_DIR=/usr/local/lib/roundcubemail
+
+# source files of the master branch
+master_zip_url="https://github.com/roundcube/roundcubemail/archive/master.zip"
+
+# git clone url
+master_git_url="https://github.com/roundcube/roundcubemail.git"
+master_tag="${RC_CLONE_TAG:-master}"
+
+
+install_composer() {
+    # https://getcomposer.org/doc/faqs/how-to-install-composer-programmatically.md
+    local EXPECTED_CHECKSUM="$(wget -q -O - https://composer.github.io/installer.sig)"
+    php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+    local ACTUAL_CHECKSUM="$(php -r "echo hash_file('sha384', 'composer-setup.php');")"
+
+    if [ "$EXPECTED_CHECKSUM" != "$ACTUAL_CHECKSUM" ]
+    then
+        >&2 echo 'ERROR: Invalid installer checksum'
+        rm composer-setup.php
+        return 1
+    fi
+
+    php composer-setup.php --quiet
+    local RESULT=$?
+    rm composer-setup.php
+    [ $RESULT -eq 0 ] && return 0
+    return 1
+}
+
+
+process_zip() {
+    zip="/tmp/roundcube-master.zip"
+    hide_output wget -O "$zip" "$master_zip_url"
+
+    # set working directory to /usr/local/lib
+    pushd $(dirname "$RCM_DIR") >/dev/null
+
+    # rename active installation directory (/usr/local/lib/roundcubemail)
+    # to roundcubemail-master so current installation is overwritten
+    # during unzip
+    mv $(basename "$RCM_DIR") roundcubemail-master
+
+    # unzip master sources, overwriting current installation
+    unzip -q -o "$zip"
+
+    # rename back to expected installation directory
+    mv roundcubemail-master $(basename "$RCM_DIR")
+
+    # remove the temp file
+    rm -f "$zip"
+}
+
+
+
+process_git() {
+    # set working directory to /usr/local/lib
+    pushd $(dirname "$RCM_DIR") >/dev/null
+
+    # clone to roundcubemail-master
+    git clone --branch "$master_tag" --depth 1 "$master_git_url" "roundcubemail-master"
+
+    # checkout the desired branch/ref
+    cd "roundcubemail-master"
+    # if [ ! -e "program/steps/login/oauth.inc" ]; then
+    #     git checkout `git rev-list -n 1 --before="2020-10-02 00:00" master`
+    # fi
+    
+    # copy and overwrite existing installation
+    tar cf - . | (cd "$RCM_DIR"; tar xf -)
+
+    # remove clone
+    cd ..
+    rm -rf "roundcubemail-master"    
+}
+
+
+process_git
+
+# run composer to update dependencies
+cd "$RCM_DIR"
+
+# 1. install 'dist' composer.json that came with master
+if [ -e "composer.json" -a ! -e "composer.json.orig" ]; then
+    mv composer.json composer.json.orig
+fi
+if [ -e "composer.lock" -a ! -e "composer.lock.orig" ]; then
+    mv composer.lock composer.lock.orig
+fi
+rm -f composer.json
+rm -f composer.lock
+cp composer.json-dist composer.json
+
+# 2. install composer
+if [ ! -e "composer.phar" ]; then
+    install_composer
+fi
+
+# 3. update dependencies
+php composer.phar --no-interaction --no-plugins --no-dev install
+php composer.phar --no-interaction --no-plugins require "kolab/net_ldap3"
+
+# revert working directory
+popd >/dev/null
+
+# done
+echo "Roundcube sources from $master_tag branch successfully installed"
+
diff --git a/tools/editconf.php b/tools/editconf.php
new file mode 100644
index 00000000..6d661ee3
--- /dev/null
+++ b/tools/editconf.php
@@ -0,0 +1,124 @@
+<?php
+
+#
+# Edit a Nextcloud or other config.php file
+#
+# Specify the path to config.php as the first argument.
+#
+# Specify the name of the config variable as the second argument.
+#
+# Subsequent arguments specify the name and value pairs of elements to
+#  change or add. Each element of the pair are separate
+#  arguments. Arrays should be specified as "array(...)".
+#
+# Names may be preceeded with '+' to indicate that the value should be
+# added, but not modify an existing value if it already exists.
+#
+# For example, to set dbhost to 'localhost' and trusted_domains to an
+# array of values:
+#
+#   php editconfig.php /usr/local/lib/roundcubemail/config/config.inc.php config dbhost localhost trusted_domains "array(0=>'localhost',1=>'127.0.0.1')"
+#
+# The original file is MODIFIED in-place!!!
+#
+
+require($argv[1]);
+$config_var_name = $argv[2];
+$configref = &$$config_var_name;
+
+$dry_run = false;
+
+function print_array($v, $level, $fp) {
+  fwrite($fp, "array (\n");
+
+  if ((array) $v !== $v) {
+     foreach($v as $kv) {
+         fwrite($fp, $kv . ",");
+     }
+  }
+  else {
+     foreach($v as $key => $kv) {
+       fwrite($fp,str_repeat('    ', $level));
+       if (is_string($key)) {
+          fwrite($fp,"'" . $key . "' => ");
+       }
+       else {
+          fwrite($fp,$key . " => ");
+       }
+       
+       if (is_array($kv)) {
+           print_array($kv, $level+1, $fp);
+       }
+       else if (is_string($kv)) {
+           fwrite($fp,"'" . $kv . "',\n");
+       }
+       else if (is_bool($kv)) {
+           fwrite($fp, ($kv ? 'true' : 'false') . ",\n");
+       }
+       else {
+           fwrite($fp,$kv . ",\n");
+       }
+     }
+  }
+  fwrite($fp,str_repeat('    ', $level-1));
+  fwrite($fp,")");
+  if ($level>1) fwrite($fp,",\n");
+}
+
+
+for($i=3; $i<count($argv); $i+=2) {
+   $overwrite = true;
+   
+   $name=$argv[$i];
+   if (substr($name,0,1) == "+") {
+       $overwrite = false;
+       $name=substr($name,1);
+   }
+
+   $value=$argv[$i+1];
+   if(substr($value,0,5) == "array") {
+       $value = eval('return ' . $value . ';');
+   }
+   else if (substr($value,0,8) == "constant") {
+       $value = eval('return ' . $value . ';');
+   }
+   else if (is_numeric($value)) {
+       if (strstr($value, ".") === FALSE) $value = intval($value);
+       else $value = floatval($value);
+   }
+   else if ($value == "true") {
+       $value = true;
+   }
+   else if ($value == "false") {
+       $value = false;
+   }
+
+   if ($overwrite || ! array_key_exists($name, $configref)) {
+       $configref[$name] = $value;
+   }
+}
+
+
+if ($dry_run) {
+   $fp = STDOUT;
+} else {
+   $fp = fopen($argv[1] . ".new", "w");
+}
+
+fwrite($fp, "<?php\n");
+fwrite($fp, "\$$config_var_name=");
+print_array($configref, 1, $fp);
+fwrite($fp, ";\n");
+fwrite($fp, "?>\n");
+fclose($fp);
+
+# ok - rename
+if (! $dry_run) {
+   if (file_exists($argv[1] . ".old")) {
+      unlink($argv[1] . ".old");
+   }
+   rename($argv[1], $argv[1] . ".old");
+   rename($argv[1] . ".new", $argv[1]);
+}
+
+?>