functions 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. #!/usr/bin/env bash
  2. #
  3. # Zammad backup script functions
  4. #
  5. function get_zammad_dir () {
  6. ZAMMAD_DIR="$(echo ${BACKUP_SCRIPT_PATH} | sed -e 's#/contrib/backup.*##g')"
  7. }
  8. function get_backup_date () {
  9. TIMESTAMP="$(date +'%Y%m%d%H%M%S')"
  10. if [ "${DEBUG}" == "yes" ]; then
  11. echo "timestamp is ${TIMESTAMP}"
  12. fi
  13. }
  14. function delete_old_backups () {
  15. # Use -mmin to clean up files as -mtime (days) is too unprecise.
  16. # However, add +60 minutes to allow for the backup script run time, so that
  17. # backups created a few minutes more than a day ago are not already purged.
  18. test -d ${BACKUP_DIR} && find ${BACKUP_DIR}/*_zammad_*.gz -type f -mmin +$(((60*24)*${HOLD_DAYS}+60)) -delete
  19. }
  20. function get_db_credentials () {
  21. DB_ADAPTER="$(grep -m 1 '^[[:space:]]*adapter:' < ${ZAMMAD_DIR}/config/database.yml | sed -e 's/.*adapter:[[:space:]]*//g')"
  22. DB_HOST="$(grep -m 1 '^[[:space:]]*host:' < ${ZAMMAD_DIR}/config/database.yml | sed -e 's/.*host:[[:space:]]*//g')"
  23. DB_PORT="$(grep -m 1 '^[[:space:]]*port:' < ${ZAMMAD_DIR}/config/database.yml | sed -e 's/.*port:[[:space:]]*//g')"
  24. DB_NAME="$(grep -m 1 '^[[:space:]]*database:' < ${ZAMMAD_DIR}/config/database.yml | sed -e 's/.*database:[[:space:]]* //g')"
  25. DB_USER="$(grep -m 1 '^[[:space:]]*username:' < ${ZAMMAD_DIR}/config/database.yml | sed -e 's/.*username:[[:space:]]*//g')"
  26. DB_PASS="$(grep -m 1 '^[[:space:]]*password:' < ${ZAMMAD_DIR}/config/database.yml | sed -e 's/.*password:[[:space:]]*//g')"
  27. if [ "${DEBUG}" == "yes" ]; then
  28. echo "adapter=${DB_ADAPTER} dbhost=${DB_HOST} dbport=${DB_PORT} dbname=${DB_NAME} dbuser=${DB_USER} dbpass=${DB_PASS}"
  29. fi
  30. }
  31. function backup_dir_create () {
  32. test -d ${BACKUP_DIR} || mkdir -p ${BACKUP_DIR}
  33. if [ "${DEBUG}" == "yes" ]; then
  34. echo "backup dir is ${BACKUP_DIR}"
  35. fi
  36. }
  37. function backup_files () {
  38. echo "creating file backup..."
  39. tar -C / -czf ${BACKUP_DIR}/${TIMESTAMP}_zammad_files.tar.gz --exclude='tmp' ${ZAMMAD_DIR#/}
  40. ln -sfn ${BACKUP_DIR}/${TIMESTAMP}_zammad_files.tar.gz ${BACKUP_DIR}/latest_zammad_files.tar.gz
  41. }
  42. function create_pgpassfile() {
  43. PGPASSFILE=$(mktemp)
  44. export PGPASSFILE
  45. chmod 600 "$PGPASSFILE"
  46. cat <<EOT > "$PGPASSFILE"
  47. *:*:${DB_NAME}:${DB_USER}:${DB_PASS}
  48. EOT
  49. trap 'rm "$PGPASSFILE"' EXIT
  50. }
  51. function backup_db () {
  52. if [ "${DB_ADAPTER}" == "mysql2" ]; then
  53. echo "creating mysql backup..."
  54. mysqldump --opt --single-transaction -u${DB_USER} -p${DB_PASS} ${DB_NAME} | gzip > ${BACKUP_DIR}/${TIMESTAMP}_zammad_db.mysql.gz
  55. ln -sfn ${BACKUP_DIR}/${TIMESTAMP}_zammad_db.mysql.gz ${BACKUP_DIR}/latest_zammad_db.mysql.gz
  56. elif [ "${DB_ADAPTER}" == "postgresql" ]; then
  57. echo "creating postgresql backup..."
  58. create_pgpassfile
  59. pg_dump --dbname "${DB_NAME}" \
  60. --username "${DB_USER}" \
  61. ${DB_HOST:+--host $DB_HOST} \
  62. ${DB_PORT:+--port $DB_PORT} \
  63. --no-privileges --no-owner \
  64. --compress 6 --file "${BACKUP_DIR}/${TIMESTAMP}_zammad_db.psql.gz"
  65. ln -sfn ${BACKUP_DIR}/${TIMESTAMP}_zammad_db.psql.gz ${BACKUP_DIR}/latest_zammad_db.psql.gz
  66. else
  67. echo "DB ADAPTER not found. if its sqlite backup is already saved in the filebackup"
  68. fi
  69. }
  70. function check_database_config_exists () {
  71. if [ -f ${ZAMMAD_DIR}/config/database.yml ]; then
  72. get_db_credentials
  73. else
  74. echo -e "${ZAMMAD_DIR}/config/database.yml is missing. is Zammad configured yet? \nAborting..."
  75. exit 1
  76. fi
  77. }
  78. function restore_warning () {
  79. if [ -n "${1}" ]; then
  80. CHOOSE_RESTORE="yes"
  81. else
  82. echo -e "The restore will delete your current config and database! \nBe sure to have a backup available! \n"
  83. echo -e "Enter 'yes' if you want to proceed!"
  84. read -p 'Restore?: ' CHOOSE_RESTORE
  85. fi
  86. if [ "${CHOOSE_RESTORE}" != "yes" ]; then
  87. echo "Restore aborted!"
  88. exit 1
  89. fi
  90. }
  91. function get_restore_dates () {
  92. RESTORE_FILE_DATES="$(find ${BACKUP_DIR} -type f -iname '*_zammad_files.tar.gz' | sed -e "s#${BACKUP_DIR}/##g" -e "s#_zammad_files.tar.gz##g" | sort)"
  93. if [ "${DB_ADAPTER}" == "postgresql" ]; then
  94. DB_FILE_EXT="psql"
  95. elif [ "${DB_ADAPTER}" == "mysql2" ]; then
  96. DB_FILE_EXT="mysql"
  97. fi
  98. RESTORE_DB_DATES="$(find ${BACKUP_DIR} -type f -iname "*_zammad_db.${DB_FILE_EXT}.gz" | sed -e "s#${BACKUP_DIR}/##g" -e "s#_zammad_db.${DB_FILE_EXT}.gz##g" | sort)"
  99. }
  100. function choose_restore_date () {
  101. if [ -n "${1}" ]; then
  102. RESTORE_FILE_DATE="${1}"
  103. else
  104. echo -e "Enter file date to restore: \n${RESTORE_FILE_DATES}"
  105. read -p 'File date: ' RESTORE_FILE_DATE
  106. fi
  107. if [ ! -f "${BACKUP_DIR}/${RESTORE_FILE_DATE}_zammad_files.tar.gz" ];then
  108. echo -e "File ${BACKUP_DIR}/${RESTORE_FILE_DATE}_zammad_files.tar.gz does not exist! \nRestore aborted!"
  109. exit 1
  110. fi
  111. if [ -n "${1}" ]; then
  112. RESTORE_DB_DATE="${1}"
  113. else
  114. echo -e "Enter db date to restore: \n${RESTORE_DB_DATES}"
  115. read -p 'DB date: ' RESTORE_DB_DATE
  116. fi
  117. if [ ! -f "${BACKUP_DIR}/${RESTORE_DB_DATE}_zammad_db.${DB_FILE_EXT}.gz" ];then
  118. echo -e "File ${BACKUP_DIR}/${RESTORE_DB_DATE}_zammad_db.${DB_FILE_EXT}.gz does not exist! \nRestore aborted!"
  119. exit 1
  120. fi
  121. }
  122. function detect_initcmd () {
  123. if [ -n "$(which systemctl 2> /dev/null)" ]; then
  124. INIT_CMD="systemctl"
  125. elif [ -n "$(which initctl 2> /dev/null)" ]; then
  126. INIT_CMD="initctl"
  127. else
  128. function sysvinit () {
  129. service $2 $1
  130. }
  131. INIT_CMD="sysvinit"
  132. fi
  133. if [ "${DOCKER}" == "yes" ]; then
  134. INIT_CMD="initctl"
  135. fi
  136. if [ "${DEBUG}" == "yes" ]; then
  137. echo "INIT CMD = ${INIT_CMD}"
  138. fi
  139. }
  140. function start_zammad () {
  141. echo "# Starting Zammad"
  142. ${INIT_CMD} start zammad
  143. }
  144. function stop_zammad () {
  145. echo "# Stopping Zammad"
  146. ${INIT_CMD} stop zammad
  147. }
  148. function restore_zammad () {
  149. if ! command -v zammad > /dev/null; then
  150. # See #3160 for the reasons of this :>
  151. restore_files
  152. fi
  153. if [ "${DB_ADAPTER}" == "postgresql" ]; then
  154. echo "# Checking requirements"
  155. if ! id "zammad" &> /dev/null; then
  156. echo "# ERROR: User 'zammad' is not present, but should be by default! #"
  157. echo "# Restoration was NOT successful, exiting ..."
  158. exit 1
  159. fi
  160. echo "# ... Dropping current database ${DB_NAME}"
  161. # This step is only needed for some pgsql dumps, as they don't provide a drop table statement which will cause
  162. # relation errors during restoration (as on package installation there's always an initialized database)
  163. if command -v zammad > /dev/null; then
  164. zammad config:set DISABLE_DATABASE_ENVIRONMENT_CHECK=1
  165. zammad run rake db:drop
  166. zammad config:set DISABLE_DATABASE_ENVIRONMENT_CHECK=0
  167. else
  168. DISABLE_DATABASE_ENVIRONMENT_CHECK=1 ${ZAMMAD_DIR}/bin/rake db:drop
  169. fi
  170. echo "# ... Creating database ${DB_NAME} for owner ${DB_USER}"
  171. if command -v zammad > /dev/null; then
  172. # We'll skip this part for docker installations
  173. su -c "psql -c \"CREATE DATABASE ${DB_NAME} OWNER ${DB_USER};\"" postgres
  174. else
  175. ${ZAMMAD_DIR}/bin/rake db:create
  176. fi
  177. echo "# Restoring PostgreSQL DB"
  178. create_pgpassfile
  179. zcat < ${BACKUP_DIR}/${RESTORE_DB_DATE}_zammad_db.${DB_FILE_EXT}.gz \
  180. | psql ${DB_HOST:+--host $DB_HOST} ${DB_PORT:+--port $DB_PORT} ${DB_USER:+--username $DB_USER} --dbname ${DB_NAME}
  181. elif [ "${DB_ADAPTER}" == "mysql2" ]; then
  182. echo "# Restoring MySQL DB"
  183. zcat < ${BACKUP_DIR}/${RESTORE_DB_DATE}_zammad_db.${DB_FILE_EXT}.gz | mysql -u${DB_USER} -p${DB_PASS} ${DB_NAME}
  184. fi
  185. if command -v zammad > /dev/null; then
  186. # See #3160 for the reasons of this :>
  187. restore_files
  188. fi
  189. # Ensure all data is loaded from the restored database and not the cache of the previous system state
  190. echo "# Clearing Cache ..."
  191. if command -v zammad > /dev/null; then
  192. zammad run rails r "Cache.clear"
  193. else
  194. ${ZAMMAD_DIR}/bin/rails r "Cache.clear"
  195. fi
  196. }
  197. function restore_files () {
  198. echo "# Restoring Files"
  199. tar -C / --overwrite -xzf ${BACKUP_DIR}/${RESTORE_FILE_DATE}_zammad_files.tar.gz
  200. echo "# Ensuring correct file rights ..."
  201. chown -R zammad:zammad ${ZAMMAD_DIR}
  202. }
  203. function start_backup_message () {
  204. echo -e "\n# Zammad backup started - $(date)!\n"
  205. }
  206. function start_restore_message () {
  207. echo -e "\n# Zammad restored started - $(date)!\n"
  208. }
  209. function finished_backup_message () {
  210. echo -e "\n# Zammad backuped successfully - $(date)!\n"
  211. }
  212. function finished_restore_message () {
  213. echo -e "\n# Zammad restored successfully - $(date)!\n"
  214. }