# util.py - Mercurial utility functions and platform specific implementations # # Copyright 2005 K. Thananchayan # Copyright 2005-2007 Matt Mackall # Copyright 2006 Vadim Gelfer # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. """Mercurial utility functions and platform specific implementations. This contains helper routines that are independent of the SCM core and hide platform-specific details from the core. """ from __future__ import absolute_import import bz2 import calendar import collections import datetime import errno import gc import hashlib import imp import os import platform as pyplatform import re as remod import shutil import signal import socket import stat import string import subprocess import sys import tempfile import textwrap import time import traceback import zlib from . import ( encoding, error, i18n, osutil, parsers, pycompat, ) empty = pycompat.empty httplib = pycompat.httplib httpserver = pycompat.httpserver pickle = pycompat.pickle queue = pycompat.queue socketserver = pycompat.socketserver stderr = pycompat.stderr stdin = pycompat.stdin stdout = pycompat.stdout stringio = pycompat.stringio urlerr = pycompat.urlerr urlparse = pycompat.urlparse urlreq = pycompat.urlreq xmlrpclib = pycompat.xmlrpclib if os.name == 'nt': from . import windows as platform stdout = platform.winstdout(pycompat.stdout) else: from . import posix as platform _ = i18n._ bindunixsocket = platform.bindunixsocket cachestat = platform.cachestat checkexec = platform.checkexec checklink = platform.checklink copymode = platform.copymode executablepath = platform.executablepath expandglobs = platform.expandglobs explainexit = platform.explainexit findexe = platform.findexe gethgcmd = platform.gethgcmd getuser = platform.getuser getpid = os.getpid groupmembers = platform.groupmembers groupname = platform.groupname hidewindow = platform.hidewindow isexec = platform.isexec isowner = platform.isowner localpath = platform.localpath lookupreg = platform.lookupreg makedir = platform.makedir nlinks = platform.nlinks normpath = platform.normpath normcase = platform.normcase normcasespec = platform.normcasespec normcasefallback = platform.normcasefallback openhardlinks = platform.openhardlinks oslink = platform.oslink parsepatchoutput = platform.parsepatchoutput pconvert = platform.pconvert poll = platform.poll popen = platform.popen posixfile = platform.posixfile quotecommand = platform.quotecommand readpipe = platform.readpipe rename = platform.rename removedirs = platform.removedirs samedevice = platform.samedevice samefile = platform.samefile samestat = platform.samestat setbinary = platform.setbinary setflags = platform.setflags setsignalhandler = platform.setsignalhandler shellquote = platform.shellquote spawndetached = platform.spawndetached split = platform.split sshargs = platform.sshargs statfiles = getattr(osutil, 'statfiles', platform.statfiles) statisexec = platform.statisexec statislink = platform.statislink testpid = platform.testpid umask = platform.umask unlink = platform.unlink unlinkpath = platform.unlinkpath username = platform.username # Python compatibility _notset = object() # disable Python's problematic floating point timestamps (issue4836) # (Python hypocritically says you shouldn't change this behavior in # libraries, and sure enough Mercurial is not a library.) os.stat_float_times(False) def safehasattr(thing, attr): return getattr(thing, attr, _notset) is not _notset DIGESTS = { 'md5': hashlib.md5, 'sha1': hashlib.sha1, 'sha512': hashlib.sha512, } # List of digest types from strongest to weakest DIGESTS_BY_STRENGTH = ['sha512', 'sha1', 'md5'] for k in DIGESTS_BY_STRENGTH: assert k in DIGESTS class digester(object): """helper to compute digests. This helper can be used to compute one or more digests given their name. >>> d = digester(['md5', 'sha1']) >>> d.update('foo') >>> [k for k in sorted(d)] ['md5', 'sha1'] >>> d['md5'] 'acbd18db4cc2f85cedef654fccc4a4d8' >>> d['sha1'] '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33' >>> digester.preferred(['md5', 'sha1']) 'sha1' """ def __init__(self, digests, s=''): self._hashes = {} for k in digests: if k not in DIGESTS: raise Abort(_('unknown digest type: %s') % k) self._hashes[k] = DIGESTS[k]() if s: self.update(s) def update(self, data): for h in self._hashes.values(): h.update(data) def __getitem__(self, key): if key not in DIGESTS: raise Abort(_('unknown digest type: %s') % k) return self._hashes[key].hexdigest() def __iter__(self): return iter(self._hashes) @staticmethod def preferred(supported): """returns the strongest digest type in both supported and DIGESTS.""" for k in DIGESTS_BY_STRENGTH: if k in supported: return k return None class digestchecker(object): """file handle wrapper that additionally checks content against a given size and digests. d = digestchecker(fh, size, {'md5': '...'}) When multiple digests are given, all of them are validated. """ def __init__(self, fh, size, digests): self._fh = fh self._size = size self._got = 0 self._digests = dict(digests) self._digester = digester(self._digests.keys()) def read(self, length=-1): content = self._fh.read(length) self._digester.update(content) self._got += len(content) return content def validate(self): if self._size != self._got: raise Abort(_('size mismatch: expected %d, got %d') % (self._size, self._got)) for k, v in self._digests.items(): if v != self._digester[k]: # i18n: first parameter is a digest name raise Abort(_('%s mismatch: expected %s, got %s') % (k, v, self._digester[k])) try: buffer = buffer except NameError: if not pycompat.ispy3: def buffer(sliceable, offset=0): return sliceable[offset:] else: def buffer(sliceable, offset=0): return memoryview(sliceable)[offset:] closefds = os.name == 'posix' _chunksize = 4096 class bufferedinputpipe(object): """a manually buffered input pipe Python will not let us use buffered IO and lazy reading with 'polling' at the same time. We cannot probe the buffer state and select will not detect that data are ready to read if they are already buffered. This class let us work around that by implementing its own buffering (allowing efficient readline) while offering a way to know if the buffer is empty from the output (allowing collaboration of the buffer with polling). This class lives in the 'util' module because it makes use of the 'os' module from the python stdlib. """ def __init__(self, input): self._input = input self._buffer = [] self._eof = False self._lenbuf = 0 @property def hasbuffer(self): """True is any data is currently buffered This will be used externally a pre-step for polling IO. If there is already data then no polling should be set in place.""" return bool(self._buffer) @property def closed(self): return self._input.closed def fileno(self): return self._input.fileno() def close(self): return self._input.close() def read(self, size): while (not self._eof) and (self._lenbuf < size): self._fillbuffer() return self._frombuffer(size) def readline(self, *args, **kwargs): if 1 < len(self._buffer): # this should not happen because both read and readline end with a # _frombuffer call that collapse it. self._buffer = [''.join(self._buffer)] self._lenbuf = len(self._buffer[0]) lfi = -1 if self._buffer: lfi = self._buffer[-1].find('\n') while (not self._eof) and lfi < 0: self._fillbuffer() if self._buffer: lfi = self._buffer[-1].find('\n') size = lfi + 1 if lfi < 0: # end of file size = self._lenbuf elif 1 < len(self._buffer): # we need to take previous chunks into account size += self._lenbuf - len(self._buffer[-1]) return self._frombuffer(size) def _frombuffer(self, size): """return at most 'size' data from the buffer The data are removed from the buffer.""" if size == 0 or not self._buffer: return '' buf = self._buffer[0] if 1 < len(self._buffer): buf = ''.join(self._buffer) data = buf[:size] buf = buf[len(data):] if buf: self._buffer = [buf] self._lenbuf = len(buf) else: self._buffer = [] self._lenbuf = 0 return data def _fillbuffer(self): """read data to the buffer""" data = os.read(self._input.fileno(), _chunksize) if not data: self._eof = True else: self._lenbuf += len(data) self._buffer.append(data) def popen2(cmd, env=None, newlines=False): # Setting bufsize to -1 lets the system decide the buffer size. # The default for bufsize is 0, meaning unbuffered. This leads to # poor performance on Mac OS X: http://bugs.python.org/issue4194 p = subprocess.Popen(cmd, shell=True, bufsize=-1, close_fds=closefds, stdin=subprocess.PIPE, stdout=subprocess.PIPE, universal_newlines=newlines, env=env) return p.stdin, p.stdout def popen3(cmd, env=None, newlines=False): stdin, stdout, stderr, p = popen4(cmd, env, newlines) return stdin, stdout, stderr def popen4(cmd, env=None, newlines=False, bufsize=-1): p = subprocess.Popen(cmd, shell=True, bufsize=bufsize, close_fds=closefds, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=newlines, env=env) return p.stdin, p.stdout, p.stderr, p def version(): """Return version information if available.""" try: from . import __version__ return __version__.version except ImportError: return 'unknown' def versiontuple(v=None, n=4): """Parses a Mercurial version string into an N-tuple. The version string to be parsed is specified with the ``v`` argument. If it isn't defined, the current Mercurial version string will be parsed. ``n`` can be 2, 3, or 4. Here is how some version strings map to returned values: >>> v = '3.6.1+190-df9b73d2d444' >>> versiontuple(v, 2) (3, 6) >>> versiontuple(v, 3) (3, 6, 1) >>> versiontuple(v, 4) (3, 6, 1, '190-df9b73d2d444') >>> versiontuple('3.6.1+190-df9b73d2d444+20151118') (3, 6, 1, '190-df9b73d2d444+20151118') >>> v = '3.6' >>> versiontuple(v, 2) (3, 6) >>> versiontuple(v, 3) (3, 6, None) >>> versiontuple(v, 4) (3, 6, None, None) >>> v = '3.9-rc' >>> versiontuple(v, 2) (3, 9) >>> versiontuple(v, 3) (3, 9, None) >>> versiontuple(v, 4) (3, 9, None, 'rc') >>> v = '3.9-rc+2-02a8fea4289b' >>> versiontuple(v, 2) (3, 9) >>> versiontuple(v, 3) (3, 9, None) >>> versiontuple(v, 4) (3, 9, None, 'rc+2-02a8fea4289b') """ if not v: v = version() parts = remod.split('[\+-]', v, 1) if len(parts) == 1: vparts, extra = parts[0], None else: vparts, extra = parts vints = [] for i in vparts.split('.'): try: vints.append(int(i)) except ValueError: break # (3, 6) -> (3, 6, None) while len(vints) < 3: vints.append(None) if n == 2: return (vints[0], vints[1]) if n == 3: return (vints[0], vints[1], vints[2]) if n == 4: return (vints[0], vints[1], vints[2], extra) # used by parsedate defaultdateformats = ( '%Y-%m-%dT%H:%M:%S', # the 'real' ISO8601 '%Y-%m-%dT%H:%M', # without seconds '%Y-%m-%dT%H%M%S', # another awful but legal variant without : '%Y-%m-%dT%H%M', # without seconds '%Y-%m-%d %H:%M:%S', # our common legal variant '%Y-%m-%d %H:%M', # without seconds '%Y-%m-%d %H%M%S', # without : '%Y-%m-%d %H%M', # without seconds '%Y-%m-%d %I:%M:%S%p', '%Y-%m-%d %H:%M', '%Y-%m-%d %I:%M%p', '%Y-%m-%d', '%m-%d', '%m/%d', '%m/%d/%y', '%m/%d/%Y', '%a %b %d %H:%M:%S %Y', '%a %b %d %I:%M:%S%p %Y', '%a, %d %b %Y %H:%M:%S', # GNU coreutils "/bin/date --rfc-2822" '%b %d %H:%M:%S %Y', '%b %d %I:%M:%S%p %Y', '%b %d %H:%M:%S', '%b %d %I:%M:%S%p', '%b %d %H:%M', '%b %d %I:%M%p', '%b %d %Y', '%b %d', '%H:%M:%S', '%I:%M:%S%p', '%H:%M', '%I:%M%p', ) extendeddateformats = defaultdateformats + ( "%Y", "%Y-%m", "%b", "%b %Y", ) def cachefunc(func): '''cache the result of function calls''' # XXX doesn't handle keywords args if func.__code__.co_argcount == 0: cache = [] def f(): if len(cache) == 0: cache.append(func()) return cache[0] return f cache = {} if func.__code__.co_argcount == 1: # we gain a small amount of time because # we don't need to pack/unpack the list def f(arg): if arg not in cache: cache[arg] = func(arg) return cache[arg] else: def f(*args): if args not in cache: cache[args] = func(*args) return cache[args] return f class sortdict(dict): '''a simple sorted dictionary''' def __init__(self, data=None): self._list = [] if data: self.update(data) def copy(self): return sortdict(self) def __setitem__(self, key, val): if key in self: self._list.remove(key) self._list.append(key) dict.__setitem__(self, key, val) def __iter__(self): return self._list.__iter__() def update(self, src): if isinstance(src, dict): src = src.iteritems() for k, v in src: self[k] = v def clear(self): dict.clear(self) self._list = [] def items(self): return [(k, self[k]) for k in self._list] def __delitem__(self, key): dict.__delitem__(self, key) self._list.remove(key) def pop(self, key, *args, **kwargs): dict.pop(self, key, *args, **kwargs) try: self._list.remove(key) except ValueError: pass def keys(self): return self._list def iterkeys(self): return self._list.__iter__() def iteritems(self): for k in self._list: yield k, self[k] def insert(self, index, key, val): self._list.insert(index, key) dict.__setitem__(self, key, val) def __repr__(self): if not self: return '%s()' % self.__class__.__name__ return '%s(%r)' % (self.__class__.__name__, self.items()) class _lrucachenode(object): """A node in a doubly linked list. Holds a reference to nodes on either side as well as a key-value pair for the dictionary entry. """ __slots__ = (u'next', u'prev', u'key', u'value') def __init__(self): self.next = None self.prev = None self.key = _notset self.value = None def markempty(self): """Mark the node as emptied.""" self.key = _notset class lrucachedict(object): """Dict that caches most recent accesses and sets. The dict consists of an actual backing dict - indexed by original key - and a doubly linked circular list defining the order of entries in the cache. The head node is the newest entry in the cache. If the cache is full, we recycle head.prev and make it the new head. Cache accesses result in the node being moved to before the existing head and being marked as the new head node. """ def __init__(self, max): self._cache = {} self._head = head = _lrucachenode() head.prev = head head.next = head self._size = 1 self._capacity = max def __len__(self): return len(self._cache) def __contains__(self, k): return k in self._cache def __iter__(self): # We don't have to iterate in cache order, but why not. n = self._head for i in range(len(self._cache)): yield n.key n = n.next def __getitem__(self, k): node = self._cache[k] self._movetohead(node) return node.value def __setitem__(self, k, v): node = self._cache.get(k) # Replace existing value and mark as newest. if node is not None: node.value = v self._movetohead(node) return if self._size < self._capacity: node = self._addcapacity() else: # Grab the last/oldest item. node = self._head.prev # At capacity. Kill the old entry. if node.key is not _notset: del self._cache[node.key] node.key = k node.value = v self._cache[k] = node # And mark it as newest entry. No need to adjust order since it # is already self._head.prev. self._head = node def __delitem__(self, k): node = self._cache.pop(k) node.markempty() # Temporarily mark as newest item before re-adjusting head to make # this node the oldest item. self._movetohead(node) self._head = node.next # Additional dict methods. def get(self, k, default=None): try: return self._cache[k].value except KeyError: return default def clear(self): n = self._head while n.key is not _notset: n.markempty() n = n.next self._cache.clear() def copy(self): result = lrucachedict(self._capacity) n = self._head.prev # Iterate in oldest-to-newest order, so the copy has the right ordering for i in range(len(self._cache)): result[n.key] = n.value n = n.prev return result def _movetohead(self, node): """Mark a node as the newest, making it the new head. When a node is accessed, it becomes the freshest entry in the LRU list, which is denoted by self._head. Visually, let's make ``N`` the new head node (* denotes head): previous/oldest <-> head <-> next/next newest ----<->--- A* ---<->----- | | E <-> D <-> N <-> C <-> B To: ----<->--- N* ---<->----- | | E <-> D <-> C <-> B <-> A This requires the following moves: C.next = D (node.prev.next = node.next) D.prev = C (node.next.prev = node.prev) E.next = N (head.prev.next = node) N.prev = E (node.prev = head.prev) N.next = A (node.next = head) A.prev = N (head.prev = node) """ head = self._head # C.next = D node.prev.next = node.next # D.prev = C node.next.prev = node.prev # N.prev = E node.prev = head.prev # N.next = A # It is tempting to do just "head" here, however if node is # adjacent to head, this will do bad things. node.next = head.prev.next # E.next = N node.next.prev = node # A.prev = N node.prev.next = node self._head = node def _addcapacity(self): """Add a node to the circular linked list. The new node is inserted before the head node. """ head = self._head node = _lrucachenode() head.prev.next = node node.prev = head.prev node.next = head head.prev = node self._size += 1 return node def lrucachefunc(func): '''cache most recent results of function calls''' cache = {} order = collections.deque() if func.__code__.co_argcount == 1: def f(arg): if arg not in cache: if len(cache) > 20: del cache[order.popleft()] cache[arg] = func(arg) else: order.remove(arg) order.append(arg) return cache[arg] else: def f(*args): if args not in cache: if len(cache) > 20: del cache[order.popleft()] cache[args] = func(*args) else: order.remove(args) order.append(args) return cache[args] return f class propertycache(object): def __init__(self, func): self.func = func self.name = func.__name__ def __get__(self, obj, type=None): result = self.func(obj) self.cachevalue(obj, result) return result def cachevalue(self, obj, value): # __dict__ assignment required to bypass __setattr__ (eg: repoview) obj.__dict__[self.name] = value def pipefilter(s, cmd): '''filter string S through command CMD, returning its output''' p = subprocess.Popen(cmd, shell=True, close_fds=closefds, stdin=subprocess.PIPE, stdout=subprocess.PIPE) pout, perr = p.communicate(s) return pout def tempfilter(s, cmd): '''filter string S through a pair of temporary files with CMD. CMD is used as a template to create the real command to be run, with the strings INFILE and OUTFILE replaced by the real names of the temporary files generated.''' inname, outname = None, None try: infd, inname = tempfile.mkstemp(prefix='hg-filter-in-') fp = os.fdopen(infd, 'wb') fp.write(s) fp.close() outfd, outname = tempfile.mkstemp(prefix='hg-filter-out-') os.close(outfd) cmd = cmd.replace('INFILE', inname) cmd = cmd.replace('OUTFILE', outname) code = os.system(cmd) if sys.platform == 'OpenVMS' and code & 1: code = 0 if code: raise Abort(_("command '%s' failed: %s") % (cmd, explainexit(code))) return readfile(outname) finally: try: if inname: os.unlink(inname) except OSError: pass try: if outname: os.unlink(outname) except OSError: pass filtertable = { 'tempfile:': tempfilter, 'pipe:': pipefilter, } def filter(s, cmd): "filter a string through a command that transforms its input to its output" for name, fn in filtertable.iteritems(): if cmd.startswith(name): return fn(s, cmd[len(name):].lstrip()) return pipefilter(s, cmd) def binary(s): """return true if a string is binary data""" return bool(s and '\0' in s) def increasingchunks(source, min=1024, max=65536): '''return no less than min bytes per chunk while data remains, doubling min after each chunk until it reaches max''' def log2(x): if not x: return 0 i = 0 while x: x >>= 1 i += 1 return i - 1 buf = [] blen = 0 for chunk in source: buf.append(chunk) blen += len(chunk) if blen >= min: if min < max: min = min << 1 nmin = 1 << log2(blen) if nmin > min: min = nmin if min > max: min = max yield ''.join(buf) blen = 0 buf = [] if buf: yield ''.join(buf) Abort = error.Abort def always(fn): return True def never(fn): return False def nogc(func): """disable garbage collector Python's garbage collector triggers a GC each time a certain number of container objects (the number being defined by gc.get_threshold()) are allocated even when marked not to be tracked by the collector. Tracking has no effect on when GCs are triggered, only on what objects the GC looks into. As a workaround, disable GC while building complex (huge) containers. This garbage collector issue have been fixed in 2.7. """ if sys.version_info >= (2, 7): return func def wrapper(*args, **kwargs): gcenabled = gc.isenabled() gc.disable() try: return func(*args, **kwargs) finally: if gcenabled: gc.enable() return wrapper def pathto(root, n1, n2): '''return the relative path from one place to another. root should use os.sep to separate directories n1 should use os.sep to separate directories n2 should use "/" to separate directories returns an os.sep-separated path. If n1 is a relative path, it's assumed it's relative to root. n2 should always be relative to root. ''' if not n1: return localpath(n2) if os.path.isabs(n1): if os.path.splitdrive(root)[0] != os.path.splitdrive(n1)[0]: return os.path.join(root, localpath(n2)) n2 = '/'.join((pconvert(root), n2)) a, b = splitpath(n1), n2.split('/') a.reverse() b.reverse() while a and b and a[-1] == b[-1]: a.pop() b.pop() b.reverse() return os.sep.join((['..'] * len(a)) + b) or '.' def mainfrozen(): """return True if we are a frozen executable. The code supports py2exe (most common, Windows only) and tools/freeze (portable, not much used). """ return (safehasattr(sys, "frozen") or # new py2exe safehasattr(sys, "importers") or # old py2exe imp.is_frozen(u"__main__")) # tools/freeze # the location of data files matching the source code if mainfrozen() and getattr(sys, 'frozen', None) != 'macosx_app': # executable version (py2exe) doesn't support __file__ datapath = os.path.dirname(sys.executable) else: datapath = os.path.dirname(__file__) if not isinstance(datapath, bytes): datapath = pycompat.fsencode(datapath) i18n.setdatapath(datapath) _hgexecutable = None def hgexecutable(): """return location of the 'hg' executable. Defaults to $HG or 'hg' in the search path. """ if _hgexecutable is None: hg = os.environ.get('HG') mainmod = sys.modules['__main__'] if hg: _sethgexecutable(hg) elif mainfrozen(): if getattr(sys, 'frozen', None) == 'macosx_app': # Env variable set by py2app _sethgexecutable(os.environ['EXECUTABLEPATH']) else: _sethgexecutable(sys.executable) elif os.path.basename(getattr(mainmod, '__file__', '')) == 'hg': _sethgexecutable(mainmod.__file__) else: exe = findexe('hg') or os.path.basename(sys.argv[0]) _sethgexecutable(exe) return _hgexecutable def _sethgexecutable(path): """set location of the 'hg' executable""" global _hgexecutable _hgexecutable = path def _isstdout(f): fileno = getattr(f, 'fileno', None) return fileno and fileno() == sys.__stdout__.fileno() def system(cmd, environ=None, cwd=None, onerr=None, errprefix=None, out=None): '''enhanced shell command execution. run with environment maybe modified, maybe in different dir. if command fails and onerr is None, return status, else raise onerr object as exception. if out is specified, it is assumed to be a file-like object that has a write() method. stdout and stderr will be redirected to out.''' if environ is None: environ = {} try: stdout.flush() except Exception: pass def py2shell(val): 'convert python object into string that is useful to shell' if val is None or val is False: return '0' if val is True: return '1' return str(val) origcmd = cmd cmd = quotecommand(cmd) if sys.platform == 'plan9' and (sys.version_info[0] == 2 and sys.version_info[1] < 7): # subprocess kludge to work around issues in half-baked Python # ports, notably bichued/python: if not cwd is None: os.chdir(cwd) rc = os.system(cmd) else: env = dict(os.environ) env.update((k, py2shell(v)) for k, v in environ.iteritems()) env['HG'] = hgexecutable() if out is None or _isstdout(out): rc = subprocess.call(cmd, shell=True, close_fds=closefds, env=env, cwd=cwd) else: proc = subprocess.Popen(cmd, shell=True, close_fds=closefds, env=env, cwd=cwd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) for line in iter(proc.stdout.readline, ''): out.write(line) proc.wait() rc = proc.returncode if sys.platform == 'OpenVMS' and rc & 1: rc = 0 if rc and onerr: errmsg = '%s %s' % (os.path.basename(origcmd.split(None, 1)[0]), explainexit(rc)[0]) if errprefix: errmsg = '%s: %s' % (errprefix, errmsg) raise onerr(errmsg) return rc def checksignature(func): '''wrap a function with code to check for calling errors''' def check(*args, **kwargs): try: return func(*args, **kwargs) except TypeError: if len(traceback.extract_tb(sys.exc_info()[2])) == 1: raise error.SignatureError raise return check def copyfile(src, dest, hardlink=False, copystat=False, checkambig=False): '''copy a file, preserving mode and optionally other stat info like atime/mtime checkambig argument is used with filestat, and is useful only if destination file is guarded by any lock (e.g. repo.lock or repo.wlock). copystat and checkambig should be exclusive. ''' assert not (copystat and checkambig) oldstat = None if os.path.lexists(dest): if checkambig: oldstat = checkambig and filestat(dest) unlink(dest) # hardlinks are problematic on CIFS, quietly ignore this flag # until we find a way to work around it cleanly (issue4546) if False and hardlink: try: oslink(src, dest) return except (IOError, OSError): pass # fall back to normal copy if os.path.islink(src): os.symlink(os.readlink(src), dest) # copytime is ignored for symlinks, but in general copytime isn't needed # for them anyway else: try: shutil.copyfile(src, dest) if copystat: # copystat also copies mode shutil.copystat(src, dest) else: shutil.copymode(src, dest) if oldstat and oldstat.stat: newstat = filestat(dest) if newstat.isambig(oldstat): # stat of copied file is ambiguous to original one advanced = (oldstat.stat.st_mtime + 1) & 0x7fffffff os.utime(dest, (advanced, advanced)) except shutil.Error as inst: raise Abort(str(inst)) def copyfiles(src, dst, hardlink=None, progress=lambda t, pos: None): """Copy a directory tree using hardlinks if possible.""" num = 0 if hardlink is None: hardlink = (os.stat(src).st_dev == os.stat(os.path.dirname(dst)).st_dev) if hardlink: topic = _('linking') else: topic = _('copying') if os.path.isdir(src): os.mkdir(dst) for name, kind in osutil.listdir(src): srcname = os.path.join(src, name) dstname = os.path.join(dst, name) def nprog(t, pos): if pos is not None: return progress(t, pos + num) hardlink, n = copyfiles(srcname, dstname, hardlink, progress=nprog) num += n else: if hardlink: try: oslink(src, dst) except (IOError, OSError): hardlink = False shutil.copy(src, dst) else: shutil.copy(src, dst) num += 1 progress(topic, num) progress(topic, None) return hardlink, num _winreservednames = '''con prn aux nul com1 com2 com3 com4 com5 com6 com7 com8 com9 lpt1 lpt2 lpt3 lpt4 lpt5 lpt6 lpt7 lpt8 lpt9'''.split() _winreservedchars = ':*?"<>|' def checkwinfilename(path): r'''Check that the base-relative path is a valid filename on Windows. Returns None if the path is ok, or a UI string describing the problem. >>> checkwinfilename("just/a/normal/path") >>> checkwinfilename("foo/bar/con.xml") "filename contains 'con', which is reserved on Windows" >>> checkwinfilename("foo/con.xml/bar") "filename contains 'con', which is reserved on Windows" >>> checkwinfilename("foo/bar/xml.con") >>> checkwinfilename("foo/bar/AUX/bla.txt") "filename contains 'AUX', which is reserved on Windows" >>> checkwinfilename("foo/bar/bla:.txt") "filename contains ':', which is reserved on Windows" >>> checkwinfilename("foo/bar/b\07la.txt") "filename contains '\\x07', which is invalid on Windows" >>> checkwinfilename("foo/bar/bla ") "filename ends with ' ', which is not allowed on Windows" >>> checkwinfilename("../bar") >>> checkwinfilename("foo\\") "filename ends with '\\', which is invalid on Windows" >>> checkwinfilename("foo\\/bar") "directory name ends with '\\', which is invalid on Windows" ''' if path.endswith('\\'): return _("filename ends with '\\', which is invalid on Windows") if '\\/' in path: return _("directory name ends with '\\', which is invalid on Windows") for n in path.replace('\\', '/').split('/'): if not n: continue for c in n: if c in _winreservedchars: return _("filename contains '%s', which is reserved " "on Windows") % c if ord(c) <= 31: return _("filename contains %r, which is invalid " "on Windows") % c base = n.split('.')[0] if base and base.lower() in _winreservednames: return _("filename contains '%s', which is reserved " "on Windows") % base t = n[-1] if t in '. ' and n not in '..': return _("filename ends with '%s', which is not allowed " "on Windows") % t if os.name == 'nt': checkosfilename = checkwinfilename else: checkosfilename = platform.checkosfilename def makelock(info, pathname): try: return os.symlink(info, pathname) except OSError as why: if why.errno == errno.EEXIST: raise except AttributeError: # no symlink in os pass ld = os.open(pathname, os.O_CREAT | os.O_WRONLY | os.O_EXCL) os.write(ld, info) os.close(ld) def readlock(pathname): try: return os.readlink(pathname) except OSError as why: if why.errno not in (errno.EINVAL, errno.ENOSYS): raise except AttributeError: # no symlink in os pass fp = posixfile(pathname) r = fp.read() fp.close() return r def fstat(fp): '''stat file object that may not have fileno method.''' try: return os.fstat(fp.fileno()) except AttributeError: return os.stat(fp.name) # File system features def fscasesensitive(path): """ Return true if the given path is on a case-sensitive filesystem Requires a path (like /foo/.hg) ending with a foldable final directory component. """ s1 = os.lstat(path) d, b = os.path.split(path) b2 = b.upper() if b == b2: b2 = b.lower() if b == b2: return True # no evidence against case sensitivity p2 = os.path.join(d, b2) try: s2 = os.lstat(p2) if s2 == s1: return False return True except OSError: return True try: import re2 _re2 = None except ImportError: _re2 = False class _re(object): def _checkre2(self): global _re2 try: # check if match works, see issue3964 _re2 = bool(re2.match(r'\[([^\[]+)\]', '[ui]')) except ImportError: _re2 = False def compile(self, pat, flags=0): '''Compile a regular expression, using re2 if possible For best performance, use only re2-compatible regexp features. The only flags from the re module that are re2-compatible are IGNORECASE and MULTILINE.''' if _re2 is None: self._checkre2() if _re2 and (flags & ~(remod.IGNORECASE | remod.MULTILINE)) == 0: if flags & remod.IGNORECASE: pat = '(?i)' + pat if flags & remod.MULTILINE: pat = '(?m)' + pat try: return re2.compile(pat) except re2.error: pass return remod.compile(pat, flags) @propertycache def escape(self): '''Return the version of escape corresponding to self.compile. This is imperfect because whether re2 or re is used for a particular function depends on the flags, etc, but it's the best we can do. ''' global _re2 if _re2 is None: self._checkre2() if _re2: return re2.escape else: return remod.escape re = _re() _fspathcache = {} def fspath(name, root): '''Get name in the case stored in the filesystem The name should be relative to root, and be normcase-ed for efficiency. Note that this function is unnecessary, and should not be called, for case-sensitive filesystems (simply because it's expensive). The root should be normcase-ed, too. ''' def _makefspathcacheentry(dir): return dict((normcase(n), n) for n in os.listdir(dir)) seps = os.sep if os.altsep: seps = seps + os.altsep # Protect backslashes. This gets silly very quickly. seps.replace('\\','\\\\') pattern = remod.compile(r'([^%s]+)|([%s]+)' % (seps, seps)) dir = os.path.normpath(root) result = [] for part, sep in pattern.findall(name): if sep: result.append(sep) continue if dir not in _fspathcache: _fspathcache[dir] = _makefspathcacheentry(dir) contents = _fspathcache[dir] found = contents.get(part) if not found: # retry "once per directory" per "dirstate.walk" which # may take place for each patches of "hg qpush", for example _fspathcache[dir] = contents = _makefspathcacheentry(dir) found = contents.get(part) result.append(found or part) dir = os.path.join(dir, part) return ''.join(result) def checknlink(testfile): '''check whether hardlink count reporting works properly''' # testfile may be open, so we need a separate file for checking to # work around issue2543 (or testfile may get lost on Samba shares) f1 = testfile + ".hgtmp1" if os.path.lexists(f1): return False try: posixfile(f1, 'w').close() except IOError: try: os.unlink(f1) except OSError: pass return False f2 = testfile + ".hgtmp2" fd = None try: oslink(f1, f2) # nlinks() may behave differently for files on Windows shares if # the file is open. fd = posixfile(f2) return nlinks(f2) > 1 except OSError: return False finally: if fd is not None: fd.close() for f in (f1, f2): try: os.unlink(f) except OSError: pass def endswithsep(path): '''Check path ends with os.sep or os.altsep.''' return path.endswith(os.sep) or os.altsep and path.endswith(os.altsep) def splitpath(path): '''Split path by os.sep. Note that this function does not use os.altsep because this is an alternative of simple "xxx.split(os.sep)". It is recommended to use os.path.normpath() before using this function if need.''' return path.split(os.sep) def gui(): '''Are we running in a GUI?''' if sys.platform == 'darwin': if 'SSH_CONNECTION' in os.environ: # handle SSH access to a box where the user is logged in return False elif getattr(osutil, 'isgui', None): # check if a CoreGraphics session is available return osutil.isgui() else: # pure build; use a safe default return True else: return os.name == "nt" or os.environ.get("DISPLAY") def mktempcopy(name, emptyok=False, createmode=None): """Create a temporary file with the same contents from name The permission bits are copied from the original file. If the temporary file is going to be truncated immediately, you can use emptyok=True as an optimization. Returns the name of the temporary file. """ d, fn = os.path.split(name) fd, temp = tempfile.mkstemp(prefix='.%s-' % fn, dir=d) os.close(fd) # Temporary files are created with mode 0600, which is usually not # what we want. If the original file already exists, just copy # its mode. Otherwise, manually obey umask. copymode(name, temp, createmode) if emptyok: return temp try: try: ifp = posixfile(name, "rb") except IOError as inst: if inst.errno == errno.ENOENT: return temp if not getattr(inst, 'filename', None): inst.filename = name raise ofp = posixfile(temp, "wb") for chunk in filechunkiter(ifp): ofp.write(chunk) ifp.close() ofp.close() except: # re-raises try: os.unlink(temp) except OSError: pass raise return temp class filestat(object): """help to exactly detect change of a file 'stat' attribute is result of 'os.stat()' if specified 'path' exists. Otherwise, it is None. This can avoid preparative 'exists()' examination on client side of this class. """ def __init__(self, path): try: self.stat = os.stat(path) except OSError as err: if err.errno != errno.ENOENT: raise self.stat = None __hash__ = object.__hash__ def __eq__(self, old): try: # if ambiguity between stat of new and old file is # avoided, comparison of size, ctime and mtime is enough # to exactly detect change of a file regardless of platform return (self.stat.st_size == old.stat.st_size and self.stat.st_ctime == old.stat.st_ctime and self.stat.st_mtime == old.stat.st_mtime) except AttributeError: return False def isambig(self, old): """Examine whether new (= self) stat is ambiguous against old one "S[N]" below means stat of a file at N-th change: - S[n-1].ctime < S[n].ctime: can detect change of a file - S[n-1].ctime == S[n].ctime - S[n-1].ctime < S[n].mtime: means natural advancing (*1) - S[n-1].ctime == S[n].mtime: is ambiguous (*2) - S[n-1].ctime > S[n].mtime: never occurs naturally (don't care) - S[n-1].ctime > S[n].ctime: never occurs naturally (don't care) Case (*2) above means that a file was changed twice or more at same time in sec (= S[n-1].ctime), and comparison of timestamp is ambiguous. Base idea to avoid such ambiguity is "advance mtime 1 sec, if timestamp is ambiguous". But advancing mtime only in case (*2) doesn't work as expected, because naturally advanced S[n].mtime in case (*1) might be equal to manually advanced S[n-1 or earlier].mtime. Therefore, all "S[n-1].ctime == S[n].ctime" cases should be treated as ambiguous regardless of mtime, to avoid overlooking by confliction between such mtime. Advancing mtime "if isambig(oldstat)" ensures "S[n-1].mtime != S[n].mtime", even if size of a file isn't changed. """ try: return (self.stat.st_ctime == old.stat.st_ctime) except AttributeError: return False def avoidambig(self, path, old): """Change file stat of specified path to avoid ambiguity 'old' should be previous filestat of 'path'. This skips avoiding ambiguity, if a process doesn't have appropriate privileges for 'path'. """ advanced = (old.stat.st_mtime + 1) & 0x7fffffff try: os.utime(path, (advanced, advanced)) except OSError as inst: if inst.errno == errno.EPERM: # utime() on the file created by another user causes EPERM, # if a process doesn't have appropriate privileges return raise def __ne__(self, other): return not self == other class atomictempfile(object): '''writable file object that atomically updates a file All writes will go to a temporary copy of the original file. Call close() when you are done writing, and atomictempfile will rename the temporary copy to the original name, making the changes visible. If the object is destroyed without being closed, all your writes are discarded. checkambig argument of constructor is used with filestat, and is useful only if target file is guarded by any lock (e.g. repo.lock or repo.wlock). ''' def __init__(self, name, mode='w+b', createmode=None, checkambig=False): self.__name = name # permanent name self._tempname = mktempcopy(name, emptyok=('w' in mode), createmode=createmode) self._fp = posixfile(self._tempname, mode) self._checkambig = checkambig # delegated methods self.read = self._fp.read self.write = self._fp.write self.seek = self._fp.seek self.tell = self._fp.tell self.fileno = self._fp.fileno def close(self): if not self._fp.closed: self._fp.close() filename = localpath(self.__name) oldstat = self._checkambig and filestat(filename) if oldstat and oldstat.stat: rename(self._tempname, filename) newstat = filestat(filename) if newstat.isambig(oldstat): # stat of changed file is ambiguous to original one advanced = (oldstat.stat.st_mtime + 1) & 0x7fffffff os.utime(filename, (advanced, advanced)) else: rename(self._tempname, filename) def discard(self): if not self._fp.closed: try: os.unlink(self._tempname) except OSError: pass self._fp.close() def __del__(self): if safehasattr(self, '_fp'): # constructor actually did something self.discard() def __enter__(self): return self def __exit__(self, exctype, excvalue, traceback): if exctype is not None: self.discard() else: self.close() def makedirs(name, mode=None, notindexed=False): """recursive directory creation with parent mode inheritance Newly created directories are marked as "not to be indexed by the content indexing service", if ``notindexed`` is specified for "write" mode access. """ try: makedir(name, notindexed) except OSError as err: if err.errno == errno.EEXIST: return if err.errno != errno.ENOENT or not name: raise parent = os.path.dirname(os.path.abspath(name)) if parent == name: raise makedirs(parent, mode, notindexed) try: makedir(name, notindexed) except OSError as err: # Catch EEXIST to handle races if err.errno == errno.EEXIST: return raise if mode is not None: os.chmod(name, mode) def readfile(path): with open(path, 'rb') as fp: return fp.read() def writefile(path, text): with open(path, 'wb') as fp: fp.write(text) def appendfile(path, text): with open(path, 'ab') as fp: fp.write(text) class chunkbuffer(object): """Allow arbitrary sized chunks of data to be efficiently read from an iterator over chunks of arbitrary size.""" def __init__(self, in_iter): """in_iter is the iterator that's iterating over the input chunks. targetsize is how big a buffer to try to maintain.""" def splitbig(chunks): for chunk in chunks: if len(chunk) > 2**20: pos = 0 while pos < len(chunk): end = pos + 2 ** 18 yield chunk[pos:end] pos = end else: yield chunk self.iter = splitbig(in_iter) self._queue = collections.deque() self._chunkoffset = 0 def read(self, l=None): """Read L bytes of data from the iterator of chunks of data. Returns less than L bytes if the iterator runs dry. If size parameter is omitted, read everything""" if l is None: return ''.join(self.iter) left = l buf = [] queue = self._queue while left > 0: # refill the queue if not queue: target = 2**18 for chunk in self.iter: queue.append(chunk) target -= len(chunk) if target <= 0: break if not queue: break # The easy way to do this would be to queue.popleft(), modify the # chunk (if necessary), then queue.appendleft(). However, for cases # where we read partial chunk content, this incurs 2 dequeue # mutations and creates a new str for the remaining chunk in the # queue. Our code below avoids this overhead. chunk = queue[0] chunkl = len(chunk) offset = self._chunkoffset # Use full chunk. if offset == 0 and left >= chunkl: left -= chunkl queue.popleft() buf.append(chunk) # self._chunkoffset remains at 0. continue chunkremaining = chunkl - offset # Use all of unconsumed part of chunk. if left >= chunkremaining: left -= chunkremaining queue.popleft() # offset == 0 is enabled by block above, so this won't merely # copy via ``chunk[0:]``. buf.append(chunk[offset:]) self._chunkoffset = 0 # Partial chunk needed. else: buf.append(chunk[offset:offset + left]) self._chunkoffset += left left -= chunkremaining return ''.join(buf) def filechunkiter(f, size=131072, limit=None): """Create a generator that produces the data in the file size (default 131072) bytes at a time, up to optional limit (default is to read all data). Chunks may be less than size bytes if the chunk is the last chunk in the file, or the file is a socket or some other type of file that sometimes reads less data than is requested.""" assert size >= 0 assert limit is None or limit >= 0 while True: if limit is None: nbytes = size else: nbytes = min(limit, size) s = nbytes and f.read(nbytes) if not s: break if limit: limit -= len(s) yield s def makedate(timestamp=None): '''Return a unix timestamp (or the current time) as a (unixtime, offset) tuple based off the local timezone.''' if timestamp is None: timestamp = time.time() if timestamp < 0: hint = _("check your clock") raise Abort(_("negative timestamp: %d") % timestamp, hint=hint) delta = (datetime.datetime.utcfromtimestamp(timestamp) - datetime.datetime.fromtimestamp(timestamp)) tz = delta.days * 86400 + delta.seconds return timestamp, tz def datestr(date=None, format='%a %b %d %H:%M:%S %Y %1%2'): """represent a (unixtime, offset) tuple as a localized time. unixtime is seconds since the epoch, and offset is the time zone's number of seconds away from UTC. >>> datestr((0, 0)) 'Thu Jan 01 00:00:00 1970 +0000' >>> datestr((42, 0)) 'Thu Jan 01 00:00:42 1970 +0000' >>> datestr((-42, 0)) 'Wed Dec 31 23:59:18 1969 +0000' >>> datestr((0x7fffffff, 0)) 'Tue Jan 19 03:14:07 2038 +0000' >>> datestr((-0x80000000, 0)) 'Fri Dec 13 20:45:52 1901 +0000' """ t, tz = date or makedate() if "%1" in format or "%2" in format or "%z" in format: sign = (tz > 0) and "-" or "+" minutes = abs(tz) // 60 q, r = divmod(minutes, 60) format = format.replace("%z", "%1%2") format = format.replace("%1", "%c%02d" % (sign, q)) format = format.replace("%2", "%02d" % r) d = t - tz if d > 0x7fffffff: d = 0x7fffffff elif d < -0x80000000: d = -0x80000000 # Never use time.gmtime() and datetime.datetime.fromtimestamp() # because they use the gmtime() system call which is buggy on Windows # for negative values. t = datetime.datetime(1970, 1, 1) + datetime.timedelta(seconds=d) s = t.strftime(format) return s def shortdate(date=None): """turn (timestamp, tzoff) tuple into iso 8631 date.""" return datestr(date, format='%Y-%m-%d') def parsetimezone(s): """find a trailing timezone, if any, in string, and return a (offset, remainder) pair""" if s.endswith("GMT") or s.endswith("UTC"): return 0, s[:-3].rstrip() # Unix-style timezones [+-]hhmm if len(s) >= 5 and s[-5] in "+-" and s[-4:].isdigit(): sign = (s[-5] == "+") and 1 or -1 hours = int(s[-4:-2]) minutes = int(s[-2:]) return -sign * (hours * 60 + minutes) * 60, s[:-5].rstrip() # ISO8601 trailing Z if s.endswith("Z") and s[-2:-1].isdigit(): return 0, s[:-1] # ISO8601-style [+-]hh:mm if (len(s) >= 6 and s[-6] in "+-" and s[-3] == ":" and s[-5:-3].isdigit() and s[-2:].isdigit()): sign = (s[-6] == "+") and 1 or -1 hours = int(s[-5:-3]) minutes = int(s[-2:]) return -sign * (hours * 60 + minutes) * 60, s[:-6] return None, s def strdate(string, format, defaults=[]): """parse a localized time string and return a (unixtime, offset) tuple. if the string cannot be parsed, ValueError is raised.""" # NOTE: unixtime = localunixtime + offset offset, date = parsetimezone(string) # add missing elements from defaults usenow = False # default to using biased defaults for part in ("S", "M", "HI", "d", "mb", "yY"): # decreasing specificity found = [True for p in part if ("%"+p) in format] if not found: date += "@" + defaults[part][usenow] format += "@%" + part[0] else: # We've found a specific time element, less specific time # elements are relative to today usenow = True timetuple = time.strptime(date, format) localunixtime = int(calendar.timegm(timetuple)) if offset is None: # local timezone unixtime = int(time.mktime(timetuple)) offset = unixtime - localunixtime else: unixtime = localunixtime + offset return unixtime, offset def parsedate(date, formats=None, bias=None): """parse a localized date/time and return a (unixtime, offset) tuple. The date may be a "unixtime offset" string or in one of the specified formats. If the date already is a (unixtime, offset) tuple, it is returned. >>> parsedate(' today ') == parsedate(\ datetime.date.today().strftime('%b %d')) True >>> parsedate( 'yesterday ') == parsedate((datetime.date.today() -\ datetime.timedelta(days=1)\ ).strftime('%b %d')) True >>> now, tz = makedate() >>> strnow, strtz = parsedate('now') >>> (strnow - now) < 1 True >>> tz == strtz True """ if bias is None: bias = {} if not date: return 0, 0 if isinstance(date, tuple) and len(date) == 2: return date if not formats: formats = defaultdateformats date = date.strip() if date == 'now' or date == _('now'): return makedate() if date == 'today' or date == _('today'): date = datetime.date.today().strftime('%b %d') elif date == 'yesterday' or date == _('yesterday'): date = (datetime.date.today() - datetime.timedelta(days=1)).strftime('%b %d') try: when, offset = map(int, date.split(' ')) except ValueError: # fill out defaults now = makedate() defaults = {} for part in ("d", "mb", "yY", "HI", "M", "S"): # this piece is for rounding the specific end of unknowns b = bias.get(part) if b is None: if part[0] in "HMS": b = "00" else: b = "0" # this piece is for matching the generic end to today's date n = datestr(now, "%" + part[0]) defaults[part] = (b, n) for format in formats: try: when, offset = strdate(date, format, defaults) except (ValueError, OverflowError): pass else: break else: raise Abort(_('invalid date: %r') % date) # validate explicit (probably user-specified) date and # time zone offset. values must fit in signed 32 bits for # current 32-bit linux runtimes. timezones go from UTC-12 # to UTC+14 if when < -0x80000000 or when > 0x7fffffff: raise Abort(_('date exceeds 32 bits: %d') % when) if offset < -50400 or offset > 43200: raise Abort(_('impossible time zone offset: %d') % offset) return when, offset def matchdate(date): """Return a function that matches a given date match specifier Formats include: '{date}' match a given date to the accuracy provided '<{date}' on or before a given date '>{date}' on or after a given date >>> p1 = parsedate("10:29:59") >>> p2 = parsedate("10:30:00") >>> p3 = parsedate("10:30:59") >>> p4 = parsedate("10:31:00") >>> p5 = parsedate("Sep 15 10:30:00 1999") >>> f = matchdate("10:30") >>> f(p1[0]) False >>> f(p2[0]) True >>> f(p3[0]) True >>> f(p4[0]) False >>> f(p5[0]) False """ def lower(date): d = {'mb': "1", 'd': "1"} return parsedate(date, extendeddateformats, d)[0] def upper(date): d = {'mb': "12", 'HI': "23", 'M': "59", 'S': "59"} for days in ("31", "30", "29"): try: d["d"] = days return parsedate(date, extendeddateformats, d)[0] except Abort: pass d["d"] = "28" return parsedate(date, extendeddateformats, d)[0] date = date.strip() if not date: raise Abort(_("dates cannot consist entirely of whitespace")) elif date[0] == "<": if not date[1:]: raise Abort(_("invalid day spec, use '": if not date[1:]: raise Abort(_("invalid day spec, use '>DATE'")) when = lower(date[1:]) return lambda x: x >= when elif date[0] == "-": try: days = int(date[1:]) except ValueError: raise Abort(_("invalid day spec: %s") % date[1:]) if days < 0: raise Abort(_("%s must be nonnegative (see 'hg help dates')") % date[1:]) when = makedate()[0] - days * 3600 * 24 return lambda x: x >= when elif " to " in date: a, b = date.split(" to ") start, stop = lower(a), upper(b) return lambda x: x >= start and x <= stop else: start, stop = lower(date), upper(date) return lambda x: x >= start and x <= stop def stringmatcher(pattern): """ accepts a string, possibly starting with 're:' or 'literal:' prefix. returns the matcher name, pattern, and matcher function. missing or unknown prefixes are treated as literal matches. helper for tests: >>> def test(pattern, *tests): ... kind, pattern, matcher = stringmatcher(pattern) ... return (kind, pattern, [bool(matcher(t)) for t in tests]) exact matching (no prefix): >>> test('abcdefg', 'abc', 'def', 'abcdefg') ('literal', 'abcdefg', [False, False, True]) regex matching ('re:' prefix) >>> test('re:a.+b', 'nomatch', 'fooadef', 'fooadefbar') ('re', 'a.+b', [False, False, True]) force exact matches ('literal:' prefix) >>> test('literal:re:foobar', 'foobar', 're:foobar') ('literal', 're:foobar', [False, True]) unknown prefixes are ignored and treated as literals >>> test('foo:bar', 'foo', 'bar', 'foo:bar') ('literal', 'foo:bar', [False, False, True]) """ if pattern.startswith('re:'): pattern = pattern[3:] try: regex = remod.compile(pattern) except remod.error as e: raise error.ParseError(_('invalid regular expression: %s') % e) return 're', pattern, regex.search elif pattern.startswith('literal:'): pattern = pattern[8:] return 'literal', pattern, pattern.__eq__ def shortuser(user): """Return a short representation of a user name or email address.""" f = user.find('@') if f >= 0: user = user[:f] f = user.find('<') if f >= 0: user = user[f + 1:] f = user.find(' ') if f >= 0: user = user[:f] f = user.find('.') if f >= 0: user = user[:f] return user def emailuser(user): """Return the user portion of an email address.""" f = user.find('@') if f >= 0: user = user[:f] f = user.find('<') if f >= 0: user = user[f + 1:] return user def email(author): '''get email of author.''' r = author.find('>') if r == -1: r = None return author[author.find('<') + 1:r] def ellipsis(text, maxlength=400): """Trim string to at most maxlength (default: 400) columns in display.""" return encoding.trim(text, maxlength, ellipsis='...') def unitcountfn(*unittable): '''return a function that renders a readable count of some quantity''' def go(count): for multiplier, divisor, format in unittable: if count >= divisor * multiplier: return format % (count / float(divisor)) return unittable[-1][2] % count return go bytecount = unitcountfn( (100, 1 << 30, _('%.0f GB')), (10, 1 << 30, _('%.1f GB')), (1, 1 << 30, _('%.2f GB')), (100, 1 << 20, _('%.0f MB')), (10, 1 << 20, _('%.1f MB')), (1, 1 << 20, _('%.2f MB')), (100, 1 << 10, _('%.0f KB')), (10, 1 << 10, _('%.1f KB')), (1, 1 << 10, _('%.2f KB')), (1, 1, _('%.0f bytes')), ) def uirepr(s): # Avoid double backslash in Windows path repr() return repr(s).replace('\\\\', '\\') # delay import of textwrap def MBTextWrapper(**kwargs): class tw(textwrap.TextWrapper): """ Extend TextWrapper for width-awareness. Neither number of 'bytes' in any encoding nor 'characters' is appropriate to calculate terminal columns for specified string. Original TextWrapper implementation uses built-in 'len()' directly, so overriding is needed to use width information of each characters. In addition, characters classified into 'ambiguous' width are treated as wide in East Asian area, but as narrow in other. This requires use decision to determine width of such characters. """ def _cutdown(self, ucstr, space_left): l = 0 colwidth = encoding.ucolwidth for i in xrange(len(ucstr)): l += colwidth(ucstr[i]) if space_left < l: return (ucstr[:i], ucstr[i:]) return ucstr, '' # overriding of base class def _handle_long_word(self, reversed_chunks, cur_line, cur_len, width): space_left = max(width - cur_len, 1) if self.break_long_words: cut, res = self._cutdown(reversed_chunks[-1], space_left) cur_line.append(cut) reversed_chunks[-1] = res elif not cur_line: cur_line.append(reversed_chunks.pop()) # this overriding code is imported from TextWrapper of Python 2.6 # to calculate columns of string by 'encoding.ucolwidth()' def _wrap_chunks(self, chunks): colwidth = encoding.ucolwidth lines = [] if self.width <= 0: raise ValueError("invalid width %r (must be > 0)" % self.width) # Arrange in reverse order so items can be efficiently popped # from a stack of chucks. chunks.reverse() while chunks: # Start the list of chunks that will make up the current line. # cur_len is just the length of all the chunks in cur_line. cur_line = [] cur_len = 0 # Figure out which static string will prefix this line. if lines: indent = self.subsequent_indent else: indent = self.initial_indent # Maximum width for this line. width = self.width - len(indent) # First chunk on line is whitespace -- drop it, unless this # is the very beginning of the text (i.e. no lines started yet). if self.drop_whitespace and chunks[-1].strip() == '' and lines: del chunks[-1] while chunks: l = colwidth(chunks[-1]) # Can at least squeeze this chunk onto the current line. if cur_len + l <= width: cur_line.append(chunks.pop()) cur_len += l # Nope, this line is full. else: break # The current line is full, and the next chunk is too big to # fit on *any* line (not just this one). if chunks and colwidth(chunks[-1]) > width: self._handle_long_word(chunks, cur_line, cur_len, width) # If the last chunk on this line is all whitespace, drop it. if (self.drop_whitespace and cur_line and cur_line[-1].strip() == ''): del cur_line[-1] # Convert current line back to a string and store it in list # of all lines (return value). if cur_line: lines.append(indent + ''.join(cur_line)) return lines global MBTextWrapper MBTextWrapper = tw return tw(**kwargs) def wrap(line, width, initindent='', hangindent=''): maxindent = max(len(hangindent), len(initindent)) if width <= maxindent: # adjust for weird terminal size width = max(78, maxindent + 1) line = line.decode(encoding.encoding, encoding.encodingmode) initindent = initindent.decode(encoding.encoding, encoding.encodingmode) hangindent = hangindent.decode(encoding.encoding, encoding.encodingmode) wrapper = MBTextWrapper(width=width, initial_indent=initindent, subsequent_indent=hangindent) return wrapper.fill(line).encode(encoding.encoding) if (pyplatform.python_implementation() == 'CPython' and sys.version_info < (3, 0)): # There is an issue in CPython that some IO methods do not handle EINTR # correctly. The following table shows what CPython version (and functions) # are affected (buggy: has the EINTR bug, okay: otherwise): # # | < 2.7.4 | 2.7.4 to 2.7.12 | >= 3.0 # -------------------------------------------------- # fp.__iter__ | buggy | buggy | okay # fp.read* | buggy | okay [1] | okay # # [1]: fixed by changeset 67dc99a989cd in the cpython hg repo. # # Here we workaround the EINTR issue for fileobj.__iter__. Other methods # like "read*" are ignored for now, as Python < 2.7.4 is a minority. # # Although we can workaround the EINTR issue for fp.__iter__, it is slower: # "for x in fp" is 4x faster than "for x in iter(fp.readline, '')" in # CPython 2, because CPython 2 maintains an internal readahead buffer for # fp.__iter__ but not other fp.read* methods. # # On modern systems like Linux, the "read" syscall cannot be interrupted # when reading "fast" files like on-disk files. So the EINTR issue only # affects things like pipes, sockets, ttys etc. We treat "normal" (S_ISREG) # files approximately as "fast" files and use the fast (unsafe) code path, # to minimize the performance impact. if sys.version_info >= (2, 7, 4): # fp.readline deals with EINTR correctly, use it as a workaround. def _safeiterfile(fp): return iter(fp.readline, '') else: # fp.read* are broken too, manually deal with EINTR in a stupid way. # note: this may block longer than necessary because of bufsize. def _safeiterfile(fp, bufsize=4096): fd = fp.fileno() line = '' while True: try: buf = os.read(fd, bufsize) except OSError as ex: # os.read only raises EINTR before any data is read if ex.errno == errno.EINTR: continue else: raise line += buf if '\n' in buf: splitted = line.splitlines(True) line = '' for l in splitted: if l[-1] == '\n': yield l else: line = l if not buf: break if line: yield line def iterfile(fp): fastpath = True if type(fp) is file: fastpath = stat.S_ISREG(os.fstat(fp.fileno()).st_mode) if fastpath: return fp else: return _safeiterfile(fp) else: # PyPy and CPython 3 do not have the EINTR issue thus no workaround needed. def iterfile(fp): return fp def iterlines(iterator): for chunk in iterator: for line in chunk.splitlines(): yield line def expandpath(path): return os.path.expanduser(os.path.expandvars(path)) def hgcmd(): """Return the command used to execute current hg This is different from hgexecutable() because on Windows we want to avoid things opening new shell windows like batch files, so we get either the python call or current executable. """ if mainfrozen(): if getattr(sys, 'frozen', None) == 'macosx_app': # Env variable set by py2app return [os.environ['EXECUTABLEPATH']] else: return [sys.executable] return gethgcmd() def rundetached(args, condfn): """Execute the argument list in a detached process. condfn is a callable which is called repeatedly and should return True once the child process is known to have started successfully. At this point, the child process PID is returned. If the child process fails to start or finishes before condfn() evaluates to True, return -1. """ # Windows case is easier because the child process is either # successfully starting and validating the condition or exiting # on failure. We just poll on its PID. On Unix, if the child # process fails to start, it will be left in a zombie state until # the parent wait on it, which we cannot do since we expect a long # running process on success. Instead we listen for SIGCHLD telling # us our child process terminated. terminated = set() def handler(signum, frame): terminated.add(os.wait()) prevhandler = None SIGCHLD = getattr(signal, 'SIGCHLD', None) if SIGCHLD is not None: prevhandler = signal.signal(SIGCHLD, handler) try: pid = spawndetached(args) while not condfn(): if ((pid in terminated or not testpid(pid)) and not condfn()): return -1 time.sleep(0.1) return pid finally: if prevhandler is not None: signal.signal(signal.SIGCHLD, prevhandler) def interpolate(prefix, mapping, s, fn=None, escape_prefix=False): """Return the result of interpolating items in the mapping into string s. prefix is a single character string, or a two character string with a backslash as the first character if the prefix needs to be escaped in a regular expression. fn is an optional function that will be applied to the replacement text just before replacement. escape_prefix is an optional flag that allows using doubled prefix for its escaping. """ fn = fn or (lambda s: s) patterns = '|'.join(mapping.keys()) if escape_prefix: patterns += '|' + prefix if len(prefix) > 1: prefix_char = prefix[1:] else: prefix_char = prefix mapping[prefix_char] = prefix_char r = remod.compile(r'%s(%s)' % (prefix, patterns)) return r.sub(lambda x: fn(mapping[x.group()[1:]]), s) def getport(port): """Return the port for a given network service. If port is an integer, it's returned as is. If it's a string, it's looked up using socket.getservbyname(). If there's no matching service, error.Abort is raised. """ try: return int(port) except ValueError: pass try: return socket.getservbyname(port) except socket.error: raise Abort(_("no port number associated with service '%s'") % port) _booleans = {'1': True, 'yes': True, 'true': True, 'on': True, 'always': True, '0': False, 'no': False, 'false': False, 'off': False, 'never': False} def parsebool(s): """Parse s into a boolean. If s is not a valid boolean, returns None. """ return _booleans.get(s.lower(), None) _hextochr = dict((a + b, chr(int(a + b, 16))) for a in string.hexdigits for b in string.hexdigits) class url(object): r"""Reliable URL parser. This parses URLs and provides attributes for the following components: ://:@:/?# Missing components are set to None. The only exception is fragment, which is set to '' if present but empty. If parsefragment is False, fragment is included in query. If parsequery is False, query is included in path. If both are False, both fragment and query are included in path. See http://www.ietf.org/rfc/rfc2396.txt for more information. Note that for backward compatibility reasons, bundle URLs do not take host names. That means 'bundle://../' has a path of '../'. Examples: >>> url('http://www.ietf.org/rfc/rfc2396.txt') >>> url('ssh://[::1]:2200//home/joe/repo') >>> url('file:///home/joe/repo') >>> url('file:///c:/temp/foo/') >>> url('bundle:foo') >>> url('bundle://../foo') >>> url(r'c:\foo\bar') >>> url(r'\\blah\blah\blah') >>> url(r'\\blah\blah\blah#baz') >>> url(r'file:///C:\users\me') Authentication credentials: >>> url('ssh://joe:xyz@x/repo') >>> url('ssh://joe@x/repo') Query strings and fragments: >>> url('http://host/a?b#c') >>> url('http://host/a?b#c', parsequery=False, parsefragment=False) Empty path: >>> url('') >>> url('#a') >>> url('http://host/') >>> url('http://host/#a') Only scheme: >>> url('http:') """ _safechars = "!~*'()+" _safepchars = "/!~*'()+:\\" _matchscheme = remod.compile('^[a-zA-Z0-9+.\\-]+:').match def __init__(self, path, parsequery=True, parsefragment=True): # We slowly chomp away at path until we have only the path left self.scheme = self.user = self.passwd = self.host = None self.port = self.path = self.query = self.fragment = None self._localpath = True self._hostport = '' self._origpath = path if parsefragment and '#' in path: path, self.fragment = path.split('#', 1) # special case for Windows drive letters and UNC paths if hasdriveletter(path) or path.startswith('\\\\'): self.path = path return # For compatibility reasons, we can't handle bundle paths as # normal URLS if path.startswith('bundle:'): self.scheme = 'bundle' path = path[7:] if path.startswith('//'): path = path[2:] self.path = path return if self._matchscheme(path): parts = path.split(':', 1) if parts[0]: self.scheme, path = parts self._localpath = False if not path: path = None if self._localpath: self.path = '' return else: if self._localpath: self.path = path return if parsequery and '?' in path: path, self.query = path.split('?', 1) if not path: path = None if not self.query: self.query = None # // is required to specify a host/authority if path and path.startswith('//'): parts = path[2:].split('/', 1) if len(parts) > 1: self.host, path = parts else: self.host = parts[0] path = None if not self.host: self.host = None # path of file:///d is /d # path of file:///d:/ is d:/, not /d:/ if path and not hasdriveletter(path): path = '/' + path if self.host and '@' in self.host: self.user, self.host = self.host.rsplit('@', 1) if ':' in self.user: self.user, self.passwd = self.user.split(':', 1) if not self.host: self.host = None # Don't split on colons in IPv6 addresses without ports if (self.host and ':' in self.host and not (self.host.startswith('[') and self.host.endswith(']'))): self._hostport = self.host self.host, self.port = self.host.rsplit(':', 1) if not self.host: self.host = None if (self.host and self.scheme == 'file' and self.host not in ('localhost', '127.0.0.1', '[::1]')): raise Abort(_('file:// URLs can only refer to localhost')) self.path = path # leave the query string escaped for a in ('user', 'passwd', 'host', 'port', 'path', 'fragment'): v = getattr(self, a) if v is not None: setattr(self, a, pycompat.urlunquote(v)) def __repr__(self): attrs = [] for a in ('scheme', 'user', 'passwd', 'host', 'port', 'path', 'query', 'fragment'): v = getattr(self, a) if v is not None: attrs.append('%s: %r' % (a, v)) return '' % ', '.join(attrs) def __str__(self): r"""Join the URL's components back into a URL string. Examples: >>> str(url('http://user:pw@host:80/c:/bob?fo:oo#ba:ar')) 'http://user:pw@host:80/c:/bob?fo:oo#ba:ar' >>> str(url('http://user:pw@host:80/?foo=bar&baz=42')) 'http://user:pw@host:80/?foo=bar&baz=42' >>> str(url('http://user:pw@host:80/?foo=bar%3dbaz')) 'http://user:pw@host:80/?foo=bar%3dbaz' >>> str(url('ssh://user:pw@[::1]:2200//home/joe#')) 'ssh://user:pw@[::1]:2200//home/joe#' >>> str(url('http://localhost:80//')) 'http://localhost:80//' >>> str(url('http://localhost:80/')) 'http://localhost:80/' >>> str(url('http://localhost:80')) 'http://localhost:80/' >>> str(url('bundle:foo')) 'bundle:foo' >>> str(url('bundle://../foo')) 'bundle:../foo' >>> str(url('path')) 'path' >>> str(url('file:///tmp/foo/bar')) 'file:///tmp/foo/bar' >>> str(url('file:///c:/tmp/foo/bar')) 'file:///c:/tmp/foo/bar' >>> print url(r'bundle:foo\bar') bundle:foo\bar >>> print url(r'file:///D:\data\hg') file:///D:\data\hg """ if self._localpath: s = self.path if self.scheme == 'bundle': s = 'bundle:' + s if self.fragment: s += '#' + self.fragment return s s = self.scheme + ':' if self.user or self.passwd or self.host: s += '//' elif self.scheme and (not self.path or self.path.startswith('/') or hasdriveletter(self.path)): s += '//' if hasdriveletter(self.path): s += '/' if self.user: s += urlreq.quote(self.user, safe=self._safechars) if self.passwd: s += ':' + urlreq.quote(self.passwd, safe=self._safechars) if self.user or self.passwd: s += '@' if self.host: if not (self.host.startswith('[') and self.host.endswith(']')): s += urlreq.quote(self.host) else: s += self.host if self.port: s += ':' + urlreq.quote(self.port) if self.host: s += '/' if self.path: # TODO: similar to the query string, we should not unescape the # path when we store it, the path might contain '%2f' = '/', # which we should *not* escape. s += urlreq.quote(self.path, safe=self._safepchars) if self.query: # we store the query in escaped form. s += '?' + self.query if self.fragment is not None: s += '#' + urlreq.quote(self.fragment, safe=self._safepchars) return s def authinfo(self): user, passwd = self.user, self.passwd try: self.user, self.passwd = None, None s = str(self) finally: self.user, self.passwd = user, passwd if not self.user: return (s, None) # authinfo[1] is passed to urllib2 password manager, and its # URIs must not contain credentials. The host is passed in the # URIs list because Python < 2.4.3 uses only that to search for # a password. return (s, (None, (s, self.host), self.user, self.passwd or '')) def isabs(self): if self.scheme and self.scheme != 'file': return True # remote URL if hasdriveletter(self.path): return True # absolute for our purposes - can't be joined() if self.path.startswith(r'\\'): return True # Windows UNC path if self.path.startswith('/'): return True # POSIX-style return False def localpath(self): if self.scheme == 'file' or self.scheme == 'bundle': path = self.path or '/' # For Windows, we need to promote hosts containing drive # letters to paths with drive letters. if hasdriveletter(self._hostport): path = self._hostport + '/' + self.path elif (self.host is not None and self.path and not hasdriveletter(path)): path = '/' + path return path return self._origpath def islocal(self): '''whether localpath will return something that posixfile can open''' return (not self.scheme or self.scheme == 'file' or self.scheme == 'bundle') def hasscheme(path): return bool(url(path).scheme) def hasdriveletter(path): return path and path[1:2] == ':' and path[0:1].isalpha() def urllocalpath(path): return url(path, parsequery=False, parsefragment=False).localpath() def hidepassword(u): '''hide user credential in a url string''' u = url(u) if u.passwd: u.passwd = '***' return str(u) def removeauth(u): '''remove all authentication information from a url string''' u = url(u) u.user = u.passwd = None return str(u) def isatty(fp): try: return fp.isatty() except AttributeError: return False timecount = unitcountfn( (1, 1e3, _('%.0f s')), (100, 1, _('%.1f s')), (10, 1, _('%.2f s')), (1, 1, _('%.3f s')), (100, 0.001, _('%.1f ms')), (10, 0.001, _('%.2f ms')), (1, 0.001, _('%.3f ms')), (100, 0.000001, _('%.1f us')), (10, 0.000001, _('%.2f us')), (1, 0.000001, _('%.3f us')), (100, 0.000000001, _('%.1f ns')), (10, 0.000000001, _('%.2f ns')), (1, 0.000000001, _('%.3f ns')), ) _timenesting = [0] def timed(func): '''Report the execution time of a function call to stderr. During development, use as a decorator when you need to measure the cost of a function, e.g. as follows: @util.timed def foo(a, b, c): pass ''' def wrapper(*args, **kwargs): start = time.time() indent = 2 _timenesting[0] += indent try: return func(*args, **kwargs) finally: elapsed = time.time() - start _timenesting[0] -= indent stderr.write('%s%s: %s\n' % (' ' * _timenesting[0], func.__name__, timecount(elapsed))) return wrapper _sizeunits = (('m', 2**20), ('k', 2**10), ('g', 2**30), ('kb', 2**10), ('mb', 2**20), ('gb', 2**30), ('b', 1)) def sizetoint(s): '''Convert a space specifier to a byte count. >>> sizetoint('30') 30 >>> sizetoint('2.2kb') 2252 >>> sizetoint('6M') 6291456 ''' t = s.strip().lower() try: for k, u in _sizeunits: if t.endswith(k): return int(float(t[:-len(k)]) * u) return int(t) except ValueError: raise error.ParseError(_("couldn't parse size: %s") % s) class hooks(object): '''A collection of hook functions that can be used to extend a function's behavior. Hooks are called in lexicographic order, based on the names of their sources.''' def __init__(self): self._hooks = [] def add(self, source, hook): self._hooks.append((source, hook)) def __call__(self, *args): self._hooks.sort(key=lambda x: x[0]) results = [] for source, hook in self._hooks: results.append(hook(*args)) return results def getstackframes(skip=0, line=' %-*s in %s\n', fileline='%s:%s'): '''Yields lines for a nicely formatted stacktrace. Skips the 'skip' last entries. Each file+linenumber is formatted according to fileline. Each line is formatted according to line. If line is None, it yields: length of longest filepath+line number, filepath+linenumber, function Not be used in production code but very convenient while developing. ''' entries = [(fileline % (fn, ln), func) for fn, ln, func, _text in traceback.extract_stack()[:-skip - 1]] if entries: fnmax = max(len(entry[0]) for entry in entries) for fnln, func in entries: if line is None: yield (fnmax, fnln, func) else: yield line % (fnmax, fnln, func) def debugstacktrace(msg='stacktrace', skip=0, f=stderr, otherf=stdout): '''Writes a message to f (stderr) with a nicely formatted stacktrace. Skips the 'skip' last entries. By default it will flush stdout first. It can be used everywhere and intentionally does not require an ui object. Not be used in production code but very convenient while developing. ''' if otherf: otherf.flush() f.write('%s at:\n' % msg) for line in getstackframes(skip + 1): f.write(line) f.flush() class dirs(object): '''a multiset of directory names from a dirstate or manifest''' def __init__(self, map, skip=None): self._dirs = {} addpath = self.addpath if safehasattr(map, 'iteritems') and skip is not None: for f, s in map.iteritems(): if s[0] != skip: addpath(f) else: for f in map: addpath(f) def addpath(self, path): dirs = self._dirs for base in finddirs(path): if base in dirs: dirs[base] += 1 return dirs[base] = 1 def delpath(self, path): dirs = self._dirs for base in finddirs(path): if dirs[base] > 1: dirs[base] -= 1 return del dirs[base] def __iter__(self): return self._dirs.iterkeys() def __contains__(self, d): return d in self._dirs if safehasattr(parsers, 'dirs'): dirs = parsers.dirs def finddirs(path): pos = path.rfind('/') while pos != -1: yield path[:pos] pos = path.rfind('/', 0, pos) class ctxmanager(object): '''A context manager for use in 'with' blocks to allow multiple contexts to be entered at once. This is both safer and more flexible than contextlib.nested. Once Mercurial supports Python 2.7+, this will become mostly unnecessary. ''' def __init__(self, *args): '''Accepts a list of no-argument functions that return context managers. These will be invoked at __call__ time.''' self._pending = args self._atexit = [] def __enter__(self): return self def enter(self): '''Create and enter context managers in the order in which they were passed to the constructor.''' values = [] for func in self._pending: obj = func() values.append(obj.__enter__()) self._atexit.append(obj.__exit__) del self._pending return values def atexit(self, func, *args, **kwargs): '''Add a function to call when this context manager exits. The ordering of multiple atexit calls is unspecified, save that they will happen before any __exit__ functions.''' def wrapper(exc_type, exc_val, exc_tb): func(*args, **kwargs) self._atexit.append(wrapper) return func def __exit__(self, exc_type, exc_val, exc_tb): '''Context managers are exited in the reverse order from which they were created.''' received = exc_type is not None suppressed = False pending = None self._atexit.reverse() for exitfunc in self._atexit: try: if exitfunc(exc_type, exc_val, exc_tb): suppressed = True exc_type = None exc_val = None exc_tb = None except BaseException: pending = sys.exc_info() exc_type, exc_val, exc_tb = pending = sys.exc_info() del self._atexit if pending: raise exc_val return received and suppressed # compression code class compressormanager(object): """Holds registrations of various compression engines. This class essentially abstracts the differences between compression engines to allow new compression formats to be added easily, possibly from extensions. Compressors are registered against the global instance by calling its ``register()`` method. """ def __init__(self): self._engines = {} # Bundle spec human name to engine name. self._bundlenames = {} # Internal bundle identifier to engine name. self._bundletypes = {} def __getitem__(self, key): return self._engines[key] def __contains__(self, key): return key in self._engines def __iter__(self): return iter(self._engines.keys()) def register(self, engine): """Register a compression engine with the manager. The argument must be a ``compressionengine`` instance. """ if not isinstance(engine, compressionengine): raise ValueError(_('argument must be a compressionengine')) name = engine.name() if name in self._engines: raise error.Abort(_('compression engine %s already registered') % name) bundleinfo = engine.bundletype() if bundleinfo: bundlename, bundletype = bundleinfo if bundlename in self._bundlenames: raise error.Abort(_('bundle name %s already registered') % bundlename) if bundletype in self._bundletypes: raise error.Abort(_('bundle type %s already registered by %s') % (bundletype, self._bundletypes[bundletype])) # No external facing name declared. if bundlename: self._bundlenames[bundlename] = name self._bundletypes[bundletype] = name self._engines[name] = engine @property def supportedbundlenames(self): return set(self._bundlenames.keys()) @property def supportedbundletypes(self): return set(self._bundletypes.keys()) def forbundlename(self, bundlename): """Obtain a compression engine registered to a bundle name. Will raise KeyError if the bundle type isn't registered. Will abort if the engine is known but not available. """ engine = self._engines[self._bundlenames[bundlename]] if not engine.available(): raise error.Abort(_('compression engine %s could not be loaded') % engine.name()) return engine def forbundletype(self, bundletype): """Obtain a compression engine registered to a bundle type. Will raise KeyError if the bundle type isn't registered. Will abort if the engine is known but not available. """ engine = self._engines[self._bundletypes[bundletype]] if not engine.available(): raise error.Abort(_('compression engine %s could not be loaded') % engine.name()) return engine compengines = compressormanager() class compressionengine(object): """Base class for compression engines. Compression engines must implement the interface defined by this class. """ def name(self): """Returns the name of the compression engine. This is the key the engine is registered under. This method must be implemented. """ raise NotImplementedError() def available(self): """Whether the compression engine is available. The intent of this method is to allow optional compression engines that may not be available in all installations (such as engines relying on C extensions that may not be present). """ return True def bundletype(self): """Describes bundle identifiers for this engine. If this compression engine isn't supported for bundles, returns None. If this engine can be used for bundles, returns a 2-tuple of strings of the user-facing "bundle spec" compression name and an internal identifier used to denote the compression format within bundles. To exclude the name from external usage, set the first element to ``None``. If bundle compression is supported, the class must also implement ``compressstream`` and `decompressorreader``. """ return None def compressstream(self, it, opts=None): """Compress an iterator of chunks. The method receives an iterator (ideally a generator) of chunks of bytes to be compressed. It returns an iterator (ideally a generator) of bytes of chunks representing the compressed output. Optionally accepts an argument defining how to perform compression. Each engine treats this argument differently. """ raise NotImplementedError() def decompressorreader(self, fh): """Perform decompression on a file object. Argument is an object with a ``read(size)`` method that returns compressed data. Return value is an object with a ``read(size)`` that returns uncompressed data. """ raise NotImplementedError() class _zlibengine(compressionengine): def name(self): return 'zlib' def bundletype(self): return 'gzip', 'GZ' def compressstream(self, it, opts=None): opts = opts or {} z = zlib.compressobj(opts.get('level', -1)) for chunk in it: data = z.compress(chunk) # Not all calls to compress emit data. It is cheaper to inspect # here than to feed empty chunks through generator. if data: yield data yield z.flush() def decompressorreader(self, fh): def gen(): d = zlib.decompressobj() for chunk in filechunkiter(fh): yield d.decompress(chunk) return chunkbuffer(gen()) compengines.register(_zlibengine()) class _bz2engine(compressionengine): def name(self): return 'bz2' def bundletype(self): return 'bzip2', 'BZ' def compressstream(self, it, opts=None): opts = opts or {} z = bz2.BZ2Compressor(opts.get('level', 9)) for chunk in it: data = z.compress(chunk) if data: yield data yield z.flush() def decompressorreader(self, fh): def gen(): d = bz2.BZ2Decompressor() for chunk in filechunkiter(fh): yield d.decompress(chunk) return chunkbuffer(gen()) compengines.register(_bz2engine()) class _truncatedbz2engine(compressionengine): def name(self): return 'bz2truncated' def bundletype(self): return None, '_truncatedBZ' # We don't implement compressstream because it is hackily handled elsewhere. def decompressorreader(self, fh): def gen(): # The input stream doesn't have the 'BZ' header. So add it back. d = bz2.BZ2Decompressor() d.decompress('BZ') for chunk in filechunkiter(fh): yield d.decompress(chunk) return chunkbuffer(gen()) compengines.register(_truncatedbz2engine()) class _noopengine(compressionengine): def name(self): return 'none' def bundletype(self): return 'none', 'UN' def compressstream(self, it, opts=None): return it def decompressorreader(self, fh): return fh compengines.register(_noopengine()) class _zstdengine(compressionengine): def name(self): return 'zstd' @propertycache def _module(self): # Not all installs have the zstd module available. So defer importing # until first access. try: from . import zstd # Force delayed import. zstd.__version__ return zstd except ImportError: return None def available(self): return bool(self._module) def bundletype(self): return 'zstd', 'ZS' def compressstream(self, it, opts=None): opts = opts or {} # zstd level 3 is almost always significantly faster than zlib # while providing no worse compression. It strikes a good balance # between speed and compression. level = opts.get('level', 3) zstd = self._module z = zstd.ZstdCompressor(level=level).compressobj() for chunk in it: data = z.compress(chunk) if data: yield data yield z.flush() def decompressorreader(self, fh): zstd = self._module dctx = zstd.ZstdDecompressor() return chunkbuffer(dctx.read_from(fh)) compengines.register(_zstdengine()) # convenient shortcut dst = debugstacktrace