archive.py 31 KB

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