Skip to content

Commit

Permalink
dms: noop: rewrite, add a framework
Browse files Browse the repository at this point in the history
  • Loading branch information
@snarfed
snarfed committed Feb 3, 2025
1 parent 4484a8f commit 31e2296
Show file tree
Hide file tree
Showing 2 changed files with 214 additions and 135 deletions.
346 changes: 212 additions & 134 deletions dms.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from oauth_dropins.webutil.flask_util import error
from oauth_dropins.webutil import util

from collections import namedtuple
from common import create_task, DOMAINS
import ids
import memcache
Expand All @@ -33,6 +34,211 @@
'username',
'yes',
)
# populated by the command() decorator
_commands = {}


def command(names, arg=False, user_bridged=None, handle_bridged=None):
"""Function decorator. Defines and registers a DM command.
Args:
names (sequence of str): the command strings that trigger this command, or
``None`` if this command has no command string
arg: whether this command takes an argument. ``False`` for no, ``True``
for yes, anything, ``'handle'`` for yes, a handle in the bot account's
protocol for a user that must not already be bridged.
user_bridged (bool): whether the user sending the DM should be
bridged. ``True`` for yes, ``False`` for no, ``None` for either.
The decorated function should have the signature:
(from_user, to_proto, arg=None, to_user=None) => (str, None)
If it returns a string, that text is sent to the user as a reply to their DM.
Args for the decorated function:
from_user (models.User): the user who sent the DM
to_proto (protocol.Protocol): the protocol bot account they sent it to
arg (str or None): the argument to the command, if any
to_user (models.User or None): the user for the argument, if it's a handle
The decorated function returns:
str: text to reply to the user in a DM, if any
"""
assert arg in (False, True, 'handle'), arg
if handle_bridged:
assert arg == 'handle', arg

def decorator(fn):
def wrapped(from_user, to_proto, cmd, cmd_arg, dm_as1):
def reply(text, type=None):
maybe_send(from_proto=to_proto, to_user=from_user, text=text,
type=type, in_reply_to=dm_as1.get('id'))
return 'OK', 200

if arg == 'handle':
if not to_proto.owns_handle(cmd_arg) and cmd_arg.startswith('@'):
logging.info(f"doesn't look like a handle, trying without leading @")
cmd_arg = cmd_arg.removeprefix('@')

to_user = load_user(to_proto, cmd_arg)
from_proto = from_user.__class__
if not to_user:
return reply(f"Couldn't find {to_proto.PHRASE} user {cmd_arg}")
elif to_user.is_enabled(from_proto):
return reply(f'{to_user.user_link(proto=from_proto)} is already bridged into {from_proto.PHRASE}.')

from_user_enabled = from_user.is_enabled(to_proto)
if user_bridged is True and not from_user_enabled:
return reply(f"Looks like you're not bridged to {to_proto.PHRASE} yet! Please bridge your account first by following this account.")
elif user_bridged is False and from_user_enabled:
return reply(f"Looks like you're already bridged to {to_proto.PHRASE}!")
elif arg and not cmd_arg:
return reply(f'{cmd} command needs an argument<br><br>{help(from_user, to_proto)}')

# dispatch!
kwargs = {}
if cmd_arg:
kwargs['arg'] = cmd_arg
if arg == 'handle':
kwargs['to_user'] = to_user
reply_text = fn(from_user, to_proto, **kwargs)
if reply_text:
reply(reply_text)

return 'OK', 200

if names is None:
assert None not in _commands
_commands[None] = wrapped
else:
assert isinstance(names, (tuple, list))
for name in names:
_commands[name] = wrapped

return wrapped

return decorator


@command(['?', 'help', 'commands', 'info', 'hi', 'hello'])
def help(from_user, to_proto):
extra = ''
if to_proto.LABEL == 'atproto':
extra = """<li><em>did</em>: get your bridged Bluesky account's <a href="https://atproto.com/guides/identity#identifiers">DID</a>"""
return f"""\
<p>Hi! I'm a friendly bot that can help you bridge your account into {to_proto.PHRASE}. Here are some commands I respond to:</p>
<ul>
<li><em>start</em>: enable bridging for your account
<li><em>stop</em>: disable bridging for your account
<li><em>username [domain]</em>: set a custom domain username (handle)
<li><em>[handle]</em>: ask me to DM a user on {to_proto.PHRASE} to request that they bridge their account into {from_user.PHRASE}
<li><em>block [handle]</em>: block a user on {to_proto.PHRASE} who's not bridged here
{extra}
<li><em>help</em>: print this message
</ul>"""


