ios2html/lib/sms_plugin.sh

161 lines
5.0 KiB
Bash
Executable File

#!/usr/bin/env bash
#===============================================================================
#
# DIRECTORY:
# ---
#
# FILE:
# ./sms_plugin.sh
#
# USAGE:
# . sms_plugin.sh
# OR
# source sms_plugin.sh
#
#
# DESCRIPTION:
# SMS/iMessage plugin (library) to generate content with simple template engine.
#
# BUGS:
# ---
#
# TESTS:
# - shellcheck -s bash -e SC2034 ./sms_plugin.sh
# - shellcheck -s ksh -e SC2034 ./sms_plugin.sh
# - shellcheck -s dash -e SC2034 ./sms_plugin.sh
#
# AUTHOR:
# Patrick Neumann, patrick@neumannsland.de
#
# COAUTHOR(S):
# Odin Heitmann, odin.heitmann@gmail.com
#
# COMPANY:
# (privately)
#
# VERSION:
# 1.0
#
# LINK TO THE MOST CURRENT VERSION:
# (Sorry, we bet, I'm not allowed to publish it over GitHub!)
#
# CREATED:
# 2018-06-01
#
# COPYRIGHT (C):
# 2018 - Patrick Neumann & Odin Heitmann
#
# LICENSE:
# This program 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.
#
# WARRANTY:
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
#
# NOTES:
# ---
#
# TODO:
# ---
#
# HISTORY:
# 1.0 - P. N. & O. H. - Initial (for the trainers eyes only) release
#
#===============================================================================
#-------------------------------------------------------------------------------
# Check if functions library is loaded first.
#-------------------------------------------------------------------------------
if [ "${FUNCTIONS_LOADED}" != "true" ] ; then
printf "\\n\\033[01;31;40mERROR: functions library not loaded... EXIT!!!\\033[00m\\n\\n"
exit 200
fi
#-------------------------------------------------------------------------------
# Check if temblate engine library is loaded first.
#-------------------------------------------------------------------------------
if [ "${TEMPLATE_ENGINE_LOADED}" != "true" ] ; then
error_exit "template_engine.sh not loaded" 200
fi
#=== CONFIGURATION (static) ====================================================
#assign_binary "xyz" # (un)common
#=== FUNCTION ==================================================================
# NAME: get_sms_list
# DESCRIPTION: "Grep" information and store into vars.
# PARAMETERS: none (global vars will be used.)
#===============================================================================
get_sms_list () {
# "3d0d7e5fb2ce288813306e4d4636395e047a3d28" in iTunes Backup.
readonly SMS_SQLITE="$( ${BIN_FIND} "${IOS_BACKUP}" -type f -name "sms.db" )"
if [ -z "${SMS_SQLITE}" ] ; then
readonly SMS_SOURCE="<code>sms.db not found</code>"
error "sms.db not found"
readonly SMS_LIST="<tr><td class='highlight' colspan='7'>ERROR: database not found!</td></tr>"
else
readonly SMS_SOURCE="<a href='sms.db' target='_blank'><code>${SMS_SQLITE/${IOS_BACKUP}/\/private\/var}</code></a>"
# * -> Don't forget to copy write ahead log!
${BIN_CP} "${SMS_SQLITE}"* "${FOLDER}/"
readonly SMS_LIST="$( ${BIN_SQLITE3} -html "${FOLDER}/sms.db" \
"SELECT
m.ROWID,
m.text,
m.service,
DATETIME(m.date+978307200, 'unixepoch'),
REPLACE (m.account, 'p:', ''),
CASE WHEN m.is_from_me=0 THEN '<-' ELSE '->' END,
h.id
FROM
message AS m, handle AS h
WHERE
m.handle_id=h.ROWID;" )"
fi
if [ "${DEBUG}" = "on" ] ; then
${BIN_PRINTF} "INFO: sms_plugin processed.\\n" 1>&2
fi
}
#-------------------------------------------------------------------------------
# Partial template for hardware information for the simple template engine.
#-------------------------------------------------------------------------------
# SC2034: all "unused" vars are verified!
SMS_INFORMATION=$( ${BIN_CAT} <<'EOF'
<h2>SMS/iMessage</h2>
<h4>Sources</h4>
<ul class="file">
<li>${SMS_SOURCE}</li>
</ul>
<h3>Information</h3>
<table>
<tr>
<th>ID</th>
<th>Text</th>
<th>Service</th>
<th>Date</th>
<th>Me</th>
<th>Direction</th>
<th>Other</th>
</tr>
${SMS_LIST}
</table>
EOF
)
readonly SMS_PLUGIN_LOADED="true"
if [ "${DEBUG}" = "on" ] ; then
${BIN_PRINTF} "INFO: sms_plugin.sh loaded.\\n" 1>&2
fi
# Do not use "exit" at the end of a sourced library!