1 """Helper functions and classes for bup."""
3 from __future__ import absolute_import, division
4 from collections import namedtuple
5 from contextlib import contextmanager
6 from ctypes import sizeof, c_void_p
9 from subprocess import PIPE, Popen
10 import sys, os, subprocess, errno, select, mmap, stat, re, struct
11 import hashlib, heapq, math, operator, time, tempfile
13 from bup import _helpers
14 from bup import compat
15 from bup.compat import argv_bytes, byte_int, nullcontext, pending_raise
16 from bup.io import byte_stream, path_msg
17 # This function should really be in helpers, not in bup.options. But we
18 # want options.py to be standalone so people can include it in other projects.
19 from bup.options import _tty_width as tty_width
22 buglvl = int(os.environ.get('BUP_DEBUG', 0))
26 """Helper to deal with Python scoping issues"""
30 def nullcontext_if_not(manager):
31 return manager if manager is not None else nullcontext()
35 def finalized(enter_result=None, finalize=None):
39 except BaseException as ex:
40 with pending_raise(ex):
41 finalize(enter_result)
42 finalize(enter_result)
45 sc_page_size = os.sysconf('SC_PAGE_SIZE')
46 assert(sc_page_size > 0)
48 sc_arg_max = os.sysconf('SC_ARG_MAX')
49 if sc_arg_max == -1: # "no definite limit" - let's choose 2M
50 sc_arg_max = 2 * 1024 * 1024
54 for result in iterable:
59 _fdatasync = os.fdatasync
60 except AttributeError:
63 if sys.platform.startswith('darwin'):
64 # Apparently os.fsync on OS X doesn't guarantee to sync all the way down
68 return fcntl.fcntl(fd, fcntl.F_FULLFSYNC)
70 # Fallback for file systems (SMB) that do not support F_FULLFSYNC
71 if e.errno == errno.ENOTSUP:
76 fdatasync = _fdatasync
79 def partition(predicate, stream):
80 """Returns (leading_matches_it, rest_it), where leading_matches_it
81 must be completely exhausted before traversing rest_it.
86 ns.first_nonmatch = None
87 def leading_matches():
92 ns.first_nonmatch = (x,)
96 yield ns.first_nonmatch[0]
99 return (leading_matches(), rest())
109 def lines_until_sentinel(f, sentinel, ex_type):
110 # sentinel must end with \n and must contain only one \n
113 if not (line and line.endswith(b'\n')):
114 raise ex_type('Hit EOF while reading line')
120 def stat_if_exists(path):
124 if e.errno != errno.ENOENT:
129 # Write (blockingly) to sockets that may or may not be in blocking mode.
130 # We need this because our stderr is sometimes eaten by subprocesses
131 # (probably ssh) that sometimes make it nonblocking, if only temporarily,
132 # leading to race conditions. Ick. We'll do it the hard way.
133 def _hard_write(fd, buf):
135 (r,w,x) = select.select([], [fd], [], None)
137 raise IOError('select(fd) returned without being writable')
139 sz = os.write(fd, buf)
141 if e.errno != errno.EAGAIN:
149 """Print a log message to stderr."""
152 _hard_write(sys.stderr.fileno(), s if isinstance(s, bytes) else s.encode())
166 istty1 = os.isatty(1) or (int(os.environ.get('BUP_FORCE_TTY', 0)) & 1)
167 istty2 = os.isatty(2) or (int(os.environ.get('BUP_FORCE_TTY', 0)) & 2)
170 """Calls log() if stderr is a TTY. Does nothing otherwise."""
171 global _last_progress
178 """Calls progress() only if we haven't printed progress in a while.
180 This avoids overloading the stderr buffer with excess junk.
184 if now - _last_prog > 0.1:
190 """Calls progress() to redisplay the most recent progress message.
192 Useful after you've printed some other message that wipes out the
195 if _last_progress and _last_progress.endswith('\r'):
196 progress(_last_progress)
199 def mkdirp(d, mode=None):
200 """Recursively create directories on path 'd'.
202 Unlike os.makedirs(), it doesn't raise an exception if the last element of
203 the path already exists.
211 if e.errno == errno.EEXIST:
218 def __init__(self, entry, read_it):
220 self.read_it = read_it
222 return self.entry < x.entry
224 def merge_iter(iters, pfreq, pfunc, pfinal, key=None):
226 samekey = lambda e, pe: getattr(e, key) == getattr(pe, key, None)
228 samekey = operator.eq
230 total = sum(len(it) for it in iters)
231 iters = (iter(it) for it in iters)
232 heap = ((next(it, None),it) for it in iters)
233 heap = [MergeIterItem(e, it) for e, it in heap if e]
238 if not count % pfreq:
240 e, it = heap[0].entry, heap[0].read_it
241 if not samekey(e, pe):
247 except StopIteration:
248 heapq.heappop(heap) # remove current
250 # shift current to new location
251 heapq.heapreplace(heap, MergeIterItem(e, it))
256 """Delete a file at path 'f' if it currently exists.
258 Unlike os.unlink(), does not throw an exception if the file didn't already
264 if e.errno != errno.ENOENT:
268 _bq_simple_id_rx = re.compile(br'^[-_./a-zA-Z0-9]+$')
269 _sq_simple_id_rx = re.compile(r'^[-_./a-zA-Z0-9]+$')
274 if _bq_simple_id_rx.match(x):
276 return b"'%s'" % x.replace(b"'", b"'\"'\"'")
281 if _sq_simple_id_rx.match(x):
283 return "'%s'" % x.replace("'", "'\"'\"'")
286 if isinstance(x, bytes):
288 if isinstance(x, compat.str_type):
291 # some versions of pylint get confused
295 """Return a shell quoted string for cmd if it's a sequence, else cmd.
297 cmd must be a string, bytes, or a sequence of one or the other,
298 and the assumption is that if cmd is a string or bytes, then it's
299 already quoted (because it's what's actually being passed to
300 call() and friends. e.g. log(shstr(cmd)); call(cmd)
303 if isinstance(cmd, (bytes, compat.str_type)):
305 elif all(isinstance(x, bytes) for x in cmd):
306 return b' '.join(map(bquote, cmd))
307 elif all(isinstance(x, compat.str_type) for x in cmd):
308 return ' '.join(map(squote, cmd))
309 raise TypeError('unsupported shstr argument: ' + repr(cmd))
312 exc = subprocess.check_call
323 assert stdin in (None, PIPE)
326 stdin=stdin, stdout=PIPE, stderr=stderr,
328 preexec_fn=preexec_fn,
330 out, err = p.communicate(input)
331 if check and p.returncode != 0:
332 raise Exception('subprocess %r failed with status %d%s'
333 % (b' '.join(map(quote, cmd)), p.returncode,
334 ', stderr: %r' % err if err else ''))
337 def readpipe(argv, preexec_fn=None, shell=False):
338 """Run a subprocess and return its output."""
339 return exo(argv, preexec_fn=preexec_fn, shell=shell)[0]
342 def _argmax_base(command):
345 base_size += len(command) + 1
346 for k, v in compat.items(environ):
347 base_size += len(k) + len(v) + 2 + sizeof(c_void_p)
351 def _argmax_args_size(args):
352 return sum(len(x) + 1 + sizeof(c_void_p) for x in args)
355 def batchpipe(command, args, preexec_fn=None, arg_max=sc_arg_max):
356 """If args is not empty, yield the output produced by calling the
357 command list with args as a sequence of strings (It may be necessary
358 to return multiple strings in order to respect ARG_MAX)."""
359 # The optional arg_max arg is a workaround for an issue with the
360 # current wvtest behavior.
361 base_size = _argmax_base(command)
363 room = arg_max - base_size
366 next_size = _argmax_args_size(args[i:i+1])
367 if room - next_size < 0:
373 assert(len(sub_args))
374 yield readpipe(command + sub_args, preexec_fn=preexec_fn)
377 def resolve_parent(p):
378 """Return the absolute path of a file without following any final symlink.
380 Behaves like os.path.realpath, but doesn't follow a symlink for the last
381 element. (ie. if 'p' itself is a symlink, this one won't follow it, but it
382 will follow symlinks in p's directory)
388 if st and stat.S_ISLNK(st.st_mode):
389 (dir, name) = os.path.split(p)
390 dir = os.path.realpath(dir)
391 out = os.path.join(dir, name)
393 out = os.path.realpath(p)
394 #log('realpathing:%r,%r\n' % (p, out))
398 def detect_fakeroot():
399 "Return True if we appear to be running under fakeroot."
400 return os.getenv("FAKEROOTKEY") != None
403 if sys.platform.startswith('cygwin'):
405 # https://cygwin.com/ml/cygwin/2015-02/msg00057.html
406 groups = os.getgroups()
407 return 544 in groups or 0 in groups
410 return os.geteuid() == 0
413 def cache_key_value(get_value, key, cache):
414 """Return (value, was_cached). If there is a value in the cache
415 for key, use that, otherwise, call get_value(key) which should
416 throw a KeyError if there is no value -- in which case the cached
417 and returned value will be None.
419 try: # Do we already have it (or know there wasn't one)?
426 cache[key] = value = get_value(key)
434 """Get the FQDN of this machine."""
437 _hostname = _helpers.gethostname()
441 def format_filesize(size):
446 exponent = int(math.log(size) // math.log(unit))
447 size_prefix = "KMGTPE"[exponent - 1]
448 return "%.1f%s" % (size / math.pow(unit, exponent), size_prefix)
451 class NotOk(Exception):
456 def __init__(self, outp):
457 self._base_closed = False
461 self._base_closed = True
462 while self._read(65536): pass
465 assert self._base_closed
467 def _read(self, size):
468 raise NotImplementedError("Subclasses must implement _read")
470 def read(self, size):
471 """Read 'size' bytes from input stream."""
473 return self._read(size)
475 def _readline(self, size):
476 raise NotImplementedError("Subclasses must implement _readline")
479 """Read from input stream until a newline is found."""
481 return self._readline()
483 def write(self, data):
484 """Write 'data' to output stream."""
485 #log('%d writing: %d bytes\n' % (os.getpid(), len(data)))
486 self.outp.write(data)
489 """Return true if input stream is readable."""
490 raise NotImplementedError("Subclasses must implement has_input")
493 """Indicate end of output from last sent command."""
494 self.write(b'\nok\n')
497 """Indicate server error to the client."""
498 s = re.sub(br'\s+', b' ', s)
499 self.write(b'\nerror %s\n' % s)
501 def _check_ok(self, onempty):
504 for rl in linereader(self):
505 #log('%d got line: %r\n' % (os.getpid(), rl))
506 if not rl: # empty line
510 elif rl.startswith(b'error '):
511 #log('client: error: %s\n' % rl[6:])
515 raise Exception('server exited unexpectedly; see errors above')
517 def drain_and_check_ok(self):
518 """Remove all data for the current command from input stream."""
521 return self._check_ok(onempty)
524 """Verify that server action completed successfully."""
526 raise Exception('expected "ok", got %r' % rl)
527 return self._check_ok(onempty)
530 class Conn(BaseConn):
531 def __init__(self, inp, outp):
532 BaseConn.__init__(self, outp)
535 def _read(self, size):
536 return self.inp.read(size)
539 return self.inp.readline()
542 [rl, wl, xl] = select.select([self.inp.fileno()], [], [], 0)
544 assert(rl[0] == self.inp.fileno())
550 def checked_reader(fd, n):
552 rl, _, _ = select.select([fd], [], [])
555 if not buf: raise Exception("Unexpected EOF reading %d more bytes" % n)
560 MAX_PACKET = 128 * 1024
561 def mux(p, outfd, outr, errr):
564 while p.poll() is None:
565 rl, _, _ = select.select(fds, [], [])
568 buf = os.read(outr, MAX_PACKET)
570 os.write(outfd, struct.pack('!IB', len(buf), 1) + buf)
572 buf = os.read(errr, 1024)
574 os.write(outfd, struct.pack('!IB', len(buf), 2) + buf)
576 os.write(outfd, struct.pack('!IB', 0, 3))
579 class DemuxConn(BaseConn):
580 """A helper class for bup's client-server protocol."""
581 def __init__(self, infd, outp):
582 BaseConn.__init__(self, outp)
583 # Anything that comes through before the sync string was not
584 # multiplexed and can be assumed to be debug/log before mux init.
586 stderr = byte_stream(sys.stderr)
587 while tail != b'BUPMUX':
588 # Make sure to write all pre-BUPMUX output to stderr
589 b = os.read(infd, (len(tail) < 6) and (6-len(tail)) or 1)
591 ex = IOError('demux: unexpected EOF during initialization')
592 with pending_raise(ex):
596 stderr.write(tail[:-6])
604 def write(self, data):
606 BaseConn.write(self, data)
608 def _next_packet(self, timeout):
609 if self.closed: return False
610 rl, wl, xl = select.select([self.infd], [], [], timeout)
611 if not rl: return False
612 assert(rl[0] == self.infd)
613 ns = b''.join(checked_reader(self.infd, 5))
614 n, fdw = struct.unpack('!IB', ns)
616 # assume that something went wrong and print stuff
617 ns += os.read(self.infd, 1024)
618 stderr = byte_stream(sys.stderr)
621 raise Exception("Connection broken")
623 self.reader = checked_reader(self.infd, n)
625 for buf in checked_reader(self.infd, n):
626 byte_stream(sys.stderr).write(buf)
629 debug2("DemuxConn: marked closed\n")
632 def _load_buf(self, timeout):
633 if self.buf is not None:
635 while not self.closed:
636 while not self.reader:
637 if not self._next_packet(timeout):
640 self.buf = next(self.reader)
642 except StopIteration:
646 def _read_parts(self, ix_fn):
647 while self._load_buf(None):
648 assert(self.buf is not None)
650 if i is None or i == len(self.buf):
655 self.buf = self.buf[i:]
663 return buf.index(b'\n')+1
666 return b''.join(self._read_parts(find_eol))
668 def _read(self, size):
670 def until_size(buf): # Closes on csize
671 if len(buf) < csize[0]:
676 return b''.join(self._read_parts(until_size))
679 return self._load_buf(0)
683 """Generate a list of input lines from 'f' without terminating newlines."""
691 def chunkyreader(f, count = None):
692 """Generate a list of chunks of data read from 'f'.
694 If count is None, read until EOF is reached.
696 If count is a positive integer, read 'count' bytes from 'f'. If EOF is
697 reached while reading, raise IOError.
701 b = f.read(min(count, 65536))
703 raise IOError('EOF with %d bytes remaining' % count)
714 def atomically_replaced_file(name, mode='w', buffering=-1):
715 """Yield a file that will be atomically renamed name when leaving the block.
717 This contextmanager yields an open file object that is backed by a
718 temporary file which will be renamed (atomically) to the target
719 name if everything succeeds.
721 The mode and buffering arguments are handled exactly as with open,
722 and the yielded file will have very restrictive permissions, as
727 with atomically_replaced_file('foo.txt', 'w') as f:
728 f.write('hello jack.')
732 (ffd, tempname) = tempfile.mkstemp(dir=os.path.dirname(name),
733 text=('b' not in mode))
736 f = os.fdopen(ffd, mode, buffering)
744 os.rename(tempname, name)
746 unlink(tempname) # nonexistant file is ignored
750 """Append "/" to 's' if it doesn't aleady end in "/"."""
751 assert isinstance(s, bytes)
752 if s and not s.endswith(b'/'):
758 def _mmap_do(f, sz, flags, prot, close):
760 st = os.fstat(f.fileno())
763 # trying to open a zero-length map gives an error, but an empty
764 # string has all the same behaviour of a zero-length map, ie. it has
767 map = compat.mmap(f.fileno(), sz, flags, prot)
769 f.close() # map will persist beyond file close
773 def mmap_read(f, sz = 0, close=True):
774 """Create a read-only memory mapped region on file 'f'.
775 If sz is 0, the region will cover the entire file.
777 return _mmap_do(f, sz, mmap.MAP_PRIVATE, mmap.PROT_READ, close)
780 def mmap_readwrite(f, sz = 0, close=True):
781 """Create a read-write memory mapped region on file 'f'.
782 If sz is 0, the region will cover the entire file.
784 return _mmap_do(f, sz, mmap.MAP_SHARED, mmap.PROT_READ|mmap.PROT_WRITE,
788 def mmap_readwrite_private(f, sz = 0, close=True):
789 """Create a read-write memory mapped region on file 'f'.
790 If sz is 0, the region will cover the entire file.
791 The map is private, which means the changes are never flushed back to the
794 return _mmap_do(f, sz, mmap.MAP_PRIVATE, mmap.PROT_READ|mmap.PROT_WRITE,
798 _mincore = getattr(_helpers, 'mincore', None)
800 # ./configure ensures that we're on Linux if MINCORE_INCORE isn't defined.
801 MINCORE_INCORE = getattr(_helpers, 'MINCORE_INCORE', 1)
803 _fmincore_chunk_size = None
804 def _set_fmincore_chunk_size():
805 global _fmincore_chunk_size
806 pref_chunk_size = 64 * 1024 * 1024
807 chunk_size = sc_page_size
808 if (sc_page_size < pref_chunk_size):
809 chunk_size = sc_page_size * (pref_chunk_size // sc_page_size)
810 _fmincore_chunk_size = chunk_size
813 """Return the mincore() data for fd as a bytearray whose values can be
814 tested via MINCORE_INCORE, or None if fd does not fully
815 support the operation."""
817 if (st.st_size == 0):
819 if not _fmincore_chunk_size:
820 _set_fmincore_chunk_size()
821 pages_per_chunk = _fmincore_chunk_size // sc_page_size;
822 page_count = (st.st_size + sc_page_size - 1) // sc_page_size;
823 chunk_count = (st.st_size + _fmincore_chunk_size - 1) // _fmincore_chunk_size
824 result = bytearray(page_count)
825 for ci in compat.range(chunk_count):
826 pos = _fmincore_chunk_size * ci;
827 msize = min(_fmincore_chunk_size, st.st_size - pos)
829 m = compat.mmap(fd, msize, mmap.MAP_PRIVATE, 0, 0, pos)
830 except mmap.error as ex:
831 if ex.errno == errno.EINVAL or ex.errno == errno.ENODEV:
832 # Perhaps the file was a pipe, i.e. "... | bup split ..."
836 _mincore(m, msize, 0, result, ci * pages_per_chunk)
837 except OSError as ex:
838 if ex.errno == errno.ENOSYS:
844 def parse_timestamp(epoch_str):
845 """Return the number of nanoseconds since the epoch that are described
846 by epoch_str (100ms, 100ns, ...); when epoch_str cannot be parsed,
847 throw a ValueError that may contain additional information."""
848 ns_per = {'s' : 1000000000,
852 match = re.match(r'^((?:[-+]?[0-9]+)?)(s|ms|us|ns)$', epoch_str)
854 if re.match(r'^([-+]?[0-9]+)$', epoch_str):
855 raise ValueError('must include units, i.e. 100ns, 100ms, ...')
857 (n, units) = match.group(1, 2)
861 return n * ns_per[units]
865 """Parse string or bytes as a possibly unit suffixed number.
868 199.2k means 203981 bytes
869 1GB means 1073741824 bytes
870 2.1 tb means 2199023255552 bytes
872 if isinstance(s, bytes):
873 # FIXME: should this raise a ValueError for UnicodeDecodeError
874 # (perhaps with the latter as the context).
875 s = s.decode('ascii')
876 g = re.match(r'([-+\d.e]+)\s*(\w*)', str(s))
878 raise ValueError("can't parse %r as a number" % s)
879 (val, unit) = g.groups()
882 if unit in ['t', 'tb']:
883 mult = 1024*1024*1024*1024
884 elif unit in ['g', 'gb']:
885 mult = 1024*1024*1024
886 elif unit in ['m', 'mb']:
888 elif unit in ['k', 'kb']:
890 elif unit in ['', 'b']:
893 raise ValueError("invalid unit %r in number %r" % (unit, s))
899 """Append an error message to the list of saved errors.
901 Once processing is able to stop and output the errors, the saved errors are
902 accessible in the module variable helpers.saved_errors.
904 saved_errors.append(e)
913 def die_if_errors(msg=None, status=1):
917 msg = 'warning: %d errors encountered\n' % len(saved_errors)
923 """Replace the default exception handler for KeyboardInterrupt (Ctrl-C).
925 The new exception handler will make sure that bup will exit without an ugly
926 stacktrace when Ctrl-C is hit.
928 oldhook = sys.excepthook
929 def newhook(exctype, value, traceback):
930 if exctype == KeyboardInterrupt:
931 log('\nInterrupted.\n')
933 oldhook(exctype, value, traceback)
934 sys.excepthook = newhook
937 def columnate(l, prefix):
938 """Format elements of 'l' in columns with 'prefix' leading each line.
940 The number of columns is determined automatically based on the string
943 binary = isinstance(prefix, bytes)
944 nothing = b'' if binary else ''
945 nl = b'\n' if binary else '\n'
949 clen = max(len(s) for s in l)
950 ncols = (tty_width() - len(prefix)) // (clen + 2)
955 while len(l) % ncols:
957 rows = len(l) // ncols
958 for s in compat.range(0, len(l), rows):
959 cols.append(l[s:s+rows])
961 fmt = b'%-*s' if binary else '%-*s'
962 for row in zip(*cols):
963 out += prefix + nothing.join((fmt % (clen+2, s)) for s in row) + nl
967 def parse_date_or_fatal(str, fatal):
968 """Parses the given date or calls Option.fatal().
969 For now we expect a string that contains a float."""
972 except ValueError as e:
973 raise fatal('invalid date format (should be a float): %r' % e)
978 def parse_excludes(options, fatal):
979 """Traverse the options and extract all excludes, or call Option.fatal()."""
983 (option, parameter) = flag
984 if option == '--exclude':
985 excluded_paths.append(resolve_parent(argv_bytes(parameter)))
986 elif option == '--exclude-from':
988 f = open(resolve_parent(argv_bytes(parameter)), 'rb')
990 raise fatal("couldn't read %r" % parameter)
991 for exclude_path in f.readlines():
992 # FIXME: perhaps this should be rstrip('\n')
993 exclude_path = resolve_parent(exclude_path.strip())
995 excluded_paths.append(exclude_path)
996 return sorted(frozenset(excluded_paths))
999 def parse_rx_excludes(options, fatal):
1000 """Traverse the options and extract all rx excludes, or call
1002 excluded_patterns = []
1004 for flag in options:
1005 (option, parameter) = flag
1006 if option == '--exclude-rx':
1008 excluded_patterns.append(re.compile(argv_bytes(parameter)))
1009 except re.error as ex:
1010 fatal('invalid --exclude-rx pattern (%r): %s' % (parameter, ex))
1011 elif option == '--exclude-rx-from':
1013 f = open(resolve_parent(parameter), 'rb')
1014 except IOError as e:
1015 raise fatal("couldn't read %r" % parameter)
1016 for pattern in f.readlines():
1017 spattern = pattern.rstrip(b'\n')
1021 excluded_patterns.append(re.compile(spattern))
1022 except re.error as ex:
1023 fatal('invalid --exclude-rx pattern (%r): %s' % (spattern, ex))
1024 return excluded_patterns
1027 def should_rx_exclude_path(path, exclude_rxs):
1028 """Return True if path matches a regular expression in exclude_rxs."""
1029 for rx in exclude_rxs:
1031 debug1('Skipping %r: excluded by rx pattern %r.\n'
1032 % (path, rx.pattern))
1037 # FIXME: Carefully consider the use of functions (os.path.*, etc.)
1038 # that resolve against the current filesystem in the strip/graft
1039 # functions for example, but elsewhere as well. I suspect bup's not
1040 # always being careful about that. For some cases, the contents of
1041 # the current filesystem should be irrelevant, and consulting it might
1042 # produce the wrong result, perhaps via unintended symlink resolution,
1045 def path_components(path):
1046 """Break path into a list of pairs of the form (name,
1047 full_path_to_name). Path must start with '/'.
1049 '/home/foo' -> [('', '/'), ('home', '/home'), ('foo', '/home/foo')]"""
1050 if not path.startswith(b'/'):
1051 raise Exception('path must start with "/": %s' % path_msg(path))
1052 # Since we assume path startswith('/'), we can skip the first element.
1053 result = [(b'', b'/')]
1054 norm_path = os.path.abspath(path)
1055 if norm_path == b'/':
1058 for p in norm_path.split(b'/')[1:]:
1059 full_path += b'/' + p
1060 result.append((p, full_path))
1064 def stripped_path_components(path, strip_prefixes):
1065 """Strip any prefix in strip_prefixes from path and return a list
1066 of path components where each component is (name,
1067 none_or_full_fs_path_to_name). Assume path startswith('/').
1068 See thelpers.py for examples."""
1069 normalized_path = os.path.abspath(path)
1070 sorted_strip_prefixes = sorted(strip_prefixes, key=len, reverse=True)
1071 for bp in sorted_strip_prefixes:
1072 normalized_bp = os.path.abspath(bp)
1073 if normalized_bp == b'/':
1075 if normalized_path.startswith(normalized_bp):
1076 prefix = normalized_path[:len(normalized_bp)]
1078 for p in normalized_path[len(normalized_bp):].split(b'/'):
1082 result.append((p, prefix))
1085 return path_components(path)
1088 def grafted_path_components(graft_points, path):
1089 # Create a result that consists of some number of faked graft
1090 # directories before the graft point, followed by all of the real
1091 # directories from path that are after the graft point. Arrange
1092 # for the directory at the graft point in the result to correspond
1093 # to the "orig" directory in --graft orig=new. See t/thelpers.py
1094 # for some examples.
1096 # Note that given --graft orig=new, orig and new have *nothing* to
1097 # do with each other, even if some of their component names
1098 # match. i.e. --graft /foo/bar/baz=/foo/bar/bax is semantically
1099 # equivalent to --graft /foo/bar/baz=/x/y/z, or even
1102 # FIXME: This can't be the best solution...
1103 clean_path = os.path.abspath(path)
1104 for graft_point in graft_points:
1105 old_prefix, new_prefix = graft_point
1106 # Expand prefixes iff not absolute paths.
1107 old_prefix = os.path.normpath(old_prefix)
1108 new_prefix = os.path.normpath(new_prefix)
1109 if clean_path.startswith(old_prefix):
1110 escaped_prefix = re.escape(old_prefix)
1111 grafted_path = re.sub(br'^' + escaped_prefix, new_prefix, clean_path)
1112 # Handle /foo=/ (at least) -- which produces //whatever.
1113 grafted_path = b'/' + grafted_path.lstrip(b'/')
1114 clean_path_components = path_components(clean_path)
1115 # Count the components that were stripped.
1116 strip_count = 0 if old_prefix == b'/' else old_prefix.count(b'/')
1117 new_prefix_parts = new_prefix.split(b'/')
1118 result_prefix = grafted_path.split(b'/')[:new_prefix.count(b'/')]
1119 result = [(p, None) for p in result_prefix] \
1120 + clean_path_components[strip_count:]
1121 # Now set the graft point name to match the end of new_prefix.
1122 graft_point = len(result_prefix)
1123 result[graft_point] = \
1124 (new_prefix_parts[-1], clean_path_components[strip_count][1])
1125 if new_prefix == b'/': # --graft ...=/ is a special case.
1128 return path_components(clean_path)
1134 _localtime = getattr(_helpers, 'localtime', None)
1137 bup_time = namedtuple('bup_time', ['tm_year', 'tm_mon', 'tm_mday',
1138 'tm_hour', 'tm_min', 'tm_sec',
1139 'tm_wday', 'tm_yday',
1140 'tm_isdst', 'tm_gmtoff', 'tm_zone'])
1142 # Define a localtime() that returns bup_time when possible. Note:
1143 # this means that any helpers.localtime() results may need to be
1144 # passed through to_py_time() before being passed to python's time
1145 # module, which doesn't appear willing to ignore the extra items.
1147 def localtime(time):
1148 return bup_time(*_helpers.localtime(int(floor(time))))
1149 def utc_offset_str(t):
1150 """Return the local offset from UTC as "+hhmm" or "-hhmm" for time t.
1151 If the current UTC offset does not represent an integer number
1152 of minutes, the fractional component will be truncated."""
1153 off = localtime(t).tm_gmtoff
1154 # Note: // doesn't truncate like C for negative values, it rounds down.
1155 offmin = abs(off) // 60
1157 h = (offmin - m) // 60
1158 return b'%+03d%02d' % (-h if off < 0 else h, m)
1160 if isinstance(x, time.struct_time):
1162 return time.struct_time(x[:9])
1164 localtime = time.localtime
1165 def utc_offset_str(t):
1166 return time.strftime(b'%z', localtime(t))
1171 _some_invalid_save_parts_rx = re.compile(br'[\[ ~^:?*\\]|\.\.|//|@{')
1173 def valid_save_name(name):
1174 # Enforce a superset of the restrictions in git-check-ref-format(1)
1176 or name.startswith(b'/') or name.endswith(b'/') \
1177 or name.endswith(b'.'):
1179 if _some_invalid_save_parts_rx.search(name):
1182 if byte_int(c) < 0x20 or byte_int(c) == 0x7f:
1184 for part in name.split(b'/'):
1185 if part.startswith(b'.') or part.endswith(b'.lock'):
1190 _period_rx = re.compile(br'^([0-9]+)(s|min|h|d|w|m|y)$')
1192 def period_as_secs(s):
1195 match = _period_rx.match(s)
1198 mag = int(match.group(1))
1199 scale = match.group(2)
1200 return mag * {b's': 1,
1204 b'w': 60 * 60 * 24 * 7,
1205 b'm': 60 * 60 * 24 * 31,
1206 b'y': 60 * 60 * 24 * 366}[scale]