[CalendarServer-changes] [7538] CalendarServer/trunk/contrib/tools/backup
source_changes at macosforge.org
source_changes at macosforge.org
Fri May 27 09:45:45 PDT 2011
Revision: 7538
http://trac.macosforge.org/projects/calendarserver/changeset/7538
Author: sagen at apple.com
Date: 2011-05-27 09:45:44 -0700 (Fri, 27 May 2011)
Log Message:
-----------
A basic backup/restore utility
Added Paths:
-----------
CalendarServer/trunk/contrib/tools/backup
Added: CalendarServer/trunk/contrib/tools/backup
===================================================================
--- CalendarServer/trunk/contrib/tools/backup (rev 0)
+++ CalendarServer/trunk/contrib/tools/backup 2011-05-27 16:45:44 UTC (rev 7538)
@@ -0,0 +1,230 @@
+#!/usr/bin/python
+
+##
+# Copyright (c) 2011 Apple Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+from getopt import getopt, GetoptError
+import os
+import subprocess
+import sys
+import tarfile
+from tempfile import mkstemp
+from shutil import rmtree
+
+from twistedcaldav.config import config
+from calendarserver.tools.util import loadConfig
+
+USERNAME = "caldav"
+DATABASENAME = "caldav"
+DUMPFILENAME = "db_backup"
+PLISTPATH = "/etc/caldavd/caldavd.plist"
+PLISTNAME = "caldavd.plist"
+
+PSQL = "/usr/bin/psql"
+PGDUMP = "/usr/bin/pg_dump"
+
+def usage(e=None):
+ name = os.path.basename(sys.argv[0])
+ print "usage: %s [options] command backup-file" % (name,)
+ print ""
+ print " Backup or restore calendar and addressbook data"
+ print ""
+ print "options:"
+ print " -f --config <path>: Specify caldavd.plist configuration path"
+ print " -h --help: print this help and exit"
+ print " -v --verbose: print additional information"
+ print ""
+ print "commands:"
+ print " backup: create backup-file"
+ print " restore: restore from backup-file"
+ print ""
+
+ if e:
+ sys.stderr.write("%s\n" % (e,))
+ sys.exit(64)
+ else:
+ sys.exit(0)
+
+
+def dumpData(dumpFile, verbose=False):
+ """
+ Use pg_dump to dump data to dumpFile
+ """
+
+ cmdArgs = [
+ PGDUMP,
+ "--username=%s" % (USERNAME,),
+ "--clean",
+ "--no-privileges",
+ "--file=%s" % (dumpFile,),
+ DATABASENAME
+ ]
+ try:
+ if verbose:
+ print "\nDumping data to %s" % (dumpFile,)
+ print "Executing: %s" % (" ".join(cmdArgs))
+ out = subprocess.check_output(cmdArgs, stderr=subprocess.STDOUT)
+ if verbose:
+ print out
+ except subprocess.CalledProcessError, e:
+ if verbose:
+ print e.output
+ raise BackupError(
+ "%s failed:\n%s (exit code = %d)" %
+ (PGDUMP, e.output, e.returncode)
+ )
+
+
+def loadData(dumpFile, verbose=False):
+ """
+ Use psql to load data from dumpFile
+ """
+
+ cmdArgs = [
+ PSQL,
+ "--username=%s" % (USERNAME,),
+ "--file=%s" % (dumpFile,)
+ ]
+ try:
+ if verbose:
+ print "\nLoading data from %s" % (dumpFile,)
+ print "Executing: %s" % (" ".join(cmdArgs))
+ out = subprocess.check_output(cmdArgs, stderr=subprocess.STDOUT)
+ if verbose:
+ print out
+ except subprocess.CalledProcessError, e:
+ if verbose:
+ print e.output
+ raise BackupError(
+ "%s failed:\n%s (exit code = %d)" %
+ (PGDUMP, e.output, e.returncode)
+ )
+
+
+class BackupError(Exception):
+ pass
+
+
+def error(s):
+ sys.stderr.write("%s\n" % (s,))
+ sys.exit(1)
+
+
+def main():
+ try:
+ (optargs, args) = getopt(
+ sys.argv[1:], "f:hv", [
+ "config=",
+ "help",
+ "verbose",
+ ],
+ )
+ except GetoptError, e:
+ usage(e)
+
+ verbose = False
+ configFileName = None
+
+ for opt, arg in optargs:
+ if opt in ("-h", "--help"):
+ usage()
+ elif opt in ("-f", "--config"):
+ configFileName = arg
+ elif opt in ("-v", "--verbose"):
+ verbose = True
+ else:
+ raise NotImplementedError(opt)
+
+ if len(args) != 2:
+ usage("Must specify a command and a backup-file name.")
+
+ command = args[0]
+ filename = args[1]
+
+ loadConfig(configFileName)
+
+ serverRoot = config.ServerRoot
+ dataRoot = config.DataRoot
+ docRoot = config.DocumentRoot
+
+ if command == "backup":
+
+ fd, tmpPath = mkstemp(suffix=".dbdump")
+
+ try:
+ dumpData(tmpPath, verbose=verbose)
+
+ if verbose:
+ print "Creating %s" % (filename,)
+ tar = tarfile.open(filename, "w:gz")
+ if verbose:
+ print "Adding %s" % (dataRoot,)
+ tar.add(dataRoot, "Data")
+ if verbose:
+ print "Adding %s" % (docRoot,)
+ tar.add(docRoot, "Documents")
+ if verbose:
+ print "Adding %s" % (tmpPath,)
+ tar.add(tmpPath, DUMPFILENAME)
+ if verbose:
+ print "Adding %s" % (PLISTPATH,)
+ tar.add(PLISTPATH, PLISTNAME)
+ tar.close()
+
+ if verbose:
+ print "Removing %s" % (tmpPath,)
+ os.remove(tmpPath)
+
+ if verbose:
+ print "Done"
+ except BackupError, e:
+ error("Failed to dump database; error: %s" % (e,))
+
+ elif command == "restore":
+
+ try:
+ tar = tarfile.open(filename, "r:gz")
+ os.chdir(serverRoot)
+
+ if os.path.exists(dataRoot):
+ if verbose:
+ print "Removing old DataRoot: %s" % (dataRoot,)
+ rmtree(dataRoot)
+
+ if os.path.exists(docRoot):
+ if verbose:
+ print "Removing old DocumentRoot: %s" % (docRoot,)
+ rmtree(docRoot)
+
+ if verbose:
+ print "Extracting from backup file: %s" % (filename,)
+ tar.extractall()
+
+ loadData(DUMPFILENAME, verbose=verbose)
+
+ if verbose:
+ print "Cleaning up database dump file: %s" % (DUMPFILENAME,)
+ os.remove(DUMPFILENAME)
+
+ except BackupError, e:
+ error("Failed to dump database; error: %s" % (e,))
+ raise
+
+ else:
+ error("Unknown command '%s'" % (command,))
+
+if __name__ == "__main__":
+ main()
Property changes on: CalendarServer/trunk/contrib/tools/backup
___________________________________________________________________
Added: svn:executable
+ *
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20110527/9d64addc/attachment-0001.html>
More information about the calendarserver-changes
mailing list