py3: encode underlying error message during parse error of %include

mercurial/config.py

@@ -1,312 +1,313 b''
 # config.py - configuration parsing for Mercurial
 #
 #  Copyright 2009 Matt Mackall <[e-mail]> and others
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import errno
 import os
 
 from .i18n import _
 from .pycompat import getattr
 from . import (
+    encoding,
     error,
     pycompat,
     util,
 )
 
 
 class config(object):
     def __init__(self, data=None, includepaths=None):
         self._data = {}
         self._unset = []
         self._includepaths = includepaths or []
         if data:
             for k in data._data:
                 self._data[k] = data[k].copy()
             self._source = data._source.copy()
         else:
             self._source = util.cowdict()
 
     def copy(self):
         return config(self)
 
     def __contains__(self, section):
         return section in self._data
 
     def hasitem(self, section, item):
         return item in self._data.get(section, {})
 
     def __getitem__(self, section):
         return self._data.get(section, {})
 
     def __iter__(self):
         for d in self.sections():
             yield d
 
     def update(self, src):
         self._source = self._source.preparewrite()
         for s, n in src._unset:
             ds = self._data.get(s, None)
             if ds is not None and n in ds:
                 self._data[s] = ds.preparewrite()
                 del self._data[s][n]
                 del self._source[(s, n)]
         for s in src:
             ds = self._data.get(s, None)
             if ds:
                 self._data[s] = ds.preparewrite()
             else:
                 self._data[s] = util.cowsortdict()
             self._data[s].update(src._data[s])
         self._source.update(src._source)
 
     def get(self, section, item, default=None):
         return self._data.get(section, {}).get(item, default)
 
     def backup(self, section, item):
         """return a tuple allowing restore to reinstall a previous value
 
         The main reason we need it is because it handles the "no data" case.
         """
         try:
             value = self._data[section][item]
             source = self.source(section, item)
             return (section, item, value, source)
         except KeyError:
             return (section, item)
 
     def source(self, section, item):
         return self._source.get((section, item), b"")
 
     def sections(self):
         return sorted(self._data.keys())
 
     def items(self, section):
         return list(pycompat.iteritems(self._data.get(section, {})))
 
     def set(self, section, item, value, source=b""):
         if pycompat.ispy3:
             assert not isinstance(
                 section, str
             ), b'config section may not be unicode strings on Python 3'
             assert not isinstance(
                 item, str
             ), b'config item may not be unicode strings on Python 3'
             assert not isinstance(
                 value, str
             ), b'config values may not be unicode strings on Python 3'
         if section not in self:
             self._data[section] = util.cowsortdict()
         else:
             self._data[section] = self._data[section].preparewrite()
         self._data[section][item] = value
         if source:
             self._source = self._source.preparewrite()
             self._source[(section, item)] = source
 
     def restore(self, data):
         """restore data returned by self.backup"""
         self._source = self._source.preparewrite()
         if len(data) == 4:
             # restore old data
             section, item, value, source = data
             self._data[section] = self._data[section].preparewrite()
             self._data[section][item] = value
             self._source[(section, item)] = source
         else:
             # no data before, remove everything
             section, item = data
             if section in self._data:
                 self._data[section].pop(item, None)
             self._source.pop((section, item), None)
 
     def parse(self, src, data, sections=None, remap=None, include=None):
         sectionre = util.re.compile(br'\[([^\[]+)\]')
         itemre = util.re.compile(br'([^=\s][^=]*?)\s*=\s*(.*\S|)')
         contre = util.re.compile(br'\s+(\S|\S.*\S)\s*$')
         emptyre = util.re.compile(br'(;|#|\s*$)')
         commentre = util.re.compile(br'(;|#)')
         unsetre = util.re.compile(br'%unset\s+(\S+)')
         includere = util.re.compile(br'%include\s+(\S|\S.*\S)\s*$')
         section = b""
         item = None
         line = 0
         cont = False
 
         if remap:
             section = remap.get(section, section)
 
         for l in data.splitlines(True):
             line += 1
             if line == 1 and l.startswith(b'\xef\xbb\xbf'):
                 # Someone set us up the BOM
                 l = l[3:]
             if cont:
                 if commentre.match(l):
                     continue
                 m = contre.match(l)
                 if m:
                     if sections and section not in sections:
                         continue
                     v = self.get(section, item) + b"\n" + m.group(1)
                     self.set(section, item, v, b"%s:%d" % (src, line))
                     continue
                 item = None
                 cont = False
             m = includere.match(l)
 
             if m and include:
                 expanded = util.expandpath(m.group(1))
                 includepaths = [os.path.dirname(src)] + self._includepaths
 
                 for base in includepaths:
                     inc = os.path.normpath(os.path.join(base, expanded))
 
                     try:
                         include(inc, remap=remap, sections=sections)
                         break
                     except IOError as inst:
                         if inst.errno != errno.ENOENT:
                             raise error.ParseError(
                                 _(b"cannot include %s (%s)")
-                                % (inc, inst.strerror),
+                                % (inc, encoding.strtolocal(inst.strerror)),
                                 b"%s:%d" % (src, line),
                             )
                 continue
             if emptyre.match(l):
                 continue
             m = sectionre.match(l)
             if m:
                 section = m.group(1)
                 if remap:
                     section = remap.get(section, section)
                 if section not in self:
                     self._data[section] = util.cowsortdict()
                 continue
             m = itemre.match(l)
             if m:
                 item = m.group(1)
                 cont = True
                 if sections and section not in sections:
                     continue
                 self.set(section, item, m.group(2), b"%s:%d" % (src, line))
                 continue
             m = unsetre.match(l)
             if m:
                 name = m.group(1)
                 if sections and section not in sections:
                     continue
                 if self.get(section, name) is not None:
                     self._data[section] = self._data[section].preparewrite()
                     del self._data[section][name]
                 self._unset.append((section, name))
                 continue
 
             raise error.ParseError(l.rstrip(), (b"%s:%d" % (src, line)))
 
     def read(self, path, fp=None, sections=None, remap=None):
         if not fp:
             fp = util.posixfile(path, b'rb')
         assert (
             getattr(fp, 'mode', r'rb') == r'rb'
         ), b'config files must be opened in binary mode, got fp=%r mode=%r' % (
             fp,
             fp.mode,
         )
         self.parse(
             path, fp.read(), sections=sections, remap=remap, include=self.read
         )
 
 
 def parselist(value):
     """parse a configuration value as a list of comma/space separated strings
 
     >>> parselist(b'this,is "a small" ,test')
     ['this', 'is', 'a small', 'test']
     """
 
     def _parse_plain(parts, s, offset):
         whitespace = False
         while offset < len(s) and (
             s[offset : offset + 1].isspace() or s[offset : offset + 1] == b','
         ):
             whitespace = True
             offset += 1
         if offset >= len(s):
             return None, parts, offset
         if whitespace:
             parts.append(b'')
         if s[offset : offset + 1] == b'"' and not parts[-1]:
             return _parse_quote, parts, offset + 1
         elif s[offset : offset + 1] == b'"' and parts[-1][-1:] == b'\\':
             parts[-1] = parts[-1][:-1] + s[offset : offset + 1]
             return _parse_plain, parts, offset + 1
         parts[-1] += s[offset : offset + 1]
         return _parse_plain, parts, offset + 1
 
     def _parse_quote(parts, s, offset):
         if offset < len(s) and s[offset : offset + 1] == b'"':  # ""
             parts.append(b'')
             offset += 1
             while offset < len(s) and (
                 s[offset : offset + 1].isspace()
                 or s[offset : offset + 1] == b','
             ):
                 offset += 1
             return _parse_plain, parts, offset
 
         while offset < len(s) and s[offset : offset + 1] != b'"':
             if (
                 s[offset : offset + 1] == b'\\'
                 and offset + 1 < len(s)
                 and s[offset + 1 : offset + 2] == b'"'
             ):
                 offset += 1
                 parts[-1] += b'"'
             else:
                 parts[-1] += s[offset : offset + 1]
             offset += 1
 
         if offset >= len(s):
             real_parts = _configlist(parts[-1])
             if not real_parts:
                 parts[-1] = b'"'
             else:
                 real_parts[0] = b'"' + real_parts[0]
                 parts = parts[:-1]
                 parts.extend(real_parts)
             return None, parts, offset
 
         offset += 1
         while offset < len(s) and s[offset : offset + 1] in [b' ', b',']:
             offset += 1
 
         if offset < len(s):
             if offset + 1 == len(s) and s[offset : offset + 1] == b'"':
                 parts[-1] += b'"'
                 offset += 1
             else:
                 parts.append(b'')
         else:
             return None, parts, offset
 
         return _parse_plain, parts, offset
 
     def _configlist(s):
         s = s.rstrip(b' ,')
         if not s:
             return []
         parser, parts, offset = _parse_plain, [b''], 0
         while parser:
             parser, parts, offset = parser(parts, s, offset)
         return parts
 
     if value is not None and isinstance(value, bytes):
         result = _configlist(value.lstrip(b' ,\n'))
     else:
         result = value
     return result or []

tests/test-hgrc.t

@@ -1,249 +1,261 b''
 Use hgrc within $TESTTMP
 
   $ HGRCPATH=`pwd`/hgrc
   $ export HGRCPATH
 
 hide outer repo
   $ hg init
 
 Use an alternate var for scribbling on hgrc to keep check-code from
 complaining about the important settings we may be overwriting:
 
   $ HGRC=`pwd`/hgrc
   $ export HGRC
 
 Basic syntax error
 
   $ echo "invalid" > $HGRC
   $ hg version
   hg: parse error at $TESTTMP/hgrc:1: invalid
   [255]
   $ echo "" > $HGRC
 
 Issue1199: Can't use '%' in hgrc (eg url encoded username)
 
   $ hg init "foo%bar"
   $ hg clone "foo%bar" foobar
   updating to branch default
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ cd foobar
   $ cat .hg/hgrc
   # example repository config (see 'hg help config' for more info)
   [paths]
   default = $TESTTMP/foo%bar
   
   # path aliases to other clones of this repo in URLs or filesystem paths
   # (see 'hg help config.paths' for more info)
   #
   # default:pushurl = ssh://[e-mail]/hg/jdoes-fork
   # my-fork         = ssh://[e-mail]/hg/jdoes-fork
   # my-clone        = /home/jdoe/jdoes-clone
   
   [ui]
   # name and email (local to this repository, optional), e.g.
   # username = Jane Doe <[e-mail]>
   $ hg paths
   default = $TESTTMP/foo%bar
   $ hg showconfig
   bundle.mainreporoot=$TESTTMP/foobar
   paths.default=$TESTTMP/foo%bar
   $ cd ..
 
