async def login(evt: CommandEvent) -> EventID:
override_sender = False
if len(evt.args) > 0 and evt.sender.is_admin and evt.args[0]:
override_user_id = UserID(evt.args[0])
try:
Client.parse_user_id(override_user_id)
except ValueError:
return await evt.reply(
f"**Usage:** `$cmdprefix+sp login [override user ID]`\n\n"
f"{override_user_id!r} is not a valid Matrix user ID"
)
orig_user_id = evt.sender.mxid
evt.sender = await u.User.get_and_start_by_mxid(override_user_id)
override_sender = True
if orig_user_id != evt.sender:
await evt.reply(
f"Admin override: logging in as {evt.sender.mxid} instead of {orig_user_id}"
)
if await evt.sender.is_logged_in():
return await evt.reply(f"You are already logged in as {evt.sender.human_tg_id}.")
allow_matrix_login = evt.config["bridge.allow_matrix_login"]
if allow_matrix_login and not override_sender:
evt.sender.command_status = {
"next": enter_phone_or_token,
"action": "Login",
}
nb = "**N.B. Logging in grants the bridge full access to your Telegram account.**"
if evt.config["appservice.public.enabled"]:
prefix = evt.config["appservice.public.external"]
url = f"{prefix}/login?token={evt.public_website.make_token(evt.sender.mxid, '/login')}"
if override_sender:
return await evt.reply(
f"[Click here to log in]({url}) as "
f"[{evt.sender.mxid}](https://matrix.to/#/{evt.sender.mxid})."
)
elif allow_matrix_login:
return await evt.reply(
f"[Click here to log in]({url}). Alternatively, send your phone"
f" number (or bot auth token) here to log in.\n\n{nb}"
)
return await evt.reply(f"[Click here to log in]({url}).\n\n{nb}")
elif allow_matrix_login:
if override_sender:
return await evt.reply(
"This bridge instance does not allow you to log in outside of Matrix. "
"Logging in as another user inside Matrix is not currently possible."
)
return await evt.reply(
"Please send your phone number (or bot auth token) here to start "
f"the login process.\n\n{nb}"
)
return await evt.reply("This bridge instance has been configured to not allow logging in.")
async def exchange_token(request: web.Request) -> web.Response:
try:
data: 'OpenIDPayload' = await request.json()
except json.JSONDecodeError:
raise Error.request_not_json
if "access_token" not in data or "matrix_server_name" not in data:
raise Error.invalid_openid_payload
try:
user_id = await check_openid_token(data["access_token"])
_, homeserver = Client.parse_user_id(user_id)
except (ClientError, json.JSONDecodeError, KeyError, ValueError):
raise Error.invalid_openid_token
if homeserver != data["matrix_server_name"]:
raise Error.homeserver_mismatch
permissions = config.get_permissions(user_id)
if not permissions.user:
raise Error.no_access
token = Token.random(user_id)
await token.insert()
return web.json_response(
{
"user_id": user_id,
"token": token.secret,
"level": permissions.level,
"permissions": {
"docker": permissions.admin,
},
},
headers=account_cors_headers)
def get_permissions(self, mxid: UserID) -> Permissions:
permissions = self["bridge.permissions"]
if mxid in permissions:
return self._get_permissions(mxid)
_, homeserver = Client.parse_user_id(mxid)
if homeserver in permissions:
return self._get_permissions(homeserver)
return self._get_permissions("*")
async def _create_community(self) -> None:
template = self.config["bridge.community_template"]
if not template:
return
localpart, server = MxClient.parse_user_id(self.mxid)
community_localpart = template.format(localpart=localpart, server=server)
self.log.debug(f"Creating personal filtering community {community_localpart}...")
self._community_id, created = await self._community_helper.create(community_localpart)
if created:
await self._community_helper.update(self._community_id, name="Facebook Messenger",
avatar_url=self.config["appservice.bot_avatar"],
short_desc="Your Facebook bridged chats")
await self._community_helper.invite(self._community_id, self.mxid)
def mxid_localpart(self) -> str:
localpart, server = Client.parse_user_id(self.mxid)
return localpart
class KarmaBot(Plugin):
karma_t: Type[Karma]
version: Type[Version]
async def start(self) -> None:
await super().start()
self.config.load_and_update()
self.karma_t, self.version = make_tables(self.database)
@command.new("karma", help="View users' karma or karma top lists")
async def karma(self) -> None:
pass
@karma.subcommand("up", help="Upvote an event")
@command.argument("event_id", "Event ID", required=True)
def upvote(self, evt: MessageEvent, event_id: EventID) -> Awaitable[None]:
return self._vote(evt, event_id, +1)
@karma.subcommand("down", help="Downvote a message")
@command.argument("event_id", "Event ID", required=True)
def downvote(self, evt: MessageEvent,
event_id: EventID) -> Awaitable[None]:
return self._vote(evt, event_id, -1)
@command.passive(UPVOTE)
def upvote(self, evt: MessageEvent, _: Tuple[str]) -> Awaitable[None]:
return self._vote(evt, evt.content.get_reply_to(), +1)
@command.passive(DOWNVOTE)
def downvote(self, evt: MessageEvent, _: Tuple[str]) -> Awaitable[None]:
return self._vote(evt, evt.content.get_reply_to(), -1)
@command.passive(regex=UPVOTE_EMOJI,
field=lambda evt: evt.content.relates_to.key,
event_type=EventType.REACTION,
msgtypes=None)
def upvote_react(self, evt: ReactionEvent,
key: Tuple[str]) -> Awaitable[None]:
try:
return self._vote(evt, evt.content.relates_to.event_id, 1)
except KeyError:
pass
@command.passive(regex=DOWNVOTE_EMOJI,
field=lambda evt: evt.content.relates_to.key,
event_type=EventType.REACTION,
msgtypes=None)
def downvote_react(self, evt: ReactionEvent,
key: Tuple[str]) -> Awaitable[None]:
try:
return self._vote(evt, evt.content.relates_to.event_id, -1)
except KeyError:
pass
@event.on(EventType.ROOM_REDACTION)
async def redact(self, evt: RedactionEvent) -> None:
karma = self.karma_t.get_by_given_from(evt.redacts)
if karma:
self.log.debug(
f"Deleting {karma} due to redaction by {evt.sender}.")
karma.delete()
@karma.subcommand("stats", help="View global karma statistics")
async def karma_stats(self, evt: MessageEvent) -> None:
await evt.reply("Not yet implemented :(")
@karma.subcommand("view", help="View your or another users karma")
@command.argument("user",
"user ID",
required=False,
parser=lambda val: Client.parse_user_id(val)
if val else None)
async def view_karma(self, evt: MessageEvent,
user: Optional[Tuple[str, str]]) -> None:
if user is not None:
mxid = UserID(f"@{user[0]}:{user[1]}")
name = f"[{user[0]}](https://matrix.to/#/{mxid})"
word_have = "has"
word_to_be = "is"
else:
mxid = evt.sender
name = "You"
word_have = "have"
word_to_be = "are"
karma = self.karma_t.get_karma(mxid)
if karma is None or karma.total is None:
await evt.reply(f"{name} {word_have} no karma :(")
return
index = self.karma_t.find_index_from_top(mxid)
await evt.reply(
f"{name} {word_have} {karma.total} karma "
f"(+{karma.positive}/-{karma.negative}) "
f"and {word_to_be} #{index + 1 or '∞'} on the top list.")
@karma.subcommand("export", help="Export the data of your karma")
async def export_own_karma(self, evt: MessageEvent) -> None:
karma_list = [
karma.to_dict() for karma in self.karma_t.export(evt.sender)
]
data = json.dumps(karma_list).encode("utf-8")
url = await self.client.upload_media(data,
mime_type="application/json")
await evt.reply(
MediaMessageEventContent(msgtype=MessageType.FILE,
body=f"karma-{evt.sender}.json",
url=url,
info=FileInfo(
mimetype="application/json",
size=len(data),
)))
@karma.subcommand("breakdown", help="View your karma breakdown")
async def own_karma_breakdown(self, evt: MessageEvent) -> None:
await evt.reply("Not yet implemented :(")
@karma.subcommand("top", help="View the highest rated users")
async def karma_top(self, evt: MessageEvent) -> None:
await evt.reply(self._karma_user_list("top"))
@karma.subcommand("bottom", help="View the lowest rated users")
async def karma_bottom(self, evt: MessageEvent) -> None:
await evt.reply(self._karma_user_list("bottom"))
@karma.subcommand("best", help="View the highest rated messages")
async def karma_best(self, evt: MessageEvent) -> None:
await evt.reply(self._karma_message_list("best"))
@karma.subcommand("worst", help="View the lowest rated messages")
async def karma_worst(self, evt: MessageEvent) -> None:
await evt.reply(self._karma_message_list("worst"))
def _parse_content(self, evt: Event) -> str:
if not self.config["store_content"]:
return ""
if isinstance(evt, MessageEvent):
if evt.content.msgtype in (MessageType.NOTICE, MessageType.TEXT,
MessageType.EMOTE):
body = evt.content.body
if evt.content.msgtype == MessageType.EMOTE:
body = "/me " + body
if self.config["store_content"] == "partial":
body = body.split("\n")[0]
if len(body) > 60:
body = body[:50] + " \u2026"
return body
name = media_reply_fallback_body_map[evt.content.msgtype]
return f"[{name}]({self.client.api.get_download_url(evt.content.url)})"
elif isinstance(evt, StateEvent):
return "a state event"
return "an unknown event"
@staticmethod
def _sign(value: int) -> str:
if value > 0:
return f"+{value}"
elif value < 0:
return str(value)
else:
return "±0"
async def _vote(self, evt: MessageEvent, target: EventID,
value: int) -> None:
if not target:
return
in_filter = evt.sender in self.config["filter"]
if self.config["democracy"] == in_filter or sha1(
evt.sender) in self.config["opt_out"]:
if self.config["errors.filtered_users"] and isinstance(
evt, MessageEvent):
await evt.reply("Sorry, you're not allowed to vote.")
return
if self.karma_t.is_vote_event(target):
if self.config["errors.vote_on_vote"] and isinstance(
evt, MessageEvent):
await evt.reply("Sorry, you can't vote on votes.")
return
karma_target = await self.client.get_event(evt.room_id, target)
if not karma_target:
return
if karma_target.sender == evt.sender and value > 0:
if self.config["errors.upvote_self"] and isinstance(
evt, MessageEvent):
await evt.reply("Hey! You can't upvote yourself!")
return
karma_id = dict(given_to=karma_target.sender,
given_by=evt.sender,
given_in=evt.room_id,
given_for=karma_target.event_id)
anonymize = sha1(karma_target.sender) in self.config["opt_out"]
if anonymize:
karma_id["given_to"] = ""
existing = self.karma_t.get(**karma_id)
if existing is not None:
if existing.value == value:
if self.config["errors.already_voted"] and isinstance(
evt, MessageEvent):
await evt.reply(
f"You already {self._sign(value)}'d that message.")
return
existing.update(new_value=value)
else:
karma = self.karma_t(**karma_id,
given_from=evt.event_id,
value=value,
content=self._parse_content(karma_target)
if not anonymize else "")
karma.insert()
if isinstance(evt, MessageEvent):
await evt.mark_read()
def _denotify(self, mxid: UserID) -> str:
localpart, _ = self.client.parse_user_id(mxid)
return "\u2063".join(localpart)
def _user_link(self, user_id: UserID) -> str:
if not user_id:
return "Anonymous"
return f"[{self._denotify(user_id)}](https://matrix.to/#/{user_id})"
def _karma_user_list(self, list_type: str) -> Optional[str]:
if list_type == "top":
karma_list = self.karma_t.get_top_users()
message = "#### Highest karma\n\n"
elif list_type in ("bot", "bottom"):
karma_list = self.karma_t.get_bottom_users()
message = "#### Lowest karma\n\n"
else:
return None
message += "\n".join(
f"{index + 1}. {self._user_link(karma.user_id)}: "
f"{self._sign(karma.total)} (+{karma.positive}/-{karma.negative})"
for index, karma in enumerate(karma_list) if karma.user_id)
return message
def _message_text(self, index, event) -> str:
text = (
f"{index + 1}. [Event](https://matrix.to/#/{event.room_id}/{event.event_id})"
f" by {self._user_link(event.sender)} with"
f" {self._sign(event.total)} karma (+{event.positive}/-{event.negative})\n"
)
if event.content and self.config["show_content"]:
text += f" \n > {html.escape(event.content)}\n"
return text
def _karma_message_list(self, list_type: str) -> Optional[str]:
if list_type == "best":
karma_list = self.karma_t.get_best_events()
message = "#### Best messages\n\n"
elif list_type == "worst":
karma_list = self.karma_t.get_worst_events()
message = "#### Worst messages\n\n"
else:
return None
message += "\n".join(
self._message_text(index, event)
for index, event in enumerate(karma_list))
return message
@classmethod
def get_config_class(cls) -> Type[BaseProxyConfig]:
return Config
def _validate_user(user: Any) -> bool:
try:
Client.parse_user_id(user)
return True
except (ValueError, IndexError):
return False
