openship 0.4.4 → 0.4.6

package/dist/server/engine/tools/backup_mysql.sh

@@ -0,0 +1,238 @@
+#!/usr/bin/env bash
+# Author:   Zhang Huangbin (zhb@iredmail.org)
+# Date:     16/09/2007
+# Purpose:  Backup specified mysql databases with command 'mysqldump'.
+# License:  This shell script is part of iRedMail project, released under
+#           GPL v2.
+
+###########################
+# REQUIREMENTS
+###########################
+#
+#   * Required commands:
+#       + mysqldump
+#       + du
+#       + bzip2     # If bzip2 is not available, change 'CMD_COMPRESS'
+#                   # to use 'gzip'.
+#
+
+###########################
+# USAGE
+###########################
+#
+#   * It stores all backup copies in directory '/var/vmail/backup' by default,
+#     You can change it in variable $BACKUP_ROOTDIR below.
+#
+#   * Set correct values for below variables:
+#
+#       BACKUP_ROOTDIR
+#       MYSQL_ROOT_USER
+#       DATABASES
+#       DB_CHARACTER_SET
+#
+#   * Add crontab job for root user (or whatever user you want):
+#
+#       # crontab -e -u root
+#       1   4   *   *   *   bash /path/to/backup_mysql.sh
+#
+#   * Make sure 'crond' service is running, and will start automatically when
+#     system startup:
+#
+#       # ---- On RHEL/CentOS ----
+#       # chkconfig --level 345 crond on
+#       # /etc/init.d/crond status
+#
+#       # ---- On Debian/Ubuntu ----
+#       # update-rc.d cron defaults
+#       # /etc/init.d/cron status
+#
+
+#########################################################
+# Modify below variables to fit your need ----
+#########################################################
+# Keep backup for how many days. Default is 90 days.
+KEEP_DAYS='90'
+
+# Where to store backup copies.
+export BACKUP_ROOTDIR='/var/vmail/backup'
+
+# MySQL username. Root user is required to dump all databases.
+export MYSQL_ROOT_USER='root'
+
+# ~/.my.cnf
+export MYSQL_DOT_MY_CNF='/root/.my.cnf'
+
+# Databases we should backup.
+# Multiple databases MUST be seperated by SPACE.
+export DATABASES='mysql vmail roundcubemail amavisd iredadmin sogo iredapd sa_bayes'
+
+# Database character set for ALL databases.
+# Note: Currently, it doesn't support to specify character set for each databases.
+export DB_CHARACTER_SET="utf8"
+
+#########################################################
+# You do *NOT* need to modify below lines.
+#########################################################
+export PATH='/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/usr/local/sbin'
+
+# Commands.
+export CMD_DATE='/bin/date'
+export CMD_DU='du -sh'
+export CMD_COMPRESS='bzip2 -9'
+export COMPRESS_SUFFIX='bz2'
+export CMD_MYSQL="mysql --defaults-file=${MYSQL_DOT_MY_CNF} -u${MYSQL_ROOT_USER}"
+export CMD_MYSQLDUMP="mysqldump --defaults-file=${MYSQL_DOT_MY_CNF} -u${MYSQL_ROOT_USER} --events --ignore-table=mysql.event --default-character-set=${DB_CHARACTER_SET} --skip-comments"
+
+# Date.
+export YEAR="$(${CMD_DATE} +%Y)"
+export MONTH="$(${CMD_DATE} +%m)"
+export DAY="$(${CMD_DATE} +%d)"
+export TIME="$(${CMD_DATE} +%H-%M-%S)"
+export TIMESTAMP="${YEAR}-${MONTH}-${DAY}-${TIME}"
+
+# Pre-defined backup status
+export BACKUP_SUCCESS='YES'
+
+# Define, check, create directories.
+export BACKUP_DIR="${BACKUP_ROOTDIR}/mysql/${YEAR}/${MONTH}/${DAY}"
+
+# Find the old backup which should be removed.
+export REMOVE_OLD_BACKUP='YES'
+
+export KERNEL="$(uname -s)"
+if [[ X"${KERNEL}" == X'Linux' ]]; then
+    shift_year=$(date --date="${KEEP_DAYS} days ago" "+%Y")
+    shift_month=$(date --date="${KEEP_DAYS} days ago" "+%m")
+    shift_day=$(date --date="${KEEP_DAYS} days ago" "+%d")
+elif [[ X"${KERNEL}" == X'FreeBSD' ]]; then
+    shift_year=$(date -j -v-${KEEP_DAYS}d "+%Y")
+    shift_month=$(date -j -v-${KEEP_DAYS}d "+%m")
+    shift_day=$(date -j -v-${KEEP_DAYS}d "+%d")
+elif [[ X"${KERNEL}" == X'OpenBSD' ]]; then
+    epoch_seconds_now="$(date +%s)"
+    epoch_shift="$((${KEEP_DAYS} * 86400))"
+    epoch_seconds_old="$((epoch_seconds_now - epoch_shift))"
+
+    shift_year=$(date -r ${epoch_seconds_old} "+%Y")
+    shift_month=$(date -r ${epoch_seconds_old} "+%m")
+    shift_day=$(date -r ${epoch_seconds_old} "+%d")
+else
+    export REMOVE_OLD_BACKUP='NO'
+fi
+
+export REMOVED_BACKUP_DIR="${BACKUP_ROOTDIR}/mysql/${shift_year}/${shift_month}/${shift_day}"
+export REMOVED_BACKUP_MONTH_DIR="${BACKUP_ROOTDIR}/mysql/${shift_year}/${shift_month}"
+export REMOVED_BACKUP_YEAR_DIR="${BACKUP_ROOTDIR}/mysql/${shift_year}"
+
+# Log file
+export LOGFILE="${BACKUP_DIR}/${TIMESTAMP}.log"
+
+# Verify MySQL connection.
+${CMD_MYSQL} -e "show databases" &>/dev/null
+if [ X"$?" != X"0" ]; then
+    echo "[ERROR] MySQL username or password is incorrect in file ${0}." 1>&2
+    echo "Please fix them first." 1>&2
+
+    exit 255
+fi
+
+# Check and create directories.
+[ ! -d ${BACKUP_DIR} ] && mkdir -p ${BACKUP_DIR} 2>/dev/null
+chown root ${BACKUP_DIR}
+chmod 0400 ${BACKUP_DIR}
+
+# Initialize log file.
+echo "* Starting backup: ${TIMESTAMP}." >${LOGFILE}
+echo "* Backup directory: ${BACKUP_DIR}." >>${LOGFILE}
+chmod 0400 ${LOGFILE}
+
+# Check whether iredadmin database exists.
+# Used for logging backup status in iredadmin database.
+export has_iredadmin="NO"
+if echo ${DATABASES} | grep 'iredadmin' &>/dev/null; then
+    has_iredadmin="YES"
+fi
+
+# Backup.
+echo "* Backing up databases: ${DATABASES}." >> ${LOGFILE}
+for db in ${DATABASES}; do
+    #backup_db ${db} >>${LOGFILE}
+
+    #if [ X"$?" == X"0" ]; then
+    #    echo "  - ${db} [DONE]" >> ${LOGFILE}
+    #else
+    #    [ X"${BACKUP_SUCCESS}" == X'YES' ] && export BACKUP_SUCCESS='NO'
+    #fi
+    output_sql="${BACKUP_DIR}/${db}-${TIMESTAMP}.sql"
+
+    # Check database existence
+    ${CMD_MYSQL} -e "USE ${db}" &>/dev/null
+
+    if [ X"$?" == X'0' ]; then
+        # Dump
+        ${CMD_MYSQLDUMP} ${db} > ${output_sql}
+        chmod 0400 ${output_sql}
+
+        if [ X"$?" == X'0' ]; then
+            # Get original SQL file size
+            original_size="$(${CMD_DU} ${output_sql} | awk '{print $1}')"
+
+            # Compress
+            ${CMD_COMPRESS} ${output_sql} >>${LOGFILE}
+            chmod 0400 ${output_sql}.*
+
+            if [ X"$?" == X'0' ]; then
+                rm -f ${output_sql} >> ${LOGFILE}
+            fi
+
+            # Get compressed file size
+            compressed_file_name="${output_sql}.${COMPRESS_SUFFIX}"
+            compressed_size="$(${CMD_DU} ${compressed_file_name} | awk '{print $1}')"
+
+            sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'Database: ${db}, size: ${compressed_size} (original: ${original_size})', 'cron_backup_sql', '127.0.0.1', UTC_TIMESTAMP());"
+        else
+            # backup failed
+            export BACKUP_SUCCESS='NO'
+            sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'Database backup failed: ${db}. Log: $(cat ${LOGFILE})', 'cron_backup_sql', '127.0.0.1', UTC_TIMESTAMP());"
+        fi
+
+        # Log to SQL table `iredadmin.log`, so that global domain admins can
+        # check backup status (System -> Admin Log)
+        if [[ ${has_iredadmin} == "YES" ]]; then
+            ${CMD_MYSQL} iredadmin -e "${sql_log_msg}"
+        fi
+    fi
+done
+
+# Append file size of backup files.
+echo -e "* File size:\n----" >>${LOGFILE}
+cd ${BACKUP_DIR} && \
+${CMD_DU} *${TIMESTAMP}*sql* >>${LOGFILE}
+echo "----" >>${LOGFILE}
+
+echo "* Backup completed (Success? ${BACKUP_SUCCESS})." >>${LOGFILE}
+
+if [ X"${BACKUP_SUCCESS}" == X'YES' ]; then
+    echo "==> Backup completed successfully."
+else
+    echo -e "==> Backup completed with !!!ERRORS!!!.\n" 1>&2
+fi
+
+if [[ X"${REMOVE_OLD_BACKUP}" == X'YES' ]] && [[ -d "${REMOVED_BACKUP_DIR}" ]]; then
+    echo -e "* Old backup found. Deleting: ${REMOVED_BACKUP_DIR}." >>${LOGFILE}
+    rm -rf ${REMOVED_BACKUP_DIR} >> ${LOGFILE} 2>&1
+
+    # Try to remove empty directory.
+    rmdir ${REMOVED_BACKUP_MONTH_DIR} 2>/dev/null
+    rmdir ${REMOVED_BACKUP_YEAR_DIR} 2>/dev/null
+
+    sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'Remove old backup: ${REMOVED_BACKUP_DIR}.', 'cron_backup_sql', '127.0.0.1', UTC_TIMESTAMP());"
+
+    if [[ ${has_iredadmin} == "YES" ]]; then
+        ${CMD_MYSQL} iredadmin -e "${sql_log_msg}"
+    fi
+fi
+
+echo "==> Detailed log (${LOGFILE}):"
+echo "========================="
+cat ${LOGFILE}