+Check %include
+
+  $ echo '[section]' > $TESTTMP/included
+  $ echo 'option = value' >> $TESTTMP/included
+  $ echo '%include $TESTTMP/included' >> $HGRC
+  $ hg showconfig section
+  section.option=value
+  $ chmod u-r $TESTTMP/included
+  $ hg showconfig section
+  hg: parse error at $TESTTMP/hgrc:2: cannot include $TESTTMP/included (Permission denied)
+  [255]
+
 issue1829: wrong indentation
 
   $ echo '[foo]' > $HGRC
   $ echo '  x = y' >> $HGRC
   $ hg version
   hg: parse error at $TESTTMP/hgrc:2:   x = y
   unexpected leading whitespace
   [255]
 
   $ "$PYTHON" -c "from __future__ import print_function; print('[foo]\nbar = a\n b\n c \n  de\n fg \nbaz = bif cb \n')" \
   > > $HGRC
   $ hg showconfig foo
   foo.bar=a\nb\nc\nde\nfg
   foo.baz=bif cb
 
   $ FAKEPATH=/path/to/nowhere
   $ export FAKEPATH
   $ echo '%include $FAKEPATH/no-such-file' > $HGRC
   $ hg version
   Mercurial Distributed SCM (version *) (glob)
   (see https://mercurial-scm.org for more information)
   
   Copyright (C) 2005-* Matt Mackall and others (glob)
   This is free software; see the source for copying conditions. There is NO
   warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   $ unset FAKEPATH
 
 make sure global options given on the cmdline take precedence
 
   $ hg showconfig --config ui.verbose=True --quiet
   bundle.mainreporoot=$TESTTMP
   ui.verbose=False
   ui.debug=False
   ui.quiet=True
 
   $ touch foobar/untracked
   $ cat >> foobar/.hg/hgrc <<EOF
   > [ui]
   > verbose=True
   > EOF
   $ hg -R foobar st -q
 
 username expansion
 
   $ olduser=$HGUSER
   $ unset HGUSER
 
   $ FAKEUSER='John Doe'
   $ export FAKEUSER
   $ echo '[ui]' > $HGRC
   $ echo 'username = $FAKEUSER' >> $HGRC
 
   $ hg init usertest
   $ cd usertest
   $ touch bar
   $ hg commit --addremove --quiet -m "added bar"
   $ hg log --template "{author}\n"
   John Doe
   $ cd ..
 
   $ hg showconfig
   bundle.mainreporoot=$TESTTMP
   ui.username=$FAKEUSER
 
   $ unset FAKEUSER
   $ HGUSER=$olduser
   $ export HGUSER
 
 showconfig with multiple arguments
 
   $ echo "[alias]" > $HGRC
   $ echo "log = log -g" >> $HGRC
   $ echo "[defaults]" >> $HGRC
   $ echo "identify = -n" >> $HGRC
   $ hg showconfig alias defaults
   alias.log=log -g
   defaults.identify=-n
   $ hg showconfig alias alias
   alias.log=log -g
   $ hg showconfig alias.log alias.log
   alias.log=log -g
   $ hg showconfig alias defaults.identify
   alias.log=log -g
   defaults.identify=-n
   $ hg showconfig alias.log defaults.identify
   alias.log=log -g
   defaults.identify=-n
 
 HGPLAIN
 
   $ echo "[ui]" > $HGRC
   $ echo "debug=true" >> $HGRC
   $ echo "fallbackencoding=ASCII" >> $HGRC
   $ echo "quiet=true" >> $HGRC
   $ echo "slash=true" >> $HGRC
   $ echo "traceback=true" >> $HGRC
   $ echo "verbose=true" >> $HGRC
   $ echo "style=~/.hgstyle" >> $HGRC
   $ echo "logtemplate={node}" >> $HGRC
   $ echo "[defaults]" >> $HGRC
   $ echo "identify=-n" >> $HGRC
   $ echo "[alias]" >> $HGRC
   $ echo "log=log -g" >> $HGRC
 
 customized hgrc
 
   $ hg showconfig
   read config from: $TESTTMP/hgrc
   $TESTTMP/hgrc:13: alias.log=log -g
   repo: bundle.mainreporoot=$TESTTMP
   $TESTTMP/hgrc:11: defaults.identify=-n
   $TESTTMP/hgrc:2: ui.debug=true
   $TESTTMP/hgrc:3: ui.fallbackencoding=ASCII
   $TESTTMP/hgrc:4: ui.quiet=true
   $TESTTMP/hgrc:5: ui.slash=true
   $TESTTMP/hgrc:6: ui.traceback=true
   $TESTTMP/hgrc:7: ui.verbose=true
   $TESTTMP/hgrc:8: ui.style=~/.hgstyle
   $TESTTMP/hgrc:9: ui.logtemplate={node}
 
 plain hgrc
 
   $ HGPLAIN=; export HGPLAIN
   $ hg showconfig --config ui.traceback=True --debug
   read config from: $TESTTMP/hgrc
   repo: bundle.mainreporoot=$TESTTMP
   --config: ui.traceback=True
   --verbose: ui.verbose=False
   --debug: ui.debug=True
   --quiet: ui.quiet=False
 
 with environment variables
 
   $ PAGER=p1 EDITOR=e1 VISUAL=e2 hg showconfig --debug
   set config by: $EDITOR
   set config by: $VISUAL
   set config by: $PAGER
   read config from: $TESTTMP/hgrc
   repo: bundle.mainreporoot=$TESTTMP
   $PAGER: pager.pager=p1
   $VISUAL: ui.editor=e2
   --verbose: ui.verbose=False
   --debug: ui.debug=True
   --quiet: ui.quiet=False
 
 plain mode with exceptions
 
   $ cat > plain.py <<EOF
   > from mercurial import commands, extensions
   > def _config(orig, ui, repo, *values, **opts):
   >     ui.write(b'plain: %r\n' % ui.plain())
   >     return orig(ui, repo, *values, **opts)
   > def uisetup(ui):
   >     extensions.wrapcommand(commands.table, b'config', _config)
   > EOF
   $ echo "[extensions]" >> $HGRC
   $ echo "plain=./plain.py" >> $HGRC
   $ HGPLAINEXCEPT=; export HGPLAINEXCEPT
   $ hg showconfig --config ui.traceback=True --debug
   plain: True
   read config from: $TESTTMP/hgrc
   repo: bundle.mainreporoot=$TESTTMP
   $TESTTMP/hgrc:15: extensions.plain=./plain.py
   --config: ui.traceback=True
   --verbose: ui.verbose=False
   --debug: ui.debug=True
   --quiet: ui.quiet=False
   $ unset HGPLAIN
   $ hg showconfig --config ui.traceback=True --debug
   plain: True
   read config from: $TESTTMP/hgrc
   repo: bundle.mainreporoot=$TESTTMP
   $TESTTMP/hgrc:15: extensions.plain=./plain.py
   --config: ui.traceback=True
   --verbose: ui.verbose=False
   --debug: ui.debug=True
   --quiet: ui.quiet=False
   $ HGPLAINEXCEPT=i18n; export HGPLAINEXCEPT
   $ hg showconfig --config ui.traceback=True --debug
   plain: True
   read config from: $TESTTMP/hgrc
   repo: bundle.mainreporoot=$TESTTMP
   $TESTTMP/hgrc:15: extensions.plain=./plain.py
   --config: ui.traceback=True
   --verbose: ui.verbose=False
   --debug: ui.debug=True
   --quiet: ui.quiet=False
 
 source of paths is not mangled
 
   $ cat >> $HGRCPATH <<EOF
   > [paths]
   > foo = bar
   > EOF
   $ hg showconfig --debug paths
   plain: True
   read config from: $TESTTMP/hgrc
   $TESTTMP/hgrc:17: paths.foo=$TESTTMP/bar