/usr/lib/python2.7/dist-packages/obnamlib/app.py is in obnam 1.19.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | # Copyright (C) 2009-2016 Lars Wirzenius
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import logging
import socket
import sys
import time
import tracing
import cliapp
import larch
import ttystatus
import obnamlib
class ObnamIOError(obnamlib.ObnamError):
msg = 'I/O error: {filename}: {errno}: {strerror}'
class ObnamSystemError(obnamlib.ObnamError):
msg = 'System error: {filename}: {errno}: {strerror}'
class App(cliapp.Application):
'''Main program for backup program.'''
def add_settings(self):
# General settings.
self.settings.string(
['repository', 'r'],
'name of backup repository (can be pathname or supported URL)',
metavar='URL')
self.settings.string(
['client-name'],
'name of client (defaults to hostname)',
default=self.deduce_client_name())
self.settings.boolean(
['quiet', 'silent'],
'be silent: show only error messages, no progress updates')
self.settings.boolean(
['verbose'],
'be verbose: tell the user more of what is going on and '
'generally make sure the user is aware of what is happening '
'or at least that something is happening and '
'also make sure their screen is getting updates frequently '
'and that there is changes happening all the time so they '
'do not get bored and that they in fact get frustrated by '
'getting distracted by so many updates that they will move '
'into the Gobi desert to live under a rock')
self.settings.boolean(
['pretend', 'dry-run', 'no-act'],
'do not actually change anything (works with '
'backup, forget and restore only, and may only '
'simulate approximately real behavior)')
self.settings.integer(
['lock-timeout'],
'when locking in the backup repository, '
'wait TIMEOUT seconds for an existing lock '
'to go away before giving up',
metavar='TIMEOUT',
default=60)
# Repository format selection.
self.settings.choice(
['repository-format'],
['6', 'green-albatross'],
'use FORMAT for new repositories; one of "6", "green-albatross"',
metavar='FORMAT')
# Performance related settings.
perf_group = obnamlib.option_group['perf']
self.settings.bytesize(
['node-size'],
'size of B-tree nodes on disk; only affects new '
'B-trees so you may need to delete a client '
'or repository to change this for existing '
'repositories',
default=obnamlib.DEFAULT_NODE_SIZE,
group=perf_group)
self.settings.bytesize(
['chunk-size'],
'size of chunks of file data backed up',
default=obnamlib.DEFAULT_CHUNK_SIZE,
group=perf_group)
self.settings.bytesize(
['upload-queue-size'],
'length of upload queue for B-tree nodes',
default=obnamlib.DEFAULT_UPLOAD_QUEUE_SIZE,
group=perf_group)
self.settings.bytesize(
['lru-size'],
'size of LRU cache for B-tree nodes',
default=obnamlib.DEFAULT_LRU_SIZE,
group=perf_group)
self.settings.integer(
['idpath-depth'],
'depth of chunk id mapping',
default=obnamlib.IDPATH_DEPTH,
group=perf_group)
self.settings.integer(
['idpath-bits'],
'chunk id level size',
default=obnamlib.IDPATH_BITS,
group=perf_group)
self.settings.integer(
['idpath-skip'],
'chunk id mapping lowest bits skip',
default=obnamlib.IDPATH_SKIP,
group=perf_group)
# Settings to help developers and development of Obnam.
devel_group = obnamlib.option_group['devel']
self.settings.string_list(
['trace'],
'add to filename patters for which trace '
'debugging logging happens',
group=devel_group)
self.settings.string(
['pretend-time'],
'pretend it is TIMESTAMP (YYYY-MM-DD HH:MM:SS); '
'this is only useful for testing purposes',
metavar='TIMESTAMP',
group=devel_group)
self.settings.integer(
['crash-limit'],
'artificially crash the program after COUNTER '
'files written to the repository; this is '
'useful for crash testing the application, '
'and should not be enabled for real use; '
'set to 0 to disable (disabled by default)',
metavar='COUNTER',
group=devel_group)
# The following needs to be done here, because it needs
# to be done before option processing. This is a bit ugly,
# but the best we can do with the current cliapp structure.
# Possibly cliapp will provide a better hook for us to use
# later on, but this is reality now.
self.setup_ttystatus()
self.fsf = obnamlib.VfsFactory()
self.repo_factory = obnamlib.RepositoryFactory()
self.setup_hooks()
self.settings['log-level'] = 'info'
def deduce_client_name(self):
return socket.gethostname()
def setup_hooks(self):
self.hooks = obnamlib.HookManager()
self.hooks.new('config-loaded')
self.hooks.new('shutdown')
# The repository factory creates all repository related hooks.
self.repo_factory.setup_hooks(self.hooks)
def setup(self):
self.pluginmgr.plugin_arguments = (self,)
def process_args(self, args):
try:
try:
if self.settings['quiet']:
self.ts.disable()
for pattern in self.settings['trace']:
tracing.trace_add_pattern(pattern)
self.hooks.call('config-loaded')
cliapp.Application.process_args(self, args)
self.hooks.call('shutdown')
except IOError as e:
logging.critical('Caught IOError: %s', str(e), exc_info=True)
raise ObnamIOError(
errno=e.errno, strerror=e.strerror, filename=e.filename)
except OSError as e:
logging.critical('Caught OSError: %s', str(e), exc_info=True)
raise ObnamSystemError(
errno=e.errno, strerror=e.strerror, filename=e.filename)
except larch.Error as e:
logging.critical(str(e), exc_info=True)
sys.stderr.write('ERROR: %s\n' % str(e))
sys.exit(1)
except obnamlib.StructuredError as e:
logging.critical(str(e), exc_info=True)
sys.stderr.write('ERROR: %s\n' % e.formatted())
sys.exit(1)
def setup_ttystatus(self):
self.ts = ttystatus.TerminalStatus(period=0.1)
if self.settings['quiet']:
self.ts.disable()
def get_repository_object(self, create=False, repofs=None):
'''Return an implementation of obnamlib.RepositoryInterface.'''
logging.info('Opening repository: %s', self.settings['repository'])
tracing.trace('create=%s', create)
tracing.trace('repofs=%s', repofs)
repopath = self.settings['repository']
if repofs is None:
repofs = self.fsf.new(repopath, create=create)
if self.settings['crash-limit'] > 0:
repofs.crash_limit = self.settings['crash-limit']
repofs.connect()
else:
repofs.reinit(repopath)
kwargs = {
'lock_timeout': self.settings['lock-timeout'],
'node_size': self.settings['node-size'],
'upload_queue_size': self.settings['upload-queue-size'],
'lru_size': self.settings['lru-size'],
'idpath_depth': self.settings['idpath-depth'],
'idpath_bits': self.settings['idpath-bits'],
'idpath_skip': self.settings['idpath-skip'],
'hooks': self.hooks,
'current_time': self.time,
'chunk_size': self.settings['chunk-size'],
'chunk_cache_size': self.settings['chunk-cache-size'],
'chunk_bag_size': self.settings['chunk-bag-size'],
'dir_cache_size': self.settings['dir-cache-size'],
'dir_bag_size': self.settings['dir-bag-size'],
}
if create:
return self.repo_factory.create_repo(
repofs, self.get_default_repository_class(), **kwargs)
else:
return self.repo_factory.open_existing_repo(repofs, **kwargs)
def get_default_repository_class(self):
classes = {
'6': obnamlib.RepositoryFormat6,
'green-albatross': obnamlib.RepositoryFormatGA,
}
return classes[self.settings['repository-format']]
def time(self):
'''Return current time in seconds since epoch.
This is a wrapper around time.time() so that it can be overridden
with the --pretend-time setting.
'''
s = self.settings['pretend-time']
if s:
t = time.strptime(s, '%Y-%m-%d %H:%M:%S')
return time.mktime(t)
else:
return time.time()
|