boartty/gertty/commentlink.py
James E. Blair 844634b2f6 Add hyperlinks
Add a 'link' commentlink substitution type that is a hyperlink
which will open the link in the user's web browser.  A built-in
configuration will apply this automaticlly to most http(s)?://
links (using a very simple and not entirely correct regex).

My current commentlink section in my config is as follows:

  commentlinks:
    - match: "^- (?P<job>.*?) (?P<url>.*?) : (?P<result>.*?) (?P<rest>.*)$"
      replacements:
        - link:
            text: "{job:<42}"
            url: "{url}"
        - text:
            color: "test-{result}"
            text: "{result} "
        - text: "{rest}"

In order to support the Zuul commentlink syntax.

Change-Id: Ifceee547c116fdcc15b50a2f73a0ddfe2e98af84
2014-05-30 08:44:22 -07:00

81 lines
2.7 KiB
Python

# Copyright 2014 OpenStack Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import re
import urwid
import mywid
class TextReplacement(object):
def __init__(self, config):
if isinstance(config, basestring):
self.color = None
self.text = config
else:
self.color = config.get('color')
self.text = config['text']
def replace(self, app, data):
if self.color:
return (self.color.format(**data), self.text.format(**data))
return (None, self.text.format(**data))
class LinkReplacement(object):
def __init__(self, config):
self.url = config['url']
self.text = config['text']
def replace(self, app, data):
link = mywid.Link(self.text.format(**data), 'link', 'focused-link')
urwid.connect_signal(link, 'selected',
lambda link:app.openURL(self.url.format(**data)))
app.log.debug("link %s" % link)
return link
class CommentLink(object):
def __init__(self, config):
self.match = re.compile(config['match'], re.M)
self.replacements = []
for r in config['replacements']:
if 'text' in r:
self.replacements.append(TextReplacement(r['text']))
if 'link' in r:
self.replacements.append(LinkReplacement(r['link']))
def run(self, app, chunks):
ret = []
for chunk in chunks:
if not isinstance(chunk, basestring):
# We don't currently support nested commentlinks; if
# we have something that isn't a string, just append
# it to the output.
ret.append(chunk)
continue
if not chunk:
ret += [chunk]
while chunk:
m = self.match.search(chunk)
if not m:
ret.append(chunk)
break
before = chunk[:m.start()]
after = chunk[m.end():]
if before:
ret.append(before)
ret += [r.replace(app, m.groupdict()) for r in self.replacements]
chunk = after
return ret