package/dist/server/engine/tools/backup_openldap.sh

@@ -0,0 +1,230 @@
+#!/usr/bin/env bash
+
+# Author:   Zhang Huangbin (zhb@iredmail.org)
+# Date:     Mar 15, 2012
+# Purpose:  Dump whole LDAP tree with command 'slapcat'.
+# License:  This shell script is part of iRedMail project, released under
+#           GPL v2.
+
+###########################
+# REQUIREMENTS
+###########################
+#
+#   * Required commands:
+#       + slapcat
+#       + du
+#       + bzip2 # If bzip2 is not available, change 'CMD_COMPRESS' to use 'gzip'.
+#
+
+###########################
+# USAGE
+###########################
+#
+#   * It stores all backup copies in directory '/var/vmail/backup' by default,
+#     You can change it with variable $BACKUP_ROOTDIR below.
+#
+#   * Set correct values for below variables:
+#
+#       BACKUP_ROOTDIR
+#
+#   * Add crontab job for root user (or whatever user you want):
+#
+#       # crontab -e -u root
+#       1   4   *   *   *   bash /path/to/backup_openldap.sh
+#
+#   * Make sure 'crond' service is running, and will start automatically when
+#     system startup:
+#
+#       # ---- On RHEL/CentOS ----
+#       # chkconfig --level 345 crond on
+#       # /etc/init.d/crond status
+#
+#       # ---- On Debian/Ubuntu ----
+#       # update-rc.d cron defaults
+#       # /etc/init.d/cron status
+#
+
+###############################
+# How to restore backup file:
+###############################
+# Please refer to wiki tutorial for detail steps:
+# http://www.iredmail.org/docs/backup.restore.html
+#
+
+#########################################################
+# Modify below variables to fit your need ----
+#########################################################
+# Where to store backup copies.
+export BACKUP_ROOTDIR='/var/vmail/backup'
+
+# Keep backup for how many days. Default is 90 days.
+export KEEP_DAYS='90'
+
+#########################################################
+# You do *NOT* need to modify below lines.
+#########################################################
+
+export PATH="$PATH:/usr/sbin:/usr/local/sbin/"
+
+# Commands.
+export CMD_DATE='/bin/date'
+export CMD_DU='du -sh'
+export CMD_COMPRESS='bzip2 -9'
+export COMPRESS_SUFFIX='bz2'
+export CMD_MYSQL='mysql'
+
+# MySQL user and password, used to log backup status to sql table `iredadmin.log`.
+# You can find password of SQL user 'iredadmin' in iRedAdmin config file 'settings.py'.
+#
+# If MYSQL_PASSWD is empty, read password from /root/.my.cnf instead.
+export MYSQL_USER='root'
+export MYSQL_PASSWD=''
+export MYSQL_DOT_MY_CNF='/root/.my.cnf'
+
+if [ -f /etc/ldap/slapd.conf ]; then
+    export CMD_SLAPCAT='slapcat -f /etc/ldap/slapd.conf'
+elif [ -f /etc/openldap/slapd.conf ]; then
+    export CMD_SLAPCAT='slapcat -f /etc/openldap/slapd.conf'
+elif [ -f /usr/local/etc/openldap/slapd.conf ]; then
+    export CMD_SLAPCAT='slapcat -f /usr/local/etc/openldap/slapd.conf'
+else
+    export CMD_SLAPCAT='slapcat'
+fi
+
+# Date.
+export YEAR="$(${CMD_DATE} +%Y)"
+export MONTH="$(${CMD_DATE} +%m)"
+export DAY="$(${CMD_DATE} +%d)"
+export TIME="$(${CMD_DATE} +%H-%M-%S)"
+export TIMESTAMP="${YEAR}-${MONTH}-${DAY}-${TIME}"
+
+# Pre-defined backup status
+export BACKUP_SUCCESS='NO'
+
+#########
+# Define, check, create directories.
+#
+# Backup directory.
+export BACKUP_DIR="${BACKUP_ROOTDIR}/ldap/${YEAR}/${MONTH}"
+export BACKUP_FILE="${BACKUP_DIR}/${TIMESTAMP}.ldif"
+
+# Find the old backup which should be removed.
+export REMOVE_OLD_BACKUP='YES'
+
+export KERNEL="$(uname -s)"
+if [[ X"${KERNEL}" == X'Linux' ]]; then
+    shift_year=$(date --date="${KEEP_DAYS} days ago" "+%Y")
+    shift_month=$(date --date="${KEEP_DAYS} days ago" "+%m")
+    shift_day=$(date --date="${KEEP_DAYS} days ago" "+%d")
+elif [[ X"${KERNEL}" == X'FreeBSD' ]]; then
+    shift_year=$(date -j -v-${KEEP_DAYS}d "+%Y")
+    shift_month=$(date -j -v-${KEEP_DAYS}d "+%m")
+    shift_day=$(date -j -v-${KEEP_DAYS}d "+%d")
+elif [[ X"${KERNEL}" == X'OpenBSD' ]]; then
+    epoch_seconds_now="$(date +%s)"
+    epoch_shift="$((${KEEP_DAYS} * 86400))"
+    epoch_seconds_old="$((epoch_seconds_now - epoch_shift))"
+
+    shift_year=$(date -r ${epoch_seconds_old} "+%Y")
+    shift_month=$(date -r ${epoch_seconds_old} "+%m")
+    shift_day=$(date -r ${epoch_seconds_old} "+%d")
+else
+    export REMOVE_OLD_BACKUP='NO'
+fi
+
+export REMOVED_BACKUP_DIR="${BACKUP_ROOTDIR}/ldap/${shift_year}/${shift_month}"
+export REMOVED_BACKUP_MONTH_DIR="${BACKUP_ROOTDIR}/ldap/${shift_year}/${shift_month}"
+export REMOVED_BACKUP_YEAR_DIR="${BACKUP_ROOTDIR}/ldap/${shift_year}"
+export REMOVED_BACKUPS="${BACKUP_ROOTDIR}/ldap/${shift_year}/${shift_month}/${shift_year}-${shift_month}-${shift_day}-*"
+
+# Log file
+export LOGFILE="${BACKUP_DIR}/${TIMESTAMP}.log"
+
+# Check and create directories.
+[ -d ${BACKUP_DIR} ] || mkdir -p ${BACKUP_DIR}
+chown root ${BACKUP_DIR}
+chmod 0700 ${BACKUP_DIR}
+
+# Initialize log file.
+echo "* Starting backup at ${TIMESTAMP}" >> ${LOGFILE}
+echo "* Backup directory: ${BACKUP_DIR}." >> ${LOGFILE}
+
+# Backup
+echo "* Dumping LDAP data into file: ${BACKUP_FILE}..." >> ${LOGFILE}
+${CMD_SLAPCAT} > ${BACKUP_FILE}
+
+if [ X"$?" == X"0" ]; then
+    export BACKUP_SUCCESS='YES'
+
+    # Get original backup file size
+    original_size="$(${CMD_DU} ${BACKUP_FILE} | awk '{print $1}')"
+
+    # Compress backup file.
+    echo "* Compressing LDIF file with command: '${CMD_COMPRESS}' ..." >> ${LOGFILE}
+    ${CMD_COMPRESS} ${BACKUP_FILE} >> ${LOGFILE} 2>&1
+
+    echo "* [DONE]" >>${LOGFILE}
+
+    # Get compressed file size
+    compressed_file_name="${BACKUP_FILE}.${COMPRESS_SUFFIX}"
+    compressed_size="$(${CMD_DU} ${compressed_file_name} | awk '{print $1}')"
+
+    echo -n "* Removing plain LDIF file: ${BACKUP_FILE}..." >>${LOGFILE}
+    rm -f ${BACKUP_FILE} >> ${LOGFILE} 2>&1
+    [ X"$?" == X"0" ] && echo -e "\t[DONE]" >>${LOGFILE}
+
+    sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'Backup LDAP data, size: ${original_size}, compressed: ${compressed_size}', 'cron_backup_ldap', '127.0.0.1', UTC_TIMESTAMP());"
+else
+    # Log failure
+    sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'Backup LDAP data failed, check log file ${LOGFILE} for more details.', 'cron_backup_ldap', '127.0.0.1', UTC_TIMESTAMP());"
+fi
+
+# Log to SQL table `iredadmin.log`, so that global domain admins can
+# check backup status (System -> Admin Log)
+export LOG_BACKUP_STATUS='YES'
+if [[ -n ${MYSQL_USER} ]]; then
+    if [[ -n ${MYSQL_PASSWD} ]]; then
+        export CMD_MYSQL_ROOT="${CMD_MYSQL} -u${MYSQL_USER} -p${MYSQL_PASSWD}"
+    else
+        export CMD_MYSQL_ROOT="${CMD_MYSQL} --defaults-file=${MYSQL_DOT_MY_CNF} -u${MYSQL_USER}"
+    fi
+
+    ${CMD_MYSQL_ROOT} -e "USE iredadmin;" &>/dev/null
+    if [[ X"$?" != X'0' ]]; then
+        export LOG_BACKUP_STATUS='NO'
+    fi
+fi
+
+if [[ X"${LOG_BACKUP_STATUS}" == X'YES' ]]; then
+    ${CMD_MYSQL_ROOT} iredadmin -e "${sql_log_msg}" >>${LOGFILE} 2>&1
+fi
+
+# Append file size of backup files to log file.
+echo "* File size:" >>${LOGFILE}
+echo "=================" >>${LOGFILE}
+${CMD_DU} ${BACKUP_FILE}* >>${LOGFILE}
+echo "=================" >>${LOGFILE}
+
+# Print some message. It will cause cron generates an email to root user.
+if [ X"${BACKUP_SUCCESS}" == X'YES' ]; then
+    echo "* [ OK ] Backup completes successfully." >> ${LOGFILE}
+else
+    echo "* <<< ERROR >>> Backup not successfully complete." >> ${LOGFILE}
+fi
+
+if [ X"${REMOVE_OLD_BACKUP}" == X'YES' -a -d ${REMOVED_BACKUP_DIR} ]; then
+    echo -e "* Delete old backup under ${REMOVED_BACKUP_DIR}." >> ${LOGFILE}
+    echo -e "* Suppose to delete: ${REMOVED_BACKUPS}" >> ${LOGFILE}
+    rm -rf ${REMOVED_BACKUPS} >> ${LOGFILE} 2>&1
+
+    # Try to remove empty directory.
+    rmdir ${REMOVED_BACKUP_MONTH_DIR} 2>/dev/null
+    rmdir ${REMOVED_BACKUP_YEAR_DIR} 2>/dev/null
+
+    if [[ X"${LOG_BACKUP_STATUS}" == X'YES' ]]; then
+        sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'Remove old backup: ${REMOVED_BACKUPS}.', 'cron_backup_sql', '127.0.0.1', UTC_TIMESTAMP());"
+        ${CMD_MYSQL_ROOT} iredadmin -e "${sql_log_msg}"
+    fi
+fi
+
+cat ${LOGFILE}