@command(['yes', 'ok', 'start'], user_bridged=False)
def start(from_user, to_proto):
from_user.enable_protocol(to_proto)
to_proto.bot_follow(from_user)


@command(['no', 'stop'])
def stop(from_user, to_proto, user_bridged=True):
from_user.delete(to_proto)
from_user.disable_protocol(to_proto)


@command(['did'], user_bridged=True)
def did(from_user, to_proto):
if to_proto.LABEL == 'atproto':
return f'Your DID is <code>{from_user.get_copy(PROTOCOLS["atproto"])}</code>'


@command(['username', 'handle'], arg=True, user_bridged=True)
def username(from_user, to_proto, arg):
try:
to_proto.set_username(from_user, arg)
except NotImplementedError:
return f"Sorry, Bridgy Fed doesn't support custom usernames for {to_proto.PHRASE} yet."
except (ValueError, RuntimeError) as e:
return str(e)

return f"Your username in {to_proto.PHRASE} has been set to {from_user.user_link(proto=to_proto, name=False, handle=True)}. It should appear soon!"


@command(['block'], arg='handle', user_bridged=True)
def block(from_user, to_proto, arg, to_user):
id = f'{from_user.key.id()}#bridgy-fed-block-{util.now().isoformat()}'
obj = Object(id=id, source_protocol=from_user.LABEL, our_as1={
'objectType': 'activity',
'verb': 'block',
'id': id,
'actor': from_user.key.id(),
'object': to_user.key.id(),
})
obj.put()
from_user.deliver(obj, from_user=from_user)
return f"""OK, you're now blocking {to_user.user_link()} on {to_proto.PHRASE}."""


@command(['unblock'], arg='handle', user_bridged=True)
def unblock(from_user, to_proto, arg, to_user):
id = f'{from_user.key.id()}#bridgy-fed-unblock-{util.now().isoformat()}'
obj = Object(id=id, source_protocol=from_user.LABEL, our_as1={
'objectType': 'activity',
'verb': 'undo',
'id': id,
'actor': from_user.key.id(),
'object': {
'objectType': 'activity',
'verb': 'block',
'actor': from_user.key.id(),
'object': to_user.key.id(),
},
})
obj.put()
from_user.deliver(obj, from_user=from_user)
return f"""OK, you're not blocking {to_user.user_link()} on {to_proto.PHRASE}."""


@command(None, arg='handle', user_bridged=True) # no command, just the handle, alone
def prompt(from_user, to_proto, arg, to_user):
from_proto = from_user.__class__
try:
ids.translate_handle(handle=arg, from_=to_proto, to=from_user, enhanced=False)
except ValueError as e:
logger.warning(e)
return f"Sorry, Bridgy Fed doesn't yet support bridging handle {arg} from {to_proto.PHRASE} to {from_proto.PHRASE}."

if to_user.is_enabled(from_proto):
# already bridged
return f'{to_user.user_link(proto=from_proto)} is already bridged into {from_proto.PHRASE}.'

elif (models.DM(protocol=from_proto.LABEL, type='request_bridging')
in to_user.sent_dms):
# already requested
return f"We've already sent {to_user.user_link()} a DM. Fingers crossed!"

# check and update rate limits
attempts_key = f'dm-user-requests-{from_user.LABEL}-{from_user.key.id()}'
# incr leaves existing expiration as is, doesn't change it
# https://stackoverflow.com/a/4084043/186123
attempts = memcache.memcache.incr(attempts_key, 1)
if not attempts:
memcache.memcache.add(
attempts_key, 1,
expire=int(REQUESTS_LIMIT_EXPIRE.total_seconds()))
elif attempts > REQUESTS_LIMIT_USER:
return f"Sorry, you've hit your limit of {REQUESTS_LIMIT_USER} requests per day. Try again tomorrow!"

