This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8810

templater: handle None returned from templatedir()
ClosedPublic

Authored by martinvonz on Jul 24 2020, 5:47 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGd5ccc059fbcd: templater: handle None returned from templatedir()
Summary

My recent 91aa9bba3dc9 (templater: make templatepaths() return a
single path, or None, 2020-07-21) didn't account for the fact that
templatedir() returns None in frozen binaries. That is ironic,
since the reason I'm working on this is to add support for built-in
mapfiles in frozen binaries. This patch updates the callers to handle
the None case. It's somewhat ugly, but I will have to revisit this
soon anyway, since my goal is to make all callers handle that case by
trying to read the map file using the resources API instead.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Revision Contents
Changeset List

Diff 22114

mercurial/debugcommands.py

re2 = b'missing' re2 = b'missing'
if util._re2: if util._re2:
re2 = b'available' re2 = b'available'
fm.plain(_(b'checking "re2" regexp engine (%s)\n') % re2) fm.plain(_(b'checking "re2" regexp engine (%s)\n') % re2)
fm.data(re2=bool(util._re2)) fm.data(re2=bool(util._re2))
# templates # templates
p = templater.templatedir() p = templater.templatedir()
fm.write(b'templatedirs', b'checking templates (%s)...\n', p) fm.write(b'templatedirs', b'checking templates (%s)...\n', p or b'')
fm.condwrite(not p, b'', _(b" no template directories found\n")) fm.condwrite(not p, b'', _(b" no template directories found\n"))
if p: if p:
m = templater.templatepath(b"map-cmdline.default") m = templater.templatepath(b"map-cmdline.default")
if m: if m:
# template found, check if it is working # template found, check if it is working
err = None err = None
try: try:
templater.templater.frommapfile(m) templater.templater.frommapfile(m)

mercurial/hgweb/hgwebdir_mod.py

if virtual.startswith(b'static/') or b'static' in req.qsparams: if virtual.startswith(b'static/') or b'static' in req.qsparams:
if virtual.startswith(b'static/'): if virtual.startswith(b'static/'):
fname = virtual[7:] fname = virtual[7:]
else: else:
fname = req.qsparams[b'static'] fname = req.qsparams[b'static']
static = self.ui.config(b"web", b"static", untrusted=False) static = self.ui.config(b"web", b"static", untrusted=False)
if not static: if not static:
tp = self.templatepath or templater.templatedir() tp = self.templatepath or templater.templatedir()
if tp is not None:
static = [os.path.join(tp, b'static')] static = [os.path.join(tp, b'static')]
staticfile(static, fname, res) staticfile(static, fname, res)
return res.sendresponse() return res.sendresponse()
# top-level index # top-level index
repos = dict(self.repos) repos = dict(self.repos)

mercurial/templater.py

) )
base = os.path.dirname(mapfile) base = os.path.dirname(mapfile)
conf = config.config() conf = config.config()
def include(rel, abs, remap, sections): def include(rel, abs, remap, sections):
templatedirs = [base, templatedir()] templatedirs = [base, templatedir()]
for dir in templatedirs: for dir in templatedirs:
if dir is None:
continue
abs = os.path.normpath(os.path.join(dir, rel)) abs = os.path.normpath(os.path.join(dir, rel))
if os.path.isfile(abs): if os.path.isfile(abs):
data = util.posixfile(abs, b'rb').read() data = util.posixfile(abs, b'rb').read()
conf.parse( conf.parse(
abs, data, sections=sections, remap=remap, include=include abs, data, sections=sections, remap=remap, include=include
) )
break break
data = util.posixfile(mapfile, b'rb').read() data = util.posixfile(mapfile, b'rb').read()
conf.parse(mapfile, data, remap={b'': b'templates'}, include=include) conf.parse(mapfile, data, remap={b'': b'templates'}, include=include)
cache = {} cache = {}
tmap = {} tmap = {}
aliases = [] aliases = []
val = conf.get(b'templates', b'__base__') val = conf.get(b'templates', b'__base__')
if val and val[0] not in b"'\"": if val and val[0] not in b"'\"":
# treat as a pointer to a base class for this style # treat as a pointer to a base class for this style
path = util.normpath(os.path.join(base, val)) path = util.normpath(os.path.join(base, val))
# fallback check in template paths # fallback check in template paths
if not os.path.exists(path): if not os.path.exists(path):
p2 = util.normpath(os.path.join(templatedir(), val)) dir = templatedir()
if dir is not None:
p2 = util.normpath(os.path.join(dir, val))
if os.path.isfile(p2): if os.path.isfile(p2):
path = p2 path = p2
else: else:
p3 = util.normpath(os.path.join(p2, b"map")) p3 = util.normpath(os.path.join(p2, b"map"))
if os.path.isfile(p3): if os.path.isfile(p3):
path = p3 path = p3
cache, tmap, aliases = _readmapfile(path) cache, tmap, aliases = _readmapfile(path)
for key, val in conf[b'templates'].items(): for key, val in conf[b'templates'].items():
if not val: if not val:
raise error.ParseError( raise error.ParseError(
_(b'missing value'), conf.source(b'templates', key) _(b'missing value'), conf.source(b'templates', key)
) )
def templatedir(): def templatedir():
'''return the directory used for template files, or None.''' '''return the directory used for template files, or None.'''
path = os.path.normpath(os.path.join(resourceutil.datapath, b'templates')) path = os.path.normpath(os.path.join(resourceutil.datapath, b'templates'))
return path if os.path.isdir(path) else None return path if os.path.isdir(path) else None
def templatepath(name): def templatepath(name):
'''return location of template file. returns None if not found.''' '''return location of template file. returns None if not found.'''
dir = templatedir()
if dir is None:
return None
f = os.path.join(templatedir(), name) f = os.path.join(templatedir(), name)
if f and os.path.exists(f): if f and os.path.exists(f):
return f return f
return None return None
def stylemap(styles, path=None): def stylemap(styles, path=None):
"""Return path to mapfile for a given style. """Return path to mapfile for a given style.
Searches mapfile in the following locations: Searches mapfile in the following locations:
1. templatepath/style/map 1. templatepath/style/map
2. templatepath/map-style 2. templatepath/map-style
3. templatepath/map 3. templatepath/map
""" """
if path is None: if path is None:
path = templatedir() path = templatedir()
if isinstance(styles, bytes): if isinstance(styles, bytes):
styles = [styles] styles = [styles]
if path is not None:
for style in styles: for style in styles:
# only plain name is allowed to honor template paths # only plain name is allowed to honor template paths
if ( if (
not style not style
or style in (pycompat.oscurdir, pycompat.ospardir) or style in (pycompat.oscurdir, pycompat.ospardir)
or pycompat.ossep in style or pycompat.ossep in style
or pycompat.osaltsep or pycompat.osaltsep
and pycompat.osaltsep in style and pycompat.osaltsep in style
): ):
continue continue
locations = [os.path.join(style, b'map'), b'map-' + style] locations = [os.path.join(style, b'map'), b'map-' + style]
locations.append(b'map') locations.append(b'map')
for location in locations: for location in locations:
mapfile = os.path.join(path, location) mapfile = os.path.join(path, location)
if os.path.isfile(mapfile): if os.path.isfile(mapfile):
return style, mapfile return style, mapfile
raise RuntimeError(b"No hgweb templates found in %r" % path) raise RuntimeError(b"No hgweb templates found in %r" % path)