##// END OF EJS Templates
util: extract pure tolf/tocrlf() functions from eol extension...
Yuya Nishihara -
r31776:fe9b33bc default
parent child Browse files
Show More
@@ -1,393 +1,388
1 1 """automatically manage newlines in repository files
2 2
3 3 This extension allows you to manage the type of line endings (CRLF or
4 4 LF) that are used in the repository and in the local working
5 5 directory. That way you can get CRLF line endings on Windows and LF on
6 6 Unix/Mac, thereby letting everybody use their OS native line endings.
7 7
8 8 The extension reads its configuration from a versioned ``.hgeol``
9 9 configuration file found in the root of the working directory. The
10 10 ``.hgeol`` file use the same syntax as all other Mercurial
11 11 configuration files. It uses two sections, ``[patterns]`` and
12 12 ``[repository]``.
13 13
14 14 The ``[patterns]`` section specifies how line endings should be
15 15 converted between the working directory and the repository. The format is
16 16 specified by a file pattern. The first match is used, so put more
17 17 specific patterns first. The available line endings are ``LF``,
18 18 ``CRLF``, and ``BIN``.
19 19
20 20 Files with the declared format of ``CRLF`` or ``LF`` are always
21 21 checked out and stored in the repository in that format and files
22 22 declared to be binary (``BIN``) are left unchanged. Additionally,
23 23 ``native`` is an alias for checking out in the platform's default line
24 24 ending: ``LF`` on Unix (including Mac OS X) and ``CRLF`` on
25 25 Windows. Note that ``BIN`` (do nothing to line endings) is Mercurial's
26 26 default behavior; it is only needed if you need to override a later,
27 27 more general pattern.
28 28
29 29 The optional ``[repository]`` section specifies the line endings to
30 30 use for files stored in the repository. It has a single setting,
31 31 ``native``, which determines the storage line endings for files
32 32 declared as ``native`` in the ``[patterns]`` section. It can be set to
33 33 ``LF`` or ``CRLF``. The default is ``LF``. For example, this means
34 34 that on Windows, files configured as ``native`` (``CRLF`` by default)
35 35 will be converted to ``LF`` when stored in the repository. Files
36 36 declared as ``LF``, ``CRLF``, or ``BIN`` in the ``[patterns]`` section
37 37 are always stored as-is in the repository.
38 38
39 39 Example versioned ``.hgeol`` file::
40 40
41 41 [patterns]
42 42 **.py = native
43 43 **.vcproj = CRLF
44 44 **.txt = native
45 45 Makefile = LF
46 46 **.jpg = BIN
47 47
48 48 [repository]
49 49 native = LF
50 50
51 51 .. note::
52 52
53 53 The rules will first apply when files are touched in the working
54 54 directory, e.g. by updating to null and back to tip to touch all files.
55 55
56 56 The extension uses an optional ``[eol]`` section read from both the
57 57 normal Mercurial configuration files and the ``.hgeol`` file, with the
58 58 latter overriding the former. You can use that section to control the
59 59 overall behavior. There are three settings:
60 60
61 61 - ``eol.native`` (default ``os.linesep``) can be set to ``LF`` or
62 62 ``CRLF`` to override the default interpretation of ``native`` for
63 63 checkout. This can be used with :hg:`archive` on Unix, say, to
64 64 generate an archive where files have line endings for Windows.
65 65
66 66 - ``eol.only-consistent`` (default True) can be set to False to make
67 67 the extension convert files with inconsistent EOLs. Inconsistent
68 68 means that there is both ``CRLF`` and ``LF`` present in the file.
69 69 Such files are normally not touched under the assumption that they
70 70 have mixed EOLs on purpose.
71 71
72 72 - ``eol.fix-trailing-newline`` (default False) can be set to True to
73 73 ensure that converted files end with a EOL character (either ``\\n``
74 74 or ``\\r\\n`` as per the configured patterns).
75 75
76 76 The extension provides ``cleverencode:`` and ``cleverdecode:`` filters
77 77 like the deprecated win32text extension does. This means that you can
78 78 disable win32text and enable eol and your filters will still work. You
79 79 only need to these filters until you have prepared a ``.hgeol`` file.
80 80
81 81 The ``win32text.forbid*`` hooks provided by the win32text extension
82 82 have been unified into a single hook named ``eol.checkheadshook``. The
83 83 hook will lookup the expected line endings from the ``.hgeol`` file,
84 84 which means you must migrate to a ``.hgeol`` file first before using
85 85 the hook. ``eol.checkheadshook`` only checks heads, intermediate
86 86 invalid revisions will be pushed. To forbid them completely, use the
87 87 ``eol.checkallhook`` hook. These hooks are best used as
88 88 ``pretxnchangegroup`` hooks.
89 89
90 90 See :hg:`help patterns` for more information about the glob patterns
91 91 used.
92 92 """
93 93
94 94 from __future__ import absolute_import
95 95
96 96 import os
97 97 import re
98 98 from mercurial.i18n import _
99 99 from mercurial import (
100 100 config,
101 101 error,
102 102 extensions,
103 103 match,
104 104 pycompat,
105 105 util,
106 106 )
107 107
108 108 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
109 109 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
110 110 # be specifying the version(s) of Mercurial they are tested with, or
111 111 # leave the attribute unspecified.
112 112 testedwith = 'ships-with-hg-core'
113 113
114 114 # Matches a lone LF, i.e., one that is not part of CRLF.
115 115 singlelf = re.compile('(^|[^\r])\n')
116 # Matches a single EOL which can either be a CRLF where repeated CR
117 # are removed or a LF. We do not care about old Macintosh files, so a
118 # stray CR is an error.
119 eolre = re.compile('\r*\n')
120
121 116
122 117 def inconsistenteol(data):
123 118 return '\r\n' in data and singlelf.search(data)
124 119
125 120 def tolf(s, params, ui, **kwargs):
126 121 """Filter to convert to LF EOLs."""
127 122 if util.binary(s):
128 123 return s
129 124 if ui.configbool('eol', 'only-consistent', True) and inconsistenteol(s):
130 125 return s
131 126 if (ui.configbool('eol', 'fix-trailing-newline', False)
132 127 and s and s[-1] != '\n'):
133 128 s = s + '\n'
134 return eolre.sub('\n', s)
129 return util.tolf(s)
135 130
136 131 def tocrlf(s, params, ui, **kwargs):
137 132 """Filter to convert to CRLF EOLs."""
138 133 if util.binary(s):
139 134 return s
140 135 if ui.configbool('eol', 'only-consistent', True) and inconsistenteol(s):
141 136 return s
142 137 if (ui.configbool('eol', 'fix-trailing-newline', False)
143 138 and s and s[-1] != '\n'):
144 139 s = s + '\n'
145 return eolre.sub('\r\n', s)
140 return util.tocrlf(s)
146 141
147 142 def isbinary(s, params):
148 143 """Filter to do nothing with the file."""
149 144 return s
150 145
151 146 filters = {
152 147 'to-lf': tolf,
153 148 'to-crlf': tocrlf,
154 149 'is-binary': isbinary,
155 150 # The following provide backwards compatibility with win32text
156 151 'cleverencode:': tolf,
157 152 'cleverdecode:': tocrlf
158 153 }
159 154
160 155 class eolfile(object):
161 156 def __init__(self, ui, root, data):
162 157 self._decode = {'LF': 'to-lf', 'CRLF': 'to-crlf', 'BIN': 'is-binary'}
163 158 self._encode = {'LF': 'to-lf', 'CRLF': 'to-crlf', 'BIN': 'is-binary'}
164 159
165 160 self.cfg = config.config()
166 161 # Our files should not be touched. The pattern must be
167 162 # inserted first override a '** = native' pattern.
168 163 self.cfg.set('patterns', '.hg*', 'BIN', 'eol')
169 164 # We can then parse the user's patterns.
170 165 self.cfg.parse('.hgeol', data)
171 166
172 167 isrepolf = self.cfg.get('repository', 'native') != 'CRLF'
173 168 self._encode['NATIVE'] = isrepolf and 'to-lf' or 'to-crlf'
174 169 iswdlf = ui.config('eol', 'native', pycompat.oslinesep) in ('LF', '\n')
175 170 self._decode['NATIVE'] = iswdlf and 'to-lf' or 'to-crlf'
176 171
177 172 include = []
178 173 exclude = []
179 174 self.patterns = []
180 175 for pattern, style in self.cfg.items('patterns'):
181 176 key = style.upper()
182 177 if key == 'BIN':
183 178 exclude.append(pattern)
184 179 else:
185 180 include.append(pattern)
186 181 m = match.match(root, '', [pattern])
187 182 self.patterns.append((pattern, key, m))
188 183 # This will match the files for which we need to care
189 184 # about inconsistent newlines.
190 185 self.match = match.match(root, '', [], include, exclude)
191 186
192 187 def copytoui(self, ui):
193 188 for pattern, key, m in self.patterns:
194 189 try:
195 190 ui.setconfig('decode', pattern, self._decode[key], 'eol')
196 191 ui.setconfig('encode', pattern, self._encode[key], 'eol')
197 192 except KeyError:
198 193 ui.warn(_("ignoring unknown EOL style '%s' from %s\n")
199 194 % (key, self.cfg.source('patterns', pattern)))
200 195 # eol.only-consistent can be specified in ~/.hgrc or .hgeol
201 196 for k, v in self.cfg.items('eol'):
202 197 ui.setconfig('eol', k, v, 'eol')
203 198
204 199 def checkrev(self, repo, ctx, files):
205 200 failed = []
206 201 for f in (files or ctx.files()):
207 202 if f not in ctx:
208 203 continue
209 204 for pattern, key, m in self.patterns:
210 205 if not m(f):
211 206 continue
212 207 target = self._encode[key]
213 208 data = ctx[f].data()
214 209 if (target == "to-lf" and "\r\n" in data
215 210 or target == "to-crlf" and singlelf.search(data)):
216 211 failed.append((f, target, str(ctx)))
217 212 break
218 213 return failed
219 214
220 215 def parseeol(ui, repo, nodes):
221 216 try:
222 217 for node in nodes:
223 218 try:
224 219 if node is None:
225 220 # Cannot use workingctx.data() since it would load
226 221 # and cache the filters before we configure them.
227 222 data = repo.wvfs('.hgeol').read()
228 223 else:
229 224 data = repo[node]['.hgeol'].data()
230 225 return eolfile(ui, repo.root, data)
231 226 except (IOError, LookupError):
232 227 pass
233 228 except error.ParseError as inst:
234 229 ui.warn(_("warning: ignoring .hgeol file due to parse error "
235 230 "at %s: %s\n") % (inst.args[1], inst.args[0]))
236 231 return None
237 232
238 233 def _checkhook(ui, repo, node, headsonly):
239 234 # Get revisions to check and touched files at the same time
240 235 files = set()
241 236 revs = set()
242 237 for rev in xrange(repo[node].rev(), len(repo)):
243 238 revs.add(rev)
244 239 if headsonly:
245 240 ctx = repo[rev]
246 241 files.update(ctx.files())
247 242 for pctx in ctx.parents():
248 243 revs.discard(pctx.rev())
249 244 failed = []
250 245 for rev in revs:
251 246 ctx = repo[rev]
252 247 eol = parseeol(ui, repo, [ctx.node()])
253 248 if eol:
254 249 failed.extend(eol.checkrev(repo, ctx, files))
255 250
256 251 if failed:
257 252 eols = {'to-lf': 'CRLF', 'to-crlf': 'LF'}
258 253 msgs = []
259 254 for f, target, node in sorted(failed):
260 255 msgs.append(_(" %s in %s should not have %s line endings") %
261 256 (f, node, eols[target]))
262 257 raise error.Abort(_("end-of-line check failed:\n") + "\n".join(msgs))
263 258
264 259 def checkallhook(ui, repo, node, hooktype, **kwargs):
265 260 """verify that files have expected EOLs"""
266 261 _checkhook(ui, repo, node, False)
267 262
268 263 def checkheadshook(ui, repo, node, hooktype, **kwargs):
269 264 """verify that files have expected EOLs"""
270 265 _checkhook(ui, repo, node, True)
271 266
272 267 # "checkheadshook" used to be called "hook"
273 268 hook = checkheadshook
274 269
275 270 def preupdate(ui, repo, hooktype, parent1, parent2):
276 271 repo.loadeol([parent1])
277 272 return False
278 273
279 274 def uisetup(ui):
280 275 ui.setconfig('hooks', 'preupdate.eol', preupdate, 'eol')
281 276
282 277 def extsetup(ui):
283 278 try:
284 279 extensions.find('win32text')
285 280 ui.warn(_("the eol extension is incompatible with the "
286 281 "win32text extension\n"))
287 282 except KeyError:
288 283 pass
289 284
290 285
291 286 def reposetup(ui, repo):
292 287 uisetup(repo.ui)
293 288
294 289 if not repo.local():
295 290 return
296 291 for name, fn in filters.iteritems():
297 292 repo.adddatafilter(name, fn)
298 293
299 294 ui.setconfig('patch', 'eol', 'auto', 'eol')
300 295
301 296 class eolrepo(repo.__class__):
302 297
303 298 def loadeol(self, nodes):
304 299 eol = parseeol(self.ui, self, nodes)
305 300 if eol is None:
306 301 return None
307 302 eol.copytoui(self.ui)
308 303 return eol.match
309 304
310 305 def _hgcleardirstate(self):
311 306 self._eolmatch = self.loadeol([None, 'tip'])
312 307 if not self._eolmatch:
313 308 self._eolmatch = util.never
314 309 return
315 310
316 311 oldeol = None
317 312 try:
318 313 cachemtime = os.path.getmtime(self.vfs.join("eol.cache"))
319 314 except OSError:
320 315 cachemtime = 0
321 316 else:
322 317 olddata = self.vfs.read("eol.cache")
323 318 if olddata:
324 319 oldeol = eolfile(self.ui, self.root, olddata)
325 320
326 321 try:
327 322 eolmtime = os.path.getmtime(self.wjoin(".hgeol"))
328 323 except OSError:
329 324 eolmtime = 0
330 325
331 326 if eolmtime > cachemtime:
332 327 self.ui.debug("eol: detected change in .hgeol\n")
333 328
334 329 hgeoldata = self.wvfs.read('.hgeol')
335 330 neweol = eolfile(self.ui, self.root, hgeoldata)
336 331
337 332 wlock = None
338 333 try:
339 334 wlock = self.wlock()
340 335 for f in self.dirstate:
341 336 if self.dirstate[f] != 'n':
342 337 continue
343 338 if oldeol is not None:
344 339 if not oldeol.match(f) and not neweol.match(f):
345 340 continue
346 341 oldkey = None
347 342 for pattern, key, m in oldeol.patterns:
348 343 if m(f):
349 344 oldkey = key
350 345 break
351 346 newkey = None
352 347 for pattern, key, m in neweol.patterns:
353 348 if m(f):
354 349 newkey = key
355 350 break
356 351 if oldkey == newkey:
357 352 continue
358 353 # all normal files need to be looked at again since
359 354 # the new .hgeol file specify a different filter
360 355 self.dirstate.normallookup(f)
361 356 # Write the cache to update mtime and cache .hgeol
362 357 with self.vfs("eol.cache", "w") as f:
363 358 f.write(hgeoldata)
364 359 except error.LockUnavailable:
365 360 # If we cannot lock the repository and clear the
366 361 # dirstate, then a commit might not see all files
367 362 # as modified. But if we cannot lock the
368 363 # repository, then we can also not make a commit,
369 364 # so ignore the error.
370 365 pass
371 366 finally:
372 367 if wlock is not None:
373 368 wlock.release()
374 369
375 370 def commitctx(self, ctx, haserror=False):
376 371 for f in sorted(ctx.added() + ctx.modified()):
377 372 if not self._eolmatch(f):
378 373 continue
379 374 fctx = ctx[f]
380 375 if fctx is None:
381 376 continue
382 377 data = fctx.data()
383 378 if util.binary(data):
384 379 # We should not abort here, since the user should
385 380 # be able to say "** = native" to automatically
386 381 # have all non-binary files taken care of.
387 382 continue
388 383 if inconsistenteol(data):
389 384 raise error.Abort(_("inconsistent newline style "
390 385 "in %s\n") % f)
391 386 return super(eolrepo, self).commitctx(ctx, haserror)
392 387 repo.__class__ = eolrepo
393 388 repo._hgcleardirstate()
@@ -1,3636 +1,3647
1 1 # util.py - Mercurial utility functions and platform specific implementations
2 2 #
3 3 # Copyright 2005 K. Thananchayan <thananck@yahoo.com>
4 4 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
5 5 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
6 6 #
7 7 # This software may be used and distributed according to the terms of the
8 8 # GNU General Public License version 2 or any later version.
9 9
10 10 """Mercurial utility functions and platform specific implementations.
11 11
12 12 This contains helper routines that are independent of the SCM core and
13 13 hide platform-specific details from the core.
14 14 """
15 15
16 16 from __future__ import absolute_import
17 17
18 18 import bz2
19 19 import calendar
20 20 import codecs
21 21 import collections
22 22 import datetime
23 23 import errno
24 24 import gc
25 25 import hashlib
26 26 import imp
27 27 import os
28 28 import platform as pyplatform
29 29 import re as remod
30 30 import shutil
31 31 import signal
32 32 import socket
33 33 import stat
34 34 import string
35 35 import subprocess
36 36 import sys
37 37 import tempfile
38 38 import textwrap
39 39 import time
40 40 import traceback
41 41 import zlib
42 42
43 43 from . import (
44 44 encoding,
45 45 error,
46 46 i18n,
47 47 osutil,
48 48 parsers,
49 49 pycompat,
50 50 )
51 51
52 52 empty = pycompat.empty
53 53 httplib = pycompat.httplib
54 54 httpserver = pycompat.httpserver
55 55 pickle = pycompat.pickle
56 56 queue = pycompat.queue
57 57 socketserver = pycompat.socketserver
58 58 stderr = pycompat.stderr
59 59 stdin = pycompat.stdin
60 60 stdout = pycompat.stdout
61 61 stringio = pycompat.stringio
62 62 urlerr = pycompat.urlerr
63 63 urlreq = pycompat.urlreq
64 64 xmlrpclib = pycompat.xmlrpclib
65 65
66 66 def isatty(fp):
67 67 try:
68 68 return fp.isatty()
69 69 except AttributeError:
70 70 return False
71 71
72 72 # glibc determines buffering on first write to stdout - if we replace a TTY
73 73 # destined stdout with a pipe destined stdout (e.g. pager), we want line
74 74 # buffering
75 75 if isatty(stdout):
76 76 stdout = os.fdopen(stdout.fileno(), pycompat.sysstr('wb'), 1)
77 77
78 78 if pycompat.osname == 'nt':
79 79 from . import windows as platform
80 80 stdout = platform.winstdout(stdout)
81 81 else:
82 82 from . import posix as platform
83 83
84 84 _ = i18n._
85 85
86 86 bindunixsocket = platform.bindunixsocket
87 87 cachestat = platform.cachestat
88 88 checkexec = platform.checkexec
89 89 checklink = platform.checklink
90 90 copymode = platform.copymode
91 91 executablepath = platform.executablepath
92 92 expandglobs = platform.expandglobs
93 93 explainexit = platform.explainexit
94 94 findexe = platform.findexe
95 95 gethgcmd = platform.gethgcmd
96 96 getuser = platform.getuser
97 97 getpid = os.getpid
98 98 groupmembers = platform.groupmembers
99 99 groupname = platform.groupname
100 100 hidewindow = platform.hidewindow
101 101 isexec = platform.isexec
102 102 isowner = platform.isowner
103 103 localpath = platform.localpath
104 104 lookupreg = platform.lookupreg
105 105 makedir = platform.makedir
106 106 nlinks = platform.nlinks
107 107 normpath = platform.normpath
108 108 normcase = platform.normcase
109 109 normcasespec = platform.normcasespec
110 110 normcasefallback = platform.normcasefallback
111 111 openhardlinks = platform.openhardlinks
112 112 oslink = platform.oslink
113 113 parsepatchoutput = platform.parsepatchoutput
114 114 pconvert = platform.pconvert
115 115 poll = platform.poll
116 116 popen = platform.popen
117 117 posixfile = platform.posixfile
118 118 quotecommand = platform.quotecommand
119 119 readpipe = platform.readpipe
120 120 rename = platform.rename
121 121 removedirs = platform.removedirs
122 122 samedevice = platform.samedevice
123 123 samefile = platform.samefile
124 124 samestat = platform.samestat
125 125 setbinary = platform.setbinary
126 126 setflags = platform.setflags
127 127 setsignalhandler = platform.setsignalhandler
128 128 shellquote = platform.shellquote
129 129 spawndetached = platform.spawndetached
130 130 split = platform.split
131 131 sshargs = platform.sshargs
132 132 statfiles = getattr(osutil, 'statfiles', platform.statfiles)
133 133 statisexec = platform.statisexec
134 134 statislink = platform.statislink
135 135 testpid = platform.testpid
136 136 umask = platform.umask
137 137 unlink = platform.unlink
138 138 username = platform.username
139 139
140 140 # Python compatibility
141 141
142 142 _notset = object()
143 143
144 144 # disable Python's problematic floating point timestamps (issue4836)
145 145 # (Python hypocritically says you shouldn't change this behavior in
146 146 # libraries, and sure enough Mercurial is not a library.)
147 147 os.stat_float_times(False)
148 148
149 149 def safehasattr(thing, attr):
150 150 return getattr(thing, attr, _notset) is not _notset
151 151
152 152 def bitsfrom(container):
153 153 bits = 0
154 154 for bit in container:
155 155 bits |= bit
156 156 return bits
157 157
158 158 DIGESTS = {
159 159 'md5': hashlib.md5,
160 160 'sha1': hashlib.sha1,
161 161 'sha512': hashlib.sha512,
162 162 }
163 163 # List of digest types from strongest to weakest
164 164 DIGESTS_BY_STRENGTH = ['sha512', 'sha1', 'md5']
165 165
166 166 for k in DIGESTS_BY_STRENGTH:
167 167 assert k in DIGESTS
168 168
169 169 class digester(object):
170 170 """helper to compute digests.
171 171
172 172 This helper can be used to compute one or more digests given their name.
173 173
174 174 >>> d = digester(['md5', 'sha1'])
175 175 >>> d.update('foo')
176 176 >>> [k for k in sorted(d)]
177 177 ['md5', 'sha1']
178 178 >>> d['md5']
179 179 'acbd18db4cc2f85cedef654fccc4a4d8'
180 180 >>> d['sha1']
181 181 '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33'
182 182 >>> digester.preferred(['md5', 'sha1'])
183 183 'sha1'
184 184 """
185 185
186 186 def __init__(self, digests, s=''):
187 187 self._hashes = {}
188 188 for k in digests:
189 189 if k not in DIGESTS:
190 190 raise Abort(_('unknown digest type: %s') % k)
191 191 self._hashes[k] = DIGESTS[k]()
192 192 if s:
193 193 self.update(s)
194 194
195 195 def update(self, data):
196 196 for h in self._hashes.values():
197 197 h.update(data)
198 198
199 199 def __getitem__(self, key):
200 200 if key not in DIGESTS:
201 201 raise Abort(_('unknown digest type: %s') % k)
202 202 return self._hashes[key].hexdigest()
203 203
204 204 def __iter__(self):
205 205 return iter(self._hashes)
206 206
207 207 @staticmethod
208 208 def preferred(supported):
209 209 """returns the strongest digest type in both supported and DIGESTS."""
210 210
211 211 for k in DIGESTS_BY_STRENGTH:
212 212 if k in supported:
213 213 return k
214 214 return None
215 215
216 216 class digestchecker(object):
217 217 """file handle wrapper that additionally checks content against a given
218 218 size and digests.
219 219
220 220 d = digestchecker(fh, size, {'md5': '...'})
221 221
222 222 When multiple digests are given, all of them are validated.
223 223 """
224 224
225 225 def __init__(self, fh, size, digests):
226 226 self._fh = fh
227 227 self._size = size
228 228 self._got = 0
229 229 self._digests = dict(digests)
230 230 self._digester = digester(self._digests.keys())
231 231
232 232 def read(self, length=-1):
233 233 content = self._fh.read(length)
234 234 self._digester.update(content)
235 235 self._got += len(content)
236 236 return content
237 237
238 238 def validate(self):
239 239 if self._size != self._got:
240 240 raise Abort(_('size mismatch: expected %d, got %d') %
241 241 (self._size, self._got))
242 242 for k, v in self._digests.items():
243 243 if v != self._digester[k]:
244 244 # i18n: first parameter is a digest name
245 245 raise Abort(_('%s mismatch: expected %s, got %s') %
246 246 (k, v, self._digester[k]))
247 247
248 248 try:
249 249 buffer = buffer
250 250 except NameError:
251 251 if not pycompat.ispy3:
252 252 def buffer(sliceable, offset=0, length=None):
253 253 if length is not None:
254 254 return sliceable[offset:offset + length]
255 255 return sliceable[offset:]
256 256 else:
257 257 def buffer(sliceable, offset=0, length=None):
258 258 if length is not None:
259 259 return memoryview(sliceable)[offset:offset + length]
260 260 return memoryview(sliceable)[offset:]
261 261
262 262 closefds = pycompat.osname == 'posix'
263 263
264 264 _chunksize = 4096
265 265
266 266 class bufferedinputpipe(object):
267 267 """a manually buffered input pipe
268 268
269 269 Python will not let us use buffered IO and lazy reading with 'polling' at
270 270 the same time. We cannot probe the buffer state and select will not detect
271 271 that data are ready to read if they are already buffered.
272 272
273 273 This class let us work around that by implementing its own buffering
274 274 (allowing efficient readline) while offering a way to know if the buffer is
275 275 empty from the output (allowing collaboration of the buffer with polling).
276 276
277 277 This class lives in the 'util' module because it makes use of the 'os'
278 278 module from the python stdlib.
279 279 """
280 280
281 281 def __init__(self, input):
282 282 self._input = input
283 283 self._buffer = []
284 284 self._eof = False
285 285 self._lenbuf = 0
286 286
287 287 @property
288 288 def hasbuffer(self):
289 289 """True is any data is currently buffered
290 290
291 291 This will be used externally a pre-step for polling IO. If there is
292 292 already data then no polling should be set in place."""
293 293 return bool(self._buffer)
294 294
295 295 @property
296 296 def closed(self):
297 297 return self._input.closed
298 298
299 299 def fileno(self):
300 300 return self._input.fileno()
301 301
302 302 def close(self):
303 303 return self._input.close()
304 304
305 305 def read(self, size):
306 306 while (not self._eof) and (self._lenbuf < size):
307 307 self._fillbuffer()
308 308 return self._frombuffer(size)
309 309
310 310 def readline(self, *args, **kwargs):
311 311 if 1 < len(self._buffer):
312 312 # this should not happen because both read and readline end with a
313 313 # _frombuffer call that collapse it.
314 314 self._buffer = [''.join(self._buffer)]
315 315 self._lenbuf = len(self._buffer[0])
316 316 lfi = -1
317 317 if self._buffer:
318 318 lfi = self._buffer[-1].find('\n')
319 319 while (not self._eof) and lfi < 0:
320 320 self._fillbuffer()
321 321 if self._buffer:
322 322 lfi = self._buffer[-1].find('\n')
323 323 size = lfi + 1
324 324 if lfi < 0: # end of file
325 325 size = self._lenbuf
326 326 elif 1 < len(self._buffer):
327 327 # we need to take previous chunks into account
328 328 size += self._lenbuf - len(self._buffer[-1])
329 329 return self._frombuffer(size)
330 330
331 331 def _frombuffer(self, size):
332 332 """return at most 'size' data from the buffer
333 333
334 334 The data are removed from the buffer."""
335 335 if size == 0 or not self._buffer:
336 336 return ''
337 337 buf = self._buffer[0]
338 338 if 1 < len(self._buffer):
339 339 buf = ''.join(self._buffer)
340 340
341 341 data = buf[:size]
342 342 buf = buf[len(data):]
343 343 if buf:
344 344 self._buffer = [buf]
345 345 self._lenbuf = len(buf)
346 346 else:
347 347 self._buffer = []
348 348 self._lenbuf = 0
349 349 return data
350 350
351 351 def _fillbuffer(self):
352 352 """read data to the buffer"""
353 353 data = os.read(self._input.fileno(), _chunksize)
354 354 if not data:
355 355 self._eof = True
356 356 else:
357 357 self._lenbuf += len(data)
358 358 self._buffer.append(data)
359 359
360 360 def popen2(cmd, env=None, newlines=False):
361 361 # Setting bufsize to -1 lets the system decide the buffer size.
362 362 # The default for bufsize is 0, meaning unbuffered. This leads to
363 363 # poor performance on Mac OS X: http://bugs.python.org/issue4194
364 364 p = subprocess.Popen(cmd, shell=True, bufsize=-1,
365 365 close_fds=closefds,
366 366 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
367 367 universal_newlines=newlines,
368 368 env=env)
369 369 return p.stdin, p.stdout
370 370
371 371 def popen3(cmd, env=None, newlines=False):
372 372 stdin, stdout, stderr, p = popen4(cmd, env, newlines)
373 373 return stdin, stdout, stderr
374 374
375 375 def popen4(cmd, env=None, newlines=False, bufsize=-1):
376 376 p = subprocess.Popen(cmd, shell=True, bufsize=bufsize,
377 377 close_fds=closefds,
378 378 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
379 379 stderr=subprocess.PIPE,
380 380 universal_newlines=newlines,
381 381 env=env)
382 382 return p.stdin, p.stdout, p.stderr, p
383 383
384 384 def version():
385 385 """Return version information if available."""
386 386 try:
387 387 from . import __version__
388 388 return __version__.version
389 389 except ImportError:
390 390 return 'unknown'
391 391
392 392 def versiontuple(v=None, n=4):
393 393 """Parses a Mercurial version string into an N-tuple.
394 394
395 395 The version string to be parsed is specified with the ``v`` argument.
396 396 If it isn't defined, the current Mercurial version string will be parsed.
397 397
398 398 ``n`` can be 2, 3, or 4. Here is how some version strings map to
399 399 returned values:
400 400
401 401 >>> v = '3.6.1+190-df9b73d2d444'
402 402 >>> versiontuple(v, 2)
403 403 (3, 6)
404 404 >>> versiontuple(v, 3)
405 405 (3, 6, 1)
406 406 >>> versiontuple(v, 4)
407 407 (3, 6, 1, '190-df9b73d2d444')
408 408
409 409 >>> versiontuple('3.6.1+190-df9b73d2d444+20151118')
410 410 (3, 6, 1, '190-df9b73d2d444+20151118')
411 411
412 412 >>> v = '3.6'
413 413 >>> versiontuple(v, 2)
414 414 (3, 6)
415 415 >>> versiontuple(v, 3)
416 416 (3, 6, None)
417 417 >>> versiontuple(v, 4)
418 418 (3, 6, None, None)
419 419
420 420 >>> v = '3.9-rc'
421 421 >>> versiontuple(v, 2)
422 422 (3, 9)
423 423 >>> versiontuple(v, 3)
424 424 (3, 9, None)
425 425 >>> versiontuple(v, 4)
426 426 (3, 9, None, 'rc')
427 427
428 428 >>> v = '3.9-rc+2-02a8fea4289b'
429 429 >>> versiontuple(v, 2)
430 430 (3, 9)
431 431 >>> versiontuple(v, 3)
432 432 (3, 9, None)
433 433 >>> versiontuple(v, 4)
434 434 (3, 9, None, 'rc+2-02a8fea4289b')
435 435 """
436 436 if not v:
437 437 v = version()
438 438 parts = remod.split('[\+-]', v, 1)
439 439 if len(parts) == 1:
440 440 vparts, extra = parts[0], None
441 441 else:
442 442 vparts, extra = parts
443 443
444 444 vints = []
445 445 for i in vparts.split('.'):
446 446 try:
447 447 vints.append(int(i))
448 448 except ValueError:
449 449 break
450 450 # (3, 6) -> (3, 6, None)
451 451 while len(vints) < 3:
452 452 vints.append(None)
453 453
454 454 if n == 2:
455 455 return (vints[0], vints[1])
456 456 if n == 3:
457 457 return (vints[0], vints[1], vints[2])
458 458 if n == 4:
459 459 return (vints[0], vints[1], vints[2], extra)
460 460
461 461 # used by parsedate
462 462 defaultdateformats = (
463 463 '%Y-%m-%dT%H:%M:%S', # the 'real' ISO8601
464 464 '%Y-%m-%dT%H:%M', # without seconds
465 465 '%Y-%m-%dT%H%M%S', # another awful but legal variant without :
466 466 '%Y-%m-%dT%H%M', # without seconds
467 467 '%Y-%m-%d %H:%M:%S', # our common legal variant
468 468 '%Y-%m-%d %H:%M', # without seconds
469 469 '%Y-%m-%d %H%M%S', # without :
470 470 '%Y-%m-%d %H%M', # without seconds
471 471 '%Y-%m-%d %I:%M:%S%p',
472 472 '%Y-%m-%d %H:%M',
473 473 '%Y-%m-%d %I:%M%p',
474 474 '%Y-%m-%d',
475 475 '%m-%d',
476 476 '%m/%d',
477 477 '%m/%d/%y',
478 478 '%m/%d/%Y',
479 479 '%a %b %d %H:%M:%S %Y',
480 480 '%a %b %d %I:%M:%S%p %Y',
481 481 '%a, %d %b %Y %H:%M:%S', # GNU coreutils "/bin/date --rfc-2822"
482 482 '%b %d %H:%M:%S %Y',
483 483 '%b %d %I:%M:%S%p %Y',
484 484 '%b %d %H:%M:%S',
485 485 '%b %d %I:%M:%S%p',
486 486 '%b %d %H:%M',
487 487 '%b %d %I:%M%p',
488 488 '%b %d %Y',
489 489 '%b %d',
490 490 '%H:%M:%S',
491 491 '%I:%M:%S%p',
492 492 '%H:%M',
493 493 '%I:%M%p',
494 494 )
495 495
496 496 extendeddateformats = defaultdateformats + (
497 497 "%Y",
498 498 "%Y-%m",
499 499 "%b",
500 500 "%b %Y",
501 501 )
502 502
503 503 def cachefunc(func):
504 504 '''cache the result of function calls'''
505 505 # XXX doesn't handle keywords args
506 506 if func.__code__.co_argcount == 0:
507 507 cache = []
508 508 def f():
509 509 if len(cache) == 0:
510 510 cache.append(func())
511 511 return cache[0]
512 512 return f
513 513 cache = {}
514 514 if func.__code__.co_argcount == 1:
515 515 # we gain a small amount of time because
516 516 # we don't need to pack/unpack the list
517 517 def f(arg):
518 518 if arg not in cache:
519 519 cache[arg] = func(arg)
520 520 return cache[arg]
521 521 else:
522 522 def f(*args):
523 523 if args not in cache:
524 524 cache[args] = func(*args)
525 525 return cache[args]
526 526
527 527 return f
528 528
529 529 class sortdict(dict):
530 530 '''a simple sorted dictionary'''
531 531 def __init__(self, data=None):
532 532 self._list = []
533 533 if data:
534 534 self.update(data)
535 535 def copy(self):
536 536 return sortdict(self)
537 537 def __setitem__(self, key, val):
538 538 if key in self:
539 539 self._list.remove(key)
540 540 self._list.append(key)
541 541 dict.__setitem__(self, key, val)
542 542 def __iter__(self):
543 543 return self._list.__iter__()
544 544 def update(self, src):
545 545 if isinstance(src, dict):
546 546 src = src.iteritems()
547 547 for k, v in src:
548 548 self[k] = v
549 549 def clear(self):
550 550 dict.clear(self)
551 551 self._list = []
552 552 def items(self):
553 553 return [(k, self[k]) for k in self._list]
554 554 def __delitem__(self, key):
555 555 dict.__delitem__(self, key)
556 556 self._list.remove(key)
557 557 def pop(self, key, *args, **kwargs):
558 558 dict.pop(self, key, *args, **kwargs)
559 559 try:
560 560 self._list.remove(key)
561 561 except ValueError:
562 562 pass
563 563 def keys(self):
564 564 return self._list[:]
565 565 def iterkeys(self):
566 566 return self._list.__iter__()
567 567 def iteritems(self):
568 568 for k in self._list:
569 569 yield k, self[k]
570 570 def insert(self, index, key, val):
571 571 self._list.insert(index, key)
572 572 dict.__setitem__(self, key, val)
573 573 def __repr__(self):
574 574 if not self:
575 575 return '%s()' % self.__class__.__name__
576 576 return '%s(%r)' % (self.__class__.__name__, self.items())
577 577
578 578 class _lrucachenode(object):
579 579 """A node in a doubly linked list.
580 580
581 581 Holds a reference to nodes on either side as well as a key-value
582 582 pair for the dictionary entry.
583 583 """
584 584 __slots__ = (u'next', u'prev', u'key', u'value')
585 585
586 586 def __init__(self):
587 587 self.next = None
588 588 self.prev = None
589 589
590 590 self.key = _notset
591 591 self.value = None
592 592
593 593 def markempty(self):
594 594 """Mark the node as emptied."""
595 595 self.key = _notset
596 596
597 597 class lrucachedict(object):
598 598 """Dict that caches most recent accesses and sets.
599 599
600 600 The dict consists of an actual backing dict - indexed by original
601 601 key - and a doubly linked circular list defining the order of entries in
602 602 the cache.
603 603
604 604 The head node is the newest entry in the cache. If the cache is full,
605 605 we recycle head.prev and make it the new head. Cache accesses result in
606 606 the node being moved to before the existing head and being marked as the
607 607 new head node.
608 608 """
609 609 def __init__(self, max):
610 610 self._cache = {}
611 611
612 612 self._head = head = _lrucachenode()
613 613 head.prev = head
614 614 head.next = head
615 615 self._size = 1
616 616 self._capacity = max
617 617
618 618 def __len__(self):
619 619 return len(self._cache)
620 620
621 621 def __contains__(self, k):
622 622 return k in self._cache
623 623
624 624 def __iter__(self):
625 625 # We don't have to iterate in cache order, but why not.
626 626 n = self._head
627 627 for i in range(len(self._cache)):
628 628 yield n.key
629 629 n = n.next
630 630
631 631 def __getitem__(self, k):
632 632 node = self._cache[k]
633 633 self._movetohead(node)
634 634 return node.value
635 635
636 636 def __setitem__(self, k, v):
637 637 node = self._cache.get(k)
638 638 # Replace existing value and mark as newest.
639 639 if node is not None:
640 640 node.value = v
641 641 self._movetohead(node)
642 642 return
643 643
644 644 if self._size < self._capacity:
645 645 node = self._addcapacity()
646 646 else:
647 647 # Grab the last/oldest item.
648 648 node = self._head.prev
649 649
650 650 # At capacity. Kill the old entry.
651 651 if node.key is not _notset:
652 652 del self._cache[node.key]
653 653
654 654 node.key = k
655 655 node.value = v
656 656 self._cache[k] = node
657 657 # And mark it as newest entry. No need to adjust order since it
658 658 # is already self._head.prev.
659 659 self._head = node
660 660
661 661 def __delitem__(self, k):
662 662 node = self._cache.pop(k)
663 663 node.markempty()
664 664
665 665 # Temporarily mark as newest item before re-adjusting head to make
666 666 # this node the oldest item.
667 667 self._movetohead(node)
668 668 self._head = node.next
669 669
670 670 # Additional dict methods.
671 671
672 672 def get(self, k, default=None):
673 673 try:
674 674 return self._cache[k].value
675 675 except KeyError:
676 676 return default
677 677
678 678 def clear(self):
679 679 n = self._head
680 680 while n.key is not _notset:
681 681 n.markempty()
682 682 n = n.next
683 683
684 684 self._cache.clear()
685 685
686 686 def copy(self):
687 687 result = lrucachedict(self._capacity)
688 688 n = self._head.prev
689 689 # Iterate in oldest-to-newest order, so the copy has the right ordering
690 690 for i in range(len(self._cache)):
691 691 result[n.key] = n.value
692 692 n = n.prev
693 693 return result
694 694
695 695 def _movetohead(self, node):
696 696 """Mark a node as the newest, making it the new head.
697 697
698 698 When a node is accessed, it becomes the freshest entry in the LRU
699 699 list, which is denoted by self._head.
700 700
701 701 Visually, let's make ``N`` the new head node (* denotes head):
702 702
703 703 previous/oldest <-> head <-> next/next newest
704 704
705 705 ----<->--- A* ---<->-----
706 706 | |
707 707 E <-> D <-> N <-> C <-> B
708 708
709 709 To:
710 710
711 711 ----<->--- N* ---<->-----
712 712 | |
713 713 E <-> D <-> C <-> B <-> A
714 714
715 715 This requires the following moves:
716 716
717 717 C.next = D (node.prev.next = node.next)
718 718 D.prev = C (node.next.prev = node.prev)
719 719 E.next = N (head.prev.next = node)
720 720 N.prev = E (node.prev = head.prev)
721 721 N.next = A (node.next = head)
722 722 A.prev = N (head.prev = node)
723 723 """
724 724 head = self._head
725 725 # C.next = D
726 726 node.prev.next = node.next
727 727 # D.prev = C
728 728 node.next.prev = node.prev
729 729 # N.prev = E
730 730 node.prev = head.prev
731 731 # N.next = A
732 732 # It is tempting to do just "head" here, however if node is
733 733 # adjacent to head, this will do bad things.
734 734 node.next = head.prev.next
735 735 # E.next = N
736 736 node.next.prev = node
737 737 # A.prev = N
738 738 node.prev.next = node
739 739
740 740 self._head = node
741 741
742 742 def _addcapacity(self):
743 743 """Add a node to the circular linked list.
744 744
745 745 The new node is inserted before the head node.
746 746 """
747 747 head = self._head
748 748 node = _lrucachenode()
749 749 head.prev.next = node
750 750 node.prev = head.prev
751 751 node.next = head
752 752 head.prev = node
753 753 self._size += 1
754 754 return node
755 755
756 756 def lrucachefunc(func):
757 757 '''cache most recent results of function calls'''
758 758 cache = {}
759 759 order = collections.deque()
760 760 if func.__code__.co_argcount == 1:
761 761 def f(arg):
762 762 if arg not in cache:
763 763 if len(cache) > 20:
764 764 del cache[order.popleft()]
765 765 cache[arg] = func(arg)
766 766 else:
767 767 order.remove(arg)
768 768 order.append(arg)
769 769 return cache[arg]
770 770 else:
771 771 def f(*args):
772 772 if args not in cache:
773 773 if len(cache) > 20:
774 774 del cache[order.popleft()]
775 775 cache[args] = func(*args)
776 776 else:
777 777 order.remove(args)
778 778 order.append(args)
779 779 return cache[args]
780 780
781 781 return f
782 782
783 783 class propertycache(object):
784 784 def __init__(self, func):
785 785 self.func = func
786 786 self.name = func.__name__
787 787 def __get__(self, obj, type=None):
788 788 result = self.func(obj)
789 789 self.cachevalue(obj, result)
790 790 return result
791 791
792 792 def cachevalue(self, obj, value):
793 793 # __dict__ assignment required to bypass __setattr__ (eg: repoview)
794 794 obj.__dict__[self.name] = value
795 795
796 796 def pipefilter(s, cmd):
797 797 '''filter string S through command CMD, returning its output'''
798 798 p = subprocess.Popen(cmd, shell=True, close_fds=closefds,
799 799 stdin=subprocess.PIPE, stdout=subprocess.PIPE)
800 800 pout, perr = p.communicate(s)
801 801 return pout
802 802
803 803 def tempfilter(s, cmd):
804 804 '''filter string S through a pair of temporary files with CMD.
805 805 CMD is used as a template to create the real command to be run,
806 806 with the strings INFILE and OUTFILE replaced by the real names of
807 807 the temporary files generated.'''
808 808 inname, outname = None, None
809 809 try:
810 810 infd, inname = tempfile.mkstemp(prefix='hg-filter-in-')
811 811 fp = os.fdopen(infd, pycompat.sysstr('wb'))
812 812 fp.write(s)
813 813 fp.close()
814 814 outfd, outname = tempfile.mkstemp(prefix='hg-filter-out-')
815 815 os.close(outfd)
816 816 cmd = cmd.replace('INFILE', inname)
817 817 cmd = cmd.replace('OUTFILE', outname)
818 818 code = os.system(cmd)
819 819 if pycompat.sysplatform == 'OpenVMS' and code & 1:
820 820 code = 0
821 821 if code:
822 822 raise Abort(_("command '%s' failed: %s") %
823 823 (cmd, explainexit(code)))
824 824 return readfile(outname)
825 825 finally:
826 826 try:
827 827 if inname:
828 828 os.unlink(inname)
829 829 except OSError:
830 830 pass
831 831 try:
832 832 if outname:
833 833 os.unlink(outname)
834 834 except OSError:
835 835 pass
836 836
837 837 filtertable = {
838 838 'tempfile:': tempfilter,
839 839 'pipe:': pipefilter,
840 840 }
841 841
842 842 def filter(s, cmd):
843 843 "filter a string through a command that transforms its input to its output"
844 844 for name, fn in filtertable.iteritems():
845 845 if cmd.startswith(name):
846 846 return fn(s, cmd[len(name):].lstrip())
847 847 return pipefilter(s, cmd)
848 848
849 849 def binary(s):
850 850 """return true if a string is binary data"""
851 851 return bool(s and '\0' in s)
852 852
853 853 def increasingchunks(source, min=1024, max=65536):
854 854 '''return no less than min bytes per chunk while data remains,
855 855 doubling min after each chunk until it reaches max'''
856 856 def log2(x):
857 857 if not x:
858 858 return 0
859 859 i = 0
860 860 while x:
861 861 x >>= 1
862 862 i += 1
863 863 return i - 1
864 864
865 865 buf = []
866 866 blen = 0
867 867 for chunk in source:
868 868 buf.append(chunk)
869 869 blen += len(chunk)
870 870 if blen >= min:
871 871 if min < max:
872 872 min = min << 1
873 873 nmin = 1 << log2(blen)
874 874 if nmin > min:
875 875 min = nmin
876 876 if min > max:
877 877 min = max
878 878 yield ''.join(buf)
879 879 blen = 0
880 880 buf = []
881 881 if buf:
882 882 yield ''.join(buf)
883 883
884 884 Abort = error.Abort
885 885
886 886 def always(fn):
887 887 return True
888 888
889 889 def never(fn):
890 890 return False
891 891
892 892 def nogc(func):
893 893 """disable garbage collector
894 894
895 895 Python's garbage collector triggers a GC each time a certain number of
896 896 container objects (the number being defined by gc.get_threshold()) are
897 897 allocated even when marked not to be tracked by the collector. Tracking has
898 898 no effect on when GCs are triggered, only on what objects the GC looks
899 899 into. As a workaround, disable GC while building complex (huge)
900 900 containers.
901 901
902 902 This garbage collector issue have been fixed in 2.7.
903 903 """
904 904 if sys.version_info >= (2, 7):
905 905 return func
906 906 def wrapper(*args, **kwargs):
907 907 gcenabled = gc.isenabled()
908 908 gc.disable()
909 909 try:
910 910 return func(*args, **kwargs)
911 911 finally:
912 912 if gcenabled:
913 913 gc.enable()
914 914 return wrapper
915 915
916 916 def pathto(root, n1, n2):
917 917 '''return the relative path from one place to another.
918 918 root should use os.sep to separate directories
919 919 n1 should use os.sep to separate directories
920 920 n2 should use "/" to separate directories
921 921 returns an os.sep-separated path.
922 922
923 923 If n1 is a relative path, it's assumed it's
924 924 relative to root.
925 925 n2 should always be relative to root.
926 926 '''
927 927 if not n1:
928 928 return localpath(n2)
929 929 if os.path.isabs(n1):
930 930 if os.path.splitdrive(root)[0] != os.path.splitdrive(n1)[0]:
931 931 return os.path.join(root, localpath(n2))
932 932 n2 = '/'.join((pconvert(root), n2))
933 933 a, b = splitpath(n1), n2.split('/')
934 934 a.reverse()
935 935 b.reverse()
936 936 while a and b and a[-1] == b[-1]:
937 937 a.pop()
938 938 b.pop()
939 939 b.reverse()
940 940 return pycompat.ossep.join((['..'] * len(a)) + b) or '.'
941 941
942 942 def mainfrozen():
943 943 """return True if we are a frozen executable.
944 944
945 945 The code supports py2exe (most common, Windows only) and tools/freeze
946 946 (portable, not much used).
947 947 """
948 948 return (safehasattr(sys, "frozen") or # new py2exe
949 949 safehasattr(sys, "importers") or # old py2exe
950 950 imp.is_frozen(u"__main__")) # tools/freeze
951 951
952 952 # the location of data files matching the source code
953 953 if mainfrozen() and getattr(sys, 'frozen', None) != 'macosx_app':
954 954 # executable version (py2exe) doesn't support __file__
955 955 datapath = os.path.dirname(pycompat.sysexecutable)
956 956 else:
957 957 datapath = os.path.dirname(pycompat.fsencode(__file__))
958 958
959 959 i18n.setdatapath(datapath)
960 960
961 961 _hgexecutable = None
962 962
963 963 def hgexecutable():
964 964 """return location of the 'hg' executable.
965 965
966 966 Defaults to $HG or 'hg' in the search path.
967 967 """
968 968 if _hgexecutable is None:
969 969 hg = encoding.environ.get('HG')
970 970 mainmod = sys.modules[pycompat.sysstr('__main__')]
971 971 if hg:
972 972 _sethgexecutable(hg)
973 973 elif mainfrozen():
974 974 if getattr(sys, 'frozen', None) == 'macosx_app':
975 975 # Env variable set by py2app
976 976 _sethgexecutable(encoding.environ['EXECUTABLEPATH'])
977 977 else:
978 978 _sethgexecutable(pycompat.sysexecutable)
979 979 elif (os.path.basename(
980 980 pycompat.fsencode(getattr(mainmod, '__file__', ''))) == 'hg'):
981 981 _sethgexecutable(pycompat.fsencode(mainmod.__file__))
982 982 else:
983 983 exe = findexe('hg') or os.path.basename(sys.argv[0])
984 984 _sethgexecutable(exe)
985 985 return _hgexecutable
986 986
987 987 def _sethgexecutable(path):
988 988 """set location of the 'hg' executable"""
989 989 global _hgexecutable
990 990 _hgexecutable = path
991 991
992 992 def _isstdout(f):
993 993 fileno = getattr(f, 'fileno', None)
994 994 return fileno and fileno() == sys.__stdout__.fileno()
995 995
996 996 def shellenviron(environ=None):
997 997 """return environ with optional override, useful for shelling out"""
998 998 def py2shell(val):
999 999 'convert python object into string that is useful to shell'
1000 1000 if val is None or val is False:
1001 1001 return '0'
1002 1002 if val is True:
1003 1003 return '1'
1004 1004 return str(val)
1005 1005 env = dict(encoding.environ)
1006 1006 if environ:
1007 1007 env.update((k, py2shell(v)) for k, v in environ.iteritems())
1008 1008 env['HG'] = hgexecutable()
1009 1009 return env
1010 1010
1011 1011 def system(cmd, environ=None, cwd=None, out=None):
1012 1012 '''enhanced shell command execution.
1013 1013 run with environment maybe modified, maybe in different dir.
1014 1014
1015 1015 if out is specified, it is assumed to be a file-like object that has a
1016 1016 write() method. stdout and stderr will be redirected to out.'''
1017 1017 try:
1018 1018 stdout.flush()
1019 1019 except Exception:
1020 1020 pass
1021 1021 cmd = quotecommand(cmd)
1022 1022 if pycompat.sysplatform == 'plan9' and (sys.version_info[0] == 2
1023 1023 and sys.version_info[1] < 7):
1024 1024 # subprocess kludge to work around issues in half-baked Python
1025 1025 # ports, notably bichued/python:
1026 1026 if not cwd is None:
1027 1027 os.chdir(cwd)
1028 1028 rc = os.system(cmd)
1029 1029 else:
1030 1030 env = shellenviron(environ)
1031 1031 if out is None or _isstdout(out):
1032 1032 rc = subprocess.call(cmd, shell=True, close_fds=closefds,
1033 1033 env=env, cwd=cwd)
1034 1034 else:
1035 1035 proc = subprocess.Popen(cmd, shell=True, close_fds=closefds,
1036 1036 env=env, cwd=cwd, stdout=subprocess.PIPE,
1037 1037 stderr=subprocess.STDOUT)
1038 1038 for line in iter(proc.stdout.readline, ''):
1039 1039 out.write(line)
1040 1040 proc.wait()
1041 1041 rc = proc.returncode
1042 1042 if pycompat.sysplatform == 'OpenVMS' and rc & 1:
1043 1043 rc = 0
1044 1044 return rc
1045 1045
1046 1046 def checksignature(func):
1047 1047 '''wrap a function with code to check for calling errors'''
1048 1048 def check(*args, **kwargs):
1049 1049 try:
1050 1050 return func(*args, **kwargs)
1051 1051 except TypeError:
1052 1052 if len(traceback.extract_tb(sys.exc_info()[2])) == 1:
1053 1053 raise error.SignatureError
1054 1054 raise
1055 1055
1056 1056 return check
1057 1057
1058 1058 # a whilelist of known filesystems where hardlink works reliably
1059 1059 _hardlinkfswhitelist = set([
1060 1060 'btrfs',
1061 1061 'ext2',
1062 1062 'ext3',
1063 1063 'ext4',
1064 1064 'hfs',
1065 1065 'jfs',
1066 1066 'reiserfs',
1067 1067 'tmpfs',
1068 1068 'ufs',
1069 1069 'xfs',
1070 1070 'zfs',
1071 1071 ])
1072 1072
1073 1073 def copyfile(src, dest, hardlink=False, copystat=False, checkambig=False):
1074 1074 '''copy a file, preserving mode and optionally other stat info like
1075 1075 atime/mtime
1076 1076
1077 1077 checkambig argument is used with filestat, and is useful only if
1078 1078 destination file is guarded by any lock (e.g. repo.lock or
1079 1079 repo.wlock).
1080 1080
1081 1081 copystat and checkambig should be exclusive.
1082 1082 '''
1083 1083 assert not (copystat and checkambig)
1084 1084 oldstat = None
1085 1085 if os.path.lexists(dest):
1086 1086 if checkambig:
1087 1087 oldstat = checkambig and filestat(dest)
1088 1088 unlink(dest)
1089 1089 if hardlink:
1090 1090 # Hardlinks are problematic on CIFS (issue4546), do not allow hardlinks
1091 1091 # unless we are confident that dest is on a whitelisted filesystem.
1092 1092 try:
1093 1093 fstype = getfstype(os.path.dirname(dest))
1094 1094 except OSError:
1095 1095 fstype = None
1096 1096 if fstype not in _hardlinkfswhitelist:
1097 1097 hardlink = False
1098 1098 if hardlink:
1099 1099 try:
1100 1100 oslink(src, dest)
1101 1101 return
1102 1102 except (IOError, OSError):
1103 1103 pass # fall back to normal copy
1104 1104 if os.path.islink(src):
1105 1105 os.symlink(os.readlink(src), dest)
1106 1106 # copytime is ignored for symlinks, but in general copytime isn't needed
1107 1107 # for them anyway
1108 1108 else:
1109 1109 try:
1110 1110 shutil.copyfile(src, dest)
1111 1111 if copystat:
1112 1112 # copystat also copies mode
1113 1113 shutil.copystat(src, dest)
1114 1114 else:
1115 1115 shutil.copymode(src, dest)
1116 1116 if oldstat and oldstat.stat:
1117 1117 newstat = filestat(dest)
1118 1118 if newstat.isambig(oldstat):
1119 1119 # stat of copied file is ambiguous to original one
1120 1120 advanced = (oldstat.stat.st_mtime + 1) & 0x7fffffff
1121 1121 os.utime(dest, (advanced, advanced))
1122 1122 except shutil.Error as inst:
1123 1123 raise Abort(str(inst))
1124 1124
1125 1125 def copyfiles(src, dst, hardlink=None, progress=lambda t, pos: None):
1126 1126 """Copy a directory tree using hardlinks if possible."""
1127 1127 num = 0
1128 1128
1129 1129 gettopic = lambda: hardlink and _('linking') or _('copying')
1130 1130
1131 1131 if os.path.isdir(src):
1132 1132 if hardlink is None:
1133 1133 hardlink = (os.stat(src).st_dev ==
1134 1134 os.stat(os.path.dirname(dst)).st_dev)
1135 1135 topic = gettopic()
1136 1136 os.mkdir(dst)
1137 1137 for name, kind in osutil.listdir(src):
1138 1138 srcname = os.path.join(src, name)
1139 1139 dstname = os.path.join(dst, name)
1140 1140 def nprog(t, pos):
1141 1141 if pos is not None:
1142 1142 return progress(t, pos + num)
1143 1143 hardlink, n = copyfiles(srcname, dstname, hardlink, progress=nprog)
1144 1144 num += n
1145 1145 else:
1146 1146 if hardlink is None:
1147 1147 hardlink = (os.stat(os.path.dirname(src)).st_dev ==
1148 1148 os.stat(os.path.dirname(dst)).st_dev)
1149 1149 topic = gettopic()
1150 1150
1151 1151 if hardlink:
1152 1152 try:
1153 1153 oslink(src, dst)
1154 1154 except (IOError, OSError):
1155 1155 hardlink = False
1156 1156 shutil.copy(src, dst)
1157 1157 else:
1158 1158 shutil.copy(src, dst)
1159 1159 num += 1
1160 1160 progress(topic, num)
1161 1161 progress(topic, None)
1162 1162
1163 1163 return hardlink, num
1164 1164
1165 1165 _winreservednames = '''con prn aux nul
1166 1166 com1 com2 com3 com4 com5 com6 com7 com8 com9
1167 1167 lpt1 lpt2 lpt3 lpt4 lpt5 lpt6 lpt7 lpt8 lpt9'''.split()
1168 1168 _winreservedchars = ':*?"<>|'
1169 1169 def checkwinfilename(path):
1170 1170 r'''Check that the base-relative path is a valid filename on Windows.
1171 1171 Returns None if the path is ok, or a UI string describing the problem.
1172 1172
1173 1173 >>> checkwinfilename("just/a/normal/path")
1174 1174 >>> checkwinfilename("foo/bar/con.xml")
1175 1175 "filename contains 'con', which is reserved on Windows"
1176 1176 >>> checkwinfilename("foo/con.xml/bar")
1177 1177 "filename contains 'con', which is reserved on Windows"
1178 1178 >>> checkwinfilename("foo/bar/xml.con")
1179 1179 >>> checkwinfilename("foo/bar/AUX/bla.txt")
1180 1180 "filename contains 'AUX', which is reserved on Windows"
1181 1181 >>> checkwinfilename("foo/bar/bla:.txt")
1182 1182 "filename contains ':', which is reserved on Windows"
1183 1183 >>> checkwinfilename("foo/bar/b\07la.txt")
1184 1184 "filename contains '\\x07', which is invalid on Windows"
1185 1185 >>> checkwinfilename("foo/bar/bla ")
1186 1186 "filename ends with ' ', which is not allowed on Windows"
1187 1187 >>> checkwinfilename("../bar")
1188 1188 >>> checkwinfilename("foo\\")
1189 1189 "filename ends with '\\', which is invalid on Windows"
1190 1190 >>> checkwinfilename("foo\\/bar")
1191 1191 "directory name ends with '\\', which is invalid on Windows"
1192 1192 '''
1193 1193 if path.endswith('\\'):
1194 1194 return _("filename ends with '\\', which is invalid on Windows")
1195 1195 if '\\/' in path:
1196 1196 return _("directory name ends with '\\', which is invalid on Windows")
1197 1197 for n in path.replace('\\', '/').split('/'):
1198 1198 if not n:
1199 1199 continue
1200 1200 for c in pycompat.bytestr(n):
1201 1201 if c in _winreservedchars:
1202 1202 return _("filename contains '%s', which is reserved "
1203 1203 "on Windows") % c
1204 1204 if ord(c) <= 31:
1205 1205 return _("filename contains %r, which is invalid "
1206 1206 "on Windows") % c
1207 1207 base = n.split('.')[0]
1208 1208 if base and base.lower() in _winreservednames:
1209 1209 return _("filename contains '%s', which is reserved "
1210 1210 "on Windows") % base
1211 1211 t = n[-1]
1212 1212 if t in '. ' and n not in '..':
1213 1213 return _("filename ends with '%s', which is not allowed "
1214 1214 "on Windows") % t
1215 1215
1216 1216 if pycompat.osname == 'nt':
1217 1217 checkosfilename = checkwinfilename
1218 1218 timer = time.clock
1219 1219 else:
1220 1220 checkosfilename = platform.checkosfilename
1221 1221 timer = time.time
1222 1222
1223 1223 if safehasattr(time, "perf_counter"):
1224 1224 timer = time.perf_counter
1225 1225
1226 1226 def makelock(info, pathname):
1227 1227 try:
1228 1228 return os.symlink(info, pathname)
1229 1229 except OSError as why:
1230 1230 if why.errno == errno.EEXIST:
1231 1231 raise
1232 1232 except AttributeError: # no symlink in os
1233 1233 pass
1234 1234
1235 1235 ld = os.open(pathname, os.O_CREAT | os.O_WRONLY | os.O_EXCL)
1236 1236 os.write(ld, info)
1237 1237 os.close(ld)
1238 1238
1239 1239 def readlock(pathname):
1240 1240 try:
1241 1241 return os.readlink(pathname)
1242 1242 except OSError as why:
1243 1243 if why.errno not in (errno.EINVAL, errno.ENOSYS):
1244 1244 raise
1245 1245 except AttributeError: # no symlink in os
1246 1246 pass
1247 1247 fp = posixfile(pathname)
1248 1248 r = fp.read()
1249 1249 fp.close()
1250 1250 return r
1251 1251
1252 1252 def fstat(fp):
1253 1253 '''stat file object that may not have fileno method.'''
1254 1254 try:
1255 1255 return os.fstat(fp.fileno())
1256 1256 except AttributeError:
1257 1257 return os.stat(fp.name)
1258 1258
1259 1259 # File system features
1260 1260
1261 1261 def fscasesensitive(path):
1262 1262 """
1263 1263 Return true if the given path is on a case-sensitive filesystem
1264 1264
1265 1265 Requires a path (like /foo/.hg) ending with a foldable final
1266 1266 directory component.
1267 1267 """
1268 1268 s1 = os.lstat(path)
1269 1269 d, b = os.path.split(path)
1270 1270 b2 = b.upper()
1271 1271 if b == b2:
1272 1272 b2 = b.lower()
1273 1273 if b == b2:
1274 1274 return True # no evidence against case sensitivity
1275 1275 p2 = os.path.join(d, b2)
1276 1276 try:
1277 1277 s2 = os.lstat(p2)
1278 1278 if s2 == s1:
1279 1279 return False
1280 1280 return True
1281 1281 except OSError:
1282 1282 return True
1283 1283
1284 1284 try:
1285 1285 import re2
1286 1286 _re2 = None
1287 1287 except ImportError:
1288 1288 _re2 = False
1289 1289
1290 1290 class _re(object):
1291 1291 def _checkre2(self):
1292 1292 global _re2
1293 1293 try:
1294 1294 # check if match works, see issue3964
1295 1295 _re2 = bool(re2.match(r'\[([^\[]+)\]', '[ui]'))
1296 1296 except ImportError:
1297 1297 _re2 = False
1298 1298
1299 1299 def compile(self, pat, flags=0):
1300 1300 '''Compile a regular expression, using re2 if possible
1301 1301
1302 1302 For best performance, use only re2-compatible regexp features. The
1303 1303 only flags from the re module that are re2-compatible are
1304 1304 IGNORECASE and MULTILINE.'''
1305 1305 if _re2 is None:
1306 1306 self._checkre2()
1307 1307 if _re2 and (flags & ~(remod.IGNORECASE | remod.MULTILINE)) == 0:
1308 1308 if flags & remod.IGNORECASE:
1309 1309 pat = '(?i)' + pat
1310 1310 if flags & remod.MULTILINE:
1311 1311 pat = '(?m)' + pat
1312 1312 try:
1313 1313 return re2.compile(pat)
1314 1314 except re2.error:
1315 1315 pass
1316 1316 return remod.compile(pat, flags)
1317 1317
1318 1318 @propertycache
1319 1319 def escape(self):
1320 1320 '''Return the version of escape corresponding to self.compile.
1321 1321
1322 1322 This is imperfect because whether re2 or re is used for a particular
1323 1323 function depends on the flags, etc, but it's the best we can do.
1324 1324 '''
1325 1325 global _re2
1326 1326 if _re2 is None:
1327 1327 self._checkre2()
1328 1328 if _re2:
1329 1329 return re2.escape
1330 1330 else:
1331 1331 return remod.escape
1332 1332
1333 1333 re = _re()
1334 1334
1335 1335 _fspathcache = {}
1336 1336 def fspath(name, root):
1337 1337 '''Get name in the case stored in the filesystem
1338 1338
1339 1339 The name should be relative to root, and be normcase-ed for efficiency.
1340 1340
1341 1341 Note that this function is unnecessary, and should not be
1342 1342 called, for case-sensitive filesystems (simply because it's expensive).
1343 1343
1344 1344 The root should be normcase-ed, too.
1345 1345 '''
1346 1346 def _makefspathcacheentry(dir):
1347 1347 return dict((normcase(n), n) for n in os.listdir(dir))
1348 1348
1349 1349 seps = pycompat.ossep
1350 1350 if pycompat.osaltsep:
1351 1351 seps = seps + pycompat.osaltsep
1352 1352 # Protect backslashes. This gets silly very quickly.
1353 1353 seps.replace('\\','\\\\')
1354 1354 pattern = remod.compile(br'([^%s]+)|([%s]+)' % (seps, seps))
1355 1355 dir = os.path.normpath(root)
1356 1356 result = []
1357 1357 for part, sep in pattern.findall(name):
1358 1358 if sep:
1359 1359 result.append(sep)
1360 1360 continue
1361 1361
1362 1362 if dir not in _fspathcache:
1363 1363 _fspathcache[dir] = _makefspathcacheentry(dir)
1364 1364 contents = _fspathcache[dir]
1365 1365
1366 1366 found = contents.get(part)
1367 1367 if not found:
1368 1368 # retry "once per directory" per "dirstate.walk" which
1369 1369 # may take place for each patches of "hg qpush", for example
1370 1370 _fspathcache[dir] = contents = _makefspathcacheentry(dir)
1371 1371 found = contents.get(part)
1372 1372
1373 1373 result.append(found or part)
1374 1374 dir = os.path.join(dir, part)
1375 1375
1376 1376 return ''.join(result)
1377 1377
1378 1378 def getfstype(dirpath):
1379 1379 '''Get the filesystem type name from a directory (best-effort)
1380 1380
1381 1381 Returns None if we are unsure. Raises OSError on ENOENT, EPERM, etc.
1382 1382 '''
1383 1383 return getattr(osutil, 'getfstype', lambda x: None)(dirpath)
1384 1384
1385 1385 def checknlink(testfile):
1386 1386 '''check whether hardlink count reporting works properly'''
1387 1387
1388 1388 # testfile may be open, so we need a separate file for checking to
1389 1389 # work around issue2543 (or testfile may get lost on Samba shares)
1390 1390 f1 = testfile + ".hgtmp1"
1391 1391 if os.path.lexists(f1):
1392 1392 return False
1393 1393 try:
1394 1394 posixfile(f1, 'w').close()
1395 1395 except IOError:
1396 1396 try:
1397 1397 os.unlink(f1)
1398 1398 except OSError:
1399 1399 pass
1400 1400 return False
1401 1401
1402 1402 f2 = testfile + ".hgtmp2"
1403 1403 fd = None
1404 1404 try:
1405 1405 oslink(f1, f2)
1406 1406 # nlinks() may behave differently for files on Windows shares if
1407 1407 # the file is open.
1408 1408 fd = posixfile(f2)
1409 1409 return nlinks(f2) > 1
1410 1410 except OSError:
1411 1411 return False
1412 1412 finally:
1413 1413 if fd is not None:
1414 1414 fd.close()
1415 1415 for f in (f1, f2):
1416 1416 try:
1417 1417 os.unlink(f)
1418 1418 except OSError:
1419 1419 pass
1420 1420
1421 1421 def endswithsep(path):
1422 1422 '''Check path ends with os.sep or os.altsep.'''
1423 1423 return (path.endswith(pycompat.ossep)
1424 1424 or pycompat.osaltsep and path.endswith(pycompat.osaltsep))
1425 1425
1426 1426 def splitpath(path):
1427 1427 '''Split path by os.sep.
1428 1428 Note that this function does not use os.altsep because this is
1429 1429 an alternative of simple "xxx.split(os.sep)".
1430 1430 It is recommended to use os.path.normpath() before using this
1431 1431 function if need.'''
1432 1432 return path.split(pycompat.ossep)
1433 1433
1434 1434 def gui():
1435 1435 '''Are we running in a GUI?'''
1436 1436 if pycompat.sysplatform == 'darwin':
1437 1437 if 'SSH_CONNECTION' in encoding.environ:
1438 1438 # handle SSH access to a box where the user is logged in
1439 1439 return False
1440 1440 elif getattr(osutil, 'isgui', None):
1441 1441 # check if a CoreGraphics session is available
1442 1442 return osutil.isgui()
1443 1443 else:
1444 1444 # pure build; use a safe default
1445 1445 return True
1446 1446 else:
1447 1447 return pycompat.osname == "nt" or encoding.environ.get("DISPLAY")
1448 1448
1449 1449 def mktempcopy(name, emptyok=False, createmode=None):
1450 1450 """Create a temporary file with the same contents from name
1451 1451
1452 1452 The permission bits are copied from the original file.
1453 1453
1454 1454 If the temporary file is going to be truncated immediately, you
1455 1455 can use emptyok=True as an optimization.
1456 1456
1457 1457 Returns the name of the temporary file.
1458 1458 """
1459 1459 d, fn = os.path.split(name)
1460 1460 fd, temp = tempfile.mkstemp(prefix='.%s-' % fn, dir=d)
1461 1461 os.close(fd)
1462 1462 # Temporary files are created with mode 0600, which is usually not
1463 1463 # what we want. If the original file already exists, just copy
1464 1464 # its mode. Otherwise, manually obey umask.
1465 1465 copymode(name, temp, createmode)
1466 1466 if emptyok:
1467 1467 return temp
1468 1468 try:
1469 1469 try:
1470 1470 ifp = posixfile(name, "rb")
1471 1471 except IOError as inst:
1472 1472 if inst.errno == errno.ENOENT:
1473 1473 return temp
1474 1474 if not getattr(inst, 'filename', None):
1475 1475 inst.filename = name
1476 1476 raise
1477 1477 ofp = posixfile(temp, "wb")
1478 1478 for chunk in filechunkiter(ifp):
1479 1479 ofp.write(chunk)
1480 1480 ifp.close()
1481 1481 ofp.close()
1482 1482 except: # re-raises
1483 1483 try: os.unlink(temp)
1484 1484 except OSError: pass
1485 1485 raise
1486 1486 return temp
1487 1487
1488 1488 class filestat(object):
1489 1489 """help to exactly detect change of a file
1490 1490
1491 1491 'stat' attribute is result of 'os.stat()' if specified 'path'
1492 1492 exists. Otherwise, it is None. This can avoid preparative
1493 1493 'exists()' examination on client side of this class.
1494 1494 """
1495 1495 def __init__(self, path):
1496 1496 try:
1497 1497 self.stat = os.stat(path)
1498 1498 except OSError as err:
1499 1499 if err.errno != errno.ENOENT:
1500 1500 raise
1501 1501 self.stat = None
1502 1502
1503 1503 __hash__ = object.__hash__
1504 1504
1505 1505 def __eq__(self, old):
1506 1506 try:
1507 1507 # if ambiguity between stat of new and old file is
1508 1508 # avoided, comparison of size, ctime and mtime is enough
1509 1509 # to exactly detect change of a file regardless of platform
1510 1510 return (self.stat.st_size == old.stat.st_size and
1511 1511 self.stat.st_ctime == old.stat.st_ctime and
1512 1512 self.stat.st_mtime == old.stat.st_mtime)
1513 1513 except AttributeError:
1514 1514 return False
1515 1515
1516 1516 def isambig(self, old):
1517 1517 """Examine whether new (= self) stat is ambiguous against old one
1518 1518
1519 1519 "S[N]" below means stat of a file at N-th change:
1520 1520
1521 1521 - S[n-1].ctime < S[n].ctime: can detect change of a file
1522 1522 - S[n-1].ctime == S[n].ctime
1523 1523 - S[n-1].ctime < S[n].mtime: means natural advancing (*1)
1524 1524 - S[n-1].ctime == S[n].mtime: is ambiguous (*2)
1525 1525 - S[n-1].ctime > S[n].mtime: never occurs naturally (don't care)
1526 1526 - S[n-1].ctime > S[n].ctime: never occurs naturally (don't care)
1527 1527
1528 1528 Case (*2) above means that a file was changed twice or more at
1529 1529 same time in sec (= S[n-1].ctime), and comparison of timestamp
1530 1530 is ambiguous.
1531 1531
1532 1532 Base idea to avoid such ambiguity is "advance mtime 1 sec, if
1533 1533 timestamp is ambiguous".
1534 1534
1535 1535 But advancing mtime only in case (*2) doesn't work as
1536 1536 expected, because naturally advanced S[n].mtime in case (*1)
1537 1537 might be equal to manually advanced S[n-1 or earlier].mtime.
1538 1538
1539 1539 Therefore, all "S[n-1].ctime == S[n].ctime" cases should be
1540 1540 treated as ambiguous regardless of mtime, to avoid overlooking
1541 1541 by confliction between such mtime.
1542 1542
1543 1543 Advancing mtime "if isambig(oldstat)" ensures "S[n-1].mtime !=
1544 1544 S[n].mtime", even if size of a file isn't changed.
1545 1545 """
1546 1546 try:
1547 1547 return (self.stat.st_ctime == old.stat.st_ctime)
1548 1548 except AttributeError:
1549 1549 return False
1550 1550
1551 1551 def avoidambig(self, path, old):
1552 1552 """Change file stat of specified path to avoid ambiguity
1553 1553
1554 1554 'old' should be previous filestat of 'path'.
1555 1555
1556 1556 This skips avoiding ambiguity, if a process doesn't have
1557 1557 appropriate privileges for 'path'.
1558 1558 """
1559 1559 advanced = (old.stat.st_mtime + 1) & 0x7fffffff
1560 1560 try:
1561 1561 os.utime(path, (advanced, advanced))
1562 1562 except OSError as inst:
1563 1563 if inst.errno == errno.EPERM:
1564 1564 # utime() on the file created by another user causes EPERM,
1565 1565 # if a process doesn't have appropriate privileges
1566 1566 return
1567 1567 raise
1568 1568
1569 1569 def __ne__(self, other):
1570 1570 return not self == other
1571 1571
1572 1572 class atomictempfile(object):
1573 1573 '''writable file object that atomically updates a file
1574 1574
1575 1575 All writes will go to a temporary copy of the original file. Call
1576 1576 close() when you are done writing, and atomictempfile will rename
1577 1577 the temporary copy to the original name, making the changes
1578 1578 visible. If the object is destroyed without being closed, all your
1579 1579 writes are discarded.
1580 1580
1581 1581 checkambig argument of constructor is used with filestat, and is
1582 1582 useful only if target file is guarded by any lock (e.g. repo.lock
1583 1583 or repo.wlock).
1584 1584 '''
1585 1585 def __init__(self, name, mode='w+b', createmode=None, checkambig=False):
1586 1586 self.__name = name # permanent name
1587 1587 self._tempname = mktempcopy(name, emptyok=('w' in mode),
1588 1588 createmode=createmode)
1589 1589 self._fp = posixfile(self._tempname, mode)
1590 1590 self._checkambig = checkambig
1591 1591
1592 1592 # delegated methods
1593 1593 self.read = self._fp.read
1594 1594 self.write = self._fp.write
1595 1595 self.seek = self._fp.seek
1596 1596 self.tell = self._fp.tell
1597 1597 self.fileno = self._fp.fileno
1598 1598
1599 1599 def close(self):
1600 1600 if not self._fp.closed:
1601 1601 self._fp.close()
1602 1602 filename = localpath(self.__name)
1603 1603 oldstat = self._checkambig and filestat(filename)
1604 1604 if oldstat and oldstat.stat:
1605 1605 rename(self._tempname, filename)
1606 1606 newstat = filestat(filename)
1607 1607 if newstat.isambig(oldstat):
1608 1608 # stat of changed file is ambiguous to original one
1609 1609 advanced = (oldstat.stat.st_mtime + 1) & 0x7fffffff
1610 1610 os.utime(filename, (advanced, advanced))
1611 1611 else:
1612 1612 rename(self._tempname, filename)
1613 1613
1614 1614 def discard(self):
1615 1615 if not self._fp.closed:
1616 1616 try:
1617 1617 os.unlink(self._tempname)
1618 1618 except OSError:
1619 1619 pass
1620 1620 self._fp.close()
1621 1621
1622 1622 def __del__(self):
1623 1623 if safehasattr(self, '_fp'): # constructor actually did something
1624 1624 self.discard()
1625 1625
1626 1626 def __enter__(self):
1627 1627 return self
1628 1628
1629 1629 def __exit__(self, exctype, excvalue, traceback):
1630 1630 if exctype is not None:
1631 1631 self.discard()
1632 1632 else:
1633 1633 self.close()
1634 1634
1635 1635 def unlinkpath(f, ignoremissing=False):
1636 1636 """unlink and remove the directory if it is empty"""
1637 1637 if ignoremissing:
1638 1638 tryunlink(f)
1639 1639 else:
1640 1640 unlink(f)
1641 1641 # try removing directories that might now be empty
1642 1642 try:
1643 1643 removedirs(os.path.dirname(f))
1644 1644 except OSError:
1645 1645 pass
1646 1646
1647 1647 def tryunlink(f):
1648 1648 """Attempt to remove a file, ignoring ENOENT errors."""
1649 1649 try:
1650 1650 unlink(f)
1651 1651 except OSError as e:
1652 1652 if e.errno != errno.ENOENT:
1653 1653 raise
1654 1654
1655 1655 def makedirs(name, mode=None, notindexed=False):
1656 1656 """recursive directory creation with parent mode inheritance
1657 1657
1658 1658 Newly created directories are marked as "not to be indexed by
1659 1659 the content indexing service", if ``notindexed`` is specified
1660 1660 for "write" mode access.
1661 1661 """
1662 1662 try:
1663 1663 makedir(name, notindexed)
1664 1664 except OSError as err:
1665 1665 if err.errno == errno.EEXIST:
1666 1666 return
1667 1667 if err.errno != errno.ENOENT or not name:
1668 1668 raise
1669 1669 parent = os.path.dirname(os.path.abspath(name))
1670 1670 if parent == name:
1671 1671 raise
1672 1672 makedirs(parent, mode, notindexed)
1673 1673 try:
1674 1674 makedir(name, notindexed)
1675 1675 except OSError as err:
1676 1676 # Catch EEXIST to handle races
1677 1677 if err.errno == errno.EEXIST:
1678 1678 return
1679 1679 raise
1680 1680 if mode is not None:
1681 1681 os.chmod(name, mode)
1682 1682
1683 1683 def readfile(path):
1684 1684 with open(path, 'rb') as fp:
1685 1685 return fp.read()
1686 1686
1687 1687 def writefile(path, text):
1688 1688 with open(path, 'wb') as fp:
1689 1689 fp.write(text)
1690 1690
1691 1691 def appendfile(path, text):
1692 1692 with open(path, 'ab') as fp:
1693 1693 fp.write(text)
1694 1694
1695 1695 class chunkbuffer(object):
1696 1696 """Allow arbitrary sized chunks of data to be efficiently read from an
1697 1697 iterator over chunks of arbitrary size."""
1698 1698
1699 1699 def __init__(self, in_iter):
1700 1700 """in_iter is the iterator that's iterating over the input chunks.
1701 1701 targetsize is how big a buffer to try to maintain."""
1702 1702 def splitbig(chunks):
1703 1703 for chunk in chunks:
1704 1704 if len(chunk) > 2**20:
1705 1705 pos = 0
1706 1706 while pos < len(chunk):
1707 1707 end = pos + 2 ** 18
1708 1708 yield chunk[pos:end]
1709 1709 pos = end
1710 1710 else:
1711 1711 yield chunk
1712 1712 self.iter = splitbig(in_iter)
1713 1713 self._queue = collections.deque()
1714 1714 self._chunkoffset = 0
1715 1715
1716 1716 def read(self, l=None):
1717 1717 """Read L bytes of data from the iterator of chunks of data.
1718 1718 Returns less than L bytes if the iterator runs dry.
1719 1719
1720 1720 If size parameter is omitted, read everything"""
1721 1721 if l is None:
1722 1722 return ''.join(self.iter)
1723 1723
1724 1724 left = l
1725 1725 buf = []
1726 1726 queue = self._queue
1727 1727 while left > 0:
1728 1728 # refill the queue
1729 1729 if not queue:
1730 1730 target = 2**18
1731 1731 for chunk in self.iter:
1732 1732 queue.append(chunk)
1733 1733 target -= len(chunk)
1734 1734 if target <= 0:
1735 1735 break
1736 1736 if not queue:
1737 1737 break
1738 1738
1739 1739 # The easy way to do this would be to queue.popleft(), modify the
1740 1740 # chunk (if necessary), then queue.appendleft(). However, for cases
1741 1741 # where we read partial chunk content, this incurs 2 dequeue
1742 1742 # mutations and creates a new str for the remaining chunk in the
1743 1743 # queue. Our code below avoids this overhead.
1744 1744
1745 1745 chunk = queue[0]
1746 1746 chunkl = len(chunk)
1747 1747 offset = self._chunkoffset
1748 1748
1749 1749 # Use full chunk.
1750 1750 if offset == 0 and left >= chunkl:
1751 1751 left -= chunkl
1752 1752 queue.popleft()
1753 1753 buf.append(chunk)
1754 1754 # self._chunkoffset remains at 0.
1755 1755 continue
1756 1756
1757 1757 chunkremaining = chunkl - offset
1758 1758
1759 1759 # Use all of unconsumed part of chunk.
1760 1760 if left >= chunkremaining:
1761 1761 left -= chunkremaining
1762 1762 queue.popleft()
1763 1763 # offset == 0 is enabled by block above, so this won't merely
1764 1764 # copy via ``chunk[0:]``.
1765 1765 buf.append(chunk[offset:])
1766 1766 self._chunkoffset = 0
1767 1767
1768 1768 # Partial chunk needed.
1769 1769 else:
1770 1770 buf.append(chunk[offset:offset + left])
1771 1771 self._chunkoffset += left
1772 1772 left -= chunkremaining
1773 1773
1774 1774 return ''.join(buf)
1775 1775
1776 1776 def filechunkiter(f, size=131072, limit=None):
1777 1777 """Create a generator that produces the data in the file size
1778 1778 (default 131072) bytes at a time, up to optional limit (default is
1779 1779 to read all data). Chunks may be less than size bytes if the
1780 1780 chunk is the last chunk in the file, or the file is a socket or
1781 1781 some other type of file that sometimes reads less data than is
1782 1782 requested."""
1783 1783 assert size >= 0
1784 1784 assert limit is None or limit >= 0
1785 1785 while True:
1786 1786 if limit is None:
1787 1787 nbytes = size
1788 1788 else:
1789 1789 nbytes = min(limit, size)
1790 1790 s = nbytes and f.read(nbytes)
1791 1791 if not s:
1792 1792 break
1793 1793 if limit:
1794 1794 limit -= len(s)
1795 1795 yield s
1796 1796
1797 1797 def makedate(timestamp=None):
1798 1798 '''Return a unix timestamp (or the current time) as a (unixtime,
1799 1799 offset) tuple based off the local timezone.'''
1800 1800 if timestamp is None:
1801 1801 timestamp = time.time()
1802 1802 if timestamp < 0:
1803 1803 hint = _("check your clock")
1804 1804 raise Abort(_("negative timestamp: %d") % timestamp, hint=hint)
1805 1805 delta = (datetime.datetime.utcfromtimestamp(timestamp) -
1806 1806 datetime.datetime.fromtimestamp(timestamp))
1807 1807 tz = delta.days * 86400 + delta.seconds
1808 1808 return timestamp, tz
1809 1809
1810 1810 def datestr(date=None, format='%a %b %d %H:%M:%S %Y %1%2'):
1811 1811 """represent a (unixtime, offset) tuple as a localized time.
1812 1812 unixtime is seconds since the epoch, and offset is the time zone's
1813 1813 number of seconds away from UTC.
1814 1814
1815 1815 >>> datestr((0, 0))
1816 1816 'Thu Jan 01 00:00:00 1970 +0000'
1817 1817 >>> datestr((42, 0))
1818 1818 'Thu Jan 01 00:00:42 1970 +0000'
1819 1819 >>> datestr((-42, 0))
1820 1820 'Wed Dec 31 23:59:18 1969 +0000'
1821 1821 >>> datestr((0x7fffffff, 0))
1822 1822 'Tue Jan 19 03:14:07 2038 +0000'
1823 1823 >>> datestr((-0x80000000, 0))
1824 1824 'Fri Dec 13 20:45:52 1901 +0000'
1825 1825 """
1826 1826 t, tz = date or makedate()
1827 1827 if "%1" in format or "%2" in format or "%z" in format:
1828 1828 sign = (tz > 0) and "-" or "+"
1829 1829 minutes = abs(tz) // 60
1830 1830 q, r = divmod(minutes, 60)
1831 1831 format = format.replace("%z", "%1%2")
1832 1832 format = format.replace("%1", "%c%02d" % (sign, q))
1833 1833 format = format.replace("%2", "%02d" % r)
1834 1834 d = t - tz
1835 1835 if d > 0x7fffffff:
1836 1836 d = 0x7fffffff
1837 1837 elif d < -0x80000000:
1838 1838 d = -0x80000000
1839 1839 # Never use time.gmtime() and datetime.datetime.fromtimestamp()
1840 1840 # because they use the gmtime() system call which is buggy on Windows
1841 1841 # for negative values.
1842 1842 t = datetime.datetime(1970, 1, 1) + datetime.timedelta(seconds=d)
1843 1843 s = encoding.strtolocal(t.strftime(encoding.strfromlocal(format)))
1844 1844 return s
1845 1845
1846 1846 def shortdate(date=None):
1847 1847 """turn (timestamp, tzoff) tuple into iso 8631 date."""
1848 1848 return datestr(date, format='%Y-%m-%d')
1849 1849
1850 1850 def parsetimezone(s):
1851 1851 """find a trailing timezone, if any, in string, and return a
1852 1852 (offset, remainder) pair"""
1853 1853
1854 1854 if s.endswith("GMT") or s.endswith("UTC"):
1855 1855 return 0, s[:-3].rstrip()
1856 1856
1857 1857 # Unix-style timezones [+-]hhmm
1858 1858 if len(s) >= 5 and s[-5] in "+-" and s[-4:].isdigit():
1859 1859 sign = (s[-5] == "+") and 1 or -1
1860 1860 hours = int(s[-4:-2])
1861 1861 minutes = int(s[-2:])
1862 1862 return -sign * (hours * 60 + minutes) * 60, s[:-5].rstrip()
1863 1863
1864 1864 # ISO8601 trailing Z
1865 1865 if s.endswith("Z") and s[-2:-1].isdigit():
1866 1866 return 0, s[:-1]
1867 1867
1868 1868 # ISO8601-style [+-]hh:mm
1869 1869 if (len(s) >= 6 and s[-6] in "+-" and s[-3] == ":" and
1870 1870 s[-5:-3].isdigit() and s[-2:].isdigit()):
1871 1871 sign = (s[-6] == "+") and 1 or -1
1872 1872 hours = int(s[-5:-3])
1873 1873 minutes = int(s[-2:])
1874 1874 return -sign * (hours * 60 + minutes) * 60, s[:-6]
1875 1875
1876 1876 return None, s
1877 1877
1878 1878 def strdate(string, format, defaults=None):
1879 1879 """parse a localized time string and return a (unixtime, offset) tuple.
1880 1880 if the string cannot be parsed, ValueError is raised."""
1881 1881 if defaults is None:
1882 1882 defaults = {}
1883 1883
1884 1884 # NOTE: unixtime = localunixtime + offset
1885 1885 offset, date = parsetimezone(string)
1886 1886
1887 1887 # add missing elements from defaults
1888 1888 usenow = False # default to using biased defaults
1889 1889 for part in ("S", "M", "HI", "d", "mb", "yY"): # decreasing specificity
1890 1890 found = [True for p in part if ("%"+p) in format]
1891 1891 if not found:
1892 1892 date += "@" + defaults[part][usenow]
1893 1893 format += "@%" + part[0]
1894 1894 else:
1895 1895 # We've found a specific time element, less specific time
1896 1896 # elements are relative to today
1897 1897 usenow = True
1898 1898
1899 1899 timetuple = time.strptime(date, format)
1900 1900 localunixtime = int(calendar.timegm(timetuple))
1901 1901 if offset is None:
1902 1902 # local timezone
1903 1903 unixtime = int(time.mktime(timetuple))
1904 1904 offset = unixtime - localunixtime
1905 1905 else:
1906 1906 unixtime = localunixtime + offset
1907 1907 return unixtime, offset
1908 1908
1909 1909 def parsedate(date, formats=None, bias=None):
1910 1910 """parse a localized date/time and return a (unixtime, offset) tuple.
1911 1911
1912 1912 The date may be a "unixtime offset" string or in one of the specified
1913 1913 formats. If the date already is a (unixtime, offset) tuple, it is returned.
1914 1914
1915 1915 >>> parsedate(' today ') == parsedate(\
1916 1916 datetime.date.today().strftime('%b %d'))
1917 1917 True
1918 1918 >>> parsedate( 'yesterday ') == parsedate((datetime.date.today() -\
1919 1919 datetime.timedelta(days=1)\
1920 1920 ).strftime('%b %d'))
1921 1921 True
1922 1922 >>> now, tz = makedate()
1923 1923 >>> strnow, strtz = parsedate('now')
1924 1924 >>> (strnow - now) < 1
1925 1925 True
1926 1926 >>> tz == strtz
1927 1927 True
1928 1928 """
1929 1929 if bias is None:
1930 1930 bias = {}
1931 1931 if not date:
1932 1932 return 0, 0
1933 1933 if isinstance(date, tuple) and len(date) == 2:
1934 1934 return date
1935 1935 if not formats:
1936 1936 formats = defaultdateformats
1937 1937 date = date.strip()
1938 1938
1939 1939 if date == 'now' or date == _('now'):
1940 1940 return makedate()
1941 1941 if date == 'today' or date == _('today'):
1942 1942 date = datetime.date.today().strftime('%b %d')
1943 1943 elif date == 'yesterday' or date == _('yesterday'):
1944 1944 date = (datetime.date.today() -
1945 1945 datetime.timedelta(days=1)).strftime('%b %d')
1946 1946
1947 1947 try:
1948 1948 when, offset = map(int, date.split(' '))
1949 1949 except ValueError:
1950 1950 # fill out defaults
1951 1951 now = makedate()
1952 1952 defaults = {}
1953 1953 for part in ("d", "mb", "yY", "HI", "M", "S"):
1954 1954 # this piece is for rounding the specific end of unknowns
1955 1955 b = bias.get(part)
1956 1956 if b is None:
1957 1957 if part[0] in "HMS":
1958 1958 b = "00"
1959 1959 else:
1960 1960 b = "0"
1961 1961
1962 1962 # this piece is for matching the generic end to today's date
1963 1963 n = datestr(now, "%" + part[0])
1964 1964
1965 1965 defaults[part] = (b, n)
1966 1966
1967 1967 for format in formats:
1968 1968 try:
1969 1969 when, offset = strdate(date, format, defaults)
1970 1970 except (ValueError, OverflowError):
1971 1971 pass
1972 1972 else:
1973 1973 break
1974 1974 else:
1975 1975 raise Abort(_('invalid date: %r') % date)
1976 1976 # validate explicit (probably user-specified) date and
1977 1977 # time zone offset. values must fit in signed 32 bits for
1978 1978 # current 32-bit linux runtimes. timezones go from UTC-12
1979 1979 # to UTC+14
1980 1980 if when < -0x80000000 or when > 0x7fffffff:
1981 1981 raise Abort(_('date exceeds 32 bits: %d') % when)
1982 1982 if offset < -50400 or offset > 43200:
1983 1983 raise Abort(_('impossible time zone offset: %d') % offset)
1984 1984 return when, offset
1985 1985
1986 1986 def matchdate(date):
1987 1987 """Return a function that matches a given date match specifier
1988 1988
1989 1989 Formats include:
1990 1990
1991 1991 '{date}' match a given date to the accuracy provided
1992 1992
1993 1993 '<{date}' on or before a given date
1994 1994
1995 1995 '>{date}' on or after a given date
1996 1996
1997 1997 >>> p1 = parsedate("10:29:59")
1998 1998 >>> p2 = parsedate("10:30:00")
1999 1999 >>> p3 = parsedate("10:30:59")
2000 2000 >>> p4 = parsedate("10:31:00")
2001 2001 >>> p5 = parsedate("Sep 15 10:30:00 1999")
2002 2002 >>> f = matchdate("10:30")
2003 2003 >>> f(p1[0])
2004 2004 False
2005 2005 >>> f(p2[0])
2006 2006 True
2007 2007 >>> f(p3[0])
2008 2008 True
2009 2009 >>> f(p4[0])
2010 2010 False
2011 2011 >>> f(p5[0])
2012 2012 False
2013 2013 """
2014 2014
2015 2015 def lower(date):
2016 2016 d = {'mb': "1", 'd': "1"}
2017 2017 return parsedate(date, extendeddateformats, d)[0]
2018 2018
2019 2019 def upper(date):
2020 2020 d = {'mb': "12", 'HI': "23", 'M': "59", 'S': "59"}
2021 2021 for days in ("31", "30", "29"):
2022 2022 try:
2023 2023 d["d"] = days
2024 2024 return parsedate(date, extendeddateformats, d)[0]
2025 2025 except Abort:
2026 2026 pass
2027 2027 d["d"] = "28"
2028 2028 return parsedate(date, extendeddateformats, d)[0]
2029 2029
2030 2030 date = date.strip()
2031 2031
2032 2032 if not date:
2033 2033 raise Abort(_("dates cannot consist entirely of whitespace"))
2034 2034 elif date[0] == "<":
2035 2035 if not date[1:]:
2036 2036 raise Abort(_("invalid day spec, use '<DATE'"))
2037 2037 when = upper(date[1:])
2038 2038 return lambda x: x <= when
2039 2039 elif date[0] == ">":
2040 2040 if not date[1:]:
2041 2041 raise Abort(_("invalid day spec, use '>DATE'"))
2042 2042 when = lower(date[1:])
2043 2043 return lambda x: x >= when
2044 2044 elif date[0] == "-":
2045 2045 try:
2046 2046 days = int(date[1:])
2047 2047 except ValueError:
2048 2048 raise Abort(_("invalid day spec: %s") % date[1:])
2049 2049 if days < 0:
2050 2050 raise Abort(_("%s must be nonnegative (see 'hg help dates')")
2051 2051 % date[1:])
2052 2052 when = makedate()[0] - days * 3600 * 24
2053 2053 return lambda x: x >= when
2054 2054 elif " to " in date:
2055 2055 a, b = date.split(" to ")
2056 2056 start, stop = lower(a), upper(b)
2057 2057 return lambda x: x >= start and x <= stop
2058 2058 else:
2059 2059 start, stop = lower(date), upper(date)
2060 2060 return lambda x: x >= start and x <= stop
2061 2061
2062 2062 def stringmatcher(pattern, casesensitive=True):
2063 2063 """
2064 2064 accepts a string, possibly starting with 're:' or 'literal:' prefix.
2065 2065 returns the matcher name, pattern, and matcher function.
2066 2066 missing or unknown prefixes are treated as literal matches.
2067 2067
2068 2068 helper for tests:
2069 2069 >>> def test(pattern, *tests):
2070 2070 ... kind, pattern, matcher = stringmatcher(pattern)
2071 2071 ... return (kind, pattern, [bool(matcher(t)) for t in tests])
2072 2072 >>> def itest(pattern, *tests):
2073 2073 ... kind, pattern, matcher = stringmatcher(pattern, casesensitive=False)
2074 2074 ... return (kind, pattern, [bool(matcher(t)) for t in tests])
2075 2075
2076 2076 exact matching (no prefix):
2077 2077 >>> test('abcdefg', 'abc', 'def', 'abcdefg')
2078 2078 ('literal', 'abcdefg', [False, False, True])
2079 2079
2080 2080 regex matching ('re:' prefix)
2081 2081 >>> test('re:a.+b', 'nomatch', 'fooadef', 'fooadefbar')
2082 2082 ('re', 'a.+b', [False, False, True])
2083 2083
2084 2084 force exact matches ('literal:' prefix)
2085 2085 >>> test('literal:re:foobar', 'foobar', 're:foobar')
2086 2086 ('literal', 're:foobar', [False, True])
2087 2087
2088 2088 unknown prefixes are ignored and treated as literals
2089 2089 >>> test('foo:bar', 'foo', 'bar', 'foo:bar')
2090 2090 ('literal', 'foo:bar', [False, False, True])
2091 2091
2092 2092 case insensitive regex matches
2093 2093 >>> itest('re:A.+b', 'nomatch', 'fooadef', 'fooadefBar')
2094 2094 ('re', 'A.+b', [False, False, True])
2095 2095
2096 2096 case insensitive literal matches
2097 2097 >>> itest('ABCDEFG', 'abc', 'def', 'abcdefg')
2098 2098 ('literal', 'ABCDEFG', [False, False, True])
2099 2099 """
2100 2100 if pattern.startswith('re:'):
2101 2101 pattern = pattern[3:]
2102 2102 try:
2103 2103 flags = 0
2104 2104 if not casesensitive:
2105 2105 flags = remod.I
2106 2106 regex = remod.compile(pattern, flags)
2107 2107 except remod.error as e:
2108 2108 raise error.ParseError(_('invalid regular expression: %s')
2109 2109 % e)
2110 2110 return 're', pattern, regex.search
2111 2111 elif pattern.startswith('literal:'):
2112 2112 pattern = pattern[8:]
2113 2113
2114 2114 match = pattern.__eq__
2115 2115
2116 2116 if not casesensitive:
2117 2117 ipat = encoding.lower(pattern)
2118 2118 match = lambda s: ipat == encoding.lower(s)
2119 2119 return 'literal', pattern, match
2120 2120
2121 2121 def shortuser(user):
2122 2122 """Return a short representation of a user name or email address."""
2123 2123 f = user.find('@')
2124 2124 if f >= 0:
2125 2125 user = user[:f]
2126 2126 f = user.find('<')
2127 2127 if f >= 0:
2128 2128 user = user[f + 1:]
2129 2129 f = user.find(' ')
2130 2130 if f >= 0:
2131 2131 user = user[:f]
2132 2132 f = user.find('.')
2133 2133 if f >= 0:
2134 2134 user = user[:f]
2135 2135 return user
2136 2136
2137 2137 def emailuser(user):
2138 2138 """Return the user portion of an email address."""
2139 2139 f = user.find('@')
2140 2140 if f >= 0:
2141 2141 user = user[:f]
2142 2142 f = user.find('<')
2143 2143 if f >= 0:
2144 2144 user = user[f + 1:]
2145 2145 return user
2146 2146
2147 2147 def email(author):
2148 2148 '''get email of author.'''
2149 2149 r = author.find('>')
2150 2150 if r == -1:
2151 2151 r = None
2152 2152 return author[author.find('<') + 1:r]
2153 2153
2154 2154 def ellipsis(text, maxlength=400):
2155 2155 """Trim string to at most maxlength (default: 400) columns in display."""
2156 2156 return encoding.trim(text, maxlength, ellipsis='...')
2157 2157
2158 2158 def unitcountfn(*unittable):
2159 2159 '''return a function that renders a readable count of some quantity'''
2160 2160
2161 2161 def go(count):
2162 2162 for multiplier, divisor, format in unittable:
2163 2163 if count >= divisor * multiplier:
2164 2164 return format % (count / float(divisor))
2165 2165 return unittable[-1][2] % count
2166 2166
2167 2167 return go
2168 2168
2169 2169 def processlinerange(fromline, toline):
2170 2170 """Check that linerange <fromline>:<toline> makes sense and return a
2171 2171 0-based range.
2172 2172
2173 2173 >>> processlinerange(10, 20)
2174 2174 (9, 20)
2175 2175 >>> processlinerange(2, 1)
2176 2176 Traceback (most recent call last):
2177 2177 ...
2178 2178 ParseError: line range must be positive
2179 2179 >>> processlinerange(0, 5)
2180 2180 Traceback (most recent call last):
2181 2181 ...
2182 2182 ParseError: fromline must be strictly positive
2183 2183 """
2184 2184 if toline - fromline < 0:
2185 2185 raise error.ParseError(_("line range must be positive"))
2186 2186 if fromline < 1:
2187 2187 raise error.ParseError(_("fromline must be strictly positive"))
2188 2188 return fromline - 1, toline
2189 2189
2190 2190 bytecount = unitcountfn(
2191 2191 (100, 1 << 30, _('%.0f GB')),
2192 2192 (10, 1 << 30, _('%.1f GB')),
2193 2193 (1, 1 << 30, _('%.2f GB')),
2194 2194 (100, 1 << 20, _('%.0f MB')),
2195 2195 (10, 1 << 20, _('%.1f MB')),
2196 2196 (1, 1 << 20, _('%.2f MB')),
2197 2197 (100, 1 << 10, _('%.0f KB')),
2198 2198 (10, 1 << 10, _('%.1f KB')),
2199 2199 (1, 1 << 10, _('%.2f KB')),
2200 2200 (1, 1, _('%.0f bytes')),
2201 2201 )
2202 2202
2203 # Matches a single EOL which can either be a CRLF where repeated CR
2204 # are removed or a LF. We do not care about old Macintosh files, so a
2205 # stray CR is an error.
2206 _eolre = remod.compile(br'\r*\n')
2207
2208 def tolf(s):
2209 return _eolre.sub('\n', s)
2210
2211 def tocrlf(s):
2212 return _eolre.sub('\r\n', s)
2213
2203 2214 def escapestr(s):
2204 2215 # call underlying function of s.encode('string_escape') directly for
2205 2216 # Python 3 compatibility
2206 2217 return codecs.escape_encode(s)[0]
2207 2218
2208 2219 def unescapestr(s):
2209 2220 return codecs.escape_decode(s)[0]
2210 2221
2211 2222 def uirepr(s):
2212 2223 # Avoid double backslash in Windows path repr()
2213 2224 return repr(s).replace('\\\\', '\\')
2214 2225
2215 2226 # delay import of textwrap
2216 2227 def MBTextWrapper(**kwargs):
2217 2228 class tw(textwrap.TextWrapper):
2218 2229 """
2219 2230 Extend TextWrapper for width-awareness.
2220 2231
2221 2232 Neither number of 'bytes' in any encoding nor 'characters' is
2222 2233 appropriate to calculate terminal columns for specified string.
2223 2234
2224 2235 Original TextWrapper implementation uses built-in 'len()' directly,
2225 2236 so overriding is needed to use width information of each characters.
2226 2237
2227 2238 In addition, characters classified into 'ambiguous' width are
2228 2239 treated as wide in East Asian area, but as narrow in other.
2229 2240
2230 2241 This requires use decision to determine width of such characters.
2231 2242 """
2232 2243 def _cutdown(self, ucstr, space_left):
2233 2244 l = 0
2234 2245 colwidth = encoding.ucolwidth
2235 2246 for i in xrange(len(ucstr)):
2236 2247 l += colwidth(ucstr[i])
2237 2248 if space_left < l:
2238 2249 return (ucstr[:i], ucstr[i:])
2239 2250 return ucstr, ''
2240 2251
2241 2252 # overriding of base class
2242 2253 def _handle_long_word(self, reversed_chunks, cur_line, cur_len, width):
2243 2254 space_left = max(width - cur_len, 1)
2244 2255
2245 2256 if self.break_long_words:
2246 2257 cut, res = self._cutdown(reversed_chunks[-1], space_left)
2247 2258 cur_line.append(cut)
2248 2259 reversed_chunks[-1] = res
2249 2260 elif not cur_line:
2250 2261 cur_line.append(reversed_chunks.pop())
2251 2262
2252 2263 # this overriding code is imported from TextWrapper of Python 2.6
2253 2264 # to calculate columns of string by 'encoding.ucolwidth()'
2254 2265 def _wrap_chunks(self, chunks):
2255 2266 colwidth = encoding.ucolwidth
2256 2267
2257 2268 lines = []
2258 2269 if self.width <= 0:
2259 2270 raise ValueError("invalid width %r (must be > 0)" % self.width)
2260 2271
2261 2272 # Arrange in reverse order so items can be efficiently popped
2262 2273 # from a stack of chucks.
2263 2274 chunks.reverse()
2264 2275
2265 2276 while chunks:
2266 2277
2267 2278 # Start the list of chunks that will make up the current line.
2268 2279 # cur_len is just the length of all the chunks in cur_line.
2269 2280 cur_line = []
2270 2281 cur_len = 0
2271 2282
2272 2283 # Figure out which static string will prefix this line.
2273 2284 if lines:
2274 2285 indent = self.subsequent_indent
2275 2286 else:
2276 2287 indent = self.initial_indent
2277 2288
2278 2289 # Maximum width for this line.
2279 2290 width = self.width - len(indent)
2280 2291
2281 2292 # First chunk on line is whitespace -- drop it, unless this
2282 2293 # is the very beginning of the text (i.e. no lines started yet).
2283 2294 if self.drop_whitespace and chunks[-1].strip() == '' and lines:
2284 2295 del chunks[-1]
2285 2296
2286 2297 while chunks:
2287 2298 l = colwidth(chunks[-1])
2288 2299
2289 2300 # Can at least squeeze this chunk onto the current line.
2290 2301 if cur_len + l <= width:
2291 2302 cur_line.append(chunks.pop())
2292 2303 cur_len += l
2293 2304
2294 2305 # Nope, this line is full.
2295 2306 else:
2296 2307 break
2297 2308
2298 2309 # The current line is full, and the next chunk is too big to
2299 2310 # fit on *any* line (not just this one).
2300 2311 if chunks and colwidth(chunks[-1]) > width:
2301 2312 self._handle_long_word(chunks, cur_line, cur_len, width)
2302 2313
2303 2314 # If the last chunk on this line is all whitespace, drop it.
2304 2315 if (self.drop_whitespace and
2305 2316 cur_line and cur_line[-1].strip() == ''):
2306 2317 del cur_line[-1]
2307 2318
2308 2319 # Convert current line back to a string and store it in list
2309 2320 # of all lines (return value).
2310 2321 if cur_line:
2311 2322 lines.append(indent + ''.join(cur_line))
2312 2323
2313 2324 return lines
2314 2325
2315 2326 global MBTextWrapper
2316 2327 MBTextWrapper = tw
2317 2328 return tw(**kwargs)
2318 2329
2319 2330 def wrap(line, width, initindent='', hangindent=''):
2320 2331 maxindent = max(len(hangindent), len(initindent))
2321 2332 if width <= maxindent:
2322 2333 # adjust for weird terminal size
2323 2334 width = max(78, maxindent + 1)
2324 2335 line = line.decode(pycompat.sysstr(encoding.encoding),
2325 2336 pycompat.sysstr(encoding.encodingmode))
2326 2337 initindent = initindent.decode(pycompat.sysstr(encoding.encoding),
2327 2338 pycompat.sysstr(encoding.encodingmode))
2328 2339 hangindent = hangindent.decode(pycompat.sysstr(encoding.encoding),
2329 2340 pycompat.sysstr(encoding.encodingmode))
2330 2341 wrapper = MBTextWrapper(width=width,
2331 2342 initial_indent=initindent,
2332 2343 subsequent_indent=hangindent)
2333 2344 return wrapper.fill(line).encode(pycompat.sysstr(encoding.encoding))
2334 2345
2335 2346 if (pyplatform.python_implementation() == 'CPython' and
2336 2347 sys.version_info < (3, 0)):
2337 2348 # There is an issue in CPython that some IO methods do not handle EINTR
2338 2349 # correctly. The following table shows what CPython version (and functions)
2339 2350 # are affected (buggy: has the EINTR bug, okay: otherwise):
2340 2351 #
2341 2352 # | < 2.7.4 | 2.7.4 to 2.7.12 | >= 3.0
2342 2353 # --------------------------------------------------
2343 2354 # fp.__iter__ | buggy | buggy | okay
2344 2355 # fp.read* | buggy | okay [1] | okay
2345 2356 #
2346 2357 # [1]: fixed by changeset 67dc99a989cd in the cpython hg repo.
2347 2358 #
2348 2359 # Here we workaround the EINTR issue for fileobj.__iter__. Other methods
2349 2360 # like "read*" are ignored for now, as Python < 2.7.4 is a minority.
2350 2361 #
2351 2362 # Although we can workaround the EINTR issue for fp.__iter__, it is slower:
2352 2363 # "for x in fp" is 4x faster than "for x in iter(fp.readline, '')" in
2353 2364 # CPython 2, because CPython 2 maintains an internal readahead buffer for
2354 2365 # fp.__iter__ but not other fp.read* methods.
2355 2366 #
2356 2367 # On modern systems like Linux, the "read" syscall cannot be interrupted
2357 2368 # when reading "fast" files like on-disk files. So the EINTR issue only
2358 2369 # affects things like pipes, sockets, ttys etc. We treat "normal" (S_ISREG)
2359 2370 # files approximately as "fast" files and use the fast (unsafe) code path,
2360 2371 # to minimize the performance impact.
2361 2372 if sys.version_info >= (2, 7, 4):
2362 2373 # fp.readline deals with EINTR correctly, use it as a workaround.
2363 2374 def _safeiterfile(fp):
2364 2375 return iter(fp.readline, '')
2365 2376 else:
2366 2377 # fp.read* are broken too, manually deal with EINTR in a stupid way.
2367 2378 # note: this may block longer than necessary because of bufsize.
2368 2379 def _safeiterfile(fp, bufsize=4096):
2369 2380 fd = fp.fileno()
2370 2381 line = ''
2371 2382 while True:
2372 2383 try:
2373 2384 buf = os.read(fd, bufsize)
2374 2385 except OSError as ex:
2375 2386 # os.read only raises EINTR before any data is read
2376 2387 if ex.errno == errno.EINTR:
2377 2388 continue
2378 2389 else:
2379 2390 raise
2380 2391 line += buf
2381 2392 if '\n' in buf:
2382 2393 splitted = line.splitlines(True)
2383 2394 line = ''
2384 2395 for l in splitted:
2385 2396 if l[-1] == '\n':
2386 2397 yield l
2387 2398 else:
2388 2399 line = l
2389 2400 if not buf:
2390 2401 break
2391 2402 if line:
2392 2403 yield line
2393 2404
2394 2405 def iterfile(fp):
2395 2406 fastpath = True
2396 2407 if type(fp) is file:
2397 2408 fastpath = stat.S_ISREG(os.fstat(fp.fileno()).st_mode)
2398 2409 if fastpath:
2399 2410 return fp
2400 2411 else:
2401 2412 return _safeiterfile(fp)
2402 2413 else:
2403 2414 # PyPy and CPython 3 do not have the EINTR issue thus no workaround needed.
2404 2415 def iterfile(fp):
2405 2416 return fp
2406 2417
2407 2418 def iterlines(iterator):
2408 2419 for chunk in iterator:
2409 2420 for line in chunk.splitlines():
2410 2421 yield line
2411 2422
2412 2423 def expandpath(path):
2413 2424 return os.path.expanduser(os.path.expandvars(path))
2414 2425
2415 2426 def hgcmd():
2416 2427 """Return the command used to execute current hg
2417 2428
2418 2429 This is different from hgexecutable() because on Windows we want
2419 2430 to avoid things opening new shell windows like batch files, so we
2420 2431 get either the python call or current executable.
2421 2432 """
2422 2433 if mainfrozen():
2423 2434 if getattr(sys, 'frozen', None) == 'macosx_app':
2424 2435 # Env variable set by py2app
2425 2436 return [encoding.environ['EXECUTABLEPATH']]
2426 2437 else:
2427 2438 return [pycompat.sysexecutable]
2428 2439 return gethgcmd()
2429 2440
2430 2441 def rundetached(args, condfn):
2431 2442 """Execute the argument list in a detached process.
2432 2443
2433 2444 condfn is a callable which is called repeatedly and should return
2434 2445 True once the child process is known to have started successfully.
2435 2446 At this point, the child process PID is returned. If the child
2436 2447 process fails to start or finishes before condfn() evaluates to
2437 2448 True, return -1.
2438 2449 """
2439 2450 # Windows case is easier because the child process is either
2440 2451 # successfully starting and validating the condition or exiting
2441 2452 # on failure. We just poll on its PID. On Unix, if the child
2442 2453 # process fails to start, it will be left in a zombie state until
2443 2454 # the parent wait on it, which we cannot do since we expect a long
2444 2455 # running process on success. Instead we listen for SIGCHLD telling
2445 2456 # us our child process terminated.
2446 2457 terminated = set()
2447 2458 def handler(signum, frame):
2448 2459 terminated.add(os.wait())
2449 2460 prevhandler = None
2450 2461 SIGCHLD = getattr(signal, 'SIGCHLD', None)
2451 2462 if SIGCHLD is not None:
2452 2463 prevhandler = signal.signal(SIGCHLD, handler)
2453 2464 try:
2454 2465 pid = spawndetached(args)
2455 2466 while not condfn():
2456 2467 if ((pid in terminated or not testpid(pid))
2457 2468 and not condfn()):
2458 2469 return -1
2459 2470 time.sleep(0.1)
2460 2471 return pid
2461 2472 finally:
2462 2473 if prevhandler is not None:
2463 2474 signal.signal(signal.SIGCHLD, prevhandler)
2464 2475
2465 2476 def interpolate(prefix, mapping, s, fn=None, escape_prefix=False):
2466 2477 """Return the result of interpolating items in the mapping into string s.
2467 2478
2468 2479 prefix is a single character string, or a two character string with
2469 2480 a backslash as the first character if the prefix needs to be escaped in
2470 2481 a regular expression.
2471 2482
2472 2483 fn is an optional function that will be applied to the replacement text
2473 2484 just before replacement.
2474 2485
2475 2486 escape_prefix is an optional flag that allows using doubled prefix for
2476 2487 its escaping.
2477 2488 """
2478 2489 fn = fn or (lambda s: s)
2479 2490 patterns = '|'.join(mapping.keys())
2480 2491 if escape_prefix:
2481 2492 patterns += '|' + prefix
2482 2493 if len(prefix) > 1:
2483 2494 prefix_char = prefix[1:]
2484 2495 else:
2485 2496 prefix_char = prefix
2486 2497 mapping[prefix_char] = prefix_char
2487 2498 r = remod.compile(r'%s(%s)' % (prefix, patterns))
2488 2499 return r.sub(lambda x: fn(mapping[x.group()[1:]]), s)
2489 2500
2490 2501 def getport(port):
2491 2502 """Return the port for a given network service.
2492 2503
2493 2504 If port is an integer, it's returned as is. If it's a string, it's
2494 2505 looked up using socket.getservbyname(). If there's no matching
2495 2506 service, error.Abort is raised.
2496 2507 """
2497 2508 try:
2498 2509 return int(port)
2499 2510 except ValueError:
2500 2511 pass
2501 2512
2502 2513 try:
2503 2514 return socket.getservbyname(port)
2504 2515 except socket.error:
2505 2516 raise Abort(_("no port number associated with service '%s'") % port)
2506 2517
2507 2518 _booleans = {'1': True, 'yes': True, 'true': True, 'on': True, 'always': True,
2508 2519 '0': False, 'no': False, 'false': False, 'off': False,
2509 2520 'never': False}
2510 2521
2511 2522 def parsebool(s):
2512 2523 """Parse s into a boolean.
2513 2524
2514 2525 If s is not a valid boolean, returns None.
2515 2526 """
2516 2527 return _booleans.get(s.lower(), None)
2517 2528
2518 2529 _hextochr = dict((a + b, chr(int(a + b, 16)))
2519 2530 for a in string.hexdigits for b in string.hexdigits)
2520 2531
2521 2532 class url(object):
2522 2533 r"""Reliable URL parser.
2523 2534
2524 2535 This parses URLs and provides attributes for the following
2525 2536 components:
2526 2537
2527 2538 <scheme>://<user>:<passwd>@<host>:<port>/<path>?<query>#<fragment>
2528 2539
2529 2540 Missing components are set to None. The only exception is
2530 2541 fragment, which is set to '' if present but empty.
2531 2542
2532 2543 If parsefragment is False, fragment is included in query. If
2533 2544 parsequery is False, query is included in path. If both are
2534 2545 False, both fragment and query are included in path.
2535 2546
2536 2547 See http://www.ietf.org/rfc/rfc2396.txt for more information.
2537 2548
2538 2549 Note that for backward compatibility reasons, bundle URLs do not
2539 2550 take host names. That means 'bundle://../' has a path of '../'.
2540 2551
2541 2552 Examples:
2542 2553
2543 2554 >>> url('http://www.ietf.org/rfc/rfc2396.txt')
2544 2555 <url scheme: 'http', host: 'www.ietf.org', path: 'rfc/rfc2396.txt'>
2545 2556 >>> url('ssh://[::1]:2200//home/joe/repo')
2546 2557 <url scheme: 'ssh', host: '[::1]', port: '2200', path: '/home/joe/repo'>
2547 2558 >>> url('file:///home/joe/repo')
2548 2559 <url scheme: 'file', path: '/home/joe/repo'>
2549 2560 >>> url('file:///c:/temp/foo/')
2550 2561 <url scheme: 'file', path: 'c:/temp/foo/'>
2551 2562 >>> url('bundle:foo')
2552 2563 <url scheme: 'bundle', path: 'foo'>
2553 2564 >>> url('bundle://../foo')
2554 2565 <url scheme: 'bundle', path: '../foo'>
2555 2566 >>> url(r'c:\foo\bar')
2556 2567 <url path: 'c:\\foo\\bar'>
2557 2568 >>> url(r'\\blah\blah\blah')
2558 2569 <url path: '\\\\blah\\blah\\blah'>
2559 2570 >>> url(r'\\blah\blah\blah#baz')
2560 2571 <url path: '\\\\blah\\blah\\blah', fragment: 'baz'>
2561 2572 >>> url(r'file:///C:\users\me')
2562 2573 <url scheme: 'file', path: 'C:\\users\\me'>
2563 2574
2564 2575 Authentication credentials:
2565 2576
2566 2577 >>> url('ssh://joe:xyz@x/repo')
2567 2578 <url scheme: 'ssh', user: 'joe', passwd: 'xyz', host: 'x', path: 'repo'>
2568 2579 >>> url('ssh://joe@x/repo')
2569 2580 <url scheme: 'ssh', user: 'joe', host: 'x', path: 'repo'>
2570 2581
2571 2582 Query strings and fragments:
2572 2583
2573 2584 >>> url('http://host/a?b#c')
2574 2585 <url scheme: 'http', host: 'host', path: 'a', query: 'b', fragment: 'c'>
2575 2586 >>> url('http://host/a?b#c', parsequery=False, parsefragment=False)
2576 2587 <url scheme: 'http', host: 'host', path: 'a?b#c'>
2577 2588
2578 2589 Empty path:
2579 2590
2580 2591 >>> url('')
2581 2592 <url path: ''>
2582 2593 >>> url('#a')
2583 2594 <url path: '', fragment: 'a'>
2584 2595 >>> url('http://host/')
2585 2596 <url scheme: 'http', host: 'host', path: ''>
2586 2597 >>> url('http://host/#a')
2587 2598 <url scheme: 'http', host: 'host', path: '', fragment: 'a'>
2588 2599
2589 2600 Only scheme:
2590 2601
2591 2602 >>> url('http:')
2592 2603 <url scheme: 'http'>
2593 2604 """
2594 2605
2595 2606 _safechars = "!~*'()+"
2596 2607 _safepchars = "/!~*'()+:\\"
2597 2608 _matchscheme = remod.compile('^[a-zA-Z0-9+.\\-]+:').match
2598 2609
2599 2610 def __init__(self, path, parsequery=True, parsefragment=True):
2600 2611 # We slowly chomp away at path until we have only the path left
2601 2612 self.scheme = self.user = self.passwd = self.host = None
2602 2613 self.port = self.path = self.query = self.fragment = None
2603 2614 self._localpath = True
2604 2615 self._hostport = ''
2605 2616 self._origpath = path
2606 2617
2607 2618 if parsefragment and '#' in path:
2608 2619 path, self.fragment = path.split('#', 1)
2609 2620
2610 2621 # special case for Windows drive letters and UNC paths
2611 2622 if hasdriveletter(path) or path.startswith('\\\\'):
2612 2623 self.path = path
2613 2624 return
2614 2625
2615 2626 # For compatibility reasons, we can't handle bundle paths as
2616 2627 # normal URLS
2617 2628 if path.startswith('bundle:'):
2618 2629 self.scheme = 'bundle'
2619 2630 path = path[7:]
2620 2631 if path.startswith('//'):
2621 2632 path = path[2:]
2622 2633 self.path = path
2623 2634 return
2624 2635
2625 2636 if self._matchscheme(path):
2626 2637 parts = path.split(':', 1)
2627 2638 if parts[0]:
2628 2639 self.scheme, path = parts
2629 2640 self._localpath = False
2630 2641
2631 2642 if not path:
2632 2643 path = None
2633 2644 if self._localpath:
2634 2645 self.path = ''
2635 2646 return
2636 2647 else:
2637 2648 if self._localpath:
2638 2649 self.path = path
2639 2650 return
2640 2651
2641 2652 if parsequery and '?' in path:
2642 2653 path, self.query = path.split('?', 1)
2643 2654 if not path:
2644 2655 path = None
2645 2656 if not self.query:
2646 2657 self.query = None
2647 2658
2648 2659 # // is required to specify a host/authority
2649 2660 if path and path.startswith('//'):
2650 2661 parts = path[2:].split('/', 1)
2651 2662 if len(parts) > 1:
2652 2663 self.host, path = parts
2653 2664 else:
2654 2665 self.host = parts[0]
2655 2666 path = None
2656 2667 if not self.host:
2657 2668 self.host = None
2658 2669 # path of file:///d is /d
2659 2670 # path of file:///d:/ is d:/, not /d:/
2660 2671 if path and not hasdriveletter(path):
2661 2672 path = '/' + path
2662 2673
2663 2674 if self.host and '@' in self.host:
2664 2675 self.user, self.host = self.host.rsplit('@', 1)
2665 2676 if ':' in self.user:
2666 2677 self.user, self.passwd = self.user.split(':', 1)
2667 2678 if not self.host:
2668 2679 self.host = None
2669 2680
2670 2681 # Don't split on colons in IPv6 addresses without ports
2671 2682 if (self.host and ':' in self.host and
2672 2683 not (self.host.startswith('[') and self.host.endswith(']'))):
2673 2684 self._hostport = self.host
2674 2685 self.host, self.port = self.host.rsplit(':', 1)
2675 2686 if not self.host:
2676 2687 self.host = None
2677 2688
2678 2689 if (self.host and self.scheme == 'file' and
2679 2690 self.host not in ('localhost', '127.0.0.1', '[::1]')):
2680 2691 raise Abort(_('file:// URLs can only refer to localhost'))
2681 2692
2682 2693 self.path = path
2683 2694
2684 2695 # leave the query string escaped
2685 2696 for a in ('user', 'passwd', 'host', 'port',
2686 2697 'path', 'fragment'):
2687 2698 v = getattr(self, a)
2688 2699 if v is not None:
2689 2700 setattr(self, a, urlreq.unquote(v))
2690 2701
2691 2702 def __repr__(self):
2692 2703 attrs = []
2693 2704 for a in ('scheme', 'user', 'passwd', 'host', 'port', 'path',
2694 2705 'query', 'fragment'):
2695 2706 v = getattr(self, a)
2696 2707 if v is not None:
2697 2708 attrs.append('%s: %r' % (a, v))
2698 2709 return '<url %s>' % ', '.join(attrs)
2699 2710
2700 2711 def __str__(self):
2701 2712 r"""Join the URL's components back into a URL string.
2702 2713
2703 2714 Examples:
2704 2715
2705 2716 >>> str(url('http://user:pw@host:80/c:/bob?fo:oo#ba:ar'))
2706 2717 'http://user:pw@host:80/c:/bob?fo:oo#ba:ar'
2707 2718 >>> str(url('http://user:pw@host:80/?foo=bar&baz=42'))
2708 2719 'http://user:pw@host:80/?foo=bar&baz=42'
2709 2720 >>> str(url('http://user:pw@host:80/?foo=bar%3dbaz'))
2710 2721 'http://user:pw@host:80/?foo=bar%3dbaz'
2711 2722 >>> str(url('ssh://user:pw@[::1]:2200//home/joe#'))
2712 2723 'ssh://user:pw@[::1]:2200//home/joe#'
2713 2724 >>> str(url('http://localhost:80//'))
2714 2725 'http://localhost:80//'
2715 2726 >>> str(url('http://localhost:80/'))
2716 2727 'http://localhost:80/'
2717 2728 >>> str(url('http://localhost:80'))
2718 2729 'http://localhost:80/'
2719 2730 >>> str(url('bundle:foo'))
2720 2731 'bundle:foo'
2721 2732 >>> str(url('bundle://../foo'))
2722 2733 'bundle:../foo'
2723 2734 >>> str(url('path'))
2724 2735 'path'
2725 2736 >>> str(url('file:///tmp/foo/bar'))
2726 2737 'file:///tmp/foo/bar'
2727 2738 >>> str(url('file:///c:/tmp/foo/bar'))
2728 2739 'file:///c:/tmp/foo/bar'
2729 2740 >>> print url(r'bundle:foo\bar')
2730 2741 bundle:foo\bar
2731 2742 >>> print url(r'file:///D:\data\hg')
2732 2743 file:///D:\data\hg
2733 2744 """
2734 2745 return encoding.strfromlocal(self.__bytes__())
2735 2746
2736 2747 def __bytes__(self):
2737 2748 if self._localpath:
2738 2749 s = self.path
2739 2750 if self.scheme == 'bundle':
2740 2751 s = 'bundle:' + s
2741 2752 if self.fragment:
2742 2753 s += '#' + self.fragment
2743 2754 return s
2744 2755
2745 2756 s = self.scheme + ':'
2746 2757 if self.user or self.passwd or self.host:
2747 2758 s += '//'
2748 2759 elif self.scheme and (not self.path or self.path.startswith('/')
2749 2760 or hasdriveletter(self.path)):
2750 2761 s += '//'
2751 2762 if hasdriveletter(self.path):
2752 2763 s += '/'
2753 2764 if self.user:
2754 2765 s += urlreq.quote(self.user, safe=self._safechars)
2755 2766 if self.passwd:
2756 2767 s += ':' + urlreq.quote(self.passwd, safe=self._safechars)
2757 2768 if self.user or self.passwd:
2758 2769 s += '@'
2759 2770 if self.host:
2760 2771 if not (self.host.startswith('[') and self.host.endswith(']')):
2761 2772 s += urlreq.quote(self.host)
2762 2773 else:
2763 2774 s += self.host
2764 2775 if self.port:
2765 2776 s += ':' + urlreq.quote(self.port)
2766 2777 if self.host:
2767 2778 s += '/'
2768 2779 if self.path:
2769 2780 # TODO: similar to the query string, we should not unescape the
2770 2781 # path when we store it, the path might contain '%2f' = '/',
2771 2782 # which we should *not* escape.
2772 2783 s += urlreq.quote(self.path, safe=self._safepchars)
2773 2784 if self.query:
2774 2785 # we store the query in escaped form.
2775 2786 s += '?' + self.query
2776 2787 if self.fragment is not None:
2777 2788 s += '#' + urlreq.quote(self.fragment, safe=self._safepchars)
2778 2789 return s
2779 2790
2780 2791 def authinfo(self):
2781 2792 user, passwd = self.user, self.passwd
2782 2793 try:
2783 2794 self.user, self.passwd = None, None
2784 2795 s = str(self)
2785 2796 finally:
2786 2797 self.user, self.passwd = user, passwd
2787 2798 if not self.user:
2788 2799 return (s, None)
2789 2800 # authinfo[1] is passed to urllib2 password manager, and its
2790 2801 # URIs must not contain credentials. The host is passed in the
2791 2802 # URIs list because Python < 2.4.3 uses only that to search for
2792 2803 # a password.
2793 2804 return (s, (None, (s, self.host),
2794 2805 self.user, self.passwd or ''))
2795 2806
2796 2807 def isabs(self):
2797 2808 if self.scheme and self.scheme != 'file':
2798 2809 return True # remote URL
2799 2810 if hasdriveletter(self.path):
2800 2811 return True # absolute for our purposes - can't be joined()
2801 2812 if self.path.startswith(r'\\'):
2802 2813 return True # Windows UNC path
2803 2814 if self.path.startswith('/'):
2804 2815 return True # POSIX-style
2805 2816 return False
2806 2817
2807 2818 def localpath(self):
2808 2819 if self.scheme == 'file' or self.scheme == 'bundle':
2809 2820 path = self.path or '/'
2810 2821 # For Windows, we need to promote hosts containing drive
2811 2822 # letters to paths with drive letters.
2812 2823 if hasdriveletter(self._hostport):
2813 2824 path = self._hostport + '/' + self.path
2814 2825 elif (self.host is not None and self.path
2815 2826 and not hasdriveletter(path)):
2816 2827 path = '/' + path
2817 2828 return path
2818 2829 return self._origpath
2819 2830
2820 2831 def islocal(self):
2821 2832 '''whether localpath will return something that posixfile can open'''
2822 2833 return (not self.scheme or self.scheme == 'file'
2823 2834 or self.scheme == 'bundle')
2824 2835
2825 2836 def hasscheme(path):
2826 2837 return bool(url(path).scheme)
2827 2838
2828 2839 def hasdriveletter(path):
2829 2840 return path and path[1:2] == ':' and path[0:1].isalpha()
2830 2841
2831 2842 def urllocalpath(path):
2832 2843 return url(path, parsequery=False, parsefragment=False).localpath()
2833 2844
2834 2845 def hidepassword(u):
2835 2846 '''hide user credential in a url string'''
2836 2847 u = url(u)
2837 2848 if u.passwd:
2838 2849 u.passwd = '***'
2839 2850 return str(u)
2840 2851
2841 2852 def removeauth(u):
2842 2853 '''remove all authentication information from a url string'''
2843 2854 u = url(u)
2844 2855 u.user = u.passwd = None
2845 2856 return str(u)
2846 2857
2847 2858 timecount = unitcountfn(
2848 2859 (1, 1e3, _('%.0f s')),
2849 2860 (100, 1, _('%.1f s')),
2850 2861 (10, 1, _('%.2f s')),
2851 2862 (1, 1, _('%.3f s')),
2852 2863 (100, 0.001, _('%.1f ms')),
2853 2864 (10, 0.001, _('%.2f ms')),
2854 2865 (1, 0.001, _('%.3f ms')),
2855 2866 (100, 0.000001, _('%.1f us')),
2856 2867 (10, 0.000001, _('%.2f us')),
2857 2868 (1, 0.000001, _('%.3f us')),
2858 2869 (100, 0.000000001, _('%.1f ns')),
2859 2870 (10, 0.000000001, _('%.2f ns')),
2860 2871 (1, 0.000000001, _('%.3f ns')),
2861 2872 )
2862 2873
2863 2874 _timenesting = [0]
2864 2875
2865 2876 def timed(func):
2866 2877 '''Report the execution time of a function call to stderr.
2867 2878
2868 2879 During development, use as a decorator when you need to measure
2869 2880 the cost of a function, e.g. as follows:
2870 2881
2871 2882 @util.timed
2872 2883 def foo(a, b, c):
2873 2884 pass
2874 2885 '''
2875 2886
2876 2887 def wrapper(*args, **kwargs):
2877 2888 start = timer()
2878 2889 indent = 2
2879 2890 _timenesting[0] += indent
2880 2891 try:
2881 2892 return func(*args, **kwargs)
2882 2893 finally:
2883 2894 elapsed = timer() - start
2884 2895 _timenesting[0] -= indent
2885 2896 stderr.write('%s%s: %s\n' %
2886 2897 (' ' * _timenesting[0], func.__name__,
2887 2898 timecount(elapsed)))
2888 2899 return wrapper
2889 2900
2890 2901 _sizeunits = (('m', 2**20), ('k', 2**10), ('g', 2**30),
2891 2902 ('kb', 2**10), ('mb', 2**20), ('gb', 2**30), ('b', 1))
2892 2903
2893 2904 def sizetoint(s):
2894 2905 '''Convert a space specifier to a byte count.
2895 2906
2896 2907 >>> sizetoint('30')
2897 2908 30
2898 2909 >>> sizetoint('2.2kb')
2899 2910 2252
2900 2911 >>> sizetoint('6M')
2901 2912 6291456
2902 2913 '''
2903 2914 t = s.strip().lower()
2904 2915 try:
2905 2916 for k, u in _sizeunits:
2906 2917 if t.endswith(k):
2907 2918 return int(float(t[:-len(k)]) * u)
2908 2919 return int(t)
2909 2920 except ValueError:
2910 2921 raise error.ParseError(_("couldn't parse size: %s") % s)
2911 2922
2912 2923 class hooks(object):
2913 2924 '''A collection of hook functions that can be used to extend a
2914 2925 function's behavior. Hooks are called in lexicographic order,
2915 2926 based on the names of their sources.'''
2916 2927
2917 2928 def __init__(self):
2918 2929 self._hooks = []
2919 2930
2920 2931 def add(self, source, hook):
2921 2932 self._hooks.append((source, hook))
2922 2933
2923 2934 def __call__(self, *args):
2924 2935 self._hooks.sort(key=lambda x: x[0])
2925 2936 results = []
2926 2937 for source, hook in self._hooks:
2927 2938 results.append(hook(*args))
2928 2939 return results
2929 2940
2930 2941 def getstackframes(skip=0, line=' %-*s in %s\n', fileline='%s:%s', depth=0):
2931 2942 '''Yields lines for a nicely formatted stacktrace.
2932 2943 Skips the 'skip' last entries, then return the last 'depth' entries.
2933 2944 Each file+linenumber is formatted according to fileline.
2934 2945 Each line is formatted according to line.
2935 2946 If line is None, it yields:
2936 2947 length of longest filepath+line number,
2937 2948 filepath+linenumber,
2938 2949 function
2939 2950
2940 2951 Not be used in production code but very convenient while developing.
2941 2952 '''
2942 2953 entries = [(fileline % (fn, ln), func)
2943 2954 for fn, ln, func, _text in traceback.extract_stack()[:-skip - 1]
2944 2955 ][-depth:]
2945 2956 if entries:
2946 2957 fnmax = max(len(entry[0]) for entry in entries)
2947 2958 for fnln, func in entries:
2948 2959 if line is None:
2949 2960 yield (fnmax, fnln, func)
2950 2961 else:
2951 2962 yield line % (fnmax, fnln, func)
2952 2963
2953 2964 def debugstacktrace(msg='stacktrace', skip=0,
2954 2965 f=stderr, otherf=stdout, depth=0):
2955 2966 '''Writes a message to f (stderr) with a nicely formatted stacktrace.
2956 2967 Skips the 'skip' entries closest to the call, then show 'depth' entries.
2957 2968 By default it will flush stdout first.
2958 2969 It can be used everywhere and intentionally does not require an ui object.
2959 2970 Not be used in production code but very convenient while developing.
2960 2971 '''
2961 2972 if otherf:
2962 2973 otherf.flush()
2963 2974 f.write('%s at:\n' % msg.rstrip())
2964 2975 for line in getstackframes(skip + 1, depth=depth):
2965 2976 f.write(line)
2966 2977 f.flush()
2967 2978
2968 2979 class dirs(object):
2969 2980 '''a multiset of directory names from a dirstate or manifest'''
2970 2981
2971 2982 def __init__(self, map, skip=None):
2972 2983 self._dirs = {}
2973 2984 addpath = self.addpath
2974 2985 if safehasattr(map, 'iteritems') and skip is not None:
2975 2986 for f, s in map.iteritems():
2976 2987 if s[0] != skip:
2977 2988 addpath(f)
2978 2989 else:
2979 2990 for f in map:
2980 2991 addpath(f)
2981 2992
2982 2993 def addpath(self, path):
2983 2994 dirs = self._dirs
2984 2995 for base in finddirs(path):
2985 2996 if base in dirs:
2986 2997 dirs[base] += 1
2987 2998 return
2988 2999 dirs[base] = 1
2989 3000
2990 3001 def delpath(self, path):
2991 3002 dirs = self._dirs
2992 3003 for base in finddirs(path):
2993 3004 if dirs[base] > 1:
2994 3005 dirs[base] -= 1
2995 3006 return
2996 3007 del dirs[base]
2997 3008
2998 3009 def __iter__(self):
2999 3010 return iter(self._dirs)
3000 3011
3001 3012 def __contains__(self, d):
3002 3013 return d in self._dirs
3003 3014
3004 3015 if safehasattr(parsers, 'dirs'):
3005 3016 dirs = parsers.dirs
3006 3017
3007 3018 def finddirs(path):
3008 3019 pos = path.rfind('/')
3009 3020 while pos != -1:
3010 3021 yield path[:pos]
3011 3022 pos = path.rfind('/', 0, pos)
3012 3023
3013 3024 class ctxmanager(object):
3014 3025 '''A context manager for use in 'with' blocks to allow multiple
3015 3026 contexts to be entered at once. This is both safer and more
3016 3027 flexible than contextlib.nested.
3017 3028
3018 3029 Once Mercurial supports Python 2.7+, this will become mostly
3019 3030 unnecessary.
3020 3031 '''
3021 3032
3022 3033 def __init__(self, *args):
3023 3034 '''Accepts a list of no-argument functions that return context
3024 3035 managers. These will be invoked at __call__ time.'''
3025 3036 self._pending = args
3026 3037 self._atexit = []
3027 3038
3028 3039 def __enter__(self):
3029 3040 return self
3030 3041
3031 3042 def enter(self):
3032 3043 '''Create and enter context managers in the order in which they were
3033 3044 passed to the constructor.'''
3034 3045 values = []
3035 3046 for func in self._pending:
3036 3047 obj = func()
3037 3048 values.append(obj.__enter__())
3038 3049 self._atexit.append(obj.__exit__)
3039 3050 del self._pending
3040 3051 return values
3041 3052
3042 3053 def atexit(self, func, *args, **kwargs):
3043 3054 '''Add a function to call when this context manager exits. The
3044 3055 ordering of multiple atexit calls is unspecified, save that
3045 3056 they will happen before any __exit__ functions.'''
3046 3057 def wrapper(exc_type, exc_val, exc_tb):
3047 3058 func(*args, **kwargs)
3048 3059 self._atexit.append(wrapper)
3049 3060 return func
3050 3061
3051 3062 def __exit__(self, exc_type, exc_val, exc_tb):
3052 3063 '''Context managers are exited in the reverse order from which
3053 3064 they were created.'''
3054 3065 received = exc_type is not None
3055 3066 suppressed = False
3056 3067 pending = None
3057 3068 self._atexit.reverse()
3058 3069 for exitfunc in self._atexit:
3059 3070 try:
3060 3071 if exitfunc(exc_type, exc_val, exc_tb):
3061 3072 suppressed = True
3062 3073 exc_type = None
3063 3074 exc_val = None
3064 3075 exc_tb = None
3065 3076 except BaseException:
3066 3077 pending = sys.exc_info()
3067 3078 exc_type, exc_val, exc_tb = pending = sys.exc_info()
3068 3079 del self._atexit
3069 3080 if pending:
3070 3081 raise exc_val
3071 3082 return received and suppressed
3072 3083
3073 3084 # compression code
3074 3085
3075 3086 SERVERROLE = 'server'
3076 3087 CLIENTROLE = 'client'
3077 3088
3078 3089 compewireprotosupport = collections.namedtuple(u'compenginewireprotosupport',
3079 3090 (u'name', u'serverpriority',
3080 3091 u'clientpriority'))
3081 3092
3082 3093 class compressormanager(object):
3083 3094 """Holds registrations of various compression engines.
3084 3095
3085 3096 This class essentially abstracts the differences between compression
3086 3097 engines to allow new compression formats to be added easily, possibly from
3087 3098 extensions.
3088 3099
3089 3100 Compressors are registered against the global instance by calling its
3090 3101 ``register()`` method.
3091 3102 """
3092 3103 def __init__(self):
3093 3104 self._engines = {}
3094 3105 # Bundle spec human name to engine name.
3095 3106 self._bundlenames = {}
3096 3107 # Internal bundle identifier to engine name.
3097 3108 self._bundletypes = {}
3098 3109 # Revlog header to engine name.
3099 3110 self._revlogheaders = {}
3100 3111 # Wire proto identifier to engine name.
3101 3112 self._wiretypes = {}
3102 3113
3103 3114 def __getitem__(self, key):
3104 3115 return self._engines[key]
3105 3116
3106 3117 def __contains__(self, key):
3107 3118 return key in self._engines
3108 3119
3109 3120 def __iter__(self):
3110 3121 return iter(self._engines.keys())
3111 3122
3112 3123 def register(self, engine):
3113 3124 """Register a compression engine with the manager.
3114 3125
3115 3126 The argument must be a ``compressionengine`` instance.
3116 3127 """
3117 3128 if not isinstance(engine, compressionengine):
3118 3129 raise ValueError(_('argument must be a compressionengine'))
3119 3130
3120 3131 name = engine.name()
3121 3132
3122 3133 if name in self._engines:
3123 3134 raise error.Abort(_('compression engine %s already registered') %
3124 3135 name)
3125 3136
3126 3137 bundleinfo = engine.bundletype()
3127 3138 if bundleinfo:
3128 3139 bundlename, bundletype = bundleinfo
3129 3140
3130 3141 if bundlename in self._bundlenames:
3131 3142 raise error.Abort(_('bundle name %s already registered') %
3132 3143 bundlename)
3133 3144 if bundletype in self._bundletypes:
3134 3145 raise error.Abort(_('bundle type %s already registered by %s') %
3135 3146 (bundletype, self._bundletypes[bundletype]))
3136 3147
3137 3148 # No external facing name declared.
3138 3149 if bundlename:
3139 3150 self._bundlenames[bundlename] = name
3140 3151
3141 3152 self._bundletypes[bundletype] = name
3142 3153
3143 3154 wiresupport = engine.wireprotosupport()
3144 3155 if wiresupport:
3145 3156 wiretype = wiresupport.name
3146 3157 if wiretype in self._wiretypes:
3147 3158 raise error.Abort(_('wire protocol compression %s already '
3148 3159 'registered by %s') %
3149 3160 (wiretype, self._wiretypes[wiretype]))
3150 3161
3151 3162 self._wiretypes[wiretype] = name
3152 3163
3153 3164 revlogheader = engine.revlogheader()
3154 3165 if revlogheader and revlogheader in self._revlogheaders:
3155 3166 raise error.Abort(_('revlog header %s already registered by %s') %
3156 3167 (revlogheader, self._revlogheaders[revlogheader]))
3157 3168
3158 3169 if revlogheader:
3159 3170 self._revlogheaders[revlogheader] = name
3160 3171
3161 3172 self._engines[name] = engine
3162 3173
3163 3174 @property
3164 3175 def supportedbundlenames(self):
3165 3176 return set(self._bundlenames.keys())
3166 3177
3167 3178 @property
3168 3179 def supportedbundletypes(self):
3169 3180 return set(self._bundletypes.keys())
3170 3181
3171 3182 def forbundlename(self, bundlename):
3172 3183 """Obtain a compression engine registered to a bundle name.
3173 3184
3174 3185 Will raise KeyError if the bundle type isn't registered.
3175 3186
3176 3187 Will abort if the engine is known but not available.
3177 3188 """
3178 3189 engine = self._engines[self._bundlenames[bundlename]]
3179 3190 if not engine.available():
3180 3191 raise error.Abort(_('compression engine %s could not be loaded') %
3181 3192 engine.name())
3182 3193 return engine
3183 3194
3184 3195 def forbundletype(self, bundletype):
3185 3196 """Obtain a compression engine registered to a bundle type.
3186 3197
3187 3198 Will raise KeyError if the bundle type isn't registered.
3188 3199
3189 3200 Will abort if the engine is known but not available.
3190 3201 """
3191 3202 engine = self._engines[self._bundletypes[bundletype]]
3192 3203 if not engine.available():
3193 3204 raise error.Abort(_('compression engine %s could not be loaded') %
3194 3205 engine.name())
3195 3206 return engine
3196 3207
3197 3208 def supportedwireengines(self, role, onlyavailable=True):
3198 3209 """Obtain compression engines that support the wire protocol.
3199 3210
3200 3211 Returns a list of engines in prioritized order, most desired first.
3201 3212
3202 3213 If ``onlyavailable`` is set, filter out engines that can't be
3203 3214 loaded.
3204 3215 """
3205 3216 assert role in (SERVERROLE, CLIENTROLE)
3206 3217
3207 3218 attr = 'serverpriority' if role == SERVERROLE else 'clientpriority'
3208 3219
3209 3220 engines = [self._engines[e] for e in self._wiretypes.values()]
3210 3221 if onlyavailable:
3211 3222 engines = [e for e in engines if e.available()]
3212 3223
3213 3224 def getkey(e):
3214 3225 # Sort first by priority, highest first. In case of tie, sort
3215 3226 # alphabetically. This is arbitrary, but ensures output is
3216 3227 # stable.
3217 3228 w = e.wireprotosupport()
3218 3229 return -1 * getattr(w, attr), w.name
3219 3230
3220 3231 return list(sorted(engines, key=getkey))
3221 3232
3222 3233 def forwiretype(self, wiretype):
3223 3234 engine = self._engines[self._wiretypes[wiretype]]
3224 3235 if not engine.available():
3225 3236 raise error.Abort(_('compression engine %s could not be loaded') %
3226 3237 engine.name())
3227 3238 return engine
3228 3239
3229 3240 def forrevlogheader(self, header):
3230 3241 """Obtain a compression engine registered to a revlog header.
3231 3242
3232 3243 Will raise KeyError if the revlog header value isn't registered.
3233 3244 """
3234 3245 return self._engines[self._revlogheaders[header]]
3235 3246
3236 3247 compengines = compressormanager()
3237 3248
3238 3249 class compressionengine(object):
3239 3250 """Base class for compression engines.
3240 3251
3241 3252 Compression engines must implement the interface defined by this class.
3242 3253 """
3243 3254 def name(self):
3244 3255 """Returns the name of the compression engine.
3245 3256
3246 3257 This is the key the engine is registered under.
3247 3258
3248 3259 This method must be implemented.
3249 3260 """
3250 3261 raise NotImplementedError()
3251 3262
3252 3263 def available(self):
3253 3264 """Whether the compression engine is available.
3254 3265
3255 3266 The intent of this method is to allow optional compression engines
3256 3267 that may not be available in all installations (such as engines relying
3257 3268 on C extensions that may not be present).
3258 3269 """
3259 3270 return True
3260 3271
3261 3272 def bundletype(self):
3262 3273 """Describes bundle identifiers for this engine.
3263 3274
3264 3275 If this compression engine isn't supported for bundles, returns None.
3265 3276
3266 3277 If this engine can be used for bundles, returns a 2-tuple of strings of
3267 3278 the user-facing "bundle spec" compression name and an internal
3268 3279 identifier used to denote the compression format within bundles. To
3269 3280 exclude the name from external usage, set the first element to ``None``.
3270 3281
3271 3282 If bundle compression is supported, the class must also implement
3272 3283 ``compressstream`` and `decompressorreader``.
3273 3284 """
3274 3285 return None
3275 3286
3276 3287 def wireprotosupport(self):
3277 3288 """Declare support for this compression format on the wire protocol.
3278 3289
3279 3290 If this compression engine isn't supported for compressing wire
3280 3291 protocol payloads, returns None.
3281 3292
3282 3293 Otherwise, returns ``compenginewireprotosupport`` with the following
3283 3294 fields:
3284 3295
3285 3296 * String format identifier
3286 3297 * Integer priority for the server
3287 3298 * Integer priority for the client
3288 3299
3289 3300 The integer priorities are used to order the advertisement of format
3290 3301 support by server and client. The highest integer is advertised
3291 3302 first. Integers with non-positive values aren't advertised.
3292 3303
3293 3304 The priority values are somewhat arbitrary and only used for default
3294 3305 ordering. The relative order can be changed via config options.
3295 3306
3296 3307 If wire protocol compression is supported, the class must also implement
3297 3308 ``compressstream`` and ``decompressorreader``.
3298 3309 """
3299 3310 return None
3300 3311
3301 3312 def revlogheader(self):
3302 3313 """Header added to revlog chunks that identifies this engine.
3303 3314
3304 3315 If this engine can be used to compress revlogs, this method should
3305 3316 return the bytes used to identify chunks compressed with this engine.
3306 3317 Else, the method should return ``None`` to indicate it does not
3307 3318 participate in revlog compression.
3308 3319 """
3309 3320 return None
3310 3321
3311 3322 def compressstream(self, it, opts=None):
3312 3323 """Compress an iterator of chunks.
3313 3324
3314 3325 The method receives an iterator (ideally a generator) of chunks of
3315 3326 bytes to be compressed. It returns an iterator (ideally a generator)
3316 3327 of bytes of chunks representing the compressed output.
3317 3328
3318 3329 Optionally accepts an argument defining how to perform compression.
3319 3330 Each engine treats this argument differently.
3320 3331 """
3321 3332 raise NotImplementedError()
3322 3333
3323 3334 def decompressorreader(self, fh):
3324 3335 """Perform decompression on a file object.
3325 3336
3326 3337 Argument is an object with a ``read(size)`` method that returns
3327 3338 compressed data. Return value is an object with a ``read(size)`` that
3328 3339 returns uncompressed data.
3329 3340 """
3330 3341 raise NotImplementedError()
3331 3342
3332 3343 def revlogcompressor(self, opts=None):
3333 3344 """Obtain an object that can be used to compress revlog entries.
3334 3345
3335 3346 The object has a ``compress(data)`` method that compresses binary
3336 3347 data. This method returns compressed binary data or ``None`` if
3337 3348 the data could not be compressed (too small, not compressible, etc).
3338 3349 The returned data should have a header uniquely identifying this
3339 3350 compression format so decompression can be routed to this engine.
3340 3351 This header should be identified by the ``revlogheader()`` return
3341 3352 value.
3342 3353
3343 3354 The object has a ``decompress(data)`` method that decompresses
3344 3355 data. The method will only be called if ``data`` begins with
3345 3356 ``revlogheader()``. The method should return the raw, uncompressed
3346 3357 data or raise a ``RevlogError``.
3347 3358
3348 3359 The object is reusable but is not thread safe.
3349 3360 """
3350 3361 raise NotImplementedError()
3351 3362
3352 3363 class _zlibengine(compressionengine):
3353 3364 def name(self):
3354 3365 return 'zlib'
3355 3366
3356 3367 def bundletype(self):
3357 3368 return 'gzip', 'GZ'
3358 3369
3359 3370 def wireprotosupport(self):
3360 3371 return compewireprotosupport('zlib', 20, 20)
3361 3372
3362 3373 def revlogheader(self):
3363 3374 return 'x'
3364 3375
3365 3376 def compressstream(self, it, opts=None):
3366 3377 opts = opts or {}
3367 3378
3368 3379 z = zlib.compressobj(opts.get('level', -1))
3369 3380 for chunk in it:
3370 3381 data = z.compress(chunk)
3371 3382 # Not all calls to compress emit data. It is cheaper to inspect
3372 3383 # here than to feed empty chunks through generator.
3373 3384 if data:
3374 3385 yield data
3375 3386
3376 3387 yield z.flush()
3377 3388
3378 3389 def decompressorreader(self, fh):
3379 3390 def gen():
3380 3391 d = zlib.decompressobj()
3381 3392 for chunk in filechunkiter(fh):
3382 3393 while chunk:
3383 3394 # Limit output size to limit memory.
3384 3395 yield d.decompress(chunk, 2 ** 18)
3385 3396 chunk = d.unconsumed_tail
3386 3397
3387 3398 return chunkbuffer(gen())
3388 3399
3389 3400 class zlibrevlogcompressor(object):
3390 3401 def compress(self, data):
3391 3402 insize = len(data)
3392 3403 # Caller handles empty input case.
3393 3404 assert insize > 0
3394 3405
3395 3406 if insize < 44:
3396 3407 return None
3397 3408
3398 3409 elif insize <= 1000000:
3399 3410 compressed = zlib.compress(data)
3400 3411 if len(compressed) < insize:
3401 3412 return compressed
3402 3413 return None
3403 3414
3404 3415 # zlib makes an internal copy of the input buffer, doubling
3405 3416 # memory usage for large inputs. So do streaming compression
3406 3417 # on large inputs.
3407 3418 else:
3408 3419 z = zlib.compressobj()
3409 3420 parts = []
3410 3421 pos = 0
3411 3422 while pos < insize:
3412 3423 pos2 = pos + 2**20
3413 3424 parts.append(z.compress(data[pos:pos2]))
3414 3425 pos = pos2
3415 3426 parts.append(z.flush())
3416 3427
3417 3428 if sum(map(len, parts)) < insize:
3418 3429 return ''.join(parts)
3419 3430 return None
3420 3431
3421 3432 def decompress(self, data):
3422 3433 try:
3423 3434 return zlib.decompress(data)
3424 3435 except zlib.error as e:
3425 3436 raise error.RevlogError(_('revlog decompress error: %s') %
3426 3437 str(e))
3427 3438
3428 3439 def revlogcompressor(self, opts=None):
3429 3440 return self.zlibrevlogcompressor()
3430 3441
3431 3442 compengines.register(_zlibengine())
3432 3443
3433 3444 class _bz2engine(compressionengine):
3434 3445 def name(self):
3435 3446 return 'bz2'
3436 3447
3437 3448 def bundletype(self):
3438 3449 return 'bzip2', 'BZ'
3439 3450
3440 3451 # We declare a protocol name but don't advertise by default because
3441 3452 # it is slow.
3442 3453 def wireprotosupport(self):
3443 3454 return compewireprotosupport('bzip2', 0, 0)
3444 3455
3445 3456 def compressstream(self, it, opts=None):
3446 3457 opts = opts or {}
3447 3458 z = bz2.BZ2Compressor(opts.get('level', 9))
3448 3459 for chunk in it:
3449 3460 data = z.compress(chunk)
3450 3461 if data:
3451 3462 yield data
3452 3463
3453 3464 yield z.flush()
3454 3465
3455 3466 def decompressorreader(self, fh):
3456 3467 def gen():
3457 3468 d = bz2.BZ2Decompressor()
3458 3469 for chunk in filechunkiter(fh):
3459 3470 yield d.decompress(chunk)
3460 3471
3461 3472 return chunkbuffer(gen())
3462 3473
3463 3474 compengines.register(_bz2engine())
3464 3475
3465 3476 class _truncatedbz2engine(compressionengine):
3466 3477 def name(self):
3467 3478 return 'bz2truncated'
3468 3479
3469 3480 def bundletype(self):
3470 3481 return None, '_truncatedBZ'
3471 3482
3472 3483 # We don't implement compressstream because it is hackily handled elsewhere.
3473 3484
3474 3485 def decompressorreader(self, fh):
3475 3486 def gen():
3476 3487 # The input stream doesn't have the 'BZ' header. So add it back.
3477 3488 d = bz2.BZ2Decompressor()
3478 3489 d.decompress('BZ')
3479 3490 for chunk in filechunkiter(fh):
3480 3491 yield d.decompress(chunk)
3481 3492
3482 3493 return chunkbuffer(gen())
3483 3494
3484 3495 compengines.register(_truncatedbz2engine())
3485 3496
3486 3497 class _noopengine(compressionengine):
3487 3498 def name(self):
3488 3499 return 'none'
3489 3500
3490 3501 def bundletype(self):
3491 3502 return 'none', 'UN'
3492 3503
3493 3504 # Clients always support uncompressed payloads. Servers don't because
3494 3505 # unless you are on a fast network, uncompressed payloads can easily
3495 3506 # saturate your network pipe.
3496 3507 def wireprotosupport(self):
3497 3508 return compewireprotosupport('none', 0, 10)
3498 3509
3499 3510 # We don't implement revlogheader because it is handled specially
3500 3511 # in the revlog class.
3501 3512
3502 3513 def compressstream(self, it, opts=None):
3503 3514 return it
3504 3515
3505 3516 def decompressorreader(self, fh):
3506 3517 return fh
3507 3518
3508 3519 class nooprevlogcompressor(object):
3509 3520 def compress(self, data):
3510 3521 return None
3511 3522
3512 3523 def revlogcompressor(self, opts=None):
3513 3524 return self.nooprevlogcompressor()
3514 3525
3515 3526 compengines.register(_noopengine())
3516 3527
3517 3528 class _zstdengine(compressionengine):
3518 3529 def name(self):
3519 3530 return 'zstd'
3520 3531
3521 3532 @propertycache
3522 3533 def _module(self):
3523 3534 # Not all installs have the zstd module available. So defer importing
3524 3535 # until first access.
3525 3536 try:
3526 3537 from . import zstd
3527 3538 # Force delayed import.
3528 3539 zstd.__version__
3529 3540 return zstd
3530 3541 except ImportError:
3531 3542 return None
3532 3543
3533 3544 def available(self):
3534 3545 return bool(self._module)
3535 3546
3536 3547 def bundletype(self):
3537 3548 return 'zstd', 'ZS'
3538 3549
3539 3550 def wireprotosupport(self):
3540 3551 return compewireprotosupport('zstd', 50, 50)
3541 3552
3542 3553 def revlogheader(self):
3543 3554 return '\x28'
3544 3555
3545 3556 def compressstream(self, it, opts=None):
3546 3557 opts = opts or {}
3547 3558 # zstd level 3 is almost always significantly faster than zlib
3548 3559 # while providing no worse compression. It strikes a good balance
3549 3560 # between speed and compression.
3550 3561 level = opts.get('level', 3)
3551 3562
3552 3563 zstd = self._module
3553 3564 z = zstd.ZstdCompressor(level=level).compressobj()
3554 3565 for chunk in it:
3555 3566 data = z.compress(chunk)
3556 3567 if data:
3557 3568 yield data
3558 3569
3559 3570 yield z.flush()
3560 3571
3561 3572 def decompressorreader(self, fh):
3562 3573 zstd = self._module
3563 3574 dctx = zstd.ZstdDecompressor()
3564 3575 return chunkbuffer(dctx.read_from(fh))
3565 3576
3566 3577 class zstdrevlogcompressor(object):
3567 3578 def __init__(self, zstd, level=3):
3568 3579 # Writing the content size adds a few bytes to the output. However,
3569 3580 # it allows decompression to be more optimal since we can
3570 3581 # pre-allocate a buffer to hold the result.
3571 3582 self._cctx = zstd.ZstdCompressor(level=level,
3572 3583 write_content_size=True)
3573 3584 self._dctx = zstd.ZstdDecompressor()
3574 3585 self._compinsize = zstd.COMPRESSION_RECOMMENDED_INPUT_SIZE
3575 3586 self._decompinsize = zstd.DECOMPRESSION_RECOMMENDED_INPUT_SIZE
3576 3587
3577 3588 def compress(self, data):
3578 3589 insize = len(data)
3579 3590 # Caller handles empty input case.
3580 3591 assert insize > 0
3581 3592
3582 3593 if insize < 50:
3583 3594 return None
3584 3595
3585 3596 elif insize <= 1000000:
3586 3597 compressed = self._cctx.compress(data)
3587 3598 if len(compressed) < insize:
3588 3599 return compressed
3589 3600 return None
3590 3601 else:
3591 3602 z = self._cctx.compressobj()
3592 3603 chunks = []
3593 3604 pos = 0
3594 3605 while pos < insize:
3595 3606 pos2 = pos + self._compinsize
3596 3607 chunk = z.compress(data[pos:pos2])
3597 3608 if chunk:
3598 3609 chunks.append(chunk)
3599 3610 pos = pos2
3600 3611 chunks.append(z.flush())
3601 3612
3602 3613 if sum(map(len, chunks)) < insize:
3603 3614 return ''.join(chunks)
3604 3615 return None
3605 3616
3606 3617 def decompress(self, data):
3607 3618 insize = len(data)
3608 3619
3609 3620 try:
3610 3621 # This was measured to be faster than other streaming
3611 3622 # decompressors.
3612 3623 dobj = self._dctx.decompressobj()
3613 3624 chunks = []
3614 3625 pos = 0
3615 3626 while pos < insize:
3616 3627 pos2 = pos + self._decompinsize
3617 3628 chunk = dobj.decompress(data[pos:pos2])
3618 3629 if chunk:
3619 3630 chunks.append(chunk)
3620 3631 pos = pos2
3621 3632 # Frame should be exhausted, so no finish() API.
3622 3633
3623 3634 return ''.join(chunks)
3624 3635 except Exception as e:
3625 3636 raise error.RevlogError(_('revlog decompress error: %s') %
3626 3637 str(e))
3627 3638
3628 3639 def revlogcompressor(self, opts=None):
3629 3640 opts = opts or {}
3630 3641 return self.zstdrevlogcompressor(self._module,
3631 3642 level=opts.get('level', 3))
3632 3643
3633 3644 compengines.register(_zstdengine())
3634 3645
3635 3646 # convenient shortcut
3636 3647 dst = debugstacktrace
General Comments 0
You need to be logged in to leave comments. Login now