archive.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751
  1. from datetime import datetime, timedelta, timezone
  2. from getpass import getuser
  3. from itertools import groupby
  4. import errno
  5. import shutil
  6. import tempfile
  7. from attic.key import key_factory
  8. from attic.remote import cache_if_remote
  9. import msgpack
  10. import os
  11. import socket
  12. import stat
  13. import sys
  14. import time
  15. from io import BytesIO
  16. from attic import xattr
  17. from attic.platform import acl_get, acl_set
  18. from attic.chunker import Chunker
  19. from attic.hashindex import ChunkIndex
  20. from attic.helpers import Error, uid2user, user2uid, gid2group, group2gid, \
  21. Manifest, Statistics, decode_dict, st_mtime_ns, make_path_safe, StableDict, int_to_bigint, bigint_to_int
  22. ITEMS_BUFFER = 1024 * 1024
  23. CHUNK_MIN = 1024
  24. WINDOW_SIZE = 0xfff
  25. CHUNK_MASK = 0xffff
  26. utime_supports_fd = os.utime in getattr(os, 'supports_fd', {})
  27. utime_supports_follow_symlinks = os.utime in getattr(os, 'supports_follow_symlinks', {})
  28. has_mtime_ns = sys.version >= '3.3'
  29. has_lchmod = hasattr(os, 'lchmod')
  30. has_lchflags = hasattr(os, 'lchflags')
  31. # Python <= 3.2 raises OSError instead of PermissionError (See #164)
  32. try:
  33. PermissionError = PermissionError
  34. except NameError:
  35. PermissionError = OSError
  36. class DownloadPipeline:
  37. def __init__(self, repository, key):
  38. self.repository = repository
  39. self.key = key
  40. def unpack_many(self, ids, filter=None, preload=False):
  41. unpacker = msgpack.Unpacker(use_list=False)
  42. for data in self.fetch_many(ids):
  43. unpacker.feed(data)
  44. items = [decode_dict(item, (b'path', b'source', b'user', b'group')) for item in unpacker]
  45. if filter:
  46. items = [item for item in items if filter(item)]
  47. if preload:
  48. for item in items:
  49. if b'chunks' in item:
  50. self.repository.preload([c[0] for c in item[b'chunks']])
  51. for item in items:
  52. yield item
  53. def fetch_many(self, ids, is_preloaded=False):
  54. for id_, data in zip(ids, self.repository.get_many(ids, is_preloaded=is_preloaded)):
  55. yield self.key.decrypt(id_, data)
  56. class ChunkBuffer:
  57. BUFFER_SIZE = 1 * 1024 * 1024
  58. def __init__(self, key):
  59. self.buffer = BytesIO()
  60. self.packer = msgpack.Packer(unicode_errors='surrogateescape')
  61. self.chunks = []
  62. self.key = key
  63. self.chunker = Chunker(WINDOW_SIZE, CHUNK_MASK, CHUNK_MIN, self.key.chunk_seed)
  64. def add(self, item):
  65. self.buffer.write(self.packer.pack(StableDict(item)))
  66. if self.is_full():
  67. self.flush()
  68. def write_chunk(self, chunk):
  69. raise NotImplementedError
  70. def flush(self, flush=False):
  71. if self.buffer.tell() == 0:
  72. return
  73. self.buffer.seek(0)
  74. chunks = list(bytes(s) for s in self.chunker.chunkify(self.buffer))
  75. self.buffer.seek(0)
  76. self.buffer.truncate(0)
  77. # Leave the last partial chunk in the buffer unless flush is True
  78. end = None if flush or len(chunks) == 1 else -1
  79. for chunk in chunks[:end]:
  80. self.chunks.append(self.write_chunk(chunk))
  81. if end == -1:
  82. self.buffer.write(chunks[-1])
  83. def is_full(self):
  84. return self.buffer.tell() > self.BUFFER_SIZE
  85. class CacheChunkBuffer(ChunkBuffer):
  86. def __init__(self, cache, key, stats):
  87. super(CacheChunkBuffer, self).__init__(key)
  88. self.cache = cache
  89. self.stats = stats
  90. def write_chunk(self, chunk):
  91. id_, _, _ = self.cache.add_chunk(self.key.id_hash(chunk), chunk, self.stats)
  92. return id_
  93. class Archive:
  94. class DoesNotExist(Error):
  95. """Archive {} does not exist"""
  96. class AlreadyExists(Error):
  97. """Archive {} already exists"""
  98. def __init__(self, repository, key, manifest, name, cache=None, create=False,
  99. checkpoint_interval=300, numeric_owner=False):
  100. self.cwd = os.getcwd()
  101. self.key = key
  102. self.repository = repository
  103. self.cache = cache
  104. self.manifest = manifest
  105. self.hard_links = {}
  106. self.stats = Statistics()
  107. self.name = name
  108. self.checkpoint_interval = checkpoint_interval
  109. self.numeric_owner = numeric_owner
  110. self.pipeline = DownloadPipeline(self.repository, self.key)
  111. if create:
  112. self.items_buffer = CacheChunkBuffer(self.cache, self.key, self.stats)
  113. self.chunker = Chunker(WINDOW_SIZE, CHUNK_MASK, CHUNK_MIN, self.key.chunk_seed)
  114. if name in manifest.archives:
  115. raise self.AlreadyExists(name)
  116. self.last_checkpoint = time.time()
  117. i = 0
  118. while True:
  119. self.checkpoint_name = '%s.checkpoint%s' % (name, i and ('.%d' % i) or '')
  120. if self.checkpoint_name not in manifest.archives:
  121. break
  122. i += 1
  123. else:
  124. if name not in self.manifest.archives:
  125. raise self.DoesNotExist(name)
  126. info = self.manifest.archives[name]
  127. self.load(info[b'id'])
  128. def load(self, id):
  129. self.id = id
  130. data = self.key.decrypt(self.id, self.repository.get(self.id))
  131. self.metadata = msgpack.unpackb(data)
  132. if self.metadata[b'version'] != 1:
  133. raise Exception('Unknown archive metadata version')
  134. decode_dict(self.metadata, (b'name', b'hostname', b'username', b'time'))
  135. self.metadata[b'cmdline'] = [arg.decode('utf-8', 'surrogateescape') for arg in self.metadata[b'cmdline']]
  136. self.name = self.metadata[b'name']
  137. @property
  138. def ts(self):
  139. """Timestamp of archive creation in UTC"""
  140. t, f = self.metadata[b'time'].split('.', 1)
  141. return datetime.strptime(t, '%Y-%m-%dT%H:%M:%S').replace(tzinfo=timezone.utc) + timedelta(seconds=float('.' + f))
  142. def __repr__(self):
  143. return 'Archive(%r)' % self.name
  144. def iter_items(self, filter=None, preload=False):
  145. for item in self.pipeline.unpack_many(self.metadata[b'items'], filter=filter, preload=preload):
  146. yield item
  147. def add_item(self, item):
  148. self.items_buffer.add(item)
  149. if time.time() - self.last_checkpoint > self.checkpoint_interval:
  150. self.write_checkpoint()
  151. self.last_checkpoint = time.time()
  152. def write_checkpoint(self):
  153. self.save(self.checkpoint_name)
  154. del self.manifest.archives[self.checkpoint_name]
  155. self.cache.chunk_decref(self.id, self.stats)
  156. def save(self, name=None):
  157. name = name or self.name
  158. if name in self.manifest.archives:
  159. raise self.AlreadyExists(name)
  160. self.items_buffer.flush(flush=True)
  161. metadata = StableDict({
  162. 'version': 1,
  163. 'name': name,
  164. 'items': self.items_buffer.chunks,
  165. 'cmdline': sys.argv,
  166. 'hostname': socket.gethostname(),
  167. 'username': getuser(),
  168. 'time': datetime.utcnow().isoformat(),
  169. })
  170. data = msgpack.packb(metadata, unicode_errors='surrogateescape')
  171. self.id = self.key.id_hash(data)
  172. self.cache.add_chunk(self.id, data, self.stats)
  173. self.manifest.archives[name] = {'id': self.id, 'time': metadata['time']}
  174. self.manifest.write()
  175. self.repository.commit()
  176. self.cache.commit()
  177. def calc_stats(self, cache):
  178. def add(id):
  179. count, size, csize = self.cache.chunks[id]
  180. stats.update(size, csize, count == 1)
  181. self.cache.chunks[id] = count - 1, size, csize
  182. def add_file_chunks(chunks):
  183. for id, _, _ in chunks:
  184. add(id)
  185. # This function is a bit evil since it abuses the cache to calculate
  186. # the stats. The cache transaction must be rolled back afterwards
  187. unpacker = msgpack.Unpacker(use_list=False)
  188. cache.begin_txn()
  189. stats = Statistics()
  190. add(self.id)
  191. for id, chunk in zip(self.metadata[b'items'], self.repository.get_many(self.metadata[b'items'])):
  192. add(id)
  193. unpacker.feed(self.key.decrypt(id, chunk))
  194. for item in unpacker:
  195. if b'chunks' in item:
  196. stats.nfiles += 1
  197. add_file_chunks(item[b'chunks'])
  198. cache.rollback()
  199. return stats
  200. def extract_item(self, item, restore_attrs=True, dry_run=False, stdout=False):
  201. if dry_run or stdout:
  202. if b'chunks' in item:
  203. for data in self.pipeline.fetch_many([c[0] for c in item[b'chunks']], is_preloaded=True):
  204. if stdout:
  205. sys.stdout.buffer.write(data)
  206. if stdout:
  207. sys.stdout.buffer.flush()
  208. return
  209. dest = self.cwd
  210. if item[b'path'].startswith('/') or item[b'path'].startswith('..'):
  211. raise Exception('Path should be relative and local')
  212. path = os.path.join(dest, item[b'path'])
  213. # Attempt to remove existing files, ignore errors on failure
  214. try:
  215. st = os.lstat(path)
  216. if stat.S_ISDIR(st.st_mode):
  217. os.rmdir(path)
  218. else:
  219. os.unlink(path)
  220. except OSError:
  221. pass
  222. mode = item[b'mode']
  223. if stat.S_ISDIR(mode):
  224. if not os.path.exists(path):
  225. os.makedirs(path)
  226. if restore_attrs:
  227. self.restore_attrs(path, item)
  228. elif stat.S_ISREG(mode):
  229. if not os.path.exists(os.path.dirname(path)):
  230. os.makedirs(os.path.dirname(path))
  231. # Hard link?
  232. if b'source' in item:
  233. source = os.path.join(dest, item[b'source'])
  234. if os.path.exists(path):
  235. os.unlink(path)
  236. os.link(source, path)
  237. else:
  238. with open(path, 'wb') as fd:
  239. ids = [c[0] for c in item[b'chunks']]
  240. for data in self.pipeline.fetch_many(ids, is_preloaded=True):
  241. fd.write(data)
  242. fd.flush()
  243. self.restore_attrs(path, item, fd=fd.fileno())
  244. elif stat.S_ISFIFO(mode):
  245. if not os.path.exists(os.path.dirname(path)):
  246. os.makedirs(os.path.dirname(path))
  247. os.mkfifo(path)
  248. self.restore_attrs(path, item)
  249. elif stat.S_ISLNK(mode):
  250. if not os.path.exists(os.path.dirname(path)):
  251. os.makedirs(os.path.dirname(path))
  252. source = item[b'source']
  253. if os.path.exists(path):
  254. os.unlink(path)
  255. os.symlink(source, path)
  256. self.restore_attrs(path, item, symlink=True)
  257. elif stat.S_ISCHR(mode) or stat.S_ISBLK(mode):
  258. os.mknod(path, item[b'mode'], item[b'rdev'])
  259. self.restore_attrs(path, item)
  260. else:
  261. raise Exception('Unknown archive item type %r' % item[b'mode'])
  262. def restore_attrs(self, path, item, symlink=False, fd=None):
  263. xattrs = item.get(b'xattrs')
  264. if xattrs:
  265. for k, v in xattrs.items():
  266. try:
  267. xattr.setxattr(fd or path, k, v, follow_symlinks=False)
  268. except OSError as e:
  269. if e.errno != errno.ENOTSUP:
  270. raise
  271. uid = gid = None
  272. if not self.numeric_owner:
  273. uid = user2uid(item[b'user'])
  274. gid = group2gid(item[b'group'])
  275. uid = item[b'uid'] if uid is None else uid
  276. gid = item[b'gid'] if gid is None else gid
  277. # This code is a bit of a mess due to os specific differences
  278. try:
  279. if fd:
  280. os.fchown(fd, uid, gid)
  281. else:
  282. os.lchown(path, uid, gid)
  283. except OSError:
  284. pass
  285. if fd:
  286. os.fchmod(fd, item[b'mode'])
  287. elif not symlink:
  288. os.chmod(path, item[b'mode'])
  289. elif has_lchmod: # Not available on Linux
  290. os.lchmod(path, item[b'mode'])
  291. mtime = bigint_to_int(item[b'mtime'])
  292. if fd and utime_supports_fd: # Python >= 3.3
  293. os.utime(fd, None, ns=(mtime, mtime))
  294. elif utime_supports_follow_symlinks: # Python >= 3.3
  295. os.utime(path, None, ns=(mtime, mtime), follow_symlinks=False)
  296. elif not symlink:
  297. os.utime(path, (mtime / 1e9, mtime / 1e9))
  298. acl_set(path, item, self.numeric_owner)
  299. # Only available on OS X and FreeBSD
  300. if has_lchflags and b'bsdflags' in item:
  301. try:
  302. os.lchflags(path, item[b'bsdflags'])
  303. except OSError:
  304. pass
  305. def delete(self, stats):
  306. unpacker = msgpack.Unpacker(use_list=False)
  307. for items_id, data in zip(self.metadata[b'items'], self.repository.get_many(self.metadata[b'items'])):
  308. unpacker.feed(self.key.decrypt(items_id, data))
  309. self.cache.chunk_decref(items_id, stats)
  310. for item in unpacker:
  311. if b'chunks' in item:
  312. for chunk_id, size, csize in item[b'chunks']:
  313. self.cache.chunk_decref(chunk_id, stats)
  314. self.cache.chunk_decref(self.id, stats)
  315. del self.manifest.archives[self.name]
  316. def stat_attrs(self, st, path):
  317. item = {
  318. b'mode': st.st_mode,
  319. b'uid': st.st_uid, b'user': uid2user(st.st_uid),
  320. b'gid': st.st_gid, b'group': gid2group(st.st_gid),
  321. b'mtime': int_to_bigint(st_mtime_ns(st))
  322. }
  323. if self.numeric_owner:
  324. item[b'user'] = item[b'group'] = None
  325. xattrs = xattr.get_all(path, follow_symlinks=False)
  326. if xattrs:
  327. item[b'xattrs'] = StableDict(xattrs)
  328. if has_lchflags and st.st_flags:
  329. item[b'bsdflags'] = st.st_flags
  330. acl_get(path, item, st, self.numeric_owner)
  331. return item
  332. def process_item(self, path, st):
  333. item = {b'path': make_path_safe(path)}
  334. item.update(self.stat_attrs(st, path))
  335. self.add_item(item)
  336. def process_dev(self, path, st):
  337. item = {b'path': make_path_safe(path), b'rdev': st.st_rdev}
  338. item.update(self.stat_attrs(st, path))
  339. self.add_item(item)
  340. def process_symlink(self, path, st):
  341. source = os.readlink(path)
  342. item = {b'path': make_path_safe(path), b'source': source}
  343. item.update(self.stat_attrs(st, path))
  344. self.add_item(item)
  345. def process_stdin(self, path, cache):
  346. uid, gid = 0, 0
  347. fd = sys.stdin.buffer # binary
  348. chunks = []
  349. for chunk in self.chunker.chunkify(fd):
  350. chunks.append(cache.add_chunk(self.key.id_hash(chunk), chunk, self.stats))
  351. self.stats.nfiles += 1
  352. item = {
  353. b'path': path,
  354. b'chunks': chunks,
  355. b'mode': 0o100660, # regular file, ug=rw
  356. b'uid': uid, b'user': uid2user(uid),
  357. b'gid': gid, b'group': gid2group(gid),
  358. b'mtime': int_to_bigint(int(time.time()) * 1000000000)
  359. }
  360. self.add_item(item)
  361. def process_file(self, path, st, cache):
  362. safe_path = make_path_safe(path)
  363. # Is it a hard link?
  364. if st.st_nlink > 1:
  365. source = self.hard_links.get((st.st_ino, st.st_dev))
  366. if (st.st_ino, st.st_dev) in self.hard_links:
  367. item = self.stat_attrs(st, path)
  368. item.update({b'path': safe_path, b'source': source})
  369. self.add_item(item)
  370. return
  371. else:
  372. self.hard_links[st.st_ino, st.st_dev] = safe_path
  373. path_hash = self.key.id_hash(os.path.join(self.cwd, path).encode('utf-8', 'surrogateescape'))
  374. ids = cache.file_known_and_unchanged(path_hash, st)
  375. chunks = None
  376. if ids is not None:
  377. # Make sure all ids are available
  378. for id_ in ids:
  379. if not cache.seen_chunk(id_):
  380. break
  381. else:
  382. chunks = [cache.chunk_incref(id_, self.stats) for id_ in ids]
  383. # Only chunkify the file if needed
  384. if chunks is None:
  385. with Archive._open_rb(path, st) as fd:
  386. chunks = []
  387. for chunk in self.chunker.chunkify(fd):
  388. chunks.append(cache.add_chunk(self.key.id_hash(chunk), chunk, self.stats))
  389. cache.memorize_file(path_hash, st, [c[0] for c in chunks])
  390. item = {b'path': safe_path, b'chunks': chunks}
  391. item.update(self.stat_attrs(st, path))
  392. self.stats.nfiles += 1
  393. self.add_item(item)
  394. @staticmethod
  395. def list_archives(repository, key, manifest, cache=None):
  396. for name, info in manifest.archives.items():
  397. yield Archive(repository, key, manifest, name, cache=cache)
  398. @staticmethod
  399. def _open_rb(path, st):
  400. flags_noatime = None
  401. euid = None
  402. def open_simple(p, s):
  403. return open(p, 'rb')
  404. def open_noatime_if_owner(p, s):
  405. if euid == 0 or s.st_uid == euid:
  406. # we are root or owner of file
  407. return os.fdopen(os.open(p, flags_noatime), 'rb')
  408. else:
  409. return open(p, 'rb')
  410. def open_noatime(p, s):
  411. try:
  412. fd = os.open(p, flags_noatime)
  413. except PermissionError:
  414. # Was this EPERM due to the O_NOATIME flag?
  415. fo = open(p, 'rb')
  416. # Yes, it was -- otherwise the above line would have thrown
  417. # another exception.
  418. nonlocal euid
  419. euid = os.geteuid()
  420. # So in future, let's check whether the file is owned by us
  421. # before attempting to use O_NOATIME.
  422. Archive._open_rb = open_noatime_if_owner
  423. return fo
  424. return os.fdopen(fd, 'rb')
  425. o_noatime = getattr(os, 'O_NOATIME', None)
  426. if o_noatime is not None:
  427. flags_noatime = os.O_RDONLY | getattr(os, 'O_BINARY', 0) | o_noatime
  428. # Always use O_NOATIME version.
  429. Archive._open_rb = open_noatime
  430. else:
  431. # Always use non-O_NOATIME version.
  432. Archive._open_rb = open_simple
  433. return Archive._open_rb(path, st)
  434. class RobustUnpacker():
  435. """A restartable/robust version of the streaming msgpack unpacker
  436. """
  437. item_keys = [msgpack.packb(name) for name in ('path', 'mode', 'source', 'chunks', 'rdev', 'xattrs', 'user', 'group', 'uid', 'gid', 'mtime')]
  438. def __init__(self, validator):
  439. super(RobustUnpacker, self).__init__()
  440. self.validator = validator
  441. self._buffered_data = []
  442. self._resync = False
  443. self._unpacker = msgpack.Unpacker(object_hook=StableDict)
  444. def resync(self):
  445. self._buffered_data = []
  446. self._resync = True
  447. def feed(self, data):
  448. if self._resync:
  449. self._buffered_data.append(data)
  450. else:
  451. self._unpacker.feed(data)
  452. def __iter__(self):
  453. return self
  454. def __next__(self):
  455. if self._resync:
  456. data = b''.join(self._buffered_data)
  457. while self._resync:
  458. if not data:
  459. raise StopIteration
  460. # Abort early if the data does not look like a serialized dict
  461. if len(data) < 2 or ((data[0] & 0xf0) != 0x80) or ((data[1] & 0xe0) != 0xa0):
  462. data = data[1:]
  463. continue
  464. # Make sure it looks like an item dict
  465. for pattern in self.item_keys:
  466. if data[1:].startswith(pattern):
  467. break
  468. else:
  469. data = data[1:]
  470. continue
  471. self._unpacker = msgpack.Unpacker(object_hook=StableDict)
  472. self._unpacker.feed(data)
  473. try:
  474. item = next(self._unpacker)
  475. if self.validator(item):
  476. self._resync = False
  477. return item
  478. # Ignore exceptions that might be raised when feeding
  479. # msgpack with invalid data
  480. except (TypeError, ValueError, StopIteration):
  481. pass
  482. data = data[1:]
  483. else:
  484. return next(self._unpacker)
  485. class ArchiveChecker:
  486. def __init__(self):
  487. self.error_found = False
  488. self.possibly_superseded = set()
  489. self.tmpdir = tempfile.mkdtemp()
  490. def __del__(self):
  491. shutil.rmtree(self.tmpdir)
  492. def check(self, repository, repair=False, last=None):
  493. self.report_progress('Starting archive consistency check...')
  494. self.repair = repair
  495. self.repository = repository
  496. self.init_chunks()
  497. self.key = self.identify_key(repository)
  498. if Manifest.MANIFEST_ID not in self.chunks:
  499. self.manifest = self.rebuild_manifest()
  500. else:
  501. self.manifest, _ = Manifest.load(repository, key=self.key)
  502. self.rebuild_refcounts(last=last)
  503. if last is None:
  504. self.verify_chunks()
  505. else:
  506. self.report_progress('Orphaned objects check skipped (needs all archives checked)')
  507. if not self.error_found:
  508. self.report_progress('Archive consistency check complete, no problems found.')
  509. return self.repair or not self.error_found
  510. def init_chunks(self):
  511. """Fetch a list of all object keys from repository
  512. """
  513. # Explicity set the initial hash table capacity to avoid performance issues
  514. # due to hash table "resonance"
  515. capacity = int(len(self.repository) * 1.2)
  516. self.chunks = ChunkIndex(capacity)
  517. marker = None
  518. while True:
  519. result = self.repository.list(limit=10000, marker=marker)
  520. if not result:
  521. break
  522. marker = result[-1]
  523. for id_ in result:
  524. self.chunks[id_] = (0, 0, 0)
  525. def report_progress(self, msg, error=False):
  526. if error:
  527. self.error_found = True
  528. print(msg, file=sys.stderr if error else sys.stdout)
  529. def identify_key(self, repository):
  530. cdata = repository.get(next(self.chunks.iteritems())[0])
  531. return key_factory(repository, cdata)
  532. def rebuild_manifest(self):
  533. """Rebuild the manifest object if it is missing
  534. Iterates through all objects in the repository looking for archive metadata blocks.
  535. """
  536. self.report_progress('Rebuilding missing manifest, this might take some time...', error=True)
  537. manifest = Manifest(self.key, self.repository)
  538. for chunk_id, _ in self.chunks.iteritems():
  539. cdata = self.repository.get(chunk_id)
  540. data = self.key.decrypt(chunk_id, cdata)
  541. # Some basic sanity checks of the payload before feeding it into msgpack
  542. if len(data) < 2 or ((data[0] & 0xf0) != 0x80) or ((data[1] & 0xe0) != 0xa0):
  543. continue
  544. if b'cmdline' not in data or b'\xa7version\x01' not in data:
  545. continue
  546. try:
  547. archive = msgpack.unpackb(data)
  548. # Ignore exceptions that might be raised when feeding
  549. # msgpack with invalid data
  550. except (TypeError, ValueError, StopIteration):
  551. continue
  552. if isinstance(archive, dict) and b'items' in archive and b'cmdline' in archive:
  553. self.report_progress('Found archive ' + archive[b'name'].decode('utf-8'), error=True)
  554. manifest.archives[archive[b'name'].decode('utf-8')] = {b'id': chunk_id, b'time': archive[b'time']}
  555. self.report_progress('Manifest rebuild complete', error=True)
  556. return manifest
  557. def rebuild_refcounts(self, last=None):
  558. """Rebuild object reference counts by walking the metadata
  559. Missing and/or incorrect data is repaired when detected
  560. """
  561. # Exclude the manifest from chunks
  562. del self.chunks[Manifest.MANIFEST_ID]
  563. def mark_as_possibly_superseded(id_):
  564. if self.chunks.get(id_, (0,))[0] == 0:
  565. self.possibly_superseded.add(id_)
  566. def add_callback(chunk):
  567. id_ = self.key.id_hash(chunk)
  568. cdata = self.key.encrypt(chunk)
  569. add_reference(id_, len(chunk), len(cdata), cdata)
  570. return id_
  571. def add_reference(id_, size, csize, cdata=None):
  572. try:
  573. count, _, _ = self.chunks[id_]
  574. self.chunks[id_] = count + 1, size, csize
  575. except KeyError:
  576. assert cdata is not None
  577. self.chunks[id_] = 1, size, csize
  578. if self.repair:
  579. self.repository.put(id_, cdata)
  580. def verify_file_chunks(item):
  581. """Verifies that all file chunks are present
  582. Missing file chunks will be replaced with new chunks of the same
  583. length containing all zeros.
  584. """
  585. offset = 0
  586. chunk_list = []
  587. for chunk_id, size, csize in item[b'chunks']:
  588. if chunk_id not in self.chunks:
  589. # If a file chunk is missing, create an all empty replacement chunk
  590. self.report_progress('{}: Missing file chunk detected (Byte {}-{})'.format(item[b'path'].decode('utf-8', 'surrogateescape'), offset, offset + size), error=True)
  591. data = bytes(size)
  592. chunk_id = self.key.id_hash(data)
  593. cdata = self.key.encrypt(data)
  594. csize = len(cdata)
  595. add_reference(chunk_id, size, csize, cdata)
  596. else:
  597. add_reference(chunk_id, size, csize)
  598. chunk_list.append((chunk_id, size, csize))
  599. offset += size
  600. item[b'chunks'] = chunk_list
  601. def robust_iterator(archive):
  602. """Iterates through all archive items
  603. Missing item chunks will be skipped and the msgpack stream will be restarted
  604. """
  605. unpacker = RobustUnpacker(lambda item: isinstance(item, dict) and b'path' in item)
  606. _state = 0
  607. def missing_chunk_detector(chunk_id):
  608. nonlocal _state
  609. if _state % 2 != int(chunk_id not in self.chunks):
  610. _state += 1
  611. return _state
  612. for state, items in groupby(archive[b'items'], missing_chunk_detector):
  613. items = list(items)
  614. if state % 2:
  615. self.report_progress('Archive metadata damage detected', error=True)
  616. continue
  617. if state > 0:
  618. unpacker.resync()
  619. for chunk_id, cdata in zip(items, repository.get_many(items)):
  620. unpacker.feed(self.key.decrypt(chunk_id, cdata))
  621. for item in unpacker:
  622. yield item
  623. repository = cache_if_remote(self.repository)
  624. num_archives = len(self.manifest.archives)
  625. archive_items = sorted(self.manifest.archives.items(), reverse=True,
  626. key=lambda name_info: name_info[1][b'time'])
  627. end = None if last is None else min(num_archives, last)
  628. for i, (name, info) in enumerate(archive_items[:end]):
  629. self.report_progress('Analyzing archive {} ({}/{})'.format(name, num_archives - i, num_archives))
  630. archive_id = info[b'id']
  631. if archive_id not in self.chunks:
  632. self.report_progress('Archive metadata block is missing', error=True)
  633. del self.manifest.archives[name]
  634. continue
  635. mark_as_possibly_superseded(archive_id)
  636. cdata = self.repository.get(archive_id)
  637. data = self.key.decrypt(archive_id, cdata)
  638. archive = StableDict(msgpack.unpackb(data))
  639. if archive[b'version'] != 1:
  640. raise Exception('Unknown archive metadata version')
  641. decode_dict(archive, (b'name', b'hostname', b'username', b'time')) # fixme: argv
  642. items_buffer = ChunkBuffer(self.key)
  643. items_buffer.write_chunk = add_callback
  644. for item in robust_iterator(archive):
  645. if b'chunks' in item:
  646. verify_file_chunks(item)
  647. items_buffer.add(item)
  648. items_buffer.flush(flush=True)
  649. for previous_item_id in archive[b'items']:
  650. mark_as_possibly_superseded(previous_item_id)
  651. archive[b'items'] = items_buffer.chunks
  652. data = msgpack.packb(archive, unicode_errors='surrogateescape')
  653. new_archive_id = self.key.id_hash(data)
  654. cdata = self.key.encrypt(data)
  655. add_reference(new_archive_id, len(data), len(cdata), cdata)
  656. info[b'id'] = new_archive_id
  657. def verify_chunks(self):
  658. unused = set()
  659. for id_, (count, size, csize) in self.chunks.iteritems():
  660. if count == 0:
  661. unused.add(id_)
  662. orphaned = unused - self.possibly_superseded
  663. if orphaned:
  664. self.report_progress('{} orphaned objects found'.format(len(orphaned)), error=True)
  665. if self.repair:
  666. for id_ in unused:
  667. self.repository.delete(id_)
  668. self.manifest.write()
  669. self.repository.commit()