# send the DM request!
maybe_send(from_proto=from_proto, to_user=to_user, type='request_bridging', text=f"""\
<p>Hi! {from_user.user_link(proto=to_proto, proto_fallback=True)} is using Bridgy Fed to bridge their account from {from_proto.PHRASE} into {to_proto.PHRASE}, and they'd like to follow you. You can bridge your account into {from_proto.PHRASE} by following this account. <a href="https://fed.brid.gy/docs">See the docs</a> for more information.
<p>If you do nothing, your account won't be bridged, and users on {from_proto.PHRASE} won't be able to see or interact with you.
<p>Bridgy Fed will only send you this message once.""")
return f"Got it! We'll send {to_user.user_link()} a message and say that you hope they'll enable the bridge. Fingers crossed!"


def maybe_send(*, from_proto, to_user, text, type=None, in_reply_to=None):
Expand Down Expand Up @@ -114,12 +320,12 @@ def receive(*, from_user, obj):
to_proto = protocol.Protocol.for_bridgy_subdomain(recip)
assert to_proto # already checked in check_supported call in Protocol.receive

inner_obj = (as1.get_object(obj.as1) if as1.object_type(obj.as1) == 'post'
inner_as1 = (as1.get_object(obj.as1) if as1.object_type(obj.as1) == 'post'
else obj.as1)
logger.info(f'got DM from {from_user.key.id()} to {to_proto.LABEL}: {inner_obj.get("content")}')
logger.info(f'got DM from {from_user.key.id()} to {to_proto.LABEL}: {inner_as1.get("content")}')

# parse message
text = source.html_to_text(inner_obj.get('content', ''))
text = source.html_to_text(inner_as1.get('content', ''))
tokens = text.strip().lower().split()
logger.info(f' tokens: {tokens}')

Expand All @@ -140,138 +346,10 @@ def receive(*, from_user, obj):
cmd = None
arg = tokens[0]

# handle commands
def reply(text, type=None):
maybe_send(from_proto=to_proto, to_user=from_user, text=text, type=type,
in_reply_to=inner_obj.get('id'))
return 'OK', 200

if cmd in ('?', 'help', 'commands', 'info', 'hi', 'hello'):
extra = ''
if to_proto.LABEL == 'atproto':
extra = """<li><em>did</em>: get your bridged Bluesky account's <a href="https://atproto.com/guides/identity#identifiers">DID</a>"""
return reply(f"""\
<p>Hi! I'm a friendly bot that can help you bridge your account into {to_proto.PHRASE}. Here are some commands I respond to:</p>
<ul>
<li><em>start</em>: enable bridging for your account
<li><em>stop</em>: disable bridging for your account
<li><em>username [domain]</em>: set a custom domain username (handle)
<li><em>[handle]</em>: ask me to DM a user on {to_proto.PHRASE} to request that they bridge their account into {from_user.PHRASE}
<li><em>block [handle]</em>: block a user on {to_proto.PHRASE} who's not bridged here
{extra}
<li><em>help</em>: print this message
</ul>""")

if cmd in ('yes', 'ok', 'start') and not arg:
from_user.enable_protocol(to_proto)
to_proto.bot_follow(from_user)
return 'OK', 200

# all other commands require the user to be bridged to this protocol first
if not from_user.is_enabled(to_proto):
return reply(f"Looks like you're not bridged to {to_proto.PHRASE} yet! Please bridge your account first by following this account.")

if cmd == 'did' and not arg and to_proto.LABEL == 'atproto':
return reply(f'Your DID is <code>{from_user.get_copy(PROTOCOLS["atproto"])}</code>')
return 'OK', 200

if cmd in ('no', 'stop') and not arg:
from_user.delete(to_proto)
from_user.disable_protocol(to_proto)
return 'OK', 200

if cmd in ('username', 'handle') and arg:
try:
to_proto.set_username(from_user, arg)
except NotImplementedError:
return reply(f"Sorry, Bridgy Fed doesn't support custom usernames for {to_proto.PHRASE} yet.")
except (ValueError, RuntimeError) as e:
return reply(str(e))
return reply(f"Your username in {to_proto.PHRASE} has been set to {from_user.user_link(proto=to_proto, name=False, handle=True)}. It should appear soon!")

if cmd in ('block', 'unblock') and arg:
handle = arg
if not to_proto.owns_handle(handle) and handle.startswith('@'):
logging.info(f"doesn't look like a handle, trying without leading @")
handle = handle.removeprefix('@')

to_user = load_user(to_proto, handle)
if not to_user:
return reply(f"Couldn't find {to_proto.PHRASE} user {handle}")

obj_as1 = {
'objectType': 'activity',
'verb': 'block',
'actor': from_user.key.id(),
'object': to_user.key.id(),
}

if cmd == 'block':
msg = f"""OK, you're now blocking {to_user.user_link()} on {to_proto.PHRASE}."""
elif cmd == 'unblock':
obj_as1 = {
'objectType': 'activity',
'verb': 'undo',
'actor': from_user.key.id(),
'object': obj_as1,
}
msg = f"""OK, you're not blocking {to_user.user_link()} on {to_proto.PHRASE}."""

id = f'{from_user.key.id()}#bridgy-fed-{cmd}-{util.now().isoformat()}'
obj_as1['id'] = id
obj = Object(id=id, source_protocol=from_user.LABEL, our_as1=obj_as1)
obj.put()
from_user.deliver(obj, from_user=from_user)
return reply(msg)

# are they requesting a user?
if not cmd:
handle = arg
if not to_proto.owns_handle(handle) and handle.startswith('@'):
logging.info(f"doesn't look like a handle, trying without leading @")
handle = handle.removeprefix('@')

to_user = load_user(to_proto, handle)
if not to_user:
return reply(f"Couldn't find {to_proto.PHRASE} user {handle}")

from_proto = from_user.__class__
try:
ids.translate_handle(handle=handle, from_=to_proto, to=from_user,
enhanced=False)
except ValueError as e:
logger.warning(e)
return reply(f"Sorry, Bridgy Fed doesn't yet support bridging handle {handle} from {to_proto.PHRASE} to {from_proto.PHRASE}.")

if to_user.is_enabled(from_proto):
# already bridged
return reply(f'{to_user.user_link(proto=from_proto)} is already bridged into {from_proto.PHRASE}.')

elif (models.DM(protocol=from_proto.LABEL, type='request_bridging')
in to_user.sent_dms):
# already requested
return reply(f"We've already sent {to_user.user_link()} a DM. Fingers crossed!")

# check and update rate limits
attempts_key = f'dm-user-requests-{from_user.LABEL}-{from_user.key.id()}'
# incr leaves existing expiration as is, doesn't change it
# https://stackoverflow.com/a/4084043/186123
attempts = memcache.memcache.incr(attempts_key, 1)
if not attempts:
memcache.memcache.add(
attempts_key, 1,
expire=int(REQUESTS_LIMIT_EXPIRE.total_seconds()))
elif attempts > REQUESTS_LIMIT_USER:
return reply(f"Sorry, you've hit your limit of {REQUESTS_LIMIT_USER} requests per day. Try again tomorrow!")

# send the DM request!
maybe_send(from_proto=from_proto, to_user=to_user, type='request_bridging', text=f"""\
<p>Hi! {from_user.user_link(proto=to_proto, proto_fallback=True)} is using Bridgy Fed to bridge their account from {from_proto.PHRASE} into {to_proto.PHRASE}, and they'd like to follow you. You can bridge your account into {from_proto.PHRASE} by following this account. <a href="https://fed.brid.gy/docs">See the docs</a> for more information.
<p>If you do nothing, your account won't be bridged, and users on {from_proto.PHRASE} won't be able to see or interact with you.
<p>Bridgy Fed will only send you this message once.""")
return reply(f"Got it! We'll send {to_user.user_link()} a message and say that you hope they'll enable the bridge. Fingers crossed!")
if fn := _commands.get(cmd):
return fn(from_user, to_proto, cmd, arg, inner_as1)

error(f"Couldn't understand DM: {tokens}", status=304)
error(f"Couldn't understand DM: {text}", status=304)


def load_user(proto, handle):
Expand Down
3 changes: 2 additions & 1 deletion tests/test_dms.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,9 @@ def test_receive_no_yes_sets_enabled_protocols(self):
self.assertEqual(('OK', 200), receive(from_user=user, obj=dm))
user = user.key.get()
self.assertEqual(['fake'], user.enabled_protocols)
self.assertEqual([], Fake.created_for)
self.assertTrue(user.is_enabled(Fake))
self.assertEqual(['efake:user'], Fake.created_for)
self.assert_replied(OtherFake, alice, '?', "Looks like you're already bridged to fake-phrase!")

# "no" DM should remove from enabled_protocols
Follower.get_or_create(to=user, from_=alice)
Expand Down

0 comments on commit 31e2296

Please sign in to comment.