digikam 4:5.6.0-0ubuntu10 / usr / bin / cleanup_digikamdb

#!/bin/sh

# Author: Andi Clemens, <andi dot clemens at gmail dot com>
#
# Description:
#
# This script will read in the digiKam configuration file to determine the
# database location. It will then make sure that digiKam is not running and
# call "sqlite3 DATABASE 'VACUUM;" on the database, to clean up and optimize
# the tables.
# This will often lead to great performance gain and a smaller database file
# size.

# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# FUNCTIONS
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------

# $1: char
# $2: count (optional)
repeat_char()
{
    local header_offset=20
    for i in $(seq ${2:-$header_offset}); do
        echo -n "$1"
    done
}

# -----------------------------------------------------------------------------

# $*: string
pretty_header()
{
    # use an offset to center text
    local offset=$(repeat_char " ")
    local offset_length=$(expr $(expr length "${offset}") \* 2)

    # calculate length
    local str_length=$(expr length "$*")
    local length=$(expr ${str_length} + ${offset_length})

    # delimiter line
    local delimiter=$(repeat_char "-" ${length})

    # print header
    echo "${delimiter}"
    echo "${offset}$*${offset}"
    echo "${delimiter}"
}

# -----------------------------------------------------------------------------

# $1: config key
readConfigValue()
{
    local config_file="digikamrc"
    local config_group="Database Settings"
    local db_dir=$(kreadconfig --file "${config_file}" --group "${config_group}" --key "$1")
    echo "${db_dir}"
}


# -----------------------------------------------------------------------------

checkForRunningProgram()
{
    local proc=$(pgrep -u $USER -x digikam)
    if [ "${proc}" != "" ]
    then
        echo "Please shutdown ${digikam_name} before running this script."
        return 1
    fi
    return 0
}

# -----------------------------------------------------------------------------

checkDatabaseType()
{
    local db_type=$(readConfigValue "Database Type")
    if [ "${db_type}" != "QSQLITE" ]
    then
        echo "This program only handles SQLite databases."
        return 1
    fi
    return 0
}

# -----------------------------------------------------------------------------

help()
{
    cat <<EOF
Usage: $(basename $0) <options>

options:
  -t            Include thumbnail databases
  -T            Only cleanup thumbnail databases
  -p <path>     Specify a different database path.
                If the specified path is invalid, the entry from the configuration file will be used.
  -h            Show this help.
EOF
    exit 1
}

# -----------------------------------------------------------------------------

cleanupDB()
{
    cd "$1" > /dev/null 2>&1
    if [ $? = 0 ]; then
        local db_out="${output_str_database}:"
        echo "${output_str_location}:  $(pwd)"

        for db in $(eval "find . ${db_find_cmd} 2> /dev/null")
        do
            echo -n "${db_out} ${db} ... "
            sqlite3 ${db} "VACUUM;"
            if [ $? = 0 ]
            then
                echo "done!"
            else
                echo "failed!"
            fi
        done
        echo
        echo "=> Finished"
    else
        echo
        echo "I was not able to enter the database folder."
        echo
        echo "Make sure that the variable '${config_key}' in your 'digikamrc' config file"
        echo "is set correctly and that you have permissions to access the database folder."
    fi
}


# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# MAIN
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------

script_name="Cleanup Databases"
script_version="1.1"

digikam_name="digiKam"
digikam_version=$(digikam -v | grep "${digikam_name}" | cut -d: -f2 | sed 's/ //g')

db_dir=$(readConfigValue "Database Name")
db_digikam="digikam[34].db"
db_thumbs="thumbnails-digikam.db"

output_str_location="Location"
output_str_database="Database"

db_find_args="-type f"
db_find_cmd="${db_find_args} -name '${db_digikam}'"

# -----------------------------------------------------------------------------

while getopts "tTp:h" Option
do
    case ${Option} in
        t)  db_find_cmd="${db_find_cmd} -or -name '${db_thumbs}'";;
        T)  db_find_cmd="${db_find_args} -name '${db_thumbs}'";;
        p)  if [ -n ${OPTARG} ]; then 
                if [ -d ${OPTARG} ]; then
                    db_dir=${OPTARG}
                fi
            fi;;
        h)  help;;
        *)  help;;
    esac
done

# -----------------------------------------------------------------------------

pretty_header "${script_name} v${script_version} (${digikam_name} ${digikam_version})"

checkForRunningProgram
if [ $? = 1 ]; then
    exit 1
fi

checkDatabaseType
if [ $? = 1 ]; then
    exit 1
fi

# -----------------------------------------------------------------------------

# backup current working dir
curdir=$(pwd)

# -----------------------------------------------------------------------------

# try to enter the database directory
cleanupDB ${db_dir}

# -----------------------------------------------------------------------------

# restore old working dir
cd ${curdir}