Commit 96f3bd72 authored by Maxime Buquet's avatar Maxime Buquet

Merge branch 'plugin-untrackme' into 'master'

Plugin untrackme

See merge request !154
parents a72a4845 c9f33124
Pipeline #3329 passed with stages
in 6 minutes and 47 seconds
...@@ -6,6 +6,8 @@ import re ...@@ -6,6 +6,8 @@ import re
class Plugin(BasePlugin): class Plugin(BasePlugin):
def init(self): def init(self):
self.api.information('This plugin is deprecated and will be replaced by \'untrackme\'.', 'Warning')
self.api.add_event_handler('muc_say', self.remove_get_trackers) self.api.add_event_handler('muc_say', self.remove_get_trackers)
self.api.add_event_handler('conversation_say', self.remove_get_trackers) self.api.add_event_handler('conversation_say', self.remove_get_trackers)
self.api.add_event_handler('private_say', self.remove_get_trackers) self.api.add_event_handler('private_say', self.remove_get_trackers)
UntrackMe wannabe plugin
from typing import Callable, Dict, List, Tuple, Union
import re
import logging
from slixmpp import Message
from poezio import tabs
from poezio.plugin import BasePlugin
from urllib.parse import quote as urlquote
log = logging.getLogger(__name__)
ChatTabs = Union[
RE_URL: re.Pattern = re.compile('https?://(?P<host>[^/]+)(?P<rest>[^ ]*)')
SERVICES: Dict[str, Tuple[str, bool]] = { # host: (service, proxy)
'': ('invidious', False),
'': ('invidious', False),
'': ('invidious', False),
'': ('invidious', False),
'': ('invidious', False),
'': ('nitter', False),
'': ('nitter', False),
'': ('nitter', False),
'': ('nitter_img', True),
'': ('nitter_img', True),
'': ('bibliogram', False),
'': ('bibliogram', False),
'': ('bibliogram', False),
def proxy(service: str) -> Callable[[str], str]:
"""Some services require the original url"""
def inner(origin: str) -> str:
return service + urlquote(origin)
return inner
class Plugin(BasePlugin):
default_config: Dict[str, str] = {
'default': {
'cleanup': True,
'redirect': True,
'display_corrections': True,
'services': {
'invidious': '',
'nitter': '',
'bibliogram': '',
def init(self):
nitter_img = self.config.get('nitter', section='services') + '/pic/'
self.config.set('nitter_img', nitter_img, section='services')
self.api.add_event_handler('muc_say', self.handle_msg)
self.api.add_event_handler('conversation_say', self.handle_msg)
self.api.add_event_handler('private_say', self.handle_msg)
self.api.add_event_handler('muc_msg', self.handle_msg)
self.api.add_event_handler('conversation_msg', self.handle_msg)
self.api.add_event_handler('private_msg', self.handle_msg)
def map_services(self, match: re.Match) -> str:
If it matches a host that we know about, change the domain for the
alternative service. Some hosts needs to be proxied instead (such
as twitter pictures), so they're url encoded and appended to the
proxy service.
host ='host')
dest = SERVICES.get(host)
if dest is None:
destname, proxy = dest
replaced = self.config.get(destname, section='services')
result = replaced +'rest')
if proxy:
url = urlquote(
result = replaced + url
# TODO: count parenthesis?
# Removes comma at the end of a link.
if result[-3] == '%2C':
result = result[:-3] + ','
return result
def handle_msg(self, msg: Message, tab: ChatTabs) -> None:
orig = msg['body']
if self.config.get('cleanup', section='default'):
msg['body'] = self.cleanup_url(msg['body'])
if self.config.get('redirect', section='default'):
msg['body'] = self.redirect_url(msg['body'])
'UntrackMe in tab \'%s\':\nOriginal: %s\nModified: %s',, orig, msg['body'],
if self.config.get('display_corrections', section='default') and \
msg['body'] != orig:
'UntrackMe in tab \'{}\':\nOriginal: {}\nModified: {}'.format(, orig, msg['body']
def cleanup_url(self, txt: str) -> str:
# fbclid: used globally (Facebook)
# utm_*: used globally
# ncid: DoubleClick (Google)
# ref_src, ref_url: twitter
# Others exist but are excluded because they are not common.
# See
return re.sub('(https?://[^ ]+)&?(fbclid|dclid|ncid|utm_source|utm_medium|utm_campaign|utm_term|utm_content|ref_src|ref_url)=[^ &#]*',
def redirect_url(self, txt: str) -> str:
return RE_URL.sub(self.map_services, txt)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment