etc/Server/fmsbackup.Mac.sh

   1 #!/bin/sh
   2 #
   3 #  http://web.sevensdoor.com/download/fmsbackup.sh.txt
   4 #
   5 #  FileMaker Server Backup Script ver.1.5.2
   6 #  Backup FileMaker database files latest n hours and latest n days.
   7 #  This script is written for FileMaker Server 7-11 on Mac OS X.
   8 #
   9 #  Copyright (C) 2007 Koji Takeuchi
  10 #
  11 #  This script is free software; you can redistribute it and/or
  12 #  modify it under the terms of the GNU General Public License
  13 #  as published by the Free Software Foundation; either version 2
  14 #  of the License, or (at your option) any later version.
  15 #
  16 #  This script is distributed in the hope that it will be useful,
  17 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 #  GNU General Public License for more details.
  20 #
  21 #  Koji Takeuchi <takeuchi@nemoux.com>
  22 #  2007.09.20
  23 #
  24 #
  25 #  To use this script:
  26 #  0. Set permission of this file to executable.
  27 #     ex. $ chgrp fmsadmin fmsbackup.sh
  28 #         $ chmod 750 fmsbackup.sh
  29 #  1. You can edit 'set variables' section of this file directly, then
  30 #     run this script.
  31 #     OR
  32 #  2. You can separate 'set variables' section to other files as a 'conf' file.
  33 #     and run this script with arguments to include variables specified on
  34 #     separate 'conf' files.
  35 #     ex. $ ./fmsbackup.sh hourly.conf
  36 #         $ /usr/local/bin/fmsbackup.sh ~/Documents/daily.conf
  37 #
  38 #     If you specify the same variables on both this file and the separate file,
  39 #     this file's variables are replaced by variables loaded from the
  40 #     separate file.
  41 #
  42 #  To run this script periodically:
  43 #  1. Put this script on '/Library/FileMaker Server/Data/Scripts', then
  44 #     use 'System-Level Script' schedule on FileMaker Server 9
  45 #     Admin Console.
  46 #     OR
  47 #  2. Install your crontab.
  48 #     ex: $ crontab -e
  49 #         03 * * * * /usr/local/bin/fmsbackup.sh ~/Documents/hourly.conf
  50 #         30 04 * * * /usr/local/bin/fmsbackup.sh ~/Documents/daily.conf
  51 #
  52 #         In this case, hourly schedule will launch every '**:03',
  53 #         and daily schedule will launch every '04:30'.
  54 #         If you lose your mind when you just enter 'crontab -e',
  55 #         see 'man vi'. (or just type ':q!' and forget it.)
  56 #     OR
  57 #  3. If you are Apple Certified System Administrator, use launchd.
  58 #     Figure out a property list file and save as
  59 #     '/Library/LaunchDaemons/com.example.hourlybackup.plist'.
  60 #     And load the property list file.
  61 #     ex: $ sudo launchctl -w load /Library/LaunchDaemons/com.example.hourlybackup.plist
  62 #
  63 #       - contents of property list file should be like this...
  64 #
  65 #     <?xml version="1.0" encoding="UTF-8"?>
  66 #     <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
  67 #     <plist version="1.0">
  68 #     <dict>
  69 #       <key>Label</key>        <string>com.example.hourlybackup</string>
  70 #       <key>Disabled</key>     <false/>
  71 #       <key>ProgramArguments</key>
  72 #               <array>
  73 #                       <string>/usr/local/bin/fmsbackup.sh</string>
  74 #                       <string>/Users/YOURNAME/Documents/hourly.conf</string>
  75 #               </array>
  76 #       <key>StartCalendarInterval</key>
  77 #                       <dict>
  78 #                               <key>Minute</key>  <integer>03</integer>
  79 #                       </dict>
  80 #       <key>RunAtLoad</key>    <true/>
  81 #     </dict>
  82 #     </plist>
  83 #
  84 #  To get report:
  85 #     Simply redirect to mail command.
  86 #     You can get (sometimes too many) reports via mail.
  87 #     ex: /usr/local/bin/fmsbackup.sh ~/Documents/daily.conf | mail -s "fms backup report" yourname@example.com
  88 #
  89 #
  90 #
  91 #
  92 ################################################
  93 #                set variables                 #
  94 ################################################
  95 #############  Required variables  #############
  96 # user name for fms admin console
  97 user=USERNAME
  98 #
  99 # password for fms admin console
 100 pass=PASSWORD
 101 #
 102 # 'data' path ( parent of Database )
 103 data=/Library/'FileMaker Server'/Data
 104 #
 105 # Database directory path
 106 databases="$data"/Databases
 107 #
 108 # backup directory name
 109 backupdir=Databases
 110 #
 111 # backup directory path
 112 backups=/Library/'FileMaker Server'/Data/Backups
 113 #
 114 # backup Database directory path
 115 backupdatabases="$backups"/"$backupdir"
 116 #
 117 # backup Database directory path for 'fmsadmin backup' command
 118 backupspath="filemac:/'Macintosh HD'$backupdatabases/"
 119 #
 120 # with sub directory? ( y = 1, n = 0 )
 121 subdirectory=1
 122 #
 123 # verify option? ( y = -x, n = "" ) for ver.11 or above
 124 verify=
 125 #
 126 # clone option? ( y = -n, n = "" ) for ver.11 or above
 127 clone=
 128 #
 129 # prefix of archive file name
 130 prefix=servername_fms11
 131 #
 132 # zip or tar.gz? ( zip/tar.gz )
 133 # If you don't need any archiving, just leave it blank
 134 archive=tar.gz
 135 #
 136 #
 137 #
 138 ##########  options for archiving   ###########
 139 #  Archive backup files and keep them latest xx hours ( and xx days )
 140 #  If necessary, set 'hours' or 'days' value to n and edit following variables
 141 #
 142 # how many hours do you want to keep shortest terms backups? ( y = n, n = 0 )
 143 #hour_short=5
 144 #
 145 #  If hour=n, set following variables
 146 #
 147 # hourly generation directory name
 148 #shortlydirectory=archives_shortly
 149 #
 150 # hourly generation directory path
 151 #shortlypath="$backups"/"$shortlydirectory"
 152 #
 153 #
 154 # how many hours do you want to keep hourly backups? ( y = n, n = 0 )
 155 #hour=72
 156 #
 157 #  If hour=n, set following variables
 158 #
 159 # hourly generation directory name
 160 #hourlydirectory=archives_hourly
 161 #
 162 # hourly generation directory path
 163 #hourlypath="$backups"/"$hourlydirectory"
 164 #
 165 #
 166 # how many days do you want to keep daily backups? ( y = n, n = 0 )
 167 #day=30
 168 #
 169 #  If day=n, set following variables
 170 #
 171 # daily generation directory name
 172 #dailydirectory=archives_daily
 173 #
 174 # daily generation directory path
 175 #dailypath="$backups"/"$dailydirectory"
 176 #
 177 #
 178 # how many months do you keep monthly backups? ( y = n, n = 0 )
 179 #month=120
 180 #
 181 #  If month=n, set following variables
 182 #
 183 # monthly generation directory name
 184 #monthlydirectory=archives_monthly
 185 #
 186 # monthly generation directory path
 187 #monthlypath="$backups"/"$monthlydirectory"
 188 #
 189 #
 190 #
 191 ########  options for external volume  #########
 192 #  Syncronize each backup directory to external backup volume
 193 #  If necessary, set 'ext_*ly' value to 1 and edit following variables
 194 #
 195 # mirror shortly directory to external volume? ( y = 1, n = 0 )
 196 #ext_shortly=0
 197 #
 198 # mirror hourly directory to external volume? ( y = 1, n = 0 )
 199 #ext_hourly=0
 200 #
 201 # mirror daily directory to external volume? ( y = 1, n = 0 )
 202 #ext_daily=0
 203 #
 204 # mirror monthly directory to external volume? ( y = 1, n = 0 )
 205 #ext_monthly=0
 206 #
 207 #  If ext_*ly=1, set following variables
 208 #
 209 # external backup directory path
 210 #external=/Volumes/backup_external/fms/
 211 #
 212 #
 213 #
 214 ####  options for alternate backup server 1  #####
 215 #  Syncronize each backup directory to other host via network
 216 #  If necessary, set 'altn_*ly' value to 1 and edit the following variables
 217 #  To use this option, backup server needs the RSA key of FM Server
 218 #
 219 # mirror shortly directory to backup server 1? ( y = 1, n = 0 )
 220 #alt1_shortly=0
 221 #
 222 # mirror hourly directory to backup server 1? ( y = 1, n = 0 )
 223 #alt1_hourly=0
 224 #
 225 # mirror daily directory to backup server 1? ( y = 1, n = 0 )
 226 #alt1_daily=1
 227 #
 228 # mirror monthly directory to backup server 1? ( y = 1, n = 0 )
 229 #alt1_monthly=1
 230 #
 231 #  If altn_*ly=1, set following variables
 232 #
 233 # user name of alternate backup server 1
 234 #host1user=root
 235 #
 236 # host name or IP address of alternate backup server 1
 237 #host1=host.example.com
 238 #
 239 # backup directory path of alternate backup server 1
 240 #host1path=/Volumes/backup_external/foo/fms
 241 #
 242 #
 243 #
 244 ####  options for alternate backup server 2  #####
 245 #  Syncronize each backup directory to other host via network
 246 #  If necessary, set 'altn_*ly' value to 1 and edit the following variables
 247 #  To use this option, backup server needs the RSA key of FM Server
 248 #
 249 # mirror shortly directory to backup server 2? ( y = 1, n = 0 )
 250 #alt2_shortly=0
 251 #
 252 # mirror hourly directory to backup server 2? ( y = 1, n = 0 )
 253 #alt2_hourly=0
 254 #
 255 # mirror daily directory to backup server 2? ( y = 1, n = 0 )
 256 #alt2_daily=1
 257 #
 258 # mirror monthly directory to backup server 2? ( y = 1, n = 0 )
 259 #alt2_monthly=1
 260 #
 261 #  If altn_*ly=1, set following variables
 262 #
 263 # user name of alternate backup server 2
 264 #host2user=root
 265 #
 266 # host name or IP address of alternate backup server 2
 267 #host2=host.example.com
 268 #
 269 # backup directory path of alternate backup server 2
 270 #host2path=/Volumes/backup_external/foo/fms
 271 #
 272 #
 273 #
 274 ################################################
 275 #                load variables                #
 276 ################################################
 277 #######  set variables from other file  ########
 278 #  If run this script with arguments, some of the variables you set above
 279 #  are replaced by contents of file specified by argument
 280 #
 281 # DO NOT EDIT following 5 lines
 282 includes="$1"
 283 #
 284 if [ -r "$includes" ]; then
 285         . "$includes"
 286 fi
 287 #
 288 ################################################
 289 #                fmserver backup               #
 290 ################################################
 291 FMSALIVE=$(ps axww | grep fmserverd | grep -v grep)
 292 ISCONSOLEARRIVE=$(/usr/bin/fmsadmin list files -u "$user" -p "$pass" | grep [Ff][Pp]7 | grep -v grep)
 293 if [ -z "$FMSALIVE" ]; then
 294         echo "FileMaker Server is not working."
 295         echo "exit script."
 296         exit 1
 297 fi
 298 if [ -n "$ISCONSOLEARRIVE" ]; then
 299         echo "fmsadmin is alive."
 300 else
 301         echo "is fmsadmin dead?\n\n$ISCONSOLEARRIVE" | mail -s "`hostname` fmsadmin failure" takeuchi@splash.jp
 302         exit 1
 303 fi
 304 echo "-------------------------------------------------------------------"
 305 echo ""
 306 echo "          `hostname` FileMaker Server Backup Report!"
 307 echo ""
 308 echo "-------------------------------------------------------------------"
 309 echo ""
 310 echo ""
 311 echo ""
 312 echo "1.  Backup database files"
 313 #
 314 #   Delete old files in temporary backup directory
 315 rm -rf "$backupdatabases"/*
 316 #
 317 #       Synchronize source directory to temporary backup directory
 318 cd "$data"
 319 /usr/bin/fmsadmin backup "$backupdir"/*.[FfIi][PpNn][7Ss] "$verify" "$clone" -d "$backupspath" -u "$user" -p "$pass"
 320 if [ "$subdirectory" -eq 1 ]; then
 321         /usr/bin/fmsadmin backup "$backupdir"/*/*.[FfIi][PpNn][7Ss] "$verify" "$clone" -d "$backupspath" -u "$user" -p "$pass"
 322 fi
 323 #
 324 #   Get timestamp for archive file name
 325 shortlyfilename="$prefix"_`date +"%Y_%m_%d_%H%M%S"`
 326 hourlyfilename="$prefix"_`date +"%Y_%m_%d_%H%M%S"`
 327 dailyfilename="$prefix"_`date +"%Y_%m_%d"`
 328 monthlyfilename="$prefix"_`date +"%Y_%m"`
 329 #
 330 echo "    ... Done!"
 331 echo ""
 332 #
 333 #
 334 echo "2.  Deleting old files"
 335 #
 336 #       Delete old files in n hours directory and n days directory
 337 if [ "$hour_short" -gt 0 ]; then
 338         cd "$shortlypath"
 339         find . -type f -mmin +`expr "$hour_short" \* 60` | xargs rm -fv
 340 fi
 341 if [ "$hour" -gt 0 ]; then
 342         cd "$hourlypath"
 343         find . -type f -mmin +`expr "$hour" \* 60` | xargs rm -fv
 344 fi
 345 if [ "$day" -gt 0 ]; then
 346         cd "$dailypath"
 347         find . -type f -mtime +"$day" | xargs rm -fv
 348 fi
 349 echo "    ... Done!"
 350 echo ""
 351 #
 352 #
 353 echo "3.  Archiving files"
 354 #
 355 #       Archive temporary backup directory to zip or tar ball
 356 cd "$backups"
 357 if [ "$archive" = "zip" ]; then
 358         zip -r "$prefix".zip "$backupdir"
 359 elif [ "$archive" = "tar.gz" ]; then
 360         tar czvpf "$prefix".tar.gz "$backupdir"
 361 fi
 362 #
 363 #       Copy archive file to 'nhours directory/prefix_yyyy_MM_dd_hhmmss.tar.gz'
 364 #       and 'ndays directory/prefix_yyyy_MM_dd.tar.gz'
 365 #   and 'nmonths directory/prefix_yyyy_MM.tar.gz'
 366 if [ "$hour_short" -gt 0 ]; then
 367         cp -fp "$prefix"."$archive" "$shortlydirectory"/$shortlyfilename."$archive"
 368 fi
 369 if [ "$hour" -gt 0 ]; then
 370         cp -fp "$prefix"."$archive" "$hourlydirectory"/$hourlyfilename."$archive"
 371 fi
 372 if [ "$day" -gt 0 ]; then
 373         cp -fp "$prefix"."$archive" "$dailydirectory"/$dailyfilename."$archive"
 374 fi
 375 if [ "$month" -gt 0 ]; then
 376         cp -fp "$prefix"."$archive"  "$monthlydirectory"/$monthlyfilename."$archive"
 377 fi
 378 echo "    ... Done!"
 379 echo ""
 380 #
 381 #
 382 ## options for external volume ##
 383 #
 384 if [ "$ext_shortly" -eq 1 ] || [ "$ext_hourly" -eq 1 ] || [ "$ext_daily" -eq 1 ] || [ "$ext_monthly" -eq 1 ]; then
 385         echo "4.  Syncronizing archive files to external drive"
 386 #
 387 #
 388 #       Syncronize each backup directory to alternate backup directory
 389         if [ "$ext_shortly" -eq 1 ]; then
 390                 rsync -vrpo --delete -u --ignore-existing "$shortlydirectory" "$external"
 391         fi
 392         if [ "$ext_hourly" -eq 1 ]; then
 393                 rsync -vrpo --delete -u --ignore-existing "$hourlydirectory" "$external"
 394         fi
 395         if [ "$ext_daily" -eq 1 ]; then
 396                 rsync -vrpo --delete -u --ignore-existing "$dailydirectory" "$external"
 397                 /bin/cp -vp "$dailydirectory"/$dailyfilename."$archive" "$external"/"$dailydirectory"/
 398         fi
 399         if [ "$ext_monthly" -eq 1 ]; then
 400                 rsync -vrpo --delete -u --ignore-existing "$monthlydirectory" "$external"
 401                 /bin/cp -vp "$monthlydirectory"/$monthlyfilename."$archive" "$external"/"$monthlydirectory"/
 402         fi
 403         currentnum=4
 404         echo "    ... Done!"
 405         echo ""
 406 else
 407         currentnum=3
 408 fi
 409 #
 410 #
 411 ## options for alternate backup server 1 ##
 412 #
 413 if [ "$alt1_shortly" -eq 1 ] || [ "$alt1_hourly" -eq 1 ] || [ "$alt1_daily" -eq 1 ] || [ "$alt1_monthly" -eq 1 ]; then
 414         echo `expr "$currentnum" \+ 1`".  Transfering archive files to alternate backup server 1";
 415 #
 416 #
 417 #       Syncronize each backup directory to other host via network
 418         if [ "$alt1_shortly" -eq 1 ]; then
 419                 rsync -vrpo --delete -u --ignore-existing --copy-links -e ssh "$shortlydirectory" "$host1user"@"$host1":"$host1path"/
 420         fi
 421         if [ "$alt1_hourly" -eq 1 ]; then
 422                 rsync -vrpo --delete -u --ignore-existing --copy-links -e ssh "$hourlydirectory" "$host1user"@"$host1":"$host1path"/
 423                 /usr/bin/scp -vp "$hourlydirectory"/$hourlyfilename."$archive" "$host1user"@"$host1":"$host1path"/"$hourlydirectory"/
 424         fi
 425         if [ "$alt1_daily" -eq 1 ]; then
 426                 rsync -vrpo --delete -u --ignore-existing --copy-links -e ssh "$dailydirectory" "$host1user"@"$host1":"$host1path"/
 427                 /usr/bin/scp -vp "$dailydirectory"/$dailyfilename."$archive" "$host1user"@"$host1":"$host1path"/"$dailydirectory"/
 428         fi
 429         if [ "$alt1_monthly" -eq 1 ]; then
 430                 rsync -vrpo --delete -u --ignore-existing --copy-links -e ssh "$monthlydirectory" "$host1user"@"$host1":"$host1path"/
 431                 /usr/bin/scp -vp "$monthlydirectory"/$monthlyfilename."$archive" "$host1user"@"$host1":"$host1path"/"$monthlydirectory"/
 432         fi
 433 echo "    ... Done!"
 434 echo ""
 435 echo ""
 436 fi
 437 #
 438 #
 439 ## options for alternate backup server 2 ##
 440 #
 441 if [ "$alt2_shortly" -eq 1 ] || [ "$alt2_hourly" -eq 1 ] || [ "$alt2_daily" -eq 1 ] || [ "$alt2_monthly" -eq 1 ]; then
 442         echo `expr "$currentnum" \+ 1`".  Transfering archive files to alternate backup server 2";
 443 #
 444 #
 445 #       Syncronize each backup directory to other host via network
 446         if [ "$alt2_shortly" -eq 1 ]; then
 447                 rsync -vrpo --delete -u --ignore-existing --copy-links -e ssh "$shortlydirectory" "$host2user"@"$host2":"$host2path"/
 448         fi
 449         if [ "$alt2_hourly" -eq 1 ]; then
 450                 rsync -vrpo --delete -u --ignore-existing --copy-links -e ssh "$hourlydirectory" "$host2user"@"$host2":"$host2path"/
 451                                 /usr/bin/scp -vp "$hourlydirectory"/$hourlyfilename."$archive" "$host2user"@"$host2":"$host2path"/"$hourlydirectory"/
 452         fi
 453         if [ "$alt2_daily" -eq 1 ]; then
 454                 rsync -vrpo --delete -u --ignore-existing --copy-links -e ssh "$dailydirectory" "$host2user"@"$host2":"$host2path"/
 455                 /usr/bin/scp -vp "$dailydirectory"/$dailyfilename."$archive" "$host2user"@"$host2":"$host2path"/"$dailydirectory"/
 456         fi
 457         if [ "$alt2_monthly" -eq 1 ]; then
 458                 rsync -vrpo --delete -u --ignore-existing --copy-links -e ssh "$monthlydirectory" "$host2user"@"$host2":"$host2path"/
 459                 /usr/bin/scp -vp "$monthlydirectory"/$monthlyfilename."$archive" "$host2user"@"$host2":"$host2path"/"$monthlydirectory"/
 460         fi
 461 echo "    ... Done!"
 462 echo ""
 463 echo ""
 464 fi
 465 #
 466 #
 467 ## Report what was done ##
 468 #
 469 echo "Now $databases is copied to"
 470 echo "    $backupdatabases"
 471 if [ "$hour_short" -gt 0 ]; then
 472         echo "and archived to $shortlypath/$shortlyfilename.$archive."
 473 fi
 474 if [ "$hour" -gt 0 ]; then
 475         echo "and archived to $hourlypath/$hourlyfilename.$archive."
 476 fi
 477 if [ "$day" -gt 0 ]; then
 478         echo "and archived to $dailypath/$dailyfilename.$archive."
 479 fi
 480 if [ "$month" -gt 0 ]; then
 481         echo "and archived to $monthlypath/$monthlyfilename.$archive."
 482 fi
 483 if [ "$ext_shortly" -eq 1 ]; then
 484         echo "and $shortlypath directory is mirrored to"
 485         echo "    $external"
 486 fi
 487 if [ "$ext_hourly" -eq 1 ]; then
 488         echo "and $hourlypath directory is mirrored to"
 489         echo "    $external"
 490 fi
 491 if [ "$ext_daily" -eq 1 ]; then
 492         echo "and $dailypath directory is mirrored to"
 493         echo "    $external"
 494 fi
 495 if [ "$ext_monthly" -eq 1 ]; then
 496         echo "and $monthlypath directory is mirrored to"
 497         echo "    $external"
 498 fi
 499 if [ "$alt1_shortly" -eq 1 ]; then
 500         echo "and $shortlypath directory is mirrored to"
 501         echo "    $host1:$host1path/$shortlydirectory"
 502 fi
 503 if [ "$alt1_hourly" -eq 1 ]; then
 504         echo "and $hourlypath directory is mirrored to"
 505         echo "    $host1:$host1path/$hourlydirectory"
 506 fi
 507 if [ "$alt1_daily" -eq 1 ]; then
 508         echo "and $dailypath directory is mirrored to"
 509         echo "    $host1:$host1path/$dailydirectory"
 510 fi
 511 if [ "$alt1_monthly" -eq 1 ]; then
 512         echo "and $monthlypath directory is mirrored to"
 513         echo "    $host1:$host1path/$monthlydirectory"
 514 fi
 515 if [ "$alt2_shortly" -eq 1 ]; then
 516         echo "and $shortlypath directory is mirrored to"
 517         echo "    $host2:$host2path/$shortlydirectory"
 518 fi
 519 if [ "$alt2_hourly" -eq 1 ]; then
 520         echo "and $hourlypath directory is mirrored to"
 521         echo "    $host2:$host2path/$hourlydirectory"
 522 fi
 523 if [ "$alt2_daily" -eq 1 ]; then
 524         echo "and $dailypath directory is mirrored to"
 525         echo "    $host2:$host2path/$dailydirectory"
 526 fi
 527 if [ "$alt2_monthly" -eq 1 ]; then
 528         echo "and $monthlypath directory is mirrored to"
 529         echo "    $host2:$host2path/$monthlydirectory"
 530 fi
 531 echo ""
 532 echo ""
 533 echo ""
 534 echo "FileMaker Server Backup completed."
 535 echo ""
 536 echo ""
 537 echo ""
 538 echo "----------------------  end of Backup Report  ---------------------"
 539 echo ""
 540 echo ""
 541 exit 0