external/aurweb
0
0
Fork 0
mirror of https://gitlab.archlinux.org/archlinux/aurweb.git synced 2025-02-03 10:43:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

rendercomment: respectful linkification of Git commits

Browse source 
Turn the git-commits markdown processor into an inline processor, which
is smart enough not to convert Git hashes contained in code blocks or
links.

Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org>
This commit is contained in:
Frédéric Mangano-Tarumi 2020-01-30 03:35:12 +01:00 • committed by Lukas Fleischer
parent 8ff21fd39c
commit c277a3de8f
1 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
aurweb/scripts/rendercomment.py
View file

@ -40,19 +40,26 @@ class FlysprayLinksExtension(markdown.extensions.Extension):
md.preprocessors.add('flyspray-links', preprocessor, '_end') md.preprocessors.add('flyspray-links', preprocessor, '_end')
class GitCommitsPreprocessor(markdown.preprocessors.Preprocessor): class GitCommitsInlineProcessor(markdown.inlinepatterns.InlineProcessor):
_oidre = re.compile(r'(\b)([0-9a-f]{7,40})(\b)') """
Turn Git hashes like f7f5152be5ab into links to AUR's cgit.
Only commit references that do exist are linkified. Hashes are shortened to
shorter non-ambiguous prefixes. Only hashes with at least 7 digits are
considered.
"""
_repo = pygit2.Repository(repo_path) _repo = pygit2.Repository(repo_path)
_head = None
def __init__(self, md, head): def __init__(self, md, head):
self._head = head self._head = head
super(markdown.preprocessors.Preprocessor, self).__init__(md) super().__init__(r'\b([0-9a-f]{7,40})\b', md)
def handleMatch(self, m): def handleMatch(self, m, data):
oid = m.group(2) oid = m.group(1)
if oid not in self._repo: if oid not in self._repo:
return oid # Unkwown OID; preserve the orginal text.
return None, None, None
prefixlen = 12 prefixlen = 12
while prefixlen < 40: while prefixlen < 40:
@ -60,13 +67,10 @@ class GitCommitsPreprocessor(markdown.preprocessors.Preprocessor):
break break
prefixlen += 1 prefixlen += 1
html = '[`' + oid[:prefixlen] + '`]' el = markdown.util.etree.Element('a')
html += '(' + commit_uri % (self._head, oid[:prefixlen]) + ')' el.set('href', commit_uri % (self._head, oid[:prefixlen]))
el.text = markdown.util.AtomicString(oid[:prefixlen])
return html return el, m.start(0), m.end(0)
def run(self, lines):
return [self._oidre.sub(self.handleMatch, line) for line in lines]
class GitCommitsExtension(markdown.extensions.Extension): class GitCommitsExtension(markdown.extensions.Extension):
@ -77,8 +81,8 @@ class GitCommitsExtension(markdown.extensions.Extension):
super(markdown.extensions.Extension, self).__init__() super(markdown.extensions.Extension, self).__init__()
def extendMarkdown(self, md, md_globals): def extendMarkdown(self, md, md_globals):
preprocessor = GitCommitsPreprocessor(md, self._head) processor = GitCommitsInlineProcessor(md, self._head)
md.preprocessors.add('git-commits', preprocessor, '_end') md.inlinePatterns.add('git-commits', processor, '_end')
class HeadingTreeprocessor(markdown.treeprocessors.Treeprocessor): class HeadingTreeprocessor(markdown.treeprocessors.Treeprocessor):