#!/usr/bin/env bash
#===============================================================================
#
# DIRECTORY:
#   ---
#
# FILE:
#   ./addressbook_plugin.sh
#
# USAGE:
#     . addressbook_plugin.sh
#   OR
#     source addressbook_plugin.sh
#
# DESCRIPTION:
#   AddressBook plugin (library) to generate content with simple template engine.
#
# BUGS:
#   ---
#
# TESTS:
#   - shellcheck -s bash -e SC2034 ./AddressBook_plugin.sh
#   - shellcheck -s ksh -e SC2034 ./AddressBook_plugin.sh
#   - shellcheck -s dash -e SC2034 ./AddressBook_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_addressbook_list
# DESCRIPTION: "Grep" information and store into vars.
# PARAMETERS: none (global vars will be used.)
#===============================================================================
get_addressbook_list () {
	# "8e281be6657d4523710d96341b6f86ba89b56df7" in iTunes Backup.
	readonly ADDRESSBOOK_SQLITE="$( ${BIN_FIND} "${IOS_BACKUP}" -type f -name "AddressBook.sqlitedb" )"
	
	if [ -z "${ADDRESSBOOK_SQLITE}" ] ; then
		readonly ADDRESSBOOK_SOURCE="<code>AddressBook.sqlitedb not found</code>"
		error "AddressBook.sqlitedb not found"
		readonly ADDRESSBOOK_PERSON="<tr><td class='highlight' colspan='4'>ERROR: database not found!</td></tr>"
	else
		readonly ADDRESSBOOK_SOURCE="<a href='AddressBook.sqlitedb' target='_blank'><code>${ADDRESSBOOK_SQLITE/${IOS_BACKUP}/\/private\/var}</code></a>"
		# Don't forget to copy write ahead log!
		${BIN_CP}	"${ADDRESSBOOK_SQLITE}"* "${FOLDER}/"

	  readonly readonly ADDRESSBOOK_PERSON="$( ${BIN_SQLITE3} -html "${FOLDER}/AddressBook.sqlitedb" \
                           "SELECT
                              person.ROWID,
                              person.First,
                              person.Middle,
                              person.Last,
                              multivalue.value
                            FROM
                              ABPerson AS person,
                              ABMultiValue AS multivalue
                            WHERE
                              multivalue.record_id=person.ROWID;" )"

	fi
	
	if [ "${DEBUG}" = "on" ] ; then
		${BIN_PRINTF} "INFO: addressaook_plugin processed.\\n" 1>&2
	fi
}

#-------------------------------------------------------------------------------
# Partial template for hardware information for the simple template engine.
#-------------------------------------------------------------------------------
# SC2034: all "unused" vars are verified!
ADDRESSBOOK_INFORMATION=$( ${BIN_CAT} <<'EOF'
					<h2>AddressBook / Contacts</h2>
					<h4>Sources</h4>
					<ul class="file">
						<li>${ADDRESSBOOK_SOURCE}</li>
					</ul>
					<h3>Contacts</h3>
				 <table>
						<tr>
							<th>ID</th>
							<th>First name</th>
							<th>Middle name</th>
							<th>Last name</th>
							<th>Value</th>
						</tr>
						${ADDRESSBOOK_PERSON}
					</table>
EOF
)

readonly ADDRESSBOOK_PLUGIN_LOADED="true"

if [ "${DEBUG}" = "on" ] ; then
	${BIN_PRINTF} "INFO: addressaook_plugin.sh loaded.\\n" 1>&2
fi
# Do not use "exit" at the end of a sourced library!