mautrix-signal/mautrix_signal/puppet.py
2020-09-28 02:03:47 +03:00

292 lines
11 KiB
Python

# mautrix-signal - A Matrix-Signal puppeting bridge
# Copyright (C) 2020 Tulir Asokan
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from typing import (Optional, Dict, AsyncIterable, Awaitable, AsyncGenerator, Union,
TYPE_CHECKING, cast)
from uuid import UUID
import asyncio
from mausignald.types import Address, Contact, Profile
from mautrix.bridge import BasePuppet
from mautrix.appservice import IntentAPI
from mautrix.types import UserID, SyncToken, RoomID
from mautrix.util.simple_template import SimpleTemplate
from .db import Puppet as DBPuppet
from .config import Config
from . import portal as p
if TYPE_CHECKING:
from .__main__ import SignalBridge
try:
import phonenumbers
except ImportError:
phonenumbers = None
class Puppet(DBPuppet, BasePuppet):
by_uuid: Dict[UUID, 'Puppet'] = {}
by_number: Dict[str, 'Puppet'] = {}
by_custom_mxid: Dict[UserID, 'Puppet'] = {}
hs_domain: str
mxid_template: SimpleTemplate[str]
config: Config
default_mxid_intent: IntentAPI
default_mxid: UserID
_uuid_lock: asyncio.Lock
_update_info_lock: asyncio.Lock
def __init__(self, uuid: Optional[UUID], number: Optional[str],
name: Optional[str] = None, uuid_registered: bool = False,
number_registered: bool = False, custom_mxid: Optional[UserID] = None,
access_token: Optional[str] = None, next_batch: Optional[SyncToken] = None
) -> None:
super().__init__(uuid=uuid, number=number, name=name, uuid_registered=uuid_registered,
number_registered=number_registered, custom_mxid=custom_mxid,
access_token=access_token, next_batch=next_batch)
self.log = self.log.getChild(str(uuid) or number)
self.default_mxid = self.get_mxid_from_id(self.address)
self.default_mxid_intent = self.az.intent.user(self.default_mxid)
self.intent = self._fresh_intent()
self._uuid_lock = asyncio.Lock()
self._update_info_lock = asyncio.Lock()
@classmethod
def init_cls(cls, bridge: 'SignalBridge') -> AsyncIterable[Awaitable[None]]:
cls.config = bridge.config
cls.loop = bridge.loop
cls.mx = bridge.matrix
cls.az = bridge.az
cls.hs_domain = cls.config["homeserver.domain"]
cls.mxid_template = SimpleTemplate(cls.config["bridge.username_template"], "userid",
prefix="@", suffix=f":{cls.hs_domain}", type=str)
cls.sync_with_custom_puppets = cls.config["bridge.sync_with_custom_puppets"]
secret = cls.config["bridge.login_shared_secret"]
cls.login_shared_secret = secret.encode("utf-8") if secret else None
cls.login_device_name = "Signal Bridge"
return (puppet.try_start() async for puppet in cls.all_with_custom_mxid())
def intent_for(self, portal: 'p.Portal') -> IntentAPI:
if portal.chat_id == self.uuid:
return self.default_mxid_intent
return self.intent
@property
def is_registered(self) -> bool:
return (self.uuid is not None and self.uuid_registered) or self.number_registered
@is_registered.setter
def is_registered(self, value: bool) -> None:
if self.uuid is not None:
self.uuid_registered = value
else:
self.number_registered = value
@property
def address(self) -> Address:
return Address(uuid=self.uuid, number=self.number)
async def handle_uuid_receive(self, uuid: UUID) -> None:
async with self._uuid_lock:
if self.uuid:
# Received UUID was handled while this call was waiting
return
await self._handle_uuid_receive(uuid)
async def _handle_uuid_receive(self, uuid: UUID) -> None:
self.log.debug(f"Found UUID for user: {uuid}")
await self._set_uuid(uuid)
self.by_uuid[self.uuid] = self
prev_intent = self.default_mxid_intent
self.default_mxid = self.get_mxid_from_id(self.address)
self.default_mxid_intent = self.az.intent.user(self.default_mxid)
self.intent = self._fresh_intent()
self.log = self.log.getChild(str(uuid))
self.log.debug(f"Migrating memberships {prev_intent.mxid} -> {self.default_mxid_intent}")
for room_id in await prev_intent.get_joined_rooms():
await prev_intent.invite_user(room_id, self.default_mxid)
await self.default_mxid_intent.join_room_by_id(room_id)
await prev_intent.leave_room(room_id)
async def update_info(self, info: Union[Profile, Contact]) -> None:
if isinstance(info, Contact):
if info.address.uuid and not self.uuid:
await self.handle_uuid_receive(info.address.uuid)
if not self.config["bridge.allow_contact_list_name_updates"] and self.name is not None:
return
async with self._update_info_lock:
update = False
update = await self._update_name(info.name) or update
if update:
await self.update()
@staticmethod
def fmt_phone(number: str) -> str:
if phonenumbers is None:
return number
parsed = phonenumbers.parse(number)
fmt = phonenumbers.PhoneNumberFormat.INTERNATIONAL
return phonenumbers.format_number(parsed, fmt)
@classmethod
def _get_displayname(cls, address: Address, name: Optional[str]) -> str:
names = name.split("\x00") if name else []
data = {
"first_name": names[0] if len(names) > 0 else "",
"last_name": names[-1] if len(names) > 1 else "",
"full_name": " ".join(names),
"phone": cls.fmt_phone(address.number),
"uuid": str(address.uuid) if address.uuid else None,
}
for pref in cls.config["bridge.displayname_preference"]:
value = data.get(pref.replace(" ", "_"))
if value:
data["displayname"] = value
break
return cls.config["bridge.displayname_template"].format(**data)
async def _update_name(self, name: Optional[str]) -> bool:
name = self._get_displayname(self.address, name)
if name != self.name:
self.name = name
await self.default_mxid_intent.set_displayname(self.name)
self.loop.create_task(self._update_portal_names())
return True
return False
async def _update_portal_names(self) -> None:
async for portal in p.Portal.find_private_chats_with(self.uuid):
await portal.update_puppet_name(self.name)
async def default_puppet_should_leave_room(self, room_id: RoomID) -> bool:
portal = await p.Portal.get_by_mxid(room_id)
return portal and portal.chat_id != self.uuid
# region Database getters
def _add_to_cache(self) -> None:
if self.uuid:
self.by_uuid[self.uuid] = self
if self.number:
self.by_number[self.number] = self
if self.custom_mxid:
self.by_custom_mxid[self.custom_mxid] = self
async def save(self) -> None:
await self.update()
@classmethod
async def get_by_mxid(cls, mxid: UserID, create: bool = True) -> Optional['Puppet']:
address = cls.get_id_from_mxid(mxid)
if not address:
return None
return await cls.get_by_address(address, create)
@classmethod
async def get_by_custom_mxid(cls, mxid: UserID) -> Optional['Puppet']:
try:
return cls.by_custom_mxid[mxid]
except KeyError:
pass
puppet = cast(cls, await super().get_by_custom_mxid(mxid))
if puppet:
puppet._add_to_cache()
return puppet
return None
@classmethod
def get_id_from_mxid(cls, mxid: UserID) -> Optional[Address]:
identifier = cls.mxid_template.parse(mxid)
if not identifier:
return None
if identifier.startswith("phone_"):
return Address(number="+" + identifier[len("phone_"):])
else:
try:
return Address(uuid=UUID(identifier.upper()))
except ValueError:
return None
@classmethod
def get_mxid_from_id(cls, address: Address) -> UserID:
if address.uuid:
identifier = str(address.uuid).lower()
elif address.number:
identifier = f"phone_{address.number.lstrip('+')}"
else:
raise ValueError("Empty address")
return UserID(cls.mxid_template.format_full(identifier))
@classmethod
async def get_by_address(cls, address: Address, create: bool = True) -> Optional['Puppet']:
puppet = await cls._get_by_address(address, create)
if puppet and address.uuid and not puppet.uuid:
# We found a UUID for this user, store it ASAP
await puppet.handle_uuid_receive(address.uuid)
return puppet
@classmethod
async def _get_by_address(cls, address: Address, create: bool = True) -> Optional['Puppet']:
if not address.is_valid:
raise ValueError("Empty address")
if address.uuid:
try:
return cls.by_uuid[address.uuid]
except KeyError:
pass
if address.number:
try:
return cls.by_number[address.number]
except KeyError:
pass
puppet = cast(cls, await super().get_by_address(address))
if puppet is not None:
puppet._add_to_cache()
return puppet
if create:
puppet = cls(address.uuid, address.number)
await puppet.insert()
puppet._add_to_cache()
return puppet
return None
@classmethod
async def all_with_custom_mxid(cls) -> AsyncGenerator['Puppet', None]:
puppets = await super().all_with_custom_mxid()
puppet: cls
for index, puppet in enumerate(puppets):
try:
yield cls.by_uuid[puppet.uuid]
except KeyError:
try:
yield cls.by_number[puppet.number]
except KeyError:
puppet._add_to_cache()
yield puppet
# endregion