archive.py 30 KB

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