Package CedarBackup3 :: Package extend :: Module sysinfo
[hide private]
[frames] | no frames]

Source Code for Module CedarBackup3.extend.sysinfo

  1  # -*- coding: iso-8859-1 -*- 
  2  # vim: set ft=python ts=3 sw=3 expandtab: 
  3  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
  4  # 
  5  #              C E D A R 
  6  #          S O L U T I O N S       "Software done right." 
  7  #           S O F T W A R E 
  8  # 
  9  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
 10  # 
 11  # Copyright (c) 2005,2010,2015 Kenneth J. Pronovici. 
 12  # All rights reserved. 
 13  # 
 14  # This program is free software; you can redistribute it and/or 
 15  # modify it under the terms of the GNU General Public License, 
 16  # Version 2, as published by the Free Software Foundation. 
 17  # 
 18  # This program is distributed in the hope that it will be useful, 
 19  # but WITHOUT ANY WARRANTY; without even the implied warranty of 
 20  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 21  # 
 22  # Copies of the GNU General Public License are available from 
 23  # the Free Software Foundation website, http://www.gnu.org/. 
 24  # 
 25  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
 26  # 
 27  # Author   : Kenneth J. Pronovici <pronovic@ieee.org> 
 28  # Language : Python 3 (>= 3.4) 
 29  # Project  : Official Cedar Backup Extensions 
 30  # Purpose  : Provides an extension to save off important system recovery information. 
 31  # 
 32  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
 33   
 34  ######################################################################## 
 35  # Module documentation 
 36  ######################################################################## 
 37   
 38  """ 
 39  Provides an extension to save off important system recovery information. 
 40   
 41  This is a simple Cedar Backup extension used to save off important system 
 42  recovery information.  It saves off three types of information: 
 43   
 44     - Currently-installed Debian packages via C{dpkg --get-selections} 
 45     - Disk partition information via C{fdisk -l} 
 46     - System-wide mounted filesystem contents, via C{ls -laR} 
 47   
 48  The saved-off information is placed into the collect directory and is 
 49  compressed using C{bzip2} to save space. 
 50   
 51  This extension relies on the options and collect configurations in the standard 
 52  Cedar Backup configuration file, but requires no new configuration of its own. 
 53  No public functions other than the action are exposed since all of this is 
 54  pretty simple. 
 55   
 56  @note: If the C{dpkg} or C{fdisk} commands cannot be found in their normal 
 57  locations or executed by the current user, those steps will be skipped and a 
 58  note will be logged at the INFO level. 
 59   
 60  @author: Kenneth J. Pronovici <pronovic@ieee.org> 
 61  """ 
 62   
 63  ######################################################################## 
 64  # Imported modules 
 65  ######################################################################## 
 66   
 67  # System modules 
 68  import os 
 69  import logging 
 70  from bz2 import BZ2File 
 71   
 72  # Cedar Backup modules 
 73  from CedarBackup3.util import resolveCommand, executeCommand, changeOwnership 
 74   
 75   
 76  ######################################################################## 
 77  # Module-wide constants and variables 
 78  ######################################################################## 
 79   
 80  logger = logging.getLogger("CedarBackup3.log.extend.sysinfo") 
 81   
 82  DPKG_PATH      = "/usr/bin/dpkg" 
 83  FDISK_PATH     = "/sbin/fdisk" 
 84   
 85  DPKG_COMMAND   = [ DPKG_PATH, "--get-selections", ] 
 86  FDISK_COMMAND  = [ FDISK_PATH, "-l", ] 
 87  LS_COMMAND     = [ "ls", "-laR", "/", ] 
 88   
 89   
 90  ######################################################################## 
 91  # Public functions 
 92  ######################################################################## 
 93   
 94  ########################### 
 95  # executeAction() function 
 96  ########################### 
 97   
 98  # pylint: disable=W0613 
