cqtpm

#!/bin/sh
# CQ Unix Toolkit
# Copyright (C) 2021 Wunderman Thompson Technology
#
# 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.
_usage() {
    cat <<EOT
Usage: $(basename "${0}") [OPTION...]
Invoke TAR PersistenceManager optimization/compaction process for specified CQ
instance in the background by default with 1 ms sleeping phase between each
TarPM transaction. There is possibility to invoke compaction in the background
and polling its status in the foreground to wait until operation is finished.
 
Examples:
  cqtpm -u admin -f -s 60        # Invoke compaction in the background and waits 
                                 # in the foreground (using status pooling every
                                 # minute) for the end of process
  cqtpm -i http://localhost:5510 # Invoke compaction for localhost instance on
                                 # tcp port 5510
  cqtpm -p secret -d 2           # Invoke compaction in the background using 
                                 # provided password: secret, with additional
                                 # delay 2ms between optimization transaction

Options:

  -u                    use specified username for connection
  -p                    use provided password for authentication
  -i                    use specified instance URL to connect
  -f                    simulates optimization in the foreground as blocking 
                        operation. This may not work for all versions.
  -s                    sets delay in seconds between each status pooling 
                        request (default 10 seconds). Used only when -f 
                        parameter is specified.
  -d                    sets delay in milliseconds (default 1 ms) between each
                        compacted transaction

EOT
    exit 1
}

CWD=$(dirname "${0}")
API="${CWD}/cqapi"
"${API}" -P >/dev/null
if [ ${?} -ne 0 ]; then
    echo "Fatal: cannot find or test cqapi command" >&2
    exit 1
fi

CURLBIN=$("${API}" -c)
if [ ${?} -ne 0 ]; then
    echo "Fatal: cannot find curl" >&2
    exit 1
fi

# API common options
cmdapi=$("${API}" -P "${@}")
username=$(echo "${cmdapi}" | cut -f1)
password=$(echo "${cmdapi}" | cut -f2)
instance=$(echo "${cmdapi}" | cut -f3)
passed=$(echo "${cmdapi}" | cut -f4)
apigetopts=$(echo "${cmdapi}" | cut -f5)

# Custom arguments
background=true
pooling=10
pooling_set=0
delayms=1
while getopts ":fs:d:${apigetopts}" opt; do
    case ${opt} in
    f)
        background=false
        ;;
    s)
        pooling=$(echo "${OPTARG}" | tr -cd '0-9' | cut -c1-4)
        pooling_set=1
        ;;
    d)
        delayms=$(echo "${OPTARG}" | tr -cd '0-9' | cut -c1-3)
        ;;
    \?)
        echo "Invalid option: -${OPTARG}" >&2
        _usage
        ;;
    :)
        echo "Option -${OPTARG} requires an argument." >&2
        _usage
        ;;
    esac
done
shift $((OPTIND - 1))

if [ ${pooling_set} -eq 1 -a "${background}" = "true" ]; then
    _usage
fi

if [ ${#} -ge 1 -o "${passed}" -eq 0 ]; then
    _usage
fi

REFERER="${instance}/system/console/jmx/com.adobe.granite%3Atype%3DRepository"
AUTH="${username}:${password}"
REFERERHEADER="Referer: ${REFERER}"

ECHON=$(which echo)
[ ${?} -ne 0 -o -z "${ECHON}" ] && ECHON="echo" || ECHON="${ECHON} -n "
${ECHON} "Stopping current TarPM compaction (if started)..."
FILEPATH="/system/console/jmx/com.adobe.granite%3Atype%3DRepository/op/stopTar\
Optimization/"
STATUS=$(${CURLBIN} \
    -s \
    -u "${AUTH}" \
    --write-out "%{http_code}" \
    -H "${REFERERHEADER}" \
    -X POST \
    "${instance}${FILEPATH}")

EXITCODE=${?}
"${API}" -C ${EXITCODE}
if [ ${EXITCODE} -ne 0 ]; then
    echo "Cannot stop TarPM optimization." >&2
    exit ${EXITCODE}
fi

STATUSCODE=$(echo "${STATUS}" | tail -n 1)
STATUS=$(echo "${STATUS}" | sed '$d;s/(null)//')
echo "${STATUS}"
"${API}" -H "${STATUSCODE}"
EXITCODE2=${?}
if [ ${EXITCODE2} -ne 0 ]; then
    echo "Cannot stop TarPM optimization." >&2
    exit ${EXITCODE2}
fi

${ECHON} "Setting TarPM compaction sleeping phase..."
FILEPATH="/system/console/jmx/com.adobe.granite%3Atype%3DRepository/a/TarOptimi\
zationDelay"
STATUS=$(${CURLBIN} \
    -s \
    -u "${AUTH}" \
    --write-out "%{http_code}" \
    -H "${REFERERHEADER}" \
    -X POST --data "value=${delayms}" \
    "${instance}${FILEPATH}")

EXITCODE=${?}
"${API}" -C ${EXITCODE}
if [ ${EXITCODE} -ne 0 ]; then
    echo "Cannot set compaction delay to ${delay} ms." >&2
    exit ${EXITCODE}
fi

STATUSCODE=$(echo "${STATUS}" | tail -n 1)
STATUS=$(echo "${STATUS}" | sed '$d;s/(null)//')
echo "${STATUS}"
"${API}" -H "${STATUSCODE}"
EXITCODE2=${?}
if [ ${EXITCODE2} -ne 0 ]; then
    echo "Cannot set compaction delay to ${delay} ms."
    exit ${EXITCODE2}
fi

if [ "${background}" = "false" ]; then
    background_text="foreground"
else
    background_text="background"
fi

${ECHON} "Running TarPM compaction in the ${background_text}..."
FILEPATH="/system/console/jmx/com.adobe.granite%3Atype%3DRepository/op/startTar\
Optimization/"
STATUS=$(${CURLBIN} \
    -s \
    -u "${AUTH}" \
    --write-out "%{http_code}" \
    -H "${REFERERHEADER}" \
    -X POST \
    "${instance}${FILEPATH}")

EXITCODE=${?}
"${API}" -C ${EXITCODE}

if [ ${EXITCODE} -ne 0 ]; then
    echo "Cannot start TarPM compaction." >&2
    exit ${EXITCODE}
fi

STATUSCODE=$(echo "${STATUS}" | tail -n 1)
STATUS=$(echo "${STATUS}" | sed '$d;s/(null)//')
echo "${STATUS}"
"${API}" -H "${STATUSCODE}"
EXITCODE2=${?}
if [ ${EXITCODE2} -ne 0 ]; then
    echo "Cannot start TarPM compaction." >&2
    exit ${EXITCODE2}
fi

FILEPATH="/system/console/jmx/com.adobe.granite%3Atype%3DRepository/"
if [ "${background}" = "false" ]; then
    echo "Pooling TarPM optimization status..."
    tarpm_status="1"

    while [ "${tarpm_status}" != "0" ]; do
        sleep "${pooling}s"
        STATUS=$(${CURLBIN} \
            -s \
            -u "${AUTH}" \
            --write-out "%{http_code}" \
            -H "${REFERERHEADER}" \
            "${instance}${FILEPATH}")
        STATUSCODE=$(echo "${STATUS}" | tail -n 1)
        "${API}" -H "${STATUSCODE}"
        if [ ${EXITCODE} -ne 0 ]; then
            echo "Cannot pool properly TarPM compaction status" >&2
            exit ${EXITCODE}
        fi

        tarpm_status=$(echo "${STATUS}" | grep TarOptimizationRunningSince | tr -cd '0-9 ' | tr -s ' ' | sed 's#^ *##' | cut -f2 -d ' ')
        if [ -z "${tarpm_status}" ]; then
            tarpm_status=0
        fi
    done
    echo "DONE"
fi