package/dist/server/engine/tools/backup_pgsql.sh

@@ -0,0 +1,217 @@
+#!/usr/bin/env bash
+
+# Author:   Zhang Huangbin (zhb _at_ iredmail.org)
+# Date:     2012-09-06
+# Purpose:  Backup specified PostgreSQL databases with command 'pg_dump'.
+# License:  This shell script is part of iRedMail project, released under GPLv2.
+
+###########################
+# REQUIREMENTS
+###########################
+#
+#   * Required commands:
+#       + pg_dump
+#       + du
+#       + bzip2     # If bzip2 is not available, change 'CMD_COMPRESS'
+#                   # to use 'gzip'.
+#
+
+###########################
+# USAGE
+###########################
+#
+#   * It stores all backup copies in directory '/var/vmail/backup' by default,
+#     You can change it in variable $BACKUP_ROOTDIR below.
+#
+#   * Set correct values for below variables:
+#
+#       SYS_USER_PGSQL
+#       BACKUP_ROOTDIR
+#       DATABASES
+#
+#   * Add crontab job for root user (or whatever user you want):
+#
+#       # crontab -e -u root
+#       1   4   *   *   *   bash /path/to/backup_pgsql.sh
+#
+#   * Make sure 'crond' service is running.
+#
+
+#########################################################
+# Modify below variables to fit your need ----
+#########################################################
+# Keep backup for how many days. Default is 90 days.
+KEEP_DAYS='90'
+
+# System user used to run PostgreSQL daemon.
+#   - On Linux, it's postgres.
+#   - On FreeBSD, it's pgsql.
+#   - On OpenBSD, it's _postgresql.
+export SYS_USER_PGSQL='postgres'
+
+# Where to store backup copies.
+export BACKUP_ROOTDIR='/var/vmail/backup'
+
+# Databases we should backup.
+# Multiple databases MUST be seperated by SPACE.
+# Your iRedMail server might have below databases:
+# vmail, roundcubemail, cluebringer, amavisd, iredadmin.
+export DATABASES='vmail roundcubemail amavisd iredadmin sogo iredapd sa_bayes'
+
+#########################################################
+# You do *NOT* need to modify below lines.
+#########################################################
+export PATH='/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/usr/local/sbin'
+
+# Commands.
+export CMD_DATE='/bin/date'
+export CMD_DU='du -sh'
+export CMD_COMPRESS='bzip2 -9'
+export COMPRESS_SUFFIX='bz2'
+export CMD_PG_DUMP='pg_dump --clean'
+
+# Date.
+export YEAR="$(${CMD_DATE} +%Y)"
+export MONTH="$(${CMD_DATE} +%m)"
+export DAY="$(${CMD_DATE} +%d)"
+export TIME="$(${CMD_DATE} +%H-%M-%S)"
+export TIMESTAMP="${YEAR}-${MONTH}-${DAY}-${TIME}"
+
+# Pre-defined backup status
+export BACKUP_SUCCESS='YES'
+
+# Define, check, create directories.
+export BACKUP_DIR="${BACKUP_ROOTDIR}/pgsql/${YEAR}/${MONTH}/${DAY}"
+
+# Find the old backup which should be removed.
+export REMOVE_OLD_BACKUP='YES'
+
+export KERNEL="$(uname -s)"
+if [[ X"${KERNEL}" == X'Linux' ]]; then
+    shift_year=$(date --date="${KEEP_DAYS} days ago" "+%Y")
+    shift_month=$(date --date="${KEEP_DAYS} days ago" "+%m")
+    shift_day=$(date --date="${KEEP_DAYS} days ago" "+%d")
+elif [[ X"${KERNEL}" == X'FreeBSD' ]]; then
+    shift_year=$(date -j -v-${KEEP_DAYS}d "+%Y")
+    shift_month=$(date -j -v-${KEEP_DAYS}d "+%m")
+    shift_day=$(date -j -v-${KEEP_DAYS}d "+%d")
+elif [[ X"${KERNEL}" == X'OpenBSD' ]]; then
+    epoch_seconds_now="$(date +%s)"
+    epoch_shift="$((${KEEP_DAYS} * 86400))"
+    epoch_seconds_old="$((epoch_seconds_now - epoch_shift))"
+
+    shift_year=$(date -r ${epoch_seconds_old} "+%Y")
+    shift_month=$(date -r ${epoch_seconds_old} "+%m")
+    shift_day=$(date -r ${epoch_seconds_old} "+%d")
+else
+    export REMOVE_OLD_BACKUP='NO'
+fi
+
+export REMOVED_BACKUP_DIR="${BACKUP_ROOTDIR}/pgsql/${shift_year}/${shift_month}/${shift_day}"
+export REMOVED_BACKUP_MONTH_DIR="${BACKUP_ROOTDIR}/pgsql/${shift_year}/${shift_month}"
+export REMOVED_BACKUP_YEAR_DIR="${BACKUP_ROOTDIR}/pgsql/${shift_year}"
+
+# Log file
+export LOGFILE="${BACKUP_DIR}/${TIMESTAMP}.log"
+
+# Check and create directories.
+[ ! -d ${BACKUP_DIR} ] && mkdir -p ${BACKUP_DIR} 2>/dev/null
+chown root ${BACKUP_DIR}
+chmod 0700 ${BACKUP_DIR}
+
+# Get HOME directory of SYS_USER_PGSQL
+export PGSQL_USER_HOMEDIR="$(su - ${SYS_USER_PGSQL} -c 'echo $HOME')"
+
+# Initialize log file.
+echo "* Starting at: ${YEAR}-${MONTH}-${DAY}-${TIME}." >${LOGFILE}
+echo "* Backup directory: ${BACKUP_DIR}." >>${LOGFILE}
+
+# Check whether iredadmin database exists.
+# Used for logging backup status in iredadmin database.
+export has_iredadmin="NO"
+if echo ${DATABASES} | grep 'iredadmin' &>/dev/null; then
+    has_iredadmin="YES"
+fi
+
+# Backup.
+echo "* Backing up databases: ${DATABASES}." >> ${LOGFILE}
+for db in ${DATABASES}; do
+    output_sql="${db}-${TIMESTAMP}.sql"
+
+    # Check database existence
+    su - "${SYS_USER_PGSQL}" -c "psql -d ${db} -c '\q' >/dev/null 2>&1"
+
+    # Dump
+    if [ X"$?" == X'0' ]; then
+        su - "${SYS_USER_PGSQL}" -c "${CMD_PG_DUMP} ${db} > ${PGSQL_USER_HOMEDIR}/${output_sql}"
+
+        if [ X"$?" == X'0' ]; then
+            # Move to backup directory.
+            mv ${PGSQL_USER_HOMEDIR}/${output_sql} ${BACKUP_DIR}
+
+            cd ${BACKUP_DIR}
+
+            # Get original SQL file size
+            original_size="$(${CMD_DU} ${output_sql} | awk '{print $1}')"
+
+            # Compress
+            ${CMD_COMPRESS} ${output_sql} >>${LOGFILE}
+
+            rm -f ${output_sql} >> ${LOGFILE}
+            echo -e "  + ${db} [DONE]" >> ${LOGFILE}
+
+            # Get compressed file size
+            compressed_file_name="${output_sql}.${COMPRESS_SUFFIX}"
+            compressed_size="$(${CMD_DU} ${compressed_file_name} | awk '{print $1}')"
+
+            # Log to SQL table `iredadmin.log`, so that global domain admins
+            # can check backup status
+            sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'Database: ${db}, size: ${compressed_size} (original: ${original_size})', 'cron_backup_sql', '127.0.0.1', NOW());"
+        else
+            export BACKUP_SUCCESS='NO'
+            sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'Database backup failed: ${db}, check log file ${LOGFILE} for more details.', 'cron_backup_sql', '127.0.0.1', NOW());"
+        fi
+
+        if [[ ${has_iredadmin} == "YES" ]]; then
+            su - "${SYS_USER_PGSQL}" >/dev/null <<EOF
+psql -d iredadmin <<EOF2
+${sql_log_msg}
+EOF2
+EOF
+        fi
+
+    fi
+done
+
+# Append file size of backup files.
+echo -e "* File size:\n----" >>${LOGFILE}
+cd ${BACKUP_DIR} && \
+${CMD_DU} *${TIMESTAMP}*sql* >>${LOGFILE}
+echo "----" >>${LOGFILE}
+
+echo "* Backup completed (Success? ${BACKUP_SUCCESS})." >>${LOGFILE}
+
+if [ X"${BACKUP_SUCCESS}" == X'YES' ]; then
+    echo -e "\n[OK] Backup successfully completed.\n"
+else
+    echo -e "\n[ERROR] Backup completed with ERRORS.\n" 1>&2
+fi
+
+if [ X"${REMOVE_OLD_BACKUP}" == X'YES' -a -d ${REMOVED_BACKUP_DIR} ]; then
+    echo -e "* Old backup found. Deleting: ${REMOVED_BACKUP_DIR}." >>${LOGFILE}
+    rm -rf ${REMOVED_BACKUP_DIR} >> ${LOGFILE} 2>&1
+
+    # Try to remove empty directory.
+    rmdir ${REMOVED_BACKUP_MONTH_DIR} 2>/dev/null
+    rmdir ${REMOVED_BACKUP_YEAR_DIR} 2>/dev/null
+
+    if [[ ${has_iredadmin} == "YES" ]]; then
+        su - ${SYS_USER_PGSQL} -c "psql -d iredadmin" <<EOF
+INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES
+    ('backup', 'info', 'Remove old backup: ${REMOVED_BACKUP_DIR}.', 'cron_backup_sql', '127.0.0.1', NOW());
+EOF
+    fi
+fi
+
+echo "* Backup log: ${LOGFILE}:"
+cat ${LOGFILE}