win32text.py
177 lines
| 5.9 KiB
| text/x-python
|
PythonLexer
/ hgext / win32text.py
|
r6481 | # win32text.py - LF <-> CRLF/CR translation utilities for Windows/Mac users | ||
|
r5675 | # | ||
|
r8253 | # Copyright 2005, 2007-2009 Matt Mackall <mpm@selenic.com> and others | ||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r8873 | |||
|
r20624 | '''perform automatic newline conversion (DEPRECATED) | ||
|
r8873 | |||
|
r11269 | Deprecation: The win32text extension requires each user to configure | ||
the extension again and again for each clone since the configuration | ||||
is not copied when cloning. | ||||
We have therefore made the ``eol`` as an alternative. The ``eol`` | ||||
uses a version controlled file for its configuration and each clone | ||||
will therefore use the right settings from the start. | ||||
|
r9217 | To perform automatic newline conversion, use:: | ||
|
r8873 | |||
|
r9217 | [extensions] | ||
|
r10112 | win32text = | ||
|
r9217 | [encode] | ||
** = cleverencode: | ||||
# or ** = macencode: | ||||
|
r8873 | |||
|
r9217 | [decode] | ||
** = cleverdecode: | ||||
# or ** = macdecode: | ||||
|
r8873 | |||
|
r9217 | If not doing conversion, to make sure you do not commit CRLF/CR by accident:: | ||
|
r8873 | |||
|
r9217 | [hooks] | ||
pretxncommit.crlf = python:hgext.win32text.forbidcrlf | ||||
# or pretxncommit.cr = python:hgext.win32text.forbidcr | ||||
|
r8873 | |||
To do the same check on a server to prevent CRLF/CR from being | ||||
|
r9217 | pushed or pulled:: | ||
|
r8873 | |||
|
r9217 | [hooks] | ||
pretxnchangegroup.crlf = python:hgext.win32text.forbidcrlf | ||||
# or pretxnchangegroup.cr = python:hgext.win32text.forbidcr | ||||
|
r8873 | ''' | ||
|
r5675 | |||
|
r7225 | from mercurial.i18n import _ | ||
|
r7873 | from mercurial.node import short | ||
|
r6510 | from mercurial import util | ||
|
r4859 | import re | ||
|
r25186 | # Note for extension authors: ONLY specify testedwith = 'internal' for | ||
# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should | ||||
# be specifying the version(s) of Mercurial they are tested with, or | ||||
# leave the attribute unspecified. | ||||
|
r16743 | testedwith = 'internal' | ||
|
r4859 | # regexp for single LF without CR preceding. | ||
re_single_lf = re.compile('(^|[^\r])\n', re.MULTILINE) | ||||
|
r6481 | newlinestr = {'\r\n': 'CRLF', '\r': 'CR'} | ||
filterstr = {'\r\n': 'clever', '\r': 'mac'} | ||||
def checknewline(s, newline, ui=None, repo=None, filename=None): | ||||
# warn if already has 'newline' in repository. | ||||
|
r4859 | # it might cause unexpected eol conversion. | ||
# see issue 302: | ||||
|
r26420 | # https://bz.mercurial-scm.org/302 | ||
|
r6481 | if newline in s and ui and filename and repo: | ||
ui.warn(_('WARNING: %s already has %s line endings\n' | ||||
|
r5967 | 'and does not need EOL conversion by the win32text plugin.\n' | ||
'Before your next commit, please reconsider your ' | ||||
'encode/decode settings in \nMercurial.ini or %s.\n') % | ||||
|
r6481 | (filename, newlinestr[newline], repo.join('hgrc'))) | ||
def dumbdecode(s, cmd, **kwargs): | ||||
checknewline(s, '\r\n', **kwargs) | ||||
|
r4859 | # replace single LF to CRLF | ||
return re_single_lf.sub('\\1\r\n', s) | ||||
def dumbencode(s, cmd): | ||||
return s.replace('\r\n', '\n') | ||||
|
r6481 | def macdumbdecode(s, cmd, **kwargs): | ||
checknewline(s, '\r', **kwargs) | ||||
return s.replace('\n', '\r') | ||||
def macdumbencode(s, cmd): | ||||
return s.replace('\r', '\n') | ||||
|
r5967 | def cleverdecode(s, cmd, **kwargs): | ||
|
r6508 | if not util.binary(s): | ||
|
r6473 | return dumbdecode(s, cmd, **kwargs) | ||
return s | ||||
|
r4859 | |||
def cleverencode(s, cmd): | ||||
|
r6508 | if not util.binary(s): | ||
|
r6473 | return dumbencode(s, cmd) | ||
return s | ||||
|
r4859 | |||
|
r6481 | def macdecode(s, cmd, **kwargs): | ||
|
r6508 | if not util.binary(s): | ||
|
r6484 | return macdumbdecode(s, cmd, **kwargs) | ||
return s | ||||
|
r6481 | |||
def macencode(s, cmd): | ||||
|
r6508 | if not util.binary(s): | ||
|
r6484 | return macdumbencode(s, cmd) | ||
return s | ||||
|
r6481 | |||
|
r5966 | _filters = { | ||
|
r4859 | 'dumbdecode:': dumbdecode, | ||
'dumbencode:': dumbencode, | ||||
'cleverdecode:': cleverdecode, | ||||
'cleverencode:': cleverencode, | ||||
|
r6481 | 'macdumbdecode:': macdumbdecode, | ||
'macdumbencode:': macdumbencode, | ||||
'macdecode:': macdecode, | ||||
'macencode:': macencode, | ||||
|
r5966 | } | ||
|
r5675 | |||
|
r6483 | def forbidnewline(ui, repo, hooktype, node, newline, **kwargs): | ||
|
r5675 | halt = False | ||
|
r8150 | seen = set() | ||
|
r8147 | # we try to walk changesets in reverse order from newest to | ||
# oldest, so that if we see a file multiple times, we take the | ||||
# newest version as canonical. this prevents us from blocking a | ||||
# changegroup that contains an unacceptable commit followed later | ||||
# by a commit that fixes the problem. | ||||
tip = repo['tip'] | ||||
|
r18054 | for rev in xrange(len(repo) - 1, repo[node].rev() - 1, -1): | ||
|
r6747 | c = repo[rev] | ||
|
r5675 | for f in c.files(): | ||
|
r8147 | if f in seen or f not in tip or f not in c: | ||
|
r5675 | continue | ||
|
r8147 | seen.add(f) | ||
|
r5675 | data = c[f].data() | ||
|
r6508 | if not util.binary(data) and newline in data: | ||
|
r5675 | if not halt: | ||
|
r16932 | ui.warn(_('attempt to commit or push text file(s) ' | ||
|
r6481 | 'using %s line endings\n') % | ||
newlinestr[newline]) | ||||
|
r5675 | ui.warn(_('in %s: %s\n') % (short(c.node()), f)) | ||
halt = True | ||||
if halt and hooktype == 'pretxnchangegroup': | ||||
|
r6481 | crlf = newlinestr[newline].lower() | ||
filter = filterstr[newline] | ||||
|
r5675 | ui.warn(_('\nTo prevent this mistake in your local repository,\n' | ||
'add to Mercurial.ini or .hg/hgrc:\n' | ||||
'\n' | ||||
'[hooks]\n' | ||||
|
r6481 | 'pretxncommit.%s = python:hgext.win32text.forbid%s\n' | ||
|
r5675 | '\n' | ||
'and also consider adding:\n' | ||||
'\n' | ||||
'[extensions]\n' | ||||
|
r10132 | 'win32text =\n' | ||
|
r5675 | '[encode]\n' | ||
|
r6481 | '** = %sencode:\n' | ||
|
r5675 | '[decode]\n' | ||
|
r6481 | '** = %sdecode:\n') % (crlf, crlf, filter, filter)) | ||
|
r5675 | return halt | ||
|
r5966 | |||
|
r6481 | def forbidcrlf(ui, repo, hooktype, node, **kwargs): | ||
|
r6483 | return forbidnewline(ui, repo, hooktype, node, '\r\n', **kwargs) | ||
|
r6481 | |||
def forbidcr(ui, repo, hooktype, node, **kwargs): | ||||
|
r6483 | return forbidnewline(ui, repo, hooktype, node, '\r', **kwargs) | ||
|
r6481 | |||
|
r5966 | def reposetup(ui, repo): | ||
if not repo.local(): | ||||
return | ||||
for name, fn in _filters.iteritems(): | ||||
repo.adddatafilter(name, fn) | ||||
|
r12837 | def extsetup(ui): | ||
|
r25829 | # deprecated config: win32text.warn | ||
|
r12837 | if ui.configbool('win32text', 'warn', True): | ||
ui.warn(_("win32text is deprecated: " | ||||
"http://mercurial.selenic.com/wiki/Win32TextExtension\n")) | ||||