99 -def executeAction(configPath, options, config):
100 """ 101 Executes the sysinfo backup action. 102 103 @param configPath: Path to configuration file on disk. 104 @type configPath: String representing a path on disk. 105 106 @param options: Program command-line options. 107 @type options: Options object. 108 109 @param config: Program configuration. 110 @type config: Config object. 111 112 @raise ValueError: Under many generic error conditions 113 @raise IOError: If the backup process fails for some reason. 114 """ 115 logger.debug("Executing sysinfo extended action.") 116 if config.options is None or config.collect is None: 117 raise ValueError("Cedar Backup configuration is not properly filled in.") 118 _dumpDebianPackages(config.collect.targetDir, config.options.backupUser, config.options.backupGroup) 119 _dumpPartitionTable(config.collect.targetDir, config.options.backupUser, config.options.backupGroup) 120 _dumpFilesystemContents(config.collect.targetDir, config.options.backupUser, config.options.backupGroup) 121 logger.info("Executed the sysinfo extended action successfully.")
122
123 -def _dumpDebianPackages(targetDir, backupUser, backupGroup, compress=True):
124 """ 125 Dumps a list of currently installed Debian packages via C{dpkg}. 126 @param targetDir: Directory to write output file into. 127 @param backupUser: User which should own the resulting file. 128 @param backupGroup: Group which should own the resulting file. 129 @param compress: Indicates whether to compress the output file. 130 @raise IOError: If the dump fails for some reason. 131 """ 132 if not os.path.exists(DPKG_PATH): 133 logger.info("Not executing Debian package dump since %s doesn't seem to exist.", DPKG_PATH) 134 elif not os.access(DPKG_PATH, os.X_OK): 135 logger.info("Not executing Debian package dump since %s cannot be executed.", DPKG_PATH) 136 else: 137 (outputFile, filename) = _getOutputFile(targetDir, "dpkg-selections", compress) 138 with outputFile: 139 command = resolveCommand(DPKG_COMMAND) 140 result = executeCommand(command, [], returnOutput=False, ignoreStderr=True, doNotLog=True, outputFile=outputFile)[0] 141 if result != 0: 142 raise IOError("Error [%d] executing Debian package dump." % result) 143 if not os.path.exists(filename): 144 raise IOError("File [%s] does not seem to exist after Debian package dump finished." % filename) 145 changeOwnership(filename, backupUser, backupGroup)
146
147 -def _dumpPartitionTable(targetDir, backupUser, backupGroup, compress=True):
148 """ 149 Dumps information about the partition table via C{fdisk}. 150 @param targetDir: Directory to write output file into. 151 @param backupUser: User which should own the resulting file. 152 @param backupGroup: Group which should own the resulting file. 153 @param compress: Indicates whether to compress the output file. 154 @raise IOError: If the dump fails for some reason. 155 """ 156 if not os.path.exists(FDISK_PATH): 157 logger.info("Not executing partition table dump since %s doesn't seem to exist.", FDISK_PATH) 158 elif not os.access(FDISK_PATH, os.X_OK): 159 logger.info("Not executing partition table dump since %s cannot be executed.", FDISK_PATH) 160 else: 161 (outputFile, filename) = _getOutputFile(targetDir, "fdisk-l", compress) 162 with outputFile: 163 command = resolveCommand(FDISK_COMMAND) 164 result = executeCommand(command, [], returnOutput=False, ignoreStderr=True, outputFile=outputFile)[0] 165 if result != 0: 166 raise IOError("Error [%d] executing partition table dump." % result) 167 if not os.path.exists(filename): 168 raise IOError("File [%s] does not seem to exist after partition table dump finished." % filename) 169 changeOwnership(filename, backupUser, backupGroup)
170
171 -def _dumpFilesystemContents(targetDir, backupUser, backupGroup, compress=True):
172 """ 173 Dumps complete listing of filesystem contents via C{ls -laR}. 174 @param targetDir: Directory to write output file into. 175 @param backupUser: User which should own the resulting file. 176 @param backupGroup: Group which should own the resulting file. 177 @param compress: Indicates whether to compress the output file. 178 @raise IOError: If the dump fails for some reason. 179 """ 180 (outputFile, filename) = _getOutputFile(targetDir, "ls-laR", compress) 181 with outputFile: 182 # Note: can't count on return status from 'ls', so we don't check it. 183 command = resolveCommand(LS_COMMAND) 184 executeCommand(command, [], returnOutput=False, ignoreStderr=True, doNotLog=True, outputFile=outputFile) 185 if not os.path.exists(filename): 186 raise IOError("File [%s] does not seem to exist after filesystem contents dump finished." % filename) 187 changeOwnership(filename, backupUser, backupGroup)
188
189 -def _getOutputFile(targetDir, name, compress=True):
190 """ 191 Opens the output file used for saving a dump to the filesystem. 192 193 The filename will be C{name.txt} (or C{name.txt.bz2} if C{compress} is 194 C{True}), written in the target directory. 195 196 @param targetDir: Target directory to write file in. 197 @param name: Name of the file to create. 198 @param compress: Indicates whether to write compressed output. 199 200 @return: Tuple of (Output file object, filename), file opened in binary mode for use with executeCommand() 201 """ 202 filename = os.path.join(targetDir, "%s.txt" % name) 203 if compress: 204 filename = "%s.bz2" % filename 205 logger.debug("Dump file will be [%s].", filename) 206 if compress: 207 outputFile = BZ2File(filename, "wb") 208 else: 209 outputFile = open(filename, "wb") 210 return (outputFile, filename)
211